ng_ksocket.c revision 193272
1/* 2 * ng_ksocket.c 3 */ 4 5/*- 6 * Copyright (c) 1996-1999 Whistle Communications, Inc. 7 * All rights reserved. 8 * 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. 19 * 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 36 * OF SUCH DAMAGE. 37 * 38 * Author: Archie Cobbs <archie@freebsd.org> 39 * 40 * $FreeBSD: head/sys/netgraph/ng_ksocket.c 193272 2009-06-01 21:17:03Z jhb $ 41 * $Whistle: ng_ksocket.c,v 1.1 1999/11/16 20:04:40 archie Exp $ 42 */ 43 44/* 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. 47 */ 48 49#include <sys/param.h> 50#include <sys/systm.h> 51#include <sys/kernel.h> 52#include <sys/mbuf.h> 53#include <sys/proc.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> 60#include <sys/uio.h> 61#include <sys/un.h> 62 63#include <netgraph/ng_message.h> 64#include <netgraph/netgraph.h> 65#include <netgraph/ng_parse.h> 66#include <netgraph/ng_ksocket.h> 67 68#include <netinet/in.h> 69#include <netatalk/at.h> 70 71#ifdef NG_SEPARATE_MALLOC 72MALLOC_DEFINE(M_NETGRAPH_KSOCKET, "netgraph_ksock", "netgraph ksock node "); 73#else 74#define M_NETGRAPH_KSOCKET M_NETGRAPH 75#endif 76 77#define OFFSETOF(s, e) ((char *)&((s *)0)->e - (char *)((s *)0)) 78#define SADATA_OFFSET (OFFSETOF(struct sockaddr, sa_data)) 79 80/* Node private data */ 81struct ng_ksocket_private { 82 node_p node; 83 hook_p hook; 84 struct socket *so; 85 int fn_sent; /* FN call on incoming event was sent */ 86 LIST_HEAD(, ng_ksocket_private) embryos; 87 LIST_ENTRY(ng_ksocket_private) siblings; 88 u_int32_t flags; 89 u_int32_t response_token; 90 ng_ID_t response_addr; 91}; 92typedef struct ng_ksocket_private *priv_p; 93 94/* Flags for priv_p */ 95#define KSF_CONNECTING 0x00000001 /* Waiting for connection complete */ 96#define KSF_ACCEPTING 0x00000002 /* Waiting for accept complete */ 97#define KSF_EOFSEEN 0x00000004 /* Have sent 0-length EOF mbuf */ 98#define KSF_CLONED 0x00000008 /* Cloned from an accepting socket */ 99#define KSF_EMBRYONIC 0x00000010 /* Cloned node with no hooks yet */ 100 101/* Netgraph node methods */ 102static ng_constructor_t ng_ksocket_constructor; 103static ng_rcvmsg_t ng_ksocket_rcvmsg; 104static ng_shutdown_t ng_ksocket_shutdown; 105static ng_newhook_t ng_ksocket_newhook; 106static ng_rcvdata_t ng_ksocket_rcvdata; 107static ng_connect_t ng_ksocket_connect; 108static ng_disconnect_t ng_ksocket_disconnect; 109 110/* Alias structure */ 111struct ng_ksocket_alias { 112 const char *name; 113 const int value; 114 const int family; 115}; 116 117/* Protocol family aliases */ 118static const struct ng_ksocket_alias ng_ksocket_families[] = { 119 { "local", PF_LOCAL }, 120 { "inet", PF_INET }, 121 { "inet6", PF_INET6 }, 122 { "atalk", PF_APPLETALK }, 123 { "ipx", PF_IPX }, 124 { "atm", PF_ATM }, 125 { NULL, -1 }, 126}; 127 128/* Socket type aliases */ 129static const struct ng_ksocket_alias ng_ksocket_types[] = { 130 { "stream", SOCK_STREAM }, 131 { "dgram", SOCK_DGRAM }, 132 { "raw", SOCK_RAW }, 133 { "rdm", SOCK_RDM }, 134 { "seqpacket", SOCK_SEQPACKET }, 135 { NULL, -1 }, 136}; 137 138/* Protocol aliases */ 139static const struct ng_ksocket_alias ng_ksocket_protos[] = { 140 { "ip", IPPROTO_IP, PF_INET }, 141 { "raw", IPPROTO_RAW, PF_INET }, 142 { "icmp", IPPROTO_ICMP, PF_INET }, 143 { "igmp", IPPROTO_IGMP, PF_INET }, 144 { "tcp", IPPROTO_TCP, PF_INET }, 145 { "udp", IPPROTO_UDP, PF_INET }, 146 { "gre", IPPROTO_GRE, PF_INET }, 147 { "esp", IPPROTO_ESP, PF_INET }, 148 { "ah", IPPROTO_AH, PF_INET }, 149 { "swipe", IPPROTO_SWIPE, PF_INET }, 150 { "encap", IPPROTO_ENCAP, PF_INET }, 151 { "divert", IPPROTO_DIVERT, PF_INET }, 152 { "pim", IPPROTO_PIM, PF_INET }, 153 { "ddp", ATPROTO_DDP, PF_APPLETALK }, 154 { "aarp", ATPROTO_AARP, PF_APPLETALK }, 155 { NULL, -1 }, 156}; 157 158/* Helper functions */ 159static int ng_ksocket_check_accept(priv_p); 160static void ng_ksocket_finish_accept(priv_p); 161static int ng_ksocket_incoming(struct socket *so, void *arg, int waitflag); 162static int ng_ksocket_parse(const struct ng_ksocket_alias *aliases, 163 const char *s, int family); 164static void ng_ksocket_incoming2(node_p node, hook_p hook, 165 void *arg1, int arg2); 166 167/************************************************************************ 168 STRUCT SOCKADDR PARSE TYPE 169 ************************************************************************/ 170 171/* Get the length of the data portion of a generic struct sockaddr */ 172static int 173ng_parse_generic_sockdata_getLength(const struct ng_parse_type *type, 174 const u_char *start, const u_char *buf) 175{ 176 const struct sockaddr *sa; 177 178 sa = (const struct sockaddr *)(buf - SADATA_OFFSET); 179 return (sa->sa_len < SADATA_OFFSET) ? 0 : sa->sa_len - SADATA_OFFSET; 180} 181 182/* Type for the variable length data portion of a generic struct sockaddr */ 183static const struct ng_parse_type ng_ksocket_generic_sockdata_type = { 184 &ng_parse_bytearray_type, 185 &ng_parse_generic_sockdata_getLength 186}; 187 188/* Type for a generic struct sockaddr */ 189static const struct ng_parse_struct_field 190 ng_parse_generic_sockaddr_type_fields[] = { 191 { "len", &ng_parse_uint8_type }, 192 { "family", &ng_parse_uint8_type }, 193 { "data", &ng_ksocket_generic_sockdata_type }, 194 { NULL } 195}; 196static const struct ng_parse_type ng_ksocket_generic_sockaddr_type = { 197 &ng_parse_struct_type, 198 &ng_parse_generic_sockaddr_type_fields 199}; 200 201/* Convert a struct sockaddr from ASCII to binary. If its a protocol 202 family that we specially handle, do that, otherwise defer to the 203 generic parse type ng_ksocket_generic_sockaddr_type. */ 204static int 205ng_ksocket_sockaddr_parse(const struct ng_parse_type *type, 206 const char *s, int *off, const u_char *const start, 207 u_char *const buf, int *buflen) 208{ 209 struct sockaddr *const sa = (struct sockaddr *)buf; 210 enum ng_parse_token tok; 211 char fambuf[32]; 212 int family, len; 213 char *t; 214 215 /* If next token is a left curly brace, use generic parse type */ 216 if ((tok = ng_parse_get_token(s, off, &len)) == T_LBRACE) { 217 return (*ng_ksocket_generic_sockaddr_type.supertype->parse) 218 (&ng_ksocket_generic_sockaddr_type, 219 s, off, start, buf, buflen); 220 } 221 222 /* Get socket address family followed by a slash */ 223 while (isspace(s[*off])) 224 (*off)++; 225 if ((t = index(s + *off, '/')) == NULL) 226 return (EINVAL); 227 if ((len = t - (s + *off)) > sizeof(fambuf) - 1) 228 return (EINVAL); 229 strncpy(fambuf, s + *off, len); 230 fambuf[len] = '\0'; 231 *off += len + 1; 232 if ((family = ng_ksocket_parse(ng_ksocket_families, fambuf, 0)) == -1) 233 return (EINVAL); 234 235 /* Set family */ 236 if (*buflen < SADATA_OFFSET) 237 return (ERANGE); 238 sa->sa_family = family; 239 240 /* Set family-specific data and length */ 241 switch (sa->sa_family) { 242 case PF_LOCAL: /* Get pathname */ 243 { 244 const int pathoff = OFFSETOF(struct sockaddr_un, sun_path); 245 struct sockaddr_un *const sun = (struct sockaddr_un *)sa; 246 int toklen, pathlen; 247 char *path; 248 249 if ((path = ng_get_string_token(s, off, &toklen, NULL)) == NULL) 250 return (EINVAL); 251 pathlen = strlen(path); 252 if (pathlen > SOCK_MAXADDRLEN) { 253 free(path, M_NETGRAPH_KSOCKET); 254 return (E2BIG); 255 } 256 if (*buflen < pathoff + pathlen) { 257 free(path, M_NETGRAPH_KSOCKET); 258 return (ERANGE); 259 } 260 *off += toklen; 261 bcopy(path, sun->sun_path, pathlen); 262 sun->sun_len = pathoff + pathlen; 263 free(path, M_NETGRAPH_KSOCKET); 264 break; 265 } 266 267 case PF_INET: /* Get an IP address with optional port */ 268 { 269 struct sockaddr_in *const sin = (struct sockaddr_in *)sa; 270 int i; 271 272 /* Parse this: <ipaddress>[:port] */ 273 for (i = 0; i < 4; i++) { 274 u_long val; 275 char *eptr; 276 277 val = strtoul(s + *off, &eptr, 10); 278 if (val > 0xff || eptr == s + *off) 279 return (EINVAL); 280 *off += (eptr - (s + *off)); 281 ((u_char *)&sin->sin_addr)[i] = (u_char)val; 282 if (i < 3) { 283 if (s[*off] != '.') 284 return (EINVAL); 285 (*off)++; 286 } else if (s[*off] == ':') { 287 (*off)++; 288 val = strtoul(s + *off, &eptr, 10); 289 if (val > 0xffff || eptr == s + *off) 290 return (EINVAL); 291 *off += (eptr - (s + *off)); 292 sin->sin_port = htons(val); 293 } else 294 sin->sin_port = 0; 295 } 296 bzero(&sin->sin_zero, sizeof(sin->sin_zero)); 297 sin->sin_len = sizeof(*sin); 298 break; 299 } 300 301#if 0 302 case PF_APPLETALK: /* XXX implement these someday */ 303 case PF_INET6: 304 case PF_IPX: 305#endif 306 307 default: 308 return (EINVAL); 309 } 310 311 /* Done */ 312 *buflen = sa->sa_len; 313 return (0); 314} 315 316/* Convert a struct sockaddr from binary to ASCII */ 317static int 318ng_ksocket_sockaddr_unparse(const struct ng_parse_type *type, 319 const u_char *data, int *off, char *cbuf, int cbuflen) 320{ 321 const struct sockaddr *sa = (const struct sockaddr *)(data + *off); 322 int slen = 0; 323 324 /* Output socket address, either in special or generic format */ 325 switch (sa->sa_family) { 326 case PF_LOCAL: 327 { 328 const int pathoff = OFFSETOF(struct sockaddr_un, sun_path); 329 const struct sockaddr_un *sun = (const struct sockaddr_un *)sa; 330 const int pathlen = sun->sun_len - pathoff; 331 char pathbuf[SOCK_MAXADDRLEN + 1]; 332 char *pathtoken; 333 334 bcopy(sun->sun_path, pathbuf, pathlen); 335 if ((pathtoken = ng_encode_string(pathbuf, pathlen)) == NULL) 336 return (ENOMEM); 337 slen += snprintf(cbuf, cbuflen, "local/%s", pathtoken); 338 free(pathtoken, M_NETGRAPH_KSOCKET); 339 if (slen >= cbuflen) 340 return (ERANGE); 341 *off += sun->sun_len; 342 return (0); 343 } 344 345 case PF_INET: 346 { 347 const struct sockaddr_in *sin = (const struct sockaddr_in *)sa; 348 349 slen += snprintf(cbuf, cbuflen, "inet/%d.%d.%d.%d", 350 ((const u_char *)&sin->sin_addr)[0], 351 ((const u_char *)&sin->sin_addr)[1], 352 ((const u_char *)&sin->sin_addr)[2], 353 ((const u_char *)&sin->sin_addr)[3]); 354 if (sin->sin_port != 0) { 355 slen += snprintf(cbuf + strlen(cbuf), 356 cbuflen - strlen(cbuf), ":%d", 357 (u_int)ntohs(sin->sin_port)); 358 } 359 if (slen >= cbuflen) 360 return (ERANGE); 361 *off += sizeof(*sin); 362 return(0); 363 } 364 365#if 0 366 case PF_APPLETALK: /* XXX implement these someday */ 367 case PF_INET6: 368 case PF_IPX: 369#endif 370 371 default: 372 return (*ng_ksocket_generic_sockaddr_type.supertype->unparse) 373 (&ng_ksocket_generic_sockaddr_type, 374 data, off, cbuf, cbuflen); 375 } 376} 377 378/* Parse type for struct sockaddr */ 379static const struct ng_parse_type ng_ksocket_sockaddr_type = { 380 NULL, 381 NULL, 382 NULL, 383 &ng_ksocket_sockaddr_parse, 384 &ng_ksocket_sockaddr_unparse, 385 NULL /* no such thing as a default struct sockaddr */ 386}; 387 388/************************************************************************ 389 STRUCT NG_KSOCKET_SOCKOPT PARSE TYPE 390 ************************************************************************/ 391 392/* Get length of the struct ng_ksocket_sockopt value field, which is the 393 just the excess of the message argument portion over the length of 394 the struct ng_ksocket_sockopt. */ 395static int 396ng_parse_sockoptval_getLength(const struct ng_parse_type *type, 397 const u_char *start, const u_char *buf) 398{ 399 static const int offset = OFFSETOF(struct ng_ksocket_sockopt, value); 400 const struct ng_ksocket_sockopt *sopt; 401 const struct ng_mesg *msg; 402 403 sopt = (const struct ng_ksocket_sockopt *)(buf - offset); 404 msg = (const struct ng_mesg *)((const u_char *)sopt - sizeof(*msg)); 405 return msg->header.arglen - sizeof(*sopt); 406} 407 408/* Parse type for the option value part of a struct ng_ksocket_sockopt 409 XXX Eventually, we should handle the different socket options specially. 410 XXX This would avoid byte order problems, eg an integer value of 1 is 411 XXX going to be "[1]" for little endian or "[3=1]" for big endian. */ 412static const struct ng_parse_type ng_ksocket_sockoptval_type = { 413 &ng_parse_bytearray_type, 414 &ng_parse_sockoptval_getLength 415}; 416 417/* Parse type for struct ng_ksocket_sockopt */ 418static const struct ng_parse_struct_field ng_ksocket_sockopt_type_fields[] 419 = NG_KSOCKET_SOCKOPT_INFO(&ng_ksocket_sockoptval_type); 420static const struct ng_parse_type ng_ksocket_sockopt_type = { 421 &ng_parse_struct_type, 422 &ng_ksocket_sockopt_type_fields 423}; 424 425/* Parse type for struct ng_ksocket_accept */ 426static const struct ng_parse_struct_field ng_ksocket_accept_type_fields[] 427 = NGM_KSOCKET_ACCEPT_INFO; 428static const struct ng_parse_type ng_ksocket_accept_type = { 429 &ng_parse_struct_type, 430 &ng_ksocket_accept_type_fields 431}; 432 433/* List of commands and how to convert arguments to/from ASCII */ 434static const struct ng_cmdlist ng_ksocket_cmds[] = { 435 { 436 NGM_KSOCKET_COOKIE, 437 NGM_KSOCKET_BIND, 438 "bind", 439 &ng_ksocket_sockaddr_type, 440 NULL 441 }, 442 { 443 NGM_KSOCKET_COOKIE, 444 NGM_KSOCKET_LISTEN, 445 "listen", 446 &ng_parse_int32_type, 447 NULL 448 }, 449 { 450 NGM_KSOCKET_COOKIE, 451 NGM_KSOCKET_ACCEPT, 452 "accept", 453 NULL, 454 &ng_ksocket_accept_type 455 }, 456 { 457 NGM_KSOCKET_COOKIE, 458 NGM_KSOCKET_CONNECT, 459 "connect", 460 &ng_ksocket_sockaddr_type, 461 &ng_parse_int32_type 462 }, 463 { 464 NGM_KSOCKET_COOKIE, 465 NGM_KSOCKET_GETNAME, 466 "getname", 467 NULL, 468 &ng_ksocket_sockaddr_type 469 }, 470 { 471 NGM_KSOCKET_COOKIE, 472 NGM_KSOCKET_GETPEERNAME, 473 "getpeername", 474 NULL, 475 &ng_ksocket_sockaddr_type 476 }, 477 { 478 NGM_KSOCKET_COOKIE, 479 NGM_KSOCKET_SETOPT, 480 "setopt", 481 &ng_ksocket_sockopt_type, 482 NULL 483 }, 484 { 485 NGM_KSOCKET_COOKIE, 486 NGM_KSOCKET_GETOPT, 487 "getopt", 488 &ng_ksocket_sockopt_type, 489 &ng_ksocket_sockopt_type 490 }, 491 { 0 } 492}; 493 494/* Node type descriptor */ 495static struct ng_type ng_ksocket_typestruct = { 496 .version = NG_ABI_VERSION, 497 .name = NG_KSOCKET_NODE_TYPE, 498 .constructor = ng_ksocket_constructor, 499 .rcvmsg = ng_ksocket_rcvmsg, 500 .shutdown = ng_ksocket_shutdown, 501 .newhook = ng_ksocket_newhook, 502 .connect = ng_ksocket_connect, 503 .rcvdata = ng_ksocket_rcvdata, 504 .disconnect = ng_ksocket_disconnect, 505 .cmdlist = ng_ksocket_cmds, 506}; 507NETGRAPH_INIT(ksocket, &ng_ksocket_typestruct); 508 509#define ERROUT(x) do { error = (x); goto done; } while (0) 510 511/************************************************************************ 512 NETGRAPH NODE STUFF 513 ************************************************************************/ 514 515/* 516 * Node type constructor 517 * The NODE part is assumed to be all set up. 518 * There is already a reference to the node for us. 519 */ 520static int 521ng_ksocket_constructor(node_p node) 522{ 523 priv_p priv; 524 525 /* Allocate private structure */ 526 priv = malloc(sizeof(*priv), 527 M_NETGRAPH_KSOCKET, M_NOWAIT | M_ZERO); 528 if (priv == NULL) 529 return (ENOMEM); 530 531 LIST_INIT(&priv->embryos); 532 /* cross link them */ 533 priv->node = node; 534 NG_NODE_SET_PRIVATE(node, priv); 535 536 /* Done */ 537 return (0); 538} 539 540/* 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. 544 * 545 * Connecting a hook amounts to opening the socket. Disconnecting 546 * the hook closes the socket and destroys the node as well. 547 */ 548static int 549ng_ksocket_newhook(node_p node, hook_p hook, const char *name0) 550{ 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; 555 556 /* Check if we're already connected */ 557 if (priv->hook != NULL) 558 return (EISCONN); 559 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; 565 } 566 } else { 567 /* Extract family, type, and protocol from hook name */ 568 snprintf(name, sizeof(name), "%s", name0); 569 s1 = name; 570 if ((s2 = index(s1, '/')) == NULL) 571 return (EINVAL); 572 *s2++ = '\0'; 573 family = ng_ksocket_parse(ng_ksocket_families, s1, 0); 574 if (family == -1) 575 return (EINVAL); 576 s1 = s2; 577 if ((s2 = index(s1, '/')) == NULL) 578 return (EINVAL); 579 *s2++ = '\0'; 580 type = ng_ksocket_parse(ng_ksocket_types, s1, 0); 581 if (type == -1) 582 return (EINVAL); 583 s1 = s2; 584 protocol = ng_ksocket_parse(ng_ksocket_protos, s1, family); 585 if (protocol == -1) 586 return (EINVAL); 587 588 /* Create the socket */ 589 error = socreate(family, &priv->so, type, protocol, 590 td->td_ucred, td); 591 if (error != 0) 592 return (error); 593 594 /* XXX call soreserve() ? */ 595 596 } 597 598 /* OK */ 599 priv->hook = hook; 600 601 /* 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. 605 */ 606 NG_HOOK_FORCE_QUEUE(hook); 607 608 return(0); 609} 610 611static int 612ng_ksocket_connect(hook_p hook) 613{ 614 node_p node = NG_HOOK_NODE(hook); 615 const priv_p priv = NG_NODE_PRIVATE(node); 616 struct socket *const so = priv->so; 617 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); 625 SOCK_LOCK(priv->so); 626 priv->so->so_state |= SS_NBIO; 627 SOCK_UNLOCK(priv->so); 628 /* 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 632 * those now. 633 * We cannot call the upcall function directly 634 * from here, because until this function has returned our 635 * hook isn't connected. 636 * 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. 645 * (socket not open). 646 * 647 * This is a bad byproduct of the complicated way in which hooks 648 * are now created (3 daisy chained async events). 649 * 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 654 * later. 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. 658 */ 659 if (priv->flags & KSF_CLONED) { 660 ng_send_fn(node, NULL, &ng_ksocket_incoming2, so, M_NOWAIT); 661 } 662 663 return (0); 664} 665 666/* 667 * Receive a control message 668 */ 669static int 670ng_ksocket_rcvmsg(node_p node, item_p item, hook_p lasthook) 671{ 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; 676 int error = 0; 677 struct ng_mesg *msg; 678 ng_ID_t raddr; 679 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: 685 { 686 struct sockaddr *const sa 687 = (struct sockaddr *)msg->data; 688 689 /* Sanity check */ 690 if (msg->header.arglen < SADATA_OFFSET 691 || msg->header.arglen < sa->sa_len) 692 ERROUT(EINVAL); 693 if (so == NULL) 694 ERROUT(ENXIO); 695 696 /* Bind */ 697 error = sobind(so, sa, td); 698 break; 699 } 700 case NGM_KSOCKET_LISTEN: 701 { 702 /* Sanity check */ 703 if (msg->header.arglen != sizeof(int32_t)) 704 ERROUT(EINVAL); 705 if (so == NULL) 706 ERROUT(ENXIO); 707 708 /* Listen */ 709 error = solisten(so, *((int32_t *)msg->data), td); 710 break; 711 } 712 713 case NGM_KSOCKET_ACCEPT: 714 { 715 /* Sanity check */ 716 if (msg->header.arglen != 0) 717 ERROUT(EINVAL); 718 if (so == NULL) 719 ERROUT(ENXIO); 720 721 /* Make sure the socket is capable of accepting */ 722 if (!(so->so_options & SO_ACCEPTCONN)) 723 ERROUT(EINVAL); 724 if (priv->flags & KSF_ACCEPTING) 725 ERROUT(EALREADY); 726 727 error = ng_ksocket_check_accept(priv); 728 if (error != 0 && error != EWOULDBLOCK) 729 ERROUT(error); 730 731 /* 732 * If a connection is already complete, take it. 733 * Otherwise let the upcall function deal with 734 * the connection when it comes in. 735 */ 736 priv->response_token = msg->header.token; 737 raddr = priv->response_addr = NGI_RETADDR(item); 738 if (error == 0) { 739 ng_ksocket_finish_accept(priv); 740 } else 741 priv->flags |= KSF_ACCEPTING; 742 break; 743 } 744 745 case NGM_KSOCKET_CONNECT: 746 { 747 struct sockaddr *const sa 748 = (struct sockaddr *)msg->data; 749 750 /* Sanity check */ 751 if (msg->header.arglen < SADATA_OFFSET 752 || msg->header.arglen < sa->sa_len) 753 ERROUT(EINVAL); 754 if (so == NULL) 755 ERROUT(ENXIO); 756 757 /* Do connect */ 758 if ((so->so_state & SS_ISCONNECTING) != 0) 759 ERROUT(EALREADY); 760 if ((error = soconnect(so, sa, td)) != 0) { 761 so->so_state &= ~SS_ISCONNECTING; 762 ERROUT(error); 763 } 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; 769 ERROUT(EINPROGRESS); 770 } 771 break; 772 } 773 774 case NGM_KSOCKET_GETNAME: 775 case NGM_KSOCKET_GETPEERNAME: 776 { 777 int (*func)(struct socket *so, struct sockaddr **nam); 778 struct sockaddr *sa = NULL; 779 int len; 780 781 /* Sanity check */ 782 if (msg->header.arglen != 0) 783 ERROUT(EINVAL); 784 if (so == NULL) 785 ERROUT(ENXIO); 786 787 /* Get function */ 788 if (msg->header.cmd == NGM_KSOCKET_GETPEERNAME) { 789 if ((so->so_state 790 & (SS_ISCONNECTED|SS_ISCONFIRMING)) == 0) 791 ERROUT(ENOTCONN); 792 func = so->so_proto->pr_usrreqs->pru_peeraddr; 793 } else 794 func = so->so_proto->pr_usrreqs->pru_sockaddr; 795 796 /* Get local or peer address */ 797 if ((error = (*func)(so, &sa)) != 0) 798 goto bail; 799 len = (sa == NULL) ? 0 : sa->sa_len; 800 801 /* Send it back in a response */ 802 NG_MKRESPONSE(resp, msg, len, M_NOWAIT); 803 if (resp == NULL) { 804 error = ENOMEM; 805 goto bail; 806 } 807 bcopy(sa, resp->data, len); 808 809 bail: 810 /* Cleanup */ 811 if (sa != NULL) 812 free(sa, M_SONAME); 813 break; 814 } 815 816 case NGM_KSOCKET_GETOPT: 817 { 818 struct ng_ksocket_sockopt *ksopt = 819 (struct ng_ksocket_sockopt *)msg->data; 820 struct sockopt sopt; 821 822 /* Sanity check */ 823 if (msg->header.arglen != sizeof(*ksopt)) 824 ERROUT(EINVAL); 825 if (so == NULL) 826 ERROUT(ENXIO); 827 828 /* Get response with room for option value */ 829 NG_MKRESPONSE(resp, msg, sizeof(*ksopt) 830 + NG_KSOCKET_MAX_OPTLEN, M_NOWAIT); 831 if (resp == NULL) 832 ERROUT(ENOMEM); 833 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; 838 sopt.sopt_td = NULL; 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) { 843 NG_FREE_MSG(resp); 844 break; 845 } 846 847 /* Set actual value length */ 848 resp->header.arglen = sizeof(*ksopt) 849 + sopt.sopt_valsize; 850 break; 851 } 852 853 case NGM_KSOCKET_SETOPT: 854 { 855 struct ng_ksocket_sockopt *const ksopt = 856 (struct ng_ksocket_sockopt *)msg->data; 857 const int valsize = msg->header.arglen - sizeof(*ksopt); 858 struct sockopt sopt; 859 860 /* Sanity check */ 861 if (valsize < 0) 862 ERROUT(EINVAL); 863 if (so == NULL) 864 ERROUT(ENXIO); 865 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; 872 sopt.sopt_td = NULL; 873 error = sosetopt(so, &sopt); 874 break; 875 } 876 877 default: 878 error = EINVAL; 879 break; 880 } 881 break; 882 default: 883 error = EINVAL; 884 break; 885 } 886done: 887 NG_RESPOND_MSG(error, node, item, resp); 888 NG_FREE_MSG(msg); 889 return (error); 890} 891 892/* 893 * Receive incoming data on our hook. Send it out the socket. 894 */ 895static int 896ng_ksocket_rcvdata(hook_p hook, item_p item) 897{ 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; 903 int error; 904 struct mbuf *m; 905 struct sa_tag *stag; 906 907 /* Extract data */ 908 NGI_GET_M(item, m); 909 NG_FREE_ITEM(item); 910 911 /* 912 * Look if socket address is stored in packet tags. 913 * If sockaddr is ours, or provided by a third party (zero id), 914 * then we accept it. 915 */ 916 if (((stag = (struct sa_tag *)m_tag_locate(m, NGM_KSOCKET_COOKIE, 917 NG_KSOCKET_TAG_SOCKADDR, NULL)) != NULL) && 918 (stag->id == NG_NODE_ID(node) || stag->id == 0)) 919 sa = &stag->sa; 920 921 /* Reset specific mbuf flags to prevent addressing problems. */ 922 m->m_flags &= ~(M_BCAST|M_MCAST); 923 924 /* Send packet */ 925 error = sosend(so, sa, 0, m, 0, 0, td); 926 927 return (error); 928} 929 930/* 931 * Destroy node 932 */ 933static int 934ng_ksocket_shutdown(node_p node) 935{ 936 const priv_p priv = NG_NODE_PRIVATE(node); 937 priv_p embryo; 938 939 /* Close our socket (if any) */ 940 if (priv->so != NULL) { 941 SOCKBUF_LOCK(&priv->so->so_rcv); 942 soupcall_clear(priv->so, SO_RCV); 943 SOCKBUF_UNLOCK(&priv->so->so_rcv); 944 SOCKBUF_LOCK(&priv->so->so_snd); 945 soupcall_clear(priv->so, SO_SND); 946 SOCKBUF_UNLOCK(&priv->so->so_snd); 947 soclose(priv->so); 948 priv->so = NULL; 949 } 950 951 /* If we are an embryo, take ourselves out of the parent's list */ 952 if (priv->flags & KSF_EMBRYONIC) { 953 LIST_REMOVE(priv, siblings); 954 priv->flags &= ~KSF_EMBRYONIC; 955 } 956 957 /* Remove any embryonic children we have */ 958 while (!LIST_EMPTY(&priv->embryos)) { 959 embryo = LIST_FIRST(&priv->embryos); 960 ng_rmnode_self(embryo->node); 961 } 962 963 /* Take down netgraph node */ 964 bzero(priv, sizeof(*priv)); 965 free(priv, M_NETGRAPH_KSOCKET); 966 NG_NODE_SET_PRIVATE(node, NULL); 967 NG_NODE_UNREF(node); /* let the node escape */ 968 return (0); 969} 970 971/* 972 * Hook disconnection 973 */ 974static int 975ng_ksocket_disconnect(hook_p hook) 976{ 977 KASSERT(NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook)) == 0, 978 ("%s: numhooks=%d?", __func__, 979 NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook)))); 980 if (NG_NODE_IS_VALID(NG_HOOK_NODE(hook))) 981 ng_rmnode_self(NG_HOOK_NODE(hook)); 982 return (0); 983} 984 985/************************************************************************ 986 HELPER STUFF 987 ************************************************************************/ 988/* 989 * You should not "just call" a netgraph node function from an external 990 * asynchronous event. This is because in doing so you are ignoring the 991 * locking on the netgraph nodes. Instead call your function via ng_send_fn(). 992 * This will call the function you chose, but will first do all the 993 * locking rigmarole. Your function MAY only be called at some distant future 994 * time (several millisecs away) so don't give it any arguments 995 * that may be revoked soon (e.g. on your stack). 996 * 997 * To decouple stack, we use queue version of ng_send_fn(). 998 */ 999 1000static int 1001ng_ksocket_incoming(struct socket *so, void *arg, int waitflag) 1002{ 1003 const node_p node = arg; 1004 const priv_p priv = NG_NODE_PRIVATE(node); 1005 int wait = ((waitflag & M_WAITOK) ? NG_WAITOK : 0) | NG_QUEUE; 1006 1007 /* 1008 * Even if node is not locked, as soon as we are called, we assume 1009 * it exist and it's private area is valid. With some care we can 1010 * access it. Mark node that incoming event for it was sent to 1011 * avoid unneded queue trashing. 1012 */ 1013 if (atomic_cmpset_int(&priv->fn_sent, 0, 1) && 1014 ng_send_fn1(node, NULL, &ng_ksocket_incoming2, so, 0, wait)) { 1015 atomic_store_rel_int(&priv->fn_sent, 0); 1016 } 1017 return (SU_OK); 1018} 1019 1020 1021/* 1022 * When incoming data is appended to the socket, we get notified here. 1023 * This is also called whenever a significant event occurs for the socket. 1024 * Our original caller may have queued this even some time ago and 1025 * we cannot trust that he even still exists. The node however is being 1026 * held with a reference by the queueing code and guarantied to be valid. 1027 */ 1028static void 1029ng_ksocket_incoming2(node_p node, hook_p hook, void *arg1, int arg2) 1030{ 1031 struct socket *so = arg1; 1032 const priv_p priv = NG_NODE_PRIVATE(node); 1033 struct mbuf *m; 1034 struct ng_mesg *response; 1035 struct uio auio; 1036 int s, flags, error; 1037 1038 s = splnet(); 1039 1040 /* so = priv->so; *//* XXX could have derived this like so */ 1041 KASSERT(so == priv->so, ("%s: wrong socket", __func__)); 1042 1043 /* Allow next incoming event to be queued. */ 1044 atomic_store_rel_int(&priv->fn_sent, 0); 1045 1046 /* Check whether a pending connect operation has completed */ 1047 if (priv->flags & KSF_CONNECTING) { 1048 if ((error = so->so_error) != 0) { 1049 so->so_error = 0; 1050 so->so_state &= ~SS_ISCONNECTING; 1051 } 1052 if (!(so->so_state & SS_ISCONNECTING)) { 1053 NG_MKMESSAGE(response, NGM_KSOCKET_COOKIE, 1054 NGM_KSOCKET_CONNECT, sizeof(int32_t), M_NOWAIT); 1055 if (response != NULL) { 1056 response->header.flags |= NGF_RESP; 1057 response->header.token = priv->response_token; 1058 *(int32_t *)response->data = error; 1059 /* 1060 * send an async "response" message 1061 * to the node that set us up 1062 * (if it still exists) 1063 */ 1064 NG_SEND_MSG_ID(error, node, 1065 response, priv->response_addr, 0); 1066 } 1067 priv->flags &= ~KSF_CONNECTING; 1068 } 1069 } 1070 1071 /* Check whether a pending accept operation has completed */ 1072 if (priv->flags & KSF_ACCEPTING) { 1073 error = ng_ksocket_check_accept(priv); 1074 if (error != EWOULDBLOCK) 1075 priv->flags &= ~KSF_ACCEPTING; 1076 if (error == 0) 1077 ng_ksocket_finish_accept(priv); 1078 } 1079 1080 /* 1081 * If we don't have a hook, we must handle data events later. When 1082 * the hook gets created and is connected, this upcall function 1083 * will be called again. 1084 */ 1085 if (priv->hook == NULL) { 1086 splx(s); 1087 return; 1088 } 1089 1090 /* Read and forward available mbuf's */ 1091 auio.uio_td = NULL; 1092 auio.uio_resid = 1000000000; 1093 flags = MSG_DONTWAIT; 1094 while (1) { 1095 struct sockaddr *sa = NULL; 1096 struct mbuf *n; 1097 1098 /* Try to get next packet from socket */ 1099 if ((error = soreceive(so, (so->so_state & SS_ISCONNECTED) ? 1100 NULL : &sa, &auio, &m, (struct mbuf **)0, &flags)) != 0) 1101 break; 1102 1103 /* See if we got anything */ 1104 if (m == NULL) { 1105 if (sa != NULL) 1106 free(sa, M_SONAME); 1107 break; 1108 } 1109 1110 /* 1111 * Don't trust the various socket layers to get the 1112 * packet header and length correct (e.g. kern/15175). 1113 * 1114 * Also, do not trust that soreceive() will clear m_nextpkt 1115 * for us (e.g. kern/84952, kern/82413). 1116 */ 1117 m->m_pkthdr.csum_flags = 0; 1118 for (n = m, m->m_pkthdr.len = 0; n != NULL; n = n->m_next) { 1119 m->m_pkthdr.len += n->m_len; 1120 n->m_nextpkt = NULL; 1121 } 1122 1123 /* Put peer's socket address (if any) into a tag */ 1124 if (sa != NULL) { 1125 struct sa_tag *stag; 1126 1127 stag = (struct sa_tag *)m_tag_alloc(NGM_KSOCKET_COOKIE, 1128 NG_KSOCKET_TAG_SOCKADDR, sizeof(ng_ID_t) + 1129 sa->sa_len, M_NOWAIT); 1130 if (stag == NULL) { 1131 free(sa, M_SONAME); 1132 goto sendit; 1133 } 1134 bcopy(sa, &stag->sa, sa->sa_len); 1135 free(sa, M_SONAME); 1136 stag->id = NG_NODE_ID(node); 1137 m_tag_prepend(m, &stag->tag); 1138 } 1139 1140sendit: /* Forward data with optional peer sockaddr as packet tag */ 1141 NG_SEND_DATA_ONLY(error, priv->hook, m); 1142 } 1143 1144 /* 1145 * If the peer has closed the connection, forward a 0-length mbuf 1146 * to indicate end-of-file. 1147 */ 1148 if (so->so_rcv.sb_state & SBS_CANTRCVMORE && !(priv->flags & KSF_EOFSEEN)) { 1149 MGETHDR(m, M_NOWAIT, MT_DATA); 1150 if (m != NULL) { 1151 m->m_len = m->m_pkthdr.len = 0; 1152 NG_SEND_DATA_ONLY(error, priv->hook, m); 1153 } 1154 priv->flags |= KSF_EOFSEEN; 1155 } 1156 splx(s); 1157} 1158 1159/* 1160 * Check for a completed incoming connection and return 0 if one is found. 1161 * Otherwise return the appropriate error code. 1162 */ 1163static int 1164ng_ksocket_check_accept(priv_p priv) 1165{ 1166 struct socket *const head = priv->so; 1167 int error; 1168 1169 if ((error = head->so_error) != 0) { 1170 head->so_error = 0; 1171 return error; 1172 } 1173 /* Unlocked read. */ 1174 if (TAILQ_EMPTY(&head->so_comp)) { 1175 if (head->so_rcv.sb_state & SBS_CANTRCVMORE) 1176 return ECONNABORTED; 1177 return EWOULDBLOCK; 1178 } 1179 return 0; 1180} 1181 1182/* 1183 * Handle the first completed incoming connection, assumed to be already 1184 * on the socket's so_comp queue. 1185 */ 1186static void 1187ng_ksocket_finish_accept(priv_p priv) 1188{ 1189 struct socket *const head = priv->so; 1190 struct socket *so; 1191 struct sockaddr *sa = NULL; 1192 struct ng_mesg *resp; 1193 struct ng_ksocket_accept *resp_data; 1194 node_p node; 1195 priv_p priv2; 1196 int len; 1197 int error; 1198 1199 ACCEPT_LOCK(); 1200 so = TAILQ_FIRST(&head->so_comp); 1201 if (so == NULL) { /* Should never happen */ 1202 ACCEPT_UNLOCK(); 1203 return; 1204 } 1205 TAILQ_REMOVE(&head->so_comp, so, so_list); 1206 head->so_qlen--; 1207 so->so_qstate &= ~SQ_COMP; 1208 so->so_head = NULL; 1209 SOCK_LOCK(so); 1210 soref(so); 1211 so->so_state |= SS_NBIO; 1212 SOCK_UNLOCK(so); 1213 ACCEPT_UNLOCK(); 1214 1215 /* XXX KNOTE(&head->so_rcv.sb_sel.si_note, 0); */ 1216 1217 soaccept(so, &sa); 1218 1219 len = OFFSETOF(struct ng_ksocket_accept, addr); 1220 if (sa != NULL) 1221 len += sa->sa_len; 1222 1223 NG_MKMESSAGE(resp, NGM_KSOCKET_COOKIE, NGM_KSOCKET_ACCEPT, len, 1224 M_NOWAIT); 1225 if (resp == NULL) { 1226 soclose(so); 1227 goto out; 1228 } 1229 resp->header.flags |= NGF_RESP; 1230 resp->header.token = priv->response_token; 1231 1232 /* Clone a ksocket node to wrap the new socket */ 1233 error = ng_make_node_common(&ng_ksocket_typestruct, &node); 1234 if (error) { 1235 free(resp, M_NETGRAPH); 1236 soclose(so); 1237 goto out; 1238 } 1239 1240 if (ng_ksocket_constructor(node) != 0) { 1241 NG_NODE_UNREF(node); 1242 free(resp, M_NETGRAPH); 1243 soclose(so); 1244 goto out; 1245 } 1246 1247 priv2 = NG_NODE_PRIVATE(node); 1248 priv2->so = so; 1249 priv2->flags |= KSF_CLONED | KSF_EMBRYONIC; 1250 1251 /* 1252 * Insert the cloned node into a list of embryonic children 1253 * on the parent node. When a hook is created on the cloned 1254 * node it will be removed from this list. When the parent 1255 * is destroyed it will destroy any embryonic children it has. 1256 */ 1257 LIST_INSERT_HEAD(&priv->embryos, priv2, siblings); 1258 1259 SOCKBUF_LOCK(&so->so_rcv); 1260 soupcall_set(so, SO_RCV, ng_ksocket_incoming, node); 1261 SOCKBUF_UNLOCK(&so->so_rcv); 1262 SOCKBUF_LOCK(&so->so_snd); 1263 soupcall_set(so, SO_RCV, ng_ksocket_incoming, node); 1264 SOCKBUF_UNLOCK(&so->so_snd); 1265 1266 /* Fill in the response data and send it or return it to the caller */ 1267 resp_data = (struct ng_ksocket_accept *)resp->data; 1268 resp_data->nodeid = NG_NODE_ID(node); 1269 if (sa != NULL) 1270 bcopy(sa, &resp_data->addr, sa->sa_len); 1271 NG_SEND_MSG_ID(error, node, resp, priv->response_addr, 0); 1272 1273out: 1274 if (sa != NULL) 1275 free(sa, M_SONAME); 1276} 1277 1278/* 1279 * Parse out either an integer value or an alias. 1280 */ 1281static int 1282ng_ksocket_parse(const struct ng_ksocket_alias *aliases, 1283 const char *s, int family) 1284{ 1285 int k, val; 1286 char *eptr; 1287 1288 /* Try aliases */ 1289 for (k = 0; aliases[k].name != NULL; k++) { 1290 if (strcmp(s, aliases[k].name) == 0 1291 && aliases[k].family == family) 1292 return aliases[k].value; 1293 } 1294 1295 /* Try parsing as a number */ 1296 val = (int)strtoul(s, &eptr, 10); 1297 if (val < 0 || *eptr != '\0') 1298 return (-1); 1299 return (val); 1300} 1301 1302