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