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 static MALLOC_DEFINE(M_NETGRAPH_KSOCKET, "netgraph_ksock",
73 "netgraph ksock node");
75 #define M_NETGRAPH_KSOCKET M_NETGRAPH
78 #define OFFSETOF(s, e) ((char *)&((s *)0)->e - (char *)((s *)0))
79 #define SADATA_OFFSET (OFFSETOF(struct sockaddr, sa_data))
81 /* Node private data */
82 struct ng_ksocket_private {
86 int fn_sent; /* FN call on incoming event was sent */
87 LIST_HEAD(, ng_ksocket_private) embryos;
88 LIST_ENTRY(ng_ksocket_private) siblings;
90 u_int32_t response_token;
91 ng_ID_t response_addr;
93 typedef struct ng_ksocket_private *priv_p;
95 /* Flags for priv_p */
96 #define KSF_CONNECTING 0x00000001 /* Waiting for connection complete */
97 #define KSF_ACCEPTING 0x00000002 /* Waiting for accept complete */
98 #define KSF_EOFSEEN 0x00000004 /* Have sent 0-length EOF mbuf */
99 #define KSF_CLONED 0x00000008 /* Cloned from an accepting socket */
100 #define KSF_EMBRYONIC 0x00000010 /* Cloned node with no hooks yet */
102 /* Netgraph node methods */
103 static ng_constructor_t ng_ksocket_constructor;
104 static ng_rcvmsg_t ng_ksocket_rcvmsg;
105 static ng_shutdown_t ng_ksocket_shutdown;
106 static ng_newhook_t ng_ksocket_newhook;
107 static ng_rcvdata_t ng_ksocket_rcvdata;
108 static ng_connect_t ng_ksocket_connect;
109 static ng_disconnect_t ng_ksocket_disconnect;
111 /* Alias structure */
112 struct ng_ksocket_alias {
118 /* Protocol family aliases */
119 static const struct ng_ksocket_alias ng_ksocket_families[] = {
120 { "local", PF_LOCAL },
122 { "inet6", PF_INET6 },
123 { "atalk", PF_APPLETALK },
129 /* Socket type aliases */
130 static const struct ng_ksocket_alias ng_ksocket_types[] = {
131 { "stream", SOCK_STREAM },
132 { "dgram", SOCK_DGRAM },
135 { "seqpacket", SOCK_SEQPACKET },
139 /* Protocol aliases */
140 static const struct ng_ksocket_alias ng_ksocket_protos[] = {
141 { "ip", IPPROTO_IP, PF_INET },
142 { "raw", IPPROTO_RAW, PF_INET },
143 { "icmp", IPPROTO_ICMP, PF_INET },
144 { "igmp", IPPROTO_IGMP, PF_INET },
145 { "tcp", IPPROTO_TCP, PF_INET },
146 { "udp", IPPROTO_UDP, PF_INET },
147 { "gre", IPPROTO_GRE, PF_INET },
148 { "esp", IPPROTO_ESP, PF_INET },
149 { "ah", IPPROTO_AH, PF_INET },
150 { "swipe", IPPROTO_SWIPE, PF_INET },
151 { "encap", IPPROTO_ENCAP, PF_INET },
152 { "divert", IPPROTO_DIVERT, PF_INET },
153 { "pim", IPPROTO_PIM, PF_INET },
154 { "ddp", ATPROTO_DDP, PF_APPLETALK },
155 { "aarp", ATPROTO_AARP, PF_APPLETALK },
159 /* Helper functions */
160 static int ng_ksocket_check_accept(priv_p);
161 static void ng_ksocket_finish_accept(priv_p);
162 static int ng_ksocket_incoming(struct socket *so, void *arg, int waitflag);
163 static int ng_ksocket_parse(const struct ng_ksocket_alias *aliases,
164 const char *s, int family);
165 static void ng_ksocket_incoming2(node_p node, hook_p hook,
166 void *arg1, int arg2);
168 /************************************************************************
169 STRUCT SOCKADDR PARSE TYPE
170 ************************************************************************/
172 /* Get the length of the data portion of a generic struct sockaddr */
174 ng_parse_generic_sockdata_getLength(const struct ng_parse_type *type,
175 const u_char *start, const u_char *buf)
177 const struct sockaddr *sa;
179 sa = (const struct sockaddr *)(buf - SADATA_OFFSET);
180 return (sa->sa_len < SADATA_OFFSET) ? 0 : sa->sa_len - SADATA_OFFSET;
183 /* Type for the variable length data portion of a generic struct sockaddr */
184 static const struct ng_parse_type ng_ksocket_generic_sockdata_type = {
185 &ng_parse_bytearray_type,
186 &ng_parse_generic_sockdata_getLength
189 /* Type for a generic struct sockaddr */
190 static const struct ng_parse_struct_field
191 ng_parse_generic_sockaddr_type_fields[] = {
192 { "len", &ng_parse_uint8_type },
193 { "family", &ng_parse_uint8_type },
194 { "data", &ng_ksocket_generic_sockdata_type },
197 static const struct ng_parse_type ng_ksocket_generic_sockaddr_type = {
198 &ng_parse_struct_type,
199 &ng_parse_generic_sockaddr_type_fields
202 /* Convert a struct sockaddr from ASCII to binary. If its a protocol
203 family that we specially handle, do that, otherwise defer to the
204 generic parse type ng_ksocket_generic_sockaddr_type. */
206 ng_ksocket_sockaddr_parse(const struct ng_parse_type *type,
207 const char *s, int *off, const u_char *const start,
208 u_char *const buf, int *buflen)
210 struct sockaddr *const sa = (struct sockaddr *)buf;
211 enum ng_parse_token tok;
216 /* If next token is a left curly brace, use generic parse type */
217 if ((tok = ng_parse_get_token(s, off, &len)) == T_LBRACE) {
218 return (*ng_ksocket_generic_sockaddr_type.supertype->parse)
219 (&ng_ksocket_generic_sockaddr_type,
220 s, off, start, buf, buflen);
223 /* Get socket address family followed by a slash */
224 while (isspace(s[*off]))
226 if ((t = strchr(s + *off, '/')) == NULL)
228 if ((len = t - (s + *off)) > sizeof(fambuf) - 1)
230 strncpy(fambuf, s + *off, len);
233 if ((family = ng_ksocket_parse(ng_ksocket_families, fambuf, 0)) == -1)
237 if (*buflen < SADATA_OFFSET)
239 sa->sa_family = family;
241 /* Set family-specific data and length */
242 switch (sa->sa_family) {
243 case PF_LOCAL: /* Get pathname */
245 const int pathoff = OFFSETOF(struct sockaddr_un, sun_path);
246 struct sockaddr_un *const sun = (struct sockaddr_un *)sa;
250 if ((path = ng_get_string_token(s, off, &toklen, NULL)) == NULL)
252 pathlen = strlen(path);
253 if (pathlen > SOCK_MAXADDRLEN) {
254 free(path, M_NETGRAPH_KSOCKET);
257 if (*buflen < pathoff + pathlen) {
258 free(path, M_NETGRAPH_KSOCKET);
262 bcopy(path, sun->sun_path, pathlen);
263 sun->sun_len = pathoff + pathlen;
264 free(path, M_NETGRAPH_KSOCKET);
268 case PF_INET: /* Get an IP address with optional port */
270 struct sockaddr_in *const sin = (struct sockaddr_in *)sa;
273 /* Parse this: <ipaddress>[:port] */
274 for (i = 0; i < 4; i++) {
278 val = strtoul(s + *off, &eptr, 10);
279 if (val > 0xff || eptr == s + *off)
281 *off += (eptr - (s + *off));
282 ((u_char *)&sin->sin_addr)[i] = (u_char)val;
287 } else if (s[*off] == ':') {
289 val = strtoul(s + *off, &eptr, 10);
290 if (val > 0xffff || eptr == s + *off)
292 *off += (eptr - (s + *off));
293 sin->sin_port = htons(val);
297 bzero(&sin->sin_zero, sizeof(sin->sin_zero));
298 sin->sin_len = sizeof(*sin);
303 case PF_APPLETALK: /* XXX implement these someday */
313 *buflen = sa->sa_len;
317 /* Convert a struct sockaddr from binary to ASCII */
319 ng_ksocket_sockaddr_unparse(const struct ng_parse_type *type,
320 const u_char *data, int *off, char *cbuf, int cbuflen)
322 const struct sockaddr *sa = (const struct sockaddr *)(data + *off);
325 /* Output socket address, either in special or generic format */
326 switch (sa->sa_family) {
329 const int pathoff = OFFSETOF(struct sockaddr_un, sun_path);
330 const struct sockaddr_un *sun = (const struct sockaddr_un *)sa;
331 const int pathlen = sun->sun_len - pathoff;
332 char pathbuf[SOCK_MAXADDRLEN + 1];
335 bcopy(sun->sun_path, pathbuf, pathlen);
336 if ((pathtoken = ng_encode_string(pathbuf, pathlen)) == NULL)
338 slen += snprintf(cbuf, cbuflen, "local/%s", pathtoken);
339 free(pathtoken, M_NETGRAPH_KSOCKET);
342 *off += sun->sun_len;
348 const struct sockaddr_in *sin = (const struct sockaddr_in *)sa;
350 slen += snprintf(cbuf, cbuflen, "inet/%d.%d.%d.%d",
351 ((const u_char *)&sin->sin_addr)[0],
352 ((const u_char *)&sin->sin_addr)[1],
353 ((const u_char *)&sin->sin_addr)[2],
354 ((const u_char *)&sin->sin_addr)[3]);
355 if (sin->sin_port != 0) {
356 slen += snprintf(cbuf + strlen(cbuf),
357 cbuflen - strlen(cbuf), ":%d",
358 (u_int)ntohs(sin->sin_port));
362 *off += sizeof(*sin);
367 case PF_APPLETALK: /* XXX implement these someday */
373 return (*ng_ksocket_generic_sockaddr_type.supertype->unparse)
374 (&ng_ksocket_generic_sockaddr_type,
375 data, off, cbuf, cbuflen);
379 /* Parse type for struct sockaddr */
380 static const struct ng_parse_type ng_ksocket_sockaddr_type = {
384 &ng_ksocket_sockaddr_parse,
385 &ng_ksocket_sockaddr_unparse,
386 NULL /* no such thing as a default struct sockaddr */
389 /************************************************************************
390 STRUCT NG_KSOCKET_SOCKOPT PARSE TYPE
391 ************************************************************************/
393 /* Get length of the struct ng_ksocket_sockopt value field, which is the
394 just the excess of the message argument portion over the length of
395 the struct ng_ksocket_sockopt. */
397 ng_parse_sockoptval_getLength(const struct ng_parse_type *type,
398 const u_char *start, const u_char *buf)
400 static const int offset = OFFSETOF(struct ng_ksocket_sockopt, value);
401 const struct ng_ksocket_sockopt *sopt;
402 const struct ng_mesg *msg;
404 sopt = (const struct ng_ksocket_sockopt *)(buf - offset);
405 msg = (const struct ng_mesg *)((const u_char *)sopt - sizeof(*msg));
406 return msg->header.arglen - sizeof(*sopt);
409 /* Parse type for the option value part of a struct ng_ksocket_sockopt
410 XXX Eventually, we should handle the different socket options specially.
411 XXX This would avoid byte order problems, eg an integer value of 1 is
412 XXX going to be "[1]" for little endian or "[3=1]" for big endian. */
413 static const struct ng_parse_type ng_ksocket_sockoptval_type = {
414 &ng_parse_bytearray_type,
415 &ng_parse_sockoptval_getLength
418 /* Parse type for struct ng_ksocket_sockopt */
419 static const struct ng_parse_struct_field ng_ksocket_sockopt_type_fields[]
420 = NG_KSOCKET_SOCKOPT_INFO(&ng_ksocket_sockoptval_type);
421 static const struct ng_parse_type ng_ksocket_sockopt_type = {
422 &ng_parse_struct_type,
423 &ng_ksocket_sockopt_type_fields
426 /* Parse type for struct ng_ksocket_accept */
427 static const struct ng_parse_struct_field ng_ksocket_accept_type_fields[]
428 = NGM_KSOCKET_ACCEPT_INFO;
429 static const struct ng_parse_type ng_ksocket_accept_type = {
430 &ng_parse_struct_type,
431 &ng_ksocket_accept_type_fields
434 /* List of commands and how to convert arguments to/from ASCII */
435 static const struct ng_cmdlist ng_ksocket_cmds[] = {
440 &ng_ksocket_sockaddr_type,
447 &ng_parse_int32_type,
455 &ng_ksocket_accept_type
461 &ng_ksocket_sockaddr_type,
469 &ng_ksocket_sockaddr_type
473 NGM_KSOCKET_GETPEERNAME,
476 &ng_ksocket_sockaddr_type
482 &ng_ksocket_sockopt_type,
489 &ng_ksocket_sockopt_type,
490 &ng_ksocket_sockopt_type
495 /* Node type descriptor */
496 static struct ng_type ng_ksocket_typestruct = {
497 .version = NG_ABI_VERSION,
498 .name = NG_KSOCKET_NODE_TYPE,
499 .constructor = ng_ksocket_constructor,
500 .rcvmsg = ng_ksocket_rcvmsg,
501 .shutdown = ng_ksocket_shutdown,
502 .newhook = ng_ksocket_newhook,
503 .connect = ng_ksocket_connect,
504 .rcvdata = ng_ksocket_rcvdata,
505 .disconnect = ng_ksocket_disconnect,
506 .cmdlist = ng_ksocket_cmds,
508 NETGRAPH_INIT(ksocket, &ng_ksocket_typestruct);
510 #define ERROUT(x) do { error = (x); goto done; } while (0)
512 /************************************************************************
514 ************************************************************************/
517 * Node type constructor
518 * The NODE part is assumed to be all set up.
519 * There is already a reference to the node for us.
522 ng_ksocket_constructor(node_p node)
526 /* Allocate private structure */
527 priv = malloc(sizeof(*priv), M_NETGRAPH_KSOCKET, M_NOWAIT | M_ZERO);
531 LIST_INIT(&priv->embryos);
532 /* cross link them */
534 NG_NODE_SET_PRIVATE(node, priv);
541 * Give our OK for a hook to be added. The hook name is of the
542 * form "<family>/<type>/<proto>" where the three components may
543 * be decimal numbers or else aliases from the above lists.
545 * Connecting a hook amounts to opening the socket. Disconnecting
546 * the hook closes the socket and destroys the node as well.
549 ng_ksocket_newhook(node_p node, hook_p hook, const char *name0)
551 struct thread *td = curthread; /* XXX broken */
552 const priv_p priv = NG_NODE_PRIVATE(node);
553 char *s1, *s2, name[NG_HOOKSIZ];
554 int family, type, protocol, error;
556 /* Check if we're already connected */
557 if (priv->hook != NULL)
560 if (priv->flags & KSF_CLONED) {
561 if (priv->flags & KSF_EMBRYONIC) {
562 /* Remove ourselves from our parent's embryo list */
563 LIST_REMOVE(priv, siblings);
564 priv->flags &= ~KSF_EMBRYONIC;
567 /* Extract family, type, and protocol from hook name */
568 snprintf(name, sizeof(name), "%s", name0);
570 if ((s2 = strchr(s1, '/')) == NULL)
573 family = ng_ksocket_parse(ng_ksocket_families, s1, 0);
577 if ((s2 = strchr(s1, '/')) == NULL)
580 type = ng_ksocket_parse(ng_ksocket_types, s1, 0);
584 protocol = ng_ksocket_parse(ng_ksocket_protos, s1, family);
588 /* Create the socket */
589 error = socreate(family, &priv->so, type, protocol,
594 /* XXX call soreserve() ? */
602 * In case of misconfigured routing a packet may reenter
603 * ksocket node recursively. Decouple stack to avoid possible
604 * panics about sleeping with locks held.
606 NG_HOOK_FORCE_QUEUE(hook);
612 ng_ksocket_connect(hook_p hook)
614 node_p node = NG_HOOK_NODE(hook);
615 const priv_p priv = NG_NODE_PRIVATE(node);
616 struct socket *const so = priv->so;
618 /* Add our hook for incoming data and other events */
619 SOCKBUF_LOCK(&priv->so->so_rcv);
620 soupcall_set(priv->so, SO_RCV, ng_ksocket_incoming, node);
621 SOCKBUF_UNLOCK(&priv->so->so_rcv);
622 SOCKBUF_LOCK(&priv->so->so_snd);
623 soupcall_set(priv->so, SO_SND, ng_ksocket_incoming, node);
624 SOCKBUF_UNLOCK(&priv->so->so_snd);
626 priv->so->so_state |= SS_NBIO;
627 SOCK_UNLOCK(priv->so);
629 * --Original comment--
630 * On a cloned socket we may have already received one or more
631 * upcalls which we couldn't handle without a hook. Handle
633 * We cannot call the upcall function directly
634 * from here, because until this function has returned our
635 * hook isn't connected.
637 * ---meta comment for -current ---
638 * XXX This is dubius.
639 * Upcalls between the time that the hook was
640 * first created and now (on another processesor) will
641 * be earlier on the queue than the request to finalise the hook.
642 * By the time the hook is finalised,
643 * The queued upcalls will have happenned and the code
644 * will have discarded them because of a lack of a hook.
647 * This is a bad byproduct of the complicated way in which hooks
648 * are now created (3 daisy chained async events).
650 * Since we are a netgraph operation
651 * We know that we hold a lock on this node. This forces the
652 * request we make below to be queued rather than implemented
653 * immediatly which will cause the upcall function to be called a bit
655 * However, as we will run any waiting queued operations immediatly
656 * after doing this one, if we have not finalised the other end
657 * of the hook, those queued operations will fail.
659 if (priv->flags & KSF_CLONED) {
660 ng_send_fn(node, NULL, &ng_ksocket_incoming2, so, M_NOWAIT);
667 * Receive a control message
670 ng_ksocket_rcvmsg(node_p node, item_p item, hook_p lasthook)
672 struct thread *td = curthread; /* XXX broken */
673 const priv_p priv = NG_NODE_PRIVATE(node);
674 struct socket *const so = priv->so;
675 struct ng_mesg *resp = NULL;
680 NGI_GET_MSG(item, msg);
681 switch (msg->header.typecookie) {
682 case NGM_KSOCKET_COOKIE:
683 switch (msg->header.cmd) {
684 case NGM_KSOCKET_BIND:
686 struct sockaddr *const sa
687 = (struct sockaddr *)msg->data;
690 if (msg->header.arglen < SADATA_OFFSET
691 || msg->header.arglen < sa->sa_len)
697 error = sobind(so, sa, td);
700 case NGM_KSOCKET_LISTEN:
703 if (msg->header.arglen != sizeof(int32_t))
709 error = solisten(so, *((int32_t *)msg->data), td);
713 case NGM_KSOCKET_ACCEPT:
716 if (msg->header.arglen != 0)
721 /* Make sure the socket is capable of accepting */
722 if (!(so->so_options & SO_ACCEPTCONN))
724 if (priv->flags & KSF_ACCEPTING)
727 error = ng_ksocket_check_accept(priv);
728 if (error != 0 && error != EWOULDBLOCK)
732 * If a connection is already complete, take it.
733 * Otherwise let the upcall function deal with
734 * the connection when it comes in.
736 priv->response_token = msg->header.token;
737 raddr = priv->response_addr = NGI_RETADDR(item);
739 ng_ksocket_finish_accept(priv);
741 priv->flags |= KSF_ACCEPTING;
745 case NGM_KSOCKET_CONNECT:
747 struct sockaddr *const sa
748 = (struct sockaddr *)msg->data;
751 if (msg->header.arglen < SADATA_OFFSET
752 || msg->header.arglen < sa->sa_len)
758 if ((so->so_state & SS_ISCONNECTING) != 0)
760 if ((error = soconnect(so, sa, td)) != 0) {
761 so->so_state &= ~SS_ISCONNECTING;
764 if ((so->so_state & SS_ISCONNECTING) != 0) {
765 /* We will notify the sender when we connect */
766 priv->response_token = msg->header.token;
767 raddr = priv->response_addr = NGI_RETADDR(item);
768 priv->flags |= KSF_CONNECTING;
774 case NGM_KSOCKET_GETNAME:
775 case NGM_KSOCKET_GETPEERNAME:
777 int (*func)(struct socket *so, struct sockaddr **nam);
778 struct sockaddr *sa = NULL;
782 if (msg->header.arglen != 0)
788 if (msg->header.cmd == NGM_KSOCKET_GETPEERNAME) {
790 & (SS_ISCONNECTED|SS_ISCONFIRMING)) == 0)
792 func = so->so_proto->pr_usrreqs->pru_peeraddr;
794 func = so->so_proto->pr_usrreqs->pru_sockaddr;
796 /* Get local or peer address */
797 if ((error = (*func)(so, &sa)) != 0)
799 len = (sa == NULL) ? 0 : sa->sa_len;
801 /* Send it back in a response */
802 NG_MKRESPONSE(resp, msg, len, M_NOWAIT);
807 bcopy(sa, resp->data, len);
816 case NGM_KSOCKET_GETOPT:
818 struct ng_ksocket_sockopt *ksopt =
819 (struct ng_ksocket_sockopt *)msg->data;
823 if (msg->header.arglen != sizeof(*ksopt))
828 /* Get response with room for option value */
829 NG_MKRESPONSE(resp, msg, sizeof(*ksopt)
830 + NG_KSOCKET_MAX_OPTLEN, M_NOWAIT);
834 /* Get socket option, and put value in the response */
835 sopt.sopt_dir = SOPT_GET;
836 sopt.sopt_level = ksopt->level;
837 sopt.sopt_name = ksopt->name;
839 sopt.sopt_valsize = NG_KSOCKET_MAX_OPTLEN;
840 ksopt = (struct ng_ksocket_sockopt *)resp->data;
841 sopt.sopt_val = ksopt->value;
842 if ((error = sogetopt(so, &sopt)) != 0) {
847 /* Set actual value length */
848 resp->header.arglen = sizeof(*ksopt)
853 case NGM_KSOCKET_SETOPT:
855 struct ng_ksocket_sockopt *const ksopt =
856 (struct ng_ksocket_sockopt *)msg->data;
857 const int valsize = msg->header.arglen - sizeof(*ksopt);
866 /* Set socket option */
867 sopt.sopt_dir = SOPT_SET;
868 sopt.sopt_level = ksopt->level;
869 sopt.sopt_name = ksopt->name;
870 sopt.sopt_val = ksopt->value;
871 sopt.sopt_valsize = valsize;
873 error = sosetopt(so, &sopt);
887 NG_RESPOND_MSG(error, node, item, resp);
893 * Receive incoming data on our hook. Send it out the socket.
896 ng_ksocket_rcvdata(hook_p hook, item_p item)
898 struct thread *td = curthread; /* XXX broken */
899 const node_p node = NG_HOOK_NODE(hook);
900 const priv_p priv = NG_NODE_PRIVATE(node);
901 struct socket *const so = priv->so;
902 struct sockaddr *sa = NULL;
905 #ifdef ALIGNED_POINTER
907 #endif /* ALIGNED_POINTER */
913 #ifdef ALIGNED_POINTER
914 if (!ALIGNED_POINTER(mtod(m, caddr_t), uint32_t)) {
915 n = m_defrag(m, M_NOWAIT);
922 #endif /* ALIGNED_POINTER */
924 * Look if socket address is stored in packet tags.
925 * If sockaddr is ours, or provided by a third party (zero id),
928 if (((stag = (struct sa_tag *)m_tag_locate(m, NGM_KSOCKET_COOKIE,
929 NG_KSOCKET_TAG_SOCKADDR, NULL)) != NULL) &&
930 (stag->id == NG_NODE_ID(node) || stag->id == 0))
933 /* Reset specific mbuf flags to prevent addressing problems. */
934 m->m_flags &= ~(M_BCAST|M_MCAST);
937 error = sosend(so, sa, 0, m, 0, 0, td);
946 ng_ksocket_shutdown(node_p node)
948 const priv_p priv = NG_NODE_PRIVATE(node);
951 /* Close our socket (if any) */
952 if (priv->so != NULL) {
953 SOCKBUF_LOCK(&priv->so->so_rcv);
954 soupcall_clear(priv->so, SO_RCV);
955 SOCKBUF_UNLOCK(&priv->so->so_rcv);
956 SOCKBUF_LOCK(&priv->so->so_snd);
957 soupcall_clear(priv->so, SO_SND);
958 SOCKBUF_UNLOCK(&priv->so->so_snd);
963 /* If we are an embryo, take ourselves out of the parent's list */
964 if (priv->flags & KSF_EMBRYONIC) {
965 LIST_REMOVE(priv, siblings);
966 priv->flags &= ~KSF_EMBRYONIC;
969 /* Remove any embryonic children we have */
970 while (!LIST_EMPTY(&priv->embryos)) {
971 embryo = LIST_FIRST(&priv->embryos);
972 ng_rmnode_self(embryo->node);
975 /* Take down netgraph node */
976 bzero(priv, sizeof(*priv));
977 free(priv, M_NETGRAPH_KSOCKET);
978 NG_NODE_SET_PRIVATE(node, NULL);
979 NG_NODE_UNREF(node); /* let the node escape */
987 ng_ksocket_disconnect(hook_p hook)
989 KASSERT(NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook)) == 0,
990 ("%s: numhooks=%d?", __func__,
991 NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook))));
992 if (NG_NODE_IS_VALID(NG_HOOK_NODE(hook)))
993 ng_rmnode_self(NG_HOOK_NODE(hook));
997 /************************************************************************
999 ************************************************************************/
1001 * You should not "just call" a netgraph node function from an external
1002 * asynchronous event. This is because in doing so you are ignoring the
1003 * locking on the netgraph nodes. Instead call your function via ng_send_fn().
1004 * This will call the function you chose, but will first do all the
1005 * locking rigmarole. Your function MAY only be called at some distant future
1006 * time (several millisecs away) so don't give it any arguments
1007 * that may be revoked soon (e.g. on your stack).
1009 * To decouple stack, we use queue version of ng_send_fn().
1013 ng_ksocket_incoming(struct socket *so, void *arg, int waitflag)
1015 const node_p node = arg;
1016 const priv_p priv = NG_NODE_PRIVATE(node);
1017 int wait = ((waitflag & M_WAITOK) ? NG_WAITOK : 0) | NG_QUEUE;
1020 * Even if node is not locked, as soon as we are called, we assume
1021 * it exist and it's private area is valid. With some care we can
1022 * access it. Mark node that incoming event for it was sent to
1023 * avoid unneded queue trashing.
1025 if (atomic_cmpset_int(&priv->fn_sent, 0, 1) &&
1026 ng_send_fn1(node, NULL, &ng_ksocket_incoming2, so, 0, wait)) {
1027 atomic_store_rel_int(&priv->fn_sent, 0);
1034 * When incoming data is appended to the socket, we get notified here.
1035 * This is also called whenever a significant event occurs for the socket.
1036 * Our original caller may have queued this even some time ago and
1037 * we cannot trust that he even still exists. The node however is being
1038 * held with a reference by the queueing code and guarantied to be valid.
1041 ng_ksocket_incoming2(node_p node, hook_p hook, void *arg1, int arg2)
1043 struct socket *so = arg1;
1044 const priv_p priv = NG_NODE_PRIVATE(node);
1046 struct ng_mesg *response;
1050 /* so = priv->so; *//* XXX could have derived this like so */
1051 KASSERT(so == priv->so, ("%s: wrong socket", __func__));
1053 /* Allow next incoming event to be queued. */
1054 atomic_store_rel_int(&priv->fn_sent, 0);
1056 /* Check whether a pending connect operation has completed */
1057 if (priv->flags & KSF_CONNECTING) {
1058 if ((error = so->so_error) != 0) {
1060 so->so_state &= ~SS_ISCONNECTING;
1062 if (!(so->so_state & SS_ISCONNECTING)) {
1063 NG_MKMESSAGE(response, NGM_KSOCKET_COOKIE,
1064 NGM_KSOCKET_CONNECT, sizeof(int32_t), M_NOWAIT);
1065 if (response != NULL) {
1066 response->header.flags |= NGF_RESP;
1067 response->header.token = priv->response_token;
1068 *(int32_t *)response->data = error;
1070 * send an async "response" message
1071 * to the node that set us up
1072 * (if it still exists)
1074 NG_SEND_MSG_ID(error, node,
1075 response, priv->response_addr, 0);
1077 priv->flags &= ~KSF_CONNECTING;
1081 /* Check whether a pending accept operation has completed */
1082 if (priv->flags & KSF_ACCEPTING) {
1083 error = ng_ksocket_check_accept(priv);
1084 if (error != EWOULDBLOCK)
1085 priv->flags &= ~KSF_ACCEPTING;
1087 ng_ksocket_finish_accept(priv);
1091 * If we don't have a hook, we must handle data events later. When
1092 * the hook gets created and is connected, this upcall function
1093 * will be called again.
1095 if (priv->hook == NULL)
1098 /* Read and forward available mbuf's */
1100 auio.uio_resid = 1000000000;
1101 flags = MSG_DONTWAIT;
1103 struct sockaddr *sa = NULL;
1106 /* Try to get next packet from socket */
1107 if ((error = soreceive(so, (so->so_state & SS_ISCONNECTED) ?
1108 NULL : &sa, &auio, &m, (struct mbuf **)0, &flags)) != 0)
1111 /* See if we got anything */
1119 * Don't trust the various socket layers to get the
1120 * packet header and length correct (e.g. kern/15175).
1122 * Also, do not trust that soreceive() will clear m_nextpkt
1123 * for us (e.g. kern/84952, kern/82413).
1125 m->m_pkthdr.csum_flags = 0;
1126 for (n = m, m->m_pkthdr.len = 0; n != NULL; n = n->m_next) {
1127 m->m_pkthdr.len += n->m_len;
1128 n->m_nextpkt = NULL;
1131 /* Put peer's socket address (if any) into a tag */
1133 struct sa_tag *stag;
1135 stag = (struct sa_tag *)m_tag_alloc(NGM_KSOCKET_COOKIE,
1136 NG_KSOCKET_TAG_SOCKADDR, sizeof(ng_ID_t) +
1137 sa->sa_len, M_NOWAIT);
1142 bcopy(sa, &stag->sa, sa->sa_len);
1144 stag->id = NG_NODE_ID(node);
1145 m_tag_prepend(m, &stag->tag);
1148 sendit: /* Forward data with optional peer sockaddr as packet tag */
1149 NG_SEND_DATA_ONLY(error, priv->hook, m);
1153 * If the peer has closed the connection, forward a 0-length mbuf
1154 * to indicate end-of-file.
1156 if (so->so_rcv.sb_state & SBS_CANTRCVMORE && !(priv->flags & KSF_EOFSEEN)) {
1157 MGETHDR(m, M_NOWAIT, MT_DATA);
1159 m->m_len = m->m_pkthdr.len = 0;
1160 NG_SEND_DATA_ONLY(error, priv->hook, m);
1162 priv->flags |= KSF_EOFSEEN;
1167 * Check for a completed incoming connection and return 0 if one is found.
1168 * Otherwise return the appropriate error code.
1171 ng_ksocket_check_accept(priv_p priv)
1173 struct socket *const head = priv->so;
1176 if ((error = head->so_error) != 0) {
1180 /* Unlocked read. */
1181 if (TAILQ_EMPTY(&head->so_comp)) {
1182 if (head->so_rcv.sb_state & SBS_CANTRCVMORE)
1183 return ECONNABORTED;
1190 * Handle the first completed incoming connection, assumed to be already
1191 * on the socket's so_comp queue.
1194 ng_ksocket_finish_accept(priv_p priv)
1196 struct socket *const head = priv->so;
1198 struct sockaddr *sa = NULL;
1199 struct ng_mesg *resp;
1200 struct ng_ksocket_accept *resp_data;
1207 so = TAILQ_FIRST(&head->so_comp);
1208 if (so == NULL) { /* Should never happen */
1212 TAILQ_REMOVE(&head->so_comp, so, so_list);
1214 so->so_qstate &= ~SQ_COMP;
1218 so->so_state |= SS_NBIO;
1222 /* XXX KNOTE_UNLOCKED(&head->so_rcv.sb_sel.si_note, 0); */
1226 len = OFFSETOF(struct ng_ksocket_accept, addr);
1230 NG_MKMESSAGE(resp, NGM_KSOCKET_COOKIE, NGM_KSOCKET_ACCEPT, len,
1236 resp->header.flags |= NGF_RESP;
1237 resp->header.token = priv->response_token;
1239 /* Clone a ksocket node to wrap the new socket */
1240 error = ng_make_node_common(&ng_ksocket_typestruct, &node);
1242 free(resp, M_NETGRAPH);
1247 if (ng_ksocket_constructor(node) != 0) {
1248 NG_NODE_UNREF(node);
1249 free(resp, M_NETGRAPH);
1254 priv2 = NG_NODE_PRIVATE(node);
1256 priv2->flags |= KSF_CLONED | KSF_EMBRYONIC;
1259 * Insert the cloned node into a list of embryonic children
1260 * on the parent node. When a hook is created on the cloned
1261 * node it will be removed from this list. When the parent
1262 * is destroyed it will destroy any embryonic children it has.
1264 LIST_INSERT_HEAD(&priv->embryos, priv2, siblings);
1266 SOCKBUF_LOCK(&so->so_rcv);
1267 soupcall_set(so, SO_RCV, ng_ksocket_incoming, node);
1268 SOCKBUF_UNLOCK(&so->so_rcv);
1269 SOCKBUF_LOCK(&so->so_snd);
1270 soupcall_set(so, SO_SND, ng_ksocket_incoming, node);
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')