6 * Copyright (c) 1996-1999 Whistle Communications, Inc.
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.
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
38 * Author: Archie Cobbs <archie@freebsd.org>
41 * $Whistle: ng_ksocket.c,v 1.1 1999/11/16 20:04:40 archie Exp $
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.
49 #include <sys/param.h>
50 #include <sys/systm.h>
51 #include <sys/kernel.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>
63 #include <netgraph/ng_message.h>
64 #include <netgraph/netgraph.h>
65 #include <netgraph/ng_parse.h>
66 #include <netgraph/ng_ksocket.h>
68 #include <netinet/in.h>
69 #include <netatalk/at.h>
71 #ifdef NG_SEPARATE_MALLOC
72 MALLOC_DEFINE(M_NETGRAPH_KSOCKET, "netgraph_ksock", "netgraph ksock node ");
74 #define M_NETGRAPH_KSOCKET M_NETGRAPH
77 #define OFFSETOF(s, e) ((char *)&((s *)0)->e - (char *)((s *)0))
78 #define SADATA_OFFSET (OFFSETOF(struct sockaddr, sa_data))
80 /* Node private data */
81 struct ng_ksocket_private {
85 LIST_HEAD(, ng_ksocket_private) embryos;
86 LIST_ENTRY(ng_ksocket_private) siblings;
88 u_int32_t response_token;
89 ng_ID_t response_addr;
91 typedef struct ng_ksocket_private *priv_p;
93 /* Flags for priv_p */
94 #define KSF_CONNECTING 0x00000001 /* Waiting for connection complete */
95 #define KSF_ACCEPTING 0x00000002 /* Waiting for accept complete */
96 #define KSF_EOFSEEN 0x00000004 /* Have sent 0-length EOF mbuf */
97 #define KSF_CLONED 0x00000008 /* Cloned from an accepting socket */
98 #define KSF_EMBRYONIC 0x00000010 /* Cloned node with no hooks yet */
100 /* Netgraph node methods */
101 static ng_constructor_t ng_ksocket_constructor;
102 static ng_rcvmsg_t ng_ksocket_rcvmsg;
103 static ng_shutdown_t ng_ksocket_shutdown;
104 static ng_newhook_t ng_ksocket_newhook;
105 static ng_rcvdata_t ng_ksocket_rcvdata;
106 static ng_connect_t ng_ksocket_connect;
107 static ng_disconnect_t ng_ksocket_disconnect;
109 /* Alias structure */
110 struct ng_ksocket_alias {
116 /* Protocol family aliases */
117 static const struct ng_ksocket_alias ng_ksocket_families[] = {
118 { "local", PF_LOCAL },
120 { "inet6", PF_INET6 },
121 { "atalk", PF_APPLETALK },
127 /* Socket type aliases */
128 static const struct ng_ksocket_alias ng_ksocket_types[] = {
129 { "stream", SOCK_STREAM },
130 { "dgram", SOCK_DGRAM },
133 { "seqpacket", SOCK_SEQPACKET },
137 /* Protocol aliases */
138 static const struct ng_ksocket_alias ng_ksocket_protos[] = {
139 { "ip", IPPROTO_IP, PF_INET },
140 { "raw", IPPROTO_RAW, PF_INET },
141 { "icmp", IPPROTO_ICMP, PF_INET },
142 { "igmp", IPPROTO_IGMP, PF_INET },
143 { "tcp", IPPROTO_TCP, PF_INET },
144 { "udp", IPPROTO_UDP, PF_INET },
145 { "gre", IPPROTO_GRE, PF_INET },
146 { "esp", IPPROTO_ESP, PF_INET },
147 { "ah", IPPROTO_AH, PF_INET },
148 { "swipe", IPPROTO_SWIPE, PF_INET },
149 { "encap", IPPROTO_ENCAP, PF_INET },
150 { "divert", IPPROTO_DIVERT, PF_INET },
151 { "pim", IPPROTO_PIM, PF_INET },
152 { "ddp", ATPROTO_DDP, PF_APPLETALK },
153 { "aarp", ATPROTO_AARP, PF_APPLETALK },
157 /* Helper functions */
158 static int ng_ksocket_check_accept(priv_p);
159 static void ng_ksocket_finish_accept(priv_p);
160 static void ng_ksocket_incoming(struct socket *so, void *arg, int waitflag);
161 static int ng_ksocket_parse(const struct ng_ksocket_alias *aliases,
162 const char *s, int family);
163 static void ng_ksocket_incoming2(node_p node, hook_p hook,
164 void *arg1, int waitflag);
166 /************************************************************************
167 STRUCT SOCKADDR PARSE TYPE
168 ************************************************************************/
170 /* Get the length of the data portion of a generic struct sockaddr */
172 ng_parse_generic_sockdata_getLength(const struct ng_parse_type *type,
173 const u_char *start, const u_char *buf)
175 const struct sockaddr *sa;
177 sa = (const struct sockaddr *)(buf - SADATA_OFFSET);
178 return (sa->sa_len < SADATA_OFFSET) ? 0 : sa->sa_len - SADATA_OFFSET;
181 /* Type for the variable length data portion of a generic struct sockaddr */
182 static const struct ng_parse_type ng_ksocket_generic_sockdata_type = {
183 &ng_parse_bytearray_type,
184 &ng_parse_generic_sockdata_getLength
187 /* Type for a generic struct sockaddr */
188 static const struct ng_parse_struct_field
189 ng_parse_generic_sockaddr_type_fields[] = {
190 { "len", &ng_parse_uint8_type },
191 { "family", &ng_parse_uint8_type },
192 { "data", &ng_ksocket_generic_sockdata_type },
195 static const struct ng_parse_type ng_ksocket_generic_sockaddr_type = {
196 &ng_parse_struct_type,
197 &ng_parse_generic_sockaddr_type_fields
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. */
204 ng_ksocket_sockaddr_parse(const struct ng_parse_type *type,
205 const char *s, int *off, const u_char *const start,
206 u_char *const buf, int *buflen)
208 struct sockaddr *const sa = (struct sockaddr *)buf;
209 enum ng_parse_token tok;
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);
221 /* Get socket address family followed by a slash */
222 while (isspace(s[*off]))
224 if ((t = index(s + *off, '/')) == NULL)
226 if ((len = t - (s + *off)) > sizeof(fambuf) - 1)
228 strncpy(fambuf, s + *off, len);
231 if ((family = ng_ksocket_parse(ng_ksocket_families, fambuf, 0)) == -1)
235 if (*buflen < SADATA_OFFSET)
237 sa->sa_family = family;
239 /* Set family-specific data and length */
240 switch (sa->sa_family) {
241 case PF_LOCAL: /* Get pathname */
243 const int pathoff = OFFSETOF(struct sockaddr_un, sun_path);
244 struct sockaddr_un *const sun = (struct sockaddr_un *)sa;
248 if ((path = ng_get_string_token(s, off, &toklen, NULL)) == NULL)
250 pathlen = strlen(path);
251 if (pathlen > SOCK_MAXADDRLEN) {
252 FREE(path, M_NETGRAPH_KSOCKET);
255 if (*buflen < pathoff + pathlen) {
256 FREE(path, M_NETGRAPH_KSOCKET);
260 bcopy(path, sun->sun_path, pathlen);
261 sun->sun_len = pathoff + pathlen;
262 FREE(path, M_NETGRAPH_KSOCKET);
266 case PF_INET: /* Get an IP address with optional port */
268 struct sockaddr_in *const sin = (struct sockaddr_in *)sa;
271 /* Parse this: <ipaddress>[:port] */
272 for (i = 0; i < 4; i++) {
276 val = strtoul(s + *off, &eptr, 10);
277 if (val > 0xff || eptr == s + *off)
279 *off += (eptr - (s + *off));
280 ((u_char *)&sin->sin_addr)[i] = (u_char)val;
285 } else if (s[*off] == ':') {
287 val = strtoul(s + *off, &eptr, 10);
288 if (val > 0xffff || eptr == s + *off)
290 *off += (eptr - (s + *off));
291 sin->sin_port = htons(val);
295 bzero(&sin->sin_zero, sizeof(sin->sin_zero));
296 sin->sin_len = sizeof(*sin);
301 case PF_APPLETALK: /* XXX implement these someday */
311 *buflen = sa->sa_len;
315 /* Convert a struct sockaddr from binary to ASCII */
317 ng_ksocket_sockaddr_unparse(const struct ng_parse_type *type,
318 const u_char *data, int *off, char *cbuf, int cbuflen)
320 const struct sockaddr *sa = (const struct sockaddr *)(data + *off);
323 /* Output socket address, either in special or generic format */
324 switch (sa->sa_family) {
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];
333 bcopy(sun->sun_path, pathbuf, pathlen);
334 if ((pathtoken = ng_encode_string(pathbuf, pathlen)) == NULL)
336 slen += snprintf(cbuf, cbuflen, "local/%s", pathtoken);
337 FREE(pathtoken, M_NETGRAPH_KSOCKET);
340 *off += sun->sun_len;
346 const struct sockaddr_in *sin = (const struct sockaddr_in *)sa;
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));
360 *off += sizeof(*sin);
365 case PF_APPLETALK: /* XXX implement these someday */
371 return (*ng_ksocket_generic_sockaddr_type.supertype->unparse)
372 (&ng_ksocket_generic_sockaddr_type,
373 data, off, cbuf, cbuflen);
377 /* Parse type for struct sockaddr */
378 static const struct ng_parse_type ng_ksocket_sockaddr_type = {
382 &ng_ksocket_sockaddr_parse,
383 &ng_ksocket_sockaddr_unparse,
384 NULL /* no such thing as a default struct sockaddr */
387 /************************************************************************
388 STRUCT NG_KSOCKET_SOCKOPT PARSE TYPE
389 ************************************************************************/
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. */
395 ng_parse_sockoptval_getLength(const struct ng_parse_type *type,
396 const u_char *start, const u_char *buf)
398 static const int offset = OFFSETOF(struct ng_ksocket_sockopt, value);
399 const struct ng_ksocket_sockopt *sopt;
400 const struct ng_mesg *msg;
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);
407 /* Parse type for the option value part of a struct ng_ksocket_sockopt
408 XXX Eventually, we should handle the different socket options specially.
409 XXX This would avoid byte order problems, eg an integer value of 1 is
410 XXX going to be "[1]" for little endian or "[3=1]" for big endian. */
411 static const struct ng_parse_type ng_ksocket_sockoptval_type = {
412 &ng_parse_bytearray_type,
413 &ng_parse_sockoptval_getLength
416 /* Parse type for struct ng_ksocket_sockopt */
417 static const struct ng_parse_struct_field ng_ksocket_sockopt_type_fields[]
418 = NG_KSOCKET_SOCKOPT_INFO(&ng_ksocket_sockoptval_type);
419 static const struct ng_parse_type ng_ksocket_sockopt_type = {
420 &ng_parse_struct_type,
421 &ng_ksocket_sockopt_type_fields
424 /* Parse type for struct ng_ksocket_accept */
425 static const struct ng_parse_struct_field ng_ksocket_accept_type_fields[]
426 = NGM_KSOCKET_ACCEPT_INFO;
427 static const struct ng_parse_type ng_ksocket_accept_type = {
428 &ng_parse_struct_type,
429 &ng_ksocket_accept_type_fields
432 /* List of commands and how to convert arguments to/from ASCII */
433 static const struct ng_cmdlist ng_ksocket_cmds[] = {
438 &ng_ksocket_sockaddr_type,
445 &ng_parse_int32_type,
453 &ng_ksocket_accept_type
459 &ng_ksocket_sockaddr_type,
467 &ng_ksocket_sockaddr_type
471 NGM_KSOCKET_GETPEERNAME,
474 &ng_ksocket_sockaddr_type
480 &ng_ksocket_sockopt_type,
487 &ng_ksocket_sockopt_type,
488 &ng_ksocket_sockopt_type
493 /* Node type descriptor */
494 static struct ng_type ng_ksocket_typestruct = {
495 .version = NG_ABI_VERSION,
496 .name = NG_KSOCKET_NODE_TYPE,
497 .constructor = ng_ksocket_constructor,
498 .rcvmsg = ng_ksocket_rcvmsg,
499 .shutdown = ng_ksocket_shutdown,
500 .newhook = ng_ksocket_newhook,
501 .connect = ng_ksocket_connect,
502 .rcvdata = ng_ksocket_rcvdata,
503 .disconnect = ng_ksocket_disconnect,
504 .cmdlist = ng_ksocket_cmds,
506 NETGRAPH_INIT(ksocket, &ng_ksocket_typestruct);
508 #define ERROUT(x) do { error = (x); goto done; } while (0)
510 /************************************************************************
512 ************************************************************************/
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.
520 ng_ksocket_constructor(node_p node)
524 /* Allocate private structure */
525 MALLOC(priv, priv_p, sizeof(*priv),
526 M_NETGRAPH_KSOCKET, M_NOWAIT | M_ZERO);
530 LIST_INIT(&priv->embryos);
531 /* cross link them */
533 NG_NODE_SET_PRIVATE(node, priv);
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.
544 * Connecting a hook amounts to opening the socket. Disconnecting
545 * the hook closes the socket and destroys the node as well.
548 ng_ksocket_newhook(node_p node, hook_p hook, const char *name0)
550 struct thread *td = curthread; /* XXX broken */
551 const priv_p priv = NG_NODE_PRIVATE(node);
552 char *s1, *s2, name[NG_HOOKSIZ];
553 int family, type, protocol, error;
555 /* Check if we're already connected */
556 if (priv->hook != NULL)
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;
566 /* Extract family, type, and protocol from hook name */
567 snprintf(name, sizeof(name), "%s", name0);
569 if ((s2 = index(s1, '/')) == NULL)
572 family = ng_ksocket_parse(ng_ksocket_families, s1, 0);
576 if ((s2 = index(s1, '/')) == NULL)
579 type = ng_ksocket_parse(ng_ksocket_types, s1, 0);
583 protocol = ng_ksocket_parse(ng_ksocket_protos, s1, family);
587 /* Create the socket */
588 error = socreate(family, &priv->so, type, protocol,
593 /* XXX call soreserve() ? */
601 * In case of misconfigured routing a packet may reenter
602 * ksocket node recursively. Decouple stack to avoid possible
603 * panics about sleeping with locks held.
605 NG_HOOK_FORCE_QUEUE(hook);
611 ng_ksocket_connect(hook_p hook)
613 node_p node = NG_HOOK_NODE(hook);
614 const priv_p priv = NG_NODE_PRIVATE(node);
615 struct socket *const so = priv->so;
617 /* Add our hook for incoming data and other events */
618 priv->so->so_upcallarg = (caddr_t)node;
619 priv->so->so_upcall = ng_ksocket_incoming;
620 SOCKBUF_LOCK(&priv->so->so_rcv);
621 priv->so->so_rcv.sb_flags |= SB_UPCALL;
622 SOCKBUF_UNLOCK(&priv->so->so_rcv);
623 SOCKBUF_LOCK(&priv->so->so_snd);
624 priv->so->so_snd.sb_flags |= SB_UPCALL;
625 SOCKBUF_UNLOCK(&priv->so->so_snd);
627 priv->so->so_state |= SS_NBIO;
628 SOCK_UNLOCK(priv->so);
630 * --Original comment--
631 * On a cloned socket we may have already received one or more
632 * upcalls which we couldn't handle without a hook. Handle
634 * We cannot call the upcall function directly
635 * from here, because until this function has returned our
636 * hook isn't connected.
638 * ---meta comment for -current ---
639 * XXX This is dubius.
640 * Upcalls between the time that the hook was
641 * first created and now (on another processesor) will
642 * be earlier on the queue than the request to finalise the hook.
643 * By the time the hook is finalised,
644 * The queued upcalls will have happenned and the code
645 * will have discarded them because of a lack of a hook.
648 * This is a bad byproduct of the complicated way in which hooks
649 * are now created (3 daisy chained async events).
651 * Since we are a netgraph operation
652 * We know that we hold a lock on this node. This forces the
653 * request we make below to be queued rather than implemented
654 * immediatly which will cause the upcall function to be called a bit
656 * However, as we will run any waiting queued operations immediatly
657 * after doing this one, if we have not finalised the other end
658 * of the hook, those queued operations will fail.
660 if (priv->flags & KSF_CLONED) {
661 ng_send_fn(node, NULL, &ng_ksocket_incoming2, so, M_NOWAIT);
668 * Receive a control message
671 ng_ksocket_rcvmsg(node_p node, item_p item, hook_p lasthook)
673 struct thread *td = curthread; /* XXX broken */
674 const priv_p priv = NG_NODE_PRIVATE(node);
675 struct socket *const so = priv->so;
676 struct ng_mesg *resp = NULL;
681 NGI_GET_MSG(item, msg);
682 switch (msg->header.typecookie) {
683 case NGM_KSOCKET_COOKIE:
684 switch (msg->header.cmd) {
685 case NGM_KSOCKET_BIND:
687 struct sockaddr *const sa
688 = (struct sockaddr *)msg->data;
691 if (msg->header.arglen < SADATA_OFFSET
692 || msg->header.arglen < sa->sa_len)
698 error = sobind(so, sa, td);
701 case NGM_KSOCKET_LISTEN:
704 if (msg->header.arglen != sizeof(int32_t))
710 error = solisten(so, *((int32_t *)msg->data), td);
714 case NGM_KSOCKET_ACCEPT:
717 if (msg->header.arglen != 0)
722 /* Make sure the socket is capable of accepting */
723 if (!(so->so_options & SO_ACCEPTCONN))
725 if (priv->flags & KSF_ACCEPTING)
728 error = ng_ksocket_check_accept(priv);
729 if (error != 0 && error != EWOULDBLOCK)
733 * If a connection is already complete, take it.
734 * Otherwise let the upcall function deal with
735 * the connection when it comes in.
737 priv->response_token = msg->header.token;
738 raddr = priv->response_addr = NGI_RETADDR(item);
740 ng_ksocket_finish_accept(priv);
742 priv->flags |= KSF_ACCEPTING;
746 case NGM_KSOCKET_CONNECT:
748 struct sockaddr *const sa
749 = (struct sockaddr *)msg->data;
752 if (msg->header.arglen < SADATA_OFFSET
753 || msg->header.arglen < sa->sa_len)
759 if ((so->so_state & SS_ISCONNECTING) != 0)
761 if ((error = soconnect(so, sa, td)) != 0) {
762 so->so_state &= ~SS_ISCONNECTING;
765 if ((so->so_state & SS_ISCONNECTING) != 0) {
766 /* We will notify the sender when we connect */
767 priv->response_token = msg->header.token;
768 raddr = priv->response_addr = NGI_RETADDR(item);
769 priv->flags |= KSF_CONNECTING;
775 case NGM_KSOCKET_GETNAME:
776 case NGM_KSOCKET_GETPEERNAME:
778 int (*func)(struct socket *so, struct sockaddr **nam);
779 struct sockaddr *sa = NULL;
783 if (msg->header.arglen != 0)
789 if (msg->header.cmd == NGM_KSOCKET_GETPEERNAME) {
791 & (SS_ISCONNECTED|SS_ISCONFIRMING)) == 0)
793 func = so->so_proto->pr_usrreqs->pru_peeraddr;
795 func = so->so_proto->pr_usrreqs->pru_sockaddr;
797 /* Get local or peer address */
798 if ((error = (*func)(so, &sa)) != 0)
800 len = (sa == NULL) ? 0 : sa->sa_len;
802 /* Send it back in a response */
803 NG_MKRESPONSE(resp, msg, len, M_NOWAIT);
808 bcopy(sa, resp->data, len);
817 case NGM_KSOCKET_GETOPT:
819 struct ng_ksocket_sockopt *ksopt =
820 (struct ng_ksocket_sockopt *)msg->data;
824 if (msg->header.arglen != sizeof(*ksopt))
829 /* Get response with room for option value */
830 NG_MKRESPONSE(resp, msg, sizeof(*ksopt)
831 + NG_KSOCKET_MAX_OPTLEN, M_NOWAIT);
835 /* Get socket option, and put value in the response */
836 sopt.sopt_dir = SOPT_GET;
837 sopt.sopt_level = ksopt->level;
838 sopt.sopt_name = ksopt->name;
840 sopt.sopt_valsize = NG_KSOCKET_MAX_OPTLEN;
841 ksopt = (struct ng_ksocket_sockopt *)resp->data;
842 sopt.sopt_val = ksopt->value;
843 if ((error = sogetopt(so, &sopt)) != 0) {
848 /* Set actual value length */
849 resp->header.arglen = sizeof(*ksopt)
854 case NGM_KSOCKET_SETOPT:
856 struct ng_ksocket_sockopt *const ksopt =
857 (struct ng_ksocket_sockopt *)msg->data;
858 const int valsize = msg->header.arglen - sizeof(*ksopt);
867 /* Set socket option */
868 sopt.sopt_dir = SOPT_SET;
869 sopt.sopt_level = ksopt->level;
870 sopt.sopt_name = ksopt->name;
871 sopt.sopt_val = ksopt->value;
872 sopt.sopt_valsize = valsize;
874 error = sosetopt(so, &sopt);
888 NG_RESPOND_MSG(error, node, item, resp);
894 * Receive incoming data on our hook. Send it out the socket.
897 ng_ksocket_rcvdata(hook_p hook, item_p item)
899 struct thread *td = curthread; /* XXX broken */
900 const node_p node = NG_HOOK_NODE(hook);
901 const priv_p priv = NG_NODE_PRIVATE(node);
902 struct socket *const so = priv->so;
903 struct sockaddr *sa = NULL;
913 * Look if socket address is stored in packet tags.
914 * If sockaddr is ours, or provided by a third party (zero id),
917 if (((stag = (struct sa_tag *)m_tag_locate(m, NGM_KSOCKET_COOKIE,
918 NG_KSOCKET_TAG_SOCKADDR, NULL)) != NULL) &&
919 (stag->id == NG_NODE_ID(node) || stag->id == 0))
923 error = (*so->so_proto->pr_usrreqs->pru_sosend)(so, sa, 0, m, 0, 0, td);
932 ng_ksocket_shutdown(node_p node)
934 const priv_p priv = NG_NODE_PRIVATE(node);
937 /* Close our socket (if any) */
938 if (priv->so != NULL) {
939 priv->so->so_upcall = NULL;
940 SOCKBUF_LOCK(&priv->so->so_rcv);
941 priv->so->so_rcv.sb_flags &= ~SB_UPCALL;
942 SOCKBUF_UNLOCK(&priv->so->so_rcv);
943 SOCKBUF_LOCK(&priv->so->so_snd);
944 priv->so->so_snd.sb_flags &= ~SB_UPCALL;
945 SOCKBUF_UNLOCK(&priv->so->so_snd);
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;
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);
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 */
974 ng_ksocket_disconnect(hook_p hook)
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));
984 /************************************************************************
986 ************************************************************************/
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.
1005 * To decouple stack, we use queue version of ng_send_fn().
1009 ng_ksocket_incoming(struct socket *so, void *arg, int waitflag)
1011 const node_p node = arg;
1014 wait = (waitflag & M_WAITOK) ? NG_WAITOK : 0;
1015 ng_send_fn1(node, NULL, &ng_ksocket_incoming2, so, waitflag,
1021 * When incoming data is appended to the socket, we get notified here.
1022 * This is also called whenever a significant event occurs for the socket.
1023 * We know that HOOK is NULL. Because of how we were called we know we have a
1024 * lock on this node an are participating inthe netgraph locking.
1025 * Our original caller may have queued this even some time ago and
1026 * we cannot trust that he even still exists. The node however is being
1027 * held with a reference by the queueing code, at least until we finish,
1028 * even if it has been zapped, so first check it's validiy
1029 * before we trust the socket (which was derived from it).
1032 ng_ksocket_incoming2(node_p node, hook_p hook, void *arg1, int waitflag)
1034 struct socket *so = arg1;
1035 const priv_p priv = NG_NODE_PRIVATE(node);
1037 struct ng_mesg *response;
1039 int s, flags, error;
1044 if (NG_NODE_NOT_VALID(node)) {
1048 /* so = priv->so; *//* XXX could have derived this like so */
1049 KASSERT(so == priv->so, ("%s: wrong socket", __func__));
1051 /* Check whether a pending connect operation has completed */
1052 if (priv->flags & KSF_CONNECTING) {
1053 if ((error = so->so_error) != 0) {
1055 so->so_state &= ~SS_ISCONNECTING;
1057 if (!(so->so_state & SS_ISCONNECTING)) {
1058 NG_MKMESSAGE(response, NGM_KSOCKET_COOKIE,
1059 NGM_KSOCKET_CONNECT, sizeof(int32_t), waitflag);
1060 if (response != NULL) {
1061 response->header.flags |= NGF_RESP;
1062 response->header.token = priv->response_token;
1063 *(int32_t *)response->data = error;
1065 * send an async "response" message
1066 * to the node that set us up
1067 * (if it still exists)
1069 NG_SEND_MSG_ID(error, node,
1070 response, priv->response_addr, 0);
1072 priv->flags &= ~KSF_CONNECTING;
1076 /* Check whether a pending accept operation has completed */
1077 if (priv->flags & KSF_ACCEPTING) {
1078 error = ng_ksocket_check_accept(priv);
1079 if (error != EWOULDBLOCK)
1080 priv->flags &= ~KSF_ACCEPTING;
1082 ng_ksocket_finish_accept(priv);
1086 * If we don't have a hook, we must handle data events later. When
1087 * the hook gets created and is connected, this upcall function
1088 * will be called again.
1090 if (priv->hook == NULL) {
1095 /* Read and forward available mbuf's */
1097 auio.uio_resid = 1000000000;
1098 flags = MSG_DONTWAIT;
1100 struct sockaddr *sa = NULL;
1103 /* Try to get next packet from socket */
1104 if ((error = (*so->so_proto->pr_usrreqs->pru_soreceive)
1105 (so, (so->so_state & SS_ISCONNECTED) ? NULL : &sa,
1106 &auio, &m, (struct mbuf **)0, &flags)) != 0)
1109 /* See if we got anything */
1117 * Don't trust the various socket layers to get the
1118 * packet header and length correct (e.g. kern/15175).
1120 * Also, do not trust that soreceive() will clear m_nextpkt
1121 * for us (e.g. kern/84952, kern/82413).
1123 for (n = m, m->m_pkthdr.len = 0; n != NULL; n = n->m_next) {
1124 m->m_pkthdr.len += n->m_len;
1125 n->m_nextpkt = NULL;
1128 /* Put peer's socket address (if any) into a tag */
1130 struct sa_tag *stag;
1132 stag = (struct sa_tag *)m_tag_alloc(NGM_KSOCKET_COOKIE,
1133 NG_KSOCKET_TAG_SOCKADDR, sizeof(ng_ID_t) +
1134 sa->sa_len, M_NOWAIT);
1139 bcopy(sa, &stag->sa, sa->sa_len);
1141 stag->id = NG_NODE_ID(node);
1142 m_tag_prepend(m, &stag->tag);
1145 sendit: /* Forward data with optional peer sockaddr as packet tag */
1146 NG_SEND_DATA_ONLY(error, priv->hook, m);
1150 * If the peer has closed the connection, forward a 0-length mbuf
1151 * to indicate end-of-file.
1153 if (so->so_rcv.sb_state & SBS_CANTRCVMORE && !(priv->flags & KSF_EOFSEEN)) {
1154 MGETHDR(m, waitflag, MT_DATA);
1156 m->m_len = m->m_pkthdr.len = 0;
1157 NG_SEND_DATA_ONLY(error, priv->hook, m);
1159 priv->flags |= KSF_EOFSEEN;
1165 * Check for a completed incoming connection and return 0 if one is found.
1166 * Otherwise return the appropriate error code.
1169 ng_ksocket_check_accept(priv_p priv)
1171 struct socket *const head = priv->so;
1174 if ((error = head->so_error) != 0) {
1178 /* Unlocked read. */
1179 if (TAILQ_EMPTY(&head->so_comp)) {
1180 if (head->so_rcv.sb_state & SBS_CANTRCVMORE)
1181 return ECONNABORTED;
1188 * Handle the first completed incoming connection, assumed to be already
1189 * on the socket's so_comp queue.
1192 ng_ksocket_finish_accept(priv_p priv)
1194 struct socket *const head = priv->so;
1196 struct sockaddr *sa = NULL;
1197 struct ng_mesg *resp;
1198 struct ng_ksocket_accept *resp_data;
1205 so = TAILQ_FIRST(&head->so_comp);
1206 if (so == NULL) { /* Should never happen */
1210 TAILQ_REMOVE(&head->so_comp, so, so_list);
1212 so->so_qstate &= ~SQ_COMP;
1216 so->so_state |= SS_NBIO;
1220 /* XXX KNOTE(&head->so_rcv.sb_sel.si_note, 0); */
1224 len = OFFSETOF(struct ng_ksocket_accept, addr);
1228 NG_MKMESSAGE(resp, NGM_KSOCKET_COOKIE, NGM_KSOCKET_ACCEPT, len,
1234 resp->header.flags |= NGF_RESP;
1235 resp->header.token = priv->response_token;
1237 /* Clone a ksocket node to wrap the new socket */
1238 error = ng_make_node_common(&ng_ksocket_typestruct, &node);
1240 FREE(resp, M_NETGRAPH);
1245 if (ng_ksocket_constructor(node) != 0) {
1246 NG_NODE_UNREF(node);
1247 FREE(resp, M_NETGRAPH);
1252 priv2 = NG_NODE_PRIVATE(node);
1254 priv2->flags |= KSF_CLONED | KSF_EMBRYONIC;
1257 * Insert the cloned node into a list of embryonic children
1258 * on the parent node. When a hook is created on the cloned
1259 * node it will be removed from this list. When the parent
1260 * is destroyed it will destroy any embryonic children it has.
1262 LIST_INSERT_HEAD(&priv->embryos, priv2, siblings);
1264 so->so_upcallarg = (caddr_t)node;
1265 so->so_upcall = ng_ksocket_incoming;
1266 SOCKBUF_LOCK(&so->so_rcv);
1267 so->so_rcv.sb_flags |= SB_UPCALL;
1268 SOCKBUF_UNLOCK(&so->so_rcv);
1269 SOCKBUF_LOCK(&so->so_snd);
1270 so->so_snd.sb_flags |= SB_UPCALL;
1271 SOCKBUF_UNLOCK(&so->so_snd);
1273 /* Fill in the response data and send it or return it to the caller */
1274 resp_data = (struct ng_ksocket_accept *)resp->data;
1275 resp_data->nodeid = NG_NODE_ID(node);
1277 bcopy(sa, &resp_data->addr, sa->sa_len);
1278 NG_SEND_MSG_ID(error, node, resp, priv->response_addr, 0);
1286 * Parse out either an integer value or an alias.
1289 ng_ksocket_parse(const struct ng_ksocket_alias *aliases,
1290 const char *s, int family)
1296 for (k = 0; aliases[k].name != NULL; k++) {
1297 if (strcmp(s, aliases[k].name) == 0
1298 && aliases[k].family == family)
1299 return aliases[k].value;
1302 /* Try parsing as a number */
1303 val = (int)strtoul(s, &eptr, 10);
1304 if (val < 0 || *eptr != '\0')