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