1 2 /* 3 * ng_ksocket.c 4 * 5 * Copyright (c) 1996-1999 Whistle Communications, Inc. 6 * All rights reserved. 7 * 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. 18 * 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 35 * OF SUCH DAMAGE. 36 * 37 * Author: Archie Cobbs <archie@freebsd.org> 38 * 39 * $FreeBSD: src/sys/netgraph/ng_ksocket.c,v 1.5.2.14 2003/08/24 08:24:38 hsu Exp $ 40 * $DragonFly: src/sys/netgraph/ksocket/ng_ksocket.c,v 1.8 2004/04/08 20:13:28 hsu Exp $ 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/socketops.h> 61 #include <sys/uio.h> 62 #include <sys/un.h> 63 64 #include <netgraph/ng_message.h> 65 #include <netgraph/netgraph.h> 66 #include <netgraph/ng_parse.h> 67 #include "ng_ksocket.h" 68 69 #include <netinet/in.h> 70 #include <netproto/atalk/at.h> 71 72 #define OFFSETOF(s, e) ((char *)&((s *)0)->e - (char *)((s *)0)) 73 #define SADATA_OFFSET (OFFSETOF(struct sockaddr, sa_data)) 74 75 /* Node private data */ 76 struct ng_ksocket_private { 77 node_p node; 78 hook_p hook; 79 struct socket *so; 80 LIST_HEAD(, ng_ksocket_private) embryos; 81 LIST_ENTRY(ng_ksocket_private) siblings; 82 u_int32_t flags; 83 u_int32_t response_token; 84 char response_addr[NG_PATHLEN+1]; 85 }; 86 typedef struct ng_ksocket_private *priv_p; 87 88 /* Flags for priv_p */ 89 #define KSF_CONNECTING 0x00000001 /* Waiting for connection complete */ 90 #define KSF_ACCEPTING 0x00000002 /* Waiting for accept complete */ 91 #define KSF_EOFSEEN 0x00000004 /* Have sent 0-length EOF mbuf */ 92 #define KSF_CLONED 0x00000008 /* Cloned from an accepting socket */ 93 #define KSF_EMBRYONIC 0x00000010 /* Cloned node with no hooks yet */ 94 #define KSF_SENDING 0x00000020 /* Sending on socket */ 95 96 /* Internal commands which we send to ourselves */ 97 #define NGM_KSOCKET_INTERNAL_COOKIE (NGM_KSOCKET_COOKIE + 1) 98 99 enum { 100 NGM_KSOCKET_INTERNAL_UPCALL = 1 101 }; 102 103 /* Netgraph node methods */ 104 static ng_constructor_t ng_ksocket_constructor; 105 static ng_rcvmsg_t ng_ksocket_rcvmsg; 106 static ng_shutdown_t ng_ksocket_rmnode; 107 static ng_newhook_t ng_ksocket_newhook; 108 static ng_rcvdata_t ng_ksocket_rcvdata; 109 static ng_disconnect_t ng_ksocket_disconnect; 110 111 /* Alias structure */ 112 struct ng_ksocket_alias { 113 const char *name; 114 const int value; 115 const int family; 116 }; 117 118 /* Protocol family aliases */ 119 static const struct ng_ksocket_alias ng_ksocket_families[] = { 120 { "local", PF_LOCAL }, 121 { "inet", PF_INET }, 122 { "inet6", PF_INET6 }, 123 { "atalk", PF_APPLETALK }, 124 { "ipx", PF_IPX }, 125 { "atm", PF_ATM }, 126 { NULL, -1 }, 127 }; 128 129 /* Socket type aliases */ 130 static const struct ng_ksocket_alias ng_ksocket_types[] = { 131 { "stream", SOCK_STREAM }, 132 { "dgram", SOCK_DGRAM }, 133 { "raw", SOCK_RAW }, 134 { "rdm", SOCK_RDM }, 135 { "seqpacket", SOCK_SEQPACKET }, 136 { NULL, -1 }, 137 }; 138 139 /* Protocol aliases */ 140 static const struct ng_ksocket_alias ng_ksocket_protos[] = { 141 { "ip", IPPROTO_IP, PF_INET }, 142 { "raw", IPPROTO_RAW, PF_INET }, 143 { "icmp", IPPROTO_ICMP, PF_INET }, 144 { "igmp", IPPROTO_IGMP, PF_INET }, 145 { "tcp", IPPROTO_TCP, PF_INET }, 146 { "udp", IPPROTO_UDP, PF_INET }, 147 { "gre", IPPROTO_GRE, PF_INET }, 148 { "esp", IPPROTO_ESP, PF_INET }, 149 { "ah", IPPROTO_AH, PF_INET }, 150 { "swipe", IPPROTO_SWIPE, PF_INET }, 151 { "encap", IPPROTO_ENCAP, PF_INET }, 152 { "divert", IPPROTO_DIVERT, PF_INET }, 153 { "pim", IPPROTO_PIM, PF_INET }, 154 { "ddp", ATPROTO_DDP, PF_APPLETALK }, 155 { "aarp", ATPROTO_AARP, PF_APPLETALK }, 156 { NULL, -1 }, 157 }; 158 159 /* Helper functions */ 160 static int ng_ksocket_check_accept(priv_p); 161 static void ng_ksocket_finish_accept(priv_p, struct ng_mesg **); 162 static void ng_ksocket_incoming(struct socket *so, void *arg, int waitflag); 163 static int ng_ksocket_parse(const struct ng_ksocket_alias *aliases, 164 const char *s, int family); 165 166 /************************************************************************ 167 STRUCT SOCKADDR PARSE TYPE 168 ************************************************************************/ 169 170 /* Get the length of the data portion of a generic struct sockaddr */ 171 static int 172 ng_parse_generic_sockdata_getLength(const struct ng_parse_type *type, 173 const u_char *start, const u_char *buf) 174 { 175 const struct sockaddr *sa; 176 177 sa = (const struct sockaddr *)(buf - SADATA_OFFSET); 178 return (sa->sa_len < SADATA_OFFSET) ? 0 : sa->sa_len - SADATA_OFFSET; 179 } 180 181 /* Type for the variable length data portion of a generic struct sockaddr */ 182 static const struct ng_parse_type ng_ksocket_generic_sockdata_type = { 183 &ng_parse_bytearray_type, 184 &ng_parse_generic_sockdata_getLength 185 }; 186 187 /* Type for a generic struct sockaddr */ 188 static const struct ng_parse_struct_field 189 ng_parse_generic_sockaddr_type_fields[] = { 190 { "len", &ng_parse_uint8_type }, 191 { "family", &ng_parse_uint8_type }, 192 { "data", &ng_ksocket_generic_sockdata_type }, 193 { NULL } 194 }; 195 static const struct ng_parse_type ng_ksocket_generic_sockaddr_type = { 196 &ng_parse_struct_type, 197 &ng_parse_generic_sockaddr_type_fields 198 }; 199 200 /* Convert a struct sockaddr from ASCII to binary. If its a protocol 201 family that we specially handle, do that, otherwise defer to the 202 generic parse type ng_ksocket_generic_sockaddr_type. */ 203 static int 204 ng_ksocket_sockaddr_parse(const struct ng_parse_type *type, 205 const char *s, int *off, const u_char *const start, 206 u_char *const buf, int *buflen) 207 { 208 struct sockaddr *const sa = (struct sockaddr *)buf; 209 enum ng_parse_token tok; 210 char fambuf[32]; 211 int family, len; 212 char *t; 213 214 /* If next token is a left curly brace, use generic parse type */ 215 if ((tok = ng_parse_get_token(s, off, &len)) == T_LBRACE) { 216 return (*ng_ksocket_generic_sockaddr_type.supertype->parse) 217 (&ng_ksocket_generic_sockaddr_type, 218 s, off, start, buf, buflen); 219 } 220 221 /* Get socket address family followed by a slash */ 222 while (isspace(s[*off])) 223 (*off)++; 224 if ((t = index(s + *off, '/')) == NULL) 225 return (EINVAL); 226 if ((len = t - (s + *off)) > sizeof(fambuf) - 1) 227 return (EINVAL); 228 strncpy(fambuf, s + *off, len); 229 fambuf[len] = '\0'; 230 *off += len + 1; 231 if ((family = ng_ksocket_parse(ng_ksocket_families, fambuf, 0)) == -1) 232 return (EINVAL); 233 234 /* Set family */ 235 if (*buflen < SADATA_OFFSET) 236 return (ERANGE); 237 sa->sa_family = family; 238 239 /* Set family-specific data and length */ 240 switch (sa->sa_family) { 241 case PF_LOCAL: /* Get pathname */ 242 { 243 const int pathoff = OFFSETOF(struct sockaddr_un, sun_path); 244 struct sockaddr_un *const sun = (struct sockaddr_un *)sa; 245 int toklen, pathlen; 246 char *path; 247 248 if ((path = ng_get_string_token(s, off, &toklen)) == NULL) 249 return (EINVAL); 250 pathlen = strlen(path); 251 if (pathlen > SOCK_MAXADDRLEN) { 252 FREE(path, M_NETGRAPH); 253 return (E2BIG); 254 } 255 if (*buflen < pathoff + pathlen) { 256 FREE(path, M_NETGRAPH); 257 return (ERANGE); 258 } 259 *off += toklen; 260 bcopy(path, sun->sun_path, pathlen); 261 sun->sun_len = pathoff + pathlen; 262 FREE(path, M_NETGRAPH); 263 break; 264 } 265 266 case PF_INET: /* Get an IP address with optional port */ 267 { 268 struct sockaddr_in *const sin = (struct sockaddr_in *)sa; 269 int i; 270 271 /* Parse this: <ipaddress>[:port] */ 272 for (i = 0; i < 4; i++) { 273 u_long val; 274 char *eptr; 275 276 val = strtoul(s + *off, &eptr, 10); 277 if (val > 0xff || eptr == s + *off) 278 return (EINVAL); 279 *off += (eptr - (s + *off)); 280 ((u_char *)&sin->sin_addr)[i] = (u_char)val; 281 if (i < 3) { 282 if (s[*off] != '.') 283 return (EINVAL); 284 (*off)++; 285 } else if (s[*off] == ':') { 286 (*off)++; 287 val = strtoul(s + *off, &eptr, 10); 288 if (val > 0xffff || eptr == s + *off) 289 return (EINVAL); 290 *off += (eptr - (s + *off)); 291 sin->sin_port = htons(val); 292 } else 293 sin->sin_port = 0; 294 } 295 bzero(&sin->sin_zero, sizeof(sin->sin_zero)); 296 sin->sin_len = sizeof(*sin); 297 break; 298 } 299 300 #if 0 301 case PF_APPLETALK: /* XXX implement these someday */ 302 case PF_INET6: 303 case PF_IPX: 304 #endif 305 306 default: 307 return (EINVAL); 308 } 309 310 /* Done */ 311 *buflen = sa->sa_len; 312 return (0); 313 } 314 315 /* Convert a struct sockaddr from binary to ASCII */ 316 static int 317 ng_ksocket_sockaddr_unparse(const struct ng_parse_type *type, 318 const u_char *data, int *off, char *cbuf, int cbuflen) 319 { 320 const struct sockaddr *sa = (const struct sockaddr *)(data + *off); 321 int slen = 0; 322 323 /* Output socket address, either in special or generic format */ 324 switch (sa->sa_family) { 325 case PF_LOCAL: 326 { 327 const int pathoff = OFFSETOF(struct sockaddr_un, sun_path); 328 const struct sockaddr_un *sun = (const struct sockaddr_un *)sa; 329 const int pathlen = sun->sun_len - pathoff; 330 char pathbuf[SOCK_MAXADDRLEN + 1]; 331 char *pathtoken; 332 333 bcopy(sun->sun_path, pathbuf, pathlen); 334 pathbuf[pathlen] = '\0'; 335 if ((pathtoken = ng_encode_string(pathbuf)) == NULL) 336 return (ENOMEM); 337 slen += snprintf(cbuf, cbuflen, "local/%s", pathtoken); 338 FREE(pathtoken, M_NETGRAPH); 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 492 /* Internal commands */ 493 { 494 NGM_KSOCKET_INTERNAL_COOKIE, 495 NGM_KSOCKET_INTERNAL_UPCALL, 496 "upcall", 497 NULL, 498 NULL 499 }, 500 { 0 } 501 }; 502 503 /* Node type descriptor */ 504 static struct ng_type ng_ksocket_typestruct = { 505 NG_VERSION, 506 NG_KSOCKET_NODE_TYPE, 507 NULL, 508 ng_ksocket_constructor, 509 ng_ksocket_rcvmsg, 510 ng_ksocket_rmnode, 511 ng_ksocket_newhook, 512 NULL, 513 NULL, 514 ng_ksocket_rcvdata, 515 ng_ksocket_rcvdata, 516 ng_ksocket_disconnect, 517 ng_ksocket_cmds 518 }; 519 NETGRAPH_INIT(ksocket, &ng_ksocket_typestruct); 520 521 #define ERROUT(x) do { error = (x); goto done; } while (0) 522 523 /************************************************************************ 524 NETGRAPH NODE STUFF 525 ************************************************************************/ 526 527 /* 528 * Node type constructor 529 */ 530 static int 531 ng_ksocket_constructor(node_p *nodep) 532 { 533 priv_p priv; 534 int error; 535 536 /* Allocate private structure */ 537 MALLOC(priv, priv_p, sizeof(*priv), M_NETGRAPH, M_NOWAIT); 538 if (priv == NULL) 539 return (ENOMEM); 540 bzero(priv, sizeof(*priv)); 541 542 /* Call generic node constructor */ 543 if ((error = ng_make_node_common(&ng_ksocket_typestruct, nodep))) { 544 FREE(priv, M_NETGRAPH); 545 return (error); 546 } 547 (*nodep)->private = priv; 548 priv->node = *nodep; 549 LIST_INIT(&priv->embryos); 550 551 /* Done */ 552 return (0); 553 } 554 555 /* 556 * Give our OK for a hook to be added. The hook name is of the 557 * form "<family>/<type>/<proto>" where the three components may 558 * be decimal numbers or else aliases from the above lists. 559 * 560 * Connecting a hook amounts to opening the socket. Disconnecting 561 * the hook closes the socket and destroys the node as well. 562 */ 563 static int 564 ng_ksocket_newhook(node_p node, hook_p hook, const char *name0) 565 { 566 struct thread *td = curthread->td_proc ? curthread : &thread0; /* XXX broken */ 567 const priv_p priv = node->private; 568 struct ng_mesg *msg; 569 char *s1, *s2, name[NG_HOOKLEN+1]; 570 int family, type, protocol, error; 571 572 /* Check if we're already connected */ 573 if (priv->hook != NULL) 574 return (EISCONN); 575 576 if (priv->flags & KSF_CLONED) { 577 if (priv->flags & KSF_EMBRYONIC) { 578 /* Remove ourselves from our parent's embryo list */ 579 LIST_REMOVE(priv, siblings); 580 priv->flags &= ~KSF_EMBRYONIC; 581 } 582 } else { 583 /* Extract family, type, and protocol from hook name */ 584 snprintf(name, sizeof(name), "%s", name0); 585 s1 = name; 586 if ((s2 = index(s1, '/')) == NULL) 587 return (EINVAL); 588 *s2++ = '\0'; 589 family = ng_ksocket_parse(ng_ksocket_families, s1, 0); 590 if (family == -1) 591 return (EINVAL); 592 s1 = s2; 593 if ((s2 = index(s1, '/')) == NULL) 594 return (EINVAL); 595 *s2++ = '\0'; 596 type = ng_ksocket_parse(ng_ksocket_types, s1, 0); 597 if (type == -1) 598 return (EINVAL); 599 s1 = s2; 600 protocol = ng_ksocket_parse(ng_ksocket_protos, s1, family); 601 if (protocol == -1) 602 return (EINVAL); 603 604 /* Create the socket */ 605 error = socreate(family, &priv->so, type, protocol, td); 606 if (error != 0) 607 return (error); 608 609 /* XXX call soreserve() ? */ 610 611 /* Add our hook for incoming data and other events */ 612 priv->so->so_upcallarg = (caddr_t)node; 613 priv->so->so_upcall = ng_ksocket_incoming; 614 priv->so->so_rcv.sb_flags |= SB_UPCALL; 615 priv->so->so_snd.sb_flags |= SB_UPCALL; 616 priv->so->so_state |= SS_NBIO; 617 } 618 619 /* OK */ 620 priv->hook = hook; 621 622 /* 623 * On a cloned socket we may have already received one or more 624 * upcalls which we couldn't handle without a hook. Handle 625 * those now. We cannot call the upcall function directly 626 * from here, because until this function has returned our 627 * hook isn't connected. So we queue a message to ourselves 628 * which will cause the upcall function to be called a bit 629 * later. 630 */ 631 if (priv->flags & KSF_CLONED) { 632 NG_MKMESSAGE(msg, NGM_KSOCKET_INTERNAL_COOKIE, 633 NGM_KSOCKET_INTERNAL_UPCALL, 0, M_NOWAIT); 634 if (msg != NULL) 635 ng_queue_msg(node, msg, ".:"); 636 } 637 638 return (0); 639 } 640 641 /* 642 * Receive a control message 643 */ 644 static int 645 ng_ksocket_rcvmsg(node_p node, struct ng_mesg *msg, 646 const char *raddr, struct ng_mesg **rptr) 647 { 648 struct thread *td = curthread->td_proc ? curthread : &thread0; /* XXX broken */ 649 const priv_p priv = node->private; 650 struct socket *const so = priv->so; 651 struct ng_mesg *resp = NULL; 652 int error = 0; 653 654 switch (msg->header.typecookie) { 655 case NGM_KSOCKET_COOKIE: 656 switch (msg->header.cmd) { 657 case NGM_KSOCKET_BIND: 658 { 659 struct sockaddr *const sa 660 = (struct sockaddr *)msg->data; 661 662 /* Sanity check */ 663 if (msg->header.arglen < SADATA_OFFSET 664 || msg->header.arglen < sa->sa_len) 665 ERROUT(EINVAL); 666 if (so == NULL) 667 ERROUT(ENXIO); 668 669 /* Bind */ 670 error = sobind(so, sa, td); 671 break; 672 } 673 case NGM_KSOCKET_LISTEN: 674 { 675 /* Sanity check */ 676 if (msg->header.arglen != sizeof(int32_t)) 677 ERROUT(EINVAL); 678 if (so == NULL) 679 ERROUT(ENXIO); 680 681 /* Listen */ 682 error = solisten(so, *((int32_t *)msg->data), td); 683 break; 684 } 685 686 case NGM_KSOCKET_ACCEPT: 687 { 688 /* Sanity check */ 689 if (msg->header.arglen != 0) 690 ERROUT(EINVAL); 691 if (so == NULL) 692 ERROUT(ENXIO); 693 694 /* Make sure the socket is capable of accepting */ 695 if (!(so->so_options & SO_ACCEPTCONN)) 696 ERROUT(EINVAL); 697 if (priv->flags & KSF_ACCEPTING) 698 ERROUT(EALREADY); 699 700 error = ng_ksocket_check_accept(priv); 701 if (error != 0 && error != EWOULDBLOCK) 702 ERROUT(error); 703 704 /* 705 * If a connection is already complete, take it. 706 * Otherwise let the upcall function deal with 707 * the connection when it comes in. 708 */ 709 priv->response_token = msg->header.token; 710 strcpy(priv->response_addr, raddr); 711 if (error == 0) { 712 ng_ksocket_finish_accept(priv, 713 rptr != NULL ? &resp : NULL); 714 } else 715 priv->flags |= KSF_ACCEPTING; 716 break; 717 } 718 719 case NGM_KSOCKET_CONNECT: 720 { 721 struct sockaddr *const sa 722 = (struct sockaddr *)msg->data; 723 724 /* Sanity check */ 725 if (msg->header.arglen < SADATA_OFFSET 726 || msg->header.arglen < sa->sa_len) 727 ERROUT(EINVAL); 728 if (so == NULL) 729 ERROUT(ENXIO); 730 731 /* Do connect */ 732 if ((so->so_state & SS_ISCONNECTING) != 0) 733 ERROUT(EALREADY); 734 if ((error = soconnect(so, sa, td)) != 0) { 735 so->so_state &= ~SS_ISCONNECTING; 736 ERROUT(error); 737 } 738 if ((so->so_state & SS_ISCONNECTING) != 0) { 739 /* We will notify the sender when we connect */ 740 priv->response_token = msg->header.token; 741 strcpy(priv->response_addr, raddr); 742 priv->flags |= KSF_CONNECTING; 743 ERROUT(EINPROGRESS); 744 } 745 break; 746 } 747 748 case NGM_KSOCKET_GETNAME: 749 case NGM_KSOCKET_GETPEERNAME: 750 { 751 struct sockaddr *sa = NULL; 752 int len; 753 754 /* Sanity check */ 755 if (msg->header.arglen != 0) 756 ERROUT(EINVAL); 757 if (so == NULL) 758 ERROUT(ENXIO); 759 760 /* Get function */ 761 if (msg->header.cmd == NGM_KSOCKET_GETPEERNAME) { 762 if ((so->so_state 763 & (SS_ISCONNECTED|SS_ISCONFIRMING)) == 0) 764 ERROUT(ENOTCONN); 765 error = so_pru_peeraddr(so, &sa); 766 } else 767 error = so_pru_sockaddr(so, &sa); 768 769 /* Get local or peer address */ 770 if (error != 0) 771 goto bail; 772 len = (sa == NULL) ? 0 : sa->sa_len; 773 774 /* Send it back in a response */ 775 NG_MKRESPONSE(resp, msg, len, M_NOWAIT); 776 if (resp == NULL) { 777 error = ENOMEM; 778 goto bail; 779 } 780 bcopy(sa, resp->data, len); 781 782 bail: 783 /* Cleanup */ 784 if (sa != NULL) 785 FREE(sa, M_SONAME); 786 break; 787 } 788 789 case NGM_KSOCKET_GETOPT: 790 { 791 struct ng_ksocket_sockopt *ksopt = 792 (struct ng_ksocket_sockopt *)msg->data; 793 struct sockopt sopt; 794 795 /* Sanity check */ 796 if (msg->header.arglen != sizeof(*ksopt)) 797 ERROUT(EINVAL); 798 if (so == NULL) 799 ERROUT(ENXIO); 800 801 /* Get response with room for option value */ 802 NG_MKRESPONSE(resp, msg, sizeof(*ksopt) 803 + NG_KSOCKET_MAX_OPTLEN, M_NOWAIT); 804 if (resp == NULL) 805 ERROUT(ENOMEM); 806 807 /* Get socket option, and put value in the response */ 808 sopt.sopt_dir = SOPT_GET; 809 sopt.sopt_level = ksopt->level; 810 sopt.sopt_name = ksopt->name; 811 sopt.sopt_td = NULL; 812 sopt.sopt_valsize = NG_KSOCKET_MAX_OPTLEN; 813 ksopt = (struct ng_ksocket_sockopt *)resp->data; 814 sopt.sopt_val = ksopt->value; 815 if ((error = sogetopt(so, &sopt)) != 0) { 816 FREE(resp, M_NETGRAPH); 817 break; 818 } 819 820 /* Set actual value length */ 821 resp->header.arglen = sizeof(*ksopt) 822 + sopt.sopt_valsize; 823 break; 824 } 825 826 case NGM_KSOCKET_SETOPT: 827 { 828 struct ng_ksocket_sockopt *const ksopt = 829 (struct ng_ksocket_sockopt *)msg->data; 830 const int valsize = msg->header.arglen - sizeof(*ksopt); 831 struct sockopt sopt; 832 833 /* Sanity check */ 834 if (valsize < 0) 835 ERROUT(EINVAL); 836 if (so == NULL) 837 ERROUT(ENXIO); 838 839 /* Set socket option */ 840 sopt.sopt_dir = SOPT_SET; 841 sopt.sopt_level = ksopt->level; 842 sopt.sopt_name = ksopt->name; 843 sopt.sopt_val = ksopt->value; 844 sopt.sopt_valsize = valsize; 845 sopt.sopt_td = NULL; 846 error = sosetopt(so, &sopt); 847 break; 848 } 849 850 default: 851 error = EINVAL; 852 break; 853 } 854 break; 855 case NGM_KSOCKET_INTERNAL_COOKIE: 856 switch (msg->header.cmd) { 857 case NGM_KSOCKET_INTERNAL_UPCALL: 858 if (so == NULL) 859 ERROUT(ENXIO); 860 (*priv->so->so_upcall)(so, so->so_upcallarg, M_NOWAIT); 861 break; 862 default: 863 error = EINVAL; 864 break; 865 } 866 break; 867 default: 868 error = EINVAL; 869 break; 870 } 871 if (rptr) 872 *rptr = resp; 873 else if (resp) 874 FREE(resp, M_NETGRAPH); 875 876 done: 877 FREE(msg, M_NETGRAPH); 878 return (error); 879 } 880 881 /* 882 * Receive incoming data on our hook. Send it out the socket. 883 */ 884 static int 885 ng_ksocket_rcvdata(hook_p hook, struct mbuf *m, meta_p meta) 886 { 887 struct thread *td = curthread->td_proc ? curthread : &thread0; /* XXX broken */ 888 const node_p node = hook->node; 889 const priv_p priv = node->private; 890 struct socket *const so = priv->so; 891 struct sockaddr *sa = NULL; 892 int error; 893 894 /* Avoid reentrantly sending on the socket */ 895 if ((priv->flags & KSF_SENDING) != 0) { 896 NG_FREE_DATA(m, meta); 897 return (EDEADLK); 898 } 899 900 /* If any meta info, look for peer socket address */ 901 if (meta != NULL) { 902 struct meta_field_header *field; 903 904 /* Look for peer socket address */ 905 for (field = &meta->options[0]; 906 (caddr_t)field < (caddr_t)meta + meta->used_len; 907 field = (struct meta_field_header *) 908 ((caddr_t)field + field->len)) { 909 if (field->cookie != NGM_KSOCKET_COOKIE 910 || field->type != NG_KSOCKET_META_SOCKADDR) 911 continue; 912 sa = (struct sockaddr *)field->data; 913 break; 914 } 915 } 916 917 /* Send packet */ 918 priv->flags |= KSF_SENDING; 919 error = so_pru_sosend(so, sa, NULL, m, NULL, 0, td); 920 priv->flags &= ~KSF_SENDING; 921 922 /* Clean up and exit */ 923 NG_FREE_META(meta); 924 return (error); 925 } 926 927 /* 928 * Destroy node 929 */ 930 static int 931 ng_ksocket_rmnode(node_p node) 932 { 933 const priv_p priv = node->private; 934 priv_p embryo; 935 936 /* Close our socket (if any) */ 937 if (priv->so != NULL) { 938 priv->so->so_upcall = NULL; 939 priv->so->so_rcv.sb_flags &= ~SB_UPCALL; 940 priv->so->so_snd.sb_flags &= ~SB_UPCALL; 941 soclose(priv->so); 942 priv->so = NULL; 943 } 944 945 /* If we are an embryo, take ourselves out of the parent's list */ 946 if (priv->flags & KSF_EMBRYONIC) { 947 LIST_REMOVE(priv, siblings); 948 priv->flags &= ~KSF_EMBRYONIC; 949 } 950 951 /* Remove any embryonic children we have */ 952 while (!LIST_EMPTY(&priv->embryos)) { 953 embryo = LIST_FIRST(&priv->embryos); 954 ng_rmnode(embryo->node); 955 } 956 957 /* Take down netgraph node */ 958 node->flags |= NG_INVALID; 959 ng_cutlinks(node); 960 ng_unname(node); 961 bzero(priv, sizeof(*priv)); 962 FREE(priv, M_NETGRAPH); 963 node->private = NULL; 964 ng_unref(node); /* let the node escape */ 965 return (0); 966 } 967 968 /* 969 * Hook disconnection 970 */ 971 static int 972 ng_ksocket_disconnect(hook_p hook) 973 { 974 KASSERT(hook->node->numhooks == 0, 975 ("%s: numhooks=%d?", __FUNCTION__, hook->node->numhooks)); 976 ng_rmnode(hook->node); 977 return (0); 978 } 979 980 /************************************************************************ 981 HELPER STUFF 982 ************************************************************************/ 983 984 /* 985 * When incoming data is appended to the socket, we get notified here. 986 * This is also called whenever a significant event occurs for the socket. 987 */ 988 static void 989 ng_ksocket_incoming(struct socket *so, void *arg, int waitflag) 990 { 991 const node_p node = arg; 992 const priv_p priv = node->private; 993 struct mbuf *m; 994 struct ng_mesg *response; 995 struct uio auio; 996 int s, flags, error; 997 998 s = splnet(); 999 1000 /* Sanity check */ 1001 if ((node->flags & NG_INVALID) != 0) { 1002 splx(s); 1003 return; 1004 } 1005 KASSERT(so == priv->so, ("%s: wrong socket", __FUNCTION__)); 1006 1007 /* Check whether a pending connect operation has completed */ 1008 if (priv->flags & KSF_CONNECTING) { 1009 if ((error = so->so_error) != 0) { 1010 so->so_error = 0; 1011 so->so_state &= ~SS_ISCONNECTING; 1012 } 1013 if (!(so->so_state & SS_ISCONNECTING)) { 1014 NG_MKMESSAGE(response, NGM_KSOCKET_COOKIE, 1015 NGM_KSOCKET_CONNECT, sizeof(int32_t), waitflag); 1016 if (response != NULL) { 1017 response->header.flags |= NGF_RESP; 1018 response->header.token = priv->response_token; 1019 *(int32_t *)response->data = error; 1020 /* 1021 * XXX We use ng_queue_msg here because we are 1022 * being called from deep in the bowels of the TCP 1023 * stack. Is this right, or should we let the 1024 * receiver of the message worry about that? 1025 */ 1026 ng_queue_msg(node, response, 1027 priv->response_addr); 1028 } 1029 priv->flags &= ~KSF_CONNECTING; 1030 } 1031 } 1032 1033 /* Check whether a pending accept operation has completed */ 1034 if (priv->flags & KSF_ACCEPTING) { 1035 error = ng_ksocket_check_accept(priv); 1036 if (error != EWOULDBLOCK) 1037 priv->flags &= ~KSF_ACCEPTING; 1038 if (error == 0) 1039 ng_ksocket_finish_accept(priv, NULL); 1040 } 1041 1042 /* 1043 * If we don't have a hook, we must handle data events later. When 1044 * the hook gets created and is connected, this upcall function 1045 * will be called again. 1046 */ 1047 if (priv->hook == NULL) { 1048 splx(s); 1049 return; 1050 } 1051 1052 /* Read and forward available mbuf's */ 1053 auio.uio_td = NULL; 1054 auio.uio_resid = 1000000000; 1055 flags = MSG_DONTWAIT; 1056 while (1) { 1057 struct sockaddr *sa = NULL; 1058 meta_p meta = NULL; 1059 struct mbuf *n; 1060 1061 /* Try to get next packet from socket */ 1062 if ((error = so_pru_soreceive(so, 1063 (so->so_state & SS_ISCONNECTED) ? NULL : &sa, 1064 &auio, &m, (struct mbuf **)0, &flags)) != 0) 1065 break; 1066 1067 /* See if we got anything */ 1068 if (m == NULL) { 1069 if (sa != NULL) 1070 FREE(sa, M_SONAME); 1071 break; 1072 } 1073 1074 /* Don't trust the various socket layers to get the 1075 packet header and length correct (eg. kern/15175) */ 1076 for (n = m, m->m_pkthdr.len = 0; n != NULL; n = n->m_next) 1077 m->m_pkthdr.len += n->m_len; 1078 1079 /* Put peer's socket address (if any) into a meta info blob */ 1080 if (sa != NULL) { 1081 struct meta_field_header *mhead; 1082 u_int len; 1083 1084 len = sizeof(*meta) + sizeof(*mhead) + sa->sa_len; 1085 MALLOC(meta, meta_p, len, M_NETGRAPH, M_NOWAIT); 1086 if (meta == NULL) { 1087 FREE(sa, M_SONAME); 1088 goto sendit; 1089 } 1090 mhead = &meta->options[0]; 1091 bzero(meta, sizeof(*meta)); 1092 bzero(mhead, sizeof(*mhead)); 1093 meta->allocated_len = len; 1094 meta->used_len = len; 1095 mhead->cookie = NGM_KSOCKET_COOKIE; 1096 mhead->type = NG_KSOCKET_META_SOCKADDR; 1097 mhead->len = sizeof(*mhead) + sa->sa_len; 1098 bcopy(sa, mhead->data, sa->sa_len); 1099 FREE(sa, M_SONAME); 1100 } 1101 sendit: /* Forward data with optional peer sockaddr as meta info */ 1102 NG_SEND_DATA(error, priv->hook, m, meta); 1103 } 1104 1105 /* 1106 * If the peer has closed the connection, forward a 0-length mbuf 1107 * to indicate end-of-file. 1108 */ 1109 if (so->so_state & SS_CANTRCVMORE && !(priv->flags & KSF_EOFSEEN)) { 1110 MGETHDR(m, waitflag, MT_DATA); 1111 if (m != NULL) { 1112 m->m_len = m->m_pkthdr.len = 0; 1113 NG_SEND_DATA_ONLY(error, priv->hook, m); 1114 } 1115 priv->flags |= KSF_EOFSEEN; 1116 } 1117 1118 splx(s); 1119 } 1120 1121 /* 1122 * Check for a completed incoming connection and return 0 if one is found. 1123 * Otherwise return the appropriate error code. 1124 */ 1125 static int 1126 ng_ksocket_check_accept(priv_p priv) 1127 { 1128 struct socket *const head = priv->so; 1129 int error; 1130 1131 if ((error = head->so_error) != 0) { 1132 head->so_error = 0; 1133 return error; 1134 } 1135 if (TAILQ_EMPTY(&head->so_comp)) { 1136 if (head->so_state & SS_CANTRCVMORE) 1137 return ECONNABORTED; 1138 return EWOULDBLOCK; 1139 } 1140 return 0; 1141 } 1142 1143 /* 1144 * Handle the first completed incoming connection, assumed to be already 1145 * on the socket's so_comp queue. 1146 */ 1147 static void 1148 ng_ksocket_finish_accept(priv_p priv, struct ng_mesg **rptr) 1149 { 1150 struct socket *const head = priv->so; 1151 struct socket *so; 1152 struct sockaddr *sa = NULL; 1153 struct ng_mesg *resp; 1154 struct ng_ksocket_accept *resp_data; 1155 node_p node2; 1156 priv_p priv2; 1157 int len; 1158 1159 so = TAILQ_FIRST(&head->so_comp); 1160 if (so == NULL) /* Should never happen */ 1161 return; 1162 TAILQ_REMOVE(&head->so_comp, so, so_list); 1163 head->so_qlen--; 1164 1165 /* XXX KNOTE(&head->so_rcv.sb_sel.si_note, 0); */ 1166 1167 so->so_state &= ~SS_COMP; 1168 so->so_state |= SS_NBIO; 1169 so->so_head = NULL; 1170 1171 soaccept(so, &sa); 1172 1173 len = OFFSETOF(struct ng_ksocket_accept, addr); 1174 if (sa != NULL) 1175 len += sa->sa_len; 1176 1177 NG_MKMESSAGE(resp, NGM_KSOCKET_COOKIE, NGM_KSOCKET_ACCEPT, len, 1178 M_NOWAIT); 1179 if (resp == NULL) { 1180 soclose(so); 1181 goto out; 1182 } 1183 resp->header.flags |= NGF_RESP; 1184 resp->header.token = priv->response_token; 1185 1186 /* Clone a ksocket node to wrap the new socket */ 1187 if (ng_ksocket_constructor(&node2) != 0) { 1188 FREE(resp, M_NETGRAPH); 1189 soclose(so); 1190 goto out; 1191 } 1192 priv2 = (priv_p)node2->private; 1193 priv2->so = so; 1194 priv2->flags |= KSF_CLONED | KSF_EMBRYONIC; 1195 1196 /* 1197 * Insert the cloned node into a list of embryonic children 1198 * on the parent node. When a hook is created on the cloned 1199 * node it will be removed from this list. When the parent 1200 * is destroyed it will destroy any embryonic children it has. 1201 */ 1202 LIST_INSERT_HEAD(&priv->embryos, priv2, siblings); 1203 1204 so->so_upcallarg = (caddr_t)node2; 1205 so->so_upcall = ng_ksocket_incoming; 1206 so->so_rcv.sb_flags |= SB_UPCALL; 1207 so->so_snd.sb_flags |= SB_UPCALL; 1208 1209 /* Fill in the response data and send it or return it to the caller */ 1210 resp_data = (struct ng_ksocket_accept *)resp->data; 1211 resp_data->nodeid = node2->ID; 1212 if (sa != NULL) 1213 bcopy(sa, &resp_data->addr, sa->sa_len); 1214 if (rptr != NULL) 1215 *rptr = resp; 1216 else 1217 ng_queue_msg(priv->node, resp, priv->response_addr); 1218 1219 out: 1220 if (sa != NULL) 1221 FREE(sa, M_SONAME); 1222 } 1223 1224 /* 1225 * Parse out either an integer value or an alias. 1226 */ 1227 static int 1228 ng_ksocket_parse(const struct ng_ksocket_alias *aliases, 1229 const char *s, int family) 1230 { 1231 int k, val; 1232 char *eptr; 1233 1234 /* Try aliases */ 1235 for (k = 0; aliases[k].name != NULL; k++) { 1236 if (strcmp(s, aliases[k].name) == 0 1237 && aliases[k].family == family) 1238 return aliases[k].value; 1239 } 1240 1241 /* Try parsing as a number */ 1242 val = (int)strtoul(s, &eptr, 10); 1243 if (val < 0 || *eptr != '\0') 1244 return (-1); 1245 return (val); 1246 } 1247 1248