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 <netinet/ip.h>
70 #include <netatalk/at.h>
72 #ifdef NG_SEPARATE_MALLOC
73 static MALLOC_DEFINE(M_NETGRAPH_KSOCKET, "netgraph_ksock",
74 "netgraph ksock node");
76 #define M_NETGRAPH_KSOCKET M_NETGRAPH
79 #define OFFSETOF(s, e) ((char *)&((s *)0)->e - (char *)((s *)0))
80 #define SADATA_OFFSET (OFFSETOF(struct sockaddr, sa_data))
82 /* Node private data */
83 struct ng_ksocket_private {
87 int fn_sent; /* FN call on incoming event was sent */
88 LIST_HEAD(, ng_ksocket_private) embryos;
89 LIST_ENTRY(ng_ksocket_private) siblings;
91 u_int32_t response_token;
92 ng_ID_t response_addr;
94 typedef struct ng_ksocket_private *priv_p;
96 /* Flags for priv_p */
97 #define KSF_CONNECTING 0x00000001 /* Waiting for connection complete */
98 #define KSF_ACCEPTING 0x00000002 /* Waiting for accept complete */
99 #define KSF_EOFSEEN 0x00000004 /* Have sent 0-length EOF mbuf */
100 #define KSF_CLONED 0x00000008 /* Cloned from an accepting socket */
101 #define KSF_EMBRYONIC 0x00000010 /* Cloned node with no hooks yet */
103 /* Netgraph node methods */
104 static ng_constructor_t ng_ksocket_constructor;
105 static ng_rcvmsg_t ng_ksocket_rcvmsg;
106 static ng_shutdown_t ng_ksocket_shutdown;
107 static ng_newhook_t ng_ksocket_newhook;
108 static ng_rcvdata_t ng_ksocket_rcvdata;
109 static ng_connect_t ng_ksocket_connect;
110 static ng_disconnect_t ng_ksocket_disconnect;
112 /* Alias structure */
113 struct ng_ksocket_alias {
119 /* Protocol family aliases */
120 static const struct ng_ksocket_alias ng_ksocket_families[] = {
121 { "local", PF_LOCAL },
123 { "inet6", PF_INET6 },
124 { "atalk", PF_APPLETALK },
130 /* Socket type aliases */
131 static const struct ng_ksocket_alias ng_ksocket_types[] = {
132 { "stream", SOCK_STREAM },
133 { "dgram", SOCK_DGRAM },
136 { "seqpacket", SOCK_SEQPACKET },
140 /* Protocol aliases */
141 static const struct ng_ksocket_alias ng_ksocket_protos[] = {
142 { "ip", IPPROTO_IP, PF_INET },
143 { "raw", IPPROTO_RAW, PF_INET },
144 { "icmp", IPPROTO_ICMP, PF_INET },
145 { "igmp", IPPROTO_IGMP, PF_INET },
146 { "tcp", IPPROTO_TCP, PF_INET },
147 { "udp", IPPROTO_UDP, PF_INET },
148 { "gre", IPPROTO_GRE, PF_INET },
149 { "esp", IPPROTO_ESP, PF_INET },
150 { "ah", IPPROTO_AH, PF_INET },
151 { "swipe", IPPROTO_SWIPE, PF_INET },
152 { "encap", IPPROTO_ENCAP, PF_INET },
153 { "divert", IPPROTO_DIVERT, PF_INET },
154 { "pim", IPPROTO_PIM, PF_INET },
155 { "ddp", ATPROTO_DDP, PF_APPLETALK },
156 { "aarp", ATPROTO_AARP, PF_APPLETALK },
160 /* Helper functions */
161 static int ng_ksocket_check_accept(priv_p);
162 static void ng_ksocket_finish_accept(priv_p);
163 static int ng_ksocket_incoming(struct socket *so, void *arg, int waitflag);
164 static int ng_ksocket_parse(const struct ng_ksocket_alias *aliases,
165 const char *s, int family);
166 static void ng_ksocket_incoming2(node_p node, hook_p hook,
167 void *arg1, int arg2);
169 /************************************************************************
170 STRUCT SOCKADDR PARSE TYPE
171 ************************************************************************/
173 /* Get the length of the data portion of a generic struct sockaddr */
175 ng_parse_generic_sockdata_getLength(const struct ng_parse_type *type,
176 const u_char *start, const u_char *buf)
178 const struct sockaddr *sa;
180 sa = (const struct sockaddr *)(buf - SADATA_OFFSET);
181 return (sa->sa_len < SADATA_OFFSET) ? 0 : sa->sa_len - SADATA_OFFSET;
184 /* Type for the variable length data portion of a generic struct sockaddr */
185 static const struct ng_parse_type ng_ksocket_generic_sockdata_type = {
186 &ng_parse_bytearray_type,
187 &ng_parse_generic_sockdata_getLength
190 /* Type for a generic struct sockaddr */
191 static const struct ng_parse_struct_field
192 ng_parse_generic_sockaddr_type_fields[] = {
193 { "len", &ng_parse_uint8_type },
194 { "family", &ng_parse_uint8_type },
195 { "data", &ng_ksocket_generic_sockdata_type },
198 static const struct ng_parse_type ng_ksocket_generic_sockaddr_type = {
199 &ng_parse_struct_type,
200 &ng_parse_generic_sockaddr_type_fields
203 /* Convert a struct sockaddr from ASCII to binary. If its a protocol
204 family that we specially handle, do that, otherwise defer to the
205 generic parse type ng_ksocket_generic_sockaddr_type. */
207 ng_ksocket_sockaddr_parse(const struct ng_parse_type *type,
208 const char *s, int *off, const u_char *const start,
209 u_char *const buf, int *buflen)
211 struct sockaddr *const sa = (struct sockaddr *)buf;
212 enum ng_parse_token tok;
217 /* If next token is a left curly brace, use generic parse type */
218 if ((tok = ng_parse_get_token(s, off, &len)) == T_LBRACE) {
219 return (*ng_ksocket_generic_sockaddr_type.supertype->parse)
220 (&ng_ksocket_generic_sockaddr_type,
221 s, off, start, buf, buflen);
224 /* Get socket address family followed by a slash */
225 while (isspace(s[*off]))
227 if ((t = strchr(s + *off, '/')) == NULL)
229 if ((len = t - (s + *off)) > sizeof(fambuf) - 1)
231 strncpy(fambuf, s + *off, len);
234 if ((family = ng_ksocket_parse(ng_ksocket_families, fambuf, 0)) == -1)
238 if (*buflen < SADATA_OFFSET)
240 sa->sa_family = family;
242 /* Set family-specific data and length */
243 switch (sa->sa_family) {
244 case PF_LOCAL: /* Get pathname */
246 const int pathoff = OFFSETOF(struct sockaddr_un, sun_path);
247 struct sockaddr_un *const sun = (struct sockaddr_un *)sa;
251 if ((path = ng_get_string_token(s, off, &toklen, NULL)) == NULL)
253 pathlen = strlen(path);
254 if (pathlen > SOCK_MAXADDRLEN) {
255 free(path, M_NETGRAPH_KSOCKET);
258 if (*buflen < pathoff + pathlen) {
259 free(path, M_NETGRAPH_KSOCKET);
263 bcopy(path, sun->sun_path, pathlen);
264 sun->sun_len = pathoff + pathlen;
265 free(path, M_NETGRAPH_KSOCKET);
269 case PF_INET: /* Get an IP address with optional port */
271 struct sockaddr_in *const sin = (struct sockaddr_in *)sa;
274 /* Parse this: <ipaddress>[:port] */
275 for (i = 0; i < 4; i++) {
279 val = strtoul(s + *off, &eptr, 10);
280 if (val > 0xff || eptr == s + *off)
282 *off += (eptr - (s + *off));
283 ((u_char *)&sin->sin_addr)[i] = (u_char)val;
288 } else if (s[*off] == ':') {
290 val = strtoul(s + *off, &eptr, 10);
291 if (val > 0xffff || eptr == s + *off)
293 *off += (eptr - (s + *off));
294 sin->sin_port = htons(val);
298 bzero(&sin->sin_zero, sizeof(sin->sin_zero));
299 sin->sin_len = sizeof(*sin);
304 case PF_APPLETALK: /* XXX implement these someday */
314 *buflen = sa->sa_len;
318 /* Convert a struct sockaddr from binary to ASCII */
320 ng_ksocket_sockaddr_unparse(const struct ng_parse_type *type,
321 const u_char *data, int *off, char *cbuf, int cbuflen)
323 const struct sockaddr *sa = (const struct sockaddr *)(data + *off);
326 /* Output socket address, either in special or generic format */
327 switch (sa->sa_family) {
330 const int pathoff = OFFSETOF(struct sockaddr_un, sun_path);
331 const struct sockaddr_un *sun = (const struct sockaddr_un *)sa;
332 const int pathlen = sun->sun_len - pathoff;
333 char pathbuf[SOCK_MAXADDRLEN + 1];
336 bcopy(sun->sun_path, pathbuf, pathlen);
337 if ((pathtoken = ng_encode_string(pathbuf, pathlen)) == NULL)
339 slen += snprintf(cbuf, cbuflen, "local/%s", pathtoken);
340 free(pathtoken, M_NETGRAPH_KSOCKET);
343 *off += sun->sun_len;
349 const struct sockaddr_in *sin = (const struct sockaddr_in *)sa;
351 slen += snprintf(cbuf, cbuflen, "inet/%d.%d.%d.%d",
352 ((const u_char *)&sin->sin_addr)[0],
353 ((const u_char *)&sin->sin_addr)[1],
354 ((const u_char *)&sin->sin_addr)[2],
355 ((const u_char *)&sin->sin_addr)[3]);
356 if (sin->sin_port != 0) {
357 slen += snprintf(cbuf + strlen(cbuf),
358 cbuflen - strlen(cbuf), ":%d",
359 (u_int)ntohs(sin->sin_port));
363 *off += sizeof(*sin);
368 case PF_APPLETALK: /* XXX implement these someday */
374 return (*ng_ksocket_generic_sockaddr_type.supertype->unparse)
375 (&ng_ksocket_generic_sockaddr_type,
376 data, off, cbuf, cbuflen);
380 /* Parse type for struct sockaddr */
381 static const struct ng_parse_type ng_ksocket_sockaddr_type = {
385 &ng_ksocket_sockaddr_parse,
386 &ng_ksocket_sockaddr_unparse,
387 NULL /* no such thing as a default struct sockaddr */
390 /************************************************************************
391 STRUCT NG_KSOCKET_SOCKOPT PARSE TYPE
392 ************************************************************************/
394 /* Get length of the struct ng_ksocket_sockopt value field, which is the
395 just the excess of the message argument portion over the length of
396 the struct ng_ksocket_sockopt. */
398 ng_parse_sockoptval_getLength(const struct ng_parse_type *type,
399 const u_char *start, const u_char *buf)
401 static const int offset = OFFSETOF(struct ng_ksocket_sockopt, value);
402 const struct ng_ksocket_sockopt *sopt;
403 const struct ng_mesg *msg;
405 sopt = (const struct ng_ksocket_sockopt *)(buf - offset);
406 msg = (const struct ng_mesg *)((const u_char *)sopt - sizeof(*msg));
407 return msg->header.arglen - sizeof(*sopt);
410 /* Parse type for the option value part of a struct ng_ksocket_sockopt
411 XXX Eventually, we should handle the different socket options specially.
412 XXX This would avoid byte order problems, eg an integer value of 1 is
413 XXX going to be "[1]" for little endian or "[3=1]" for big endian. */
414 static const struct ng_parse_type ng_ksocket_sockoptval_type = {
415 &ng_parse_bytearray_type,
416 &ng_parse_sockoptval_getLength
419 /* Parse type for struct ng_ksocket_sockopt */
420 static const struct ng_parse_struct_field ng_ksocket_sockopt_type_fields[]
421 = NG_KSOCKET_SOCKOPT_INFO(&ng_ksocket_sockoptval_type);
422 static const struct ng_parse_type ng_ksocket_sockopt_type = {
423 &ng_parse_struct_type,
424 &ng_ksocket_sockopt_type_fields
427 /* Parse type for struct ng_ksocket_accept */
428 static const struct ng_parse_struct_field ng_ksocket_accept_type_fields[]
429 = NGM_KSOCKET_ACCEPT_INFO;
430 static const struct ng_parse_type ng_ksocket_accept_type = {
431 &ng_parse_struct_type,
432 &ng_ksocket_accept_type_fields
435 /* List of commands and how to convert arguments to/from ASCII */
436 static const struct ng_cmdlist ng_ksocket_cmds[] = {
441 &ng_ksocket_sockaddr_type,
448 &ng_parse_int32_type,
456 &ng_ksocket_accept_type
462 &ng_ksocket_sockaddr_type,
470 &ng_ksocket_sockaddr_type
474 NGM_KSOCKET_GETPEERNAME,
477 &ng_ksocket_sockaddr_type
483 &ng_ksocket_sockopt_type,
490 &ng_ksocket_sockopt_type,
491 &ng_ksocket_sockopt_type
496 /* Node type descriptor */
497 static struct ng_type ng_ksocket_typestruct = {
498 .version = NG_ABI_VERSION,
499 .name = NG_KSOCKET_NODE_TYPE,
500 .constructor = ng_ksocket_constructor,
501 .rcvmsg = ng_ksocket_rcvmsg,
502 .shutdown = ng_ksocket_shutdown,
503 .newhook = ng_ksocket_newhook,
504 .connect = ng_ksocket_connect,
505 .rcvdata = ng_ksocket_rcvdata,
506 .disconnect = ng_ksocket_disconnect,
507 .cmdlist = ng_ksocket_cmds,
509 NETGRAPH_INIT(ksocket, &ng_ksocket_typestruct);
511 #define ERROUT(x) do { error = (x); goto done; } while (0)
513 /************************************************************************
515 ************************************************************************/
518 * Node type constructor
519 * The NODE part is assumed to be all set up.
520 * There is already a reference to the node for us.
523 ng_ksocket_constructor(node_p node)
527 /* Allocate private structure */
528 priv = malloc(sizeof(*priv), M_NETGRAPH_KSOCKET, M_NOWAIT | M_ZERO);
532 LIST_INIT(&priv->embryos);
533 /* cross link them */
535 NG_NODE_SET_PRIVATE(node, priv);
542 * Give our OK for a hook to be added. The hook name is of the
543 * form "<family>/<type>/<proto>" where the three components may
544 * be decimal numbers or else aliases from the above lists.
546 * Connecting a hook amounts to opening the socket. Disconnecting
547 * the hook closes the socket and destroys the node as well.
550 ng_ksocket_newhook(node_p node, hook_p hook, const char *name0)
552 struct thread *td = curthread; /* XXX broken */
553 const priv_p priv = NG_NODE_PRIVATE(node);
554 char *s1, *s2, name[NG_HOOKSIZ];
555 int family, type, protocol, error;
557 /* Check if we're already connected */
558 if (priv->hook != NULL)
561 if (priv->flags & KSF_CLONED) {
562 if (priv->flags & KSF_EMBRYONIC) {
563 /* Remove ourselves from our parent's embryo list */
564 LIST_REMOVE(priv, siblings);
565 priv->flags &= ~KSF_EMBRYONIC;
568 /* Extract family, type, and protocol from hook name */
569 snprintf(name, sizeof(name), "%s", name0);
571 if ((s2 = strchr(s1, '/')) == NULL)
574 family = ng_ksocket_parse(ng_ksocket_families, s1, 0);
578 if ((s2 = strchr(s1, '/')) == NULL)
581 type = ng_ksocket_parse(ng_ksocket_types, s1, 0);
585 protocol = ng_ksocket_parse(ng_ksocket_protos, s1, family);
589 /* Create the socket */
590 error = socreate(family, &priv->so, type, protocol,
595 /* XXX call soreserve() ? */
603 * In case of misconfigured routing a packet may reenter
604 * ksocket node recursively. Decouple stack to avoid possible
605 * panics about sleeping with locks held.
607 NG_HOOK_FORCE_QUEUE(hook);
613 ng_ksocket_connect(hook_p hook)
615 node_p node = NG_HOOK_NODE(hook);
616 const priv_p priv = NG_NODE_PRIVATE(node);
617 struct socket *const so = priv->so;
619 /* Add our hook for incoming data and other events */
620 SOCKBUF_LOCK(&priv->so->so_rcv);
621 soupcall_set(priv->so, SO_RCV, ng_ksocket_incoming, node);
622 SOCKBUF_UNLOCK(&priv->so->so_rcv);
623 SOCKBUF_LOCK(&priv->so->so_snd);
624 soupcall_set(priv->so, SO_SND, ng_ksocket_incoming, node);
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;
906 #ifdef ALIGNED_POINTER
908 #endif /* ALIGNED_POINTER */
914 #ifdef ALIGNED_POINTER
915 if (!ALIGNED_POINTER(mtod(m, caddr_t), uint32_t)) {
916 n = m_defrag(m, M_NOWAIT);
923 #endif /* ALIGNED_POINTER */
925 * Look if socket address is stored in packet tags.
926 * If sockaddr is ours, or provided by a third party (zero id),
929 if (((stag = (struct sa_tag *)m_tag_locate(m, NGM_KSOCKET_COOKIE,
930 NG_KSOCKET_TAG_SOCKADDR, NULL)) != NULL) &&
931 (stag->id == NG_NODE_ID(node) || stag->id == 0))
934 /* Reset specific mbuf flags to prevent addressing problems. */
935 m->m_flags &= ~(M_BCAST|M_MCAST);
938 error = sosend(so, sa, 0, m, 0, 0, td);
947 ng_ksocket_shutdown(node_p node)
949 const priv_p priv = NG_NODE_PRIVATE(node);
952 /* Close our socket (if any) */
953 if (priv->so != NULL) {
954 SOCKBUF_LOCK(&priv->so->so_rcv);
955 soupcall_clear(priv->so, SO_RCV);
956 SOCKBUF_UNLOCK(&priv->so->so_rcv);
957 SOCKBUF_LOCK(&priv->so->so_snd);
958 soupcall_clear(priv->so, SO_SND);
959 SOCKBUF_UNLOCK(&priv->so->so_snd);
964 /* If we are an embryo, take ourselves out of the parent's list */
965 if (priv->flags & KSF_EMBRYONIC) {
966 LIST_REMOVE(priv, siblings);
967 priv->flags &= ~KSF_EMBRYONIC;
970 /* Remove any embryonic children we have */
971 while (!LIST_EMPTY(&priv->embryos)) {
972 embryo = LIST_FIRST(&priv->embryos);
973 ng_rmnode_self(embryo->node);
976 /* Take down netgraph node */
977 bzero(priv, sizeof(*priv));
978 free(priv, M_NETGRAPH_KSOCKET);
979 NG_NODE_SET_PRIVATE(node, NULL);
980 NG_NODE_UNREF(node); /* let the node escape */
988 ng_ksocket_disconnect(hook_p hook)
990 KASSERT(NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook)) == 0,
991 ("%s: numhooks=%d?", __func__,
992 NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook))));
993 if (NG_NODE_IS_VALID(NG_HOOK_NODE(hook)))
994 ng_rmnode_self(NG_HOOK_NODE(hook));
998 /************************************************************************
1000 ************************************************************************/
1002 * You should not "just call" a netgraph node function from an external
1003 * asynchronous event. This is because in doing so you are ignoring the
1004 * locking on the netgraph nodes. Instead call your function via ng_send_fn().
1005 * This will call the function you chose, but will first do all the
1006 * locking rigmarole. Your function MAY only be called at some distant future
1007 * time (several millisecs away) so don't give it any arguments
1008 * that may be revoked soon (e.g. on your stack).
1010 * To decouple stack, we use queue version of ng_send_fn().
1014 ng_ksocket_incoming(struct socket *so, void *arg, int waitflag)
1016 const node_p node = arg;
1017 const priv_p priv = NG_NODE_PRIVATE(node);
1018 int wait = ((waitflag & M_WAITOK) ? NG_WAITOK : 0) | NG_QUEUE;
1021 * Even if node is not locked, as soon as we are called, we assume
1022 * it exist and it's private area is valid. With some care we can
1023 * access it. Mark node that incoming event for it was sent to
1024 * avoid unneded queue trashing.
1026 if (atomic_cmpset_int(&priv->fn_sent, 0, 1) &&
1027 ng_send_fn1(node, NULL, &ng_ksocket_incoming2, so, 0, wait)) {
1028 atomic_store_rel_int(&priv->fn_sent, 0);
1035 * When incoming data is appended to the socket, we get notified here.
1036 * This is also called whenever a significant event occurs for the socket.
1037 * Our original caller may have queued this even some time ago and
1038 * we cannot trust that he even still exists. The node however is being
1039 * held with a reference by the queueing code and guarantied to be valid.
1042 ng_ksocket_incoming2(node_p node, hook_p hook, void *arg1, int arg2)
1044 struct socket *so = arg1;
1045 const priv_p priv = NG_NODE_PRIVATE(node);
1046 struct ng_mesg *response;
1049 KASSERT(so == priv->so, ("%s: wrong socket", __func__));
1051 /* Allow next incoming event to be queued. */
1052 atomic_store_rel_int(&priv->fn_sent, 0);
1054 /* Check whether a pending connect operation has completed */
1055 if (priv->flags & KSF_CONNECTING) {
1056 if ((error = so->so_error) != 0) {
1058 so->so_state &= ~SS_ISCONNECTING;
1060 if (!(so->so_state & SS_ISCONNECTING)) {
1061 NG_MKMESSAGE(response, NGM_KSOCKET_COOKIE,
1062 NGM_KSOCKET_CONNECT, sizeof(int32_t), M_NOWAIT);
1063 if (response != NULL) {
1064 response->header.flags |= NGF_RESP;
1065 response->header.token = priv->response_token;
1066 *(int32_t *)response->data = error;
1068 * send an async "response" message
1069 * to the node that set us up
1070 * (if it still exists)
1072 NG_SEND_MSG_ID(error, node,
1073 response, priv->response_addr, 0);
1075 priv->flags &= ~KSF_CONNECTING;
1079 /* Check whether a pending accept operation has completed */
1080 if (priv->flags & KSF_ACCEPTING) {
1081 error = ng_ksocket_check_accept(priv);
1082 if (error != EWOULDBLOCK)
1083 priv->flags &= ~KSF_ACCEPTING;
1085 ng_ksocket_finish_accept(priv);
1089 * If we don't have a hook, we must handle data events later. When
1090 * the hook gets created and is connected, this upcall function
1091 * will be called again.
1093 if (priv->hook == NULL)
1096 /* Read and forward available mbufs. */
1099 struct sockaddr *sa;
1103 /* Try to get next packet from socket. */
1105 uio.uio_resid = IP_MAXPACKET;
1106 flags = MSG_DONTWAIT;
1108 if ((error = soreceive(so, (so->so_state & SS_ISCONNECTED) ?
1109 NULL : &sa, &uio, &m, NULL, &flags)) != 0)
1112 /* See if we got anything. */
1113 if (flags & MSG_TRUNC) {
1123 KASSERT(m->m_nextpkt == NULL, ("%s: nextpkt", __func__));
1126 * Stream sockets do not have packet boundaries, so
1127 * we have to allocate a header mbuf and attach the
1128 * stream of data to it.
1130 if (so->so_type == SOCK_STREAM) {
1133 mh = m_gethdr(M_NOWAIT, MT_DATA);
1142 for (; m; m = m->m_next)
1143 mh->m_pkthdr.len += m->m_len;
1147 /* Put peer's socket address (if any) into a tag */
1149 struct sa_tag *stag;
1151 stag = (struct sa_tag *)m_tag_alloc(NGM_KSOCKET_COOKIE,
1152 NG_KSOCKET_TAG_SOCKADDR, sizeof(ng_ID_t) +
1153 sa->sa_len, M_NOWAIT);
1158 bcopy(sa, &stag->sa, sa->sa_len);
1160 stag->id = NG_NODE_ID(node);
1161 m_tag_prepend(m, &stag->tag);
1164 sendit: /* Forward data with optional peer sockaddr as packet tag */
1165 NG_SEND_DATA_ONLY(error, priv->hook, m);
1169 * If the peer has closed the connection, forward a 0-length mbuf
1170 * to indicate end-of-file.
1172 if (so->so_rcv.sb_state & SBS_CANTRCVMORE &&
1173 !(priv->flags & KSF_EOFSEEN)) {
1176 m = m_gethdr(M_NOWAIT, MT_DATA);
1178 NG_SEND_DATA_ONLY(error, priv->hook, m);
1179 priv->flags |= KSF_EOFSEEN;
1184 * Check for a completed incoming connection and return 0 if one is found.
1185 * Otherwise return the appropriate error code.
1188 ng_ksocket_check_accept(priv_p priv)
1190 struct socket *const head = priv->so;
1193 if ((error = head->so_error) != 0) {
1197 /* Unlocked read. */
1198 if (TAILQ_EMPTY(&head->so_comp)) {
1199 if (head->so_rcv.sb_state & SBS_CANTRCVMORE)
1200 return ECONNABORTED;
1207 * Handle the first completed incoming connection, assumed to be already
1208 * on the socket's so_comp queue.
1211 ng_ksocket_finish_accept(priv_p priv)
1213 struct socket *const head = priv->so;
1215 struct sockaddr *sa = NULL;
1216 struct ng_mesg *resp;
1217 struct ng_ksocket_accept *resp_data;
1224 so = TAILQ_FIRST(&head->so_comp);
1225 if (so == NULL) { /* Should never happen */
1229 TAILQ_REMOVE(&head->so_comp, so, so_list);
1231 so->so_qstate &= ~SQ_COMP;
1235 so->so_state |= SS_NBIO;
1239 /* XXX KNOTE_UNLOCKED(&head->so_rcv.sb_sel.si_note, 0); */
1243 len = OFFSETOF(struct ng_ksocket_accept, addr);
1247 NG_MKMESSAGE(resp, NGM_KSOCKET_COOKIE, NGM_KSOCKET_ACCEPT, len,
1253 resp->header.flags |= NGF_RESP;
1254 resp->header.token = priv->response_token;
1256 /* Clone a ksocket node to wrap the new socket */
1257 error = ng_make_node_common(&ng_ksocket_typestruct, &node);
1259 free(resp, M_NETGRAPH);
1264 if (ng_ksocket_constructor(node) != 0) {
1265 NG_NODE_UNREF(node);
1266 free(resp, M_NETGRAPH);
1271 priv2 = NG_NODE_PRIVATE(node);
1273 priv2->flags |= KSF_CLONED | KSF_EMBRYONIC;
1276 * Insert the cloned node into a list of embryonic children
1277 * on the parent node. When a hook is created on the cloned
1278 * node it will be removed from this list. When the parent
1279 * is destroyed it will destroy any embryonic children it has.
1281 LIST_INSERT_HEAD(&priv->embryos, priv2, siblings);
1283 SOCKBUF_LOCK(&so->so_rcv);
1284 soupcall_set(so, SO_RCV, ng_ksocket_incoming, node);
1285 SOCKBUF_UNLOCK(&so->so_rcv);
1286 SOCKBUF_LOCK(&so->so_snd);
1287 soupcall_set(so, SO_SND, ng_ksocket_incoming, node);
1288 SOCKBUF_UNLOCK(&so->so_snd);
1290 /* Fill in the response data and send it or return it to the caller */
1291 resp_data = (struct ng_ksocket_accept *)resp->data;
1292 resp_data->nodeid = NG_NODE_ID(node);
1294 bcopy(sa, &resp_data->addr, sa->sa_len);
1295 NG_SEND_MSG_ID(error, node, resp, priv->response_addr, 0);
1303 * Parse out either an integer value or an alias.
1306 ng_ksocket_parse(const struct ng_ksocket_alias *aliases,
1307 const char *s, int family)
1313 for (k = 0; aliases[k].name != NULL; k++) {
1314 if (strcmp(s, aliases[k].name) == 0
1315 && aliases[k].family == family)
1316 return aliases[k].value;
1319 /* Try parsing as a number */
1320 val = (int)strtoul(s, &eptr, 10);
1321 if (val < 0 || *eptr != '\0')