60af28b60cab2d3c5bb057addebf821398caef94
[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.15 2007/06/03 20:51:12 dillon 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/fcntl.h>
59 #include <sys/socket.h>
60 #include <sys/socketvar.h>
61 #include <sys/socketops.h>
62 #include <sys/thread2.h>
63 #include <sys/uio.h>
64 #include <sys/un.h>
65
66 #include <netgraph/ng_message.h>
67 #include <netgraph/netgraph.h>
68 #include <netgraph/ng_parse.h>
69 #include "ng_ksocket.h"
70
71 #include <netinet/in.h>
72 #include <netproto/atalk/at.h>
73
74 #define OFFSETOF(s, e) ((char *)&((s *)0)->e - (char *)((s *)0))
75 #define SADATA_OFFSET   (OFFSETOF(struct sockaddr, sa_data))
76
77 /* Node private data */
78 struct ng_ksocket_private {
79         node_p          node;
80         hook_p          hook;
81         struct socket   *so;
82         LIST_HEAD(, ng_ksocket_private) embryos;
83         LIST_ENTRY(ng_ksocket_private)  siblings;
84         u_int32_t       flags;
85         u_int32_t       response_token;
86         char            response_addr[NG_PATHSIZ];
87 };
88 typedef struct ng_ksocket_private *priv_p;
89
90 /* Flags for priv_p */
91 #define KSF_CONNECTING  0x00000001      /* Waiting for connection complete */
92 #define KSF_ACCEPTING   0x00000002      /* Waiting for accept complete */
93 #define KSF_EOFSEEN     0x00000004      /* Have sent 0-length EOF mbuf */
94 #define KSF_CLONED      0x00000008      /* Cloned from an accepting socket */
95 #define KSF_EMBRYONIC   0x00000010      /* Cloned node with no hooks yet */
96 #define KSF_SENDING     0x00000020      /* Sending on socket */
97
98 /* Internal commands which we send to ourselves */
99 #define NGM_KSOCKET_INTERNAL_COOKIE     (NGM_KSOCKET_COOKIE + 1)
100
101 enum {
102         NGM_KSOCKET_INTERNAL_UPCALL = 1
103 };
104
105 /* Netgraph node methods */
106 static ng_constructor_t ng_ksocket_constructor;
107 static ng_rcvmsg_t      ng_ksocket_rcvmsg;
108 static ng_shutdown_t    ng_ksocket_rmnode;
109 static ng_newhook_t     ng_ksocket_newhook;
110 static ng_rcvdata_t     ng_ksocket_rcvdata;
111 static ng_disconnect_t  ng_ksocket_disconnect;
112
113 /* Alias structure */
114 struct ng_ksocket_alias {
115         const char      *name;
116         const int       value;
117         const int       family;
118 };
119
120 /* Protocol family aliases */
121 static const struct ng_ksocket_alias ng_ksocket_families[] = {
122         { "local",      PF_LOCAL        },
123         { "inet",       PF_INET         },
124         { "inet6",      PF_INET6        },
125         { "atalk",      PF_APPLETALK    },
126         { "ipx",        PF_IPX          },
127         { "atm",        PF_ATM          },
128         { NULL,         -1              },
129 };
130
131 /* Socket type aliases */
132 static const struct ng_ksocket_alias ng_ksocket_types[] = {
133         { "stream",     SOCK_STREAM     },
134         { "dgram",      SOCK_DGRAM      },
135         { "raw",        SOCK_RAW        },
136         { "rdm",        SOCK_RDM        },
137         { "seqpacket",  SOCK_SEQPACKET  },
138         { NULL,         -1              },
139 };
140
141 /* Protocol aliases */
142 static const struct ng_ksocket_alias ng_ksocket_protos[] = {
143         { "ip",         IPPROTO_IP,             PF_INET         },
144         { "raw",        IPPROTO_RAW,            PF_INET         },
145         { "icmp",       IPPROTO_ICMP,           PF_INET         },
146         { "igmp",       IPPROTO_IGMP,           PF_INET         },
147         { "tcp",        IPPROTO_TCP,            PF_INET         },
148         { "udp",        IPPROTO_UDP,            PF_INET         },
149         { "gre",        IPPROTO_GRE,            PF_INET         },
150         { "esp",        IPPROTO_ESP,            PF_INET         },
151         { "ah",         IPPROTO_AH,             PF_INET         },
152         { "swipe",      IPPROTO_SWIPE,          PF_INET         },
153         { "encap",      IPPROTO_ENCAP,          PF_INET         },
154         { "divert",     IPPROTO_DIVERT,         PF_INET         },
155         { "pim",        IPPROTO_PIM,            PF_INET         },
156         { "ddp",        ATPROTO_DDP,            PF_APPLETALK    },
157         { "aarp",       ATPROTO_AARP,           PF_APPLETALK    },
158         { NULL,         -1                                      },
159 };
160
161 /* Helper functions */
162 static int      ng_ksocket_check_accept(priv_p);
163 static void     ng_ksocket_finish_accept(priv_p, struct ng_mesg **);
164 static void     ng_ksocket_incoming(struct socket *so, void *arg, int waitflag);
165 static int      ng_ksocket_parse(const struct ng_ksocket_alias *aliases,
166                         const char *s, int family);
167
168 /************************************************************************
169                         STRUCT SOCKADDR PARSE TYPE
170  ************************************************************************/
171
172 /* Get the length of the data portion of a generic struct sockaddr */
173 static int
174 ng_parse_generic_sockdata_getLength(const struct ng_parse_type *type,
175         const u_char *start, const u_char *buf)
176 {
177         const struct sockaddr *sa;
178
179         sa = (const struct sockaddr *)(buf - SADATA_OFFSET);
180         return (sa->sa_len < SADATA_OFFSET) ? 0 : sa->sa_len - SADATA_OFFSET;
181 }
182
183 /* Type for the variable length data portion of a generic struct sockaddr */
184 static const struct ng_parse_type ng_ksocket_generic_sockdata_type = {
185         &ng_parse_bytearray_type,
186         &ng_parse_generic_sockdata_getLength
187 };
188
189 /* Type for a generic struct sockaddr */
190 static const struct ng_parse_struct_field
191     ng_parse_generic_sockaddr_type_fields[] = {
192           { "len",      &ng_parse_uint8_type                    },
193           { "family",   &ng_parse_uint8_type                    },
194           { "data",     &ng_ksocket_generic_sockdata_type       },
195           { NULL }
196 };
197 static const struct ng_parse_type ng_ksocket_generic_sockaddr_type = {
198         &ng_parse_struct_type,
199         &ng_parse_generic_sockaddr_type_fields
200 };
201
202 /* Convert a struct sockaddr from ASCII to binary.  If its a protocol
203    family that we specially handle, do that, otherwise defer to the
204    generic parse type ng_ksocket_generic_sockaddr_type. */
205 static int
206 ng_ksocket_sockaddr_parse(const struct ng_parse_type *type,
207         const char *s, int *off, const u_char *const start,
208         u_char *const buf, int *buflen)
209 {
210         struct sockaddr *const sa = (struct sockaddr *)buf;
211         enum ng_parse_token tok;
212         char fambuf[32];
213         int family, len;
214         char *t;
215
216         /* If next token is a left curly brace, use generic parse type */
217         if ((tok = ng_parse_get_token(s, off, &len)) == T_LBRACE) {
218                 return (*ng_ksocket_generic_sockaddr_type.supertype->parse)
219                     (&ng_ksocket_generic_sockaddr_type,
220                     s, off, start, buf, buflen);
221         }
222
223         /* Get socket address family followed by a slash */
224         while (isspace(s[*off]))
225                 (*off)++;
226         if ((t = index(s + *off, '/')) == NULL)
227                 return (EINVAL);
228         if ((len = t - (s + *off)) > sizeof(fambuf) - 1)
229                 return (EINVAL);
230         strncpy(fambuf, s + *off, len);
231         fambuf[len] = '\0';
232         *off += len + 1;
233         if ((family = ng_ksocket_parse(ng_ksocket_families, fambuf, 0)) == -1)
234                 return (EINVAL);
235
236         /* Set family */
237         if (*buflen < SADATA_OFFSET)
238                 return (ERANGE);
239         sa->sa_family = family;
240
241         /* Set family-specific data and length */
242         switch (sa->sa_family) {
243         case PF_LOCAL:          /* Get pathname */
244             {
245                 const int pathoff = OFFSETOF(struct sockaddr_un, sun_path);
246                 struct sockaddr_un *const sun = (struct sockaddr_un *)sa;
247                 int toklen, pathlen;
248                 char *path;
249
250                 if ((path = ng_get_string_token(s, off, &toklen)) == NULL)
251                         return (EINVAL);
252                 pathlen = strlen(path);
253                 if (pathlen > SOCK_MAXADDRLEN) {
254                         FREE(path, M_NETGRAPH);
255                         return (E2BIG);
256                 }
257                 if (*buflen < pathoff + pathlen) {
258                         FREE(path, M_NETGRAPH);
259                         return (ERANGE);
260                 }
261                 *off += toklen;
262                 bcopy(path, sun->sun_path, pathlen);
263                 sun->sun_len = pathoff + pathlen;
264                 FREE(path, M_NETGRAPH);
265                 break;
266             }
267
268         case PF_INET:           /* Get an IP address with optional port */
269             {
270                 struct sockaddr_in *const sin = (struct sockaddr_in *)sa;
271                 int i;
272
273                 /* Parse this: <ipaddress>[:port] */
274                 for (i = 0; i < 4; i++) {
275                         u_long val;
276                         char *eptr;
277
278                         val = strtoul(s + *off, &eptr, 10);
279                         if (val > 0xff || eptr == s + *off)
280                                 return (EINVAL);
281                         *off += (eptr - (s + *off));
282                         ((u_char *)&sin->sin_addr)[i] = (u_char)val;
283                         if (i < 3) {
284                                 if (s[*off] != '.')
285                                         return (EINVAL);
286                                 (*off)++;
287                         } else if (s[*off] == ':') {
288                                 (*off)++;
289                                 val = strtoul(s + *off, &eptr, 10);
290                                 if (val > 0xffff || eptr == s + *off)
291                                         return (EINVAL);
292                                 *off += (eptr - (s + *off));
293                                 sin->sin_port = htons(val);
294                         } else
295                                 sin->sin_port = 0;
296                 }
297                 bzero(&sin->sin_zero, sizeof(sin->sin_zero));
298                 sin->sin_len = sizeof(*sin);
299                 break;
300             }
301
302 #if 0
303         case PF_APPLETALK:      /* XXX implement these someday */
304         case PF_INET6:
305         case PF_IPX:
306 #endif
307
308         default:
309                 return (EINVAL);
310         }
311
312         /* Done */
313         *buflen = sa->sa_len;
314         return (0);
315 }
316
317 /* Convert a struct sockaddr from binary to ASCII */
318 static int
319 ng_ksocket_sockaddr_unparse(const struct ng_parse_type *type,
320         const u_char *data, int *off, char *cbuf, int cbuflen)
321 {
322         const struct sockaddr *sa = (const struct sockaddr *)(data + *off);
323         int slen = 0;
324
325         /* Output socket address, either in special or generic format */
326         switch (sa->sa_family) {
327         case PF_LOCAL:
328             {
329                 const int pathoff = OFFSETOF(struct sockaddr_un, sun_path);
330                 const struct sockaddr_un *sun = (const struct sockaddr_un *)sa;
331                 const int pathlen = sun->sun_len - pathoff;
332                 char pathbuf[SOCK_MAXADDRLEN + 1];
333                 char *pathtoken;
334
335                 bcopy(sun->sun_path, pathbuf, pathlen);
336                 pathbuf[pathlen] = '\0';
337                 if ((pathtoken = ng_encode_string(pathbuf)) == NULL)
338                         return (ENOMEM);
339                 slen += ksnprintf(cbuf, cbuflen, "local/%s", pathtoken);
340                 FREE(pathtoken, M_NETGRAPH);
341                 if (slen >= cbuflen)
342                         return (ERANGE);
343                 *off += sun->sun_len;
344                 return (0);
345             }
346
347         case PF_INET:
348             {
349                 const struct sockaddr_in *sin = (const struct sockaddr_in *)sa;
350
351                 slen += ksnprintf(cbuf, cbuflen, "inet/%d.%d.%d.%d",
352                   ((const u_char *)&sin->sin_addr)[0],
353                   ((const u_char *)&sin->sin_addr)[1],
354                   ((const u_char *)&sin->sin_addr)[2],
355                   ((const u_char *)&sin->sin_addr)[3]);
356                 if (sin->sin_port != 0) {
357                         slen += ksnprintf(cbuf + strlen(cbuf),
358                             cbuflen - strlen(cbuf), ":%d",
359                             (u_int)ntohs(sin->sin_port));
360                 }
361                 if (slen >= cbuflen)
362                         return (ERANGE);
363                 *off += sizeof(*sin);
364                 return(0);
365             }
366
367 #if 0
368         case PF_APPLETALK:      /* XXX implement these someday */
369         case PF_INET6:
370         case PF_IPX:
371 #endif
372
373         default:
374                 return (*ng_ksocket_generic_sockaddr_type.supertype->unparse)
375                     (&ng_ksocket_generic_sockaddr_type,
376                     data, off, cbuf, cbuflen);
377         }
378 }
379
380 /* Parse type for struct sockaddr */
381 static const struct ng_parse_type ng_ksocket_sockaddr_type = {
382         NULL,
383         NULL,
384         NULL,
385         &ng_ksocket_sockaddr_parse,
386         &ng_ksocket_sockaddr_unparse,
387         NULL            /* no such thing as a default struct sockaddr */
388 };
389
390 /************************************************************************
391                 STRUCT NG_KSOCKET_SOCKOPT PARSE TYPE
392  ************************************************************************/
393
394 /* Get length of the struct ng_ksocket_sockopt value field, which is the
395    just the excess of the message argument portion over the length of
396    the struct ng_ksocket_sockopt. */
397 static int
398 ng_parse_sockoptval_getLength(const struct ng_parse_type *type,
399         const u_char *start, const u_char *buf)
400 {
401         static const int offset = OFFSETOF(struct ng_ksocket_sockopt, value);
402         const struct ng_ksocket_sockopt *sopt;
403         const struct ng_mesg *msg;
404
405         sopt = (const struct ng_ksocket_sockopt *)(buf - offset);
406         msg = (const struct ng_mesg *)((const u_char *)sopt - sizeof(*msg));
407         return msg->header.arglen - sizeof(*sopt);
408 }
409
410 /* Parse type for the option value part of a struct ng_ksocket_sockopt
411    XXX Eventually, we should handle the different socket options specially.
412    XXX This would avoid byte order problems, eg an integer value of 1 is
413    XXX going to be "[1]" for little endian or "[3=1]" for big endian. */
414 static const struct ng_parse_type ng_ksocket_sockoptval_type = {
415         &ng_parse_bytearray_type,
416         &ng_parse_sockoptval_getLength
417 };
418
419 /* Parse type for struct ng_ksocket_sockopt */
420 static const struct ng_parse_struct_field ng_ksocket_sockopt_type_fields[]
421         = NG_KSOCKET_SOCKOPT_INFO(&ng_ksocket_sockoptval_type);
422 static const struct ng_parse_type ng_ksocket_sockopt_type = {
423         &ng_parse_struct_type,
424         &ng_ksocket_sockopt_type_fields
425 };
426
427 /* Parse type for struct ng_ksocket_accept */
428 static const struct ng_parse_struct_field ng_ksocket_accept_type_fields[]
429         = NGM_KSOCKET_ACCEPT_INFO;
430 static const struct ng_parse_type ng_ksocket_accept_type = {
431         &ng_parse_struct_type,
432         &ng_ksocket_accept_type_fields
433 };
434
435 /* List of commands and how to convert arguments to/from ASCII */
436 static const struct ng_cmdlist ng_ksocket_cmds[] = {
437         {
438           NGM_KSOCKET_COOKIE,
439           NGM_KSOCKET_BIND,
440           "bind",
441           &ng_ksocket_sockaddr_type,
442           NULL
443         },
444         {
445           NGM_KSOCKET_COOKIE,
446           NGM_KSOCKET_LISTEN,
447           "listen",
448           &ng_parse_int32_type,
449           NULL
450         },
451         {
452           NGM_KSOCKET_COOKIE,
453           NGM_KSOCKET_ACCEPT,
454           "accept",
455           NULL,
456           &ng_ksocket_accept_type
457         },
458         {
459           NGM_KSOCKET_COOKIE,
460           NGM_KSOCKET_CONNECT,
461           "connect",
462           &ng_ksocket_sockaddr_type,
463           &ng_parse_int32_type
464         },
465         {
466           NGM_KSOCKET_COOKIE,
467           NGM_KSOCKET_GETNAME,
468           "getname",
469           NULL,
470           &ng_ksocket_sockaddr_type
471         },
472         {
473           NGM_KSOCKET_COOKIE,
474           NGM_KSOCKET_GETPEERNAME,
475           "getpeername",
476           NULL,
477           &ng_ksocket_sockaddr_type
478         },
479         {
480           NGM_KSOCKET_COOKIE,
481           NGM_KSOCKET_SETOPT,
482           "setopt",
483           &ng_ksocket_sockopt_type,
484           NULL
485         },
486         {
487           NGM_KSOCKET_COOKIE,
488           NGM_KSOCKET_GETOPT,
489           "getopt",
490           &ng_ksocket_sockopt_type,
491           &ng_ksocket_sockopt_type
492         },
493
494         /* Internal commands */
495         {
496           NGM_KSOCKET_INTERNAL_COOKIE,
497           NGM_KSOCKET_INTERNAL_UPCALL,
498           "upcall",
499           NULL,
500           NULL
501         },
502         { 0 }
503 };
504
505 /* Node type descriptor */
506 static struct ng_type ng_ksocket_typestruct = {
507         NG_VERSION,
508         NG_KSOCKET_NODE_TYPE,
509         NULL,
510         ng_ksocket_constructor,
511         ng_ksocket_rcvmsg,
512         ng_ksocket_rmnode,
513         ng_ksocket_newhook,
514         NULL,
515         NULL,
516         ng_ksocket_rcvdata,
517         ng_ksocket_rcvdata,
518         ng_ksocket_disconnect,
519         ng_ksocket_cmds
520 };
521 NETGRAPH_INIT(ksocket, &ng_ksocket_typestruct);
522
523 #define ERROUT(x)       do { error = (x); goto done; } while (0)
524
525 /************************************************************************
526                         NETGRAPH NODE STUFF
527  ************************************************************************/
528
529 /*
530  * Node type constructor
531  */
532 static int
533 ng_ksocket_constructor(node_p *nodep)
534 {
535         priv_p priv;
536         int error;
537
538         /* Allocate private structure */
539         MALLOC(priv, priv_p, sizeof(*priv), M_NETGRAPH, M_NOWAIT);
540         if (priv == NULL)
541                 return (ENOMEM);
542         bzero(priv, sizeof(*priv));
543
544         /* Call generic node constructor */
545         if ((error = ng_make_node_common(&ng_ksocket_typestruct, nodep))) {
546                 FREE(priv, M_NETGRAPH);
547                 return (error);
548         }
549         (*nodep)->private = priv;
550         priv->node = *nodep;
551         LIST_INIT(&priv->embryos);
552
553         /* Done */
554         return (0);
555 }
556
557 /*
558  * Give our OK for a hook to be added. The hook name is of the
559  * form "<family>/<type>/<proto>" where the three components may
560  * be decimal numbers or else aliases from the above lists.
561  *
562  * Connecting a hook amounts to opening the socket.  Disconnecting
563  * the hook closes the socket and destroys the node as well.
564  */
565 static int
566 ng_ksocket_newhook(node_p node, hook_p hook, const char *name0)
567 {
568         struct thread *td = curthread->td_proc ? curthread : &thread0;  /* XXX broken */
569         const priv_p priv = node->private;
570         struct ng_mesg *msg;
571         char *s1, *s2, name[NG_HOOKSIZ];
572         int family, type, protocol, error;
573
574         /* Check if we're already connected */
575         if (priv->hook != NULL)
576                 return (EISCONN);
577
578         if (priv->flags & KSF_CLONED) {
579                 if (priv->flags & KSF_EMBRYONIC) {
580                         /* Remove ourselves from our parent's embryo list */
581                         LIST_REMOVE(priv, siblings);
582                         priv->flags &= ~KSF_EMBRYONIC;
583                 }
584         } else {
585                 /* Extract family, type, and protocol from hook name */
586                 ksnprintf(name, sizeof(name), "%s", name0);
587                 s1 = name;
588                 if ((s2 = index(s1, '/')) == NULL)
589                         return (EINVAL);
590                 *s2++ = '\0';
591                 family = ng_ksocket_parse(ng_ksocket_families, s1, 0);
592                 if (family == -1)
593                         return (EINVAL);
594                 s1 = s2;
595                 if ((s2 = index(s1, '/')) == NULL)
596                         return (EINVAL);
597                 *s2++ = '\0';
598                 type = ng_ksocket_parse(ng_ksocket_types, s1, 0);
599                 if (type == -1)
600                         return (EINVAL);
601                 s1 = s2;
602                 protocol = ng_ksocket_parse(ng_ksocket_protos, s1, family);
603                 if (protocol == -1)
604                         return (EINVAL);
605
606                 /* Create the socket */
607                 error = socreate(family, &priv->so, type, protocol, td);
608                 if (error != 0)
609                         return (error);
610
611                 /* XXX call soreserve() ? */
612
613                 /* Add our hook for incoming data and other events */
614                 priv->so->so_upcallarg = (caddr_t)node;
615                 priv->so->so_upcall = ng_ksocket_incoming;
616                 priv->so->so_rcv.ssb_flags |= SSB_UPCALL;
617                 priv->so->so_snd.ssb_flags |= SSB_UPCALL;
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.ssb_flags &= ~SSB_UPCALL;
941                 priv->so->so_snd.ssb_flags &= ~SSB_UPCALL;
942                 soclose(priv->so, FNONBLOCK);
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 ng_mesg *response;
995         int error;
996
997         crit_enter();
998
999         /* Sanity check */
1000         if ((node->flags & NG_INVALID) != 0) {
1001                 crit_exit();
1002                 return;
1003         }
1004         KASSERT(so == priv->so, ("%s: wrong socket", __func__));
1005
1006         /* Check whether a pending connect operation has completed */
1007         if (priv->flags & KSF_CONNECTING) {
1008                 if ((error = so->so_error) != 0) {
1009                         so->so_error = 0;
1010                         so->so_state &= ~SS_ISCONNECTING;
1011                 }
1012                 if (!(so->so_state & SS_ISCONNECTING)) {
1013                         NG_MKMESSAGE(response, NGM_KSOCKET_COOKIE,
1014                             NGM_KSOCKET_CONNECT, sizeof(int32_t), waitflag);
1015                         if (response != NULL) {
1016                                 response->header.flags |= NGF_RESP;
1017                                 response->header.token = priv->response_token;
1018                                 *(int32_t *)response->data = error;
1019                                 /*
1020                                  * XXX We use ng_queue_msg here because we are
1021                                  * being called from deep in the bowels of the TCP
1022                                  * stack.  Is this right, or should we let the
1023                                  * receiver of the message worry about that?
1024                                  */
1025                                 ng_queue_msg(node, response,
1026                                     priv->response_addr);
1027                         }
1028                         priv->flags &= ~KSF_CONNECTING;
1029                 }
1030         }
1031
1032         /* Check whether a pending accept operation has completed */
1033         if (priv->flags & KSF_ACCEPTING) {
1034                 error = ng_ksocket_check_accept(priv);
1035                 if (error != EWOULDBLOCK)
1036                         priv->flags &= ~KSF_ACCEPTING;
1037                 if (error == 0)
1038                         ng_ksocket_finish_accept(priv, NULL);
1039         }
1040
1041         /*
1042          * If we don't have a hook, we must handle data events later.  When
1043          * the hook gets created and is connected, this upcall function
1044          * will be called again.
1045          */
1046         if (priv->hook == NULL) {
1047                 crit_exit();
1048                 return;
1049         }
1050
1051         /* Read and forward available mbuf's */
1052         while (1) {
1053                 struct sockaddr *sa = NULL;
1054                 struct sockbuf sio;
1055                 meta_p meta = NULL;
1056                 struct mbuf *n;
1057                 int flags;
1058
1059                 sbinit(&sio, 1000000000);
1060                 flags = MSG_DONTWAIT;
1061
1062                 /* Try to get next packet from socket */
1063                 error = so_pru_soreceive(so,
1064                                 ((so->so_state & SS_ISCONNECTED) ? NULL : &sa),
1065                                 NULL, &sio, NULL, &flags);
1066                 if (error)
1067                         break;
1068
1069                 /* See if we got anything */
1070                 if (sio.sb_mb == NULL) {
1071                         if (sa != NULL)
1072                                 FREE(sa, M_SONAME);
1073                         break;
1074                 }
1075
1076                 /* Don't trust the various socket layers to get the
1077                    packet header and length correct (eg. kern/15175) */
1078                 sio.sb_mb->m_pkthdr.len = 0;
1079                 for (n = sio.sb_mb; n != NULL; n = n->m_next)
1080                         sio.sb_mb->m_pkthdr.len += n->m_len;
1081
1082                 /* Put peer's socket address (if any) into a meta info blob */
1083                 if (sa != NULL) {
1084                         struct meta_field_header *mhead;
1085                         u_int len;
1086
1087                         len = sizeof(*meta) + sizeof(*mhead) + sa->sa_len;
1088                         MALLOC(meta, meta_p, len, M_NETGRAPH, M_NOWAIT);
1089                         if (meta == NULL) {
1090                                 FREE(sa, M_SONAME);
1091                                 goto sendit;
1092                         }
1093                         mhead = &meta->options[0];
1094                         bzero(meta, sizeof(*meta));
1095                         bzero(mhead, sizeof(*mhead));
1096                         meta->allocated_len = len;
1097                         meta->used_len = len;
1098                         mhead->cookie = NGM_KSOCKET_COOKIE;
1099                         mhead->type = NG_KSOCKET_META_SOCKADDR;
1100                         mhead->len = sizeof(*mhead) + sa->sa_len;
1101                         bcopy(sa, mhead->data, sa->sa_len);
1102                         FREE(sa, M_SONAME);
1103                 }
1104 sendit:         /* Forward data with optional peer sockaddr as meta info */
1105                 NG_SEND_DATA(error, priv->hook, sio.sb_mb, meta);
1106         }
1107
1108         /*
1109          * If the peer has closed the connection, forward a 0-length mbuf
1110          * to indicate end-of-file.
1111          */
1112         if (so->so_state & SS_CANTRCVMORE && !(priv->flags & KSF_EOFSEEN)) {
1113                 struct mbuf *m;
1114
1115                 MGETHDR(m, waitflag, MT_DATA);
1116                 if (m != NULL) {
1117                         m->m_len = m->m_pkthdr.len = 0;
1118                         NG_SEND_DATA_ONLY(error, priv->hook, m);
1119                 }
1120                 priv->flags |= KSF_EOFSEEN;
1121         }
1122
1123         crit_exit();
1124 }
1125
1126 /*
1127  * Check for a completed incoming connection and return 0 if one is found.
1128  * Otherwise return the appropriate error code.
1129  */
1130 static int
1131 ng_ksocket_check_accept(priv_p priv)
1132 {
1133         struct socket *const head = priv->so;
1134         int error;
1135
1136         if ((error = head->so_error) != 0) {
1137                 head->so_error = 0;
1138                 return error;
1139         }
1140         if (TAILQ_EMPTY(&head->so_comp)) {
1141                 if (head->so_state & SS_CANTRCVMORE)
1142                         return ECONNABORTED;
1143                 return EWOULDBLOCK;
1144         }
1145         return 0;
1146 }
1147
1148 /*
1149  * Handle the first completed incoming connection, assumed to be already
1150  * on the socket's so_comp queue.
1151  */
1152 static void
1153 ng_ksocket_finish_accept(priv_p priv, struct ng_mesg **rptr)
1154 {
1155         struct socket *const head = priv->so;
1156         struct socket *so;
1157         struct sockaddr *sa = NULL;
1158         struct ng_mesg *resp;
1159         struct ng_ksocket_accept *resp_data;
1160         node_p node2;
1161         priv_p priv2;
1162         int len;
1163
1164         so = TAILQ_FIRST(&head->so_comp);
1165         if (so == NULL)         /* Should never happen */
1166                 return;
1167         TAILQ_REMOVE(&head->so_comp, so, so_list);
1168         head->so_qlen--;
1169
1170         /* XXX KNOTE(&head->so_rcv.ssb_sel.si_note, 0); */
1171
1172         so->so_state &= ~SS_COMP;
1173         so->so_head = NULL;
1174
1175         soaccept(so, &sa);
1176
1177         len = OFFSETOF(struct ng_ksocket_accept, addr);
1178         if (sa != NULL)
1179                 len += sa->sa_len;
1180
1181         NG_MKMESSAGE(resp, NGM_KSOCKET_COOKIE, NGM_KSOCKET_ACCEPT, len,
1182             M_NOWAIT);
1183         if (resp == NULL) {
1184                 soclose(so, FNONBLOCK);
1185                 goto out;
1186         }
1187         resp->header.flags |= NGF_RESP;
1188         resp->header.token = priv->response_token;
1189
1190         /* Clone a ksocket node to wrap the new socket */
1191         if (ng_ksocket_constructor(&node2) != 0) {
1192                 FREE(resp, M_NETGRAPH);
1193                 soclose(so, FNONBLOCK);
1194                 goto out;
1195         }
1196         priv2 = (priv_p)node2->private;
1197         priv2->so = so;
1198         priv2->flags |= KSF_CLONED | KSF_EMBRYONIC;
1199
1200         /*
1201          * Insert the cloned node into a list of embryonic children
1202          * on the parent node.  When a hook is created on the cloned
1203          * node it will be removed from this list.  When the parent
1204          * is destroyed it will destroy any embryonic children it has.
1205          */
1206         LIST_INSERT_HEAD(&priv->embryos, priv2, siblings);
1207
1208         so->so_upcallarg = (caddr_t)node2;
1209         so->so_upcall = ng_ksocket_incoming;
1210         so->so_rcv.ssb_flags |= SSB_UPCALL;
1211         so->so_snd.ssb_flags |= SSB_UPCALL;
1212
1213         /* Fill in the response data and send it or return it to the caller */
1214         resp_data = (struct ng_ksocket_accept *)resp->data;
1215         resp_data->nodeid = node2->ID;
1216         if (sa != NULL)
1217                 bcopy(sa, &resp_data->addr, sa->sa_len);
1218         if (rptr != NULL)
1219                 *rptr = resp;
1220         else
1221                 ng_queue_msg(priv->node, resp, priv->response_addr);
1222
1223 out:
1224         if (sa != NULL)
1225                 FREE(sa, M_SONAME);
1226 }
1227
1228 /*
1229  * Parse out either an integer value or an alias.
1230  */
1231 static int
1232 ng_ksocket_parse(const struct ng_ksocket_alias *aliases,
1233         const char *s, int family)
1234 {
1235         int k, val;
1236         char *eptr;
1237
1238         /* Try aliases */
1239         for (k = 0; aliases[k].name != NULL; k++) {
1240                 if (strcmp(s, aliases[k].name) == 0
1241                     && aliases[k].family == family)
1242                         return aliases[k].value;
1243         }
1244
1245         /* Try parsing as a number */
1246         val = (int)strtoul(s, &eptr, 10);
1247         if (val < 0 || *eptr != '\0')
1248                 return (-1);
1249         return (val);
1250 }
1251