1
2 /*
3 * ng_ksocket.c
4 *
5 * Copyright (c) 1996-1999 Whistle Communications, Inc.
6 * All rights reserved.
7 *
8 * Subject to the following obligations and disclaimer of warranty, use and
9 * redistribution of this software, in source or object code forms, with or
10 * without modifications are expressly permitted by Whistle Communications;
11 * provided, however, that:
12 * 1. Any and all reproductions of the source or object code must include the
13 * copyright notice above and the following disclaimer of warranties; and
14 * 2. No rights are granted, in any manner or form, to use Whistle
15 * Communications, Inc. trademarks, including the mark "WHISTLE
16 * COMMUNICATIONS" on advertising, endorsements, or otherwise except as
17 * such appears in the above copyright notice or in the software.
18 *
19 * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
20 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
21 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
22 * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
23 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
24 * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
25 * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
26 * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
27 * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
28 * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
29 * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
30 * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
31 * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34 * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
35 * OF SUCH DAMAGE.
36 *
37 * Author: Archie Cobbs <archie@freebsd.org>
38 *
39 * $FreeBSD: releng/5.3/sys/netgraph/ng_ksocket.c 136588 2004-10-16 08:43:07Z cvs2svn $
40 * $Whistle: ng_ksocket.c,v 1.1 1999/11/16 20:04:40 archie Exp $
41 */
42
43 /*
44 * Kernel socket node type. This node type is basically a kernel-mode
45 * version of a socket... kindof like the reverse of the socket node type.
46 */
47
48 #include <sys/param.h>
49 #include <sys/systm.h>
50 #include <sys/kernel.h>
51 #include <sys/mbuf.h>
52 #include <sys/proc.h>
53 #include <sys/malloc.h>
54 #include <sys/ctype.h>
55 #include <sys/protosw.h>
56 #include <sys/errno.h>
57 #include <sys/socket.h>
58 #include <sys/socketvar.h>
59 #include <sys/uio.h>
60 #include <sys/un.h>
61
62 #include <netgraph/ng_message.h>
63 #include <netgraph/netgraph.h>
64 #include <netgraph/ng_parse.h>
65 #include <netgraph/ng_ksocket.h>
66
67 #include <netinet/in.h>
68 #include <netatalk/at.h>
69
70 #ifdef NG_SEPARATE_MALLOC
71 MALLOC_DEFINE(M_NETGRAPH_KSOCKET, "netgraph_ksock", "netgraph ksock node ");
72 #else
73 #define M_NETGRAPH_KSOCKET M_NETGRAPH
74 #endif
75
76 #define OFFSETOF(s, e) ((char *)&((s *)0)->e - (char *)((s *)0))
77 #define SADATA_OFFSET (OFFSETOF(struct sockaddr, sa_data))
78
79 /* Node private data */
80 struct ng_ksocket_private {
81 node_p node;
82 hook_p hook;
83 struct socket *so;
84 LIST_HEAD(, ng_ksocket_private) embryos;
85 LIST_ENTRY(ng_ksocket_private) siblings;
86 u_int32_t flags;
87 u_int32_t response_token;
88 ng_ID_t response_addr;
89 };
90 typedef struct ng_ksocket_private *priv_p;
91
92 /* Flags for priv_p */
93 #define KSF_CONNECTING 0x00000001 /* Waiting for connection complete */
94 #define KSF_ACCEPTING 0x00000002 /* Waiting for accept complete */
95 #define KSF_EOFSEEN 0x00000004 /* Have sent 0-length EOF mbuf */
96 #define KSF_CLONED 0x00000008 /* Cloned from an accepting socket */
97 #define KSF_EMBRYONIC 0x00000010 /* Cloned node with no hooks yet */
98 #define KSF_SENDING 0x00000020 /* Sending on socket */
99
100 /* Netgraph node methods */
101 static ng_constructor_t ng_ksocket_constructor;
102 static ng_rcvmsg_t ng_ksocket_rcvmsg;
103 static ng_shutdown_t ng_ksocket_shutdown;
104 static ng_newhook_t ng_ksocket_newhook;
105 static ng_rcvdata_t ng_ksocket_rcvdata;
106 static ng_connect_t ng_ksocket_connect;
107 static ng_disconnect_t ng_ksocket_disconnect;
108
109 /* Alias structure */
110 struct ng_ksocket_alias {
111 const char *name;
112 const int value;
113 const int family;
114 };
115
116 /* Protocol family aliases */
117 static const struct ng_ksocket_alias ng_ksocket_families[] = {
118 { "local", PF_LOCAL },
119 { "inet", PF_INET },
120 { "inet6", PF_INET6 },
121 { "atalk", PF_APPLETALK },
122 { "ipx", PF_IPX },
123 { "atm", PF_ATM },
124 { NULL, -1 },
125 };
126
127 /* Socket type aliases */
128 static const struct ng_ksocket_alias ng_ksocket_types[] = {
129 { "stream", SOCK_STREAM },
130 { "dgram", SOCK_DGRAM },
131 { "raw", SOCK_RAW },
132 { "rdm", SOCK_RDM },
133 { "seqpacket", SOCK_SEQPACKET },
134 { NULL, -1 },
135 };
136
137 /* Protocol aliases */
138 static const struct ng_ksocket_alias ng_ksocket_protos[] = {
139 { "ip", IPPROTO_IP, PF_INET },
140 { "raw", IPPROTO_RAW, PF_INET },
141 { "icmp", IPPROTO_ICMP, PF_INET },
142 { "igmp", IPPROTO_IGMP, PF_INET },
143 { "tcp", IPPROTO_TCP, PF_INET },
144 { "udp", IPPROTO_UDP, PF_INET },
145 { "gre", IPPROTO_GRE, PF_INET },
146 { "esp", IPPROTO_ESP, PF_INET },
147 { "ah", IPPROTO_AH, PF_INET },
148 { "swipe", IPPROTO_SWIPE, PF_INET },
149 { "encap", IPPROTO_ENCAP, PF_INET },
150 { "divert", IPPROTO_DIVERT, PF_INET },
151 { "pim", IPPROTO_PIM, PF_INET },
152 { "ddp", ATPROTO_DDP, PF_APPLETALK },
153 { "aarp", ATPROTO_AARP, PF_APPLETALK },
154 { NULL, -1 },
155 };
156
157 /* Helper functions */
158 static int ng_ksocket_check_accept(priv_p);
159 static void ng_ksocket_finish_accept(priv_p);
160 static void ng_ksocket_incoming(struct socket *so, void *arg, int waitflag);
161 static int ng_ksocket_parse(const struct ng_ksocket_alias *aliases,
162 const char *s, int family);
163 static void ng_ksocket_incoming2(node_p node, hook_p hook,
164 void *arg1, int waitflag);
165
166 /************************************************************************
167 STRUCT SOCKADDR PARSE TYPE
168 ************************************************************************/
169
170 /* Get the length of the data portion of a generic struct sockaddr */
171 static int
172 ng_parse_generic_sockdata_getLength(const struct ng_parse_type *type,
173 const u_char *start, const u_char *buf)
174 {
175 const struct sockaddr *sa;
176
177 sa = (const struct sockaddr *)(buf - SADATA_OFFSET);
178 return (sa->sa_len < SADATA_OFFSET) ? 0 : sa->sa_len - SADATA_OFFSET;
179 }
180
181 /* Type for the variable length data portion of a generic struct sockaddr */
182 static const struct ng_parse_type ng_ksocket_generic_sockdata_type = {
183 &ng_parse_bytearray_type,
184 &ng_parse_generic_sockdata_getLength
185 };
186
187 /* Type for a generic struct sockaddr */
188 static const struct ng_parse_struct_field
189 ng_parse_generic_sockaddr_type_fields[] = {
190 { "len", &ng_parse_uint8_type },
191 { "family", &ng_parse_uint8_type },
192 { "data", &ng_ksocket_generic_sockdata_type },
193 { NULL }
194 };
195 static const struct ng_parse_type ng_ksocket_generic_sockaddr_type = {
196 &ng_parse_struct_type,
197 &ng_parse_generic_sockaddr_type_fields
198 };
199
200 /* Convert a struct sockaddr from ASCII to binary. If its a protocol
201 family that we specially handle, do that, otherwise defer to the
202 generic parse type ng_ksocket_generic_sockaddr_type. */
203 static int
204 ng_ksocket_sockaddr_parse(const struct ng_parse_type *type,
205 const char *s, int *off, const u_char *const start,
206 u_char *const buf, int *buflen)
207 {
208 struct sockaddr *const sa = (struct sockaddr *)buf;
209 enum ng_parse_token tok;
210 char fambuf[32];
211 int family, len;
212 char *t;
213
214 /* If next token is a left curly brace, use generic parse type */
215 if ((tok = ng_parse_get_token(s, off, &len)) == T_LBRACE) {
216 return (*ng_ksocket_generic_sockaddr_type.supertype->parse)
217 (&ng_ksocket_generic_sockaddr_type,
218 s, off, start, buf, buflen);
219 }
220
221 /* Get socket address family followed by a slash */
222 while (isspace(s[*off]))
223 (*off)++;
224 if ((t = index(s + *off, '/')) == NULL)
225 return (EINVAL);
226 if ((len = t - (s + *off)) > sizeof(fambuf) - 1)
227 return (EINVAL);
228 strncpy(fambuf, s + *off, len);
229 fambuf[len] = '\0';
230 *off += len + 1;
231 if ((family = ng_ksocket_parse(ng_ksocket_families, fambuf, 0)) == -1)
232 return (EINVAL);
233
234 /* Set family */
235 if (*buflen < SADATA_OFFSET)
236 return (ERANGE);
237 sa->sa_family = family;
238
239 /* Set family-specific data and length */
240 switch (sa->sa_family) {
241 case PF_LOCAL: /* Get pathname */
242 {
243 const int pathoff = OFFSETOF(struct sockaddr_un, sun_path);
244 struct sockaddr_un *const sun = (struct sockaddr_un *)sa;
245 int toklen, pathlen;
246 char *path;
247
248 if ((path = ng_get_string_token(s, off, &toklen, NULL)) == NULL)
249 return (EINVAL);
250 pathlen = strlen(path);
251 if (pathlen > SOCK_MAXADDRLEN) {
252 FREE(path, M_NETGRAPH_KSOCKET);
253 return (E2BIG);
254 }
255 if (*buflen < pathoff + pathlen) {
256 FREE(path, M_NETGRAPH_KSOCKET);
257 return (ERANGE);
258 }
259 *off += toklen;
260 bcopy(path, sun->sun_path, pathlen);
261 sun->sun_len = pathoff + pathlen;
262 FREE(path, M_NETGRAPH_KSOCKET);
263 break;
264 }
265
266 case PF_INET: /* Get an IP address with optional port */
267 {
268 struct sockaddr_in *const sin = (struct sockaddr_in *)sa;
269 int i;
270
271 /* Parse this: <ipaddress>[:port] */
272 for (i = 0; i < 4; i++) {
273 u_long val;
274 char *eptr;
275
276 val = strtoul(s + *off, &eptr, 10);
277 if (val > 0xff || eptr == s + *off)
278 return (EINVAL);
279 *off += (eptr - (s + *off));
280 ((u_char *)&sin->sin_addr)[i] = (u_char)val;
281 if (i < 3) {
282 if (s[*off] != '.')
283 return (EINVAL);
284 (*off)++;
285 } else if (s[*off] == ':') {
286 (*off)++;
287 val = strtoul(s + *off, &eptr, 10);
288 if (val > 0xffff || eptr == s + *off)
289 return (EINVAL);
290 *off += (eptr - (s + *off));
291 sin->sin_port = htons(val);
292 } else
293 sin->sin_port = 0;
294 }
295 bzero(&sin->sin_zero, sizeof(sin->sin_zero));
296 sin->sin_len = sizeof(*sin);
297 break;
298 }
299
300 #if 0
301 case PF_APPLETALK: /* XXX implement these someday */
302 case PF_INET6:
303 case PF_IPX:
304 #endif
305
306 default:
307 return (EINVAL);
308 }
309
310 /* Done */
311 *buflen = sa->sa_len;
312 return (0);
313 }
314
315 /* Convert a struct sockaddr from binary to ASCII */
316 static int
317 ng_ksocket_sockaddr_unparse(const struct ng_parse_type *type,
318 const u_char *data, int *off, char *cbuf, int cbuflen)
319 {
320 const struct sockaddr *sa = (const struct sockaddr *)(data + *off);
321 int slen = 0;
322
323 /* Output socket address, either in special or generic format */
324 switch (sa->sa_family) {
325 case PF_LOCAL:
326 {
327 const int pathoff = OFFSETOF(struct sockaddr_un, sun_path);
328 const struct sockaddr_un *sun = (const struct sockaddr_un *)sa;
329 const int pathlen = sun->sun_len - pathoff;
330 char pathbuf[SOCK_MAXADDRLEN + 1];
331 char *pathtoken;
332
333 bcopy(sun->sun_path, pathbuf, pathlen);
334 if ((pathtoken = ng_encode_string(pathbuf, pathlen)) == NULL)
335 return (ENOMEM);
336 slen += snprintf(cbuf, cbuflen, "local/%s", pathtoken);
337 FREE(pathtoken, M_NETGRAPH_KSOCKET);
338 if (slen >= cbuflen)
339 return (ERANGE);
340 *off += sun->sun_len;
341 return (0);
342 }
343
344 case PF_INET:
345 {
346 const struct sockaddr_in *sin = (const struct sockaddr_in *)sa;
347
348 slen += snprintf(cbuf, cbuflen, "inet/%d.%d.%d.%d",
349 ((const u_char *)&sin->sin_addr)[0],
350 ((const u_char *)&sin->sin_addr)[1],
351 ((const u_char *)&sin->sin_addr)[2],
352 ((const u_char *)&sin->sin_addr)[3]);
353 if (sin->sin_port != 0) {
354 slen += snprintf(cbuf + strlen(cbuf),
355 cbuflen - strlen(cbuf), ":%d",
356 (u_int)ntohs(sin->sin_port));
357 }
358 if (slen >= cbuflen)
359 return (ERANGE);
360 *off += sizeof(*sin);
361 return(0);
362 }
363
364 #if 0
365 case PF_APPLETALK: /* XXX implement these someday */
366 case PF_INET6:
367 case PF_IPX:
368 #endif
369
370 default:
371 return (*ng_ksocket_generic_sockaddr_type.supertype->unparse)
372 (&ng_ksocket_generic_sockaddr_type,
373 data, off, cbuf, cbuflen);
374 }
375 }
376
377 /* Parse type for struct sockaddr */
378 static const struct ng_parse_type ng_ksocket_sockaddr_type = {
379 NULL,
380 NULL,
381 NULL,
382 &ng_ksocket_sockaddr_parse,
383 &ng_ksocket_sockaddr_unparse,
384 NULL /* no such thing as a default struct sockaddr */
385 };
386
387 /************************************************************************
388 STRUCT NG_KSOCKET_SOCKOPT PARSE TYPE
389 ************************************************************************/
390
391 /* Get length of the struct ng_ksocket_sockopt value field, which is the
392 just the excess of the message argument portion over the length of
393 the struct ng_ksocket_sockopt. */
394 static int
395 ng_parse_sockoptval_getLength(const struct ng_parse_type *type,
396 const u_char *start, const u_char *buf)
397 {
398 static const int offset = OFFSETOF(struct ng_ksocket_sockopt, value);
399 const struct ng_ksocket_sockopt *sopt;
400 const struct ng_mesg *msg;
401
402 sopt = (const struct ng_ksocket_sockopt *)(buf - offset);
403 msg = (const struct ng_mesg *)((const u_char *)sopt - sizeof(*msg));
404 return msg->header.arglen - sizeof(*sopt);
405 }
406
407 /* Parse type for the option value part of a struct ng_ksocket_sockopt
408 XXX Eventually, we should handle the different socket options specially.
409 XXX This would avoid byte order problems, eg an integer value of 1 is
410 XXX going to be "[1]" for little endian or "[3=1]" for big endian. */
411 static const struct ng_parse_type ng_ksocket_sockoptval_type = {
412 &ng_parse_bytearray_type,
413 &ng_parse_sockoptval_getLength
414 };
415
416 /* Parse type for struct ng_ksocket_sockopt */
417 static const struct ng_parse_struct_field ng_ksocket_sockopt_type_fields[]
418 = NG_KSOCKET_SOCKOPT_INFO(&ng_ksocket_sockoptval_type);
419 static const struct ng_parse_type ng_ksocket_sockopt_type = {
420 &ng_parse_struct_type,
421 &ng_ksocket_sockopt_type_fields
422 };
423
424 /* Parse type for struct ng_ksocket_accept */
425 static const struct ng_parse_struct_field ng_ksocket_accept_type_fields[]
426 = NGM_KSOCKET_ACCEPT_INFO;
427 static const struct ng_parse_type ng_ksocket_accept_type = {
428 &ng_parse_struct_type,
429 &ng_ksocket_accept_type_fields
430 };
431
432 /* List of commands and how to convert arguments to/from ASCII */
433 static const struct ng_cmdlist ng_ksocket_cmds[] = {
434 {
435 NGM_KSOCKET_COOKIE,
436 NGM_KSOCKET_BIND,
437 "bind",
438 &ng_ksocket_sockaddr_type,
439 NULL
440 },
441 {
442 NGM_KSOCKET_COOKIE,
443 NGM_KSOCKET_LISTEN,
444 "listen",
445 &ng_parse_int32_type,
446 NULL
447 },
448 {
449 NGM_KSOCKET_COOKIE,
450 NGM_KSOCKET_ACCEPT,
451 "accept",
452 NULL,
453 &ng_ksocket_accept_type
454 },
455 {
456 NGM_KSOCKET_COOKIE,
457 NGM_KSOCKET_CONNECT,
458 "connect",
459 &ng_ksocket_sockaddr_type,
460 &ng_parse_int32_type
461 },
462 {
463 NGM_KSOCKET_COOKIE,
464 NGM_KSOCKET_GETNAME,
465 "getname",
466 NULL,
467 &ng_ksocket_sockaddr_type
468 },
469 {
470 NGM_KSOCKET_COOKIE,
471 NGM_KSOCKET_GETPEERNAME,
472 "getpeername",
473 NULL,
474 &ng_ksocket_sockaddr_type
475 },
476 {
477 NGM_KSOCKET_COOKIE,
478 NGM_KSOCKET_SETOPT,
479 "setopt",
480 &ng_ksocket_sockopt_type,
481 NULL
482 },
483 {
484 NGM_KSOCKET_COOKIE,
485 NGM_KSOCKET_GETOPT,
486 "getopt",
487 &ng_ksocket_sockopt_type,
488 &ng_ksocket_sockopt_type
489 },
490 { 0 }
491 };
492
493 /* Node type descriptor */
494 static struct ng_type ng_ksocket_typestruct = {
495 .version = NG_ABI_VERSION,
496 .name = NG_KSOCKET_NODE_TYPE,
497 .constructor = ng_ksocket_constructor,
498 .rcvmsg = ng_ksocket_rcvmsg,
499 .shutdown = ng_ksocket_shutdown,
500 .newhook = ng_ksocket_newhook,
501 .connect = ng_ksocket_connect,
502 .rcvdata = ng_ksocket_rcvdata,
503 .disconnect = ng_ksocket_disconnect,
504 .cmdlist = ng_ksocket_cmds,
505 };
506 NETGRAPH_INIT(ksocket, &ng_ksocket_typestruct);
507
508 #define ERROUT(x) do { error = (x); goto done; } while (0)
509
510 /************************************************************************
511 NETGRAPH NODE STUFF
512 ************************************************************************/
513
514 /*
515 * Node type constructor
516 * The NODE part is assumed to be all set up.
517 * There is already a reference to the node for us.
518 */
519 static int
520 ng_ksocket_constructor(node_p node)
521 {
522 priv_p priv;
523
524 /* Allocate private structure */
525 MALLOC(priv, priv_p, sizeof(*priv),
526 M_NETGRAPH_KSOCKET, M_NOWAIT | M_ZERO);
527 if (priv == NULL)
528 return (ENOMEM);
529
530 LIST_INIT(&priv->embryos);
531 /* cross link them */
532 priv->node = node;
533 NG_NODE_SET_PRIVATE(node, priv);
534
535 /* Done */
536 return (0);
537 }
538
539 /*
540 * Give our OK for a hook to be added. The hook name is of the
541 * form "<family>/<type>/<proto>" where the three components may
542 * be decimal numbers or else aliases from the above lists.
543 *
544 * Connecting a hook amounts to opening the socket. Disconnecting
545 * the hook closes the socket and destroys the node as well.
546 */
547 static int
548 ng_ksocket_newhook(node_p node, hook_p hook, const char *name0)
549 {
550 struct thread *td = curthread; /* XXX broken */
551 const priv_p priv = NG_NODE_PRIVATE(node);
552 char *s1, *s2, name[NG_HOOKSIZ];
553 int family, type, protocol, error;
554
555 /* Check if we're already connected */
556 if (priv->hook != NULL)
557 return (EISCONN);
558
559 if (priv->flags & KSF_CLONED) {
560 if (priv->flags & KSF_EMBRYONIC) {
561 /* Remove ourselves from our parent's embryo list */
562 LIST_REMOVE(priv, siblings);
563 priv->flags &= ~KSF_EMBRYONIC;
564 }
565 } else {
566 /* Extract family, type, and protocol from hook name */
567 snprintf(name, sizeof(name), "%s", name0);
568 s1 = name;
569 if ((s2 = index(s1, '/')) == NULL)
570 return (EINVAL);
571 *s2++ = '\0';
572 family = ng_ksocket_parse(ng_ksocket_families, s1, 0);
573 if (family == -1)
574 return (EINVAL);
575 s1 = s2;
576 if ((s2 = index(s1, '/')) == NULL)
577 return (EINVAL);
578 *s2++ = '\0';
579 type = ng_ksocket_parse(ng_ksocket_types, s1, 0);
580 if (type == -1)
581 return (EINVAL);
582 s1 = s2;
583 protocol = ng_ksocket_parse(ng_ksocket_protos, s1, family);
584 if (protocol == -1)
585 return (EINVAL);
586
587 /* Create the socket */
588 error = socreate(family, &priv->so, type, protocol,
589 td->td_ucred, td);
590 if (error != 0)
591 return (error);
592
593 /* XXX call soreserve() ? */
594
595 }
596
597 /* OK */
598 priv->hook = hook;
599 return(0);
600 }
601
602 static int
603 ng_ksocket_connect(hook_p hook)
604 {
605 node_p node = NG_HOOK_NODE(hook);
606 const priv_p priv = NG_NODE_PRIVATE(node);
607 struct socket *const so = priv->so;
608
609 /* Add our hook for incoming data and other events */
610 priv->so->so_upcallarg = (caddr_t)node;
611 priv->so->so_upcall = ng_ksocket_incoming;
612 SOCKBUF_LOCK(&priv->so->so_rcv);
613 priv->so->so_rcv.sb_flags |= SB_UPCALL;
614 SOCKBUF_UNLOCK(&priv->so->so_rcv);
615 SOCKBUF_LOCK(&priv->so->so_snd);
616 priv->so->so_snd.sb_flags |= SB_UPCALL;
617 SOCKBUF_UNLOCK(&priv->so->so_snd);
618 SOCK_LOCK(priv->so);
619 priv->so->so_state |= SS_NBIO;
620 SOCK_UNLOCK(priv->so);
621 /*
622 * --Original comment--
623 * On a cloned socket we may have already received one or more
624 * upcalls which we couldn't handle without a hook. Handle
625 * those now.
626 * We cannot call the upcall function directly
627 * from here, because until this function has returned our
628 * hook isn't connected.
629 *
630 * ---meta comment for -current ---
631 * XXX This is dubius.
632 * Upcalls between the time that the hook was
633 * first created and now (on another processesor) will
634 * be earlier on the queue than the request to finalise the hook.
635 * By the time the hook is finalised,
636 * The queued upcalls will have happenned and the code
637 * will have discarded them because of a lack of a hook.
638 * (socket not open).
639 *
640 * This is a bad byproduct of the complicated way in which hooks
641 * are now created (3 daisy chained async events).
642 *
643 * Since we are a netgraph operation
644 * We know that we hold a lock on this node. This forces the
645 * request we make below to be queued rather than implemented
646 * immediatly which will cause the upcall function to be called a bit
647 * later.
648 * However, as we will run any waiting queued operations immediatly
649 * after doing this one, if we have not finalised the other end
650 * of the hook, those queued operations will fail.
651 */
652 if (priv->flags & KSF_CLONED) {
653 ng_send_fn(node, NULL, &ng_ksocket_incoming2, so, M_NOWAIT);
654 }
655
656 return (0);
657 }
658
659 /*
660 * Receive a control message
661 */
662 static int
663 ng_ksocket_rcvmsg(node_p node, item_p item, hook_p lasthook)
664 {
665 struct thread *td = curthread; /* XXX broken */
666 const priv_p priv = NG_NODE_PRIVATE(node);
667 struct socket *const so = priv->so;
668 struct ng_mesg *resp = NULL;
669 int error = 0;
670 struct ng_mesg *msg;
671 ng_ID_t raddr;
672
673 NGI_GET_MSG(item, msg);
674 switch (msg->header.typecookie) {
675 case NGM_KSOCKET_COOKIE:
676 switch (msg->header.cmd) {
677 case NGM_KSOCKET_BIND:
678 {
679 struct sockaddr *const sa
680 = (struct sockaddr *)msg->data;
681
682 /* Sanity check */
683 if (msg->header.arglen < SADATA_OFFSET
684 || msg->header.arglen < sa->sa_len)
685 ERROUT(EINVAL);
686 if (so == NULL)
687 ERROUT(ENXIO);
688
689 /* Bind */
690 error = sobind(so, sa, td);
691 break;
692 }
693 case NGM_KSOCKET_LISTEN:
694 {
695 /* Sanity check */
696 if (msg->header.arglen != sizeof(int32_t))
697 ERROUT(EINVAL);
698 if (so == NULL)
699 ERROUT(ENXIO);
700
701 /* Listen */
702 error = solisten(so, *((int32_t *)msg->data), td);
703 break;
704 }
705
706 case NGM_KSOCKET_ACCEPT:
707 {
708 /* Sanity check */
709 if (msg->header.arglen != 0)
710 ERROUT(EINVAL);
711 if (so == NULL)
712 ERROUT(ENXIO);
713
714 /* Make sure the socket is capable of accepting */
715 if (!(so->so_options & SO_ACCEPTCONN))
716 ERROUT(EINVAL);
717 if (priv->flags & KSF_ACCEPTING)
718 ERROUT(EALREADY);
719
720 error = ng_ksocket_check_accept(priv);
721 if (error != 0 && error != EWOULDBLOCK)
722 ERROUT(error);
723
724 /*
725 * If a connection is already complete, take it.
726 * Otherwise let the upcall function deal with
727 * the connection when it comes in.
728 */
729 priv->response_token = msg->header.token;
730 raddr = priv->response_addr = NGI_RETADDR(item);
731 if (error == 0) {
732 ng_ksocket_finish_accept(priv);
733 } else
734 priv->flags |= KSF_ACCEPTING;
735 break;
736 }
737
738 case NGM_KSOCKET_CONNECT:
739 {
740 struct sockaddr *const sa
741 = (struct sockaddr *)msg->data;
742
743 /* Sanity check */
744 if (msg->header.arglen < SADATA_OFFSET
745 || msg->header.arglen < sa->sa_len)
746 ERROUT(EINVAL);
747 if (so == NULL)
748 ERROUT(ENXIO);
749
750 /* Do connect */
751 if ((so->so_state & SS_ISCONNECTING) != 0)
752 ERROUT(EALREADY);
753 if ((error = soconnect(so, sa, td)) != 0) {
754 so->so_state &= ~SS_ISCONNECTING;
755 ERROUT(error);
756 }
757 if ((so->so_state & SS_ISCONNECTING) != 0) {
758 /* We will notify the sender when we connect */
759 priv->response_token = msg->header.token;
760 raddr = priv->response_addr = NGI_RETADDR(item);
761 priv->flags |= KSF_CONNECTING;
762 ERROUT(EINPROGRESS);
763 }
764 break;
765 }
766
767 case NGM_KSOCKET_GETNAME:
768 case NGM_KSOCKET_GETPEERNAME:
769 {
770 int (*func)(struct socket *so, struct sockaddr **nam);
771 struct sockaddr *sa = NULL;
772 int len;
773
774 /* Sanity check */
775 if (msg->header.arglen != 0)
776 ERROUT(EINVAL);
777 if (so == NULL)
778 ERROUT(ENXIO);
779
780 /* Get function */
781 if (msg->header.cmd == NGM_KSOCKET_GETPEERNAME) {
782 if ((so->so_state
783 & (SS_ISCONNECTED|SS_ISCONFIRMING)) == 0)
784 ERROUT(ENOTCONN);
785 func = so->so_proto->pr_usrreqs->pru_peeraddr;
786 } else
787 func = so->so_proto->pr_usrreqs->pru_sockaddr;
788
789 /* Get local or peer address */
790 if ((error = (*func)(so, &sa)) != 0)
791 goto bail;
792 len = (sa == NULL) ? 0 : sa->sa_len;
793
794 /* Send it back in a response */
795 NG_MKRESPONSE(resp, msg, len, M_NOWAIT);
796 if (resp == NULL) {
797 error = ENOMEM;
798 goto bail;
799 }
800 bcopy(sa, resp->data, len);
801
802 bail:
803 /* Cleanup */
804 if (sa != NULL)
805 FREE(sa, M_SONAME);
806 break;
807 }
808
809 case NGM_KSOCKET_GETOPT:
810 {
811 struct ng_ksocket_sockopt *ksopt =
812 (struct ng_ksocket_sockopt *)msg->data;
813 struct sockopt sopt;
814
815 /* Sanity check */
816 if (msg->header.arglen != sizeof(*ksopt))
817 ERROUT(EINVAL);
818 if (so == NULL)
819 ERROUT(ENXIO);
820
821 /* Get response with room for option value */
822 NG_MKRESPONSE(resp, msg, sizeof(*ksopt)
823 + NG_KSOCKET_MAX_OPTLEN, M_NOWAIT);
824 if (resp == NULL)
825 ERROUT(ENOMEM);
826
827 /* Get socket option, and put value in the response */
828 sopt.sopt_dir = SOPT_GET;
829 sopt.sopt_level = ksopt->level;
830 sopt.sopt_name = ksopt->name;
831 sopt.sopt_td = NULL;
832 sopt.sopt_valsize = NG_KSOCKET_MAX_OPTLEN;
833 ksopt = (struct ng_ksocket_sockopt *)resp->data;
834 sopt.sopt_val = ksopt->value;
835 if ((error = sogetopt(so, &sopt)) != 0) {
836 NG_FREE_MSG(resp);
837 break;
838 }
839
840 /* Set actual value length */
841 resp->header.arglen = sizeof(*ksopt)
842 + sopt.sopt_valsize;
843 break;
844 }
845
846 case NGM_KSOCKET_SETOPT:
847 {
848 struct ng_ksocket_sockopt *const ksopt =
849 (struct ng_ksocket_sockopt *)msg->data;
850 const int valsize = msg->header.arglen - sizeof(*ksopt);
851 struct sockopt sopt;
852
853 /* Sanity check */
854 if (valsize < 0)
855 ERROUT(EINVAL);
856 if (so == NULL)
857 ERROUT(ENXIO);
858
859 /* Set socket option */
860 sopt.sopt_dir = SOPT_SET;
861 sopt.sopt_level = ksopt->level;
862 sopt.sopt_name = ksopt->name;
863 sopt.sopt_val = ksopt->value;
864 sopt.sopt_valsize = valsize;
865 sopt.sopt_td = NULL;
866 error = sosetopt(so, &sopt);
867 break;
868 }
869
870 default:
871 error = EINVAL;
872 break;
873 }
874 break;
875 default:
876 error = EINVAL;
877 break;
878 }
879 done:
880 NG_RESPOND_MSG(error, node, item, resp);
881 NG_FREE_MSG(msg);
882 return (error);
883 }
884
885 /*
886 * Receive incoming data on our hook. Send it out the socket.
887 */
888 static int
889 ng_ksocket_rcvdata(hook_p hook, item_p item)
890 {
891 struct thread *td = curthread; /* XXX broken */
892 const node_p node = NG_HOOK_NODE(hook);
893 const priv_p priv = NG_NODE_PRIVATE(node);
894 struct socket *const so = priv->so;
895 struct sockaddr *sa = NULL;
896 int error;
897 struct mbuf *m;
898 struct sa_tag *stag;
899
900 /* Avoid reentrantly sending on the socket */
901 if ((priv->flags & KSF_SENDING) != 0) {
902 NG_FREE_ITEM(item);
903 return (EDEADLK);
904 }
905
906 /* Extract data */
907 NGI_GET_M(item, m);
908 NG_FREE_ITEM(item);
909
910 /* Look if socket address is stored in packet tags */
911 if ((stag = (struct sa_tag *)m_tag_locate(m, NGM_KSOCKET_COOKIE,
912 NG_KSOCKET_TAG_SOCKADDR, NULL)) != NULL)
913 sa = &stag->sa;
914
915 /* Send packet */
916 priv->flags |= KSF_SENDING;
917 error = (*so->so_proto->pr_usrreqs->pru_sosend)(so, sa, 0, m, 0, 0, td);
918 priv->flags &= ~KSF_SENDING;
919
920 return (error);
921 }
922
923 /*
924 * Destroy node
925 */
926 static int
927 ng_ksocket_shutdown(node_p node)
928 {
929 const priv_p priv = NG_NODE_PRIVATE(node);
930 priv_p embryo;
931
932 /* Close our socket (if any) */
933 if (priv->so != NULL) {
934 priv->so->so_upcall = NULL;
935 SOCKBUF_LOCK(&priv->so->so_rcv);
936 priv->so->so_rcv.sb_flags &= ~SB_UPCALL;
937 SOCKBUF_UNLOCK(&priv->so->so_rcv);
938 SOCKBUF_LOCK(&priv->so->so_snd);
939 priv->so->so_snd.sb_flags &= ~SB_UPCALL;
940 SOCKBUF_UNLOCK(&priv->so->so_snd);
941 soclose(priv->so);
942 priv->so = NULL;
943 }
944
945 /* If we are an embryo, take ourselves out of the parent's list */
946 if (priv->flags & KSF_EMBRYONIC) {
947 LIST_REMOVE(priv, siblings);
948 priv->flags &= ~KSF_EMBRYONIC;
949 }
950
951 /* Remove any embryonic children we have */
952 while (!LIST_EMPTY(&priv->embryos)) {
953 embryo = LIST_FIRST(&priv->embryos);
954 ng_rmnode_self(embryo->node);
955 }
956
957 /* Take down netgraph node */
958 bzero(priv, sizeof(*priv));
959 FREE(priv, M_NETGRAPH_KSOCKET);
960 NG_NODE_SET_PRIVATE(node, NULL);
961 NG_NODE_UNREF(node); /* let the node escape */
962 return (0);
963 }
964
965 /*
966 * Hook disconnection
967 */
968 static int
969 ng_ksocket_disconnect(hook_p hook)
970 {
971 KASSERT(NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook)) == 0,
972 ("%s: numhooks=%d?", __func__,
973 NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook))));
974 if (NG_NODE_IS_VALID(NG_HOOK_NODE(hook)))
975 ng_rmnode_self(NG_HOOK_NODE(hook));
976 return (0);
977 }
978
979 /************************************************************************
980 HELPER STUFF
981 ************************************************************************/
982 /*
983 * You should no-longer "just call" a netgraph node function
984 * from an external asynchronous event.
985 * This is because in doing so you are ignoring the locking on the netgraph
986 * nodes. Instead call your function via
987 * "int ng_send_fn(node_p node, hook_p hook, ng_item_fn *fn,
988 * void *arg1, int arg2);"
989 * this will call the function you chose, but will first do all the
990 * locking rigmarole. Your function MAY only be called at some distant future
991 * time (several millisecs away) so don't give it any arguments
992 * that may be revoked soon (e.g. on your stack).
993 * In this case even the 'so' argument is doubtful.
994 * While the function request is being processed the node
995 * has an extra reference and as such will not disappear until
996 * the request has at least been done, but the 'so' may not be so lucky.
997 * handle this by checking the validity of the node in the target function
998 * before dereferencing the socket pointer.
999 */
1000
1001 static void
1002 ng_ksocket_incoming(struct socket *so, void *arg, int waitflag)
1003 {
1004 const node_p node = arg;
1005
1006 ng_send_fn(node, NULL, &ng_ksocket_incoming2, so, waitflag);
1007 }
1008
1009
1010 /*
1011 * When incoming data is appended to the socket, we get notified here.
1012 * This is also called whenever a significant event occurs for the socket.
1013 * We know that HOOK is NULL. Because of how we were called we know we have a
1014 * lock on this node an are participating inthe netgraph locking.
1015 * Our original caller may have queued this even some time ago and
1016 * we cannot trust that he even still exists. The node however is being
1017 * held with a reference by the queueing code, at least until we finish,
1018 * even if it has been zapped, so first check it's validiy
1019 * before we trust the socket (which was derived from it).
1020 */
1021 static void
1022 ng_ksocket_incoming2(node_p node, hook_p hook, void *arg1, int waitflag)
1023 {
1024 struct socket *so = arg1;
1025 const priv_p priv = NG_NODE_PRIVATE(node);
1026 struct mbuf *m;
1027 struct ng_mesg *response;
1028 struct uio auio;
1029 int s, flags, error;
1030
1031 s = splnet();
1032
1033 /* Sanity check */
1034 if (NG_NODE_NOT_VALID(node)) {
1035 splx(s);
1036 return;
1037 }
1038 /* so = priv->so; *//* XXX could have derived this like so */
1039 KASSERT(so == priv->so, ("%s: wrong socket", __func__));
1040
1041 /* Check whether a pending connect operation has completed */
1042 if (priv->flags & KSF_CONNECTING) {
1043 if ((error = so->so_error) != 0) {
1044 so->so_error = 0;
1045 so->so_state &= ~SS_ISCONNECTING;
1046 }
1047 if (!(so->so_state & SS_ISCONNECTING)) {
1048 NG_MKMESSAGE(response, NGM_KSOCKET_COOKIE,
1049 NGM_KSOCKET_CONNECT, sizeof(int32_t), waitflag);
1050 if (response != NULL) {
1051 response->header.flags |= NGF_RESP;
1052 response->header.token = priv->response_token;
1053 *(int32_t *)response->data = error;
1054 /*
1055 * send an async "response" message
1056 * to the node that set us up
1057 * (if it still exists)
1058 */
1059 NG_SEND_MSG_ID(error, node,
1060 response, priv->response_addr, 0);
1061 }
1062 priv->flags &= ~KSF_CONNECTING;
1063 }
1064 }
1065
1066 /* Check whether a pending accept operation has completed */
1067 if (priv->flags & KSF_ACCEPTING) {
1068 error = ng_ksocket_check_accept(priv);
1069 if (error != EWOULDBLOCK)
1070 priv->flags &= ~KSF_ACCEPTING;
1071 if (error == 0)
1072 ng_ksocket_finish_accept(priv);
1073 }
1074
1075 /*
1076 * If we don't have a hook, we must handle data events later. When
1077 * the hook gets created and is connected, this upcall function
1078 * will be called again.
1079 */
1080 if (priv->hook == NULL) {
1081 splx(s);
1082 return;
1083 }
1084
1085 /* Read and forward available mbuf's */
1086 auio.uio_td = NULL;
1087 auio.uio_resid = 1000000000;
1088 flags = MSG_DONTWAIT;
1089 while (1) {
1090 struct sockaddr *sa = NULL;
1091 struct mbuf *n;
1092
1093 /* Try to get next packet from socket */
1094 if ((error = (*so->so_proto->pr_usrreqs->pru_soreceive)
1095 (so, (so->so_state & SS_ISCONNECTED) ? NULL : &sa,
1096 &auio, &m, (struct mbuf **)0, &flags)) != 0)
1097 break;
1098
1099 /* See if we got anything */
1100 if (m == NULL) {
1101 if (sa != NULL)
1102 FREE(sa, M_SONAME);
1103 break;
1104 }
1105
1106 /* Don't trust the various socket layers to get the
1107 packet header and length correct (eg. kern/15175) */
1108 for (n = m, m->m_pkthdr.len = 0; n != NULL; n = n->m_next)
1109 m->m_pkthdr.len += n->m_len;
1110
1111 /* Put peer's socket address (if any) into a tag */
1112 if (sa != NULL) {
1113 struct sa_tag *stag;
1114
1115 stag = (struct sa_tag *)m_tag_alloc(NGM_KSOCKET_COOKIE,
1116 NG_KSOCKET_TAG_SOCKADDR, sa->sa_len, M_NOWAIT);
1117 if (stag == NULL) {
1118 FREE(sa, M_SONAME);
1119 goto sendit;
1120 }
1121 bcopy(sa, &stag->sa, sa->sa_len);
1122 FREE(sa, M_SONAME);
1123 m_tag_prepend(m, &stag->tag);
1124 }
1125
1126 sendit: /* Forward data with optional peer sockaddr as packet tag */
1127 NG_SEND_DATA_ONLY(error, priv->hook, m);
1128 }
1129
1130 /*
1131 * If the peer has closed the connection, forward a 0-length mbuf
1132 * to indicate end-of-file.
1133 */
1134 if (so->so_rcv.sb_state & SBS_CANTRCVMORE && !(priv->flags & KSF_EOFSEEN)) {
1135 MGETHDR(m, waitflag, MT_DATA);
1136 if (m != NULL) {
1137 m->m_len = m->m_pkthdr.len = 0;
1138 NG_SEND_DATA_ONLY(error, priv->hook, m);
1139 }
1140 priv->flags |= KSF_EOFSEEN;
1141 }
1142 splx(s);
1143 }
1144
1145 /*
1146 * Check for a completed incoming connection and return 0 if one is found.
1147 * Otherwise return the appropriate error code.
1148 */
1149 static int
1150 ng_ksocket_check_accept(priv_p priv)
1151 {
1152 struct socket *const head = priv->so;
1153 int error;
1154
1155 if ((error = head->so_error) != 0) {
1156 head->so_error = 0;
1157 return error;
1158 }
1159 /* Unlocked read. */
1160 if (TAILQ_EMPTY(&head->so_comp)) {
1161 if (head->so_rcv.sb_state & SBS_CANTRCVMORE)
1162 return ECONNABORTED;
1163 return EWOULDBLOCK;
1164 }
1165 return 0;
1166 }
1167
1168 /*
1169 * Handle the first completed incoming connection, assumed to be already
1170 * on the socket's so_comp queue.
1171 */
1172 static void
1173 ng_ksocket_finish_accept(priv_p priv)
1174 {
1175 struct socket *const head = priv->so;
1176 struct socket *so;
1177 struct sockaddr *sa = NULL;
1178 struct ng_mesg *resp;
1179 struct ng_ksocket_accept *resp_data;
1180 node_p node;
1181 priv_p priv2;
1182 int len;
1183 int error;
1184
1185 ACCEPT_LOCK();
1186 so = TAILQ_FIRST(&head->so_comp);
1187 if (so == NULL) { /* Should never happen */
1188 ACCEPT_UNLOCK();
1189 return;
1190 }
1191 TAILQ_REMOVE(&head->so_comp, so, so_list);
1192 head->so_qlen--;
1193 so->so_qstate &= ~SQ_COMP;
1194 so->so_head = NULL;
1195 SOCK_LOCK(so);
1196 soref(so);
1197 so->so_state |= SS_NBIO;
1198 SOCK_UNLOCK(so);
1199 ACCEPT_UNLOCK();
1200
1201 /* XXX KNOTE(&head->so_rcv.sb_sel.si_note, 0); */
1202
1203 soaccept(so, &sa);
1204
1205 len = OFFSETOF(struct ng_ksocket_accept, addr);
1206 if (sa != NULL)
1207 len += sa->sa_len;
1208
1209 NG_MKMESSAGE(resp, NGM_KSOCKET_COOKIE, NGM_KSOCKET_ACCEPT, len,
1210 M_NOWAIT);
1211 if (resp == NULL) {
1212 soclose(so);
1213 goto out;
1214 }
1215 resp->header.flags |= NGF_RESP;
1216 resp->header.token = priv->response_token;
1217
1218 /* Clone a ksocket node to wrap the new socket */
1219 error = ng_make_node_common(&ng_ksocket_typestruct, &node);
1220 if (error) {
1221 FREE(resp, M_NETGRAPH);
1222 soclose(so);
1223 goto out;
1224 }
1225
1226 if (ng_ksocket_constructor(node) != 0) {
1227 NG_NODE_UNREF(node);
1228 FREE(resp, M_NETGRAPH);
1229 soclose(so);
1230 goto out;
1231 }
1232
1233 priv2 = NG_NODE_PRIVATE(node);
1234 priv2->so = so;
1235 priv2->flags |= KSF_CLONED | KSF_EMBRYONIC;
1236
1237 /*
1238 * Insert the cloned node into a list of embryonic children
1239 * on the parent node. When a hook is created on the cloned
1240 * node it will be removed from this list. When the parent
1241 * is destroyed it will destroy any embryonic children it has.
1242 */
1243 LIST_INSERT_HEAD(&priv->embryos, priv2, siblings);
1244
1245 so->so_upcallarg = (caddr_t)node;
1246 so->so_upcall = ng_ksocket_incoming;
1247 SOCKBUF_LOCK(&so->so_rcv);
1248 so->so_rcv.sb_flags |= SB_UPCALL;
1249 SOCKBUF_UNLOCK(&so->so_rcv);
1250 SOCKBUF_LOCK(&so->so_snd);
1251 so->so_snd.sb_flags |= SB_UPCALL;
1252 SOCKBUF_UNLOCK(&so->so_snd);
1253
1254 /* Fill in the response data and send it or return it to the caller */
1255 resp_data = (struct ng_ksocket_accept *)resp->data;
1256 resp_data->nodeid = NG_NODE_ID(node);
1257 if (sa != NULL)
1258 bcopy(sa, &resp_data->addr, sa->sa_len);
1259 NG_SEND_MSG_ID(error, node, resp, priv->response_addr, 0);
1260
1261 out:
1262 if (sa != NULL)
1263 FREE(sa, M_SONAME);
1264 }
1265
1266 /*
1267 * Parse out either an integer value or an alias.
1268 */
1269 static int
1270 ng_ksocket_parse(const struct ng_ksocket_alias *aliases,
1271 const char *s, int family)
1272 {
1273 int k, val;
1274 char *eptr;
1275
1276 /* Try aliases */
1277 for (k = 0; aliases[k].name != NULL; k++) {
1278 if (strcmp(s, aliases[k].name) == 0
1279 && aliases[k].family == family)
1280 return aliases[k].value;
1281 }
1282
1283 /* Try parsing as a number */
1284 val = (int)strtoul(s, &eptr, 10);
1285 if (val < 0 || *eptr != '\0')
1286 return (-1);
1287 return (val);
1288 }
1289
Cache object: b83a758019307561543ccd052de6f100
|