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