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$ 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 72 MALLOC_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 */ 81 struct ng_ksocket_private { 82 node_p node; 83 hook_p hook; 84 struct socket *so; 85 LIST_HEAD(, ng_ksocket_private) embryos; 86 LIST_ENTRY(ng_ksocket_private) siblings; 87 u_int32_t flags; 88 u_int32_t response_token; 89 ng_ID_t response_addr; 90 }; 91 typedef struct ng_ksocket_private *priv_p; 92 93 /* Flags for priv_p */ 94 #define KSF_CONNECTING 0x00000001 /* Waiting for connection complete */ 95 #define KSF_ACCEPTING 0x00000002 /* Waiting for accept complete */ 96 #define KSF_EOFSEEN 0x00000004 /* Have sent 0-length EOF mbuf */ 97 #define KSF_CLONED 0x00000008 /* Cloned from an accepting socket */ 98 #define KSF_EMBRYONIC 0x00000010 /* Cloned node with no hooks yet */ 99 #define KSF_SENDING 0x00000020 /* Sending on socket */ 100 101 /* Netgraph node methods */ 102 static ng_constructor_t ng_ksocket_constructor; 103 static ng_rcvmsg_t ng_ksocket_rcvmsg; 104 static ng_shutdown_t ng_ksocket_shutdown; 105 static ng_newhook_t ng_ksocket_newhook; 106 static ng_rcvdata_t ng_ksocket_rcvdata; 107 static ng_connect_t ng_ksocket_connect; 108 static ng_disconnect_t ng_ksocket_disconnect; 109 110 /* Alias structure */ 111 struct ng_ksocket_alias { 112 const char *name; 113 const int value; 114 const int family; 115 }; 116 117 /* Protocol family aliases */ 118 static 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 */ 129 static 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 */ 139 static 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 */ 159 static int ng_ksocket_check_accept(priv_p); 160 static void ng_ksocket_finish_accept(priv_p); 161 static void ng_ksocket_incoming(struct socket *so, void *arg, int waitflag); 162 static int ng_ksocket_parse(const struct ng_ksocket_alias *aliases, 163 const char *s, int family); 164 static void ng_ksocket_incoming2(node_p node, hook_p hook, 165 void *arg1, int waitflag); 166 167 /************************************************************************ 168 STRUCT SOCKADDR PARSE TYPE 169 ************************************************************************/ 170 171 /* Get the length of the data portion of a generic struct sockaddr */ 172 static int 173 ng_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 */ 183 static 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 */ 189 static 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 }; 196 static 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. */ 204 static int 205 ng_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 */ 317 static int 318 ng_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 */ 379 static 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. */ 395 static int 396 ng_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. */ 412 static 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 */ 418 static const struct ng_parse_struct_field ng_ksocket_sockopt_type_fields[] 419 = NG_KSOCKET_SOCKOPT_INFO(&ng_ksocket_sockoptval_type); 420 static 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 */ 426 static const struct ng_parse_struct_field ng_ksocket_accept_type_fields[] 427 = NGM_KSOCKET_ACCEPT_INFO; 428 static 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 */ 434 static 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 */ 495 static 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 }; 507 NETGRAPH_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 */ 520 static int 521 ng_ksocket_constructor(node_p node) 522 { 523 priv_p priv; 524 525 /* Allocate private structure */ 526 MALLOC(priv, priv_p, 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 */ 548 static int 549 ng_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 return(0); 601 } 602 603 static int 604 ng_ksocket_connect(hook_p hook) 605 { 606 node_p node = NG_HOOK_NODE(hook); 607 const priv_p priv = NG_NODE_PRIVATE(node); 608 struct socket *const so = priv->so; 609 610 /* Add our hook for incoming data and other events */ 611 priv->so->so_upcallarg = (caddr_t)node; 612 priv->so->so_upcall = ng_ksocket_incoming; 613 SOCKBUF_LOCK(&priv->so->so_rcv); 614 priv->so->so_rcv.sb_flags |= SB_UPCALL; 615 SOCKBUF_UNLOCK(&priv->so->so_rcv); 616 SOCKBUF_LOCK(&priv->so->so_snd); 617 priv->so->so_snd.sb_flags |= SB_UPCALL; 618 SOCKBUF_UNLOCK(&priv->so->so_snd); 619 SOCK_LOCK(priv->so); 620 priv->so->so_state |= SS_NBIO; 621 SOCK_UNLOCK(priv->so); 622 /* 623 * --Original comment-- 624 * On a cloned socket we may have already received one or more 625 * upcalls which we couldn't handle without a hook. Handle 626 * those now. 627 * We cannot call the upcall function directly 628 * from here, because until this function has returned our 629 * hook isn't connected. 630 * 631 * ---meta comment for -current --- 632 * XXX This is dubius. 633 * Upcalls between the time that the hook was 634 * first created and now (on another processesor) will 635 * be earlier on the queue than the request to finalise the hook. 636 * By the time the hook is finalised, 637 * The queued upcalls will have happenned and the code 638 * will have discarded them because of a lack of a hook. 639 * (socket not open). 640 * 641 * This is a bad byproduct of the complicated way in which hooks 642 * are now created (3 daisy chained async events). 643 * 644 * Since we are a netgraph operation 645 * We know that we hold a lock on this node. This forces the 646 * request we make below to be queued rather than implemented 647 * immediatly which will cause the upcall function to be called a bit 648 * later. 649 * However, as we will run any waiting queued operations immediatly 650 * after doing this one, if we have not finalised the other end 651 * of the hook, those queued operations will fail. 652 */ 653 if (priv->flags & KSF_CLONED) { 654 ng_send_fn(node, NULL, &ng_ksocket_incoming2, so, M_NOWAIT); 655 } 656 657 return (0); 658 } 659 660 /* 661 * Receive a control message 662 */ 663 static int 664 ng_ksocket_rcvmsg(node_p node, item_p item, hook_p lasthook) 665 { 666 struct thread *td = curthread; /* XXX broken */ 667 const priv_p priv = NG_NODE_PRIVATE(node); 668 struct socket *const so = priv->so; 669 struct ng_mesg *resp = NULL; 670 int error = 0; 671 struct ng_mesg *msg; 672 ng_ID_t raddr; 673 674 NGI_GET_MSG(item, msg); 675 switch (msg->header.typecookie) { 676 case NGM_KSOCKET_COOKIE: 677 switch (msg->header.cmd) { 678 case NGM_KSOCKET_BIND: 679 { 680 struct sockaddr *const sa 681 = (struct sockaddr *)msg->data; 682 683 /* Sanity check */ 684 if (msg->header.arglen < SADATA_OFFSET 685 || msg->header.arglen < sa->sa_len) 686 ERROUT(EINVAL); 687 if (so == NULL) 688 ERROUT(ENXIO); 689 690 /* Bind */ 691 error = sobind(so, sa, td); 692 break; 693 } 694 case NGM_KSOCKET_LISTEN: 695 { 696 /* Sanity check */ 697 if (msg->header.arglen != sizeof(int32_t)) 698 ERROUT(EINVAL); 699 if (so == NULL) 700 ERROUT(ENXIO); 701 702 /* Listen */ 703 error = solisten(so, *((int32_t *)msg->data), td); 704 break; 705 } 706 707 case NGM_KSOCKET_ACCEPT: 708 { 709 /* Sanity check */ 710 if (msg->header.arglen != 0) 711 ERROUT(EINVAL); 712 if (so == NULL) 713 ERROUT(ENXIO); 714 715 /* Make sure the socket is capable of accepting */ 716 if (!(so->so_options & SO_ACCEPTCONN)) 717 ERROUT(EINVAL); 718 if (priv->flags & KSF_ACCEPTING) 719 ERROUT(EALREADY); 720 721 error = ng_ksocket_check_accept(priv); 722 if (error != 0 && error != EWOULDBLOCK) 723 ERROUT(error); 724 725 /* 726 * If a connection is already complete, take it. 727 * Otherwise let the upcall function deal with 728 * the connection when it comes in. 729 */ 730 priv->response_token = msg->header.token; 731 raddr = priv->response_addr = NGI_RETADDR(item); 732 if (error == 0) { 733 ng_ksocket_finish_accept(priv); 734 } else 735 priv->flags |= KSF_ACCEPTING; 736 break; 737 } 738 739 case NGM_KSOCKET_CONNECT: 740 { 741 struct sockaddr *const sa 742 = (struct sockaddr *)msg->data; 743 744 /* Sanity check */ 745 if (msg->header.arglen < SADATA_OFFSET 746 || msg->header.arglen < sa->sa_len) 747 ERROUT(EINVAL); 748 if (so == NULL) 749 ERROUT(ENXIO); 750 751 /* Do connect */ 752 if ((so->so_state & SS_ISCONNECTING) != 0) 753 ERROUT(EALREADY); 754 if ((error = soconnect(so, sa, td)) != 0) { 755 so->so_state &= ~SS_ISCONNECTING; 756 ERROUT(error); 757 } 758 if ((so->so_state & SS_ISCONNECTING) != 0) { 759 /* We will notify the sender when we connect */ 760 priv->response_token = msg->header.token; 761 raddr = priv->response_addr = NGI_RETADDR(item); 762 priv->flags |= KSF_CONNECTING; 763 ERROUT(EINPROGRESS); 764 } 765 break; 766 } 767 768 case NGM_KSOCKET_GETNAME: 769 case NGM_KSOCKET_GETPEERNAME: 770 { 771 int (*func)(struct socket *so, struct sockaddr **nam); 772 struct sockaddr *sa = NULL; 773 int len; 774 775 /* Sanity check */ 776 if (msg->header.arglen != 0) 777 ERROUT(EINVAL); 778 if (so == NULL) 779 ERROUT(ENXIO); 780 781 /* Get function */ 782 if (msg->header.cmd == NGM_KSOCKET_GETPEERNAME) { 783 if ((so->so_state 784 & (SS_ISCONNECTED|SS_ISCONFIRMING)) == 0) 785 ERROUT(ENOTCONN); 786 func = so->so_proto->pr_usrreqs->pru_peeraddr; 787 } else 788 func = so->so_proto->pr_usrreqs->pru_sockaddr; 789 790 /* Get local or peer address */ 791 if ((error = (*func)(so, &sa)) != 0) 792 goto bail; 793 len = (sa == NULL) ? 0 : sa->sa_len; 794 795 /* Send it back in a response */ 796 NG_MKRESPONSE(resp, msg, len, M_NOWAIT); 797 if (resp == NULL) { 798 error = ENOMEM; 799 goto bail; 800 } 801 bcopy(sa, resp->data, len); 802 803 bail: 804 /* Cleanup */ 805 if (sa != NULL) 806 FREE(sa, M_SONAME); 807 break; 808 } 809 810 case NGM_KSOCKET_GETOPT: 811 { 812 struct ng_ksocket_sockopt *ksopt = 813 (struct ng_ksocket_sockopt *)msg->data; 814 struct sockopt sopt; 815 816 /* Sanity check */ 817 if (msg->header.arglen != sizeof(*ksopt)) 818 ERROUT(EINVAL); 819 if (so == NULL) 820 ERROUT(ENXIO); 821 822 /* Get response with room for option value */ 823 NG_MKRESPONSE(resp, msg, sizeof(*ksopt) 824 + NG_KSOCKET_MAX_OPTLEN, M_NOWAIT); 825 if (resp == NULL) 826 ERROUT(ENOMEM); 827 828 /* Get socket option, and put value in the response */ 829 sopt.sopt_dir = SOPT_GET; 830 sopt.sopt_level = ksopt->level; 831 sopt.sopt_name = ksopt->name; 832 sopt.sopt_td = NULL; 833 sopt.sopt_valsize = NG_KSOCKET_MAX_OPTLEN; 834 ksopt = (struct ng_ksocket_sockopt *)resp->data; 835 sopt.sopt_val = ksopt->value; 836 if ((error = sogetopt(so, &sopt)) != 0) { 837 NG_FREE_MSG(resp); 838 break; 839 } 840 841 /* Set actual value length */ 842 resp->header.arglen = sizeof(*ksopt) 843 + sopt.sopt_valsize; 844 break; 845 } 846 847 case NGM_KSOCKET_SETOPT: 848 { 849 struct ng_ksocket_sockopt *const ksopt = 850 (struct ng_ksocket_sockopt *)msg->data; 851 const int valsize = msg->header.arglen - sizeof(*ksopt); 852 struct sockopt sopt; 853 854 /* Sanity check */ 855 if (valsize < 0) 856 ERROUT(EINVAL); 857 if (so == NULL) 858 ERROUT(ENXIO); 859 860 /* Set socket option */ 861 sopt.sopt_dir = SOPT_SET; 862 sopt.sopt_level = ksopt->level; 863 sopt.sopt_name = ksopt->name; 864 sopt.sopt_val = ksopt->value; 865 sopt.sopt_valsize = valsize; 866 sopt.sopt_td = NULL; 867 error = sosetopt(so, &sopt); 868 break; 869 } 870 871 default: 872 error = EINVAL; 873 break; 874 } 875 break; 876 default: 877 error = EINVAL; 878 break; 879 } 880 done: 881 NG_RESPOND_MSG(error, node, item, resp); 882 NG_FREE_MSG(msg); 883 return (error); 884 } 885 886 /* 887 * Receive incoming data on our hook. Send it out the socket. 888 */ 889 static int 890 ng_ksocket_rcvdata(hook_p hook, item_p item) 891 { 892 struct thread *td = curthread; /* XXX broken */ 893 const node_p node = NG_HOOK_NODE(hook); 894 const priv_p priv = NG_NODE_PRIVATE(node); 895 struct socket *const so = priv->so; 896 struct sockaddr *sa = NULL; 897 int error; 898 struct mbuf *m; 899 struct sa_tag *stag; 900 901 /* Avoid reentrantly sending on the socket */ 902 if ((priv->flags & KSF_SENDING) != 0) { 903 NG_FREE_ITEM(item); 904 return (EDEADLK); 905 } 906 907 /* Extract data */ 908 NGI_GET_M(item, m); 909 NG_FREE_ITEM(item); 910 911 /* Look if socket address is stored in packet tags */ 912 if ((stag = (struct sa_tag *)m_tag_locate(m, NGM_KSOCKET_COOKIE, 913 NG_KSOCKET_TAG_SOCKADDR, NULL)) != NULL) 914 sa = &stag->sa; 915 916 /* Send packet */ 917 priv->flags |= KSF_SENDING; 918 error = (*so->so_proto->pr_usrreqs->pru_sosend)(so, sa, 0, m, 0, 0, td); 919 priv->flags &= ~KSF_SENDING; 920 921 return (error); 922 } 923 924 /* 925 * Destroy node 926 */ 927 static int 928 ng_ksocket_shutdown(node_p node) 929 { 930 const priv_p priv = NG_NODE_PRIVATE(node); 931 priv_p embryo; 932 933 /* Close our socket (if any) */ 934 if (priv->so != NULL) { 935 priv->so->so_upcall = NULL; 936 SOCKBUF_LOCK(&priv->so->so_rcv); 937 priv->so->so_rcv.sb_flags &= ~SB_UPCALL; 938 SOCKBUF_UNLOCK(&priv->so->so_rcv); 939 SOCKBUF_LOCK(&priv->so->so_snd); 940 priv->so->so_snd.sb_flags &= ~SB_UPCALL; 941 SOCKBUF_UNLOCK(&priv->so->so_snd); 942 soclose(priv->so); 943 priv->so = NULL; 944 } 945 946 /* If we are an embryo, take ourselves out of the parent's list */ 947 if (priv->flags & KSF_EMBRYONIC) { 948 LIST_REMOVE(priv, siblings); 949 priv->flags &= ~KSF_EMBRYONIC; 950 } 951 952 /* Remove any embryonic children we have */ 953 while (!LIST_EMPTY(&priv->embryos)) { 954 embryo = LIST_FIRST(&priv->embryos); 955 ng_rmnode_self(embryo->node); 956 } 957 958 /* Take down netgraph node */ 959 bzero(priv, sizeof(*priv)); 960 FREE(priv, M_NETGRAPH_KSOCKET); 961 NG_NODE_SET_PRIVATE(node, NULL); 962 NG_NODE_UNREF(node); /* let the node escape */ 963 return (0); 964 } 965 966 /* 967 * Hook disconnection 968 */ 969 static int 970 ng_ksocket_disconnect(hook_p hook) 971 { 972 KASSERT(NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook)) == 0, 973 ("%s: numhooks=%d?", __func__, 974 NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook)))); 975 if (NG_NODE_IS_VALID(NG_HOOK_NODE(hook))) 976 ng_rmnode_self(NG_HOOK_NODE(hook)); 977 return (0); 978 } 979 980 /************************************************************************ 981 HELPER STUFF 982 ************************************************************************/ 983 /* 984 * You should no-longer "just call" a netgraph node function 985 * from an external asynchronous event. 986 * This is because in doing so you are ignoring the locking on the netgraph 987 * nodes. Instead call your function via 988 * "int ng_send_fn(node_p node, hook_p hook, ng_item_fn *fn, 989 * void *arg1, int arg2);" 990 * this will call the function you chose, but will first do all the 991 * locking rigmarole. Your function MAY only be called at some distant future 992 * time (several millisecs away) so don't give it any arguments 993 * that may be revoked soon (e.g. on your stack). 994 * In this case even the 'so' argument is doubtful. 995 * While the function request is being processed the node 996 * has an extra reference and as such will not disappear until 997 * the request has at least been done, but the 'so' may not be so lucky. 998 * handle this by checking the validity of the node in the target function 999 * before dereferencing the socket pointer. 1000 */ 1001 1002 static void 1003 ng_ksocket_incoming(struct socket *so, void *arg, int waitflag) 1004 { 1005 const node_p node = arg; 1006 1007 ng_send_fn(node, NULL, &ng_ksocket_incoming2, so, waitflag); 1008 } 1009 1010 1011 /* 1012 * When incoming data is appended to the socket, we get notified here. 1013 * This is also called whenever a significant event occurs for the socket. 1014 * We know that HOOK is NULL. Because of how we were called we know we have a 1015 * lock on this node an are participating inthe netgraph locking. 1016 * Our original caller may have queued this even some time ago and 1017 * we cannot trust that he even still exists. The node however is being 1018 * held with a reference by the queueing code, at least until we finish, 1019 * even if it has been zapped, so first check it's validiy 1020 * before we trust the socket (which was derived from it). 1021 */ 1022 static void 1023 ng_ksocket_incoming2(node_p node, hook_p hook, void *arg1, int waitflag) 1024 { 1025 struct socket *so = arg1; 1026 const priv_p priv = NG_NODE_PRIVATE(node); 1027 struct mbuf *m; 1028 struct ng_mesg *response; 1029 struct uio auio; 1030 int s, flags, error; 1031 1032 s = splnet(); 1033 1034 /* Sanity check */ 1035 if (NG_NODE_NOT_VALID(node)) { 1036 splx(s); 1037 return; 1038 } 1039 /* so = priv->so; *//* XXX could have derived this like so */ 1040 KASSERT(so == priv->so, ("%s: wrong socket", __func__)); 1041 1042 /* Check whether a pending connect operation has completed */ 1043 if (priv->flags & KSF_CONNECTING) { 1044 if ((error = so->so_error) != 0) { 1045 so->so_error = 0; 1046 so->so_state &= ~SS_ISCONNECTING; 1047 } 1048 if (!(so->so_state & SS_ISCONNECTING)) { 1049 NG_MKMESSAGE(response, NGM_KSOCKET_COOKIE, 1050 NGM_KSOCKET_CONNECT, sizeof(int32_t), waitflag); 1051 if (response != NULL) { 1052 response->header.flags |= NGF_RESP; 1053 response->header.token = priv->response_token; 1054 *(int32_t *)response->data = error; 1055 /* 1056 * send an async "response" message 1057 * to the node that set us up 1058 * (if it still exists) 1059 */ 1060 NG_SEND_MSG_ID(error, node, 1061 response, priv->response_addr, 0); 1062 } 1063 priv->flags &= ~KSF_CONNECTING; 1064 } 1065 } 1066 1067 /* Check whether a pending accept operation has completed */ 1068 if (priv->flags & KSF_ACCEPTING) { 1069 error = ng_ksocket_check_accept(priv); 1070 if (error != EWOULDBLOCK) 1071 priv->flags &= ~KSF_ACCEPTING; 1072 if (error == 0) 1073 ng_ksocket_finish_accept(priv); 1074 } 1075 1076 /* 1077 * If we don't have a hook, we must handle data events later. When 1078 * the hook gets created and is connected, this upcall function 1079 * will be called again. 1080 */ 1081 if (priv->hook == NULL) { 1082 splx(s); 1083 return; 1084 } 1085 1086 /* Read and forward available mbuf's */ 1087 auio.uio_td = NULL; 1088 auio.uio_resid = 1000000000; 1089 flags = MSG_DONTWAIT; 1090 while (1) { 1091 struct sockaddr *sa = NULL; 1092 struct mbuf *n; 1093 1094 /* Try to get next packet from socket */ 1095 if ((error = (*so->so_proto->pr_usrreqs->pru_soreceive) 1096 (so, (so->so_state & SS_ISCONNECTED) ? NULL : &sa, 1097 &auio, &m, (struct mbuf **)0, &flags)) != 0) 1098 break; 1099 1100 /* See if we got anything */ 1101 if (m == NULL) { 1102 if (sa != NULL) 1103 FREE(sa, M_SONAME); 1104 break; 1105 } 1106 1107 /* Don't trust the various socket layers to get the 1108 packet header and length correct (eg. kern/15175) */ 1109 for (n = m, m->m_pkthdr.len = 0; n != NULL; n = n->m_next) 1110 m->m_pkthdr.len += n->m_len; 1111 1112 /* Put peer's socket address (if any) into a tag */ 1113 if (sa != NULL) { 1114 struct sa_tag *stag; 1115 1116 stag = (struct sa_tag *)m_tag_alloc(NGM_KSOCKET_COOKIE, 1117 NG_KSOCKET_TAG_SOCKADDR, sa->sa_len, M_NOWAIT); 1118 if (stag == NULL) { 1119 FREE(sa, M_SONAME); 1120 goto sendit; 1121 } 1122 bcopy(sa, &stag->sa, sa->sa_len); 1123 FREE(sa, M_SONAME); 1124 m_tag_prepend(m, &stag->tag); 1125 } 1126 1127 sendit: /* Forward data with optional peer sockaddr as packet tag */ 1128 NG_SEND_DATA_ONLY(error, priv->hook, m); 1129 } 1130 1131 /* 1132 * If the peer has closed the connection, forward a 0-length mbuf 1133 * to indicate end-of-file. 1134 */ 1135 if (so->so_rcv.sb_state & SBS_CANTRCVMORE && !(priv->flags & KSF_EOFSEEN)) { 1136 MGETHDR(m, waitflag, MT_DATA); 1137 if (m != NULL) { 1138 m->m_len = m->m_pkthdr.len = 0; 1139 NG_SEND_DATA_ONLY(error, priv->hook, m); 1140 } 1141 priv->flags |= KSF_EOFSEEN; 1142 } 1143 splx(s); 1144 } 1145 1146 /* 1147 * Check for a completed incoming connection and return 0 if one is found. 1148 * Otherwise return the appropriate error code. 1149 */ 1150 static int 1151 ng_ksocket_check_accept(priv_p priv) 1152 { 1153 struct socket *const head = priv->so; 1154 int error; 1155 1156 if ((error = head->so_error) != 0) { 1157 head->so_error = 0; 1158 return error; 1159 } 1160 /* Unlocked read. */ 1161 if (TAILQ_EMPTY(&head->so_comp)) { 1162 if (head->so_rcv.sb_state & SBS_CANTRCVMORE) 1163 return ECONNABORTED; 1164 return EWOULDBLOCK; 1165 } 1166 return 0; 1167 } 1168 1169 /* 1170 * Handle the first completed incoming connection, assumed to be already 1171 * on the socket's so_comp queue. 1172 */ 1173 static void 1174 ng_ksocket_finish_accept(priv_p priv) 1175 { 1176 struct socket *const head = priv->so; 1177 struct socket *so; 1178 struct sockaddr *sa = NULL; 1179 struct ng_mesg *resp; 1180 struct ng_ksocket_accept *resp_data; 1181 node_p node; 1182 priv_p priv2; 1183 int len; 1184 int error; 1185 1186 ACCEPT_LOCK(); 1187 so = TAILQ_FIRST(&head->so_comp); 1188 if (so == NULL) { /* Should never happen */ 1189 ACCEPT_UNLOCK(); 1190 return; 1191 } 1192 TAILQ_REMOVE(&head->so_comp, so, so_list); 1193 head->so_qlen--; 1194 so->so_qstate &= ~SQ_COMP; 1195 so->so_head = NULL; 1196 SOCK_LOCK(so); 1197 soref(so); 1198 so->so_state |= SS_NBIO; 1199 SOCK_UNLOCK(so); 1200 ACCEPT_UNLOCK(); 1201 1202 /* XXX KNOTE(&head->so_rcv.sb_sel.si_note, 0); */ 1203 1204 soaccept(so, &sa); 1205 1206 len = OFFSETOF(struct ng_ksocket_accept, addr); 1207 if (sa != NULL) 1208 len += sa->sa_len; 1209 1210 NG_MKMESSAGE(resp, NGM_KSOCKET_COOKIE, NGM_KSOCKET_ACCEPT, len, 1211 M_NOWAIT); 1212 if (resp == NULL) { 1213 soclose(so); 1214 goto out; 1215 } 1216 resp->header.flags |= NGF_RESP; 1217 resp->header.token = priv->response_token; 1218 1219 /* Clone a ksocket node to wrap the new socket */ 1220 error = ng_make_node_common(&ng_ksocket_typestruct, &node); 1221 if (error) { 1222 FREE(resp, M_NETGRAPH); 1223 soclose(so); 1224 goto out; 1225 } 1226 1227 if (ng_ksocket_constructor(node) != 0) { 1228 NG_NODE_UNREF(node); 1229 FREE(resp, M_NETGRAPH); 1230 soclose(so); 1231 goto out; 1232 } 1233 1234 priv2 = NG_NODE_PRIVATE(node); 1235 priv2->so = so; 1236 priv2->flags |= KSF_CLONED | KSF_EMBRYONIC; 1237 1238 /* 1239 * Insert the cloned node into a list of embryonic children 1240 * on the parent node. When a hook is created on the cloned 1241 * node it will be removed from this list. When the parent 1242 * is destroyed it will destroy any embryonic children it has. 1243 */ 1244 LIST_INSERT_HEAD(&priv->embryos, priv2, siblings); 1245 1246 so->so_upcallarg = (caddr_t)node; 1247 so->so_upcall = ng_ksocket_incoming; 1248 SOCKBUF_LOCK(&so->so_rcv); 1249 so->so_rcv.sb_flags |= SB_UPCALL; 1250 SOCKBUF_UNLOCK(&so->so_rcv); 1251 SOCKBUF_LOCK(&so->so_snd); 1252 so->so_snd.sb_flags |= SB_UPCALL; 1253 SOCKBUF_UNLOCK(&so->so_snd); 1254 1255 /* Fill in the response data and send it or return it to the caller */ 1256 resp_data = (struct ng_ksocket_accept *)resp->data; 1257 resp_data->nodeid = NG_NODE_ID(node); 1258 if (sa != NULL) 1259 bcopy(sa, &resp_data->addr, sa->sa_len); 1260 NG_SEND_MSG_ID(error, node, resp, priv->response_addr, 0); 1261 1262 out: 1263 if (sa != NULL) 1264 FREE(sa, M_SONAME); 1265 } 1266 1267 /* 1268 * Parse out either an integer value or an alias. 1269 */ 1270 static int 1271 ng_ksocket_parse(const struct ng_ksocket_alias *aliases, 1272 const char *s, int family) 1273 { 1274 int k, val; 1275 char *eptr; 1276 1277 /* Try aliases */ 1278 for (k = 0; aliases[k].name != NULL; k++) { 1279 if (strcmp(s, aliases[k].name) == 0 1280 && aliases[k].family == family) 1281 return aliases[k].value; 1282 } 1283 1284 /* Try parsing as a number */ 1285 val = (int)strtoul(s, &eptr, 10); 1286 if (val < 0 || *eptr != '\0') 1287 return (-1); 1288 return (val); 1289 } 1290 1291