ng_base.c revision 175850
1129198Scognet/* 2129198Scognet * ng_base.c 3139735Simp */ 4129198Scognet 5129198Scognet/*- 6129198Scognet * Copyright (c) 1996-1999 Whistle Communications, Inc. 7129198Scognet * All rights reserved. 8129198Scognet * 9129198Scognet * Subject to the following obligations and disclaimer of warranty, use and 10129198Scognet * redistribution of this software, in source or object code forms, with or 11129198Scognet * without modifications are expressly permitted by Whistle Communications; 12129198Scognet * provided, however, that: 13129198Scognet * 1. Any and all reproductions of the source or object code must include the 14129198Scognet * copyright notice above and the following disclaimer of warranties; and 15129198Scognet * 2. No rights are granted, in any manner or form, to use Whistle 16129198Scognet * Communications, Inc. trademarks, including the mark "WHISTLE 17129198Scognet * COMMUNICATIONS" on advertising, endorsements, or otherwise except as 18129198Scognet * such appears in the above copyright notice or in the software. 19129198Scognet * 20129198Scognet * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND 21129198Scognet * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO 22129198Scognet * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, 23129198Scognet * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF 24129198Scognet * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. 25129198Scognet * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY 26129198Scognet * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS 27129198Scognet * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE. 28129198Scognet * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES 29129198Scognet * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING 30129198Scognet * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, 31129198Scognet * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR 32129198Scognet * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY 33129198Scognet * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 34129198Scognet * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 35129198Scognet * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY 36129198Scognet * OF SUCH DAMAGE. 37129198Scognet * 38129198Scognet * Authors: Julian Elischer <julian@freebsd.org> 39129198Scognet * Archie Cobbs <archie@freebsd.org> 40129198Scognet * 41129198Scognet * $FreeBSD: head/sys/netgraph/ng_base.c 175850 2008-01-31 10:13:04Z mav $ 42129198Scognet * $Whistle: ng_base.c,v 1.39 1999/01/28 23:54:53 julian Exp $ 43129198Scognet */ 44129198Scognet 45129198Scognet/* 46129198Scognet * This file implements the base netgraph code. 47129198Scognet */ 48129198Scognet 49129198Scognet#include <sys/param.h> 50129198Scognet#include <sys/systm.h> 51129198Scognet#include <sys/ctype.h> 52129198Scognet#include <sys/errno.h> 53129198Scognet#include <sys/kdb.h> 54129198Scognet#include <sys/kernel.h> 55129198Scognet#include <sys/ktr.h> 56129198Scognet#include <sys/limits.h> 57129198Scognet#include <sys/malloc.h> 58129198Scognet#include <sys/mbuf.h> 59129198Scognet#include <sys/queue.h> 60129198Scognet#include <sys/sysctl.h> 61129198Scognet#include <sys/syslog.h> 62129198Scognet#include <sys/refcount.h> 63137463Scognet#include <sys/proc.h> 64129198Scognet 65129198Scognet#include <net/netisr.h> 66129198Scognet 67137463Scognet#include <netgraph/ng_message.h> 68129198Scognet#include <netgraph/netgraph.h> 69129198Scognet#include <netgraph/ng_parse.h> 70129198Scognet 71129198ScognetMODULE_VERSION(netgraph, NG_ABI_VERSION); 72129198Scognet 73129198Scognet/* List of all active nodes */ 74129198Scognetstatic LIST_HEAD(, ng_node) ng_nodelist; 75129198Scognetstatic struct mtx ng_nodelist_mtx; 76129198Scognet 77129198Scognet/* Mutex to protect topology events. */ 78129198Scognetstatic struct mtx ng_topo_mtx; 79129198Scognet 80129198Scognet#ifdef NETGRAPH_DEBUG 81129198Scognetstatic struct mtx ngq_mtx; /* protects the queue item list */ 82129198Scognet 83129198Scognetstatic SLIST_HEAD(, ng_node) ng_allnodes; 84129198Scognetstatic LIST_HEAD(, ng_node) ng_freenodes; /* in debug, we never free() them */ 85129198Scognetstatic SLIST_HEAD(, ng_hook) ng_allhooks; 86129198Scognetstatic LIST_HEAD(, ng_hook) ng_freehooks; /* in debug, we never free() them */ 87129198Scognet 88129198Scognetstatic void ng_dumpitems(void); 89129198Scognetstatic void ng_dumpnodes(void); 90129198Scognetstatic void ng_dumphooks(void); 91 92#endif /* NETGRAPH_DEBUG */ 93/* 94 * DEAD versions of the structures. 95 * In order to avoid races, it is sometimes neccesary to point 96 * at SOMETHING even though theoretically, the current entity is 97 * INVALID. Use these to avoid these races. 98 */ 99struct ng_type ng_deadtype = { 100 NG_ABI_VERSION, 101 "dead", 102 NULL, /* modevent */ 103 NULL, /* constructor */ 104 NULL, /* rcvmsg */ 105 NULL, /* shutdown */ 106 NULL, /* newhook */ 107 NULL, /* findhook */ 108 NULL, /* connect */ 109 NULL, /* rcvdata */ 110 NULL, /* disconnect */ 111 NULL, /* cmdlist */ 112}; 113 114struct ng_node ng_deadnode = { 115 "dead", 116 &ng_deadtype, 117 NGF_INVALID, 118 1, /* refs */ 119 0, /* numhooks */ 120 NULL, /* private */ 121 0, /* ID */ 122 LIST_HEAD_INITIALIZER(ng_deadnode.hooks), 123 {}, /* all_nodes list entry */ 124 {}, /* id hashtable list entry */ 125 {}, /* workqueue entry */ 126 { 0, 127 {}, /* should never use! (should hang) */ 128 NULL, 129 &ng_deadnode.nd_input_queue.queue, 130 &ng_deadnode 131 }, 132#ifdef NETGRAPH_DEBUG 133 ND_MAGIC, 134 __FILE__, 135 __LINE__, 136 {NULL} 137#endif /* NETGRAPH_DEBUG */ 138}; 139 140struct ng_hook ng_deadhook = { 141 "dead", 142 NULL, /* private */ 143 HK_INVALID | HK_DEAD, 144 1, /* refs always >= 1 */ 145 0, /* undefined data link type */ 146 &ng_deadhook, /* Peer is self */ 147 &ng_deadnode, /* attached to deadnode */ 148 {}, /* hooks list */ 149 NULL, /* override rcvmsg() */ 150 NULL, /* override rcvdata() */ 151#ifdef NETGRAPH_DEBUG 152 HK_MAGIC, 153 __FILE__, 154 __LINE__, 155 {NULL} 156#endif /* NETGRAPH_DEBUG */ 157}; 158 159/* 160 * END DEAD STRUCTURES 161 */ 162/* List nodes with unallocated work */ 163static TAILQ_HEAD(, ng_node) ng_worklist = TAILQ_HEAD_INITIALIZER(ng_worklist); 164static struct mtx ng_worklist_mtx; /* MUST LOCK NODE FIRST */ 165 166/* List of installed types */ 167static LIST_HEAD(, ng_type) ng_typelist; 168static struct mtx ng_typelist_mtx; 169 170/* Hash related definitions */ 171/* XXX Don't need to initialise them because it's a LIST */ 172#define NG_ID_HASH_SIZE 32 /* most systems wont need even this many */ 173static LIST_HEAD(, ng_node) ng_ID_hash[NG_ID_HASH_SIZE]; 174static struct mtx ng_idhash_mtx; 175/* Method to find a node.. used twice so do it here */ 176#define NG_IDHASH_FN(ID) ((ID) % (NG_ID_HASH_SIZE)) 177#define NG_IDHASH_FIND(ID, node) \ 178 do { \ 179 mtx_assert(&ng_idhash_mtx, MA_OWNED); \ 180 LIST_FOREACH(node, &ng_ID_hash[NG_IDHASH_FN(ID)], \ 181 nd_idnodes) { \ 182 if (NG_NODE_IS_VALID(node) \ 183 && (NG_NODE_ID(node) == ID)) { \ 184 break; \ 185 } \ 186 } \ 187 } while (0) 188 189 190/* Internal functions */ 191static int ng_add_hook(node_p node, const char *name, hook_p * hookp); 192static int ng_generic_msg(node_p here, item_p item, hook_p lasthook); 193static ng_ID_t ng_decodeidname(const char *name); 194static int ngb_mod_event(module_t mod, int event, void *data); 195static void ng_worklist_remove(node_p node); 196static void ngintr(void); 197static int ng_apply_item(node_p node, item_p item, int rw); 198static void ng_flush_input_queue(struct ng_queue * ngq); 199static void ng_setisr(node_p node); 200static node_p ng_ID2noderef(ng_ID_t ID); 201static int ng_con_nodes(item_p item, node_p node, const char *name, 202 node_p node2, const char *name2); 203static int ng_con_part2(node_p node, item_p item, hook_p hook); 204static int ng_con_part3(node_p node, item_p item, hook_p hook); 205static int ng_mkpeer(node_p node, const char *name, 206 const char *name2, char *type); 207 208/* Imported, these used to be externally visible, some may go back. */ 209void ng_destroy_hook(hook_p hook); 210node_p ng_name2noderef(node_p node, const char *name); 211int ng_path2noderef(node_p here, const char *path, 212 node_p *dest, hook_p *lasthook); 213int ng_make_node(const char *type, node_p *nodepp); 214int ng_path_parse(char *addr, char **node, char **path, char **hook); 215void ng_rmnode(node_p node, hook_p dummy1, void *dummy2, int dummy3); 216void ng_unname(node_p node); 217 218 219/* Our own netgraph malloc type */ 220MALLOC_DEFINE(M_NETGRAPH, "netgraph", "netgraph structures and ctrl messages"); 221MALLOC_DEFINE(M_NETGRAPH_HOOK, "netgraph_hook", "netgraph hook structures"); 222MALLOC_DEFINE(M_NETGRAPH_NODE, "netgraph_node", "netgraph node structures"); 223MALLOC_DEFINE(M_NETGRAPH_ITEM, "netgraph_item", "netgraph item structures"); 224MALLOC_DEFINE(M_NETGRAPH_MSG, "netgraph_msg", "netgraph name storage"); 225 226/* Should not be visible outside this file */ 227 228#define _NG_ALLOC_HOOK(hook) \ 229 MALLOC(hook, hook_p, sizeof(*hook), M_NETGRAPH_HOOK, M_NOWAIT | M_ZERO) 230#define _NG_ALLOC_NODE(node) \ 231 MALLOC(node, node_p, sizeof(*node), M_NETGRAPH_NODE, M_NOWAIT | M_ZERO) 232 233#define NG_QUEUE_LOCK_INIT(n) \ 234 mtx_init(&(n)->q_mtx, "ng_node", NULL, MTX_DEF) 235#define NG_QUEUE_LOCK(n) \ 236 mtx_lock(&(n)->q_mtx) 237#define NG_QUEUE_UNLOCK(n) \ 238 mtx_unlock(&(n)->q_mtx) 239#define NG_WORKLIST_LOCK_INIT() \ 240 mtx_init(&ng_worklist_mtx, "ng_worklist", NULL, MTX_DEF) 241#define NG_WORKLIST_LOCK() \ 242 mtx_lock(&ng_worklist_mtx) 243#define NG_WORKLIST_UNLOCK() \ 244 mtx_unlock(&ng_worklist_mtx) 245 246#ifdef NETGRAPH_DEBUG /*----------------------------------------------*/ 247/* 248 * In debug mode: 249 * In an attempt to help track reference count screwups 250 * we do not free objects back to the malloc system, but keep them 251 * in a local cache where we can examine them and keep information safely 252 * after they have been freed. 253 * We use this scheme for nodes and hooks, and to some extent for items. 254 */ 255static __inline hook_p 256ng_alloc_hook(void) 257{ 258 hook_p hook; 259 SLIST_ENTRY(ng_hook) temp; 260 mtx_lock(&ng_nodelist_mtx); 261 hook = LIST_FIRST(&ng_freehooks); 262 if (hook) { 263 LIST_REMOVE(hook, hk_hooks); 264 bcopy(&hook->hk_all, &temp, sizeof(temp)); 265 bzero(hook, sizeof(struct ng_hook)); 266 bcopy(&temp, &hook->hk_all, sizeof(temp)); 267 mtx_unlock(&ng_nodelist_mtx); 268 hook->hk_magic = HK_MAGIC; 269 } else { 270 mtx_unlock(&ng_nodelist_mtx); 271 _NG_ALLOC_HOOK(hook); 272 if (hook) { 273 hook->hk_magic = HK_MAGIC; 274 mtx_lock(&ng_nodelist_mtx); 275 SLIST_INSERT_HEAD(&ng_allhooks, hook, hk_all); 276 mtx_unlock(&ng_nodelist_mtx); 277 } 278 } 279 return (hook); 280} 281 282static __inline node_p 283ng_alloc_node(void) 284{ 285 node_p node; 286 SLIST_ENTRY(ng_node) temp; 287 mtx_lock(&ng_nodelist_mtx); 288 node = LIST_FIRST(&ng_freenodes); 289 if (node) { 290 LIST_REMOVE(node, nd_nodes); 291 bcopy(&node->nd_all, &temp, sizeof(temp)); 292 bzero(node, sizeof(struct ng_node)); 293 bcopy(&temp, &node->nd_all, sizeof(temp)); 294 mtx_unlock(&ng_nodelist_mtx); 295 node->nd_magic = ND_MAGIC; 296 } else { 297 mtx_unlock(&ng_nodelist_mtx); 298 _NG_ALLOC_NODE(node); 299 if (node) { 300 node->nd_magic = ND_MAGIC; 301 mtx_lock(&ng_nodelist_mtx); 302 SLIST_INSERT_HEAD(&ng_allnodes, node, nd_all); 303 mtx_unlock(&ng_nodelist_mtx); 304 } 305 } 306 return (node); 307} 308 309#define NG_ALLOC_HOOK(hook) do { (hook) = ng_alloc_hook(); } while (0) 310#define NG_ALLOC_NODE(node) do { (node) = ng_alloc_node(); } while (0) 311 312 313#define NG_FREE_HOOK(hook) \ 314 do { \ 315 mtx_lock(&ng_nodelist_mtx); \ 316 LIST_INSERT_HEAD(&ng_freehooks, hook, hk_hooks); \ 317 hook->hk_magic = 0; \ 318 mtx_unlock(&ng_nodelist_mtx); \ 319 } while (0) 320 321#define NG_FREE_NODE(node) \ 322 do { \ 323 mtx_lock(&ng_nodelist_mtx); \ 324 LIST_INSERT_HEAD(&ng_freenodes, node, nd_nodes); \ 325 node->nd_magic = 0; \ 326 mtx_unlock(&ng_nodelist_mtx); \ 327 } while (0) 328 329#else /* NETGRAPH_DEBUG */ /*----------------------------------------------*/ 330 331#define NG_ALLOC_HOOK(hook) _NG_ALLOC_HOOK(hook) 332#define NG_ALLOC_NODE(node) _NG_ALLOC_NODE(node) 333 334#define NG_FREE_HOOK(hook) do { FREE((hook), M_NETGRAPH_HOOK); } while (0) 335#define NG_FREE_NODE(node) do { FREE((node), M_NETGRAPH_NODE); } while (0) 336 337#endif /* NETGRAPH_DEBUG */ /*----------------------------------------------*/ 338 339/* Set this to kdb_enter("X") to catch all errors as they occur */ 340#ifndef TRAP_ERROR 341#define TRAP_ERROR() 342#endif 343 344static ng_ID_t nextID = 1; 345 346#ifdef INVARIANTS 347#define CHECK_DATA_MBUF(m) do { \ 348 struct mbuf *n; \ 349 int total; \ 350 \ 351 M_ASSERTPKTHDR(m); \ 352 for (total = 0, n = (m); n != NULL; n = n->m_next) { \ 353 total += n->m_len; \ 354 if (n->m_nextpkt != NULL) \ 355 panic("%s: m_nextpkt", __func__); \ 356 } \ 357 \ 358 if ((m)->m_pkthdr.len != total) { \ 359 panic("%s: %d != %d", \ 360 __func__, (m)->m_pkthdr.len, total); \ 361 } \ 362 } while (0) 363#else 364#define CHECK_DATA_MBUF(m) 365#endif 366 367#define ERROUT(x) do { error = (x); goto done; } while (0) 368 369/************************************************************************ 370 Parse type definitions for generic messages 371************************************************************************/ 372 373/* Handy structure parse type defining macro */ 374#define DEFINE_PARSE_STRUCT_TYPE(lo, up, args) \ 375static const struct ng_parse_struct_field \ 376 ng_ ## lo ## _type_fields[] = NG_GENERIC_ ## up ## _INFO args; \ 377static const struct ng_parse_type ng_generic_ ## lo ## _type = { \ 378 &ng_parse_struct_type, \ 379 &ng_ ## lo ## _type_fields \ 380} 381 382DEFINE_PARSE_STRUCT_TYPE(mkpeer, MKPEER, ()); 383DEFINE_PARSE_STRUCT_TYPE(connect, CONNECT, ()); 384DEFINE_PARSE_STRUCT_TYPE(name, NAME, ()); 385DEFINE_PARSE_STRUCT_TYPE(rmhook, RMHOOK, ()); 386DEFINE_PARSE_STRUCT_TYPE(nodeinfo, NODEINFO, ()); 387DEFINE_PARSE_STRUCT_TYPE(typeinfo, TYPEINFO, ()); 388DEFINE_PARSE_STRUCT_TYPE(linkinfo, LINKINFO, (&ng_generic_nodeinfo_type)); 389 390/* Get length of an array when the length is stored as a 32 bit 391 value immediately preceding the array -- as with struct namelist 392 and struct typelist. */ 393static int 394ng_generic_list_getLength(const struct ng_parse_type *type, 395 const u_char *start, const u_char *buf) 396{ 397 return *((const u_int32_t *)(buf - 4)); 398} 399 400/* Get length of the array of struct linkinfo inside a struct hooklist */ 401static int 402ng_generic_linkinfo_getLength(const struct ng_parse_type *type, 403 const u_char *start, const u_char *buf) 404{ 405 const struct hooklist *hl = (const struct hooklist *)start; 406 407 return hl->nodeinfo.hooks; 408} 409 410/* Array type for a variable length array of struct namelist */ 411static const struct ng_parse_array_info ng_nodeinfoarray_type_info = { 412 &ng_generic_nodeinfo_type, 413 &ng_generic_list_getLength 414}; 415static const struct ng_parse_type ng_generic_nodeinfoarray_type = { 416 &ng_parse_array_type, 417 &ng_nodeinfoarray_type_info 418}; 419 420/* Array type for a variable length array of struct typelist */ 421static const struct ng_parse_array_info ng_typeinfoarray_type_info = { 422 &ng_generic_typeinfo_type, 423 &ng_generic_list_getLength 424}; 425static const struct ng_parse_type ng_generic_typeinfoarray_type = { 426 &ng_parse_array_type, 427 &ng_typeinfoarray_type_info 428}; 429 430/* Array type for array of struct linkinfo in struct hooklist */ 431static const struct ng_parse_array_info ng_generic_linkinfo_array_type_info = { 432 &ng_generic_linkinfo_type, 433 &ng_generic_linkinfo_getLength 434}; 435static const struct ng_parse_type ng_generic_linkinfo_array_type = { 436 &ng_parse_array_type, 437 &ng_generic_linkinfo_array_type_info 438}; 439 440DEFINE_PARSE_STRUCT_TYPE(typelist, TYPELIST, (&ng_generic_nodeinfoarray_type)); 441DEFINE_PARSE_STRUCT_TYPE(hooklist, HOOKLIST, 442 (&ng_generic_nodeinfo_type, &ng_generic_linkinfo_array_type)); 443DEFINE_PARSE_STRUCT_TYPE(listnodes, LISTNODES, 444 (&ng_generic_nodeinfoarray_type)); 445 446/* List of commands and how to convert arguments to/from ASCII */ 447static const struct ng_cmdlist ng_generic_cmds[] = { 448 { 449 NGM_GENERIC_COOKIE, 450 NGM_SHUTDOWN, 451 "shutdown", 452 NULL, 453 NULL 454 }, 455 { 456 NGM_GENERIC_COOKIE, 457 NGM_MKPEER, 458 "mkpeer", 459 &ng_generic_mkpeer_type, 460 NULL 461 }, 462 { 463 NGM_GENERIC_COOKIE, 464 NGM_CONNECT, 465 "connect", 466 &ng_generic_connect_type, 467 NULL 468 }, 469 { 470 NGM_GENERIC_COOKIE, 471 NGM_NAME, 472 "name", 473 &ng_generic_name_type, 474 NULL 475 }, 476 { 477 NGM_GENERIC_COOKIE, 478 NGM_RMHOOK, 479 "rmhook", 480 &ng_generic_rmhook_type, 481 NULL 482 }, 483 { 484 NGM_GENERIC_COOKIE, 485 NGM_NODEINFO, 486 "nodeinfo", 487 NULL, 488 &ng_generic_nodeinfo_type 489 }, 490 { 491 NGM_GENERIC_COOKIE, 492 NGM_LISTHOOKS, 493 "listhooks", 494 NULL, 495 &ng_generic_hooklist_type 496 }, 497 { 498 NGM_GENERIC_COOKIE, 499 NGM_LISTNAMES, 500 "listnames", 501 NULL, 502 &ng_generic_listnodes_type /* same as NGM_LISTNODES */ 503 }, 504 { 505 NGM_GENERIC_COOKIE, 506 NGM_LISTNODES, 507 "listnodes", 508 NULL, 509 &ng_generic_listnodes_type 510 }, 511 { 512 NGM_GENERIC_COOKIE, 513 NGM_LISTTYPES, 514 "listtypes", 515 NULL, 516 &ng_generic_typeinfo_type 517 }, 518 { 519 NGM_GENERIC_COOKIE, 520 NGM_TEXT_CONFIG, 521 "textconfig", 522 NULL, 523 &ng_parse_string_type 524 }, 525 { 526 NGM_GENERIC_COOKIE, 527 NGM_TEXT_STATUS, 528 "textstatus", 529 NULL, 530 &ng_parse_string_type 531 }, 532 { 533 NGM_GENERIC_COOKIE, 534 NGM_ASCII2BINARY, 535 "ascii2binary", 536 &ng_parse_ng_mesg_type, 537 &ng_parse_ng_mesg_type 538 }, 539 { 540 NGM_GENERIC_COOKIE, 541 NGM_BINARY2ASCII, 542 "binary2ascii", 543 &ng_parse_ng_mesg_type, 544 &ng_parse_ng_mesg_type 545 }, 546 { 0 } 547}; 548 549/************************************************************************ 550 Node routines 551************************************************************************/ 552 553/* 554 * Instantiate a node of the requested type 555 */ 556int 557ng_make_node(const char *typename, node_p *nodepp) 558{ 559 struct ng_type *type; 560 int error; 561 562 /* Check that the type makes sense */ 563 if (typename == NULL) { 564 TRAP_ERROR(); 565 return (EINVAL); 566 } 567 568 /* Locate the node type. If we fail we return. Do not try to load 569 * module. 570 */ 571 if ((type = ng_findtype(typename)) == NULL) 572 return (ENXIO); 573 574 /* 575 * If we have a constructor, then make the node and 576 * call the constructor to do type specific initialisation. 577 */ 578 if (type->constructor != NULL) { 579 if ((error = ng_make_node_common(type, nodepp)) == 0) { 580 if ((error = ((*type->constructor)(*nodepp)) != 0)) { 581 NG_NODE_UNREF(*nodepp); 582 } 583 } 584 } else { 585 /* 586 * Node has no constructor. We cannot ask for one 587 * to be made. It must be brought into existence by 588 * some external agency. The external agency should 589 * call ng_make_node_common() directly to get the 590 * netgraph part initialised. 591 */ 592 TRAP_ERROR(); 593 error = EINVAL; 594 } 595 return (error); 596} 597 598/* 599 * Generic node creation. Called by node initialisation for externally 600 * instantiated nodes (e.g. hardware, sockets, etc ). 601 * The returned node has a reference count of 1. 602 */ 603int 604ng_make_node_common(struct ng_type *type, node_p *nodepp) 605{ 606 node_p node; 607 608 /* Require the node type to have been already installed */ 609 if (ng_findtype(type->name) == NULL) { 610 TRAP_ERROR(); 611 return (EINVAL); 612 } 613 614 /* Make a node and try attach it to the type */ 615 NG_ALLOC_NODE(node); 616 if (node == NULL) { 617 TRAP_ERROR(); 618 return (ENOMEM); 619 } 620 node->nd_type = type; 621 NG_NODE_REF(node); /* note reference */ 622 type->refs++; 623 624 NG_QUEUE_LOCK_INIT(&node->nd_input_queue); 625 node->nd_input_queue.queue = NULL; 626 node->nd_input_queue.last = &node->nd_input_queue.queue; 627 node->nd_input_queue.q_flags = 0; 628 node->nd_input_queue.q_node = node; 629 630 /* Initialize hook list for new node */ 631 LIST_INIT(&node->nd_hooks); 632 633 /* Link us into the node linked list */ 634 mtx_lock(&ng_nodelist_mtx); 635 LIST_INSERT_HEAD(&ng_nodelist, node, nd_nodes); 636 mtx_unlock(&ng_nodelist_mtx); 637 638 639 /* get an ID and put us in the hash chain */ 640 mtx_lock(&ng_idhash_mtx); 641 for (;;) { /* wrap protection, even if silly */ 642 node_p node2 = NULL; 643 node->nd_ID = nextID++; /* 137/second for 1 year before wrap */ 644 645 /* Is there a problem with the new number? */ 646 NG_IDHASH_FIND(node->nd_ID, node2); /* already taken? */ 647 if ((node->nd_ID != 0) && (node2 == NULL)) { 648 break; 649 } 650 } 651 LIST_INSERT_HEAD(&ng_ID_hash[NG_IDHASH_FN(node->nd_ID)], 652 node, nd_idnodes); 653 mtx_unlock(&ng_idhash_mtx); 654 655 /* Done */ 656 *nodepp = node; 657 return (0); 658} 659 660/* 661 * Forceably start the shutdown process on a node. Either call 662 * its shutdown method, or do the default shutdown if there is 663 * no type-specific method. 664 * 665 * We can only be called from a shutdown message, so we know we have 666 * a writer lock, and therefore exclusive access. It also means 667 * that we should not be on the work queue, but we check anyhow. 668 * 669 * Persistent node types must have a type-specific method which 670 * allocates a new node in which case, this one is irretrievably going away, 671 * or cleans up anything it needs, and just makes the node valid again, 672 * in which case we allow the node to survive. 673 * 674 * XXX We need to think of how to tell a persistent node that we 675 * REALLY need to go away because the hardware has gone or we 676 * are rebooting.... etc. 677 */ 678void 679ng_rmnode(node_p node, hook_p dummy1, void *dummy2, int dummy3) 680{ 681 hook_p hook; 682 683 /* Check if it's already shutting down */ 684 if ((node->nd_flags & NGF_CLOSING) != 0) 685 return; 686 687 if (node == &ng_deadnode) { 688 printf ("shutdown called on deadnode\n"); 689 return; 690 } 691 692 /* Add an extra reference so it doesn't go away during this */ 693 NG_NODE_REF(node); 694 695 /* 696 * Mark it invalid so any newcomers know not to try use it 697 * Also add our own mark so we can't recurse 698 * note that NGF_INVALID does not do this as it's also set during 699 * creation 700 */ 701 node->nd_flags |= NGF_INVALID|NGF_CLOSING; 702 703 /* If node has its pre-shutdown method, then call it first*/ 704 if (node->nd_type && node->nd_type->close) 705 (*node->nd_type->close)(node); 706 707 /* Notify all remaining connected nodes to disconnect */ 708 while ((hook = LIST_FIRST(&node->nd_hooks)) != NULL) 709 ng_destroy_hook(hook); 710 711 /* 712 * Drain the input queue forceably. 713 * it has no hooks so what's it going to do, bleed on someone? 714 * Theoretically we came here from a queue entry that was added 715 * Just before the queue was closed, so it should be empty anyway. 716 * Also removes us from worklist if needed. 717 */ 718 ng_flush_input_queue(&node->nd_input_queue); 719 720 /* Ask the type if it has anything to do in this case */ 721 if (node->nd_type && node->nd_type->shutdown) { 722 (*node->nd_type->shutdown)(node); 723 if (NG_NODE_IS_VALID(node)) { 724 /* 725 * Well, blow me down if the node code hasn't declared 726 * that it doesn't want to die. 727 * Presumably it is a persistant node. 728 * If we REALLY want it to go away, 729 * e.g. hardware going away, 730 * Our caller should set NGF_REALLY_DIE in nd_flags. 731 */ 732 node->nd_flags &= ~(NGF_INVALID|NGF_CLOSING); 733 NG_NODE_UNREF(node); /* Assume they still have theirs */ 734 return; 735 } 736 } else { /* do the default thing */ 737 NG_NODE_UNREF(node); 738 } 739 740 ng_unname(node); /* basically a NOP these days */ 741 742 /* 743 * Remove extra reference, possibly the last 744 * Possible other holders of references may include 745 * timeout callouts, but theoretically the node's supposed to 746 * have cancelled them. Possibly hardware dependencies may 747 * force a driver to 'linger' with a reference. 748 */ 749 NG_NODE_UNREF(node); 750} 751 752/* 753 * Remove a reference to the node, possibly the last. 754 * deadnode always acts as it it were the last. 755 */ 756int 757ng_unref_node(node_p node) 758{ 759 int v; 760 761 if (node == &ng_deadnode) { 762 return (0); 763 } 764 765 do { 766 v = node->nd_refs - 1; 767 } while (! atomic_cmpset_int(&node->nd_refs, v + 1, v)); 768 769 if (v == 0) { /* we were the last */ 770 771 mtx_lock(&ng_nodelist_mtx); 772 node->nd_type->refs--; /* XXX maybe should get types lock? */ 773 LIST_REMOVE(node, nd_nodes); 774 mtx_unlock(&ng_nodelist_mtx); 775 776 mtx_lock(&ng_idhash_mtx); 777 LIST_REMOVE(node, nd_idnodes); 778 mtx_unlock(&ng_idhash_mtx); 779 780 mtx_destroy(&node->nd_input_queue.q_mtx); 781 NG_FREE_NODE(node); 782 } 783 return (v); 784} 785 786/************************************************************************ 787 Node ID handling 788************************************************************************/ 789static node_p 790ng_ID2noderef(ng_ID_t ID) 791{ 792 node_p node; 793 mtx_lock(&ng_idhash_mtx); 794 NG_IDHASH_FIND(ID, node); 795 if(node) 796 NG_NODE_REF(node); 797 mtx_unlock(&ng_idhash_mtx); 798 return(node); 799} 800 801ng_ID_t 802ng_node2ID(node_p node) 803{ 804 return (node ? NG_NODE_ID(node) : 0); 805} 806 807/************************************************************************ 808 Node name handling 809************************************************************************/ 810 811/* 812 * Assign a node a name. Once assigned, the name cannot be changed. 813 */ 814int 815ng_name_node(node_p node, const char *name) 816{ 817 int i; 818 node_p node2; 819 820 /* Check the name is valid */ 821 for (i = 0; i < NG_NODESIZ; i++) { 822 if (name[i] == '\0' || name[i] == '.' || name[i] == ':') 823 break; 824 } 825 if (i == 0 || name[i] != '\0') { 826 TRAP_ERROR(); 827 return (EINVAL); 828 } 829 if (ng_decodeidname(name) != 0) { /* valid IDs not allowed here */ 830 TRAP_ERROR(); 831 return (EINVAL); 832 } 833 834 /* Check the name isn't already being used */ 835 if ((node2 = ng_name2noderef(node, name)) != NULL) { 836 NG_NODE_UNREF(node2); 837 TRAP_ERROR(); 838 return (EADDRINUSE); 839 } 840 841 /* copy it */ 842 strlcpy(NG_NODE_NAME(node), name, NG_NODESIZ); 843 844 return (0); 845} 846 847/* 848 * Find a node by absolute name. The name should NOT end with ':' 849 * The name "." means "this node" and "[xxx]" means "the node 850 * with ID (ie, at address) xxx". 851 * 852 * Returns the node if found, else NULL. 853 * Eventually should add something faster than a sequential search. 854 * Note it acquires a reference on the node so you can be sure it's still 855 * there. 856 */ 857node_p 858ng_name2noderef(node_p here, const char *name) 859{ 860 node_p node; 861 ng_ID_t temp; 862 863 /* "." means "this node" */ 864 if (strcmp(name, ".") == 0) { 865 NG_NODE_REF(here); 866 return(here); 867 } 868 869 /* Check for name-by-ID */ 870 if ((temp = ng_decodeidname(name)) != 0) { 871 return (ng_ID2noderef(temp)); 872 } 873 874 /* Find node by name */ 875 mtx_lock(&ng_nodelist_mtx); 876 LIST_FOREACH(node, &ng_nodelist, nd_nodes) { 877 if (NG_NODE_IS_VALID(node) 878 && NG_NODE_HAS_NAME(node) 879 && (strcmp(NG_NODE_NAME(node), name) == 0)) { 880 break; 881 } 882 } 883 if (node) 884 NG_NODE_REF(node); 885 mtx_unlock(&ng_nodelist_mtx); 886 return (node); 887} 888 889/* 890 * Decode an ID name, eg. "[f03034de]". Returns 0 if the 891 * string is not valid, otherwise returns the value. 892 */ 893static ng_ID_t 894ng_decodeidname(const char *name) 895{ 896 const int len = strlen(name); 897 char *eptr; 898 u_long val; 899 900 /* Check for proper length, brackets, no leading junk */ 901 if ((len < 3) 902 || (name[0] != '[') 903 || (name[len - 1] != ']') 904 || (!isxdigit(name[1]))) { 905 return ((ng_ID_t)0); 906 } 907 908 /* Decode number */ 909 val = strtoul(name + 1, &eptr, 16); 910 if ((eptr - name != len - 1) 911 || (val == ULONG_MAX) 912 || (val == 0)) { 913 return ((ng_ID_t)0); 914 } 915 return (ng_ID_t)val; 916} 917 918/* 919 * Remove a name from a node. This should only be called 920 * when shutting down and removing the node. 921 * IF we allow name changing this may be more resurrected. 922 */ 923void 924ng_unname(node_p node) 925{ 926} 927 928/************************************************************************ 929 Hook routines 930 Names are not optional. Hooks are always connected, except for a 931 brief moment within these routines. On invalidation or during creation 932 they are connected to the 'dead' hook. 933************************************************************************/ 934 935/* 936 * Remove a hook reference 937 */ 938void 939ng_unref_hook(hook_p hook) 940{ 941 int v; 942 943 if (hook == &ng_deadhook) { 944 return; 945 } 946 do { 947 v = hook->hk_refs; 948 } while (! atomic_cmpset_int(&hook->hk_refs, v, v - 1)); 949 950 if (v == 1) { /* we were the last */ 951 if (_NG_HOOK_NODE(hook)) { /* it'll probably be ng_deadnode */ 952 _NG_NODE_UNREF((_NG_HOOK_NODE(hook))); 953 hook->hk_node = NULL; 954 } 955 NG_FREE_HOOK(hook); 956 } 957} 958 959/* 960 * Add an unconnected hook to a node. Only used internally. 961 * Assumes node is locked. (XXX not yet true ) 962 */ 963static int 964ng_add_hook(node_p node, const char *name, hook_p *hookp) 965{ 966 hook_p hook; 967 int error = 0; 968 969 /* Check that the given name is good */ 970 if (name == NULL) { 971 TRAP_ERROR(); 972 return (EINVAL); 973 } 974 if (ng_findhook(node, name) != NULL) { 975 TRAP_ERROR(); 976 return (EEXIST); 977 } 978 979 /* Allocate the hook and link it up */ 980 NG_ALLOC_HOOK(hook); 981 if (hook == NULL) { 982 TRAP_ERROR(); 983 return (ENOMEM); 984 } 985 hook->hk_refs = 1; /* add a reference for us to return */ 986 hook->hk_flags = HK_INVALID; 987 hook->hk_peer = &ng_deadhook; /* start off this way */ 988 hook->hk_node = node; 989 NG_NODE_REF(node); /* each hook counts as a reference */ 990 991 /* Set hook name */ 992 strlcpy(NG_HOOK_NAME(hook), name, NG_HOOKSIZ); 993 994 /* 995 * Check if the node type code has something to say about it 996 * If it fails, the unref of the hook will also unref the node. 997 */ 998 if (node->nd_type->newhook != NULL) { 999 if ((error = (*node->nd_type->newhook)(node, hook, name))) { 1000 NG_HOOK_UNREF(hook); /* this frees the hook */ 1001 return (error); 1002 } 1003 } 1004 /* 1005 * The 'type' agrees so far, so go ahead and link it in. 1006 * We'll ask again later when we actually connect the hooks. 1007 */ 1008 LIST_INSERT_HEAD(&node->nd_hooks, hook, hk_hooks); 1009 node->nd_numhooks++; 1010 NG_HOOK_REF(hook); /* one for the node */ 1011 1012 if (hookp) 1013 *hookp = hook; 1014 return (0); 1015} 1016 1017/* 1018 * Find a hook 1019 * 1020 * Node types may supply their own optimized routines for finding 1021 * hooks. If none is supplied, we just do a linear search. 1022 * XXX Possibly we should add a reference to the hook? 1023 */ 1024hook_p 1025ng_findhook(node_p node, const char *name) 1026{ 1027 hook_p hook; 1028 1029 if (node->nd_type->findhook != NULL) 1030 return (*node->nd_type->findhook)(node, name); 1031 LIST_FOREACH(hook, &node->nd_hooks, hk_hooks) { 1032 if (NG_HOOK_IS_VALID(hook) 1033 && (strcmp(NG_HOOK_NAME(hook), name) == 0)) 1034 return (hook); 1035 } 1036 return (NULL); 1037} 1038 1039/* 1040 * Destroy a hook 1041 * 1042 * As hooks are always attached, this really destroys two hooks. 1043 * The one given, and the one attached to it. Disconnect the hooks 1044 * from each other first. We reconnect the peer hook to the 'dead' 1045 * hook so that it can still exist after we depart. We then 1046 * send the peer its own destroy message. This ensures that we only 1047 * interact with the peer's structures when it is locked processing that 1048 * message. We hold a reference to the peer hook so we are guaranteed that 1049 * the peer hook and node are still going to exist until 1050 * we are finished there as the hook holds a ref on the node. 1051 * We run this same code again on the peer hook, but that time it is already 1052 * attached to the 'dead' hook. 1053 * 1054 * This routine is called at all stages of hook creation 1055 * on error detection and must be able to handle any such stage. 1056 */ 1057void 1058ng_destroy_hook(hook_p hook) 1059{ 1060 hook_p peer; 1061 node_p node; 1062 1063 if (hook == &ng_deadhook) { /* better safe than sorry */ 1064 printf("ng_destroy_hook called on deadhook\n"); 1065 return; 1066 } 1067 1068 /* 1069 * Protect divorce process with mutex, to avoid races on 1070 * simultaneous disconnect. 1071 */ 1072 mtx_lock(&ng_topo_mtx); 1073 1074 hook->hk_flags |= HK_INVALID; 1075 1076 peer = NG_HOOK_PEER(hook); 1077 node = NG_HOOK_NODE(hook); 1078 1079 if (peer && (peer != &ng_deadhook)) { 1080 /* 1081 * Set the peer to point to ng_deadhook 1082 * from this moment on we are effectively independent it. 1083 * send it an rmhook message of it's own. 1084 */ 1085 peer->hk_peer = &ng_deadhook; /* They no longer know us */ 1086 hook->hk_peer = &ng_deadhook; /* Nor us, them */ 1087 if (NG_HOOK_NODE(peer) == &ng_deadnode) { 1088 /* 1089 * If it's already divorced from a node, 1090 * just free it. 1091 */ 1092 mtx_unlock(&ng_topo_mtx); 1093 } else { 1094 mtx_unlock(&ng_topo_mtx); 1095 ng_rmhook_self(peer); /* Send it a surprise */ 1096 } 1097 NG_HOOK_UNREF(peer); /* account for peer link */ 1098 NG_HOOK_UNREF(hook); /* account for peer link */ 1099 } else 1100 mtx_unlock(&ng_topo_mtx); 1101 1102 mtx_assert(&ng_topo_mtx, MA_NOTOWNED); 1103 1104 /* 1105 * Remove the hook from the node's list to avoid possible recursion 1106 * in case the disconnection results in node shutdown. 1107 */ 1108 if (node == &ng_deadnode) { /* happens if called from ng_con_nodes() */ 1109 return; 1110 } 1111 LIST_REMOVE(hook, hk_hooks); 1112 node->nd_numhooks--; 1113 if (node->nd_type->disconnect) { 1114 /* 1115 * The type handler may elect to destroy the node so don't 1116 * trust its existence after this point. (except 1117 * that we still hold a reference on it. (which we 1118 * inherrited from the hook we are destroying) 1119 */ 1120 (*node->nd_type->disconnect) (hook); 1121 } 1122 1123 /* 1124 * Note that because we will point to ng_deadnode, the original node 1125 * is not decremented automatically so we do that manually. 1126 */ 1127 _NG_HOOK_NODE(hook) = &ng_deadnode; 1128 NG_NODE_UNREF(node); /* We no longer point to it so adjust count */ 1129 NG_HOOK_UNREF(hook); /* Account for linkage (in list) to node */ 1130} 1131 1132/* 1133 * Take two hooks on a node and merge the connection so that the given node 1134 * is effectively bypassed. 1135 */ 1136int 1137ng_bypass(hook_p hook1, hook_p hook2) 1138{ 1139 if (hook1->hk_node != hook2->hk_node) { 1140 TRAP_ERROR(); 1141 return (EINVAL); 1142 } 1143 hook1->hk_peer->hk_peer = hook2->hk_peer; 1144 hook2->hk_peer->hk_peer = hook1->hk_peer; 1145 1146 hook1->hk_peer = &ng_deadhook; 1147 hook2->hk_peer = &ng_deadhook; 1148 1149 NG_HOOK_UNREF(hook1); 1150 NG_HOOK_UNREF(hook2); 1151 1152 /* XXX If we ever cache methods on hooks update them as well */ 1153 ng_destroy_hook(hook1); 1154 ng_destroy_hook(hook2); 1155 return (0); 1156} 1157 1158/* 1159 * Install a new netgraph type 1160 */ 1161int 1162ng_newtype(struct ng_type *tp) 1163{ 1164 const size_t namelen = strlen(tp->name); 1165 1166 /* Check version and type name fields */ 1167 if ((tp->version != NG_ABI_VERSION) 1168 || (namelen == 0) 1169 || (namelen >= NG_TYPESIZ)) { 1170 TRAP_ERROR(); 1171 if (tp->version != NG_ABI_VERSION) { 1172 printf("Netgraph: Node type rejected. ABI mismatch. Suggest recompile\n"); 1173 } 1174 return (EINVAL); 1175 } 1176 1177 /* Check for name collision */ 1178 if (ng_findtype(tp->name) != NULL) { 1179 TRAP_ERROR(); 1180 return (EEXIST); 1181 } 1182 1183 1184 /* Link in new type */ 1185 mtx_lock(&ng_typelist_mtx); 1186 LIST_INSERT_HEAD(&ng_typelist, tp, types); 1187 tp->refs = 1; /* first ref is linked list */ 1188 mtx_unlock(&ng_typelist_mtx); 1189 return (0); 1190} 1191 1192/* 1193 * unlink a netgraph type 1194 * If no examples exist 1195 */ 1196int 1197ng_rmtype(struct ng_type *tp) 1198{ 1199 /* Check for name collision */ 1200 if (tp->refs != 1) { 1201 TRAP_ERROR(); 1202 return (EBUSY); 1203 } 1204 1205 /* Unlink type */ 1206 mtx_lock(&ng_typelist_mtx); 1207 LIST_REMOVE(tp, types); 1208 mtx_unlock(&ng_typelist_mtx); 1209 return (0); 1210} 1211 1212/* 1213 * Look for a type of the name given 1214 */ 1215struct ng_type * 1216ng_findtype(const char *typename) 1217{ 1218 struct ng_type *type; 1219 1220 mtx_lock(&ng_typelist_mtx); 1221 LIST_FOREACH(type, &ng_typelist, types) { 1222 if (strcmp(type->name, typename) == 0) 1223 break; 1224 } 1225 mtx_unlock(&ng_typelist_mtx); 1226 return (type); 1227} 1228 1229/************************************************************************ 1230 Composite routines 1231************************************************************************/ 1232/* 1233 * Connect two nodes using the specified hooks, using queued functions. 1234 */ 1235static int 1236ng_con_part3(node_p node, item_p item, hook_p hook) 1237{ 1238 int error = 0; 1239 1240 /* 1241 * When we run, we know that the node 'node' is locked for us. 1242 * Our caller has a reference on the hook. 1243 * Our caller has a reference on the node. 1244 * (In this case our caller is ng_apply_item() ). 1245 * The peer hook has a reference on the hook. 1246 * We are all set up except for the final call to the node, and 1247 * the clearing of the INVALID flag. 1248 */ 1249 if (NG_HOOK_NODE(hook) == &ng_deadnode) { 1250 /* 1251 * The node must have been freed again since we last visited 1252 * here. ng_destry_hook() has this effect but nothing else does. 1253 * We should just release our references and 1254 * free anything we can think of. 1255 * Since we know it's been destroyed, and it's our caller 1256 * that holds the references, just return. 1257 */ 1258 ERROUT(ENOENT); 1259 } 1260 if (hook->hk_node->nd_type->connect) { 1261 if ((error = (*hook->hk_node->nd_type->connect) (hook))) { 1262 ng_destroy_hook(hook); /* also zaps peer */ 1263 printf("failed in ng_con_part3()\n"); 1264 ERROUT(error); 1265 } 1266 } 1267 /* 1268 * XXX this is wrong for SMP. Possibly we need 1269 * to separate out 'create' and 'invalid' flags. 1270 * should only set flags on hooks we have locked under our node. 1271 */ 1272 hook->hk_flags &= ~HK_INVALID; 1273done: 1274 NG_FREE_ITEM(item); 1275 return (error); 1276} 1277 1278static int 1279ng_con_part2(node_p node, item_p item, hook_p hook) 1280{ 1281 hook_p peer; 1282 int error = 0; 1283 1284 /* 1285 * When we run, we know that the node 'node' is locked for us. 1286 * Our caller has a reference on the hook. 1287 * Our caller has a reference on the node. 1288 * (In this case our caller is ng_apply_item() ). 1289 * The peer hook has a reference on the hook. 1290 * our node pointer points to the 'dead' node. 1291 * First check the hook name is unique. 1292 * Should not happen because we checked before queueing this. 1293 */ 1294 if (ng_findhook(node, NG_HOOK_NAME(hook)) != NULL) { 1295 TRAP_ERROR(); 1296 ng_destroy_hook(hook); /* should destroy peer too */ 1297 printf("failed in ng_con_part2()\n"); 1298 ERROUT(EEXIST); 1299 } 1300 /* 1301 * Check if the node type code has something to say about it 1302 * If it fails, the unref of the hook will also unref the attached node, 1303 * however since that node is 'ng_deadnode' this will do nothing. 1304 * The peer hook will also be destroyed. 1305 */ 1306 if (node->nd_type->newhook != NULL) { 1307 if ((error = (*node->nd_type->newhook)(node, hook, 1308 hook->hk_name))) { 1309 ng_destroy_hook(hook); /* should destroy peer too */ 1310 printf("failed in ng_con_part2()\n"); 1311 ERROUT(error); 1312 } 1313 } 1314 1315 /* 1316 * The 'type' agrees so far, so go ahead and link it in. 1317 * We'll ask again later when we actually connect the hooks. 1318 */ 1319 hook->hk_node = node; /* just overwrite ng_deadnode */ 1320 NG_NODE_REF(node); /* each hook counts as a reference */ 1321 LIST_INSERT_HEAD(&node->nd_hooks, hook, hk_hooks); 1322 node->nd_numhooks++; 1323 NG_HOOK_REF(hook); /* one for the node */ 1324 1325 /* 1326 * We now have a symmetrical situation, where both hooks have been 1327 * linked to their nodes, the newhook methods have been called 1328 * And the references are all correct. The hooks are still marked 1329 * as invalid, as we have not called the 'connect' methods 1330 * yet. 1331 * We can call the local one immediately as we have the 1332 * node locked, but we need to queue the remote one. 1333 */ 1334 if (hook->hk_node->nd_type->connect) { 1335 if ((error = (*hook->hk_node->nd_type->connect) (hook))) { 1336 ng_destroy_hook(hook); /* also zaps peer */ 1337 printf("failed in ng_con_part2(A)\n"); 1338 ERROUT(error); 1339 } 1340 } 1341 1342 /* 1343 * Acquire topo mutex to avoid race with ng_destroy_hook(). 1344 */ 1345 mtx_lock(&ng_topo_mtx); 1346 peer = hook->hk_peer; 1347 if (peer == &ng_deadhook) { 1348 mtx_unlock(&ng_topo_mtx); 1349 printf("failed in ng_con_part2(B)\n"); 1350 ng_destroy_hook(hook); 1351 ERROUT(ENOENT); 1352 } 1353 mtx_unlock(&ng_topo_mtx); 1354 1355 if ((error = ng_send_fn2(peer->hk_node, peer, item, &ng_con_part3, 1356 NULL, 0, NG_REUSE_ITEM))) { 1357 printf("failed in ng_con_part2(C)\n"); 1358 ng_destroy_hook(hook); /* also zaps peer */ 1359 return (error); /* item was consumed. */ 1360 } 1361 hook->hk_flags &= ~HK_INVALID; /* need both to be able to work */ 1362 return (0); /* item was consumed. */ 1363done: 1364 NG_FREE_ITEM(item); 1365 return (error); 1366} 1367 1368/* 1369 * Connect this node with another node. We assume that this node is 1370 * currently locked, as we are only called from an NGM_CONNECT message. 1371 */ 1372static int 1373ng_con_nodes(item_p item, node_p node, const char *name, 1374 node_p node2, const char *name2) 1375{ 1376 int error; 1377 hook_p hook; 1378 hook_p hook2; 1379 1380 if (ng_findhook(node2, name2) != NULL) { 1381 return(EEXIST); 1382 } 1383 if ((error = ng_add_hook(node, name, &hook))) /* gives us a ref */ 1384 return (error); 1385 /* Allocate the other hook and link it up */ 1386 NG_ALLOC_HOOK(hook2); 1387 if (hook2 == NULL) { 1388 TRAP_ERROR(); 1389 ng_destroy_hook(hook); /* XXX check ref counts so far */ 1390 NG_HOOK_UNREF(hook); /* including our ref */ 1391 return (ENOMEM); 1392 } 1393 hook2->hk_refs = 1; /* start with a reference for us. */ 1394 hook2->hk_flags = HK_INVALID; 1395 hook2->hk_peer = hook; /* Link the two together */ 1396 hook->hk_peer = hook2; 1397 NG_HOOK_REF(hook); /* Add a ref for the peer to each*/ 1398 NG_HOOK_REF(hook2); 1399 hook2->hk_node = &ng_deadnode; 1400 strlcpy(NG_HOOK_NAME(hook2), name2, NG_HOOKSIZ); 1401 1402 /* 1403 * Queue the function above. 1404 * Procesing continues in that function in the lock context of 1405 * the other node. 1406 */ 1407 if ((error = ng_send_fn2(node2, hook2, item, &ng_con_part2, NULL, 0, 1408 NG_NOFLAGS))) { 1409 printf("failed in ng_con_nodes(): %d\n", error); 1410 ng_destroy_hook(hook); /* also zaps peer */ 1411 } 1412 1413 NG_HOOK_UNREF(hook); /* Let each hook go if it wants to */ 1414 NG_HOOK_UNREF(hook2); 1415 return (error); 1416} 1417 1418/* 1419 * Make a peer and connect. 1420 * We assume that the local node is locked. 1421 * The new node probably doesn't need a lock until 1422 * it has a hook, because it cannot really have any work until then, 1423 * but we should think about it a bit more. 1424 * 1425 * The problem may come if the other node also fires up 1426 * some hardware or a timer or some other source of activation, 1427 * also it may already get a command msg via it's ID. 1428 * 1429 * We could use the same method as ng_con_nodes() but we'd have 1430 * to add ability to remove the node when failing. (Not hard, just 1431 * make arg1 point to the node to remove). 1432 * Unless of course we just ignore failure to connect and leave 1433 * an unconnected node? 1434 */ 1435static int 1436ng_mkpeer(node_p node, const char *name, const char *name2, char *type) 1437{ 1438 node_p node2; 1439 hook_p hook1, hook2; 1440 int error; 1441 1442 if ((error = ng_make_node(type, &node2))) { 1443 return (error); 1444 } 1445 1446 if ((error = ng_add_hook(node, name, &hook1))) { /* gives us a ref */ 1447 ng_rmnode(node2, NULL, NULL, 0); 1448 return (error); 1449 } 1450 1451 if ((error = ng_add_hook(node2, name2, &hook2))) { 1452 ng_rmnode(node2, NULL, NULL, 0); 1453 ng_destroy_hook(hook1); 1454 NG_HOOK_UNREF(hook1); 1455 return (error); 1456 } 1457 1458 /* 1459 * Actually link the two hooks together. 1460 */ 1461 hook1->hk_peer = hook2; 1462 hook2->hk_peer = hook1; 1463 1464 /* Each hook is referenced by the other */ 1465 NG_HOOK_REF(hook1); 1466 NG_HOOK_REF(hook2); 1467 1468 /* Give each node the opportunity to veto the pending connection */ 1469 if (hook1->hk_node->nd_type->connect) { 1470 error = (*hook1->hk_node->nd_type->connect) (hook1); 1471 } 1472 1473 if ((error == 0) && hook2->hk_node->nd_type->connect) { 1474 error = (*hook2->hk_node->nd_type->connect) (hook2); 1475 1476 } 1477 1478 /* 1479 * drop the references we were holding on the two hooks. 1480 */ 1481 if (error) { 1482 ng_destroy_hook(hook2); /* also zaps hook1 */ 1483 ng_rmnode(node2, NULL, NULL, 0); 1484 } else { 1485 /* As a last act, allow the hooks to be used */ 1486 hook1->hk_flags &= ~HK_INVALID; 1487 hook2->hk_flags &= ~HK_INVALID; 1488 } 1489 NG_HOOK_UNREF(hook1); 1490 NG_HOOK_UNREF(hook2); 1491 return (error); 1492} 1493 1494/************************************************************************ 1495 Utility routines to send self messages 1496************************************************************************/ 1497 1498/* Shut this node down as soon as everyone is clear of it */ 1499/* Should add arg "immediately" to jump the queue */ 1500int 1501ng_rmnode_self(node_p node) 1502{ 1503 int error; 1504 1505 if (node == &ng_deadnode) 1506 return (0); 1507 node->nd_flags |= NGF_INVALID; 1508 if (node->nd_flags & NGF_CLOSING) 1509 return (0); 1510 1511 error = ng_send_fn(node, NULL, &ng_rmnode, NULL, 0); 1512 return (error); 1513} 1514 1515static void 1516ng_rmhook_part2(node_p node, hook_p hook, void *arg1, int arg2) 1517{ 1518 ng_destroy_hook(hook); 1519 return ; 1520} 1521 1522int 1523ng_rmhook_self(hook_p hook) 1524{ 1525 int error; 1526 node_p node = NG_HOOK_NODE(hook); 1527 1528 if (node == &ng_deadnode) 1529 return (0); 1530 1531 error = ng_send_fn(node, hook, &ng_rmhook_part2, NULL, 0); 1532 return (error); 1533} 1534 1535/*********************************************************************** 1536 * Parse and verify a string of the form: <NODE:><PATH> 1537 * 1538 * Such a string can refer to a specific node or a specific hook 1539 * on a specific node, depending on how you look at it. In the 1540 * latter case, the PATH component must not end in a dot. 1541 * 1542 * Both <NODE:> and <PATH> are optional. The <PATH> is a string 1543 * of hook names separated by dots. This breaks out the original 1544 * string, setting *nodep to "NODE" (or NULL if none) and *pathp 1545 * to "PATH" (or NULL if degenerate). Also, *hookp will point to 1546 * the final hook component of <PATH>, if any, otherwise NULL. 1547 * 1548 * This returns -1 if the path is malformed. The char ** are optional. 1549 ***********************************************************************/ 1550int 1551ng_path_parse(char *addr, char **nodep, char **pathp, char **hookp) 1552{ 1553 char *node, *path, *hook; 1554 int k; 1555 1556 /* 1557 * Extract absolute NODE, if any 1558 */ 1559 for (path = addr; *path && *path != ':'; path++); 1560 if (*path) { 1561 node = addr; /* Here's the NODE */ 1562 *path++ = '\0'; /* Here's the PATH */ 1563 1564 /* Node name must not be empty */ 1565 if (!*node) 1566 return -1; 1567 1568 /* A name of "." is OK; otherwise '.' not allowed */ 1569 if (strcmp(node, ".") != 0) { 1570 for (k = 0; node[k]; k++) 1571 if (node[k] == '.') 1572 return -1; 1573 } 1574 } else { 1575 node = NULL; /* No absolute NODE */ 1576 path = addr; /* Here's the PATH */ 1577 } 1578 1579 /* Snoop for illegal characters in PATH */ 1580 for (k = 0; path[k]; k++) 1581 if (path[k] == ':') 1582 return -1; 1583 1584 /* Check for no repeated dots in PATH */ 1585 for (k = 0; path[k]; k++) 1586 if (path[k] == '.' && path[k + 1] == '.') 1587 return -1; 1588 1589 /* Remove extra (degenerate) dots from beginning or end of PATH */ 1590 if (path[0] == '.') 1591 path++; 1592 if (*path && path[strlen(path) - 1] == '.') 1593 path[strlen(path) - 1] = 0; 1594 1595 /* If PATH has a dot, then we're not talking about a hook */ 1596 if (*path) { 1597 for (hook = path, k = 0; path[k]; k++) 1598 if (path[k] == '.') { 1599 hook = NULL; 1600 break; 1601 } 1602 } else 1603 path = hook = NULL; 1604 1605 /* Done */ 1606 if (nodep) 1607 *nodep = node; 1608 if (pathp) 1609 *pathp = path; 1610 if (hookp) 1611 *hookp = hook; 1612 return (0); 1613} 1614 1615/* 1616 * Given a path, which may be absolute or relative, and a starting node, 1617 * return the destination node. 1618 */ 1619int 1620ng_path2noderef(node_p here, const char *address, 1621 node_p *destp, hook_p *lasthook) 1622{ 1623 char fullpath[NG_PATHSIZ]; 1624 char *nodename, *path, pbuf[2]; 1625 node_p node, oldnode; 1626 char *cp; 1627 hook_p hook = NULL; 1628 1629 /* Initialize */ 1630 if (destp == NULL) { 1631 TRAP_ERROR(); 1632 return EINVAL; 1633 } 1634 *destp = NULL; 1635 1636 /* Make a writable copy of address for ng_path_parse() */ 1637 strncpy(fullpath, address, sizeof(fullpath) - 1); 1638 fullpath[sizeof(fullpath) - 1] = '\0'; 1639 1640 /* Parse out node and sequence of hooks */ 1641 if (ng_path_parse(fullpath, &nodename, &path, NULL) < 0) { 1642 TRAP_ERROR(); 1643 return EINVAL; 1644 } 1645 if (path == NULL) { 1646 pbuf[0] = '.'; /* Needs to be writable */ 1647 pbuf[1] = '\0'; 1648 path = pbuf; 1649 } 1650 1651 /* 1652 * For an absolute address, jump to the starting node. 1653 * Note that this holds a reference on the node for us. 1654 * Don't forget to drop the reference if we don't need it. 1655 */ 1656 if (nodename) { 1657 node = ng_name2noderef(here, nodename); 1658 if (node == NULL) { 1659 TRAP_ERROR(); 1660 return (ENOENT); 1661 } 1662 } else { 1663 if (here == NULL) { 1664 TRAP_ERROR(); 1665 return (EINVAL); 1666 } 1667 node = here; 1668 NG_NODE_REF(node); 1669 } 1670 1671 /* 1672 * Now follow the sequence of hooks 1673 * XXX 1674 * We actually cannot guarantee that the sequence 1675 * is not being demolished as we crawl along it 1676 * without extra-ordinary locking etc. 1677 * So this is a bit dodgy to say the least. 1678 * We can probably hold up some things by holding 1679 * the nodelist mutex for the time of this 1680 * crawl if we wanted.. At least that way we wouldn't have to 1681 * worry about the nodes disappearing, but the hooks would still 1682 * be a problem. 1683 */ 1684 for (cp = path; node != NULL && *cp != '\0'; ) { 1685 char *segment; 1686 1687 /* 1688 * Break out the next path segment. Replace the dot we just 1689 * found with a NUL; "cp" points to the next segment (or the 1690 * NUL at the end). 1691 */ 1692 for (segment = cp; *cp != '\0'; cp++) { 1693 if (*cp == '.') { 1694 *cp++ = '\0'; 1695 break; 1696 } 1697 } 1698 1699 /* Empty segment */ 1700 if (*segment == '\0') 1701 continue; 1702 1703 /* We have a segment, so look for a hook by that name */ 1704 hook = ng_findhook(node, segment); 1705 1706 /* Can't get there from here... */ 1707 if (hook == NULL 1708 || NG_HOOK_PEER(hook) == NULL 1709 || NG_HOOK_NOT_VALID(hook) 1710 || NG_HOOK_NOT_VALID(NG_HOOK_PEER(hook))) { 1711 TRAP_ERROR(); 1712 NG_NODE_UNREF(node); 1713#if 0 1714 printf("hooknotvalid %s %s %d %d %d %d ", 1715 path, 1716 segment, 1717 hook == NULL, 1718 NG_HOOK_PEER(hook) == NULL, 1719 NG_HOOK_NOT_VALID(hook), 1720 NG_HOOK_NOT_VALID(NG_HOOK_PEER(hook))); 1721#endif 1722 return (ENOENT); 1723 } 1724 1725 /* 1726 * Hop on over to the next node 1727 * XXX 1728 * Big race conditions here as hooks and nodes go away 1729 * *** Idea.. store an ng_ID_t in each hook and use that 1730 * instead of the direct hook in this crawl? 1731 */ 1732 oldnode = node; 1733 if ((node = NG_PEER_NODE(hook))) 1734 NG_NODE_REF(node); /* XXX RACE */ 1735 NG_NODE_UNREF(oldnode); /* XXX another race */ 1736 if (NG_NODE_NOT_VALID(node)) { 1737 NG_NODE_UNREF(node); /* XXX more races */ 1738 node = NULL; 1739 } 1740 } 1741 1742 /* If node somehow missing, fail here (probably this is not needed) */ 1743 if (node == NULL) { 1744 TRAP_ERROR(); 1745 return (ENXIO); 1746 } 1747 1748 /* Done */ 1749 *destp = node; 1750 if (lasthook != NULL) 1751 *lasthook = (hook ? NG_HOOK_PEER(hook) : NULL); 1752 return (0); 1753} 1754 1755/***************************************************************\ 1756* Input queue handling. 1757* All activities are submitted to the node via the input queue 1758* which implements a multiple-reader/single-writer gate. 1759* Items which cannot be handled immediately are queued. 1760* 1761* read-write queue locking inline functions * 1762\***************************************************************/ 1763 1764static __inline item_p ng_dequeue(struct ng_queue * ngq, int *rw); 1765static __inline item_p ng_acquire_read(struct ng_queue * ngq, 1766 item_p item); 1767static __inline item_p ng_acquire_write(struct ng_queue * ngq, 1768 item_p item); 1769static __inline void ng_leave_read(struct ng_queue * ngq); 1770static __inline void ng_leave_write(struct ng_queue * ngq); 1771static __inline void ng_queue_rw(struct ng_queue * ngq, 1772 item_p item, int rw); 1773 1774/* 1775 * Definition of the bits fields in the ng_queue flag word. 1776 * Defined here rather than in netgraph.h because no-one should fiddle 1777 * with them. 1778 * 1779 * The ordering here may be important! don't shuffle these. 1780 */ 1781/*- 1782 Safety Barrier--------+ (adjustable to suit taste) (not used yet) 1783 | 1784 V 1785+-------+-------+-------+-------+-------+-------+-------+-------+ 1786 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 1787 | |A|c|t|i|v|e| |R|e|a|d|e|r| |C|o|u|n|t| | | | | | | | | |P|A| 1788 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |O|W| 1789+-------+-------+-------+-------+-------+-------+-------+-------+ 1790 \___________________________ ____________________________/ | | 1791 V | | 1792 [active reader count] | | 1793 | | 1794 Operation Pending -------------------------------+ | 1795 | 1796 Active Writer ---------------------------------------+ 1797 1798 1799*/ 1800#define WRITER_ACTIVE 0x00000001 1801#define OP_PENDING 0x00000002 1802#define READER_INCREMENT 0x00000004 1803#define READER_MASK 0xfffffffc /* Not valid if WRITER_ACTIVE is set */ 1804#define SAFETY_BARRIER 0x00100000 /* 128K items queued should be enough */ 1805 1806/* Defines of more elaborate states on the queue */ 1807/* Mask of bits a new read cares about */ 1808#define NGQ_RMASK (WRITER_ACTIVE|OP_PENDING) 1809 1810/* Mask of bits a new write cares about */ 1811#define NGQ_WMASK (NGQ_RMASK|READER_MASK) 1812 1813/* Test to decide if there is something on the queue. */ 1814#define QUEUE_ACTIVE(QP) ((QP)->q_flags & OP_PENDING) 1815 1816/* How to decide what the next queued item is. */ 1817#define HEAD_IS_READER(QP) NGI_QUEUED_READER((QP)->queue) 1818#define HEAD_IS_WRITER(QP) NGI_QUEUED_WRITER((QP)->queue) /* notused */ 1819 1820/* Read the status to decide if the next item on the queue can now run. */ 1821#define QUEUED_READER_CAN_PROCEED(QP) \ 1822 (((QP)->q_flags & (NGQ_RMASK & ~OP_PENDING)) == 0) 1823#define QUEUED_WRITER_CAN_PROCEED(QP) \ 1824 (((QP)->q_flags & (NGQ_WMASK & ~OP_PENDING)) == 0) 1825 1826/* Is there a chance of getting ANY work off the queue? */ 1827#define NEXT_QUEUED_ITEM_CAN_PROCEED(QP) \ 1828 (QUEUE_ACTIVE(QP) && \ 1829 ((HEAD_IS_READER(QP)) ? QUEUED_READER_CAN_PROCEED(QP) : \ 1830 QUEUED_WRITER_CAN_PROCEED(QP))) 1831 1832 1833#define NGQRW_R 0 1834#define NGQRW_W 1 1835 1836/* 1837 * Taking into account the current state of the queue and node, possibly take 1838 * the next entry off the queue and return it. Return NULL if there was 1839 * nothing we could return, either because there really was nothing there, or 1840 * because the node was in a state where it cannot yet process the next item 1841 * on the queue. 1842 * 1843 * This MUST MUST MUST be called with the mutex held. 1844 */ 1845static __inline item_p 1846ng_dequeue(struct ng_queue *ngq, int *rw) 1847{ 1848 item_p item; 1849 u_int add_arg; 1850 1851 mtx_assert(&ngq->q_mtx, MA_OWNED); 1852 /* 1853 * If there is nothing queued, then just return. 1854 * No point in continuing. 1855 * XXXGL: assert this? 1856 */ 1857 if (!QUEUE_ACTIVE(ngq)) { 1858 CTR4(KTR_NET, "%20s: node [%x] (%p) queue empty; " 1859 "queue flags 0x%lx", __func__, 1860 ngq->q_node->nd_ID, ngq->q_node, ngq->q_flags); 1861 return (NULL); 1862 } 1863 1864 /* 1865 * From here, we can assume there is a head item. 1866 * We need to find out what it is and if it can be dequeued, given 1867 * the current state of the node. 1868 */ 1869 if (HEAD_IS_READER(ngq)) { 1870 if (!QUEUED_READER_CAN_PROCEED(ngq)) { 1871 /* 1872 * It's a reader but we can't use it. 1873 * We are stalled so make sure we don't 1874 * get called again until something changes. 1875 */ 1876 ng_worklist_remove(ngq->q_node); 1877 CTR4(KTR_NET, "%20s: node [%x] (%p) queued reader " 1878 "can't proceed; queue flags 0x%lx", __func__, 1879 ngq->q_node->nd_ID, ngq->q_node, ngq->q_flags); 1880 return (NULL); 1881 } 1882 /* 1883 * Head of queue is a reader and we have no write active. 1884 * We don't care how many readers are already active. 1885 * Add the correct increment for the reader count. 1886 */ 1887 add_arg = READER_INCREMENT; 1888 *rw = NGQRW_R; 1889 } else if (QUEUED_WRITER_CAN_PROCEED(ngq)) { 1890 /* 1891 * There is a pending write, no readers and no active writer. 1892 * This means we can go ahead with the pending writer. Note 1893 * the fact that we now have a writer, ready for when we take 1894 * it off the queue. 1895 * 1896 * We don't need to worry about a possible collision with the 1897 * fasttrack reader. 1898 * 1899 * The fasttrack thread may take a long time to discover that we 1900 * are running so we would have an inconsistent state in the 1901 * flags for a while. Since we ignore the reader count 1902 * entirely when the WRITER_ACTIVE flag is set, this should 1903 * not matter (in fact it is defined that way). If it tests 1904 * the flag before this operation, the OP_PENDING flag 1905 * will make it fail, and if it tests it later, the 1906 * WRITER_ACTIVE flag will do the same. If it is SO slow that 1907 * we have actually completed the operation, and neither flag 1908 * is set by the time that it tests the flags, then it is 1909 * actually ok for it to continue. If it completes and we've 1910 * finished and the read pending is set it still fails. 1911 * 1912 * So we can just ignore it, as long as we can ensure that the 1913 * transition from WRITE_PENDING state to the WRITER_ACTIVE 1914 * state is atomic. 1915 * 1916 * After failing, first it will be held back by the mutex, then 1917 * when it can proceed, it will queue its request, then it 1918 * would arrive at this function. Usually it will have to 1919 * leave empty handed because the ACTIVE WRITER bit will be 1920 * set. 1921 * 1922 * Adjust the flags for the new active writer. 1923 */ 1924 add_arg = WRITER_ACTIVE; 1925 *rw = NGQRW_W; 1926 /* 1927 * We want to write "active writer, no readers " Now go make 1928 * it true. In fact there may be a number in the readers 1929 * count but we know it is not true and will be fixed soon. 1930 * We will fix the flags for the next pending entry in a 1931 * moment. 1932 */ 1933 } else { 1934 /* 1935 * We can't dequeue anything.. return and say so. Probably we 1936 * have a write pending and the readers count is non zero. If 1937 * we got here because a reader hit us just at the wrong 1938 * moment with the fasttrack code, and put us in a strange 1939 * state, then it will be coming through in just a moment, 1940 * (just as soon as we release the mutex) and keep things 1941 * moving. 1942 * Make sure we remove ourselves from the work queue. It 1943 * would be a waste of effort to do all this again. 1944 */ 1945 ng_worklist_remove(ngq->q_node); 1946 CTR4(KTR_NET, "%20s: node [%x] (%p) can't dequeue anything; " 1947 "queue flags 0x%lx", __func__, 1948 ngq->q_node->nd_ID, ngq->q_node, ngq->q_flags); 1949 return (NULL); 1950 } 1951 1952 /* 1953 * Now we dequeue the request (whatever it may be) and correct the 1954 * pending flags and the next and last pointers. 1955 */ 1956 item = ngq->queue; 1957 ngq->queue = item->el_next; 1958 CTR6(KTR_NET, "%20s: node [%x] (%p) dequeued item %p with flags 0x%lx; " 1959 "queue flags 0x%lx", __func__, 1960 ngq->q_node->nd_ID,ngq->q_node, item, item->el_flags, ngq->q_flags); 1961 if (ngq->last == &(item->el_next)) { 1962 /* 1963 * that was the last entry in the queue so set the 'last 1964 * pointer up correctly and make sure the pending flag is 1965 * clear. 1966 */ 1967 add_arg += -OP_PENDING; 1968 ngq->last = &(ngq->queue); 1969 /* 1970 * Whatever flag was set will be cleared and 1971 * the new acive field will be set by the add as well, 1972 * so we don't need to change add_arg. 1973 * But we know we don't need to be on the work list. 1974 */ 1975 atomic_add_long(&ngq->q_flags, add_arg); 1976 ng_worklist_remove(ngq->q_node); 1977 } else { 1978 /* 1979 * Since there is still something on the queue 1980 * we don't need to change the PENDING flag. 1981 */ 1982 atomic_add_long(&ngq->q_flags, add_arg); 1983 /* 1984 * If we see more doable work, make sure we are 1985 * on the work queue. 1986 */ 1987 if (NEXT_QUEUED_ITEM_CAN_PROCEED(ngq)) { 1988 ng_setisr(ngq->q_node); 1989 } 1990 } 1991 CTR6(KTR_NET, "%20s: node [%x] (%p) returning item %p as %s; " 1992 "queue flags 0x%lx", __func__, 1993 ngq->q_node->nd_ID, ngq->q_node, item, *rw ? "WRITER" : "READER" , 1994 ngq->q_flags); 1995 return (item); 1996} 1997 1998/* 1999 * Queue a packet to be picked up by someone else. 2000 * We really don't care who, but we can't or don't want to hang around 2001 * to process it ourselves. We are probably an interrupt routine.. 2002 * If the queue could be run, flag the netisr handler to start. 2003 */ 2004static __inline void 2005ng_queue_rw(struct ng_queue * ngq, item_p item, int rw) 2006{ 2007 mtx_assert(&ngq->q_mtx, MA_OWNED); 2008 2009 if (rw == NGQRW_W) 2010 NGI_SET_WRITER(item); 2011 else 2012 NGI_SET_READER(item); 2013 item->el_next = NULL; /* maybe not needed */ 2014 *ngq->last = item; 2015 CTR5(KTR_NET, "%20s: node [%x] (%p) queued item %p as %s", __func__, 2016 ngq->q_node->nd_ID, ngq->q_node, item, rw ? "WRITER" : "READER" ); 2017 /* 2018 * If it was the first item in the queue then we need to 2019 * set the last pointer and the type flags. 2020 */ 2021 if (ngq->last == &(ngq->queue)) { 2022 atomic_add_long(&ngq->q_flags, OP_PENDING); 2023 CTR3(KTR_NET, "%20s: node [%x] (%p) set OP_PENDING", __func__, 2024 ngq->q_node->nd_ID, ngq->q_node); 2025 } 2026 2027 ngq->last = &(item->el_next); 2028 /* 2029 * We can take the worklist lock with the node locked 2030 * BUT NOT THE REVERSE! 2031 */ 2032 if (NEXT_QUEUED_ITEM_CAN_PROCEED(ngq)) 2033 ng_setisr(ngq->q_node); 2034} 2035 2036 2037/* 2038 * This function 'cheats' in that it first tries to 'grab' the use of the 2039 * node, without going through the mutex. We can do this becasue of the 2040 * semantics of the lock. The semantics include a clause that says that the 2041 * value of the readers count is invalid if the WRITER_ACTIVE flag is set. It 2042 * also says that the WRITER_ACTIVE flag cannot be set if the readers count 2043 * is not zero. Note that this talks about what is valid to SET the 2044 * WRITER_ACTIVE flag, because from the moment it is set, the value if the 2045 * reader count is immaterial, and not valid. The two 'pending' flags have a 2046 * similar effect, in that If they are orthogonal to the two active fields in 2047 * how they are set, but if either is set, the attempted 'grab' need to be 2048 * backed out because there is earlier work, and we maintain ordering in the 2049 * queue. The result of this is that the reader request can try obtain use of 2050 * the node with only a single atomic addition, and without any of the mutex 2051 * overhead. If this fails the operation degenerates to the same as for other 2052 * cases. 2053 * 2054 */ 2055static __inline item_p 2056ng_acquire_read(struct ng_queue *ngq, item_p item) 2057{ 2058 KASSERT(ngq != &ng_deadnode.nd_input_queue, 2059 ("%s: working on deadnode", __func__)); 2060 2061 /* ######### Hack alert ######### */ 2062 atomic_add_long(&ngq->q_flags, READER_INCREMENT); 2063 if ((ngq->q_flags & NGQ_RMASK) == 0) { 2064 /* Successfully grabbed node */ 2065 CTR4(KTR_NET, "%20s: node [%x] (%p) fast acquired item %p", 2066 __func__, ngq->q_node->nd_ID, ngq->q_node, item); 2067 return (item); 2068 } 2069 /* undo the damage if we didn't succeed */ 2070 atomic_subtract_long(&ngq->q_flags, READER_INCREMENT); 2071 2072 /* ######### End Hack alert ######### */ 2073 NG_QUEUE_LOCK(ngq); 2074 /* 2075 * Try again. Another processor (or interrupt for that matter) may 2076 * have removed the last queued item that was stopping us from 2077 * running, between the previous test, and the moment that we took 2078 * the mutex. (Or maybe a writer completed.) 2079 * Even if another fast-track reader hits during this period 2080 * we don't care as multiple readers is OK. 2081 */ 2082 if ((ngq->q_flags & NGQ_RMASK) == 0) { 2083 atomic_add_long(&ngq->q_flags, READER_INCREMENT); 2084 NG_QUEUE_UNLOCK(ngq); 2085 CTR4(KTR_NET, "%20s: node [%x] (%p) slow acquired item %p", 2086 __func__, ngq->q_node->nd_ID, ngq->q_node, item); 2087 return (item); 2088 } 2089 2090 /* 2091 * and queue the request for later. 2092 */ 2093 ng_queue_rw(ngq, item, NGQRW_R); 2094 NG_QUEUE_UNLOCK(ngq); 2095 2096 return (NULL); 2097} 2098 2099static __inline item_p 2100ng_acquire_write(struct ng_queue *ngq, item_p item) 2101{ 2102 KASSERT(ngq != &ng_deadnode.nd_input_queue, 2103 ("%s: working on deadnode", __func__)); 2104 2105restart: 2106 NG_QUEUE_LOCK(ngq); 2107 /* 2108 * If there are no readers, no writer, and no pending packets, then 2109 * we can just go ahead. In all other situations we need to queue the 2110 * request 2111 */ 2112 if ((ngq->q_flags & NGQ_WMASK) == 0) { 2113 /* collision could happen *HERE* */ 2114 atomic_add_long(&ngq->q_flags, WRITER_ACTIVE); 2115 NG_QUEUE_UNLOCK(ngq); 2116 if (ngq->q_flags & READER_MASK) { 2117 /* Collision with fast-track reader */ 2118 atomic_subtract_long(&ngq->q_flags, WRITER_ACTIVE); 2119 goto restart; 2120 } 2121 CTR4(KTR_NET, "%20s: node [%x] (%p) acquired item %p", 2122 __func__, ngq->q_node->nd_ID, ngq->q_node, item); 2123 return (item); 2124 } 2125 2126 /* 2127 * and queue the request for later. 2128 */ 2129 ng_queue_rw(ngq, item, NGQRW_W); 2130 NG_QUEUE_UNLOCK(ngq); 2131 2132 return (NULL); 2133} 2134 2135#if 0 2136static __inline item_p 2137ng_upgrade_write(struct ng_queue *ngq, item_p item) 2138{ 2139 KASSERT(ngq != &ng_deadnode.nd_input_queue, 2140 ("%s: working on deadnode", __func__)); 2141 2142 NGI_SET_WRITER(item); 2143 2144 mtx_lock_spin(&(ngq->q_mtx)); 2145 2146 /* 2147 * There will never be no readers as we are there ourselves. 2148 * Set the WRITER_ACTIVE flags ASAP to block out fast track readers. 2149 * The caller we are running from will call ng_leave_read() 2150 * soon, so we must account for that. We must leave again with the 2151 * READER lock. If we find other readers, then 2152 * queue the request for later. However "later" may be rignt now 2153 * if there are no readers. We don't really care if there are queued 2154 * items as we will bypass them anyhow. 2155 */ 2156 atomic_add_long(&ngq->q_flags, WRITER_ACTIVE - READER_INCREMENT); 2157 if (ngq->q_flags & (NGQ_WMASK & ~OP_PENDING) == WRITER_ACTIVE) { 2158 mtx_unlock_spin(&(ngq->q_mtx)); 2159 2160 /* It's just us, act on the item. */ 2161 /* will NOT drop writer lock when done */ 2162 ng_apply_item(node, item, 0); 2163 2164 /* 2165 * Having acted on the item, atomically 2166 * down grade back to READER and finish up 2167 */ 2168 atomic_add_long(&ngq->q_flags, 2169 READER_INCREMENT - WRITER_ACTIVE); 2170 2171 /* Our caller will call ng_leave_read() */ 2172 return; 2173 } 2174 /* 2175 * It's not just us active, so queue us AT THE HEAD. 2176 * "Why?" I hear you ask. 2177 * Put us at the head of the queue as we've already been 2178 * through it once. If there is nothing else waiting, 2179 * set the correct flags. 2180 */ 2181 if ((item->el_next = ngq->queue) == NULL) { 2182 /* 2183 * Set up the "last" pointer. 2184 * We are the only (and thus last) item 2185 */ 2186 ngq->last = &(item->el_next); 2187 2188 /* We've gone from, 0 to 1 item in the queue */ 2189 atomic_add_long(&ngq->q_flags, OP_PENDING); 2190 2191 CTR3(KTR_NET, "%20s: node [%x] (%p) set OP_PENDING", __func__, 2192 ngq->q_node->nd_ID, ngq->q_node); 2193 }; 2194 ngq->queue = item; 2195 CTR5(KTR_NET, "%20s: node [%x] (%p) requeued item %p as WRITER", 2196 __func__, ngq->q_node->nd_ID, ngq->q_node, item ); 2197 2198 /* Reverse what we did above. That downgrades us back to reader */ 2199 atomic_add_long(&ngq->q_flags, READER_INCREMENT - WRITER_ACTIVE); 2200 if (NEXT_QUEUED_ITEM_CAN_PROCEED(ngq)) 2201 ng_setisr(ngq->q_node); 2202 mtx_unlock_spin(&(ngq->q_mtx)); 2203 2204 return; 2205} 2206 2207#endif 2208 2209static __inline void 2210ng_leave_read(struct ng_queue *ngq) 2211{ 2212 atomic_subtract_long(&ngq->q_flags, READER_INCREMENT); 2213} 2214 2215static __inline void 2216ng_leave_write(struct ng_queue *ngq) 2217{ 2218 atomic_subtract_long(&ngq->q_flags, WRITER_ACTIVE); 2219} 2220 2221static void 2222ng_flush_input_queue(struct ng_queue * ngq) 2223{ 2224 item_p item; 2225 2226 NG_QUEUE_LOCK(ngq); 2227 while (ngq->queue) { 2228 item = ngq->queue; 2229 ngq->queue = item->el_next; 2230 if (ngq->last == &(item->el_next)) { 2231 ngq->last = &(ngq->queue); 2232 atomic_add_long(&ngq->q_flags, -OP_PENDING); 2233 } 2234 NG_QUEUE_UNLOCK(ngq); 2235 2236 /* If the item is supplying a callback, call it with an error */ 2237 if (item->apply != NULL && 2238 refcount_release(&item->apply->refs)) { 2239 (*item->apply->apply)(item->apply->context, ENOENT); 2240 } 2241 NG_FREE_ITEM(item); 2242 NG_QUEUE_LOCK(ngq); 2243 } 2244 /* 2245 * Take us off the work queue if we are there. 2246 * We definately have no work to be done. 2247 */ 2248 ng_worklist_remove(ngq->q_node); 2249 NG_QUEUE_UNLOCK(ngq); 2250} 2251 2252/*********************************************************************** 2253* Externally visible method for sending or queueing messages or data. 2254***********************************************************************/ 2255 2256/* 2257 * The module code should have filled out the item correctly by this stage: 2258 * Common: 2259 * reference to destination node. 2260 * Reference to destination rcv hook if relevant. 2261 * apply pointer must be or NULL or reference valid struct ng_apply_info. 2262 * Data: 2263 * pointer to mbuf 2264 * Control_Message: 2265 * pointer to msg. 2266 * ID of original sender node. (return address) 2267 * Function: 2268 * Function pointer 2269 * void * argument 2270 * integer argument 2271 * 2272 * The nodes have several routines and macros to help with this task: 2273 */ 2274 2275int 2276ng_snd_item(item_p item, int flags) 2277{ 2278 hook_p hook; 2279 node_p node; 2280 int queue, rw; 2281 struct ng_queue *ngq; 2282 int error = 0; 2283 2284 if (item == NULL) { 2285 TRAP_ERROR(); 2286 return (EINVAL); /* failed to get queue element */ 2287 } 2288 2289#ifdef NETGRAPH_DEBUG 2290 _ngi_check(item, __FILE__, __LINE__); 2291#endif 2292 2293 if (item->apply) 2294 refcount_acquire(&item->apply->refs); 2295 2296 node = NGI_NODE(item); 2297 if (node == NULL) { 2298 TRAP_ERROR(); 2299 ERROUT(EINVAL); /* No address */ 2300 } 2301 2302 hook = NGI_HOOK(item); 2303 switch(item->el_flags & NGQF_TYPE) { 2304 case NGQF_DATA: 2305 /* 2306 * DATA MESSAGE 2307 * Delivered to a node via a non-optional hook. 2308 * Both should be present in the item even though 2309 * the node is derivable from the hook. 2310 * References are held on both by the item. 2311 */ 2312 2313 /* Protect nodes from sending NULL pointers 2314 * to each other 2315 */ 2316 if (NGI_M(item) == NULL) 2317 ERROUT(EINVAL); 2318 2319 CHECK_DATA_MBUF(NGI_M(item)); 2320 if (hook == NULL) { 2321 TRAP_ERROR(); 2322 ERROUT(EINVAL); 2323 } 2324 if ((NG_HOOK_NOT_VALID(hook)) 2325 || (NG_NODE_NOT_VALID(NG_HOOK_NODE(hook)))) { 2326 ERROUT(ENOTCONN); 2327 } 2328 break; 2329 case NGQF_MESG: 2330 /* 2331 * CONTROL MESSAGE 2332 * Delivered to a node. 2333 * Hook is optional. 2334 * References are held by the item on the node and 2335 * the hook if it is present. 2336 */ 2337 break; 2338 case NGQF_FN: 2339 case NGQF_FN2: 2340 break; 2341 default: 2342 TRAP_ERROR(); 2343 ERROUT(EINVAL); 2344 } 2345 switch(item->el_flags & NGQF_RW) { 2346 case NGQF_READER: 2347 rw = NGQRW_R; 2348 break; 2349 case NGQF_WRITER: 2350 rw = NGQRW_W; 2351 break; 2352 default: 2353 panic("%s: invalid item flags %lx", __func__, item->el_flags); 2354 } 2355 2356 /* 2357 * If the node specifies single threading, force writer semantics. 2358 * Similarly, the node may say one hook always produces writers. 2359 * These are overrides. 2360 */ 2361 if ((node->nd_flags & NGF_FORCE_WRITER) 2362 || (hook && (hook->hk_flags & HK_FORCE_WRITER))) 2363 rw = NGQRW_W; 2364 2365 /* 2366 * If sender or receiver requests queued delivery or stack usage 2367 * level is dangerous - enqueue message. 2368 */ 2369 queue = 0; 2370 if ((flags & NG_QUEUE) || (hook && (hook->hk_flags & HK_QUEUE))) { 2371 queue = 1; 2372 } 2373#ifdef GET_STACK_USAGE 2374 else { 2375 size_t st, su; 2376 GET_STACK_USAGE(st, su); 2377 su = (su * 128) / st; 2378 if ((su > 100) || 2379 ((su > 64) && ((node->nd_flags & NGF_HI_STACK) || 2380 (hook && (hook->hk_flags & HK_HI_STACK))))) { 2381 queue = 1; 2382 } 2383 } 2384#endif 2385 2386 ngq = &node->nd_input_queue; 2387 if (queue) { 2388 /* Put it on the queue for that node*/ 2389#ifdef NETGRAPH_DEBUG 2390 _ngi_check(item, __FILE__, __LINE__); 2391#endif 2392 NG_QUEUE_LOCK(ngq); 2393 ng_queue_rw(ngq, item, rw); 2394 NG_QUEUE_UNLOCK(ngq); 2395 2396 if (flags & NG_PROGRESS) 2397 return (EINPROGRESS); 2398 else 2399 return (0); 2400 } 2401 2402 /* 2403 * We already decided how we will be queueud or treated. 2404 * Try get the appropriate operating permission. 2405 */ 2406 if (rw == NGQRW_R) 2407 item = ng_acquire_read(ngq, item); 2408 else 2409 item = ng_acquire_write(ngq, item); 2410 2411 2412 if (item == NULL) { 2413 if (flags & NG_PROGRESS) 2414 return (EINPROGRESS); 2415 else 2416 return (0); 2417 } 2418 2419#ifdef NETGRAPH_DEBUG 2420 _ngi_check(item, __FILE__, __LINE__); 2421#endif 2422 2423 NGI_GET_NODE(item, node); /* zaps stored node */ 2424 2425 error = ng_apply_item(node, item, rw); /* drops r/w lock when done */ 2426 2427 /* 2428 * If the node goes away when we remove the reference, 2429 * whatever we just did caused it.. whatever we do, DO NOT 2430 * access the node again! 2431 */ 2432 if (NG_NODE_UNREF(node) == 0) { 2433 return (error); 2434 } 2435 2436 NG_QUEUE_LOCK(ngq); 2437 if (NEXT_QUEUED_ITEM_CAN_PROCEED(ngq)) 2438 ng_setisr(ngq->q_node); 2439 NG_QUEUE_UNLOCK(ngq); 2440 2441 return (error); 2442 2443done: 2444 /* Apply callback. */ 2445 if (item->apply != NULL && refcount_release(&item->apply->refs)) 2446 (*item->apply->apply)(item->apply->context, error); 2447 2448 NG_FREE_ITEM(item); 2449 return (error); 2450} 2451 2452/* 2453 * We have an item that was possibly queued somewhere. 2454 * It should contain all the information needed 2455 * to run it on the appropriate node/hook. 2456 * If there is apply pointer and we own the last reference, call apply(). 2457 */ 2458static int 2459ng_apply_item(node_p node, item_p item, int rw) 2460{ 2461 hook_p hook; 2462 int error = 0; 2463 ng_rcvdata_t *rcvdata; 2464 ng_rcvmsg_t *rcvmsg; 2465 struct ng_apply_info *apply; 2466 2467 NGI_GET_HOOK(item, hook); /* clears stored hook */ 2468#ifdef NETGRAPH_DEBUG 2469 _ngi_check(item, __FILE__, __LINE__); 2470#endif 2471 2472 apply = item->apply; 2473 2474 switch (item->el_flags & NGQF_TYPE) { 2475 case NGQF_DATA: 2476 /* 2477 * Check things are still ok as when we were queued. 2478 */ 2479 if ((hook == NULL) 2480 || NG_HOOK_NOT_VALID(hook) 2481 || NG_NODE_NOT_VALID(node) ) { 2482 error = EIO; 2483 NG_FREE_ITEM(item); 2484 break; 2485 } 2486 /* 2487 * If no receive method, just silently drop it. 2488 * Give preference to the hook over-ride method 2489 */ 2490 if ((!(rcvdata = hook->hk_rcvdata)) 2491 && (!(rcvdata = NG_HOOK_NODE(hook)->nd_type->rcvdata))) { 2492 error = 0; 2493 NG_FREE_ITEM(item); 2494 break; 2495 } 2496 error = (*rcvdata)(hook, item); 2497 break; 2498 case NGQF_MESG: 2499 if (hook && NG_HOOK_NOT_VALID(hook)) { 2500 /* 2501 * The hook has been zapped then we can't use it. 2502 * Immediately drop its reference. 2503 * The message may not need it. 2504 */ 2505 NG_HOOK_UNREF(hook); 2506 hook = NULL; 2507 } 2508 /* 2509 * Similarly, if the node is a zombie there is 2510 * nothing we can do with it, drop everything. 2511 */ 2512 if (NG_NODE_NOT_VALID(node)) { 2513 TRAP_ERROR(); 2514 error = EINVAL; 2515 NG_FREE_ITEM(item); 2516 break; 2517 } 2518 /* 2519 * Call the appropriate message handler for the object. 2520 * It is up to the message handler to free the message. 2521 * If it's a generic message, handle it generically, 2522 * otherwise call the type's message handler (if it exists). 2523 * XXX (race). Remember that a queued message may 2524 * reference a node or hook that has just been 2525 * invalidated. It will exist as the queue code 2526 * is holding a reference, but.. 2527 */ 2528 if ((NGI_MSG(item)->header.typecookie == NGM_GENERIC_COOKIE) && 2529 ((NGI_MSG(item)->header.flags & NGF_RESP) == 0)) { 2530 error = ng_generic_msg(node, item, hook); 2531 break; 2532 } 2533 if (((!hook) || (!(rcvmsg = hook->hk_rcvmsg))) && 2534 (!(rcvmsg = node->nd_type->rcvmsg))) { 2535 TRAP_ERROR(); 2536 error = 0; 2537 NG_FREE_ITEM(item); 2538 break; 2539 } 2540 error = (*rcvmsg)(node, item, hook); 2541 break; 2542 case NGQF_FN: 2543 case NGQF_FN2: 2544 /* 2545 * We have to implicitly trust the hook, 2546 * as some of these are used for system purposes 2547 * where the hook is invalid. In the case of 2548 * the shutdown message we allow it to hit 2549 * even if the node is invalid. 2550 */ 2551 if ((NG_NODE_NOT_VALID(node)) 2552 && (NGI_FN(item) != &ng_rmnode)) { 2553 TRAP_ERROR(); 2554 error = EINVAL; 2555 NG_FREE_ITEM(item); 2556 break; 2557 } 2558 if ((item->el_flags & NGQF_TYPE) == NGQF_FN) { 2559 (*NGI_FN(item))(node, hook, NGI_ARG1(item), 2560 NGI_ARG2(item)); 2561 NG_FREE_ITEM(item); 2562 } else /* it is NGQF_FN2 */ 2563 error = (*NGI_FN2(item))(node, item, hook); 2564 break; 2565 } 2566 /* 2567 * We held references on some of the resources 2568 * that we took from the item. Now that we have 2569 * finished doing everything, drop those references. 2570 */ 2571 if (hook) 2572 NG_HOOK_UNREF(hook); 2573 2574 if (rw == NGQRW_R) { 2575 ng_leave_read(&node->nd_input_queue); 2576 } else { 2577 ng_leave_write(&node->nd_input_queue); 2578 } 2579 2580 /* Apply callback. */ 2581 if (apply != NULL && refcount_release(&apply->refs)) 2582 (*apply->apply)(apply->context, error); 2583 2584 return (error); 2585} 2586 2587/*********************************************************************** 2588 * Implement the 'generic' control messages 2589 ***********************************************************************/ 2590static int 2591ng_generic_msg(node_p here, item_p item, hook_p lasthook) 2592{ 2593 int error = 0; 2594 struct ng_mesg *msg; 2595 struct ng_mesg *resp = NULL; 2596 2597 NGI_GET_MSG(item, msg); 2598 if (msg->header.typecookie != NGM_GENERIC_COOKIE) { 2599 TRAP_ERROR(); 2600 error = EINVAL; 2601 goto out; 2602 } 2603 switch (msg->header.cmd) { 2604 case NGM_SHUTDOWN: 2605 ng_rmnode(here, NULL, NULL, 0); 2606 break; 2607 case NGM_MKPEER: 2608 { 2609 struct ngm_mkpeer *const mkp = (struct ngm_mkpeer *) msg->data; 2610 2611 if (msg->header.arglen != sizeof(*mkp)) { 2612 TRAP_ERROR(); 2613 error = EINVAL; 2614 break; 2615 } 2616 mkp->type[sizeof(mkp->type) - 1] = '\0'; 2617 mkp->ourhook[sizeof(mkp->ourhook) - 1] = '\0'; 2618 mkp->peerhook[sizeof(mkp->peerhook) - 1] = '\0'; 2619 error = ng_mkpeer(here, mkp->ourhook, mkp->peerhook, mkp->type); 2620 break; 2621 } 2622 case NGM_CONNECT: 2623 { 2624 struct ngm_connect *const con = 2625 (struct ngm_connect *) msg->data; 2626 node_p node2; 2627 2628 if (msg->header.arglen != sizeof(*con)) { 2629 TRAP_ERROR(); 2630 error = EINVAL; 2631 break; 2632 } 2633 con->path[sizeof(con->path) - 1] = '\0'; 2634 con->ourhook[sizeof(con->ourhook) - 1] = '\0'; 2635 con->peerhook[sizeof(con->peerhook) - 1] = '\0'; 2636 /* Don't forget we get a reference.. */ 2637 error = ng_path2noderef(here, con->path, &node2, NULL); 2638 if (error) 2639 break; 2640 error = ng_con_nodes(item, here, con->ourhook, 2641 node2, con->peerhook); 2642 NG_NODE_UNREF(node2); 2643 break; 2644 } 2645 case NGM_NAME: 2646 { 2647 struct ngm_name *const nam = (struct ngm_name *) msg->data; 2648 2649 if (msg->header.arglen != sizeof(*nam)) { 2650 TRAP_ERROR(); 2651 error = EINVAL; 2652 break; 2653 } 2654 nam->name[sizeof(nam->name) - 1] = '\0'; 2655 error = ng_name_node(here, nam->name); 2656 break; 2657 } 2658 case NGM_RMHOOK: 2659 { 2660 struct ngm_rmhook *const rmh = (struct ngm_rmhook *) msg->data; 2661 hook_p hook; 2662 2663 if (msg->header.arglen != sizeof(*rmh)) { 2664 TRAP_ERROR(); 2665 error = EINVAL; 2666 break; 2667 } 2668 rmh->ourhook[sizeof(rmh->ourhook) - 1] = '\0'; 2669 if ((hook = ng_findhook(here, rmh->ourhook)) != NULL) 2670 ng_destroy_hook(hook); 2671 break; 2672 } 2673 case NGM_NODEINFO: 2674 { 2675 struct nodeinfo *ni; 2676 2677 NG_MKRESPONSE(resp, msg, sizeof(*ni), M_NOWAIT); 2678 if (resp == NULL) { 2679 error = ENOMEM; 2680 break; 2681 } 2682 2683 /* Fill in node info */ 2684 ni = (struct nodeinfo *) resp->data; 2685 if (NG_NODE_HAS_NAME(here)) 2686 strcpy(ni->name, NG_NODE_NAME(here)); 2687 strcpy(ni->type, here->nd_type->name); 2688 ni->id = ng_node2ID(here); 2689 ni->hooks = here->nd_numhooks; 2690 break; 2691 } 2692 case NGM_LISTHOOKS: 2693 { 2694 const int nhooks = here->nd_numhooks; 2695 struct hooklist *hl; 2696 struct nodeinfo *ni; 2697 hook_p hook; 2698 2699 /* Get response struct */ 2700 NG_MKRESPONSE(resp, msg, sizeof(*hl) 2701 + (nhooks * sizeof(struct linkinfo)), M_NOWAIT); 2702 if (resp == NULL) { 2703 error = ENOMEM; 2704 break; 2705 } 2706 hl = (struct hooklist *) resp->data; 2707 ni = &hl->nodeinfo; 2708 2709 /* Fill in node info */ 2710 if (NG_NODE_HAS_NAME(here)) 2711 strcpy(ni->name, NG_NODE_NAME(here)); 2712 strcpy(ni->type, here->nd_type->name); 2713 ni->id = ng_node2ID(here); 2714 2715 /* Cycle through the linked list of hooks */ 2716 ni->hooks = 0; 2717 LIST_FOREACH(hook, &here->nd_hooks, hk_hooks) { 2718 struct linkinfo *const link = &hl->link[ni->hooks]; 2719 2720 if (ni->hooks >= nhooks) { 2721 log(LOG_ERR, "%s: number of %s changed\n", 2722 __func__, "hooks"); 2723 break; 2724 } 2725 if (NG_HOOK_NOT_VALID(hook)) 2726 continue; 2727 strcpy(link->ourhook, NG_HOOK_NAME(hook)); 2728 strcpy(link->peerhook, NG_PEER_HOOK_NAME(hook)); 2729 if (NG_PEER_NODE_NAME(hook)[0] != '\0') 2730 strcpy(link->nodeinfo.name, 2731 NG_PEER_NODE_NAME(hook)); 2732 strcpy(link->nodeinfo.type, 2733 NG_PEER_NODE(hook)->nd_type->name); 2734 link->nodeinfo.id = ng_node2ID(NG_PEER_NODE(hook)); 2735 link->nodeinfo.hooks = NG_PEER_NODE(hook)->nd_numhooks; 2736 ni->hooks++; 2737 } 2738 break; 2739 } 2740 2741 case NGM_LISTNAMES: 2742 case NGM_LISTNODES: 2743 { 2744 const int unnamed = (msg->header.cmd == NGM_LISTNODES); 2745 struct namelist *nl; 2746 node_p node; 2747 int num = 0; 2748 2749 mtx_lock(&ng_nodelist_mtx); 2750 /* Count number of nodes */ 2751 LIST_FOREACH(node, &ng_nodelist, nd_nodes) { 2752 if (NG_NODE_IS_VALID(node) 2753 && (unnamed || NG_NODE_HAS_NAME(node))) { 2754 num++; 2755 } 2756 } 2757 mtx_unlock(&ng_nodelist_mtx); 2758 2759 /* Get response struct */ 2760 NG_MKRESPONSE(resp, msg, sizeof(*nl) 2761 + (num * sizeof(struct nodeinfo)), M_NOWAIT); 2762 if (resp == NULL) { 2763 error = ENOMEM; 2764 break; 2765 } 2766 nl = (struct namelist *) resp->data; 2767 2768 /* Cycle through the linked list of nodes */ 2769 nl->numnames = 0; 2770 mtx_lock(&ng_nodelist_mtx); 2771 LIST_FOREACH(node, &ng_nodelist, nd_nodes) { 2772 struct nodeinfo *const np = &nl->nodeinfo[nl->numnames]; 2773 2774 if (NG_NODE_NOT_VALID(node)) 2775 continue; 2776 if (!unnamed && (! NG_NODE_HAS_NAME(node))) 2777 continue; 2778 if (nl->numnames >= num) { 2779 log(LOG_ERR, "%s: number of %s changed\n", 2780 __func__, "nodes"); 2781 break; 2782 } 2783 if (NG_NODE_HAS_NAME(node)) 2784 strcpy(np->name, NG_NODE_NAME(node)); 2785 strcpy(np->type, node->nd_type->name); 2786 np->id = ng_node2ID(node); 2787 np->hooks = node->nd_numhooks; 2788 nl->numnames++; 2789 } 2790 mtx_unlock(&ng_nodelist_mtx); 2791 break; 2792 } 2793 2794 case NGM_LISTTYPES: 2795 { 2796 struct typelist *tl; 2797 struct ng_type *type; 2798 int num = 0; 2799 2800 mtx_lock(&ng_typelist_mtx); 2801 /* Count number of types */ 2802 LIST_FOREACH(type, &ng_typelist, types) { 2803 num++; 2804 } 2805 mtx_unlock(&ng_typelist_mtx); 2806 2807 /* Get response struct */ 2808 NG_MKRESPONSE(resp, msg, sizeof(*tl) 2809 + (num * sizeof(struct typeinfo)), M_NOWAIT); 2810 if (resp == NULL) { 2811 error = ENOMEM; 2812 break; 2813 } 2814 tl = (struct typelist *) resp->data; 2815 2816 /* Cycle through the linked list of types */ 2817 tl->numtypes = 0; 2818 mtx_lock(&ng_typelist_mtx); 2819 LIST_FOREACH(type, &ng_typelist, types) { 2820 struct typeinfo *const tp = &tl->typeinfo[tl->numtypes]; 2821 2822 if (tl->numtypes >= num) { 2823 log(LOG_ERR, "%s: number of %s changed\n", 2824 __func__, "types"); 2825 break; 2826 } 2827 strcpy(tp->type_name, type->name); 2828 tp->numnodes = type->refs - 1; /* don't count list */ 2829 tl->numtypes++; 2830 } 2831 mtx_unlock(&ng_typelist_mtx); 2832 break; 2833 } 2834 2835 case NGM_BINARY2ASCII: 2836 { 2837 int bufSize = 20 * 1024; /* XXX hard coded constant */ 2838 const struct ng_parse_type *argstype; 2839 const struct ng_cmdlist *c; 2840 struct ng_mesg *binary, *ascii; 2841 2842 /* Data area must contain a valid netgraph message */ 2843 binary = (struct ng_mesg *)msg->data; 2844 if (msg->header.arglen < sizeof(struct ng_mesg) || 2845 (msg->header.arglen - sizeof(struct ng_mesg) < 2846 binary->header.arglen)) { 2847 TRAP_ERROR(); 2848 error = EINVAL; 2849 break; 2850 } 2851 2852 /* Get a response message with lots of room */ 2853 NG_MKRESPONSE(resp, msg, sizeof(*ascii) + bufSize, M_NOWAIT); 2854 if (resp == NULL) { 2855 error = ENOMEM; 2856 break; 2857 } 2858 ascii = (struct ng_mesg *)resp->data; 2859 2860 /* Copy binary message header to response message payload */ 2861 bcopy(binary, ascii, sizeof(*binary)); 2862 2863 /* Find command by matching typecookie and command number */ 2864 for (c = here->nd_type->cmdlist; 2865 c != NULL && c->name != NULL; c++) { 2866 if (binary->header.typecookie == c->cookie 2867 && binary->header.cmd == c->cmd) 2868 break; 2869 } 2870 if (c == NULL || c->name == NULL) { 2871 for (c = ng_generic_cmds; c->name != NULL; c++) { 2872 if (binary->header.typecookie == c->cookie 2873 && binary->header.cmd == c->cmd) 2874 break; 2875 } 2876 if (c->name == NULL) { 2877 NG_FREE_MSG(resp); 2878 error = ENOSYS; 2879 break; 2880 } 2881 } 2882 2883 /* Convert command name to ASCII */ 2884 snprintf(ascii->header.cmdstr, sizeof(ascii->header.cmdstr), 2885 "%s", c->name); 2886 2887 /* Convert command arguments to ASCII */ 2888 argstype = (binary->header.flags & NGF_RESP) ? 2889 c->respType : c->mesgType; 2890 if (argstype == NULL) { 2891 *ascii->data = '\0'; 2892 } else { 2893 if ((error = ng_unparse(argstype, 2894 (u_char *)binary->data, 2895 ascii->data, bufSize)) != 0) { 2896 NG_FREE_MSG(resp); 2897 break; 2898 } 2899 } 2900 2901 /* Return the result as struct ng_mesg plus ASCII string */ 2902 bufSize = strlen(ascii->data) + 1; 2903 ascii->header.arglen = bufSize; 2904 resp->header.arglen = sizeof(*ascii) + bufSize; 2905 break; 2906 } 2907 2908 case NGM_ASCII2BINARY: 2909 { 2910 int bufSize = 2000; /* XXX hard coded constant */ 2911 const struct ng_cmdlist *c; 2912 const struct ng_parse_type *argstype; 2913 struct ng_mesg *ascii, *binary; 2914 int off = 0; 2915 2916 /* Data area must contain at least a struct ng_mesg + '\0' */ 2917 ascii = (struct ng_mesg *)msg->data; 2918 if ((msg->header.arglen < sizeof(*ascii) + 1) || 2919 (ascii->header.arglen < 1) || 2920 (msg->header.arglen < sizeof(*ascii) + 2921 ascii->header.arglen)) { 2922 TRAP_ERROR(); 2923 error = EINVAL; 2924 break; 2925 } 2926 ascii->data[ascii->header.arglen - 1] = '\0'; 2927 2928 /* Get a response message with lots of room */ 2929 NG_MKRESPONSE(resp, msg, sizeof(*binary) + bufSize, M_NOWAIT); 2930 if (resp == NULL) { 2931 error = ENOMEM; 2932 break; 2933 } 2934 binary = (struct ng_mesg *)resp->data; 2935 2936 /* Copy ASCII message header to response message payload */ 2937 bcopy(ascii, binary, sizeof(*ascii)); 2938 2939 /* Find command by matching ASCII command string */ 2940 for (c = here->nd_type->cmdlist; 2941 c != NULL && c->name != NULL; c++) { 2942 if (strcmp(ascii->header.cmdstr, c->name) == 0) 2943 break; 2944 } 2945 if (c == NULL || c->name == NULL) { 2946 for (c = ng_generic_cmds; c->name != NULL; c++) { 2947 if (strcmp(ascii->header.cmdstr, c->name) == 0) 2948 break; 2949 } 2950 if (c->name == NULL) { 2951 NG_FREE_MSG(resp); 2952 error = ENOSYS; 2953 break; 2954 } 2955 } 2956 2957 /* Convert command name to binary */ 2958 binary->header.cmd = c->cmd; 2959 binary->header.typecookie = c->cookie; 2960 2961 /* Convert command arguments to binary */ 2962 argstype = (binary->header.flags & NGF_RESP) ? 2963 c->respType : c->mesgType; 2964 if (argstype == NULL) { 2965 bufSize = 0; 2966 } else { 2967 if ((error = ng_parse(argstype, ascii->data, 2968 &off, (u_char *)binary->data, &bufSize)) != 0) { 2969 NG_FREE_MSG(resp); 2970 break; 2971 } 2972 } 2973 2974 /* Return the result */ 2975 binary->header.arglen = bufSize; 2976 resp->header.arglen = sizeof(*binary) + bufSize; 2977 break; 2978 } 2979 2980 case NGM_TEXT_CONFIG: 2981 case NGM_TEXT_STATUS: 2982 /* 2983 * This one is tricky as it passes the command down to the 2984 * actual node, even though it is a generic type command. 2985 * This means we must assume that the item/msg is already freed 2986 * when control passes back to us. 2987 */ 2988 if (here->nd_type->rcvmsg != NULL) { 2989 NGI_MSG(item) = msg; /* put it back as we found it */ 2990 return((*here->nd_type->rcvmsg)(here, item, lasthook)); 2991 } 2992 /* Fall through if rcvmsg not supported */ 2993 default: 2994 TRAP_ERROR(); 2995 error = EINVAL; 2996 } 2997 /* 2998 * Sometimes a generic message may be statically allocated 2999 * to avoid problems with allocating when in tight memeory situations. 3000 * Don't free it if it is so. 3001 * I break them appart here, because erros may cause a free if the item 3002 * in which case we'd be doing it twice. 3003 * they are kept together above, to simplify freeing. 3004 */ 3005out: 3006 NG_RESPOND_MSG(error, here, item, resp); 3007 if (msg) 3008 NG_FREE_MSG(msg); 3009 return (error); 3010} 3011 3012/************************************************************************ 3013 Queue element get/free routines 3014************************************************************************/ 3015 3016uma_zone_t ng_qzone; 3017static int maxalloc = 512; /* limit the damage of a leak */ 3018 3019TUNABLE_INT("net.graph.maxalloc", &maxalloc); 3020SYSCTL_INT(_net_graph, OID_AUTO, maxalloc, CTLFLAG_RDTUN, &maxalloc, 3021 0, "Maximum number of queue items to allocate"); 3022 3023#ifdef NETGRAPH_DEBUG 3024static TAILQ_HEAD(, ng_item) ng_itemlist = TAILQ_HEAD_INITIALIZER(ng_itemlist); 3025static int allocated; /* number of items malloc'd */ 3026#endif 3027 3028/* 3029 * Get a queue entry. 3030 * This is usually called when a packet first enters netgraph. 3031 * By definition, this is usually from an interrupt, or from a user. 3032 * Users are not so important, but try be quick for the times that it's 3033 * an interrupt. 3034 */ 3035static __inline item_p 3036ng_getqblk(int flags) 3037{ 3038 item_p item = NULL; 3039 int wait; 3040 3041 wait = (flags & NG_WAITOK) ? M_WAITOK : M_NOWAIT; 3042 3043 item = uma_zalloc(ng_qzone, wait | M_ZERO); 3044 3045#ifdef NETGRAPH_DEBUG 3046 if (item) { 3047 mtx_lock(&ngq_mtx); 3048 TAILQ_INSERT_TAIL(&ng_itemlist, item, all); 3049 allocated++; 3050 mtx_unlock(&ngq_mtx); 3051 } 3052#endif 3053 3054 return (item); 3055} 3056 3057/* 3058 * Release a queue entry 3059 */ 3060void 3061ng_free_item(item_p item) 3062{ 3063 /* 3064 * The item may hold resources on it's own. We need to free 3065 * these before we can free the item. What they are depends upon 3066 * what kind of item it is. it is important that nodes zero 3067 * out pointers to resources that they remove from the item 3068 * or we release them again here. 3069 */ 3070 switch (item->el_flags & NGQF_TYPE) { 3071 case NGQF_DATA: 3072 /* If we have an mbuf still attached.. */ 3073 NG_FREE_M(_NGI_M(item)); 3074 break; 3075 case NGQF_MESG: 3076 _NGI_RETADDR(item) = 0; 3077 NG_FREE_MSG(_NGI_MSG(item)); 3078 break; 3079 case NGQF_FN: 3080 case NGQF_FN2: 3081 /* nothing to free really, */ 3082 _NGI_FN(item) = NULL; 3083 _NGI_ARG1(item) = NULL; 3084 _NGI_ARG2(item) = 0; 3085 break; 3086 } 3087 /* If we still have a node or hook referenced... */ 3088 _NGI_CLR_NODE(item); 3089 _NGI_CLR_HOOK(item); 3090 3091#ifdef NETGRAPH_DEBUG 3092 mtx_lock(&ngq_mtx); 3093 TAILQ_REMOVE(&ng_itemlist, item, all); 3094 allocated--; 3095 mtx_unlock(&ngq_mtx); 3096#endif 3097 uma_zfree(ng_qzone, item); 3098} 3099 3100/************************************************************************ 3101 Module routines 3102************************************************************************/ 3103 3104/* 3105 * Handle the loading/unloading of a netgraph node type module 3106 */ 3107int 3108ng_mod_event(module_t mod, int event, void *data) 3109{ 3110 struct ng_type *const type = data; 3111 int s, error = 0; 3112 3113 switch (event) { 3114 case MOD_LOAD: 3115 3116 /* Register new netgraph node type */ 3117 s = splnet(); 3118 if ((error = ng_newtype(type)) != 0) { 3119 splx(s); 3120 break; 3121 } 3122 3123 /* Call type specific code */ 3124 if (type->mod_event != NULL) 3125 if ((error = (*type->mod_event)(mod, event, data))) { 3126 mtx_lock(&ng_typelist_mtx); 3127 type->refs--; /* undo it */ 3128 LIST_REMOVE(type, types); 3129 mtx_unlock(&ng_typelist_mtx); 3130 } 3131 splx(s); 3132 break; 3133 3134 case MOD_UNLOAD: 3135 s = splnet(); 3136 if (type->refs > 1) { /* make sure no nodes exist! */ 3137 error = EBUSY; 3138 } else { 3139 if (type->refs == 0) { 3140 /* failed load, nothing to undo */ 3141 splx(s); 3142 break; 3143 } 3144 if (type->mod_event != NULL) { /* check with type */ 3145 error = (*type->mod_event)(mod, event, data); 3146 if (error != 0) { /* type refuses.. */ 3147 splx(s); 3148 break; 3149 } 3150 } 3151 mtx_lock(&ng_typelist_mtx); 3152 LIST_REMOVE(type, types); 3153 mtx_unlock(&ng_typelist_mtx); 3154 } 3155 splx(s); 3156 break; 3157 3158 default: 3159 if (type->mod_event != NULL) 3160 error = (*type->mod_event)(mod, event, data); 3161 else 3162 error = EOPNOTSUPP; /* XXX ? */ 3163 break; 3164 } 3165 return (error); 3166} 3167 3168/* 3169 * Handle loading and unloading for this code. 3170 * The only thing we need to link into is the NETISR strucure. 3171 */ 3172static int 3173ngb_mod_event(module_t mod, int event, void *data) 3174{ 3175 int error = 0; 3176 3177 switch (event) { 3178 case MOD_LOAD: 3179 /* Initialize everything. */ 3180 NG_WORKLIST_LOCK_INIT(); 3181 mtx_init(&ng_typelist_mtx, "netgraph types mutex", NULL, 3182 MTX_DEF); 3183 mtx_init(&ng_nodelist_mtx, "netgraph nodelist mutex", NULL, 3184 MTX_DEF); 3185 mtx_init(&ng_idhash_mtx, "netgraph idhash mutex", NULL, 3186 MTX_DEF); 3187 mtx_init(&ng_topo_mtx, "netgraph topology mutex", NULL, 3188 MTX_DEF); 3189#ifdef NETGRAPH_DEBUG 3190 mtx_init(&ngq_mtx, "netgraph item list mutex", NULL, 3191 MTX_DEF); 3192#endif 3193 ng_qzone = uma_zcreate("NetGraph items", sizeof(struct ng_item), 3194 NULL, NULL, NULL, NULL, UMA_ALIGN_CACHE, 0); 3195 uma_zone_set_max(ng_qzone, maxalloc); 3196 netisr_register(NETISR_NETGRAPH, (netisr_t *)ngintr, NULL, 3197 NETISR_MPSAFE); 3198 break; 3199 case MOD_UNLOAD: 3200 /* You can't unload it because an interface may be using it. */ 3201 error = EBUSY; 3202 break; 3203 default: 3204 error = EOPNOTSUPP; 3205 break; 3206 } 3207 return (error); 3208} 3209 3210static moduledata_t netgraph_mod = { 3211 "netgraph", 3212 ngb_mod_event, 3213 (NULL) 3214}; 3215DECLARE_MODULE(netgraph, netgraph_mod, SI_SUB_NETGRAPH, SI_ORDER_MIDDLE); 3216SYSCTL_NODE(_net, OID_AUTO, graph, CTLFLAG_RW, 0, "netgraph Family"); 3217SYSCTL_INT(_net_graph, OID_AUTO, abi_version, CTLFLAG_RD, 0, NG_ABI_VERSION,""); 3218SYSCTL_INT(_net_graph, OID_AUTO, msg_version, CTLFLAG_RD, 0, NG_VERSION, ""); 3219 3220#ifdef NETGRAPH_DEBUG 3221void 3222dumphook (hook_p hook, char *file, int line) 3223{ 3224 printf("hook: name %s, %d refs, Last touched:\n", 3225 _NG_HOOK_NAME(hook), hook->hk_refs); 3226 printf(" Last active @ %s, line %d\n", 3227 hook->lastfile, hook->lastline); 3228 if (line) { 3229 printf(" problem discovered at file %s, line %d\n", file, line); 3230 } 3231} 3232 3233void 3234dumpnode(node_p node, char *file, int line) 3235{ 3236 printf("node: ID [%x]: type '%s', %d hooks, flags 0x%x, %d refs, %s:\n", 3237 _NG_NODE_ID(node), node->nd_type->name, 3238 node->nd_numhooks, node->nd_flags, 3239 node->nd_refs, node->nd_name); 3240 printf(" Last active @ %s, line %d\n", 3241 node->lastfile, node->lastline); 3242 if (line) { 3243 printf(" problem discovered at file %s, line %d\n", file, line); 3244 } 3245} 3246 3247void 3248dumpitem(item_p item, char *file, int line) 3249{ 3250 printf(" ACTIVE item, last used at %s, line %d", 3251 item->lastfile, item->lastline); 3252 switch(item->el_flags & NGQF_TYPE) { 3253 case NGQF_DATA: 3254 printf(" - [data]\n"); 3255 break; 3256 case NGQF_MESG: 3257 printf(" - retaddr[%d]:\n", _NGI_RETADDR(item)); 3258 break; 3259 case NGQF_FN: 3260 printf(" - fn@%p (%p, %p, %p, %d (%x))\n", 3261 _NGI_FN(item), 3262 _NGI_NODE(item), 3263 _NGI_HOOK(item), 3264 item->body.fn.fn_arg1, 3265 item->body.fn.fn_arg2, 3266 item->body.fn.fn_arg2); 3267 break; 3268 case NGQF_FN2: 3269 printf(" - fn2@%p (%p, %p, %p, %d (%x))\n", 3270 _NGI_FN2(item), 3271 _NGI_NODE(item), 3272 _NGI_HOOK(item), 3273 item->body.fn.fn_arg1, 3274 item->body.fn.fn_arg2, 3275 item->body.fn.fn_arg2); 3276 break; 3277 } 3278 if (line) { 3279 printf(" problem discovered at file %s, line %d\n", file, line); 3280 if (_NGI_NODE(item)) { 3281 printf("node %p ([%x])\n", 3282 _NGI_NODE(item), ng_node2ID(_NGI_NODE(item))); 3283 } 3284 } 3285} 3286 3287static void 3288ng_dumpitems(void) 3289{ 3290 item_p item; 3291 int i = 1; 3292 TAILQ_FOREACH(item, &ng_itemlist, all) { 3293 printf("[%d] ", i++); 3294 dumpitem(item, NULL, 0); 3295 } 3296} 3297 3298static void 3299ng_dumpnodes(void) 3300{ 3301 node_p node; 3302 int i = 1; 3303 mtx_lock(&ng_nodelist_mtx); 3304 SLIST_FOREACH(node, &ng_allnodes, nd_all) { 3305 printf("[%d] ", i++); 3306 dumpnode(node, NULL, 0); 3307 } 3308 mtx_unlock(&ng_nodelist_mtx); 3309} 3310 3311static void 3312ng_dumphooks(void) 3313{ 3314 hook_p hook; 3315 int i = 1; 3316 mtx_lock(&ng_nodelist_mtx); 3317 SLIST_FOREACH(hook, &ng_allhooks, hk_all) { 3318 printf("[%d] ", i++); 3319 dumphook(hook, NULL, 0); 3320 } 3321 mtx_unlock(&ng_nodelist_mtx); 3322} 3323 3324static int 3325sysctl_debug_ng_dump_items(SYSCTL_HANDLER_ARGS) 3326{ 3327 int error; 3328 int val; 3329 int i; 3330 3331 val = allocated; 3332 i = 1; 3333 error = sysctl_handle_int(oidp, &val, 0, req); 3334 if (error != 0 || req->newptr == NULL) 3335 return (error); 3336 if (val == 42) { 3337 ng_dumpitems(); 3338 ng_dumpnodes(); 3339 ng_dumphooks(); 3340 } 3341 return (0); 3342} 3343 3344SYSCTL_PROC(_debug, OID_AUTO, ng_dump_items, CTLTYPE_INT | CTLFLAG_RW, 3345 0, sizeof(int), sysctl_debug_ng_dump_items, "I", "Number of allocated items"); 3346#endif /* NETGRAPH_DEBUG */ 3347 3348 3349/*********************************************************************** 3350* Worklist routines 3351**********************************************************************/ 3352/* NETISR thread enters here */ 3353/* 3354 * Pick a node off the list of nodes with work, 3355 * try get an item to process off it. 3356 * If there are no more, remove the node from the list. 3357 */ 3358static void 3359ngintr(void) 3360{ 3361 item_p item; 3362 node_p node = NULL; 3363 3364 for (;;) { 3365 NG_WORKLIST_LOCK(); 3366 node = TAILQ_FIRST(&ng_worklist); 3367 if (!node) { 3368 NG_WORKLIST_UNLOCK(); 3369 break; 3370 } 3371 node->nd_flags &= ~NGF_WORKQ; 3372 TAILQ_REMOVE(&ng_worklist, node, nd_work); 3373 NG_WORKLIST_UNLOCK(); 3374 CTR3(KTR_NET, "%20s: node [%x] (%p) taken off worklist", 3375 __func__, node->nd_ID, node); 3376 /* 3377 * We have the node. We also take over the reference 3378 * that the list had on it. 3379 * Now process as much as you can, until it won't 3380 * let you have another item off the queue. 3381 * All this time, keep the reference 3382 * that lets us be sure that the node still exists. 3383 * Let the reference go at the last minute. 3384 * ng_dequeue will put us back on the worklist 3385 * if there is more too do. This may be of use if there 3386 * are Multiple Processors and multiple Net threads in the 3387 * future. 3388 */ 3389 for (;;) { 3390 int rw; 3391 3392 NG_QUEUE_LOCK(&node->nd_input_queue); 3393 item = ng_dequeue(&node->nd_input_queue, &rw); 3394 if (item == NULL) { 3395 NG_QUEUE_UNLOCK(&node->nd_input_queue); 3396 break; /* go look for another node */ 3397 } else { 3398 NG_QUEUE_UNLOCK(&node->nd_input_queue); 3399 NGI_GET_NODE(item, node); /* zaps stored node */ 3400 ng_apply_item(node, item, rw); 3401 NG_NODE_UNREF(node); 3402 } 3403 } 3404 NG_NODE_UNREF(node); 3405 } 3406} 3407 3408static void 3409ng_worklist_remove(node_p node) 3410{ 3411 mtx_assert(&node->nd_input_queue.q_mtx, MA_OWNED); 3412 3413 NG_WORKLIST_LOCK(); 3414 if (node->nd_flags & NGF_WORKQ) { 3415 node->nd_flags &= ~NGF_WORKQ; 3416 TAILQ_REMOVE(&ng_worklist, node, nd_work); 3417 NG_WORKLIST_UNLOCK(); 3418 NG_NODE_UNREF(node); 3419 CTR3(KTR_NET, "%20s: node [%x] (%p) removed from worklist", 3420 __func__, node->nd_ID, node); 3421 } else { 3422 NG_WORKLIST_UNLOCK(); 3423 } 3424} 3425 3426/* 3427 * XXX 3428 * It's posible that a debugging NG_NODE_REF may need 3429 * to be outside the mutex zone 3430 */ 3431static void 3432ng_setisr(node_p node) 3433{ 3434 3435 mtx_assert(&node->nd_input_queue.q_mtx, MA_OWNED); 3436 3437 if ((node->nd_flags & NGF_WORKQ) == 0) { 3438 /* 3439 * If we are not already on the work queue, 3440 * then put us on. 3441 */ 3442 node->nd_flags |= NGF_WORKQ; 3443 NG_WORKLIST_LOCK(); 3444 TAILQ_INSERT_TAIL(&ng_worklist, node, nd_work); 3445 NG_WORKLIST_UNLOCK(); 3446 NG_NODE_REF(node); /* XXX fafe in mutex? */ 3447 CTR3(KTR_NET, "%20s: node [%x] (%p) put on worklist", __func__, 3448 node->nd_ID, node); 3449 } else 3450 CTR3(KTR_NET, "%20s: node [%x] (%p) already on worklist", 3451 __func__, node->nd_ID, node); 3452 schednetisr(NETISR_NETGRAPH); 3453} 3454 3455 3456/*********************************************************************** 3457* Externally useable functions to set up a queue item ready for sending 3458***********************************************************************/ 3459 3460#ifdef NETGRAPH_DEBUG 3461#define ITEM_DEBUG_CHECKS \ 3462 do { \ 3463 if (NGI_NODE(item) ) { \ 3464 printf("item already has node"); \ 3465 kdb_enter(KDB_WHY_NETGRAPH, "has node"); \ 3466 NGI_CLR_NODE(item); \ 3467 } \ 3468 if (NGI_HOOK(item) ) { \ 3469 printf("item already has hook"); \ 3470 kdb_enter(KDB_WHY_NETGRAPH, "has hook"); \ 3471 NGI_CLR_HOOK(item); \ 3472 } \ 3473 } while (0) 3474#else 3475#define ITEM_DEBUG_CHECKS 3476#endif 3477 3478/* 3479 * Put mbuf into the item. 3480 * Hook and node references will be removed when the item is dequeued. 3481 * (or equivalent) 3482 * (XXX) Unsafe because no reference held by peer on remote node. 3483 * remote node might go away in this timescale. 3484 * We know the hooks can't go away because that would require getting 3485 * a writer item on both nodes and we must have at least a reader 3486 * here to be able to do this. 3487 * Note that the hook loaded is the REMOTE hook. 3488 * 3489 * This is possibly in the critical path for new data. 3490 */ 3491item_p 3492ng_package_data(struct mbuf *m, int flags) 3493{ 3494 item_p item; 3495 3496 if ((item = ng_getqblk(flags)) == NULL) { 3497 NG_FREE_M(m); 3498 return (NULL); 3499 } 3500 ITEM_DEBUG_CHECKS; 3501 item->el_flags = NGQF_DATA | NGQF_READER; 3502 item->el_next = NULL; 3503 NGI_M(item) = m; 3504 return (item); 3505} 3506 3507/* 3508 * Allocate a queue item and put items into it.. 3509 * Evaluate the address as this will be needed to queue it and 3510 * to work out what some of the fields should be. 3511 * Hook and node references will be removed when the item is dequeued. 3512 * (or equivalent) 3513 */ 3514item_p 3515ng_package_msg(struct ng_mesg *msg, int flags) 3516{ 3517 item_p item; 3518 3519 if ((item = ng_getqblk(flags)) == NULL) { 3520 NG_FREE_MSG(msg); 3521 return (NULL); 3522 } 3523 ITEM_DEBUG_CHECKS; 3524 /* Messages items count as writers unless explicitly exempted. */ 3525 if (msg->header.cmd & NGM_READONLY) 3526 item->el_flags = NGQF_MESG | NGQF_READER; 3527 else 3528 item->el_flags = NGQF_MESG | NGQF_WRITER; 3529 item->el_next = NULL; 3530 /* 3531 * Set the current lasthook into the queue item 3532 */ 3533 NGI_MSG(item) = msg; 3534 NGI_RETADDR(item) = 0; 3535 return (item); 3536} 3537 3538 3539 3540#define SET_RETADDR(item, here, retaddr) \ 3541 do { /* Data or fn items don't have retaddrs */ \ 3542 if ((item->el_flags & NGQF_TYPE) == NGQF_MESG) { \ 3543 if (retaddr) { \ 3544 NGI_RETADDR(item) = retaddr; \ 3545 } else { \ 3546 /* \ 3547 * The old return address should be ok. \ 3548 * If there isn't one, use the address \ 3549 * here. \ 3550 */ \ 3551 if (NGI_RETADDR(item) == 0) { \ 3552 NGI_RETADDR(item) \ 3553 = ng_node2ID(here); \ 3554 } \ 3555 } \ 3556 } \ 3557 } while (0) 3558 3559int 3560ng_address_hook(node_p here, item_p item, hook_p hook, ng_ID_t retaddr) 3561{ 3562 hook_p peer; 3563 node_p peernode; 3564 ITEM_DEBUG_CHECKS; 3565 /* 3566 * Quick sanity check.. 3567 * Since a hook holds a reference on it's node, once we know 3568 * that the peer is still connected (even if invalid,) we know 3569 * that the peer node is present, though maybe invalid. 3570 */ 3571 if ((hook == NULL) 3572 || NG_HOOK_NOT_VALID(hook) 3573 || (NG_HOOK_PEER(hook) == NULL) 3574 || NG_HOOK_NOT_VALID(NG_HOOK_PEER(hook)) 3575 || NG_NODE_NOT_VALID(NG_PEER_NODE(hook))) { 3576 NG_FREE_ITEM(item); 3577 TRAP_ERROR(); 3578 return (ENETDOWN); 3579 } 3580 3581 /* 3582 * Transfer our interest to the other (peer) end. 3583 */ 3584 peer = NG_HOOK_PEER(hook); 3585 NG_HOOK_REF(peer); 3586 NGI_SET_HOOK(item, peer); 3587 peernode = NG_PEER_NODE(hook); 3588 NG_NODE_REF(peernode); 3589 NGI_SET_NODE(item, peernode); 3590 SET_RETADDR(item, here, retaddr); 3591 return (0); 3592} 3593 3594int 3595ng_address_path(node_p here, item_p item, char *address, ng_ID_t retaddr) 3596{ 3597 node_p dest = NULL; 3598 hook_p hook = NULL; 3599 int error; 3600 3601 ITEM_DEBUG_CHECKS; 3602 /* 3603 * Note that ng_path2noderef increments the reference count 3604 * on the node for us if it finds one. So we don't have to. 3605 */ 3606 error = ng_path2noderef(here, address, &dest, &hook); 3607 if (error) { 3608 NG_FREE_ITEM(item); 3609 return (error); 3610 } 3611 NGI_SET_NODE(item, dest); 3612 if ( hook) { 3613 NG_HOOK_REF(hook); /* don't let it go while on the queue */ 3614 NGI_SET_HOOK(item, hook); 3615 } 3616 SET_RETADDR(item, here, retaddr); 3617 return (0); 3618} 3619 3620int 3621ng_address_ID(node_p here, item_p item, ng_ID_t ID, ng_ID_t retaddr) 3622{ 3623 node_p dest; 3624 3625 ITEM_DEBUG_CHECKS; 3626 /* 3627 * Find the target node. 3628 */ 3629 dest = ng_ID2noderef(ID); /* GETS REFERENCE! */ 3630 if (dest == NULL) { 3631 NG_FREE_ITEM(item); 3632 TRAP_ERROR(); 3633 return(EINVAL); 3634 } 3635 /* Fill out the contents */ 3636 NGI_SET_NODE(item, dest); 3637 NGI_CLR_HOOK(item); 3638 SET_RETADDR(item, here, retaddr); 3639 return (0); 3640} 3641 3642/* 3643 * special case to send a message to self (e.g. destroy node) 3644 * Possibly indicate an arrival hook too. 3645 * Useful for removing that hook :-) 3646 */ 3647item_p 3648ng_package_msg_self(node_p here, hook_p hook, struct ng_mesg *msg) 3649{ 3650 item_p item; 3651 3652 /* 3653 * Find the target node. 3654 * If there is a HOOK argument, then use that in preference 3655 * to the address. 3656 */ 3657 if ((item = ng_getqblk(NG_NOFLAGS)) == NULL) { 3658 NG_FREE_MSG(msg); 3659 return (NULL); 3660 } 3661 3662 /* Fill out the contents */ 3663 item->el_flags = NGQF_MESG | NGQF_WRITER; 3664 item->el_next = NULL; 3665 NG_NODE_REF(here); 3666 NGI_SET_NODE(item, here); 3667 if (hook) { 3668 NG_HOOK_REF(hook); 3669 NGI_SET_HOOK(item, hook); 3670 } 3671 NGI_MSG(item) = msg; 3672 NGI_RETADDR(item) = ng_node2ID(here); 3673 return (item); 3674} 3675 3676/* 3677 * Send ng_item_fn function call to the specified node. 3678 */ 3679 3680int 3681ng_send_fn(node_p node, hook_p hook, ng_item_fn *fn, void * arg1, int arg2) 3682{ 3683 3684 return ng_send_fn1(node, hook, fn, arg1, arg2, NG_NOFLAGS); 3685} 3686 3687int 3688ng_send_fn1(node_p node, hook_p hook, ng_item_fn *fn, void * arg1, int arg2, 3689 int flags) 3690{ 3691 item_p item; 3692 3693 if ((item = ng_getqblk(flags)) == NULL) { 3694 return (ENOMEM); 3695 } 3696 item->el_flags = NGQF_FN | NGQF_WRITER; 3697 NG_NODE_REF(node); /* and one for the item */ 3698 NGI_SET_NODE(item, node); 3699 if (hook) { 3700 NG_HOOK_REF(hook); 3701 NGI_SET_HOOK(item, hook); 3702 } 3703 NGI_FN(item) = fn; 3704 NGI_ARG1(item) = arg1; 3705 NGI_ARG2(item) = arg2; 3706 return(ng_snd_item(item, flags)); 3707} 3708 3709/* 3710 * Send ng_item_fn2 function call to the specified node. 3711 * 3712 * If an optional pitem parameter is supplied, its apply 3713 * callback will be copied to the new item. If also NG_REUSE_ITEM 3714 * flag is set, no new item will be allocated, but pitem will 3715 * be used. 3716 */ 3717int 3718ng_send_fn2(node_p node, hook_p hook, item_p pitem, ng_item_fn2 *fn, void *arg1, 3719 int arg2, int flags) 3720{ 3721 item_p item; 3722 3723 KASSERT((pitem != NULL || (flags & NG_REUSE_ITEM) == 0), 3724 ("%s: NG_REUSE_ITEM but no pitem", __func__)); 3725 3726 /* 3727 * Allocate a new item if no supplied or 3728 * if we can't use supplied one. 3729 */ 3730 if (pitem == NULL || (flags & NG_REUSE_ITEM) == 0) { 3731 if ((item = ng_getqblk(flags)) == NULL) 3732 return (ENOMEM); 3733 } else 3734 item = pitem; 3735 3736 item->el_flags = NGQF_FN2 | NGQF_WRITER; 3737 NG_NODE_REF(node); /* and one for the item */ 3738 NGI_SET_NODE(item, node); 3739 if (hook) { 3740 NG_HOOK_REF(hook); 3741 NGI_SET_HOOK(item, hook); 3742 } 3743 NGI_FN2(item) = fn; 3744 NGI_ARG1(item) = arg1; 3745 NGI_ARG2(item) = arg2; 3746 if (pitem != NULL && (flags & NG_REUSE_ITEM) == 0) 3747 item->apply = pitem->apply; 3748 return(ng_snd_item(item, flags)); 3749} 3750 3751/* 3752 * Official timeout routines for Netgraph nodes. 3753 */ 3754static void 3755ng_callout_trampoline(void *arg) 3756{ 3757 item_p item = arg; 3758 3759 ng_snd_item(item, 0); 3760} 3761 3762 3763int 3764ng_callout(struct callout *c, node_p node, hook_p hook, int ticks, 3765 ng_item_fn *fn, void * arg1, int arg2) 3766{ 3767 item_p item, oitem; 3768 3769 if ((item = ng_getqblk(NG_NOFLAGS)) == NULL) 3770 return (ENOMEM); 3771 3772 item->el_flags = NGQF_FN | NGQF_WRITER; 3773 NG_NODE_REF(node); /* and one for the item */ 3774 NGI_SET_NODE(item, node); 3775 if (hook) { 3776 NG_HOOK_REF(hook); 3777 NGI_SET_HOOK(item, hook); 3778 } 3779 NGI_FN(item) = fn; 3780 NGI_ARG1(item) = arg1; 3781 NGI_ARG2(item) = arg2; 3782 oitem = c->c_arg; 3783 if (callout_reset(c, ticks, &ng_callout_trampoline, item) == 1 && 3784 oitem != NULL) 3785 NG_FREE_ITEM(oitem); 3786 return (0); 3787} 3788 3789/* A special modified version of untimeout() */ 3790int 3791ng_uncallout(struct callout *c, node_p node) 3792{ 3793 item_p item; 3794 int rval; 3795 3796 KASSERT(c != NULL, ("ng_uncallout: NULL callout")); 3797 KASSERT(node != NULL, ("ng_uncallout: NULL node")); 3798 3799 rval = callout_stop(c); 3800 item = c->c_arg; 3801 /* Do an extra check */ 3802 if ((rval > 0) && (c->c_func == &ng_callout_trampoline) && 3803 (NGI_NODE(item) == node)) { 3804 /* 3805 * We successfully removed it from the queue before it ran 3806 * So now we need to unreference everything that was 3807 * given extra references. (NG_FREE_ITEM does this). 3808 */ 3809 NG_FREE_ITEM(item); 3810 } 3811 c->c_arg = NULL; 3812 3813 return (rval); 3814} 3815 3816/* 3817 * Set the address, if none given, give the node here. 3818 */ 3819void 3820ng_replace_retaddr(node_p here, item_p item, ng_ID_t retaddr) 3821{ 3822 if (retaddr) { 3823 NGI_RETADDR(item) = retaddr; 3824 } else { 3825 /* 3826 * The old return address should be ok. 3827 * If there isn't one, use the address here. 3828 */ 3829 NGI_RETADDR(item) = ng_node2ID(here); 3830 } 3831} 3832 3833#define TESTING 3834#ifdef TESTING 3835/* just test all the macros */ 3836void 3837ng_macro_test(item_p item); 3838void 3839ng_macro_test(item_p item) 3840{ 3841 node_p node = NULL; 3842 hook_p hook = NULL; 3843 struct mbuf *m; 3844 struct ng_mesg *msg; 3845 ng_ID_t retaddr; 3846 int error; 3847 3848 NGI_GET_M(item, m); 3849 NGI_GET_MSG(item, msg); 3850 retaddr = NGI_RETADDR(item); 3851 NG_SEND_DATA(error, hook, m, NULL); 3852 NG_SEND_DATA_ONLY(error, hook, m); 3853 NG_FWD_NEW_DATA(error, item, hook, m); 3854 NG_FWD_ITEM_HOOK(error, item, hook); 3855 NG_SEND_MSG_HOOK(error, node, msg, hook, retaddr); 3856 NG_SEND_MSG_ID(error, node, msg, retaddr, retaddr); 3857 NG_SEND_MSG_PATH(error, node, msg, ".:", retaddr); 3858 NG_FWD_MSG_HOOK(error, node, item, hook, retaddr); 3859} 3860#endif /* TESTING */ 3861 3862