ng_ksocket.c revision 91406
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: head/sys/netgraph/ng_ksocket.c 91406 2002-02-27 18:32:23Z jhb $ 40 * $Whistle: ng_ksocket.c,v 1.1 1999/11/16 20:04:40 archie Exp $ 41 */ 42 43/* 44 * Kernel socket node type. This node type is basically a kernel-mode 45 * version of a socket... kindof like the reverse of the socket node type. 46 */ 47 48#include <sys/param.h> 49#include <sys/systm.h> 50#include <sys/kernel.h> 51#include <sys/mbuf.h> 52#include <sys/proc.h> 53#include <sys/malloc.h> 54#include <sys/ctype.h> 55#include <sys/protosw.h> 56#include <sys/errno.h> 57#include <sys/socket.h> 58#include <sys/socketvar.h> 59#include <sys/uio.h> 60#include <sys/un.h> 61 62#include <netgraph/ng_message.h> 63#include <netgraph/netgraph.h> 64#include <netgraph/ng_parse.h> 65#include <netgraph/ng_ksocket.h> 66 67#include <netinet/in.h> 68#include <netatalk/at.h> 69 70#ifdef NG_SEPARATE_MALLOC 71MALLOC_DEFINE(M_NETGRAPH_KSOCKET, "netgraph_ksock", "netgraph ksock node "); 72#else 73#define M_NETGRAPH_KSOCKET M_NETGRAPH 74#endif 75 76#define OFFSETOF(s, e) ((char *)&((s *)0)->e - (char *)((s *)0)) 77#define SADATA_OFFSET (OFFSETOF(struct sockaddr, sa_data)) 78 79/* Node private data */ 80struct ng_ksocket_private { 81 node_p node; 82 hook_p hook; 83 struct socket *so; 84 LIST_HEAD(, ng_ksocket_private) embryos; 85 LIST_ENTRY(ng_ksocket_private) siblings; 86 u_int32_t flags; 87 u_int32_t response_token; 88 ng_ID_t response_addr; 89}; 90typedef struct ng_ksocket_private *priv_p; 91 92/* Flags for priv_p */ 93#define KSF_CONNECTING 0x00000001 /* Waiting for connection complete */ 94#define KSF_ACCEPTING 0x00000002 /* Waiting for accept complete */ 95#define KSF_EOFSEEN 0x00000004 /* Have sent 0-length EOF mbuf */ 96#define KSF_CLONED 0x00000008 /* Cloned from an accepting socket */ 97#define KSF_EMBRYONIC 0x00000010 /* Cloned node with no hooks yet */ 98#define KSF_SENDING 0x00000020 /* Sending on socket */ 99 100/* Netgraph node methods */ 101static ng_constructor_t ng_ksocket_constructor; 102static ng_rcvmsg_t ng_ksocket_rcvmsg; 103static ng_shutdown_t ng_ksocket_shutdown; 104static ng_newhook_t ng_ksocket_newhook; 105static ng_rcvdata_t ng_ksocket_rcvdata; 106static ng_connect_t ng_ksocket_connect; 107static ng_disconnect_t ng_ksocket_disconnect; 108 109/* Alias structure */ 110struct ng_ksocket_alias { 111 const char *name; 112 const int value; 113 const int family; 114}; 115 116/* Protocol family aliases */ 117static const struct ng_ksocket_alias ng_ksocket_families[] = { 118 { "local", PF_LOCAL }, 119 { "inet", PF_INET }, 120 { "inet6", PF_INET6 }, 121 { "atalk", PF_APPLETALK }, 122 { "ipx", PF_IPX }, 123 { "atm", PF_ATM }, 124 { NULL, -1 }, 125}; 126 127/* Socket type aliases */ 128static const struct ng_ksocket_alias ng_ksocket_types[] = { 129 { "stream", SOCK_STREAM }, 130 { "dgram", SOCK_DGRAM }, 131 { "raw", SOCK_RAW }, 132 { "rdm", SOCK_RDM }, 133 { "seqpacket", SOCK_SEQPACKET }, 134 { NULL, -1 }, 135}; 136 137/* Protocol aliases */ 138static const struct ng_ksocket_alias ng_ksocket_protos[] = { 139 { "ip", IPPROTO_IP, PF_INET }, 140 { "raw", IPPROTO_RAW, PF_INET }, 141 { "icmp", IPPROTO_ICMP, PF_INET }, 142 { "igmp", IPPROTO_IGMP, PF_INET }, 143 { "tcp", IPPROTO_TCP, PF_INET }, 144 { "udp", IPPROTO_UDP, PF_INET }, 145 { "gre", IPPROTO_GRE, PF_INET }, 146 { "esp", IPPROTO_ESP, PF_INET }, 147 { "ah", IPPROTO_AH, PF_INET }, 148 { "swipe", IPPROTO_SWIPE, PF_INET }, 149 { "encap", IPPROTO_ENCAP, PF_INET }, 150 { "divert", IPPROTO_DIVERT, PF_INET }, 151 { "ddp", ATPROTO_DDP, PF_APPLETALK }, 152 { "aarp", ATPROTO_AARP, PF_APPLETALK }, 153 { NULL, -1 }, 154}; 155 156/* Helper functions */ 157static int ng_ksocket_check_accept(priv_p); 158static void ng_ksocket_finish_accept(priv_p); 159static void ng_ksocket_incoming(struct socket *so, void *arg, int waitflag); 160static int ng_ksocket_parse(const struct ng_ksocket_alias *aliases, 161 const char *s, int family); 162static void ng_ksocket_incoming2(node_p node, hook_p hook, 163 void *arg1, int waitflag); 164 165/************************************************************************ 166 STRUCT SOCKADDR PARSE TYPE 167 ************************************************************************/ 168 169/* Get the length of the data portion of a generic struct sockaddr */ 170static int 171ng_parse_generic_sockdata_getLength(const struct ng_parse_type *type, 172 const u_char *start, const u_char *buf) 173{ 174 const struct sockaddr *sa; 175 176 sa = (const struct sockaddr *)(buf - SADATA_OFFSET); 177 return (sa->sa_len < SADATA_OFFSET) ? 0 : sa->sa_len - SADATA_OFFSET; 178} 179 180/* Type for the variable length data portion of a generic struct sockaddr */ 181static const struct ng_parse_type ng_ksocket_generic_sockdata_type = { 182 &ng_parse_bytearray_type, 183 &ng_parse_generic_sockdata_getLength 184}; 185 186/* Type for a generic struct sockaddr */ 187static const struct ng_parse_struct_info ng_parse_generic_sockaddr_type_info = { 188 { 189 { "len", &ng_parse_uint8_type }, 190 { "family", &ng_parse_uint8_type }, 191 { "data", &ng_ksocket_generic_sockdata_type }, 192 { NULL } 193 } 194}; 195static const struct ng_parse_type ng_ksocket_generic_sockaddr_type = { 196 &ng_parse_struct_type, 197 &ng_parse_generic_sockaddr_type_info 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. */ 203static int 204ng_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)) == NULL) 249 return (EINVAL); 250 pathlen = strlen(path); 251 if (pathlen > SOCK_MAXADDRLEN) { 252 FREE(path, M_NETGRAPH_KSOCKET); 253 return (E2BIG); 254 } 255 if (*buflen < pathoff + pathlen) { 256 FREE(path, M_NETGRAPH_KSOCKET); 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_KSOCKET); 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 */ 316static int 317ng_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 if ((pathtoken = ng_encode_string(pathbuf, pathlen)) == NULL) 335 return (ENOMEM); 336 slen += snprintf(cbuf, cbuflen, "local/%s", pathtoken); 337 FREE(pathtoken, M_NETGRAPH_KSOCKET); 338 if (slen >= cbuflen) 339 return (ERANGE); 340 *off += sun->sun_len; 341 return (0); 342 } 343 344 case PF_INET: 345 { 346 const struct sockaddr_in *sin = (const struct sockaddr_in *)sa; 347 348 slen += snprintf(cbuf, cbuflen, "inet/%d.%d.%d.%d", 349 ((const u_char *)&sin->sin_addr)[0], 350 ((const u_char *)&sin->sin_addr)[1], 351 ((const u_char *)&sin->sin_addr)[2], 352 ((const u_char *)&sin->sin_addr)[3]); 353 if (sin->sin_port != 0) { 354 slen += snprintf(cbuf + strlen(cbuf), 355 cbuflen - strlen(cbuf), ":%d", 356 (u_int)ntohs(sin->sin_port)); 357 } 358 if (slen >= cbuflen) 359 return (ERANGE); 360 *off += sizeof(*sin); 361 return(0); 362 } 363 364#if 0 365 case PF_APPLETALK: /* XXX implement these someday */ 366 case PF_INET6: 367 case PF_IPX: 368#endif 369 370 default: 371 return (*ng_ksocket_generic_sockaddr_type.supertype->unparse) 372 (&ng_ksocket_generic_sockaddr_type, 373 data, off, cbuf, cbuflen); 374 } 375} 376 377/* Parse type for struct sockaddr */ 378static const struct ng_parse_type ng_ksocket_sockaddr_type = { 379 NULL, 380 NULL, 381 NULL, 382 &ng_ksocket_sockaddr_parse, 383 &ng_ksocket_sockaddr_unparse, 384 NULL /* no such thing as a default struct sockaddr */ 385}; 386 387/************************************************************************ 388 STRUCT NG_KSOCKET_SOCKOPT PARSE TYPE 389 ************************************************************************/ 390 391/* Get length of the struct ng_ksocket_sockopt value field, which is the 392 just the excess of the message argument portion over the length of 393 the struct ng_ksocket_sockopt. */ 394static int 395ng_parse_sockoptval_getLength(const struct ng_parse_type *type, 396 const u_char *start, const u_char *buf) 397{ 398 static const int offset = OFFSETOF(struct ng_ksocket_sockopt, value); 399 const struct ng_ksocket_sockopt *sopt; 400 const struct ng_mesg *msg; 401 402 sopt = (const struct ng_ksocket_sockopt *)(buf - offset); 403 msg = (const struct ng_mesg *)((const u_char *)sopt - sizeof(*msg)); 404 return msg->header.arglen - sizeof(*sopt); 405} 406 407/* Parse type for the option value part of a struct ng_ksocket_sockopt 408 XXX Eventually, we should handle the different socket options specially. 409 XXX This would avoid byte order problems, eg an integer value of 1 is 410 XXX going to be "[1]" for little endian or "[3=1]" for big endian. */ 411static const struct ng_parse_type ng_ksocket_sockoptval_type = { 412 &ng_parse_bytearray_type, 413 &ng_parse_sockoptval_getLength 414}; 415 416/* Parse type for struct ng_ksocket_sockopt */ 417static const struct ng_parse_struct_info ng_ksocket_sockopt_type_info 418 = NG_KSOCKET_SOCKOPT_INFO(&ng_ksocket_sockoptval_type); 419static const struct ng_parse_type ng_ksocket_sockopt_type = { 420 &ng_parse_struct_type, 421 &ng_ksocket_sockopt_type_info, 422}; 423 424/* Parse type for struct ng_ksocket_accept */ 425static const struct ng_parse_struct_info ng_ksocket_accept_type_info 426 = NGM_KSOCKET_ACCEPT_INFO; 427static const struct ng_parse_type ng_ksocket_accept_type = { 428 &ng_parse_struct_type, 429 &ng_ksocket_accept_type_info 430}; 431 432/* List of commands and how to convert arguments to/from ASCII */ 433static const struct ng_cmdlist ng_ksocket_cmds[] = { 434 { 435 NGM_KSOCKET_COOKIE, 436 NGM_KSOCKET_BIND, 437 "bind", 438 &ng_ksocket_sockaddr_type, 439 NULL 440 }, 441 { 442 NGM_KSOCKET_COOKIE, 443 NGM_KSOCKET_LISTEN, 444 "listen", 445 &ng_parse_int32_type, 446 NULL 447 }, 448 { 449 NGM_KSOCKET_COOKIE, 450 NGM_KSOCKET_ACCEPT, 451 "accept", 452 NULL, 453 &ng_ksocket_accept_type 454 }, 455 { 456 NGM_KSOCKET_COOKIE, 457 NGM_KSOCKET_CONNECT, 458 "connect", 459 &ng_ksocket_sockaddr_type, 460 &ng_parse_int32_type 461 }, 462 { 463 NGM_KSOCKET_COOKIE, 464 NGM_KSOCKET_GETNAME, 465 "getname", 466 NULL, 467 &ng_ksocket_sockaddr_type 468 }, 469 { 470 NGM_KSOCKET_COOKIE, 471 NGM_KSOCKET_GETPEERNAME, 472 "getpeername", 473 NULL, 474 &ng_ksocket_sockaddr_type 475 }, 476 { 477 NGM_KSOCKET_COOKIE, 478 NGM_KSOCKET_SETOPT, 479 "setopt", 480 &ng_ksocket_sockopt_type, 481 NULL 482 }, 483 { 484 NGM_KSOCKET_COOKIE, 485 NGM_KSOCKET_GETOPT, 486 "getopt", 487 &ng_ksocket_sockopt_type, 488 &ng_ksocket_sockopt_type 489 }, 490 { 0 } 491}; 492 493/* Node type descriptor */ 494static struct ng_type ng_ksocket_typestruct = { 495 NG_ABI_VERSION, 496 NG_KSOCKET_NODE_TYPE, 497 NULL, 498 ng_ksocket_constructor, 499 ng_ksocket_rcvmsg, 500 ng_ksocket_shutdown, 501 ng_ksocket_newhook, 502 NULL, 503 ng_ksocket_connect, 504 ng_ksocket_rcvdata, 505 ng_ksocket_disconnect, 506 ng_ksocket_cmds 507}; 508NETGRAPH_INIT(ksocket, &ng_ksocket_typestruct); 509 510#define ERROUT(x) do { error = (x); goto done; } while (0) 511 512/************************************************************************ 513 NETGRAPH NODE STUFF 514 ************************************************************************/ 515 516/* 517 * Node type constructor 518 * The NODE part is assumed to be all set up. 519 * There is already a reference to the node for us. 520 */ 521static int 522ng_ksocket_constructor(node_p node) 523{ 524 priv_p priv; 525 526 /* Allocate private structure */ 527 MALLOC(priv, priv_p, sizeof(*priv), 528 M_NETGRAPH_KSOCKET, M_NOWAIT | M_ZERO); 529 if (priv == NULL) 530 return (ENOMEM); 531 532 LIST_INIT(&priv->embryos); 533 /* cross link them */ 534 priv->node = node; 535 NG_NODE_SET_PRIVATE(node, priv); 536 537 /* Done */ 538 return (0); 539} 540 541/* 542 * Give our OK for a hook to be added. The hook name is of the 543 * form "<family>/<type>/<proto>" where the three components may 544 * be decimal numbers or else aliases from the above lists. 545 * 546 * Connecting a hook amounts to opening the socket. Disconnecting 547 * the hook closes the socket and destroys the node as well. 548 */ 549static int 550ng_ksocket_newhook(node_p node, hook_p hook, const char *name0) 551{ 552 struct thread *td = curthread ? curthread : &thread0; /* XXX broken */ 553 const priv_p priv = NG_NODE_PRIVATE(node); 554 char *s1, *s2, name[NG_HOOKLEN+1]; 555 int family, type, protocol, error; 556 557 /* Check if we're already connected */ 558 if (priv->hook != NULL) 559 return (EISCONN); 560 561 if (priv->flags & KSF_CLONED) { 562 if (priv->flags & KSF_EMBRYONIC) { 563 /* Remove ourselves from our parent's embryo list */ 564 LIST_REMOVE(priv, siblings); 565 priv->flags &= ~KSF_EMBRYONIC; 566 } 567 } else { 568 /* Extract family, type, and protocol from hook name */ 569 snprintf(name, sizeof(name), "%s", name0); 570 s1 = name; 571 if ((s2 = index(s1, '/')) == NULL) 572 return (EINVAL); 573 *s2++ = '\0'; 574 family = ng_ksocket_parse(ng_ksocket_families, s1, 0); 575 if (family == -1) 576 return (EINVAL); 577 s1 = s2; 578 if ((s2 = index(s1, '/')) == NULL) 579 return (EINVAL); 580 *s2++ = '\0'; 581 type = ng_ksocket_parse(ng_ksocket_types, s1, 0); 582 if (type == -1) 583 return (EINVAL); 584 s1 = s2; 585 protocol = ng_ksocket_parse(ng_ksocket_protos, s1, family); 586 if (protocol == -1) 587 return (EINVAL); 588 589 /* Create the socket */ 590 error = socreate(family, &priv->so, type, protocol, 591 td->td_ucred, td); 592 if (error != 0) 593 return (error); 594 595 /* XXX call soreserve() ? */ 596 597 } 598 599 /* OK */ 600 priv->hook = hook; 601 return(0); 602} 603 604static int 605ng_ksocket_connect(hook_p hook) 606{ 607 node_p node = NG_HOOK_NODE(hook); 608 const priv_p priv = NG_NODE_PRIVATE(node); 609 struct socket *const so = priv->so; 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 * --Original comment-- 619 * On a cloned socket we may have already received one or more 620 * upcalls which we couldn't handle without a hook. Handle 621 * those now. 622 * We cannot call the upcall function directly 623 * from here, because until this function has returned our 624 * hook isn't connected. 625 * 626 * ---meta comment for -current --- 627 * XXX This is dubius. 628 * Upcalls between the time that the hook was 629 * first created and now (on another processesor) will 630 * be earlier on the queue than the request to finalise the hook. 631 * By the time the hook is finalised, 632 * The queued upcalls will have happenned and the code 633 * will have discarded them because of a lack of a hook. 634 * (socket not open). 635 * 636 * This is a bad byproduct of the complicated way in which hooks 637 * are now created (3 daisy chained async events). 638 * 639 * Since we are a netgraph operation 640 * We know that we hold a lock on this node. This forces the 641 * request we make below to be queued rather than implemented 642 * immediatly which will cause the upcall function to be called a bit 643 * later. 644 * However, as we will run any waiting queued operations immediatly 645 * after doing this one, if we have not finalised the other end 646 * of the hook, those queued operations will fail. 647 */ 648 if (priv->flags & KSF_CLONED) { 649 ng_send_fn(node, NULL, &ng_ksocket_incoming2, so, M_NOWAIT); 650 } 651 652 return (0); 653} 654 655/* 656 * Receive a control message 657 */ 658static int 659ng_ksocket_rcvmsg(node_p node, item_p item, hook_p lasthook) 660{ 661 struct thread *td = curthread ? curthread : &thread0; /* XXX broken */ 662 const priv_p priv = NG_NODE_PRIVATE(node); 663 struct socket *const so = priv->so; 664 struct ng_mesg *resp = NULL; 665 int error = 0; 666 struct ng_mesg *msg; 667 ng_ID_t raddr; 668 669 NGI_GET_MSG(item, msg); 670 switch (msg->header.typecookie) { 671 case NGM_KSOCKET_COOKIE: 672 switch (msg->header.cmd) { 673 case NGM_KSOCKET_BIND: 674 { 675 struct sockaddr *const sa 676 = (struct sockaddr *)msg->data; 677 678 /* Sanity check */ 679 if (msg->header.arglen < SADATA_OFFSET 680 || msg->header.arglen < sa->sa_len) 681 ERROUT(EINVAL); 682 if (so == NULL) 683 ERROUT(ENXIO); 684 685 /* Bind */ 686 error = sobind(so, sa, td); 687 break; 688 } 689 case NGM_KSOCKET_LISTEN: 690 { 691 /* Sanity check */ 692 if (msg->header.arglen != sizeof(int32_t)) 693 ERROUT(EINVAL); 694 if (so == NULL) 695 ERROUT(ENXIO); 696 697 /* Listen */ 698 error = solisten(so, *((int32_t *)msg->data), td); 699 break; 700 } 701 702 case NGM_KSOCKET_ACCEPT: 703 { 704 /* Sanity check */ 705 if (msg->header.arglen != 0) 706 ERROUT(EINVAL); 707 if (so == NULL) 708 ERROUT(ENXIO); 709 710 /* Make sure the socket is capable of accepting */ 711 if (!(so->so_options & SO_ACCEPTCONN)) 712 ERROUT(EINVAL); 713 if (priv->flags & KSF_ACCEPTING) 714 ERROUT(EALREADY); 715 716 error = ng_ksocket_check_accept(priv); 717 if (error != 0 && error != EWOULDBLOCK) 718 ERROUT(error); 719 720 /* 721 * If a connection is already complete, take it. 722 * Otherwise let the upcall function deal with 723 * the connection when it comes in. 724 */ 725 priv->response_token = msg->header.token; 726 raddr = priv->response_addr; 727 if (error == 0) { 728 ng_ksocket_finish_accept(priv); 729 } else 730 priv->flags |= KSF_ACCEPTING; 731 break; 732 } 733 734 case NGM_KSOCKET_CONNECT: 735 { 736 struct sockaddr *const sa 737 = (struct sockaddr *)msg->data; 738 739 /* Sanity check */ 740 if (msg->header.arglen < SADATA_OFFSET 741 || msg->header.arglen < sa->sa_len) 742 ERROUT(EINVAL); 743 if (so == NULL) 744 ERROUT(ENXIO); 745 746 /* Do connect */ 747 if ((so->so_state & SS_ISCONNECTING) != 0) 748 ERROUT(EALREADY); 749 if ((error = soconnect(so, sa, td)) != 0) { 750 so->so_state &= ~SS_ISCONNECTING; 751 ERROUT(error); 752 } 753 if ((so->so_state & SS_ISCONNECTING) != 0) 754 /* We will notify the sender when we connect */ 755 priv->response_token = msg->header.token; 756 raddr = priv->response_addr; 757 priv->flags |= KSF_CONNECTING; 758 ERROUT(EINPROGRESS); 759 break; 760 } 761 762 case NGM_KSOCKET_GETNAME: 763 case NGM_KSOCKET_GETPEERNAME: 764 { 765 int (*func)(struct socket *so, struct sockaddr **nam); 766 struct sockaddr *sa = NULL; 767 int len; 768 769 /* Sanity check */ 770 if (msg->header.arglen != 0) 771 ERROUT(EINVAL); 772 if (so == NULL) 773 ERROUT(ENXIO); 774 775 /* Get function */ 776 if (msg->header.cmd == NGM_KSOCKET_GETPEERNAME) { 777 if ((so->so_state 778 & (SS_ISCONNECTED|SS_ISCONFIRMING)) == 0) 779 ERROUT(ENOTCONN); 780 func = so->so_proto->pr_usrreqs->pru_peeraddr; 781 } else 782 func = so->so_proto->pr_usrreqs->pru_sockaddr; 783 784 /* Get local or peer address */ 785 if ((error = (*func)(so, &sa)) != 0) 786 goto bail; 787 len = (sa == NULL) ? 0 : sa->sa_len; 788 789 /* Send it back in a response */ 790 NG_MKRESPONSE(resp, msg, len, M_NOWAIT); 791 if (resp == NULL) { 792 error = ENOMEM; 793 goto bail; 794 } 795 bcopy(sa, resp->data, len); 796 797 bail: 798 /* Cleanup */ 799 if (sa != NULL) 800 FREE(sa, M_SONAME); 801 break; 802 } 803 804 case NGM_KSOCKET_GETOPT: 805 { 806 struct ng_ksocket_sockopt *ksopt = 807 (struct ng_ksocket_sockopt *)msg->data; 808 struct sockopt sopt; 809 810 /* Sanity check */ 811 if (msg->header.arglen != sizeof(*ksopt)) 812 ERROUT(EINVAL); 813 if (so == NULL) 814 ERROUT(ENXIO); 815 816 /* Get response with room for option value */ 817 NG_MKRESPONSE(resp, msg, sizeof(*ksopt) 818 + NG_KSOCKET_MAX_OPTLEN, M_NOWAIT); 819 if (resp == NULL) 820 ERROUT(ENOMEM); 821 822 /* Get socket option, and put value in the response */ 823 sopt.sopt_dir = SOPT_GET; 824 sopt.sopt_level = ksopt->level; 825 sopt.sopt_name = ksopt->name; 826 sopt.sopt_td = NULL; 827 sopt.sopt_valsize = NG_KSOCKET_MAX_OPTLEN; 828 ksopt = (struct ng_ksocket_sockopt *)resp->data; 829 sopt.sopt_val = ksopt->value; 830 if ((error = sogetopt(so, &sopt)) != 0) { 831 NG_FREE_MSG(resp); 832 break; 833 } 834 835 /* Set actual value length */ 836 resp->header.arglen = sizeof(*ksopt) 837 + sopt.sopt_valsize; 838 break; 839 } 840 841 case NGM_KSOCKET_SETOPT: 842 { 843 struct ng_ksocket_sockopt *const ksopt = 844 (struct ng_ksocket_sockopt *)msg->data; 845 const int valsize = msg->header.arglen - sizeof(*ksopt); 846 struct sockopt sopt; 847 848 /* Sanity check */ 849 if (valsize < 0) 850 ERROUT(EINVAL); 851 if (so == NULL) 852 ERROUT(ENXIO); 853 854 /* Set socket option */ 855 sopt.sopt_dir = SOPT_SET; 856 sopt.sopt_level = ksopt->level; 857 sopt.sopt_name = ksopt->name; 858 sopt.sopt_val = ksopt->value; 859 sopt.sopt_valsize = valsize; 860 sopt.sopt_td = NULL; 861 error = sosetopt(so, &sopt); 862 break; 863 } 864 865 default: 866 error = EINVAL; 867 break; 868 } 869 break; 870 default: 871 error = EINVAL; 872 break; 873 } 874done: 875 NG_RESPOND_MSG(error, node, item, resp); 876 NG_FREE_MSG(msg); 877 return (error); 878} 879 880/* 881 * Receive incoming data on our hook. Send it out the socket. 882 */ 883static int 884ng_ksocket_rcvdata(hook_p hook, item_p item) 885{ 886 struct thread *td = curthread ? curthread : &thread0; /* XXX broken */ 887 const node_p node = NG_HOOK_NODE(hook); 888 const priv_p priv = NG_NODE_PRIVATE(node); 889 struct socket *const so = priv->so; 890 struct sockaddr *sa = NULL; 891 meta_p meta; 892 int error; 893 struct mbuf *m; 894 895 /* Avoid reentrantly sending on the socket */ 896 if ((priv->flags & KSF_SENDING) != 0) { 897 NG_FREE_ITEM(item); 898 return (EDEADLK); 899 } 900 901 /* Extract data and meta information */ 902 NGI_GET_M(item, m); 903 NGI_GET_META(item, meta); 904 NG_FREE_ITEM(item); 905 906 /* If any meta info, look for peer socket address */ 907 if (meta != NULL) { 908 struct meta_field_header *field; 909 910 /* Look for peer socket address */ 911 for (field = &meta->options[0]; 912 (caddr_t)field < (caddr_t)meta + meta->used_len; 913 field = (struct meta_field_header *) 914 ((caddr_t)field + field->len)) { 915 if (field->cookie != NGM_KSOCKET_COOKIE 916 || field->type != NG_KSOCKET_META_SOCKADDR) 917 continue; 918 sa = (struct sockaddr *)field->data; 919 break; 920 } 921 } 922 923 /* Send packet */ 924 priv->flags |= KSF_SENDING; 925 error = (*so->so_proto->pr_usrreqs->pru_sosend)(so, sa, 0, m, 0, 0, td); 926 priv->flags &= ~KSF_SENDING; 927 928 /* Clean up and exit */ 929 NG_FREE_META(meta); 930 return (error); 931} 932 933/* 934 * Destroy node 935 */ 936static int 937ng_ksocket_shutdown(node_p node) 938{ 939 const priv_p priv = NG_NODE_PRIVATE(node); 940 priv_p embryo; 941 942 /* Close our socket (if any) */ 943 if (priv->so != NULL) { 944 priv->so->so_upcall = NULL; 945 priv->so->so_rcv.sb_flags &= ~SB_UPCALL; 946 priv->so->so_snd.sb_flags &= ~SB_UPCALL; 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 no-longer "just call" a netgraph node function 990 * from an external asynchronous event. 991 * This is because in doing so you are ignoring the locking on the netgraph 992 * nodes. Instead call your function via 993 * "int ng_send_fn(node_p node, hook_p hook, ng_item_fn *fn, 994 * void *arg1, int arg2);" 995 * this will call the function you chose, but will first do all the 996 * locking rigmarole. Your function MAY only be called at some distant future 997 * time (several millisecs away) so don't give it any arguments 998 * that may be revoked soon (e.g. on your stack). 999 * In this case even the 'so' argument is doubtful. 1000 * While the function request is being processed the node 1001 * has an extra reference and as such will not disappear until 1002 * the request has at least been done, but the 'so' may not be so lucky. 1003 * handle this by checking the validity of the node in the target function 1004 * before dereferencing the socket pointer. 1005 */ 1006 1007static void 1008ng_ksocket_incoming(struct socket *so, void *arg, int waitflag) 1009{ 1010 const node_p node = arg; 1011 1012 ng_send_fn(node, NULL, &ng_ksocket_incoming2, so, waitflag); 1013} 1014 1015 1016/* 1017 * When incoming data is appended to the socket, we get notified here. 1018 * This is also called whenever a significant event occurs for the socket. 1019 * We know that HOOK is NULL. Because of how we were called we know we have a 1020 * lock on this node an are participating inthe netgraph locking. 1021 * Our original caller may have queued this even some time ago and 1022 * we cannot trust that he even still exists. The node however is being 1023 * held with a reference by the queueing code, at least until we finish, 1024 * even if it has been zapped, so first check it's validiy 1025 * before we trust the socket (which was derived from it). 1026 */ 1027static void 1028ng_ksocket_incoming2(node_p node, hook_p hook, void *arg1, int waitflag) 1029{ 1030 struct socket *so = arg1; 1031 const priv_p priv = NG_NODE_PRIVATE(node); 1032 struct mbuf *m; 1033 struct ng_mesg *response; 1034 struct uio auio; 1035 int s, flags, error; 1036 1037 s = splnet(); 1038 1039 /* Sanity check */ 1040 if (NG_NODE_NOT_VALID(node)) { 1041 splx(s); 1042 return; 1043 } 1044 /* so = priv->so; *//* XXX could have derived this like so */ 1045 KASSERT(so == priv->so, ("%s: wrong socket", __func__)); 1046 1047 /* Check whether a pending connect operation has completed */ 1048 if (priv->flags & KSF_CONNECTING) { 1049 if ((error = so->so_error) != 0) { 1050 so->so_error = 0; 1051 so->so_state &= ~SS_ISCONNECTING; 1052 } 1053 if (!(so->so_state & SS_ISCONNECTING)) { 1054 NG_MKMESSAGE(response, NGM_KSOCKET_COOKIE, 1055 NGM_KSOCKET_CONNECT, sizeof(int32_t), waitflag); 1056 if (response != NULL) { 1057 response->header.flags |= NGF_RESP; 1058 response->header.token = priv->response_token; 1059 *(int32_t *)response->data = error; 1060 /* 1061 * send an async "response" message 1062 * to the node that set us up 1063 * (if it still exists) 1064 */ 1065 NG_SEND_MSG_ID(error, node, response, 1066 priv->response_addr, NULL); 1067 } 1068 priv->flags &= ~KSF_CONNECTING; 1069 } 1070 } 1071 1072 /* Check whether a pending accept operation has completed */ 1073 if (priv->flags & KSF_ACCEPTING) { 1074 error = ng_ksocket_check_accept(priv); 1075 if (error != EWOULDBLOCK) 1076 priv->flags &= ~KSF_ACCEPTING; 1077 if (error == 0) 1078 ng_ksocket_finish_accept(priv); 1079 } 1080 1081 /* 1082 * If we don't have a hook, we must handle data events later. When 1083 * the hook gets created and is connected, this upcall function 1084 * will be called again. 1085 */ 1086 if (priv->hook == NULL) { 1087 splx(s); 1088 return; 1089 } 1090 1091 /* Read and forward available mbuf's */ 1092 auio.uio_td = NULL; 1093 auio.uio_resid = 1000000000; 1094 flags = MSG_DONTWAIT; 1095 while (1) { 1096 struct sockaddr *sa = NULL; 1097 meta_p meta = NULL; 1098 struct mbuf *n; 1099 1100 /* Try to get next packet from socket */ 1101 if ((error = (*so->so_proto->pr_usrreqs->pru_soreceive) 1102 (so, (so->so_state & SS_ISCONNECTED) ? NULL : &sa, 1103 &auio, &m, (struct mbuf **)0, &flags)) != 0) 1104 break; 1105 1106 /* See if we got anything */ 1107 if (m == NULL) { 1108 if (sa != NULL) 1109 FREE(sa, M_SONAME); 1110 break; 1111 } 1112 1113 /* Don't trust the various socket layers to get the 1114 packet header and length correct (eg. kern/15175) */ 1115 for (n = m, m->m_pkthdr.len = 0; n != NULL; n = n->m_next) 1116 m->m_pkthdr.len += n->m_len; 1117 1118 /* Put peer's socket address (if any) into a meta info blob */ 1119 if (sa != NULL) { 1120 struct meta_field_header *mhead; 1121 u_int len; 1122 1123 len = sizeof(*meta) + sizeof(*mhead) + sa->sa_len; 1124 MALLOC(meta, meta_p, len, M_NETGRAPH_META, M_NOWAIT); 1125 if (meta == NULL) { 1126 FREE(sa, M_SONAME); 1127 goto sendit; 1128 } 1129 mhead = &meta->options[0]; 1130 bzero(meta, sizeof(*meta)); 1131 bzero(mhead, sizeof(*mhead)); 1132 meta->allocated_len = len; 1133 meta->used_len = len; 1134 mhead->cookie = NGM_KSOCKET_COOKIE; 1135 mhead->type = NG_KSOCKET_META_SOCKADDR; 1136 mhead->len = sizeof(*mhead) + sa->sa_len; 1137 bcopy(sa, mhead->data, sa->sa_len); 1138 FREE(sa, M_SONAME); 1139 } 1140 1141sendit: /* Forward data with optional peer sockaddr as meta info */ 1142 NG_SEND_DATA(error, priv->hook, m, meta); 1143 } 1144 1145 /* 1146 * If the peer has closed the connection, forward a 0-length mbuf 1147 * to indicate end-of-file. 1148 */ 1149 if (so->so_state & SS_CANTRCVMORE && !(priv->flags & KSF_EOFSEEN)) { 1150 MGETHDR(m, waitflag, MT_DATA); 1151 if (m != NULL) { 1152 m->m_len = m->m_pkthdr.len = 0; 1153 NG_SEND_DATA_ONLY(error, priv->hook, m); 1154 } 1155 priv->flags |= KSF_EOFSEEN; 1156 } 1157 splx(s); 1158} 1159 1160/* 1161 * Check for a completed incoming connection and return 0 if one is found. 1162 * Otherwise return the appropriate error code. 1163 */ 1164static int 1165ng_ksocket_check_accept(priv_p priv) 1166{ 1167 struct socket *const head = priv->so; 1168 int error; 1169 1170 if ((error = head->so_error) != 0) { 1171 head->so_error = 0; 1172 return error; 1173 } 1174 if (TAILQ_EMPTY(&head->so_comp)) { 1175 if (head->so_state & SS_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 so = TAILQ_FIRST(&head->so_comp); 1200 if (so == NULL) /* Should never happen */ 1201 return; 1202 TAILQ_REMOVE(&head->so_comp, so, so_list); 1203 head->so_qlen--; 1204 1205 /* XXX KNOTE(&head->so_rcv.sb_sel.si_note, 0); */ 1206 1207 so->so_state &= ~SS_COMP; 1208 so->so_state |= SS_NBIO; 1209 so->so_head = NULL; 1210 1211 soaccept(so, &sa); 1212 1213 len = OFFSETOF(struct ng_ksocket_accept, addr); 1214 if (sa != NULL) 1215 len += sa->sa_len; 1216 1217 NG_MKMESSAGE(resp, NGM_KSOCKET_COOKIE, NGM_KSOCKET_ACCEPT, len, 1218 M_NOWAIT); 1219 if (resp == NULL) { 1220 soclose(so); 1221 goto out; 1222 } 1223 resp->header.flags |= NGF_RESP; 1224 resp->header.token = priv->response_token; 1225 1226 /* Clone a ksocket node to wrap the new socket */ 1227 error = ng_make_node_common(&ng_ksocket_typestruct, &node); 1228 if (error) { 1229 FREE(resp, M_NETGRAPH); 1230 soclose(so); 1231 goto out; 1232 } 1233 1234 if (ng_ksocket_constructor(node) != 0) { 1235 NG_NODE_UNREF(node); 1236 FREE(resp, M_NETGRAPH); 1237 soclose(so); 1238 goto out; 1239 } 1240 1241 priv2 = NG_NODE_PRIVATE(node); 1242 priv2->so = so; 1243 priv2->flags |= KSF_CLONED | KSF_EMBRYONIC; 1244 1245 /* 1246 * Insert the cloned node into a list of embryonic children 1247 * on the parent node. When a hook is created on the cloned 1248 * node it will be removed from this list. When the parent 1249 * is destroyed it will destroy any embryonic children it has. 1250 */ 1251 LIST_INSERT_HEAD(&priv->embryos, priv2, siblings); 1252 1253 so->so_upcallarg = (caddr_t)node; 1254 so->so_upcall = ng_ksocket_incoming; 1255 so->so_rcv.sb_flags |= SB_UPCALL; 1256 so->so_snd.sb_flags |= SB_UPCALL; 1257 1258 /* Fill in the response data and send it or return it to the caller */ 1259 resp_data = (struct ng_ksocket_accept *)resp->data; 1260 resp_data->nodeid = NG_NODE_ID(node); 1261 if (sa != NULL) 1262 bcopy(sa, &resp_data->addr, sa->sa_len); 1263 NG_SEND_MSG_ID(error, node, resp, priv->response_addr, NULL); 1264 1265out: 1266 if (sa != NULL) 1267 FREE(sa, M_SONAME); 1268} 1269 1270/* 1271 * Parse out either an integer value or an alias. 1272 */ 1273static int 1274ng_ksocket_parse(const struct ng_ksocket_alias *aliases, 1275 const char *s, int family) 1276{ 1277 int k, val; 1278 char *eptr; 1279 1280 /* Try aliases */ 1281 for (k = 0; aliases[k].name != NULL; k++) { 1282 if (strcmp(s, aliases[k].name) == 0 1283 && aliases[k].family == family) 1284 return aliases[k].value; 1285 } 1286 1287 /* Try parsing as a number */ 1288 val = (int)strtoul(s, &eptr, 10); 1289 if (val < 0 || *eptr != '\0') 1290 return (-1); 1291 return (val); 1292} 1293 1294