5 * Copyright (c) 1996-1999 Whistle Communications, Inc.
8 * Subject to the following obligations and disclaimer of warranty, use and
9 * redistribution of this software, in source or object code forms, with or
10 * without modifications are expressly permitted by Whistle Communications;
11 * provided, however, that:
12 * 1. Any and all reproductions of the source or object code must include the
13 * copyright notice above and the following disclaimer of warranties; and
14 * 2. No rights are granted, in any manner or form, to use Whistle
15 * Communications, Inc. trademarks, including the mark "WHISTLE
16 * COMMUNICATIONS" on advertising, endorsements, or otherwise except as
17 * such appears in the above copyright notice or in the software.
19 * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
20 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
21 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
22 * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
23 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
24 * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
25 * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
26 * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
27 * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
28 * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
29 * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
30 * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
31 * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34 * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
37 * Author: Archie Cobbs <archie@freebsd.org>
39 * $FreeBSD: src/sys/netgraph/ng_ksocket.c,v 1.5.2.14 2003/08/24 08:24:38 hsu Exp $
40 * $Whistle: ng_ksocket.c,v 1.1 1999/11/16 20:04:40 archie Exp $
44 * Kernel socket node type. This node type is basically a kernel-mode
45 * version of a socket... kindof like the reverse of the socket node type.
48 #include <sys/param.h>
49 #include <sys/systm.h>
50 #include <sys/kernel.h>
53 #include <sys/malloc.h>
54 #include <sys/ctype.h>
55 #include <sys/protosw.h>
56 #include <sys/errno.h>
57 #include <sys/fcntl.h>
58 #include <sys/socket.h>
59 #include <sys/socketvar.h>
60 #include <sys/socketops.h>
64 #include <sys/thread2.h>
65 #include <sys/socketvar2.h>
67 #include <netgraph/ng_message.h>
68 #include <netgraph/netgraph.h>
69 #include <netgraph/ng_parse.h>
70 #include "ng_ksocket.h"
72 #include <netinet/in.h>
74 #define OFFSETOF(s, e) ((char *)&((s *)0)->e - (char *)((s *)0))
75 #define SADATA_OFFSET (OFFSETOF(struct sockaddr, sa_data))
77 /* Node private data */
78 struct ng_ksocket_private
{
82 LIST_HEAD(, ng_ksocket_private
) embryos
;
83 LIST_ENTRY(ng_ksocket_private
) siblings
;
85 u_int32_t response_token
;
86 char response_addr
[NG_PATHSIZ
];
88 typedef struct ng_ksocket_private
*priv_p
;
90 /* Flags for priv_p */
91 #define KSF_CONNECTING 0x00000001 /* Waiting for connection complete */
92 #define KSF_ACCEPTING 0x00000002 /* Waiting for accept complete */
93 #define KSF_EOFSEEN 0x00000004 /* Have sent 0-length EOF mbuf */
94 #define KSF_CLONED 0x00000008 /* Cloned from an accepting socket */
95 #define KSF_EMBRYONIC 0x00000010 /* Cloned node with no hooks yet */
96 #define KSF_SENDING 0x00000020 /* Sending on socket */
98 /* Internal commands which we send to ourselves */
99 #define NGM_KSOCKET_INTERNAL_COOKIE (NGM_KSOCKET_COOKIE + 1)
102 NGM_KSOCKET_INTERNAL_UPCALL
= 1
105 /* Netgraph node methods */
106 static ng_constructor_t ng_ksocket_constructor
;
107 static ng_rcvmsg_t ng_ksocket_rcvmsg
;
108 static ng_shutdown_t ng_ksocket_rmnode
;
109 static ng_newhook_t ng_ksocket_newhook
;
110 static ng_rcvdata_t ng_ksocket_rcvdata
;
111 static ng_disconnect_t ng_ksocket_disconnect
;
113 /* Alias structure */
114 struct ng_ksocket_alias
{
120 /* Protocol family aliases */
121 static const struct ng_ksocket_alias ng_ksocket_families
[] = {
122 { "local", PF_LOCAL
},
124 { "inet6", PF_INET6
},
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
},
157 /* Helper functions */
158 static int ng_ksocket_check_accept(priv_p
);
159 static void ng_ksocket_finish_accept(priv_p
, struct ng_mesg
**);
160 static void ng_ksocket_incoming(struct socket
*so
, void *arg
, int waitflag
);
161 static int ng_ksocket_parse(const struct ng_ksocket_alias
*aliases
,
162 const char *s
, int family
);
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
= index(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
)
248 pathlen
= strlen(path
);
249 if (pathlen
> SOCK_MAXADDRLEN
) {
250 kfree(path
, M_NETGRAPH
);
253 if (*buflen
< pathoff
+ pathlen
) {
254 kfree(path
, M_NETGRAPH
);
258 bcopy(path
, sun
->sun_path
, pathlen
);
259 sun
->sun_len
= pathoff
+ pathlen
;
260 kfree(path
, M_NETGRAPH
);
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
);
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 pathbuf
[pathlen
] = '\0';
331 if ((pathtoken
= ng_encode_string(pathbuf
)) == NULL
)
333 slen
+= ksnprintf(cbuf
, cbuflen
, "local/%s", pathtoken
);
334 kfree(pathtoken
, M_NETGRAPH
);
337 *off
+= sun
->sun_len
;
343 const struct sockaddr_in
*sin
= (const struct sockaddr_in
*)sa
;
345 slen
+= ksnprintf(cbuf
, cbuflen
, "inet/%d.%d.%d.%d",
346 ((const u_char
*)&sin
->sin_addr
)[0],
347 ((const u_char
*)&sin
->sin_addr
)[1],
348 ((const u_char
*)&sin
->sin_addr
)[2],
349 ((const u_char
*)&sin
->sin_addr
)[3]);
350 if (sin
->sin_port
!= 0) {
351 slen
+= ksnprintf(cbuf
+ strlen(cbuf
),
352 cbuflen
- strlen(cbuf
), ":%d",
353 (u_int
)ntohs(sin
->sin_port
));
357 *off
+= sizeof(*sin
);
366 return (*ng_ksocket_generic_sockaddr_type
.supertype
->unparse
)
367 (&ng_ksocket_generic_sockaddr_type
,
368 data
, off
, cbuf
, cbuflen
);
372 /* Parse type for struct sockaddr */
373 static const struct ng_parse_type ng_ksocket_sockaddr_type
= {
377 &ng_ksocket_sockaddr_parse
,
378 &ng_ksocket_sockaddr_unparse
,
379 NULL
/* no such thing as a default struct sockaddr */
382 /************************************************************************
383 STRUCT NG_KSOCKET_SOCKOPT PARSE TYPE
384 ************************************************************************/
386 /* Get length of the struct ng_ksocket_sockopt value field, which is the
387 just the excess of the message argument portion over the length of
388 the struct ng_ksocket_sockopt. */
390 ng_parse_sockoptval_getLength(const struct ng_parse_type
*type
,
391 const u_char
*start
, const u_char
*buf
)
393 static const int offset
= OFFSETOF(struct ng_ksocket_sockopt
, value
);
394 const struct ng_ksocket_sockopt
*sopt
;
395 const struct ng_mesg
*msg
;
397 sopt
= (const struct ng_ksocket_sockopt
*)(buf
- offset
);
398 msg
= (const struct ng_mesg
*)((const u_char
*)sopt
- sizeof(*msg
));
399 return msg
->header
.arglen
- sizeof(*sopt
);
402 /* Parse type for the option value part of a struct ng_ksocket_sockopt
403 XXX Eventually, we should handle the different socket options specially.
404 XXX This would avoid byte order problems, eg an integer value of 1 is
405 XXX going to be "[1]" for little endian or "[3=1]" for big endian. */
406 static const struct ng_parse_type ng_ksocket_sockoptval_type
= {
407 &ng_parse_bytearray_type
,
408 &ng_parse_sockoptval_getLength
411 /* Parse type for struct ng_ksocket_sockopt */
412 static const struct ng_parse_struct_field ng_ksocket_sockopt_type_fields
[]
413 = NG_KSOCKET_SOCKOPT_INFO(&ng_ksocket_sockoptval_type
);
414 static const struct ng_parse_type ng_ksocket_sockopt_type
= {
415 &ng_parse_struct_type
,
416 &ng_ksocket_sockopt_type_fields
419 /* Parse type for struct ng_ksocket_accept */
420 static const struct ng_parse_struct_field ng_ksocket_accept_type_fields
[]
421 = NGM_KSOCKET_ACCEPT_INFO
;
422 static const struct ng_parse_type ng_ksocket_accept_type
= {
423 &ng_parse_struct_type
,
424 &ng_ksocket_accept_type_fields
427 /* List of commands and how to convert arguments to/from ASCII */
428 static const struct ng_cmdlist ng_ksocket_cmds
[] = {
433 &ng_ksocket_sockaddr_type
,
440 &ng_parse_int32_type
,
448 &ng_ksocket_accept_type
454 &ng_ksocket_sockaddr_type
,
462 &ng_ksocket_sockaddr_type
466 NGM_KSOCKET_GETPEERNAME
,
469 &ng_ksocket_sockaddr_type
475 &ng_ksocket_sockopt_type
,
482 &ng_ksocket_sockopt_type
,
483 &ng_ksocket_sockopt_type
486 /* Internal commands */
488 NGM_KSOCKET_INTERNAL_COOKIE
,
489 NGM_KSOCKET_INTERNAL_UPCALL
,
497 /* Node type descriptor */
498 static struct ng_type ng_ksocket_typestruct
= {
500 NG_KSOCKET_NODE_TYPE
,
502 ng_ksocket_constructor
,
510 ng_ksocket_disconnect
,
513 NETGRAPH_INIT(ksocket
, &ng_ksocket_typestruct
);
515 #define ERROUT(x) do { error = (x); goto done; } while (0)
517 /************************************************************************
519 ************************************************************************/
522 * Node type constructor
525 ng_ksocket_constructor(node_p
*nodep
)
530 /* Allocate private structure */
531 priv
= kmalloc(sizeof(*priv
), M_NETGRAPH
, M_NOWAIT
| M_ZERO
);
535 /* Call generic node constructor */
536 if ((error
= ng_make_node_common(&ng_ksocket_typestruct
, nodep
))) {
537 kfree(priv
, M_NETGRAPH
);
540 (*nodep
)->private = priv
;
542 LIST_INIT(&priv
->embryos
);
549 * Give our OK for a hook to be added. The hook name is of the
550 * form "<family>/<type>/<proto>" where the three components may
551 * be decimal numbers or else aliases from the above lists.
553 * Connecting a hook amounts to opening the socket. Disconnecting
554 * the hook closes the socket and destroys the node as well.
557 ng_ksocket_newhook(node_p node
, hook_p hook
, const char *name0
)
559 struct thread
*td
= curthread
->td_proc
? curthread
: &thread0
; /* XXX broken */
560 const priv_p priv
= node
->private;
562 char *s1
, *s2
, name
[NG_HOOKSIZ
];
563 int family
, type
, protocol
, error
;
565 /* Check if we're already connected */
566 if (priv
->hook
!= NULL
)
569 if (priv
->flags
& KSF_CLONED
) {
570 if (priv
->flags
& KSF_EMBRYONIC
) {
571 /* Remove ourselves from our parent's embryo list */
572 LIST_REMOVE(priv
, siblings
);
573 priv
->flags
&= ~KSF_EMBRYONIC
;
576 /* Extract family, type, and protocol from hook name */
577 ksnprintf(name
, sizeof(name
), "%s", name0
);
579 if ((s2
= index(s1
, '/')) == NULL
)
582 family
= ng_ksocket_parse(ng_ksocket_families
, s1
, 0);
586 if ((s2
= index(s1
, '/')) == NULL
)
589 type
= ng_ksocket_parse(ng_ksocket_types
, s1
, 0);
593 protocol
= ng_ksocket_parse(ng_ksocket_protos
, s1
, family
);
597 /* Create the socket */
598 error
= socreate(family
, &priv
->so
, type
, protocol
, td
);
602 /* XXX call soreserve() ? */
604 /* Add our hook for incoming data and other events */
605 priv
->so
->so_upcallarg
= (caddr_t
)node
;
606 priv
->so
->so_upcall
= ng_ksocket_incoming
;
607 atomic_set_int(&priv
->so
->so_rcv
.ssb_flags
, SSB_UPCALL
);
608 atomic_set_int(&priv
->so
->so_snd
.ssb_flags
, SSB_UPCALL
);
615 * On a cloned socket we may have already received one or more
616 * upcalls which we couldn't handle without a hook. Handle
617 * those now. We cannot call the upcall function directly
618 * from here, because until this function has returned our
619 * hook isn't connected. So we queue a message to ourselves
620 * which will cause the upcall function to be called a bit
623 if (priv
->flags
& KSF_CLONED
) {
624 NG_MKMESSAGE(msg
, NGM_KSOCKET_INTERNAL_COOKIE
,
625 NGM_KSOCKET_INTERNAL_UPCALL
, 0, M_NOWAIT
);
627 ng_queue_msg(node
, msg
, ".:");
634 * Receive a control message
637 ng_ksocket_rcvmsg(node_p node
, struct ng_mesg
*msg
,
638 const char *raddr
, struct ng_mesg
**rptr
)
640 struct thread
*td
= curthread
->td_proc
? curthread
: &thread0
; /* XXX broken */
641 const priv_p priv
= node
->private;
642 struct socket
*const so
= priv
->so
;
643 struct ng_mesg
*resp
= NULL
;
646 switch (msg
->header
.typecookie
) {
647 case NGM_KSOCKET_COOKIE
:
648 switch (msg
->header
.cmd
) {
649 case NGM_KSOCKET_BIND
:
651 struct sockaddr
*const sa
652 = (struct sockaddr
*)msg
->data
;
655 if (msg
->header
.arglen
< SADATA_OFFSET
656 || msg
->header
.arglen
< sa
->sa_len
)
662 error
= sobind(so
, sa
, td
);
665 case NGM_KSOCKET_LISTEN
:
668 if (msg
->header
.arglen
!= sizeof(int32_t))
674 error
= solisten(so
, *((int32_t *)msg
->data
), td
);
678 case NGM_KSOCKET_ACCEPT
:
681 if (msg
->header
.arglen
!= 0)
686 /* Make sure the socket is capable of accepting */
687 if (!(so
->so_options
& SO_ACCEPTCONN
))
689 if (priv
->flags
& KSF_ACCEPTING
)
692 error
= ng_ksocket_check_accept(priv
);
693 if (error
!= 0 && error
!= EWOULDBLOCK
)
697 * If a connection is already complete, take it.
698 * Otherwise let the upcall function deal with
699 * the connection when it comes in.
701 priv
->response_token
= msg
->header
.token
;
702 strcpy(priv
->response_addr
, raddr
);
704 ng_ksocket_finish_accept(priv
,
705 rptr
!= NULL
? &resp
: NULL
);
707 priv
->flags
|= KSF_ACCEPTING
;
711 case NGM_KSOCKET_CONNECT
:
713 struct sockaddr
*const sa
714 = (struct sockaddr
*)msg
->data
;
717 if (msg
->header
.arglen
< SADATA_OFFSET
718 || msg
->header
.arglen
< sa
->sa_len
)
724 if ((so
->so_state
& SS_ISCONNECTING
) != 0)
726 if ((error
= soconnect(so
, sa
, td
, TRUE
)) != 0) {
727 soclrstate(so
, SS_ISCONNECTING
);
730 if ((so
->so_state
& SS_ISCONNECTING
) != 0) {
731 /* We will notify the sender when we connect */
732 priv
->response_token
= msg
->header
.token
;
733 strcpy(priv
->response_addr
, raddr
);
734 priv
->flags
|= KSF_CONNECTING
;
740 case NGM_KSOCKET_GETNAME
:
741 case NGM_KSOCKET_GETPEERNAME
:
743 struct sockaddr
*sa
= NULL
;
747 if (msg
->header
.arglen
!= 0)
753 if (msg
->header
.cmd
== NGM_KSOCKET_GETPEERNAME
) {
755 & (SS_ISCONNECTED
|SS_ISCONFIRMING
)) == 0)
757 error
= so_pru_peeraddr(so
, &sa
);
759 error
= so_pru_sockaddr(so
, &sa
);
761 /* Get local or peer address */
764 len
= (sa
== NULL
) ? 0 : sa
->sa_len
;
766 /* Send it back in a response */
767 NG_MKRESPONSE(resp
, msg
, len
, M_NOWAIT
);
772 bcopy(sa
, resp
->data
, len
);
781 case NGM_KSOCKET_GETOPT
:
783 struct ng_ksocket_sockopt
*ksopt
=
784 (struct ng_ksocket_sockopt
*)msg
->data
;
788 if (msg
->header
.arglen
!= sizeof(*ksopt
))
793 /* Get response with room for option value */
794 NG_MKRESPONSE(resp
, msg
, sizeof(*ksopt
)
795 + NG_KSOCKET_MAX_OPTLEN
, M_NOWAIT
);
799 /* Get socket option, and put value in the response */
800 sopt
.sopt_dir
= SOPT_GET
;
801 sopt
.sopt_level
= ksopt
->level
;
802 sopt
.sopt_name
= ksopt
->name
;
804 sopt
.sopt_valsize
= NG_KSOCKET_MAX_OPTLEN
;
805 ksopt
= (struct ng_ksocket_sockopt
*)resp
->data
;
806 sopt
.sopt_val
= ksopt
->value
;
807 if ((error
= sogetopt(so
, &sopt
)) != 0) {
808 kfree(resp
, M_NETGRAPH
);
813 /* Set actual value length */
814 resp
->header
.arglen
= sizeof(*ksopt
)
819 case NGM_KSOCKET_SETOPT
:
821 struct ng_ksocket_sockopt
*const ksopt
=
822 (struct ng_ksocket_sockopt
*)msg
->data
;
823 const int valsize
= msg
->header
.arglen
- sizeof(*ksopt
);
832 /* Set socket option */
833 sopt
.sopt_dir
= SOPT_SET
;
834 sopt
.sopt_level
= ksopt
->level
;
835 sopt
.sopt_name
= ksopt
->name
;
836 sopt
.sopt_val
= ksopt
->value
;
837 sopt
.sopt_valsize
= valsize
;
839 error
= sosetopt(so
, &sopt
);
848 case NGM_KSOCKET_INTERNAL_COOKIE
:
849 switch (msg
->header
.cmd
) {
850 case NGM_KSOCKET_INTERNAL_UPCALL
:
853 (*priv
->so
->so_upcall
)(so
, so
->so_upcallarg
, M_NOWAIT
);
867 kfree(resp
, M_NETGRAPH
);
870 kfree(msg
, M_NETGRAPH
);
875 * Receive incoming data on our hook. Send it out the socket.
878 ng_ksocket_rcvdata(hook_p hook
, struct mbuf
*m
, meta_p meta
)
880 struct thread
*td
= curthread
->td_proc
? curthread
: &thread0
; /* XXX broken */
881 const node_p node
= hook
->node
;
882 const priv_p priv
= node
->private;
883 struct socket
*const so
= priv
->so
;
884 struct sockaddr
*sa
= NULL
;
887 /* Avoid reentrantly sending on the socket */
888 if ((priv
->flags
& KSF_SENDING
) != 0) {
889 NG_FREE_DATA(m
, meta
);
893 /* If any meta info, look for peer socket address */
895 struct meta_field_header
*field
;
897 /* Look for peer socket address */
898 for (field
= &meta
->options
[0];
899 (caddr_t
)field
< (caddr_t
)meta
+ meta
->used_len
;
900 field
= (struct meta_field_header
*)
901 ((caddr_t
)field
+ field
->len
)) {
902 if (field
->cookie
!= NGM_KSOCKET_COOKIE
903 || field
->type
!= NG_KSOCKET_META_SOCKADDR
)
905 sa
= (struct sockaddr
*)field
->data
;
911 priv
->flags
|= KSF_SENDING
;
912 error
= so_pru_sosend(so
, sa
, NULL
, m
, NULL
, 0, td
);
913 priv
->flags
&= ~KSF_SENDING
;
915 /* Clean up and exit */
924 ng_ksocket_rmnode(node_p node
)
926 const priv_p priv
= node
->private;
929 /* Close our socket (if any) */
930 if (priv
->so
!= NULL
) {
931 priv
->so
->so_upcall
= NULL
;
932 atomic_clear_int(&priv
->so
->so_rcv
.ssb_flags
, SSB_UPCALL
);
933 atomic_clear_int(&priv
->so
->so_snd
.ssb_flags
, SSB_UPCALL
);
934 soclose(priv
->so
, FNONBLOCK
);
938 /* If we are an embryo, take ourselves out of the parent's list */
939 if (priv
->flags
& KSF_EMBRYONIC
) {
940 LIST_REMOVE(priv
, siblings
);
941 priv
->flags
&= ~KSF_EMBRYONIC
;
944 /* Remove any embryonic children we have */
945 while (!LIST_EMPTY(&priv
->embryos
)) {
946 embryo
= LIST_FIRST(&priv
->embryos
);
947 ng_rmnode(embryo
->node
);
950 /* Take down netgraph node */
951 node
->flags
|= NG_INVALID
;
954 bzero(priv
, sizeof(*priv
));
955 kfree(priv
, M_NETGRAPH
);
956 node
->private = NULL
;
957 ng_unref(node
); /* let the node escape */
965 ng_ksocket_disconnect(hook_p hook
)
967 KASSERT(hook
->node
->numhooks
== 0,
968 ("%s: numhooks=%d?", __func__
, hook
->node
->numhooks
));
969 ng_rmnode(hook
->node
);
973 /************************************************************************
975 ************************************************************************/
978 * When incoming data is appended to the socket, we get notified here.
979 * This is also called whenever a significant event occurs for the socket.
982 ng_ksocket_incoming(struct socket
*so
, void *arg
, int waitflag
)
984 const node_p node
= arg
;
985 const priv_p priv
= node
->private;
986 struct ng_mesg
*response
;
992 if ((node
->flags
& NG_INVALID
) != 0) {
996 KASSERT(so
== priv
->so
, ("%s: wrong socket", __func__
));
998 /* Check whether a pending connect operation has completed */
999 if (priv
->flags
& KSF_CONNECTING
) {
1000 if ((error
= so
->so_error
) != 0) {
1002 soclrstate(so
, SS_ISCONNECTING
);
1004 if (!(so
->so_state
& SS_ISCONNECTING
)) {
1005 NG_MKMESSAGE(response
, NGM_KSOCKET_COOKIE
,
1006 NGM_KSOCKET_CONNECT
, sizeof(int32_t), waitflag
);
1007 if (response
!= NULL
) {
1008 response
->header
.flags
|= NGF_RESP
;
1009 response
->header
.token
= priv
->response_token
;
1010 *(int32_t *)response
->data
= error
;
1012 * XXX We use ng_queue_msg here because we are
1013 * being called from deep in the bowels of the TCP
1014 * stack. Is this right, or should we let the
1015 * receiver of the message worry about that?
1017 ng_queue_msg(node
, response
,
1018 priv
->response_addr
);
1020 priv
->flags
&= ~KSF_CONNECTING
;
1024 /* Check whether a pending accept operation has completed */
1025 if (priv
->flags
& KSF_ACCEPTING
) {
1026 error
= ng_ksocket_check_accept(priv
);
1027 if (error
!= EWOULDBLOCK
)
1028 priv
->flags
&= ~KSF_ACCEPTING
;
1030 ng_ksocket_finish_accept(priv
, NULL
);
1034 * If we don't have a hook, we must handle data events later. When
1035 * the hook gets created and is connected, this upcall function
1036 * will be called again.
1038 if (priv
->hook
== NULL
) {
1043 /* Read and forward available mbuf's */
1045 struct sockaddr
*sa
= NULL
;
1051 sbinit(&sio
, 1000000000);
1052 flags
= MSG_DONTWAIT
;
1054 /* Try to get next packet from socket */
1055 error
= so_pru_soreceive(so
,
1056 ((so
->so_state
& SS_ISCONNECTED
) ? NULL
: &sa
),
1057 NULL
, &sio
, NULL
, &flags
);
1061 /* See if we got anything */
1062 if (sio
.sb_mb
== NULL
) {
1064 kfree(sa
, M_SONAME
);
1068 /* Don't trust the various socket layers to get the
1069 packet header and length correct (eg. kern/15175) */
1070 sio
.sb_mb
->m_pkthdr
.len
= 0;
1071 for (n
= sio
.sb_mb
; n
!= NULL
; n
= n
->m_next
)
1072 sio
.sb_mb
->m_pkthdr
.len
+= n
->m_len
;
1074 /* Put peer's socket address (if any) into a meta info blob */
1076 struct meta_field_header
*mhead
;
1079 len
= sizeof(*meta
) + sizeof(*mhead
) + sa
->sa_len
;
1080 meta
= kmalloc(len
, M_NETGRAPH
, M_NOWAIT
);
1082 kfree(sa
, M_SONAME
);
1085 mhead
= &meta
->options
[0];
1086 bzero(meta
, sizeof(*meta
));
1087 bzero(mhead
, sizeof(*mhead
));
1088 meta
->allocated_len
= len
;
1089 meta
->used_len
= len
;
1090 mhead
->cookie
= NGM_KSOCKET_COOKIE
;
1091 mhead
->type
= NG_KSOCKET_META_SOCKADDR
;
1092 mhead
->len
= sizeof(*mhead
) + sa
->sa_len
;
1093 bcopy(sa
, mhead
->data
, sa
->sa_len
);
1094 kfree(sa
, M_SONAME
);
1096 sendit
: /* Forward data with optional peer sockaddr as meta info */
1097 NG_SEND_DATA(error
, priv
->hook
, sio
.sb_mb
, meta
);
1101 * If the peer has closed the connection, forward a 0-length mbuf
1102 * to indicate end-of-file.
1104 if (so
->so_state
& SS_CANTRCVMORE
&& !(priv
->flags
& KSF_EOFSEEN
)) {
1107 MGETHDR(m
, waitflag
, MT_DATA
);
1109 m
->m_len
= m
->m_pkthdr
.len
= 0;
1110 NG_SEND_DATA_ONLY(error
, priv
->hook
, m
);
1112 priv
->flags
|= KSF_EOFSEEN
;
1119 * Check for a completed incoming connection and return 0 if one is found.
1120 * Otherwise return the appropriate error code.
1123 ng_ksocket_check_accept(priv_p priv
)
1125 struct socket
*const head
= priv
->so
;
1128 lwkt_gettoken(&head
->so_rcv
.ssb_token
);
1129 if ((error
= head
->so_error
) != 0) {
1131 lwkt_reltoken(&head
->so_rcv
.ssb_token
);
1134 if (TAILQ_EMPTY(&head
->so_comp
)) {
1135 if (head
->so_state
& SS_CANTRCVMORE
)
1136 error
= ECONNABORTED
;
1138 error
= EWOULDBLOCK
;
1140 lwkt_reltoken(&head
->so_rcv
.ssb_token
);
1145 * Handle the first completed incoming connection, assumed to be already
1146 * on the socket's so_comp queue.
1149 ng_ksocket_finish_accept(priv_p priv
, struct ng_mesg
**rptr
)
1151 struct socket
*const head
= priv
->so
;
1153 struct sockaddr
*sa
= NULL
;
1154 struct ng_mesg
*resp
;
1155 struct ng_ksocket_accept
*resp_data
;
1160 lwkt_getpooltoken(head
);
1161 so
= TAILQ_FIRST(&head
->so_comp
);
1162 if (so
== NULL
) { /* Should never happen */
1163 lwkt_relpooltoken(head
);
1166 TAILQ_REMOVE(&head
->so_comp
, so
, so_list
);
1168 soclrstate(so
, SS_COMP
);
1172 lwkt_relpooltoken(head
);
1174 /* XXX KNOTE(&head->so_rcv.ssb_sel.si_note, 0); */
1178 len
= OFFSETOF(struct ng_ksocket_accept
, addr
);
1182 NG_MKMESSAGE(resp
, NGM_KSOCKET_COOKIE
, NGM_KSOCKET_ACCEPT
, len
,
1185 soclose(so
, FNONBLOCK
);
1188 resp
->header
.flags
|= NGF_RESP
;
1189 resp
->header
.token
= priv
->response_token
;
1191 /* Clone a ksocket node to wrap the new socket */
1192 if (ng_ksocket_constructor(&node2
) != 0) {
1193 kfree(resp
, M_NETGRAPH
);
1194 soclose(so
, FNONBLOCK
);
1197 priv2
= (priv_p
)node2
->private;
1199 priv2
->flags
|= KSF_CLONED
| KSF_EMBRYONIC
;
1202 * Insert the cloned node into a list of embryonic children
1203 * on the parent node. When a hook is created on the cloned
1204 * node it will be removed from this list. When the parent
1205 * is destroyed it will destroy any embryonic children it has.
1207 LIST_INSERT_HEAD(&priv
->embryos
, priv2
, siblings
);
1209 so
->so_upcallarg
= (caddr_t
)node2
;
1210 so
->so_upcall
= ng_ksocket_incoming
;
1211 atomic_set_int(&so
->so_rcv
.ssb_flags
, SSB_UPCALL
);
1212 atomic_set_int(&so
->so_snd
.ssb_flags
, SSB_UPCALL
);
1214 /* Fill in the response data and send it or return it to the caller */
1215 resp_data
= (struct ng_ksocket_accept
*)resp
->data
;
1216 resp_data
->nodeid
= node2
->ID
;
1218 bcopy(sa
, &resp_data
->addr
, sa
->sa_len
);
1222 ng_queue_msg(priv
->node
, resp
, priv
->response_addr
);
1226 kfree(sa
, M_SONAME
);
1230 * Parse out either an integer value or an alias.
1233 ng_ksocket_parse(const struct ng_ksocket_alias
*aliases
,
1234 const char *s
, int family
)
1240 for (k
= 0; aliases
[k
].name
!= NULL
; k
++) {
1241 if (strcmp(s
, aliases
[k
].name
) == 0
1242 && aliases
[k
].family
== family
)
1243 return aliases
[k
].value
;
1246 /* Try parsing as a number */
1247 val
= (int)strtoul(s
, &eptr
, 10);
1248 if (val
< 0 || *eptr
!= '\0')