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>
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 },
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 },
155 /* Helper functions */
156 static int ng_ksocket_check_accept(priv_p);
157 static void ng_ksocket_finish_accept(priv_p);
158 static int ng_ksocket_incoming(struct socket *so, void *arg, int waitflag);
159 static int ng_ksocket_parse(const struct ng_ksocket_alias *aliases,
160 const char *s, int family);
161 static void ng_ksocket_incoming2(node_p node, hook_p hook,
162 void *arg1, int arg2);
164 /************************************************************************
165 STRUCT SOCKADDR PARSE TYPE
166 ************************************************************************/
168 /* Get the length of the data portion of a generic struct sockaddr */
170 ng_parse_generic_sockdata_getLength(const struct ng_parse_type *type,
171 const u_char *start, const u_char *buf)
173 const struct sockaddr *sa;
175 sa = (const struct sockaddr *)(buf - SADATA_OFFSET);
176 return (sa->sa_len < SADATA_OFFSET) ? 0 : sa->sa_len - SADATA_OFFSET;
179 /* Type for the variable length data portion of a generic struct sockaddr */
180 static const struct ng_parse_type ng_ksocket_generic_sockdata_type = {
181 &ng_parse_bytearray_type,
182 &ng_parse_generic_sockdata_getLength
185 /* Type for a generic struct sockaddr */
186 static const struct ng_parse_struct_field
187 ng_parse_generic_sockaddr_type_fields[] = {
188 { "len", &ng_parse_uint8_type },
189 { "family", &ng_parse_uint8_type },
190 { "data", &ng_ksocket_generic_sockdata_type },
193 static const struct ng_parse_type ng_ksocket_generic_sockaddr_type = {
194 &ng_parse_struct_type,
195 &ng_parse_generic_sockaddr_type_fields
198 /* Convert a struct sockaddr from ASCII to binary. If its a protocol
199 family that we specially handle, do that, otherwise defer to the
200 generic parse type ng_ksocket_generic_sockaddr_type. */
202 ng_ksocket_sockaddr_parse(const struct ng_parse_type *type,
203 const char *s, int *off, const u_char *const start,
204 u_char *const buf, int *buflen)
206 struct sockaddr *const sa = (struct sockaddr *)buf;
207 enum ng_parse_token tok;
212 /* If next token is a left curly brace, use generic parse type */
213 if ((tok = ng_parse_get_token(s, off, &len)) == T_LBRACE) {
214 return (*ng_ksocket_generic_sockaddr_type.supertype->parse)
215 (&ng_ksocket_generic_sockaddr_type,
216 s, off, start, buf, buflen);
219 /* Get socket address family followed by a slash */
220 while (isspace(s[*off]))
222 if ((t = strchr(s + *off, '/')) == NULL)
224 if ((len = t - (s + *off)) > sizeof(fambuf) - 1)
226 strncpy(fambuf, s + *off, len);
229 if ((family = ng_ksocket_parse(ng_ksocket_families, fambuf, 0)) == -1)
233 if (*buflen < SADATA_OFFSET)
235 sa->sa_family = family;
237 /* Set family-specific data and length */
238 switch (sa->sa_family) {
239 case PF_LOCAL: /* Get pathname */
241 const int pathoff = OFFSETOF(struct sockaddr_un, sun_path);
242 struct sockaddr_un *const sun = (struct sockaddr_un *)sa;
246 if ((path = ng_get_string_token(s, off, &toklen, NULL)) == NULL)
248 pathlen = strlen(path);
249 if (pathlen > SOCK_MAXADDRLEN) {
250 free(path, M_NETGRAPH_KSOCKET);
253 if (*buflen < pathoff + pathlen) {
254 free(path, M_NETGRAPH_KSOCKET);
258 bcopy(path, sun->sun_path, pathlen);
259 sun->sun_len = pathoff + pathlen;
260 free(path, M_NETGRAPH_KSOCKET);
264 case PF_INET: /* Get an IP address with optional port */
266 struct sockaddr_in *const sin = (struct sockaddr_in *)sa;
269 /* Parse this: <ipaddress>[:port] */
270 for (i = 0; i < 4; i++) {
274 val = strtoul(s + *off, &eptr, 10);
275 if (val > 0xff || eptr == s + *off)
277 *off += (eptr - (s + *off));
278 ((u_char *)&sin->sin_addr)[i] = (u_char)val;
283 } else if (s[*off] == ':') {
285 val = strtoul(s + *off, &eptr, 10);
286 if (val > 0xffff || eptr == s + *off)
288 *off += (eptr - (s + *off));
289 sin->sin_port = htons(val);
293 bzero(&sin->sin_zero, sizeof(sin->sin_zero));
294 sin->sin_len = sizeof(*sin);
299 case PF_INET6: /* XXX implement this someday */
307 *buflen = sa->sa_len;
311 /* Convert a struct sockaddr from binary to ASCII */
313 ng_ksocket_sockaddr_unparse(const struct ng_parse_type *type,
314 const u_char *data, int *off, char *cbuf, int cbuflen)
316 const struct sockaddr *sa = (const struct sockaddr *)(data + *off);
319 /* Output socket address, either in special or generic format */
320 switch (sa->sa_family) {
323 const int pathoff = OFFSETOF(struct sockaddr_un, sun_path);
324 const struct sockaddr_un *sun = (const struct sockaddr_un *)sa;
325 const int pathlen = sun->sun_len - pathoff;
326 char pathbuf[SOCK_MAXADDRLEN + 1];
329 bcopy(sun->sun_path, pathbuf, pathlen);
330 if ((pathtoken = ng_encode_string(pathbuf, pathlen)) == NULL)
332 slen += snprintf(cbuf, cbuflen, "local/%s", pathtoken);
333 free(pathtoken, M_NETGRAPH_KSOCKET);
336 *off += sun->sun_len;
342 const struct sockaddr_in *sin = (const struct sockaddr_in *)sa;
344 slen += snprintf(cbuf, cbuflen, "inet/%d.%d.%d.%d",
345 ((const u_char *)&sin->sin_addr)[0],
346 ((const u_char *)&sin->sin_addr)[1],
347 ((const u_char *)&sin->sin_addr)[2],
348 ((const u_char *)&sin->sin_addr)[3]);
349 if (sin->sin_port != 0) {
350 slen += snprintf(cbuf + strlen(cbuf),
351 cbuflen - strlen(cbuf), ":%d",
352 (u_int)ntohs(sin->sin_port));
356 *off += sizeof(*sin);
361 case PF_INET6: /* XXX implement this someday */
365 return (*ng_ksocket_generic_sockaddr_type.supertype->unparse)
366 (&ng_ksocket_generic_sockaddr_type,
367 data, off, cbuf, cbuflen);
371 /* Parse type for struct sockaddr */
372 static const struct ng_parse_type ng_ksocket_sockaddr_type = {
376 &ng_ksocket_sockaddr_parse,
377 &ng_ksocket_sockaddr_unparse,
378 NULL /* no such thing as a default struct sockaddr */
381 /************************************************************************
382 STRUCT NG_KSOCKET_SOCKOPT PARSE TYPE
383 ************************************************************************/
385 /* Get length of the struct ng_ksocket_sockopt value field, which is the
386 just the excess of the message argument portion over the length of
387 the struct ng_ksocket_sockopt. */
389 ng_parse_sockoptval_getLength(const struct ng_parse_type *type,
390 const u_char *start, const u_char *buf)
392 static const int offset = OFFSETOF(struct ng_ksocket_sockopt, value);
393 const struct ng_ksocket_sockopt *sopt;
394 const struct ng_mesg *msg;
396 sopt = (const struct ng_ksocket_sockopt *)(buf - offset);
397 msg = (const struct ng_mesg *)((const u_char *)sopt - sizeof(*msg));
398 return msg->header.arglen - sizeof(*sopt);
401 /* Parse type for the option value part of a struct ng_ksocket_sockopt
402 XXX Eventually, we should handle the different socket options specially.
403 XXX This would avoid byte order problems, eg an integer value of 1 is
404 XXX going to be "[1]" for little endian or "[3=1]" for big endian. */
405 static const struct ng_parse_type ng_ksocket_sockoptval_type = {
406 &ng_parse_bytearray_type,
407 &ng_parse_sockoptval_getLength
410 /* Parse type for struct ng_ksocket_sockopt */
411 static const struct ng_parse_struct_field ng_ksocket_sockopt_type_fields[]
412 = NG_KSOCKET_SOCKOPT_INFO(&ng_ksocket_sockoptval_type);
413 static const struct ng_parse_type ng_ksocket_sockopt_type = {
414 &ng_parse_struct_type,
415 &ng_ksocket_sockopt_type_fields
418 /* Parse type for struct ng_ksocket_accept */
419 static const struct ng_parse_struct_field ng_ksocket_accept_type_fields[]
420 = NGM_KSOCKET_ACCEPT_INFO;
421 static const struct ng_parse_type ng_ksocket_accept_type = {
422 &ng_parse_struct_type,
423 &ng_ksocket_accept_type_fields
426 /* List of commands and how to convert arguments to/from ASCII */
427 static const struct ng_cmdlist ng_ksocket_cmds[] = {
432 &ng_ksocket_sockaddr_type,
439 &ng_parse_int32_type,
447 &ng_ksocket_accept_type
453 &ng_ksocket_sockaddr_type,
461 &ng_ksocket_sockaddr_type
465 NGM_KSOCKET_GETPEERNAME,
468 &ng_ksocket_sockaddr_type
474 &ng_ksocket_sockopt_type,
481 &ng_ksocket_sockopt_type,
482 &ng_ksocket_sockopt_type
487 /* Node type descriptor */
488 static struct ng_type ng_ksocket_typestruct = {
489 .version = NG_ABI_VERSION,
490 .name = NG_KSOCKET_NODE_TYPE,
491 .constructor = ng_ksocket_constructor,
492 .rcvmsg = ng_ksocket_rcvmsg,
493 .shutdown = ng_ksocket_shutdown,
494 .newhook = ng_ksocket_newhook,
495 .connect = ng_ksocket_connect,
496 .rcvdata = ng_ksocket_rcvdata,
497 .disconnect = ng_ksocket_disconnect,
498 .cmdlist = ng_ksocket_cmds,
500 NETGRAPH_INIT(ksocket, &ng_ksocket_typestruct);
502 #define ERROUT(x) do { error = (x); goto done; } while (0)
504 /************************************************************************
506 ************************************************************************/
509 * Node type constructor
510 * The NODE part is assumed to be all set up.
511 * There is already a reference to the node for us.
514 ng_ksocket_constructor(node_p node)
518 /* Allocate private structure */
519 priv = malloc(sizeof(*priv), M_NETGRAPH_KSOCKET, M_NOWAIT | M_ZERO);
523 LIST_INIT(&priv->embryos);
524 /* cross link them */
526 NG_NODE_SET_PRIVATE(node, priv);
533 * Give our OK for a hook to be added. The hook name is of the
534 * form "<family>/<type>/<proto>" where the three components may
535 * be decimal numbers or else aliases from the above lists.
537 * Connecting a hook amounts to opening the socket. Disconnecting
538 * the hook closes the socket and destroys the node as well.
541 ng_ksocket_newhook(node_p node, hook_p hook, const char *name0)
543 struct thread *td = curthread; /* XXX broken */
544 const priv_p priv = NG_NODE_PRIVATE(node);
545 char *s1, *s2, name[NG_HOOKSIZ];
546 int family, type, protocol, error;
548 /* Check if we're already connected */
549 if (priv->hook != NULL)
552 if (priv->flags & KSF_CLONED) {
553 if (priv->flags & KSF_EMBRYONIC) {
554 /* Remove ourselves from our parent's embryo list */
555 LIST_REMOVE(priv, siblings);
556 priv->flags &= ~KSF_EMBRYONIC;
559 /* Extract family, type, and protocol from hook name */
560 snprintf(name, sizeof(name), "%s", name0);
562 if ((s2 = strchr(s1, '/')) == NULL)
565 family = ng_ksocket_parse(ng_ksocket_families, s1, 0);
569 if ((s2 = strchr(s1, '/')) == NULL)
572 type = ng_ksocket_parse(ng_ksocket_types, s1, 0);
576 protocol = ng_ksocket_parse(ng_ksocket_protos, s1, family);
580 /* Create the socket */
581 error = socreate(family, &priv->so, type, protocol,
586 /* XXX call soreserve() ? */
594 * In case of misconfigured routing a packet may reenter
595 * ksocket node recursively. Decouple stack to avoid possible
596 * panics about sleeping with locks held.
598 NG_HOOK_FORCE_QUEUE(hook);
604 ng_ksocket_connect(hook_p hook)
606 node_p node = NG_HOOK_NODE(hook);
607 const priv_p priv = NG_NODE_PRIVATE(node);
608 struct socket *const so = priv->so;
610 /* Add our hook for incoming data and other events */
611 SOCKBUF_LOCK(&priv->so->so_rcv);
612 soupcall_set(priv->so, SO_RCV, ng_ksocket_incoming, node);
613 SOCKBUF_UNLOCK(&priv->so->so_rcv);
614 SOCKBUF_LOCK(&priv->so->so_snd);
615 soupcall_set(priv->so, SO_SND, ng_ksocket_incoming, node);
616 SOCKBUF_UNLOCK(&priv->so->so_snd);
618 priv->so->so_state |= SS_NBIO;
619 SOCK_UNLOCK(priv->so);
621 * --Original comment--
622 * On a cloned socket we may have already received one or more
623 * upcalls which we couldn't handle without a hook. Handle
625 * We cannot call the upcall function directly
626 * from here, because until this function has returned our
627 * hook isn't connected.
629 * ---meta comment for -current ---
630 * XXX This is dubius.
631 * Upcalls between the time that the hook was
632 * first created and now (on another processesor) will
633 * be earlier on the queue than the request to finalise the hook.
634 * By the time the hook is finalised,
635 * The queued upcalls will have happenned and the code
636 * will have discarded them because of a lack of a hook.
639 * This is a bad byproduct of the complicated way in which hooks
640 * are now created (3 daisy chained async events).
642 * Since we are a netgraph operation
643 * We know that we hold a lock on this node. This forces the
644 * request we make below to be queued rather than implemented
645 * immediatly which will cause the upcall function to be called a bit
647 * However, as we will run any waiting queued operations immediatly
648 * after doing this one, if we have not finalised the other end
649 * of the hook, those queued operations will fail.
651 if (priv->flags & KSF_CLONED) {
652 ng_send_fn(node, NULL, &ng_ksocket_incoming2, so, M_NOWAIT);
659 * Receive a control message
662 ng_ksocket_rcvmsg(node_p node, item_p item, hook_p lasthook)
664 struct thread *td = curthread; /* XXX broken */
665 const priv_p priv = NG_NODE_PRIVATE(node);
666 struct socket *const so = priv->so;
667 struct ng_mesg *resp = NULL;
672 NGI_GET_MSG(item, msg);
673 switch (msg->header.typecookie) {
674 case NGM_KSOCKET_COOKIE:
675 switch (msg->header.cmd) {
676 case NGM_KSOCKET_BIND:
678 struct sockaddr *const sa
679 = (struct sockaddr *)msg->data;
682 if (msg->header.arglen < SADATA_OFFSET
683 || msg->header.arglen < sa->sa_len)
689 error = sobind(so, sa, td);
692 case NGM_KSOCKET_LISTEN:
695 if (msg->header.arglen != sizeof(int32_t))
701 error = solisten(so, *((int32_t *)msg->data), td);
705 case NGM_KSOCKET_ACCEPT:
708 if (msg->header.arglen != 0)
713 /* Make sure the socket is capable of accepting */
714 if (!(so->so_options & SO_ACCEPTCONN))
716 if (priv->flags & KSF_ACCEPTING)
719 error = ng_ksocket_check_accept(priv);
720 if (error != 0 && error != EWOULDBLOCK)
724 * If a connection is already complete, take it.
725 * Otherwise let the upcall function deal with
726 * the connection when it comes in.
728 priv->response_token = msg->header.token;
729 raddr = priv->response_addr = NGI_RETADDR(item);
731 ng_ksocket_finish_accept(priv);
733 priv->flags |= KSF_ACCEPTING;
737 case NGM_KSOCKET_CONNECT:
739 struct sockaddr *const sa
740 = (struct sockaddr *)msg->data;
743 if (msg->header.arglen < SADATA_OFFSET
744 || msg->header.arglen < sa->sa_len)
750 if ((so->so_state & SS_ISCONNECTING) != 0)
752 if ((error = soconnect(so, sa, td)) != 0) {
753 so->so_state &= ~SS_ISCONNECTING;
756 if ((so->so_state & SS_ISCONNECTING) != 0) {
757 /* We will notify the sender when we connect */
758 priv->response_token = msg->header.token;
759 raddr = priv->response_addr = NGI_RETADDR(item);
760 priv->flags |= KSF_CONNECTING;
766 case NGM_KSOCKET_GETNAME:
767 case NGM_KSOCKET_GETPEERNAME:
769 int (*func)(struct socket *so, struct sockaddr **nam);
770 struct sockaddr *sa = NULL;
774 if (msg->header.arglen != 0)
780 if (msg->header.cmd == NGM_KSOCKET_GETPEERNAME) {
782 & (SS_ISCONNECTED|SS_ISCONFIRMING)) == 0)
784 func = so->so_proto->pr_usrreqs->pru_peeraddr;
786 func = so->so_proto->pr_usrreqs->pru_sockaddr;
788 /* Get local or peer address */
789 if ((error = (*func)(so, &sa)) != 0)
791 len = (sa == NULL) ? 0 : sa->sa_len;
793 /* Send it back in a response */
794 NG_MKRESPONSE(resp, msg, len, M_NOWAIT);
799 bcopy(sa, resp->data, len);
808 case NGM_KSOCKET_GETOPT:
810 struct ng_ksocket_sockopt *ksopt =
811 (struct ng_ksocket_sockopt *)msg->data;
815 if (msg->header.arglen != sizeof(*ksopt))
820 /* Get response with room for option value */
821 NG_MKRESPONSE(resp, msg, sizeof(*ksopt)
822 + NG_KSOCKET_MAX_OPTLEN, M_NOWAIT);
826 /* Get socket option, and put value in the response */
827 sopt.sopt_dir = SOPT_GET;
828 sopt.sopt_level = ksopt->level;
829 sopt.sopt_name = ksopt->name;
831 sopt.sopt_valsize = NG_KSOCKET_MAX_OPTLEN;
832 ksopt = (struct ng_ksocket_sockopt *)resp->data;
833 sopt.sopt_val = ksopt->value;
834 if ((error = sogetopt(so, &sopt)) != 0) {
839 /* Set actual value length */
840 resp->header.arglen = sizeof(*ksopt)
845 case NGM_KSOCKET_SETOPT:
847 struct ng_ksocket_sockopt *const ksopt =
848 (struct ng_ksocket_sockopt *)msg->data;
849 const int valsize = msg->header.arglen - sizeof(*ksopt);
858 /* Set socket option */
859 sopt.sopt_dir = SOPT_SET;
860 sopt.sopt_level = ksopt->level;
861 sopt.sopt_name = ksopt->name;
862 sopt.sopt_val = ksopt->value;
863 sopt.sopt_valsize = valsize;
865 error = sosetopt(so, &sopt);
879 NG_RESPOND_MSG(error, node, item, resp);
885 * Receive incoming data on our hook. Send it out the socket.
888 ng_ksocket_rcvdata(hook_p hook, item_p item)
890 struct thread *td = curthread; /* XXX broken */
891 const node_p node = NG_HOOK_NODE(hook);
892 const priv_p priv = NG_NODE_PRIVATE(node);
893 struct socket *const so = priv->so;
894 struct sockaddr *sa = NULL;
897 #ifdef ALIGNED_POINTER
899 #endif /* ALIGNED_POINTER */
905 #ifdef ALIGNED_POINTER
906 if (!ALIGNED_POINTER(mtod(m, caddr_t), uint32_t)) {
907 n = m_defrag(m, M_NOWAIT);
914 #endif /* ALIGNED_POINTER */
916 * Look if socket address is stored in packet tags.
917 * If sockaddr is ours, or provided by a third party (zero id),
920 if (((stag = (struct sa_tag *)m_tag_locate(m, NGM_KSOCKET_COOKIE,
921 NG_KSOCKET_TAG_SOCKADDR, NULL)) != NULL) &&
922 (stag->id == NG_NODE_ID(node) || stag->id == 0))
925 /* Reset specific mbuf flags to prevent addressing problems. */
926 m->m_flags &= ~(M_BCAST|M_MCAST);
929 error = sosend(so, sa, 0, m, 0, 0, td);
938 ng_ksocket_shutdown(node_p node)
940 const priv_p priv = NG_NODE_PRIVATE(node);
943 /* Close our socket (if any) */
944 if (priv->so != NULL) {
945 SOCKBUF_LOCK(&priv->so->so_rcv);
946 soupcall_clear(priv->so, SO_RCV);
947 SOCKBUF_UNLOCK(&priv->so->so_rcv);
948 SOCKBUF_LOCK(&priv->so->so_snd);
949 soupcall_clear(priv->so, SO_SND);
950 SOCKBUF_UNLOCK(&priv->so->so_snd);
955 /* If we are an embryo, take ourselves out of the parent's list */
956 if (priv->flags & KSF_EMBRYONIC) {
957 LIST_REMOVE(priv, siblings);
958 priv->flags &= ~KSF_EMBRYONIC;
961 /* Remove any embryonic children we have */
962 while (!LIST_EMPTY(&priv->embryos)) {
963 embryo = LIST_FIRST(&priv->embryos);
964 ng_rmnode_self(embryo->node);
967 /* Take down netgraph node */
968 bzero(priv, sizeof(*priv));
969 free(priv, M_NETGRAPH_KSOCKET);
970 NG_NODE_SET_PRIVATE(node, NULL);
971 NG_NODE_UNREF(node); /* let the node escape */
979 ng_ksocket_disconnect(hook_p hook)
981 KASSERT(NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook)) == 0,
982 ("%s: numhooks=%d?", __func__,
983 NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook))));
984 if (NG_NODE_IS_VALID(NG_HOOK_NODE(hook)))
985 ng_rmnode_self(NG_HOOK_NODE(hook));
989 /************************************************************************
991 ************************************************************************/
993 * You should not "just call" a netgraph node function from an external
994 * asynchronous event. This is because in doing so you are ignoring the
995 * locking on the netgraph nodes. Instead call your function via ng_send_fn().
996 * This will call the function you chose, but will first do all the
997 * locking rigmarole. Your function MAY only be called at some distant future
998 * time (several millisecs away) so don't give it any arguments
999 * that may be revoked soon (e.g. on your stack).
1001 * To decouple stack, we use queue version of ng_send_fn().
1005 ng_ksocket_incoming(struct socket *so, void *arg, int waitflag)
1007 const node_p node = arg;
1008 const priv_p priv = NG_NODE_PRIVATE(node);
1009 int wait = ((waitflag & M_WAITOK) ? NG_WAITOK : 0) | NG_QUEUE;
1012 * Even if node is not locked, as soon as we are called, we assume
1013 * it exist and it's private area is valid. With some care we can
1014 * access it. Mark node that incoming event for it was sent to
1015 * avoid unneded queue trashing.
1017 if (atomic_cmpset_int(&priv->fn_sent, 0, 1) &&
1018 ng_send_fn1(node, NULL, &ng_ksocket_incoming2, so, 0, wait)) {
1019 atomic_store_rel_int(&priv->fn_sent, 0);
1026 * When incoming data is appended to the socket, we get notified here.
1027 * This is also called whenever a significant event occurs for the socket.
1028 * Our original caller may have queued this even some time ago and
1029 * we cannot trust that he even still exists. The node however is being
1030 * held with a reference by the queueing code and guarantied to be valid.
1033 ng_ksocket_incoming2(node_p node, hook_p hook, void *arg1, int arg2)
1035 struct socket *so = arg1;
1036 const priv_p priv = NG_NODE_PRIVATE(node);
1037 struct ng_mesg *response;
1040 KASSERT(so == priv->so, ("%s: wrong socket", __func__));
1042 /* Allow next incoming event to be queued. */
1043 atomic_store_rel_int(&priv->fn_sent, 0);
1045 /* Check whether a pending connect operation has completed */
1046 if (priv->flags & KSF_CONNECTING) {
1047 if ((error = so->so_error) != 0) {
1049 so->so_state &= ~SS_ISCONNECTING;
1051 if (!(so->so_state & SS_ISCONNECTING)) {
1052 NG_MKMESSAGE(response, NGM_KSOCKET_COOKIE,
1053 NGM_KSOCKET_CONNECT, sizeof(int32_t), M_NOWAIT);
1054 if (response != NULL) {
1055 response->header.flags |= NGF_RESP;
1056 response->header.token = priv->response_token;
1057 *(int32_t *)response->data = error;
1059 * send an async "response" message
1060 * to the node that set us up
1061 * (if it still exists)
1063 NG_SEND_MSG_ID(error, node,
1064 response, priv->response_addr, 0);
1066 priv->flags &= ~KSF_CONNECTING;
1070 /* Check whether a pending accept operation has completed */
1071 if (priv->flags & KSF_ACCEPTING) {
1072 error = ng_ksocket_check_accept(priv);
1073 if (error != EWOULDBLOCK)
1074 priv->flags &= ~KSF_ACCEPTING;
1076 ng_ksocket_finish_accept(priv);
1080 * If we don't have a hook, we must handle data events later. When
1081 * the hook gets created and is connected, this upcall function
1082 * will be called again.
1084 if (priv->hook == NULL)
1087 /* Read and forward available mbufs. */
1090 struct sockaddr *sa;
1094 /* Try to get next packet from socket. */
1096 uio.uio_resid = IP_MAXPACKET;
1097 flags = MSG_DONTWAIT;
1099 if ((error = soreceive(so, (so->so_state & SS_ISCONNECTED) ?
1100 NULL : &sa, &uio, &m, NULL, &flags)) != 0)
1103 /* See if we got anything. */
1104 if (flags & MSG_TRUNC) {
1114 KASSERT(m->m_nextpkt == NULL, ("%s: nextpkt", __func__));
1117 * Stream sockets do not have packet boundaries, so
1118 * we have to allocate a header mbuf and attach the
1119 * stream of data to it.
1121 if (so->so_type == SOCK_STREAM) {
1124 mh = m_gethdr(M_NOWAIT, MT_DATA);
1133 for (; m; m = m->m_next)
1134 mh->m_pkthdr.len += m->m_len;
1138 /* Put peer's socket address (if any) into a tag */
1140 struct sa_tag *stag;
1142 stag = (struct sa_tag *)m_tag_alloc(NGM_KSOCKET_COOKIE,
1143 NG_KSOCKET_TAG_SOCKADDR, sizeof(ng_ID_t) +
1144 sa->sa_len, M_NOWAIT);
1149 bcopy(sa, &stag->sa, sa->sa_len);
1151 stag->id = NG_NODE_ID(node);
1152 m_tag_prepend(m, &stag->tag);
1155 sendit: /* Forward data with optional peer sockaddr as packet tag */
1156 NG_SEND_DATA_ONLY(error, priv->hook, m);
1160 * If the peer has closed the connection, forward a 0-length mbuf
1161 * to indicate end-of-file.
1163 if (so->so_rcv.sb_state & SBS_CANTRCVMORE &&
1164 !(priv->flags & KSF_EOFSEEN)) {
1167 m = m_gethdr(M_NOWAIT, MT_DATA);
1169 NG_SEND_DATA_ONLY(error, priv->hook, m);
1170 priv->flags |= KSF_EOFSEEN;
1175 * Check for a completed incoming connection and return 0 if one is found.
1176 * Otherwise return the appropriate error code.
1179 ng_ksocket_check_accept(priv_p priv)
1181 struct socket *const head = priv->so;
1184 if ((error = head->so_error) != 0) {
1188 /* Unlocked read. */
1189 if (TAILQ_EMPTY(&head->so_comp)) {
1190 if (head->so_rcv.sb_state & SBS_CANTRCVMORE)
1191 return ECONNABORTED;
1198 * Handle the first completed incoming connection, assumed to be already
1199 * on the socket's so_comp queue.
1202 ng_ksocket_finish_accept(priv_p priv)
1204 struct socket *const head = priv->so;
1206 struct sockaddr *sa = NULL;
1207 struct ng_mesg *resp;
1208 struct ng_ksocket_accept *resp_data;
1215 so = TAILQ_FIRST(&head->so_comp);
1216 if (so == NULL) { /* Should never happen */
1220 TAILQ_REMOVE(&head->so_comp, so, so_list);
1222 so->so_qstate &= ~SQ_COMP;
1226 so->so_state |= SS_NBIO;
1230 /* XXX KNOTE_UNLOCKED(&head->so_rcv.sb_sel.si_note, 0); */
1234 len = OFFSETOF(struct ng_ksocket_accept, addr);
1238 NG_MKMESSAGE(resp, NGM_KSOCKET_COOKIE, NGM_KSOCKET_ACCEPT, len,
1244 resp->header.flags |= NGF_RESP;
1245 resp->header.token = priv->response_token;
1247 /* Clone a ksocket node to wrap the new socket */
1248 error = ng_make_node_common(&ng_ksocket_typestruct, &node);
1250 free(resp, M_NETGRAPH);
1255 if (ng_ksocket_constructor(node) != 0) {
1256 NG_NODE_UNREF(node);
1257 free(resp, M_NETGRAPH);
1262 priv2 = NG_NODE_PRIVATE(node);
1264 priv2->flags |= KSF_CLONED | KSF_EMBRYONIC;
1267 * Insert the cloned node into a list of embryonic children
1268 * on the parent node. When a hook is created on the cloned
1269 * node it will be removed from this list. When the parent
1270 * is destroyed it will destroy any embryonic children it has.
1272 LIST_INSERT_HEAD(&priv->embryos, priv2, siblings);
1274 SOCKBUF_LOCK(&so->so_rcv);
1275 soupcall_set(so, SO_RCV, ng_ksocket_incoming, node);
1276 SOCKBUF_UNLOCK(&so->so_rcv);
1277 SOCKBUF_LOCK(&so->so_snd);
1278 soupcall_set(so, SO_SND, ng_ksocket_incoming, node);
1279 SOCKBUF_UNLOCK(&so->so_snd);
1281 /* Fill in the response data and send it or return it to the caller */
1282 resp_data = (struct ng_ksocket_accept *)resp->data;
1283 resp_data->nodeid = NG_NODE_ID(node);
1285 bcopy(sa, &resp_data->addr, sa->sa_len);
1286 NG_SEND_MSG_ID(error, node, resp, priv->response_addr, 0);
1294 * Parse out either an integer value or an alias.
1297 ng_ksocket_parse(const struct ng_ksocket_alias *aliases,
1298 const char *s, int family)
1304 for (k = 0; aliases[k].name != NULL; k++) {
1305 if (strcmp(s, aliases[k].name) == 0
1306 && aliases[k].family == family)
1307 return aliases[k].value;
1310 /* Try parsing as a number */
1311 val = (int)strtoul(s, &eptr, 10);
1312 if (val < 0 || *eptr != '\0')