ng_base.c revision 122320
113675Sdyson/* 213675Sdyson * ng_base.c 313675Sdyson * 413675Sdyson * Copyright (c) 1996-1999 Whistle Communications, Inc. 513675Sdyson * All rights reserved. 613675Sdyson * 713675Sdyson * Subject to the following obligations and disclaimer of warranty, use and 813675Sdyson * redistribution of this software, in source or object code forms, with or 913675Sdyson * without modifications are expressly permitted by Whistle Communications; 1013675Sdyson * provided, however, that: 1113675Sdyson * 1. Any and all reproductions of the source or object code must include the 1213675Sdyson * copyright notice above and the following disclaimer of warranties; and 1313675Sdyson * 2. No rights are granted, in any manner or form, to use Whistle 1413675Sdyson * Communications, Inc. trademarks, including the mark "WHISTLE 1513675Sdyson * COMMUNICATIONS" on advertising, endorsements, or otherwise except as 1614037Sdyson * such appears in the above copyright notice or in the software. 1713675Sdyson * 1813675Sdyson * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND 1913675Sdyson * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO 2013675Sdyson * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, 2113675Sdyson * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF 2213675Sdyson * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. 2313675Sdyson * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY 2413675Sdyson * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS 2513675Sdyson * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE. 2613675Sdyson * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES 2713907Sdyson * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING 2813907Sdyson * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, 2913907Sdyson * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR 3013907Sdyson * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY 3113907Sdyson * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3213907Sdyson * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 3313907Sdyson * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY 3413907Sdyson * OF SUCH DAMAGE. 3513907Sdyson * 3613907Sdyson * Authors: Julian Elischer <julian@freebsd.org> 3713913Sdyson * Archie Cobbs <archie@freebsd.org> 3813907Sdyson * 3913907Sdyson * $FreeBSD: head/sys/netgraph/ng_base.c 122320 2003-11-08 22:28:40Z sam $ 4013907Sdyson * $Whistle: ng_base.c,v 1.39 1999/01/28 23:54:53 julian Exp $ 4113907Sdyson */ 4213907Sdyson 4313907Sdyson/* 4413907Sdyson * This file implements the base netgraph code. 4513907Sdyson */ 46118764Ssilby 47117325Ssilby#include <sys/param.h> 48118764Ssilby#include <sys/systm.h> 49117325Ssilby#include <sys/errno.h> 50118764Ssilby#include <sys/kernel.h> 51118764Ssilby#include <sys/limits.h> 52118764Ssilby#include <sys/malloc.h> 53118764Ssilby#include <sys/syslog.h> 54118764Ssilby#include <sys/sysctl.h> 55117325Ssilby#include <sys/linker.h> 56117325Ssilby#include <sys/queue.h> 57117325Ssilby#include <sys/mbuf.h> 58117325Ssilby#include <sys/ctype.h> 59117325Ssilby#include <sys/sysctl.h> 60117325Ssilby 6113907Sdyson#include <net/netisr.h> 6213907Sdyson 63116182Sobrien#include <netgraph/ng_message.h> 64116182Sobrien#include <netgraph/netgraph.h> 65116182Sobrien#include <netgraph/ng_parse.h> 66101768Srwatson 67101768SrwatsonMODULE_VERSION(netgraph, NG_ABI_VERSION); 6813675Sdyson 6913675Sdyson/* List of all active nodes */ 7024131Sbdestatic LIST_HEAD(, ng_node) ng_nodelist; 7113675Sdysonstatic struct mtx ng_nodelist_mtx; 7213675Sdyson 7324206Sbde/* Mutex that protects the free queue item list */ 7491372Salfredstatic struct mtx ngq_mtx; 7576166Smarkm 76101768Srwatson#ifdef NETGRAPH_DEBUG 7776827Salfred 7824206Sbdestatic SLIST_HEAD(, ng_node) ng_allnodes; 7913675Sdysonstatic LIST_HEAD(, ng_node) ng_freenodes; /* in debug, we never free() them */ 8091968Salfredstatic SLIST_HEAD(, ng_hook) ng_allhooks; 8129356Speterstatic LIST_HEAD(, ng_hook) ng_freehooks; /* in debug, we never free() them */ 8270834Swollman 8313675Sdysonstatic void ng_dumpitems(void); 84117325Ssilbystatic void ng_dumpnodes(void); 8513675Sdysonstatic void ng_dumphooks(void); 8613675Sdyson 8776166Smarkm#endif /* NETGRAPH_DEBUG */ 8855112Sbde/* 8934924Sbde * DEAD versions of the structures. 9059288Sjlemon * In order to avoid races, it is sometimes neccesary to point 9113675Sdyson * at SOMETHING even though theoretically, the current entity is 9213675Sdyson * INVALID. Use these to avoid these races. 9313675Sdyson */ 9413675Sdysonstruct ng_type ng_deadtype = { 9513675Sdyson NG_ABI_VERSION, 9613675Sdyson "dead", 9713675Sdyson NULL, /* modevent */ 9813675Sdyson NULL, /* constructor */ 9913907Sdyson NULL, /* rcvmsg */ 10092751Sjeff NULL, /* shutdown */ 10113675Sdyson NULL, /* newhook */ 10214037Sdyson NULL, /* findhook */ 10314037Sdyson NULL, /* connect */ 10414037Sdyson NULL, /* rcvdata */ 10514037Sdyson NULL, /* disconnect */ 10614037Sdyson NULL, /* cmdlist */ 10714037Sdyson}; 10814037Sdyson 10914037Sdysonstruct ng_node ng_deadnode = { 11014037Sdyson "dead", 11114037Sdyson &ng_deadtype, 112108255Sphk NG_INVALID, 113108255Sphk 1, /* refs */ 114108255Sphk 0, /* numhooks */ 115108255Sphk NULL, /* private */ 116108255Sphk 0, /* ID */ 117108255Sphk LIST_HEAD_INITIALIZER(ng_deadnode.hooks), 118108255Sphk {}, /* all_nodes list entry */ 11913675Sdyson {}, /* id hashtable list entry */ 12072521Sjlemon {}, /* workqueue entry */ 121116546Sphk { 0, 122116546Sphk {}, /* should never use! (should hang) */ 123116546Sphk NULL, 124116546Sphk &ng_deadnode.nd_input_queue.queue, 125116546Sphk &ng_deadnode 126116546Sphk }, 127116546Sphk#ifdef NETGRAPH_DEBUG 128116546Sphk ND_MAGIC, 12972521Sjlemon __FILE__, 13013675Sdyson __LINE__, 13159288Sjlemon {NULL} 13259288Sjlemon#endif /* NETGRAPH_DEBUG */ 13359288Sjlemon}; 13459288Sjlemon 13572521Sjlemonstruct ng_hook ng_deadhook = { 13672521Sjlemon "dead", 13772521Sjlemon NULL, /* private */ 13872521Sjlemon HK_INVALID | HK_DEAD, 13959288Sjlemon 1, /* refs always >= 1 */ 14013675Sdyson &ng_deadhook, /* Peer is self */ 14113675Sdyson &ng_deadnode, /* attached to deadnode */ 14213675Sdyson {}, /* hooks list */ 14313675Sdyson NULL, /* override rcvmsg() */ 14413675Sdyson NULL, /* override rcvdata() */ 14513675Sdyson#ifdef NETGRAPH_DEBUG 14613907Sdyson HK_MAGIC, 14713907Sdyson __FILE__, 14813675Sdyson __LINE__, 14913907Sdyson {NULL} 15017163Sdyson#endif /* NETGRAPH_DEBUG */ 15117163Sdyson}; 15217163Sdyson 15333181Seivind/* 15417163Sdyson * END DEAD STRUCTURES 155117325Ssilby */ 15617124Sbde/* List nodes with unallocated work */ 15713907Sdysonstatic TAILQ_HEAD(, ng_node) ng_worklist = TAILQ_HEAD_INITIALIZER(ng_worklist); 158117325Ssilbystatic struct mtx ng_worklist_mtx; /* MUST LOCK NODE FIRST */ 159117325Ssilby 160121307Ssilby/* List of installed types */ 161117325Ssilbystatic LIST_HEAD(, ng_type) ng_typelist; 162117325Ssilbystatic struct mtx ng_typelist_mtx; 163117364Ssilby 164117364Ssilby/* Hash related definitions */ 165117364Ssilby/* XXX Don't need to initialise them because it's a LIST */ 166117325Ssilby#define NG_ID_HASH_SIZE 32 /* most systems wont need even this many */ 167117325Ssilbystatic LIST_HEAD(, ng_node) ng_ID_hash[NG_ID_HASH_SIZE]; 168117325Ssilbystatic struct mtx ng_idhash_mtx; 16991413Salfred/* Method to find a node.. used twice so do it here */ 17091413Salfred#define NG_IDHASH_FN(ID) ((ID) % (NG_ID_HASH_SIZE)) 17191413Salfred#define NG_IDHASH_FIND(ID, node) \ 172125293Srwatson do { \ 17391413Salfred LIST_FOREACH(node, &ng_ID_hash[NG_IDHASH_FN(ID)], \ 17491413Salfred nd_idnodes) { \ 17591413Salfred if (NG_NODE_IS_VALID(node) \ 17614037Sdyson && (NG_NODE_ID(node) == ID)) { \ 17791413Salfred break; \ 17891413Salfred } \ 17991413Salfred } \ 18091413Salfred } while (0) 18114037Sdyson 18291413Salfred 18313675Sdyson/* Internal functions */ 184125293Srwatsonstatic int ng_add_hook(node_p node, const char *name, hook_p * hookp); 185125293Srwatsonstatic int ng_generic_msg(node_p here, item_p item, hook_p lasthook); 186125293Srwatsonstatic ng_ID_t ng_decodeidname(const char *name); 187125293Srwatsonstatic int ngb_mod_event(module_t mod, int event, void *data); 188125293Srwatsonstatic void ng_worklist_remove(node_p node); 18992751Sjeffstatic void ngintr(void); 19027899Sdysonstatic int ng_apply_item(node_p node, item_p item); 19191372Salfredstatic void ng_flush_input_queue(struct ng_queue * ngq); 19291372Salfredstatic void ng_setisr(node_p node); 19391372Salfredstatic node_p ng_ID2noderef(ng_ID_t ID); 19491372Salfredstatic int ng_con_nodes(node_p node, const char *name, node_p node2, 19591372Salfred const char *name2); 196118880Salcstatic void ng_con_part2(node_p node, hook_p hook, void *arg1, int arg2); 197125293Srwatsonstatic void ng_con_part3(node_p node, hook_p hook, void *arg1, int arg2); 198125293Srwatsonstatic int ng_mkpeer(node_p node, const char *name, 199125293Srwatson const char *name2, char *type); 200118880Salc 20191372Salfred/* imported , these used to be externally visible, some may go back */ 20291372Salfredint ng_bypass(hook_p hook1, hook_p hook2); 203125293Srwatsonvoid ng_destroy_hook(hook_p hook); 204125293Srwatsonnode_p ng_name2noderef(node_p node, const char *name); 205125293Srwatsonint ng_path2noderef(node_p here, const char *path, 206125293Srwatson node_p *dest, hook_p *lasthook); 207125293Srwatsonstruct ng_type *ng_findtype(const char *type); 208125293Srwatsonint ng_make_node(const char *type, node_p *nodepp); 209125293Srwatsonint ng_path_parse(char *addr, char **node, char **path, char **hook); 210125293Srwatsonvoid ng_rmnode(node_p node, hook_p dummy1, void *dummy2, int dummy3); 211125293Srwatsonvoid ng_unname(node_p node); 212125293Srwatson 213125293Srwatson 214125293Srwatson/* Our own netgraph malloc type */ 215125293SrwatsonMALLOC_DEFINE(M_NETGRAPH, "netgraph", "netgraph structures and ctrl messages"); 216125293SrwatsonMALLOC_DEFINE(M_NETGRAPH_HOOK, "netgraph_hook", "netgraph hook structures"); 217125293SrwatsonMALLOC_DEFINE(M_NETGRAPH_NODE, "netgraph_node", "netgraph node structures"); 218125293SrwatsonMALLOC_DEFINE(M_NETGRAPH_ITEM, "netgraph_item", "netgraph item structures"); 219125293SrwatsonMALLOC_DEFINE(M_NETGRAPH_META, "netgraph_meta", "netgraph name storage"); 220125293SrwatsonMALLOC_DEFINE(M_NETGRAPH_MSG, "netgraph_msg", "netgraph name storage"); 221125293Srwatson 222125293Srwatson/* Should not be visible outside this file */ 223125293Srwatson 224125293Srwatson#define _NG_ALLOC_HOOK(hook) \ 225125293Srwatson MALLOC(hook, hook_p, sizeof(*hook), M_NETGRAPH_HOOK, M_NOWAIT | M_ZERO) 226125293Srwatson#define _NG_ALLOC_NODE(node) \ 227125293Srwatson MALLOC(node, node_p, sizeof(*node), M_NETGRAPH_NODE, M_NOWAIT | M_ZERO) 228125293Srwatson 229125293Srwatson#ifdef NETGRAPH_DEBUG /*----------------------------------------------*/ 230125293Srwatson/* 231125293Srwatson * In debug mode: 232125293Srwatson * In an attempt to help track reference count screwups 233125293Srwatson * we do not free objects back to the malloc system, but keep them 234125293Srwatson * in a local cache where we can examine them and keep information safely 235125293Srwatson * after they have been freed. 236125293Srwatson * We use this scheme for nodes and hooks, and to some extent for items. 237125293Srwatson */ 238125293Srwatsonstatic __inline hook_p 239125293Srwatsonng_alloc_hook(void) 240125293Srwatson{ 241125293Srwatson hook_p hook; 242125293Srwatson SLIST_ENTRY(ng_hook) temp; 243125293Srwatson mtx_lock(&ng_nodelist_mtx); 244125293Srwatson hook = LIST_FIRST(&ng_freehooks); 245125293Srwatson if (hook) { 246125293Srwatson LIST_REMOVE(hook, hk_hooks); 247125293Srwatson bcopy(&hook->hk_all, &temp, sizeof(temp)); 248125367Srwatson bzero(hook, sizeof(struct ng_hook)); 249125293Srwatson bcopy(&temp, &hook->hk_all, sizeof(temp)); 250125293Srwatson mtx_unlock(&ng_nodelist_mtx); 251125293Srwatson hook->hk_magic = HK_MAGIC; 252125293Srwatson } else { 253125293Srwatson mtx_unlock(&ng_nodelist_mtx); 254125293Srwatson _NG_ALLOC_HOOK(hook); 255125293Srwatson if (hook) { 256125293Srwatson hook->hk_magic = HK_MAGIC; 257125293Srwatson mtx_lock(&ng_nodelist_mtx); 258125293Srwatson SLIST_INSERT_HEAD(&ng_allhooks, hook, hk_all); 259125367Srwatson mtx_unlock(&ng_nodelist_mtx); 260125367Srwatson } 261125293Srwatson } 262125293Srwatson return (hook); 263125293Srwatson} 264125293Srwatson 265125293Srwatsonstatic __inline node_p 266125293Srwatsonng_alloc_node(void) 267125293Srwatson{ 268125293Srwatson node_p node; 269125293Srwatson SLIST_ENTRY(ng_node) temp; 270125293Srwatson mtx_lock(&ng_nodelist_mtx); 271125293Srwatson node = LIST_FIRST(&ng_freenodes); 272125293Srwatson if (node) { 273125293Srwatson LIST_REMOVE(node, nd_nodes); 274125293Srwatson bcopy(&node->nd_all, &temp, sizeof(temp)); 275125293Srwatson bzero(node, sizeof(struct ng_node)); 276125293Srwatson bcopy(&temp, &node->nd_all, sizeof(temp)); 277125293Srwatson mtx_unlock(&ng_nodelist_mtx); 278125293Srwatson node->nd_magic = ND_MAGIC; 279125293Srwatson } else { 280125293Srwatson mtx_unlock(&ng_nodelist_mtx); 281125293Srwatson _NG_ALLOC_NODE(node); 282125293Srwatson if (node) { 283125293Srwatson node->nd_magic = ND_MAGIC; 284125293Srwatson mtx_lock(&ng_nodelist_mtx); 285125293Srwatson SLIST_INSERT_HEAD(&ng_allnodes, node, nd_all); 286125293Srwatson mtx_unlock(&ng_nodelist_mtx); 28713675Sdyson } 288125293Srwatson } 289125293Srwatson return (node); 29013675Sdyson} 29113675Sdyson 29213675Sdyson#define NG_ALLOC_HOOK(hook) do { (hook) = ng_alloc_hook(); } while (0) 29313675Sdyson#define NG_ALLOC_NODE(node) do { (node) = ng_alloc_node(); } while (0) 29483366Sjulian 29583366Sjulian 29613675Sdyson#define NG_FREE_HOOK(hook) \ 29713675Sdyson do { \ 29813675Sdyson mtx_lock(&ng_nodelist_mtx); \ 29913675Sdyson LIST_INSERT_HEAD(&ng_freehooks, hook, hk_hooks); \ 30083366Sjulian hook->hk_magic = 0; \ 30113675Sdyson mtx_unlock(&ng_nodelist_mtx); \ 302125293Srwatson } while (0) 30313675Sdyson 30413675Sdyson#define NG_FREE_NODE(node) \ 30527899Sdyson do { \ 306125293Srwatson mtx_lock(&ng_nodelist_mtx); \ 307125293Srwatson LIST_INSERT_HEAD(&ng_freenodes, node, nd_nodes); \ 308125293Srwatson node->nd_magic = 0; \ 309126249Srwatson mtx_unlock(&ng_nodelist_mtx); \ 310126249Srwatson } while (0) 311126249Srwatson 312125293Srwatson#else /* NETGRAPH_DEBUG */ /*----------------------------------------------*/ 313125293Srwatson 314125293Srwatson#define NG_ALLOC_HOOK(hook) _NG_ALLOC_HOOK(hook) 315125293Srwatson#define NG_ALLOC_NODE(node) _NG_ALLOC_NODE(node) 316125293Srwatson 317125293Srwatson#define NG_FREE_HOOK(hook) do { FREE((hook), M_NETGRAPH_HOOK); } while (0) 318125293Srwatson#define NG_FREE_NODE(node) do { FREE((node), M_NETGRAPH_NODE); } while (0) 319125293Srwatson 320124394Sdes#endif /* NETGRAPH_DEBUG */ /*----------------------------------------------*/ 321124394Sdes 32276364Salfred/* Warning: Generally use NG_FREE_ITEM() instead */ 32376364Salfred#define NG_FREE_ITEM_REAL(item) do { FREE((item), M_NETGRAPH_ITEM); } while (0) 324124394Sdes 32513907Sdyson 32613907Sdyson/* Set this to Debugger("X") to catch all errors as they occur */ 32713675Sdyson#ifndef TRAP_ERROR 32883366Sjulian#define TRAP_ERROR() 32970915Sdwmalone#endif 33070915Sdwmalone 33170915Sdwmalonestatic ng_ID_t nextID = 1; 33270915Sdwmalone 33370915Sdwmalone#ifdef INVARIANTS 334121256Sdwmalone#define CHECK_DATA_MBUF(m) do { \ 33583366Sjulian struct mbuf *n; \ 33670915Sdwmalone int total; \ 33770803Sdwmalone \ 33870803Sdwmalone M_ASSERTPKTHDR(m); \ 33970803Sdwmalone for (total = 0, n = (m); n != NULL; n = n->m_next) \ 34070803Sdwmalone total += n->m_len; \ 34170803Sdwmalone if ((m)->m_pkthdr.len != total) { \ 34270803Sdwmalone panic("%s: %d != %d", \ 34389306Salfred __func__, (m)->m_pkthdr.len, total); \ 34413675Sdyson } \ 34513675Sdyson } while (0) 346109153Sdillon#else 34713675Sdyson#define CHECK_DATA_MBUF(m) 34889306Salfred#endif 34983366Sjulian 35070915Sdwmalone 35189306Salfred/************************************************************************ 35283366Sjulian Parse type definitions for generic messages 35383366Sjulian************************************************************************/ 354124548Sdes 35589306Salfred/* Handy structure parse type defining macro */ 35683366Sjulian#define DEFINE_PARSE_STRUCT_TYPE(lo, up, args) \ 357124391Sdesstatic const struct ng_parse_struct_field \ 35889306Salfred ng_ ## lo ## _type_fields[] = NG_GENERIC_ ## up ## _INFO args; \ 359124391Sdesstatic const struct ng_parse_type ng_generic_ ## lo ## _type = { \ 36083366Sjulian &ng_parse_struct_type, \ 36170915Sdwmalone &ng_ ## lo ## _type_fields \ 36270915Sdwmalone} 36370915Sdwmalone 36470915SdwmaloneDEFINE_PARSE_STRUCT_TYPE(mkpeer, MKPEER, ()); 365121256SdwmaloneDEFINE_PARSE_STRUCT_TYPE(connect, CONNECT, ()); 36689306SalfredDEFINE_PARSE_STRUCT_TYPE(name, NAME, ()); 36713675SdysonDEFINE_PARSE_STRUCT_TYPE(rmhook, RMHOOK, ()); 36813675SdysonDEFINE_PARSE_STRUCT_TYPE(nodeinfo, NODEINFO, ()); 369109153SdillonDEFINE_PARSE_STRUCT_TYPE(typeinfo, TYPEINFO, ()); 37013675SdysonDEFINE_PARSE_STRUCT_TYPE(linkinfo, LINKINFO, (&ng_generic_nodeinfo_type)); 37189306Salfred 372121256Sdwmalone/* Get length of an array when the length is stored as a 32 bit 37383366Sjulian value immediately preceding the array -- as with struct namelist 37483366Sjulian and struct typelist. */ 37513675Sdysonstatic int 37613675Sdysonng_generic_list_getLength(const struct ng_parse_type *type, 37713675Sdyson const u_char *start, const u_char *buf) 37813675Sdyson{ 37913909Sdyson return *((const u_int32_t *)(buf - 4)); 38013909Sdyson} 38176364Salfred 38276364Salfred/* Get length of the array of struct linkinfo inside a struct hooklist */ 38376364Salfredstatic int 38413909Sdysonng_generic_linkinfo_getLength(const struct ng_parse_type *type, 38576364Salfred const u_char *start, const u_char *buf) 38676364Salfred{ 38713675Sdyson const struct hooklist *hl = (const struct hooklist *)start; 38876364Salfred 38913675Sdyson return hl->nodeinfo.hooks; 39076364Salfred} 391122163Salc 392117325Ssilby/* Array type for a variable length array of struct namelist */ 393117325Ssilbystatic const struct ng_parse_array_info ng_nodeinfoarray_type_info = { 39413675Sdyson &ng_generic_nodeinfo_type, 395125293Srwatson &ng_generic_list_getLength 39679224Sdillon}; 397118764Ssilbystatic const struct ng_parse_type ng_generic_nodeinfoarray_type = { 39813675Sdyson &ng_parse_array_type, 39914037Sdyson &ng_nodeinfoarray_type_info 40013675Sdyson}; 401118764Ssilby 40213675Sdyson/* Array type for a variable length array of struct typelist */ 40313675Sdysonstatic const struct ng_parse_array_info ng_typeinfoarray_type_info = { 40413675Sdyson &ng_generic_typeinfo_type, 40514037Sdyson &ng_generic_list_getLength 40613675Sdyson}; 407122163Salcstatic const struct ng_parse_type ng_generic_typeinfoarray_type = { 40876364Salfred &ng_parse_array_type, 40913688Sdyson &ng_typeinfoarray_type_info 41076364Salfred}; 411118764Ssilby 412123915Ssilby/* Array type for array of struct linkinfo in struct hooklist */ 41376364Salfredstatic const struct ng_parse_array_info ng_generic_linkinfo_array_type_info = { 41476364Salfred &ng_generic_linkinfo_type, 41576364Salfred &ng_generic_linkinfo_getLength 41676364Salfred}; 41776364Salfredstatic const struct ng_parse_type ng_generic_linkinfo_array_type = { 41876364Salfred &ng_parse_array_type, 41976364Salfred &ng_generic_linkinfo_array_type_info 42076364Salfred}; 42176364Salfred 42276364SalfredDEFINE_PARSE_STRUCT_TYPE(typelist, TYPELIST, (&ng_generic_nodeinfoarray_type)); 423110816SalcDEFINE_PARSE_STRUCT_TYPE(hooklist, HOOKLIST, 42476364Salfred (&ng_generic_nodeinfo_type, &ng_generic_linkinfo_array_type)); 42513907SdysonDEFINE_PARSE_STRUCT_TYPE(listnodes, LISTNODES, 42613688Sdyson (&ng_generic_nodeinfoarray_type)); 42713907Sdyson 42813675Sdyson/* List of commands and how to convert arguments to/from ASCII */ 42913675Sdysonstatic const struct ng_cmdlist ng_generic_cmds[] = { 43013675Sdyson { 43113907Sdyson NGM_GENERIC_COOKIE, 43213675Sdyson NGM_SHUTDOWN, 43313907Sdyson "shutdown", 43413675Sdyson NULL, 43513776Sdyson NULL 43676364Salfred }, 43791362Salfred { 43891362Salfred NGM_GENERIC_COOKIE, 43913675Sdyson NGM_MKPEER, 44091362Salfred "mkpeer", 44191362Salfred &ng_generic_mkpeer_type, 44276760Salfred NULL 443124394Sdes }, 44476760Salfred { 44513675Sdyson NGM_GENERIC_COOKIE, 44691362Salfred NGM_CONNECT, 44776760Salfred "connect", 44813675Sdyson &ng_generic_connect_type, 44913675Sdyson NULL 45013675Sdyson }, 45113675Sdyson { 45213675Sdyson NGM_GENERIC_COOKIE, 45313675Sdyson NGM_NAME, 45413675Sdyson "name", 45513675Sdyson &ng_generic_name_type, 45613675Sdyson NULL 45776364Salfred }, 45891362Salfred { 45991362Salfred NGM_GENERIC_COOKIE, 46013675Sdyson NGM_RMHOOK, 46113675Sdyson "rmhook", 46214177Sdyson &ng_generic_rmhook_type, 46313675Sdyson NULL 46413675Sdyson }, 46513675Sdyson { 46614037Sdyson NGM_GENERIC_COOKIE, 46714037Sdyson NGM_NODEINFO, 46814037Sdyson "nodeinfo", 46914037Sdyson NULL, 47076364Salfred &ng_generic_nodeinfo_type 471126252Srwatson }, 47214037Sdyson { 47314037Sdyson NGM_GENERIC_COOKIE, 474122352Stanimura NGM_LISTHOOKS, 47514037Sdyson "listhooks", 47641086Struckman NULL, 47795883Salfred &ng_generic_hooklist_type 47859288Sjlemon }, 47914037Sdyson { 48014037Sdyson NGM_GENERIC_COOKIE, 481126131Sgreen NGM_LISTNAMES, 482126131Sgreen "listnames", 483126131Sgreen NULL, 484126131Sgreen &ng_generic_listnodes_type /* same as NGM_LISTNODES */ 485126131Sgreen }, 486126131Sgreen { 487126131Sgreen NGM_GENERIC_COOKIE, 488126131Sgreen NGM_LISTNODES, 489126131Sgreen "listnodes", 490126131Sgreen NULL, 491126131Sgreen &ng_generic_listnodes_type 492126131Sgreen }, 493126131Sgreen { 494126131Sgreen NGM_GENERIC_COOKIE, 495126131Sgreen NGM_LISTTYPES, 496126131Sgreen "listtypes", 497126131Sgreen NULL, 498126131Sgreen &ng_generic_typeinfo_type 499126131Sgreen }, 500126131Sgreen { 501126131Sgreen NGM_GENERIC_COOKIE, 502126131Sgreen NGM_TEXT_CONFIG, 503126131Sgreen "textconfig", 504126131Sgreen NULL, 505126131Sgreen &ng_parse_string_type 506126131Sgreen }, 507126131Sgreen { 508126131Sgreen NGM_GENERIC_COOKIE, 509126131Sgreen NGM_TEXT_STATUS, 51013675Sdyson "textstatus", 51113675Sdyson NULL, 512101941Srwatson &ng_parse_string_type 51313675Sdyson }, 51413675Sdyson { 515101941Srwatson NGM_GENERIC_COOKIE, 51683366Sjulian NGM_ASCII2BINARY, 51745311Sdt "ascii2binary", 51813675Sdyson &ng_parse_ng_mesg_type, 519109153Sdillon &ng_parse_ng_mesg_type 52047748Salc }, 52113675Sdyson { 52218863Sdyson NGM_GENERIC_COOKIE, 52313675Sdyson NGM_BINARY2ASCII, 52491362Salfred "binary2ascii", 52513675Sdyson &ng_parse_ng_mesg_type, 52647748Salc &ng_parse_ng_mesg_type 52747748Salc }, 52847748Salc { 0 } 52947748Salc}; 530101768Srwatson 531125293Srwatson/************************************************************************ 532101768Srwatson Node routines 533101768Srwatson************************************************************************/ 534101768Srwatson 535101768Srwatson/* 53613675Sdyson * Instantiate a node of the requested type 53713907Sdyson */ 53813907Sdysonint 53913907Sdysonng_make_node(const char *typename, node_p *nodepp) 54013675Sdyson{ 54118863Sdyson struct ng_type *type; 54213675Sdyson int error; 54313675Sdyson 54418863Sdyson /* Check that the type makes sense */ 54518863Sdyson if (typename == NULL) { 54647748Salc TRAP_ERROR(); 54791362Salfred return (EINVAL); 548116127Smux } 549116127Smux 550116127Smux /* Locate the node type */ 55191362Salfred if ((type = ng_findtype(typename)) == NULL) { 55276760Salfred char filename[NG_TYPELEN + 4]; 55313675Sdyson linker_file_t lf; 55476760Salfred int error; 55513675Sdyson 55613675Sdyson /* Not found, try to load it as a loadable module */ 55713675Sdyson snprintf(filename, sizeof(filename), "ng_%s", typename); 55813675Sdyson error = linker_load_module(NULL, filename, NULL, NULL, &lf); 55913675Sdyson if (error != 0) 56047748Salc return (error); 56147748Salc lf->userrefs++; /* pretend loaded by the syscall */ 56247748Salc 56347748Salc /* Try again, as now the type should have linked itself in */ 56447748Salc if ((type = ng_findtype(typename)) == NULL) 56547748Salc return (ENXIO); 56647748Salc } 56747748Salc 56847748Salc /* 56947748Salc * If we have a constructor, then make the node and 57013675Sdyson * call the constructor to do type specific initialisation. 57114037Sdyson */ 57213907Sdyson if (type->constructor != NULL) { 57313907Sdyson if ((error = ng_make_node_common(type, nodepp)) == 0) { 57413907Sdyson if ((error = ((*type->constructor)(*nodepp)) != 0)) { 57513907Sdyson NG_NODE_UNREF(*nodepp); 57647748Salc } 57718863Sdyson } 57818863Sdyson } else { 57947748Salc /* 58091362Salfred * Node has no constructor. We cannot ask for one 581127501Salc * to be made. It must be brought into existance by 582127501Salc * some external agency. The external agency should 58391362Salfred * call ng_make_node_common() directly to get the 58413907Sdyson * netgraph part initialised. 58513907Sdyson */ 58613907Sdyson TRAP_ERROR(); 58713907Sdyson error = EINVAL; 58813907Sdyson } 58913907Sdyson return (error); 59013907Sdyson} 59113907Sdyson 59213907Sdyson/* 59314037Sdyson * Generic node creation. Called by node initialisation for externally 59413675Sdyson * instantiated nodes (e.g. hardware, sockets, etc ). 59513675Sdyson * The returned node has a reference count of 1. 59613675Sdyson */ 59776760Salfredint 59813675Sdysonng_make_node_common(struct ng_type *type, node_p *nodepp) 59976760Salfred{ 60013675Sdyson node_p node; 60143623Sdillon 60213675Sdyson /* Require the node type to have been already installed */ 60313675Sdyson if (ng_findtype(type->name) == NULL) { 60413675Sdyson TRAP_ERROR(); 60513675Sdyson return (EINVAL); 60613675Sdyson } 60713675Sdyson 60813675Sdyson /* Make a node and try attach it to the type */ 60943623Sdillon NG_ALLOC_NODE(node); 61043623Sdillon if (node == NULL) { 61147748Salc TRAP_ERROR(); 61243623Sdillon return (ENOMEM); 61347748Salc } 61413675Sdyson node->nd_type = type; 61516960Sdyson NG_NODE_REF(node); /* note reference */ 61643623Sdillon type->refs++; 617124394Sdes 618116127Smux mtx_init(&node->nd_input_queue.q_mtx, "ng_node", NULL, MTX_SPIN); 619116127Smux node->nd_input_queue.queue = NULL; 62043623Sdillon node->nd_input_queue.last = &node->nd_input_queue.queue; 62147748Salc node->nd_input_queue.q_flags = 0; 62243623Sdillon node->nd_input_queue.q_node = node; 62313675Sdyson 62447748Salc /* Initialize hook list for new node */ 62547748Salc LIST_INIT(&node->nd_hooks); 62613675Sdyson 62776760Salfred /* Link us into the node linked list */ 62847748Salc mtx_lock(&ng_nodelist_mtx); 62976760Salfred LIST_INSERT_HEAD(&ng_nodelist, node, nd_nodes); 63047748Salc mtx_unlock(&ng_nodelist_mtx); 63191362Salfred 63291362Salfred 63377140Salfred /* get an ID and put us in the hash chain */ 63447748Salc mtx_lock(&ng_idhash_mtx); 63513675Sdyson for (;;) { /* wrap protection, even if silly */ 63647748Salc node_p node2 = NULL; 63747748Salc node->nd_ID = nextID++; /* 137/second for 1 year before wrap */ 63813675Sdyson 63913675Sdyson /* Is there a problem with the new number? */ 640101768Srwatson NG_IDHASH_FIND(node->nd_ID, node2); /* already taken? */ 641101768Srwatson if ((node->nd_ID != 0) && (node2 == NULL)) { 642101768Srwatson break; 64347748Salc } 64413675Sdyson } 64591362Salfred LIST_INSERT_HEAD(&ng_ID_hash[NG_IDHASH_FN(node->nd_ID)], 64624101Sbde node, nd_idnodes); 64755112Sbde mtx_unlock(&ng_idhash_mtx); 64847748Salc 64947748Salc /* Done */ 65013913Sdyson *nodepp = node; 65147748Salc return (0); 65247748Salc} 65347748Salc 65413675Sdyson/* 65513675Sdyson * Forceably start the shutdown process on a node. Either call 65613675Sdyson * it's shutdown method, or do the default shutdown if there is 65713675Sdyson * no type-specific method. 65813675Sdyson * 65947748Salc * We can only be called form a shutdown message, so we know we have 66013675Sdyson * a writer lock, and therefore exclusive access. It also means 66113675Sdyson * that we should not be on the work queue, but we check anyhow. 66213675Sdyson * 66313675Sdyson * Persistent node types must have a type-specific method which 66413675Sdyson * Allocates a new node in which case, this one is irretrievably going away, 66513675Sdyson * or cleans up anything it needs, and just makes the node valid again, 66614037Sdyson * in which case we allow the node to survive. 66714802Sdyson * 66814037Sdyson * XXX We need to think of how to tell a persistant node that we 66914037Sdyson * REALLY need to go away because the hardware has gone or we 67091362Salfred * are rebooting.... etc. 67176760Salfred */ 67213675Sdysonvoid 67313675Sdysonng_rmnode(node_p node, hook_p dummy1, void *dummy2, int dummy3) 67414037Sdyson{ 67513907Sdyson hook_p hook; 67613907Sdyson 67713907Sdyson /* Check if it's already shutting down */ 67813907Sdyson if ((node->nd_flags & NG_CLOSING) != 0) 67913675Sdyson return; 68013907Sdyson 68113907Sdyson if (node == &ng_deadnode) { 68213675Sdyson printf ("shutdown called on deadnode\n"); 68313675Sdyson return; 684119872Salc } 68518863Sdyson 686119872Salc /* Add an extra reference so it doesn't go away during this */ 687112569Sjake NG_NODE_REF(node); 68813907Sdyson 68991412Salfred /* 69079224Sdillon * Mark it invalid so any newcomers know not to try use it 69118863Sdyson * Also add our own mark so we can't recurse 69213907Sdyson * note that NG_INVALID does not do this as it's also set during 69313907Sdyson * creation 69413907Sdyson */ 695119872Salc node->nd_flags |= NG_INVALID|NG_CLOSING; 69640286Sdg 69776760Salfred /* Notify all remaining connected nodes to disconnect */ 69876760Salfred while ((hook = LIST_FIRST(&node->nd_hooks)) != NULL) 69999899Salc ng_destroy_hook(hook); 70099899Salc 70199899Salc /* 70299899Salc * Drain the input queue forceably. 70399899Salc * it has no hooks so what's it going to do, bleed on someone? 704119872Salc * Theoretically we came here from a queue entry that was added 705119872Salc * Just before the queue was closed, so it should be empty anyway. 70699899Salc * Also removes us from worklist if needed. 707119872Salc */ 708118757Salc ng_flush_input_queue(&node->nd_input_queue); 70999899Salc 71076760Salfred /* Ask the type if it has anything to do in this case */ 71113907Sdyson if (node->nd_type && node->nd_type->shutdown) { 712120000Salc (*node->nd_type->shutdown)(node); 713120000Salc if (NG_NODE_IS_VALID(node)) { 714119872Salc /* 715119872Salc * Well, blow me down if the node code hasn't declared 71613907Sdyson * that it doesn't want to die. 71713907Sdyson * Presumably it is a persistant node. 71813907Sdyson * If we REALLY want it to go away, 71913907Sdyson * e.g. hardware going away, 72013907Sdyson * Our caller should set NG_REALLY_DIE in nd_flags. 72113907Sdyson */ 72276760Salfred node->nd_flags &= ~(NG_INVALID|NG_CLOSING); 72376760Salfred NG_NODE_UNREF(node); /* Assume they still have theirs */ 72413907Sdyson return; 72513907Sdyson } 72613907Sdyson } else { /* do the default thing */ 72713907Sdyson NG_NODE_UNREF(node); 72813907Sdyson } 72913907Sdyson 73013907Sdyson ng_unname(node); /* basically a NOP these days */ 731104908Smike 73213907Sdyson /* 73313907Sdyson * Remove extra reference, possibly the last 73413907Sdyson * Possible other holders of references may include 73513907Sdyson * timeout callouts, but theoretically the node's supposed to 73676760Salfred * have cancelled them. Possibly hardware dependencies may 73713907Sdyson * force a driver to 'linger' with a reference. 73813907Sdyson */ 73913907Sdyson NG_NODE_UNREF(node); 74013907Sdyson} 74113907Sdyson 74213907Sdyson#ifdef NETGRAPH_DEBUG 74313907Sdysonvoid 74476760Salfredng_ref_node(node_p node) 74513907Sdyson{ 74613907Sdyson _NG_NODE_REF(node); 74776364Salfred} 748127501Salc#endif 74999899Salc 750117325Ssilby/* 751118757Salc * Remove a reference to the node, possibly the last. 752117325Ssilby * deadnode always acts as it it were the last. 75399899Salc */ 75491653Stanimuraint 75513907Sdysonng_unref_node(node_p node) 75613907Sdyson{ 75713907Sdyson int v; 75813907Sdyson 75913907Sdyson if (node == &ng_deadnode) { 76013907Sdyson return (0); 76113907Sdyson } 76213907Sdyson 76313907Sdyson do { 76476364Salfred v = node->nd_refs - 1; 76513907Sdyson } while (! atomic_cmpset_int(&node->nd_refs, v + 1, v)); 766127501Salc 767127501Salc if (v == 0) { /* we were the last */ 76813907Sdyson 76913907Sdyson mtx_lock(&ng_nodelist_mtx); 77013907Sdyson node->nd_type->refs--; /* XXX maybe should get types lock? */ 77191362Salfred LIST_REMOVE(node, nd_nodes); 77213907Sdyson mtx_unlock(&ng_nodelist_mtx); 77313907Sdyson 77413907Sdyson mtx_lock(&ng_idhash_mtx); 77513907Sdyson LIST_REMOVE(node, nd_idnodes); 77613907Sdyson mtx_unlock(&ng_idhash_mtx); 77713907Sdyson 77813907Sdyson mtx_destroy(&node->nd_input_queue.q_mtx); 77913907Sdyson NG_FREE_NODE(node); 780119811Salc } 781127501Salc return (v); 782127501Salc} 783127501Salc 784127501Salc/************************************************************************ 785127501Salc Node ID handling 786127501Salc************************************************************************/ 787127501Salcstatic node_p 788127501Salcng_ID2noderef(ng_ID_t ID) 789127501Salc{ 790127501Salc node_p node; 791127501Salc mtx_lock(&ng_idhash_mtx); 79213907Sdyson NG_IDHASH_FIND(ID, node); 79313907Sdyson if(node) 79413907Sdyson NG_NODE_REF(node); 79513907Sdyson mtx_unlock(&ng_idhash_mtx); 79613907Sdyson return(node); 79713907Sdyson} 79813907Sdyson 79913907Sdysonng_ID_t 80013907Sdysonng_node2ID(node_p node) 80113907Sdyson{ 80213907Sdyson return (node ? NG_NODE_ID(node) : 0); 80313907Sdyson} 80413907Sdyson 80513907Sdyson/************************************************************************ 80613907Sdyson Node name handling 80713907Sdyson************************************************************************/ 80876364Salfred 80913951Sdyson/* 81091362Salfred * Assign a node a name. Once assigned, the name cannot be changed. 81113907Sdyson */ 81276760Salfredint 81313951Sdysonng_name_node(node_p node, const char *name) 81413951Sdyson{ 81513951Sdyson int i; 81613992Sdyson node_p node2; 81791362Salfred 81891362Salfred /* Check the name is valid */ 81914802Sdyson for (i = 0; i < NG_NODELEN + 1; i++) { 82013907Sdyson if (name[i] == '\0' || name[i] == '.' || name[i] == ':') 82114802Sdyson break; 82214802Sdyson } 82314802Sdyson if (i == 0 || name[i] != '\0') { 82414802Sdyson TRAP_ERROR(); 82513907Sdyson return (EINVAL); 82613907Sdyson } 82713951Sdyson if (ng_decodeidname(name) != 0) { /* valid IDs not allowed here */ 82876760Salfred TRAP_ERROR(); 82913951Sdyson return (EINVAL); 83013951Sdyson } 83113951Sdyson 832124394Sdes /* Check the name isn't already being used */ 83313992Sdyson if ((node2 = ng_name2noderef(node, name)) != NULL) { 83491362Salfred NG_NODE_UNREF(node2); 83591362Salfred TRAP_ERROR(); 83614802Sdyson return (EADDRINUSE); 83713907Sdyson } 83814802Sdyson 83914802Sdyson /* copy it */ 84014802Sdyson strncpy(NG_NODE_NAME(node), name, NG_NODELEN); 84113907Sdyson 84213951Sdyson return (0); 84313907Sdyson} 84413907Sdyson 84513951Sdyson/* 84613951Sdyson * Find a node by absolute name. The name should NOT end with ':' 84792305Salfred * The name "." means "this node" and "[xxx]" means "the node 848126131Sgreen * with ID (ie, at address) xxx". 849126131Sgreen * 850126131Sgreen * Returns the node if found, else NULL. 851126131Sgreen * Eventually should add something faster than a sequential search. 852119872Salc * Note it aquires a reference on the node so you can be sure it's still there. 85313907Sdyson */ 854119872Salcnode_p 85592305Salfredng_name2noderef(node_p here, const char *name) 85613907Sdyson{ 85713907Sdyson node_p node; 85813907Sdyson ng_ID_t temp; 85913907Sdyson 86013907Sdyson /* "." means "this node" */ 86113907Sdyson if (strcmp(name, ".") == 0) { 86213907Sdyson NG_NODE_REF(here); 86313907Sdyson return(here); 86413907Sdyson } 86513907Sdyson 866112981Shsu /* Check for name-by-ID */ 86713907Sdyson if ((temp = ng_decodeidname(name)) != 0) { 86814802Sdyson return (ng_ID2noderef(temp)); 86914802Sdyson } 87013907Sdyson 87113992Sdyson /* Find node by name */ 87213992Sdyson mtx_lock(&ng_nodelist_mtx); 87313992Sdyson LIST_FOREACH(node, &ng_nodelist, nd_nodes) { 87413992Sdyson if (NG_NODE_IS_VALID(node) 87514037Sdyson && NG_NODE_HAS_NAME(node) 87691362Salfred && (strcmp(NG_NODE_NAME(node), name) == 0)) { 87791362Salfred break; 87813907Sdyson } 87913907Sdyson } 88013907Sdyson if (node) 881126131Sgreen NG_NODE_REF(node); 882126131Sgreen mtx_unlock(&ng_nodelist_mtx); 88313907Sdyson return (node); 88413907Sdyson} 88513907Sdyson 88613907Sdyson/* 88713907Sdyson * Decode an ID name, eg. "[f03034de]". Returns 0 if the 88813907Sdyson * string is not valid, otherwise returns the value. 88913907Sdyson */ 89013907Sdysonstatic ng_ID_t 89113907Sdysonng_decodeidname(const char *name) 892126131Sgreen{ 89313907Sdyson const int len = strlen(name); 89476760Salfred char *eptr; 89513907Sdyson u_long val; 89613907Sdyson 89713907Sdyson /* Check for proper length, brackets, no leading junk */ 89876760Salfred if ((len < 3) 89913907Sdyson || (name[0] != '[') 90014037Sdyson || (name[len - 1] != ']') 901124394Sdes || (!isxdigit(name[1]))) { 90216960Sdyson return ((ng_ID_t)0); 903101941Srwatson } 90416960Sdyson 90513907Sdyson /* Decode number */ 906101941Srwatson val = strtoul(name + 1, &eptr, 16); 90783366Sjulian if ((eptr - name != len - 1) 90845311Sdt || (val == ULONG_MAX) 90913907Sdyson || (val == 0)) { 91013675Sdyson return ((ng_ID_t)0); 91113913Sdyson } 91216960Sdyson return (ng_ID_t)val; 91316960Sdyson} 914109153Sdillon 91516960Sdyson/* 91616960Sdyson * Remove a name from a node. This should only be called 91791395Salfred * when shutting down and removing the node. 91813675Sdyson * IF we allow name changing this may be more resurected. 91913675Sdyson */ 92013675Sdysonvoid 921125364Srwatsonng_unname(node_p node) 92291395Salfred{ 92376760Salfred} 92413675Sdyson 925101768Srwatson/************************************************************************ 926125293Srwatson Hook routines 927101768Srwatson Names are not optional. Hooks are always connected, except for a 928101768Srwatson brief moment within these routines. On invalidation or during creation 929101768Srwatson they are connected to the 'dead' hook. 930101768Srwatson************************************************************************/ 931101768Srwatson 93277676Sdillon/* 93313675Sdyson * Remove a hook reference 93417163Sdyson */ 93517163Sdysonvoid 93617163Sdysonng_unref_hook(hook_p hook) 93717163Sdyson{ 93817163Sdyson int v; 939118764Ssilby 94017163Sdyson if (hook == &ng_deadhook) { 94117163Sdyson return; 94217163Sdyson } 94317163Sdyson do { 94417163Sdyson v = hook->hk_refs; 945105009Salfred } while (! atomic_cmpset_int(&hook->hk_refs, v, v - 1)); 946126131Sgreen 947126131Sgreen if (v == 1) { /* we were the last */ 948126131Sgreen if (_NG_HOOK_NODE(hook)) { /* it'll probably be ng_deadnode */ 949126131Sgreen _NG_NODE_UNREF((_NG_HOOK_NODE(hook))); 950126131Sgreen hook->hk_node = NULL; 951126131Sgreen } 952126131Sgreen NG_FREE_HOOK(hook); 953126131Sgreen } 95413907Sdyson} 95513907Sdyson 95613907Sdyson/* 95777676Sdillon * Add an unconnected hook to a node. Only used internally. 95877676Sdillon * Assumes node is locked. (XXX not yet true ) 95977676Sdillon */ 96077676Sdillonstatic int 96177676Sdillonng_add_hook(node_p node, const char *name, hook_p *hookp) 96277676Sdillon{ 96377676Sdillon hook_p hook; 964124394Sdes int error = 0; 96577676Sdillon 96677676Sdillon /* Check that the given name is good */ 96777676Sdillon if (name == NULL) { 96877676Sdillon TRAP_ERROR(); 96991395Salfred return (EINVAL); 97077676Sdillon } 97177676Sdillon if (ng_findhook(node, name) != NULL) { 972124394Sdes TRAP_ERROR(); 97313913Sdyson return (EEXIST); 97477676Sdillon } 97513675Sdyson 97613907Sdyson /* Allocate the hook and link it up */ 97776760Salfred NG_ALLOC_HOOK(hook); 97814037Sdyson if (hook == NULL) { 97913907Sdyson TRAP_ERROR(); 98013907Sdyson return (ENOMEM); 98113907Sdyson } 98216416Sdyson hook->hk_refs = 1; /* add a reference for us to return */ 98316416Sdyson hook->hk_flags = HK_INVALID; 98458505Sdillon hook->hk_peer = &ng_deadhook; /* start off this way */ 98558505Sdillon hook->hk_node = node; 98658505Sdillon NG_NODE_REF(node); /* each hook counts as a reference */ 98713907Sdyson 98817163Sdyson /* Set hook name */ 989127501Salc strncpy(NG_HOOK_NAME(hook), name, NG_HOOKLEN); 990105009Salfred 99176760Salfred /* 99213907Sdyson * Check if the node type code has something to say about it 99313907Sdyson * If it fails, the unref of the hook will also unref the node. 99491362Salfred */ 99514037Sdyson if (node->nd_type->newhook != NULL) { 99613907Sdyson if ((error = (*node->nd_type->newhook)(node, hook, name))) { 99713907Sdyson NG_HOOK_UNREF(hook); /* this frees the hook */ 99813907Sdyson return (error); 99913907Sdyson } 100013907Sdyson } 100158505Sdillon /* 100258505Sdillon * The 'type' agrees so far, so go ahead and link it in. 100313907Sdyson * We'll ask again later when we actually connect the hooks. 100413907Sdyson */ 100513907Sdyson LIST_INSERT_HEAD(&node->nd_hooks, hook, hk_hooks); 100613992Sdyson node->nd_numhooks++; 100713992Sdyson NG_HOOK_REF(hook); /* one for the node */ 100813992Sdyson 100913992Sdyson if (hookp) 101091395Salfred *hookp = hook; 101191362Salfred return (0); 1012126131Sgreen} 1013126131Sgreen 101458505Sdillon/* 1015126131Sgreen * Find a hook 101613907Sdyson * 101713907Sdyson * Node types may supply their own optimized routines for finding 101813907Sdyson * hooks. If none is supplied, we just do a linear search. 101913907Sdyson * XXX Possibly we should add a reference to the hook? 102013907Sdyson */ 102114644Sdysonhook_p 102214644Sdysonng_findhook(node_p node, const char *name) 102313913Sdyson{ 102413913Sdyson hook_p hook; 102513907Sdyson 1026118230Spb if (node->nd_type->findhook != NULL) 102713907Sdyson return (*node->nd_type->findhook)(node, name); 102854534Stegge LIST_FOREACH(hook, &node->nd_hooks, hk_hooks) { 102954534Stegge if (NG_HOOK_IS_VALID(hook) 103076760Salfred && (strcmp(NG_HOOK_NAME(hook), name) == 0)) 103113907Sdyson return (hook); 1032126131Sgreen } 1033126131Sgreen return (NULL); 103413907Sdyson} 1035126131Sgreen 1036126131Sgreen/* 103713907Sdyson * Destroy a hook 103813907Sdyson * 103913907Sdyson * As hooks are always attached, this really destroys two hooks. 104013907Sdyson * The one given, and the one attached to it. Disconnect the hooks 1041124394Sdes * from each other first. We reconnect the peer hook to the 'dead' 104254534Stegge * hook so that it can still exist after we depart. We then 104354534Stegge * send the peer its own destroy message. This ensures that we only 104458505Sdillon * interact with the peer's structures when it is locked processing that 104558505Sdillon * message. We hold a reference to the peer hook so we are guaranteed that 104658505Sdillon * the peer hook and node are still going to exist until 104754534Stegge * we are finished there as the hook holds a ref on the node. 1048124394Sdes * We run this same code again on the peer hook, but that time it is already 104954534Stegge * attached to the 'dead' hook. 105054534Stegge * 105154534Stegge * This routine is called at all stages of hook creation 105254534Stegge * on error detection and must be able to handle any such stage. 105354534Stegge */ 105454534Steggevoid 105554534Steggeng_destroy_hook(hook_p hook) 105654534Stegge{ 105754534Stegge hook_p peer = NG_HOOK_PEER(hook); 105854534Stegge node_p node = NG_HOOK_NODE(hook); 105954534Stegge 106054534Stegge if (hook == &ng_deadhook) { /* better safe than sorry */ 106154534Stegge printf("ng_destroy_hook called on deadhook\n"); 106254534Stegge return; 1063124394Sdes } 106454534Stegge hook->hk_flags |= HK_INVALID; /* as soon as possible */ 106554534Stegge if (peer && (peer != &ng_deadhook)) { 106654534Stegge /* 106754534Stegge * Set the peer to point to ng_deadhook 106854534Stegge * from this moment on we are effectively independent it. 1069124394Sdes * send it an rmhook message of it's own. 107054534Stegge */ 107154534Stegge peer->hk_peer = &ng_deadhook; /* They no longer know us */ 107254534Stegge hook->hk_peer = &ng_deadhook; /* Nor us, them */ 1073124394Sdes if (NG_HOOK_NODE(peer) == &ng_deadnode) { 107454534Stegge /* 107554534Stegge * If it's already divorced from a node, 107691395Salfred * just free it. 1077124394Sdes */ 107854534Stegge /* nothing */ 107991395Salfred } else { 1080124394Sdes ng_rmhook_self(peer); /* Send it a surprise */ 108154534Stegge } 1082124394Sdes NG_HOOK_UNREF(peer); /* account for peer link */ 108354534Stegge NG_HOOK_UNREF(hook); /* account for peer link */ 108454534Stegge } 108554534Stegge 108654534Stegge /* 1087124394Sdes * Remove the hook from the node's list to avoid possible recursion 108854534Stegge * in case the disconnection results in node shutdown. 1089116127Smux */ 1090116127Smux if (node == &ng_deadnode) { /* happens if called from ng_con_nodes() */ 1091124394Sdes return; 109291395Salfred } 1093116127Smux LIST_REMOVE(hook, hk_hooks); 1094116127Smux node->nd_numhooks--; 1095124394Sdes if (node->nd_type->disconnect) { 109691395Salfred /* 109754534Stegge * The type handler may elect to destroy the node so don't 109854534Stegge * trust its existance after this point. (except 109954534Stegge * that we still hold a reference on it. (which we 110054534Stegge * inherrited from the hook we are destroying) 110154534Stegge */ 1102116127Smux (*node->nd_type->disconnect) (hook); 1103116127Smux } 1104116127Smux 1105116127Smux /* 1106116127Smux * Note that because we will point to ng_deadnode, the original node 1107116127Smux * is not decremented automatically so we do that manually. 1108116127Smux */ 110954534Stegge _NG_HOOK_NODE(hook) = &ng_deadnode; 1110124394Sdes NG_NODE_UNREF(node); /* We no longer point to it so adjust count */ 111154534Stegge NG_HOOK_UNREF(hook); /* Account for linkage (in list) to node */ 1112116127Smux} 1113116127Smux 111454534Stegge/* 1115124394Sdes * Take two hooks on a node and merge the connection so that the given node 111654534Stegge * is effectively bypassed. 1117126131Sgreen */ 111813675Sdysonint 111913675Sdysonng_bypass(hook_p hook1, hook_p hook2) 112013675Sdyson{ 112113675Sdyson if (hook1->hk_node != hook2->hk_node) { 112213675Sdyson TRAP_ERROR(); 112313675Sdyson return (EINVAL); 112413675Sdyson } 112513675Sdyson hook1->hk_peer->hk_peer = hook2->hk_peer; 112613675Sdyson hook2->hk_peer->hk_peer = hook1->hk_peer; 112713675Sdyson 112813675Sdyson hook1->hk_peer = &ng_deadhook; 112913675Sdyson hook2->hk_peer = &ng_deadhook; 113013675Sdyson 113114037Sdyson /* XXX If we ever cache methods on hooks update them as well */ 113213675Sdyson ng_destroy_hook(hook1); 113313675Sdyson ng_destroy_hook(hook2); 113413675Sdyson return (0); 113516960Sdyson} 113613907Sdyson 113713675Sdyson/* 113813675Sdyson * Install a new netgraph type 113913907Sdyson */ 114014037Sdysonint 114114037Sdysonng_newtype(struct ng_type *tp) 114229356Speter{ 114314037Sdyson const size_t namelen = strlen(tp->name); 114414037Sdyson 114514037Sdyson /* Check version and type name fields */ 114613675Sdyson if ((tp->version != NG_ABI_VERSION) 114791395Salfred || (namelen == 0) 114891362Salfred || (namelen > NG_TYPELEN)) { 114976760Salfred TRAP_ERROR(); 115013675Sdyson return (EINVAL); 115113675Sdyson } 115213675Sdyson 115313675Sdyson /* Check for name collision */ 115413675Sdyson if (ng_findtype(tp->name) != NULL) { 115513675Sdyson TRAP_ERROR(); 115613774Sdyson return (EEXIST); 115713907Sdyson } 1158124394Sdes 115913675Sdyson 116013675Sdyson /* Link in new type */ 116113675Sdyson mtx_lock(&ng_typelist_mtx); 116214644Sdyson LIST_INSERT_HEAD(&ng_typelist, tp, types); 116377676Sdillon tp->refs = 1; /* first ref is linked list */ 116476760Salfred mtx_unlock(&ng_typelist_mtx); 116576760Salfred return (0); 116613675Sdyson} 116713675Sdyson 116813675Sdyson/* 116913675Sdyson * unlink a netgraph type 117013675Sdyson * If no examples exist 117113675Sdyson */ 117213675Sdysonint 117313675Sdysonng_rmtype(struct ng_type *tp) 117413675Sdyson{ 117513675Sdyson /* Check for name collision */ 117613675Sdyson if (tp->refs != 1) { 117713909Sdyson TRAP_ERROR(); 117813909Sdyson return (EBUSY); 117913909Sdyson } 118013909Sdyson 118113907Sdyson /* Unlink type */ 118277676Sdillon mtx_lock(&ng_typelist_mtx); 118377676Sdillon LIST_REMOVE(tp, types); 118413907Sdyson mtx_unlock(&ng_typelist_mtx); 118577676Sdillon return (0); 118613913Sdyson} 118724101Sbde 118855112Sbde/* 118924101Sbde * Look for a type of the name given 119014037Sdyson */ 119114037Sdysonstruct ng_type * 119229356Speterng_findtype(const char *typename) 119314037Sdyson{ 119414177Sdyson struct ng_type *type; 119514037Sdyson 119613907Sdyson mtx_lock(&ng_typelist_mtx); 119791395Salfred LIST_FOREACH(type, &ng_typelist, types) { 119876760Salfred if (strcmp(type->name, typename) == 0) 119913675Sdyson break; 120013675Sdyson } 120113675Sdyson mtx_unlock(&ng_typelist_mtx); 120213675Sdyson return (type); 120313675Sdyson} 1204104094Sphk 1205102003Srwatson/************************************************************************ 120613675Sdyson Composite routines 120736735Sdfr************************************************************************/ 120899009Salfred/* 1209102003Srwatson * Connect two nodes using the specified hooks, using queued functions. 121083366Sjulian */ 121113675Sdysonstatic void 1212109153Sdillonng_con_part3(node_p node, hook_p hook, void *arg1, int arg2) 1213101768Srwatson{ 1214101768Srwatson 1215104269Srwatson /* 121613675Sdyson * When we run, we know that the node 'node' is locked for us. 1217104269Srwatson * Our caller has a reference on the hook. 1218104269Srwatson * Our caller has a reference on the node. 1219104269Srwatson * (In this case our caller is ng_apply_item() ). 1220125293Srwatson * The peer hook has a reference on the hook. 1221121970Srwatson * We are all set up except for the final call to the node, and 1222121970Srwatson * the clearing of the INVALID flag. 1223101768Srwatson */ 1224121970Srwatson if (NG_HOOK_NODE(hook) == &ng_deadnode) { 1225101768Srwatson /* 1226101768Srwatson * The node must have been freed again since we last visited 122713675Sdyson * here. ng_destry_hook() has this effect but nothing else does. 122813675Sdyson * We should just release our references and 122913675Sdyson * free anything we can think of. 1230104269Srwatson * Since we know it's been destroyed, and it's our caller 123113675Sdyson * that holds the references, just return. 123213675Sdyson */ 123313675Sdyson return ; 123413675Sdyson } 123513675Sdyson if (hook->hk_node->nd_type->connect) { 123613675Sdyson if ((*hook->hk_node->nd_type->connect) (hook)) { 123713675Sdyson ng_destroy_hook(hook); /* also zaps peer */ 123813675Sdyson printf("failed in ng_con_part3()\n"); 123991362Salfred return ; 124013675Sdyson } 124113675Sdyson } 124213675Sdyson /* 124314037Sdyson * XXX this is wrong for SMP. Possibly we need 124414037Sdyson * to separate out 'create' and 'invalid' flags. 124514037Sdyson * should only set flags on hooks we have locked under our node. 124614037Sdyson */ 124791362Salfred hook->hk_flags &= ~HK_INVALID; 124813675Sdyson return ; 124913675Sdyson} 125041086Struckman 1251104269Srwatsonstatic void 125241086Struckmanng_con_part2(node_p node, hook_p hook, void *arg1, int arg2) 125341086Struckman{ 125441086Struckman 1255104269Srwatson /* 1256104393Struckman * When we run, we know that the node 'node' is locked for us. 125713675Sdyson * Our caller has a reference on the hook. 125813675Sdyson * Our caller has a reference on the node. 125941086Struckman * (In this case our caller is ng_apply_item() ). 126041086Struckman * The peer hook has a reference on the hook. 1261104269Srwatson * our node pointer points to the 'dead' node. 126241086Struckman * First check the hook name is unique. 126341086Struckman * Should not happen because we checked before queueing this. 126441086Struckman */ 126518863Sdyson if (ng_findhook(node, NG_HOOK_NAME(hook)) != NULL) { 1266104269Srwatson TRAP_ERROR(); 1267104393Struckman ng_destroy_hook(hook); /* should destroy peer too */ 126813675Sdyson printf("failed in ng_con_part2()\n"); 126913675Sdyson return ; 127013675Sdyson } 1271104269Srwatson /* 127217124Sbde * Check if the node type code has something to say about it 127313675Sdyson * If it fails, the unref of the hook will also unref the attached node, 127413675Sdyson * however since that node is 'ng_deadnode' this will do nothing. 1275104094Sphk * The peer hook will also be destroyed. 1276101983Srwatson */ 127713675Sdyson if (node->nd_type->newhook != NULL) { 127829356Speter if ((*node->nd_type->newhook)(node, hook, hook->hk_name)) { 1279101983Srwatson ng_destroy_hook(hook); /* should destroy peer too */ 128083366Sjulian printf("failed in ng_con_part2()\n"); 128113675Sdyson return ; 1282109153Sdillon } 128313675Sdyson } 128429356Speter 1285101768Srwatson /* 1286101768Srwatson * The 'type' agrees so far, so go ahead and link it in. 1287101768Srwatson * We'll ask again later when we actually connect the hooks. 128813675Sdyson */ 128913675Sdyson hook->hk_node = node; /* just overwrite ng_deadnode */ 129091362Salfred NG_NODE_REF(node); /* each hook counts as a reference */ 1291101768Srwatson LIST_INSERT_HEAD(&node->nd_hooks, hook, hk_hooks); 1292125293Srwatson node->nd_numhooks++; 1293101768Srwatson NG_HOOK_REF(hook); /* one for the node */ 1294101768Srwatson 1295101768Srwatson /* 129629356Speter * We now have a symetrical situation, where both hooks have been 129729356Speter * linked to their nodes, the newhook methods have been called 129829356Speter * And the references are all correct. The hooks are still marked 129929356Speter * as invalid, as we have not called the 'connect' methods 130029356Speter * yet. 130113675Sdyson * We can call the local one immediatly as we have the 130229356Speter * node locked, but we need to queue the remote one. 1303125364Srwatson */ 130443311Sdillon if (hook->hk_node->nd_type->connect) { 130543311Sdillon if ((*hook->hk_node->nd_type->connect) (hook)) { 130629356Speter ng_destroy_hook(hook); /* also zaps peer */ 130713675Sdyson printf("failed in ng_con_part2(A)\n"); 130829356Speter return ; 1309125364Srwatson } 131029356Speter } 131129356Speter if (ng_send_fn(hook->hk_peer->hk_node, hook->hk_peer, 131229356Speter &ng_con_part3, arg1, arg2)) { 131329356Speter printf("failed in ng_con_part2(B)"); 131429356Speter ng_destroy_hook(hook); /* also zaps peer */ 131583805Sjhb return ; 131629356Speter } 131713675Sdyson hook->hk_flags &= ~HK_INVALID; /* need both to be able to work */ 131813675Sdyson return ; 131929356Speter} 132083805Sjhb 132130164Speter/* 132213907Sdyson * Connect this node with another node. We assume that this node is 132313675Sdyson * currently locked, as we are only called from an NGM_CONNECT message. 1324101768Srwatson */ 1325101768Srwatsonstatic int 1326101768Srwatsonng_con_nodes(node_p node, const char *name, node_p node2, const char *name2) 132791362Salfred{ 132829356Speter int error; 132929356Speter hook_p hook; 133013675Sdyson hook_p hook2; 133113675Sdyson 133298989Salfred if (ng_findhook(node2, name2) != NULL) { 133398989Salfred return(EEXIST); 133498989Salfred } 133598989Salfred if ((error = ng_add_hook(node, name, &hook))) /* gives us a ref */ 133652983Speter return (error); 1337101983Srwatson /* Allocate the other hook and link it up */ 133852983Speter NG_ALLOC_HOOK(hook2); 133952983Speter if (hook == NULL) { 1340101983Srwatson TRAP_ERROR(); 134183366Sjulian ng_destroy_hook(hook); /* XXX check ref counts so far */ 134213675Sdyson NG_HOOK_UNREF(hook); /* including our ref */ 1343109153Sdillon return (ENOMEM); 1344101768Srwatson } 1345101768Srwatson hook2->hk_refs = 1; /* start with a reference for us. */ 134652983Speter hook2->hk_flags = HK_INVALID; 1347104269Srwatson hook2->hk_peer = hook; /* Link the two together */ 1348125293Srwatson hook->hk_peer = hook2; 1349104269Srwatson NG_HOOK_REF(hook); /* Add a ref for the peer to each*/ 1350101768Srwatson NG_HOOK_REF(hook2); 1351101768Srwatson hook2->hk_node = &ng_deadnode; 1352101768Srwatson strncpy(NG_HOOK_NAME(hook2), name2, NG_HOOKLEN); 1353100527Salfred 135417124Sbde /* 135513907Sdyson * Queue the function above. 1356132436Ssilby * Procesing continues in that function in the lock context of 1357132436Ssilby * the other node. 1358132436Ssilby */ 1359132436Ssilby ng_send_fn(node2, hook2, &ng_con_part2, NULL, 0); 136013675Sdyson 136134901Sphk NG_HOOK_UNREF(hook); /* Let each hook go if it wants to */ 136234901Sphk NG_HOOK_UNREF(hook2); 136334901Sphk return (0); 136460404Schris} 136560404Schris 136617124Sbde/* 136760404Schris * Make a peer and connect. 136817124Sbde * We assume that the local node is locked. 136917124Sbde * The new node probably doesn't need a lock until 137076760Salfred * it has a hook, because it cannot really have any work until then, 137113675Sdyson * but we should think about it a bit more. 137213675Sdyson * 137313675Sdyson * The problem may come if the other node also fires up 137413675Sdyson * some hardware or a timer or some other source of activation, 137583366Sjulian * also it may already get a command msg via it's ID. 137613675Sdyson * 137783366Sjulian * We could use the same method as ng_con_nodes() but we'd have 137813675Sdyson * to add ability to remove the node when failing. (Not hard, just 1379109153Sdillon * make arg1 point to the node to remove). 138016322Sgpalmer * Unless of course we just ignore failure to connect and leave 138149413Sgreen * an unconnected node? 1382109153Sdillon */ 138396122Salfredstatic int 138413675Sdysonng_mkpeer(node_p node, const char *name, const char *name2, char *type) 138576760Salfred{ 138613675Sdyson node_p node2; 138713675Sdyson hook_p hook1; 138876364Salfred hook_p hook2; 138976364Salfred int error; 139076364Salfred 139176364Salfred if ((error = ng_make_node(type, &node2))) { 139291412Salfred return (error); 1393125293Srwatson } 1394125293Srwatson 139576364Salfred if ((error = ng_add_hook(node, name, &hook1))) { /* gives us a ref */ 139676364Salfred ng_rmnode(node2, NULL, NULL, 0); 139776364Salfred return (error); 1398117364Ssilby } 1399110816Salc 1400118764Ssilby if ((error = ng_add_hook(node2, name2, &hook2))) { 1401118764Ssilby ng_rmnode(node2, NULL, NULL, 0); 1402118764Ssilby ng_destroy_hook(hook1); 140376364Salfred NG_HOOK_UNREF(hook1); 140476364Salfred return (error); 140576364Salfred } 1406127501Salc 140776364Salfred /* 140876364Salfred * Actually link the two hooks together. 140976364Salfred */ 141076364Salfred hook1->hk_peer = hook2; 141176364Salfred hook2->hk_peer = hook1; 141276364Salfred 141376364Salfred /* Each hook is referenced by the other */ 141413675Sdyson NG_HOOK_REF(hook1); 141513675Sdyson NG_HOOK_REF(hook2); 141613675Sdyson 141713675Sdyson /* Give each node the opportunity to veto the pending connection */ 141813675Sdyson if (hook1->hk_node->nd_type->connect) { 141913675Sdyson error = (*hook1->hk_node->nd_type->connect) (hook1); 142013675Sdyson } 1421125293Srwatson 142213907Sdyson if ((error == 0) && hook2->hk_node->nd_type->connect) { 142376364Salfred error = (*hook2->hk_node->nd_type->connect) (hook2); 1424125293Srwatson 142591968Salfred } 1426125293Srwatson 1427125293Srwatson /* 142891968Salfred * drop the references we were holding on the two hooks. 142991968Salfred */ 143013907Sdyson if (error) { 143191968Salfred ng_destroy_hook(hook2); /* also zaps hook1 */ 143291968Salfred ng_rmnode(node2, NULL, NULL, 0); 143391968Salfred } else { 143491968Salfred /* As a last act, allow the hooks to be used */ 1435126131Sgreen hook1->hk_flags &= ~HK_INVALID; 143691968Salfred hook2->hk_flags &= ~HK_INVALID; 143791968Salfred } 1438126131Sgreen NG_HOOK_UNREF(hook1); 143991968Salfred NG_HOOK_UNREF(hook2); 144091968Salfred return (error); 144113675Sdyson} 1442101768Srwatson 144391968Salfred/************************************************************************ 1444125293Srwatson Utility routines to send self messages 144591968Salfred************************************************************************/ 1446125293Srwatson 1447125293Srwatson/* Shut this node down as soon as everyone is clear of it */ 144891968Salfred/* Should add arg "immediatly" to jump the queue */ 144913907Sdysonint 145091968Salfredng_rmnode_self(node_p node) 145191968Salfred{ 145291968Salfred int error; 145391968Salfred 1454125293Srwatson if (node == &ng_deadnode) 145591968Salfred return (0); 1456125293Srwatson node->nd_flags |= NG_INVALID; 1457125293Srwatson if (node->nd_flags & NG_CLOSING) 1458125293Srwatson return (0); 1459125293Srwatson 146091968Salfred error = ng_send_fn(node, NULL, &ng_rmnode, NULL, 0); 1461126131Sgreen return (error); 1462125293Srwatson} 1463125293Srwatson 1464125293Srwatsonstatic void 1465125293Srwatsonng_rmhook_part2(node_p node, hook_p hook, void *arg1, int arg2) 1466126131Sgreen{ 1467125293Srwatson ng_destroy_hook(hook); 1468125293Srwatson return ; 1469125293Srwatson} 1470125293Srwatson 1471125293Srwatsonint 1472125293Srwatsonng_rmhook_self(hook_p hook) 147391968Salfred{ 1474125293Srwatson int error; 1475125293Srwatson node_p node = NG_HOOK_NODE(hook); 1476125293Srwatson 1477125293Srwatson if (node == &ng_deadnode) 1478125293Srwatson return (0); 1479125293Srwatson 148013675Sdyson error = ng_send_fn(node, hook, &ng_rmhook_part2, NULL, 0); 148159288Sjlemon return (error); 148272521Sjlemon} 148359288Sjlemon 148472521Sjlemon/*********************************************************************** 148559288Sjlemon * Parse and verify a string of the form: <NODE:><PATH> 148689306Salfred * 148759288Sjlemon * Such a string can refer to a specific node or a specific hook 1488109153Sdillon * on a specific node, depending on how you look at it. In the 1489126131Sgreen * latter case, the PATH component must not end in a dot. 149072521Sjlemon * 149172521Sjlemon * Both <NODE:> and <PATH> are optional. The <PATH> is a string 149272521Sjlemon * of hook names separated by dots. This breaks out the original 149372521Sjlemon * string, setting *nodep to "NODE" (or NULL if none) and *pathp 149472521Sjlemon * to "PATH" (or NULL if degenerate). Also, *hookp will point to 149572521Sjlemon * the final hook component of <PATH>, if any, otherwise NULL. 1496126131Sgreen * 1497101382Sdes * This returns -1 if the path is malformed. The char ** are optional. 1498126131Sgreen ***********************************************************************/ 1499118929Sjmgint 1500126131Sgreenng_path_parse(char *addr, char **nodep, char **pathp, char **hookp) 1501126131Sgreen{ 150272521Sjlemon char *node, *path, *hook; 150372521Sjlemon int k; 1504126131Sgreen 150572521Sjlemon /* 150672521Sjlemon * Extract absolute NODE, if any 150778292Sjlemon */ 150878292Sjlemon for (path = addr; *path && *path != ':'; path++); 150991372Salfred if (*path) { 151059288Sjlemon node = addr; /* Here's the NODE */ 151159288Sjlemon *path++ = '\0'; /* Here's the PATH */ 151259288Sjlemon 151359288Sjlemon /* Node name must not be empty */ 151459288Sjlemon if (!*node) 151559288Sjlemon return -1; 1516121018Sjmg 151759288Sjlemon /* A name of "." is OK; otherwise '.' not allowed */ 1518126131Sgreen if (strcmp(node, ".") != 0) { 1519121018Sjmg for (k = 0; node[k]; k++) 1520126131Sgreen if (node[k] == '.') 1521126131Sgreen return -1; 1522121018Sjmg } 1523126131Sgreen } else { 1524121018Sjmg node = NULL; /* No absolute NODE */ 1525121018Sjmg path = addr; /* Here's the PATH */ 152678292Sjlemon } 152791372Salfred 152859288Sjlemon /* Snoop for illegal characters in PATH */ 152959288Sjlemon for (k = 0; path[k]; k++) 153059288Sjlemon if (path[k] == ':') 153159288Sjlemon return -1; 153259288Sjlemon 153359288Sjlemon /* Check for no repeated dots in PATH */ 1534109153Sdillon for (k = 0; path[k]; k++) 153559288Sjlemon if (path[k] == '.' && path[k + 1] == '.') 153659288Sjlemon return -1; 153791372Salfred 153859288Sjlemon /* Remove extra (degenerate) dots from beginning or end of PATH */ 153959288Sjlemon if (path[0] == '.') 154059288Sjlemon path++; 154159288Sjlemon if (*path && path[strlen(path) - 1] == '.') 154259288Sjlemon path[strlen(path) - 1] = 0; 1543125364Srwatson 154491372Salfred /* If PATH has a dot, then we're not talking about a hook */ 154591372Salfred if (*path) { 154659288Sjlemon for (hook = path, k = 0; path[k]; k++) 154759288Sjlemon if (path[k] == '.') { 154891372Salfred hook = NULL; 154959288Sjlemon break; 155059288Sjlemon } 155159288Sjlemon } else 155259288Sjlemon path = hook = NULL; 155359288Sjlemon 155459288Sjlemon /* Done */ 155559288Sjlemon if (nodep) 1556109153Sdillon *nodep = node; 155759288Sjlemon if (pathp) 155859288Sjlemon *pathp = path; 155991372Salfred if (hookp) 1560125364Srwatson *hookp = hook; 156159288Sjlemon return (0); 1562124394Sdes} 156391372Salfred 156459288Sjlemon/* 156559288Sjlemon * Given a path, which may be absolute or relative, and a starting node, 156659288Sjlemon * return the destination node. 156765855Sjlemon */ 156859288Sjlemonint 156959288Sjlemonng_path2noderef(node_p here, const char *address, 157091372Salfred node_p *destp, hook_p *lasthook) 157159288Sjlemon{ 157259288Sjlemon char fullpath[NG_PATHLEN + 1]; 1573 char *nodename, *path, pbuf[2]; 1574 node_p node, oldnode; 1575 char *cp; 1576 hook_p hook = NULL; 1577 1578 /* Initialize */ 1579 if (destp == NULL) { 1580 TRAP_ERROR(); 1581 return EINVAL; 1582 } 1583 *destp = NULL; 1584 1585 /* Make a writable copy of address for ng_path_parse() */ 1586 strncpy(fullpath, address, sizeof(fullpath) - 1); 1587 fullpath[sizeof(fullpath) - 1] = '\0'; 1588 1589 /* Parse out node and sequence of hooks */ 1590 if (ng_path_parse(fullpath, &nodename, &path, NULL) < 0) { 1591 TRAP_ERROR(); 1592 return EINVAL; 1593 } 1594 if (path == NULL) { 1595 pbuf[0] = '.'; /* Needs to be writable */ 1596 pbuf[1] = '\0'; 1597 path = pbuf; 1598 } 1599 1600 /* 1601 * For an absolute address, jump to the starting node. 1602 * Note that this holds a reference on the node for us. 1603 * Don't forget to drop the reference if we don't need it. 1604 */ 1605 if (nodename) { 1606 node = ng_name2noderef(here, nodename); 1607 if (node == NULL) { 1608 TRAP_ERROR(); 1609 return (ENOENT); 1610 } 1611 } else { 1612 if (here == NULL) { 1613 TRAP_ERROR(); 1614 return (EINVAL); 1615 } 1616 node = here; 1617 NG_NODE_REF(node); 1618 } 1619 1620 /* 1621 * Now follow the sequence of hooks 1622 * XXX 1623 * We actually cannot guarantee that the sequence 1624 * is not being demolished as we crawl along it 1625 * without extra-ordinary locking etc. 1626 * So this is a bit dodgy to say the least. 1627 * We can probably hold up some things by holding 1628 * the nodelist mutex for the time of this 1629 * crawl if we wanted.. At least that way we wouldn't have to 1630 * worry about the nodes dissappearing, but the hooks would still 1631 * be a problem. 1632 */ 1633 for (cp = path; node != NULL && *cp != '\0'; ) { 1634 char *segment; 1635 1636 /* 1637 * Break out the next path segment. Replace the dot we just 1638 * found with a NUL; "cp" points to the next segment (or the 1639 * NUL at the end). 1640 */ 1641 for (segment = cp; *cp != '\0'; cp++) { 1642 if (*cp == '.') { 1643 *cp++ = '\0'; 1644 break; 1645 } 1646 } 1647 1648 /* Empty segment */ 1649 if (*segment == '\0') 1650 continue; 1651 1652 /* We have a segment, so look for a hook by that name */ 1653 hook = ng_findhook(node, segment); 1654 1655 /* Can't get there from here... */ 1656 if (hook == NULL 1657 || NG_HOOK_PEER(hook) == NULL 1658 || NG_HOOK_NOT_VALID(hook) 1659 || NG_HOOK_NOT_VALID(NG_HOOK_PEER(hook))) { 1660 TRAP_ERROR(); 1661 NG_NODE_UNREF(node); 1662#if 0 1663 printf("hooknotvalid %s %s %d %d %d %d ", 1664 path, 1665 segment, 1666 hook == NULL, 1667 NG_HOOK_PEER(hook) == NULL, 1668 NG_HOOK_NOT_VALID(hook), 1669 NG_HOOK_NOT_VALID(NG_HOOK_PEER(hook))); 1670#endif 1671 return (ENOENT); 1672 } 1673 1674 /* 1675 * Hop on over to the next node 1676 * XXX 1677 * Big race conditions here as hooks and nodes go away 1678 * *** Idea.. store an ng_ID_t in each hook and use that 1679 * instead of the direct hook in this crawl? 1680 */ 1681 oldnode = node; 1682 if ((node = NG_PEER_NODE(hook))) 1683 NG_NODE_REF(node); /* XXX RACE */ 1684 NG_NODE_UNREF(oldnode); /* XXX another race */ 1685 if (NG_NODE_NOT_VALID(node)) { 1686 NG_NODE_UNREF(node); /* XXX more races */ 1687 node = NULL; 1688 } 1689 } 1690 1691 /* If node somehow missing, fail here (probably this is not needed) */ 1692 if (node == NULL) { 1693 TRAP_ERROR(); 1694 return (ENXIO); 1695 } 1696 1697 /* Done */ 1698 *destp = node; 1699 if (lasthook != NULL) 1700 *lasthook = (hook ? NG_HOOK_PEER(hook) : NULL); 1701 return (0); 1702} 1703 1704/***************************************************************\ 1705* Input queue handling. 1706* All activities are submitted to the node via the input queue 1707* which implements a multiple-reader/single-writer gate. 1708* Items which cannot be handled immeditly are queued. 1709* 1710* read-write queue locking inline functions * 1711\***************************************************************/ 1712 1713static __inline item_p ng_dequeue(struct ng_queue * ngq); 1714static __inline item_p ng_acquire_read(struct ng_queue * ngq, 1715 item_p item); 1716static __inline item_p ng_acquire_write(struct ng_queue * ngq, 1717 item_p item); 1718static __inline void ng_leave_read(struct ng_queue * ngq); 1719static __inline void ng_leave_write(struct ng_queue * ngq); 1720static __inline void ng_queue_rw(struct ng_queue * ngq, 1721 item_p item, int rw); 1722 1723/* 1724 * Definition of the bits fields in the ng_queue flag word. 1725 * Defined here rather than in netgraph.h because no-one should fiddle 1726 * with them. 1727 * 1728 * The ordering here may be important! don't shuffle these. 1729 */ 1730/*- 1731 Safety Barrier--------+ (adjustable to suit taste) (not used yet) 1732 | 1733 V 1734+-------+-------+-------+-------+-------+-------+-------+-------+ 1735| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 1736| |A|c|t|i|v|e| |R|e|a|d|e|r| |C|o|u|n|t| | | | | | | | | |R|A|W| 1737| | | | | | | | | | | | | | | | | | | | | | | | | | | | | |P|W|P| 1738+-------+-------+-------+-------+-------+-------+-------+-------+ 1739\___________________________ ____________________________/ | | | 1740 V | | | 1741 [active reader count] | | | 1742 | | | 1743 Read Pending ------------------------------------+ | | 1744 | | 1745 Active Writer -------------------------------------+ | 1746 | 1747 Write Pending ---------------------------------------+ 1748 1749 1750*/ 1751#define WRITE_PENDING 0x00000001 1752#define WRITER_ACTIVE 0x00000002 1753#define READ_PENDING 0x00000004 1754#define READER_INCREMENT 0x00000008 1755#define READER_MASK 0xfffffff0 /* Not valid if WRITER_ACTIVE is set */ 1756#define SAFETY_BARRIER 0x00100000 /* 64K items queued should be enough */ 1757 1758/* Defines of more elaborate states on the queue */ 1759/* Mask of bits a read cares about */ 1760#define NGQ_RMASK (WRITE_PENDING|WRITER_ACTIVE|READ_PENDING) 1761 1762/* Mask of bits a write cares about */ 1763#define NGQ_WMASK (NGQ_RMASK|READER_MASK) 1764 1765/* tests to decide if we could get a read or write off the queue */ 1766#define CAN_GET_READ(flag) ((flag & NGQ_RMASK) == READ_PENDING) 1767#define CAN_GET_WRITE(flag) ((flag & NGQ_WMASK) == WRITE_PENDING) 1768 1769/* Is there a chance of getting ANY work off the queue? */ 1770#define CAN_GET_WORK(flag) (CAN_GET_READ(flag) || CAN_GET_WRITE(flag)) 1771 1772/* 1773 * Taking into account the current state of the queue and node, possibly take 1774 * the next entry off the queue and return it. Return NULL if there was 1775 * nothing we could return, either because there really was nothing there, or 1776 * because the node was in a state where it cannot yet process the next item 1777 * on the queue. 1778 * 1779 * This MUST MUST MUST be called with the mutex held. 1780 */ 1781static __inline item_p 1782ng_dequeue(struct ng_queue *ngq) 1783{ 1784 item_p item; 1785 u_int add_arg; 1786 1787 if (CAN_GET_READ(ngq->q_flags)) { 1788 /* 1789 * Head of queue is a reader and we have no write active. 1790 * We don't care how many readers are already active. 1791 * Adjust the flags for the item we are about to dequeue. 1792 * Add the correct increment for the reader count as well. 1793 */ 1794 add_arg = (READER_INCREMENT - READ_PENDING); 1795 } else if (CAN_GET_WRITE(ngq->q_flags)) { 1796 /* 1797 * There is a pending write, no readers and no active writer. 1798 * This means we can go ahead with the pending writer. Note 1799 * the fact that we now have a writer, ready for when we take 1800 * it off the queue. 1801 * 1802 * We don't need to worry about a possible collision with the 1803 * fasttrack reader. 1804 * 1805 * The fasttrack thread may take a long time to discover that we 1806 * are running so we would have an inconsistent state in the 1807 * flags for a while. Since we ignore the reader count 1808 * entirely when the WRITER_ACTIVE flag is set, this should 1809 * not matter (in fact it is defined that way). If it tests 1810 * the flag before this operation, the WRITE_PENDING flag 1811 * will make it fail, and if it tests it later, the 1812 * WRITER_ACTIVE flag will do the same. If it is SO slow that 1813 * we have actually completed the operation, and neither flag 1814 * is set (nor the READ_PENDING) by the time that it tests 1815 * the flags, then it is actually ok for it to continue. If 1816 * it completes and we've finished and the read pending is 1817 * set it still fails. 1818 * 1819 * So we can just ignore it, as long as we can ensure that the 1820 * transition from WRITE_PENDING state to the WRITER_ACTIVE 1821 * state is atomic. 1822 * 1823 * After failing, first it will be held back by the mutex, then 1824 * when it can proceed, it will queue its request, then it 1825 * would arrive at this function. Usually it will have to 1826 * leave empty handed because the ACTIVE WRITER bit will be 1827 * set. 1828 * 1829 * Adjust the flags for the item we are about to dequeue 1830 * and for the new active writer. 1831 */ 1832 add_arg = (WRITER_ACTIVE - WRITE_PENDING); 1833 /* 1834 * We want to write "active writer, no readers " Now go make 1835 * it true. In fact there may be a number in the readers 1836 * count but we know it is not true and will be fixed soon. 1837 * We will fix the flags for the next pending entry in a 1838 * moment. 1839 */ 1840 } else { 1841 /* 1842 * We can't dequeue anything.. return and say so. Probably we 1843 * have a write pending and the readers count is non zero. If 1844 * we got here because a reader hit us just at the wrong 1845 * moment with the fasttrack code, and put us in a strange 1846 * state, then it will be through in just a moment, (as soon 1847 * as we release the mutex) and keep things moving. 1848 * Make sure we remove ourselves from the work queue. 1849 */ 1850 ng_worklist_remove(ngq->q_node); 1851 return (0); 1852 } 1853 1854 /* 1855 * Now we dequeue the request (whatever it may be) and correct the 1856 * pending flags and the next and last pointers. 1857 */ 1858 item = ngq->queue; 1859 ngq->queue = item->el_next; 1860 if (ngq->last == &(item->el_next)) { 1861 /* 1862 * that was the last entry in the queue so set the 'last 1863 * pointer up correctly and make sure the pending flags are 1864 * clear. 1865 */ 1866 ngq->last = &(ngq->queue); 1867 /* 1868 * Whatever flag was set will be cleared and 1869 * the new acive field will be set by the add as well, 1870 * so we don't need to change add_arg. 1871 * But we know we don't need to be on the work list. 1872 */ 1873 atomic_add_long(&ngq->q_flags, add_arg); 1874 ng_worklist_remove(ngq->q_node); 1875 } else { 1876 /* 1877 * Since there is something on the queue, note what it is 1878 * in the flags word. 1879 */ 1880 if ((ngq->queue->el_flags & NGQF_RW) == NGQF_READER) { 1881 add_arg += READ_PENDING; 1882 } else { 1883 add_arg += WRITE_PENDING; 1884 } 1885 atomic_add_long(&ngq->q_flags, add_arg); 1886 /* 1887 * If we see more doable work, make sure we are 1888 * on the work queue. 1889 */ 1890 if (CAN_GET_WORK(ngq->q_flags)) { 1891 ng_setisr(ngq->q_node); 1892 } 1893 } 1894 /* 1895 * We have successfully cleared the old pending flag, set the new one 1896 * if it is needed, and incremented the appropriate active field. 1897 * (all in one atomic addition.. ) 1898 */ 1899 return (item); 1900} 1901 1902/* 1903 * Queue a packet to be picked up by someone else. 1904 * We really don't care who, but we can't or don't want to hang around 1905 * to process it ourselves. We are probably an interrupt routine.. 1906 * 1 = writer, 0 = reader 1907 */ 1908#define NGQRW_R 0 1909#define NGQRW_W 1 1910static __inline void 1911ng_queue_rw(struct ng_queue * ngq, item_p item, int rw) 1912{ 1913 item->el_next = NULL; /* maybe not needed */ 1914 *ngq->last = item; 1915 /* 1916 * If it was the first item in the queue then we need to 1917 * set the last pointer and the type flags. 1918 */ 1919 if (ngq->last == &(ngq->queue)) { 1920 /* 1921 * When called with constants for rw, the optimiser will 1922 * remove the unneeded branch below. 1923 */ 1924 if (rw == NGQRW_W) { 1925 atomic_add_long(&ngq->q_flags, WRITE_PENDING); 1926 } else { 1927 atomic_add_long(&ngq->q_flags, READ_PENDING); 1928 } 1929 } 1930 ngq->last = &(item->el_next); 1931} 1932 1933 1934/* 1935 * This function 'cheats' in that it first tries to 'grab' the use of the 1936 * node, without going through the mutex. We can do this becasue of the 1937 * semantics of the lock. The semantics include a clause that says that the 1938 * value of the readers count is invalid if the WRITER_ACTIVE flag is set. It 1939 * also says that the WRITER_ACTIVE flag cannot be set if the readers count 1940 * is not zero. Note that this talks about what is valid to SET the 1941 * WRITER_ACTIVE flag, because from the moment it is set, the value if the 1942 * reader count is immaterial, and not valid. The two 'pending' flags have a 1943 * similar effect, in that If they are orthogonal to the two active fields in 1944 * how they are set, but if either is set, the attempted 'grab' need to be 1945 * backed out because there is earlier work, and we maintain ordering in the 1946 * queue. The result of this is that the reader request can try obtain use of 1947 * the node with only a single atomic addition, and without any of the mutex 1948 * overhead. If this fails the operation degenerates to the same as for other 1949 * cases. 1950 * 1951 */ 1952static __inline item_p 1953ng_acquire_read(struct ng_queue *ngq, item_p item) 1954{ 1955 1956 /* ######### Hack alert ######### */ 1957 atomic_add_long(&ngq->q_flags, READER_INCREMENT); 1958 if ((ngq->q_flags & NGQ_RMASK) == 0) { 1959 /* Successfully grabbed node */ 1960 return (item); 1961 } 1962 /* undo the damage if we didn't succeed */ 1963 atomic_subtract_long(&ngq->q_flags, READER_INCREMENT); 1964 1965 /* ######### End Hack alert ######### */ 1966 mtx_lock_spin((&ngq->q_mtx)); 1967 /* 1968 * Try again. Another processor (or interrupt for that matter) may 1969 * have removed the last queued item that was stopping us from 1970 * running, between the previous test, and the moment that we took 1971 * the mutex. (Or maybe a writer completed.) 1972 */ 1973 if ((ngq->q_flags & NGQ_RMASK) == 0) { 1974 atomic_add_long(&ngq->q_flags, READER_INCREMENT); 1975 mtx_unlock_spin((&ngq->q_mtx)); 1976 return (item); 1977 } 1978 1979 /* 1980 * and queue the request for later. 1981 */ 1982 item->el_flags |= NGQF_READER; 1983 ng_queue_rw(ngq, item, NGQRW_R); 1984 1985 /* 1986 * Ok, so that's the item successfully queued for later. So now we 1987 * see if we can dequeue something to run instead. 1988 */ 1989 item = ng_dequeue(ngq); 1990 mtx_unlock_spin(&(ngq->q_mtx)); 1991 return (item); 1992} 1993 1994static __inline item_p 1995ng_acquire_write(struct ng_queue *ngq, item_p item) 1996{ 1997restart: 1998 mtx_lock_spin(&(ngq->q_mtx)); 1999 /* 2000 * If there are no readers, no writer, and no pending packets, then 2001 * we can just go ahead. In all other situations we need to queue the 2002 * request 2003 */ 2004 if ((ngq->q_flags & NGQ_WMASK) == 0) { 2005 atomic_add_long(&ngq->q_flags, WRITER_ACTIVE); 2006 mtx_unlock_spin((&ngq->q_mtx)); 2007 if (ngq->q_flags & READER_MASK) { 2008 /* Collision with fast-track reader */ 2009 atomic_subtract_long(&ngq->q_flags, WRITER_ACTIVE); 2010 goto restart; 2011 } 2012 return (item); 2013 } 2014 2015 /* 2016 * and queue the request for later. 2017 */ 2018 item->el_flags &= ~NGQF_RW; 2019 ng_queue_rw(ngq, item, NGQRW_W); 2020 2021 /* 2022 * Ok, so that's the item successfully queued for later. So now we 2023 * see if we can dequeue something to run instead. 2024 */ 2025 item = ng_dequeue(ngq); 2026 mtx_unlock_spin(&(ngq->q_mtx)); 2027 return (item); 2028} 2029 2030static __inline void 2031ng_leave_read(struct ng_queue *ngq) 2032{ 2033 atomic_subtract_long(&ngq->q_flags, READER_INCREMENT); 2034} 2035 2036static __inline void 2037ng_leave_write(struct ng_queue *ngq) 2038{ 2039 atomic_subtract_long(&ngq->q_flags, WRITER_ACTIVE); 2040} 2041 2042static void 2043ng_flush_input_queue(struct ng_queue * ngq) 2044{ 2045 item_p item; 2046 u_int add_arg; 2047 mtx_lock_spin(&ngq->q_mtx); 2048 for (;;) { 2049 /* Now take a look at what's on the queue */ 2050 if (ngq->q_flags & READ_PENDING) { 2051 add_arg = -READ_PENDING; 2052 } else if (ngq->q_flags & WRITE_PENDING) { 2053 add_arg = -WRITE_PENDING; 2054 } else { 2055 break; 2056 } 2057 2058 item = ngq->queue; 2059 ngq->queue = item->el_next; 2060 if (ngq->last == &(item->el_next)) { 2061 ngq->last = &(ngq->queue); 2062 } else { 2063 if ((ngq->queue->el_flags & NGQF_RW) == NGQF_READER) { 2064 add_arg += READ_PENDING; 2065 } else { 2066 add_arg += WRITE_PENDING; 2067 } 2068 } 2069 atomic_add_long(&ngq->q_flags, add_arg); 2070 2071 mtx_lock_spin(&ngq->q_mtx); 2072 NG_FREE_ITEM(item); 2073 mtx_unlock_spin(&ngq->q_mtx); 2074 } 2075 /* 2076 * Take us off the work queue if we are there. 2077 * We definatly have no work to be done. 2078 */ 2079 ng_worklist_remove(ngq->q_node); 2080 mtx_unlock_spin(&ngq->q_mtx); 2081} 2082 2083/*********************************************************************** 2084* Externally visible method for sending or queueing messages or data. 2085***********************************************************************/ 2086 2087/* 2088 * The module code should have filled out the item correctly by this stage: 2089 * Common: 2090 * reference to destination node. 2091 * Reference to destination rcv hook if relevant. 2092 * Data: 2093 * pointer to mbuf 2094 * pointer to metadata 2095 * Control_Message: 2096 * pointer to msg. 2097 * ID of original sender node. (return address) 2098 * Function: 2099 * Function pointer 2100 * void * argument 2101 * integer argument 2102 * 2103 * The nodes have several routines and macros to help with this task: 2104 */ 2105 2106int 2107ng_snd_item(item_p item, int queue) 2108{ 2109 hook_p hook = NGI_HOOK(item); 2110 node_p node = NGI_NODE(item); 2111 int rw; 2112 int error = 0, ierror; 2113 item_p oitem; 2114 struct ng_queue * ngq = &node->nd_input_queue; 2115 2116#ifdef NETGRAPH_DEBUG 2117 _ngi_check(item, __FILE__, __LINE__); 2118#endif 2119 2120 if (item == NULL) { 2121 TRAP_ERROR(); 2122 return (EINVAL); /* failed to get queue element */ 2123 } 2124 if (node == NULL) { 2125 NG_FREE_ITEM(item); 2126 TRAP_ERROR(); 2127 return (EINVAL); /* No address */ 2128 } 2129 switch(item->el_flags & NGQF_TYPE) { 2130 case NGQF_DATA: 2131 /* 2132 * DATA MESSAGE 2133 * Delivered to a node via a non-optional hook. 2134 * Both should be present in the item even though 2135 * the node is derivable from the hook. 2136 * References are held on both by the item. 2137 */ 2138 CHECK_DATA_MBUF(NGI_M(item)); 2139 if (hook == NULL) { 2140 NG_FREE_ITEM(item); 2141 TRAP_ERROR(); 2142 return(EINVAL); 2143 } 2144 if ((NG_HOOK_NOT_VALID(hook)) 2145 || (NG_NODE_NOT_VALID(NG_HOOK_NODE(hook)))) { 2146 NG_FREE_ITEM(item); 2147 return (ENOTCONN); 2148 } 2149 if ((hook->hk_flags & HK_QUEUE)) { 2150 queue = 1; 2151 } 2152 /* By default data is a reader in the locking scheme */ 2153 item->el_flags |= NGQF_READER; 2154 rw = NGQRW_R; 2155 break; 2156 case NGQF_MESG: 2157 /* 2158 * CONTROL MESSAGE 2159 * Delivered to a node. 2160 * Hook is optional. 2161 * References are held by the item on the node and 2162 * the hook if it is present. 2163 */ 2164 if (hook && (hook->hk_flags & HK_QUEUE)) { 2165 queue = 1; 2166 } 2167 /* Data messages count as writers unles explicitly exempted */ 2168 if (NGI_MSG(item)->header.cmd & NGM_READONLY) { 2169 item->el_flags |= NGQF_READER; 2170 rw = NGQRW_R; 2171 } else { 2172 item->el_flags &= ~NGQF_RW; 2173 rw = NGQRW_W; 2174 } 2175 break; 2176 case NGQF_FN: 2177 item->el_flags &= ~NGQF_RW; 2178 rw = NGQRW_W; 2179 break; 2180 default: 2181 NG_FREE_ITEM(item); 2182 TRAP_ERROR(); 2183 return (EINVAL); 2184 } 2185 /* 2186 * If the node specifies single threading, force writer semantics 2187 * Similarly the node may say one hook always produces writers. 2188 * These are over-rides. 2189 */ 2190 if ((node->nd_flags & NG_FORCE_WRITER) 2191 || (hook && (hook->hk_flags & HK_FORCE_WRITER))) { 2192 rw = NGQRW_W; 2193 item->el_flags &= ~NGQF_READER; 2194 } 2195 if (queue) { 2196 /* Put it on the queue for that node*/ 2197#ifdef NETGRAPH_DEBUG 2198 _ngi_check(item, __FILE__, __LINE__); 2199#endif 2200 mtx_lock_spin(&(ngq->q_mtx)); 2201 ng_queue_rw(ngq, item, rw); 2202 /* 2203 * If there are active elements then we can rely on 2204 * them. if not we should not rely on another packet 2205 * coming here by another path, 2206 * so it is best to put us in the netisr list. 2207 * We can take the worklist lock with the node locked 2208 * BUT NOT THE REVERSE! 2209 */ 2210 if (CAN_GET_WORK(ngq->q_flags)) { 2211 ng_setisr(node); 2212 } 2213 mtx_unlock_spin(&(ngq->q_mtx)); 2214 return (0); 2215 } 2216 /* 2217 * Take a queue item and a node and see if we can apply the item to 2218 * the node. We may end up getting a different item to apply instead. 2219 * Will allow for a piggyback reply only in the case where 2220 * there is no queueing. 2221 */ 2222 2223 oitem = item; 2224 /* 2225 * We already decided how we will be queueud or treated. 2226 * Try get the appropriate operating permission. 2227 */ 2228 if (rw == NGQRW_R) { 2229 item = ng_acquire_read(ngq, item); 2230 } else { 2231 item = ng_acquire_write(ngq, item); 2232 } 2233 2234 /* 2235 * May have come back with a different item. 2236 * or maybe none at all. The one we started with will 2237 * have been queued in thises cases. 2238 */ 2239 if (item == NULL) { 2240 return (0); 2241 } 2242 2243#ifdef NETGRAPH_DEBUG 2244 _ngi_check(item, __FILE__, __LINE__); 2245#endif 2246 /* 2247 * Take over the reference frm the item. 2248 * Hold it until the called function returns. 2249 */ 2250 NGI_GET_NODE(item, node); /* zaps stored node */ 2251 2252 ierror = ng_apply_item(node, item); /* drops r/w lock when done */ 2253 2254 /* only return an error if it was our initial item.. (compat hack) */ 2255 if (oitem == item) { 2256 error = ierror; 2257 } 2258 2259 /* 2260 * If the node goes away when we remove the reference, 2261 * whatever we just did caused it.. whatever we do, DO NOT 2262 * access the node again! 2263 */ 2264 if (NG_NODE_UNREF(node) == 0) { 2265 return (error); 2266 } 2267 2268 /* 2269 * Now we've handled the packet we brought, (or a friend of it) let's 2270 * look for any other packets that may have been queued up. We hold 2271 * no locks, so if someone puts something in the queue after 2272 * we check that it is empty, it is their problem 2273 * to ensure it is processed. If we have the netisr thread cme in here 2274 * while we still say we have stuff to do, we may get a boost 2275 * in SMP systems. :-) 2276 */ 2277 for (;;) { 2278 /* 2279 * dequeue acquires and adjusts the input_queue as it dequeues 2280 * packets. It acquires the rw lock as needed. 2281 */ 2282 mtx_lock_spin(&ngq->q_mtx); 2283 item = ng_dequeue(ngq); /* fixes worklist too*/ 2284 if (!item) { 2285 mtx_unlock_spin(&ngq->q_mtx); 2286 return (error); 2287 } 2288 mtx_unlock_spin(&ngq->q_mtx); 2289 2290 /* 2291 * Take over the reference frm the item. 2292 * Hold it until the called function returns. 2293 */ 2294 2295 NGI_GET_NODE(item, node); /* zaps stored node */ 2296 2297 /* 2298 * We have the appropriate lock, so run the item. 2299 * When finished it will drop the lock accordingly 2300 */ 2301 ierror = ng_apply_item(node, item); 2302 2303 /* 2304 * only return an error if it was our initial 2305 * item.. (compat hack) 2306 */ 2307 if (oitem == item) { 2308 error = ierror; 2309 } 2310 2311 /* 2312 * If the node goes away when we remove the reference, 2313 * whatever we just did caused it.. whatever we do, DO NOT 2314 * access the node again! 2315 */ 2316 if (NG_NODE_UNREF(node) == 0) { 2317 break; 2318 } 2319 } 2320 return (error); 2321} 2322 2323/* 2324 * We have an item that was possibly queued somewhere. 2325 * It should contain all the information needed 2326 * to run it on the appropriate node/hook. 2327 */ 2328static int 2329ng_apply_item(node_p node, item_p item) 2330{ 2331 hook_p hook; 2332 int was_reader = ((item->el_flags & NGQF_RW)); 2333 int error = 0; 2334 ng_rcvdata_t *rcvdata; 2335 ng_rcvmsg_t *rcvmsg; 2336 2337 NGI_GET_HOOK(item, hook); /* clears stored hook */ 2338#ifdef NETGRAPH_DEBUG 2339 _ngi_check(item, __FILE__, __LINE__); 2340#endif 2341 switch (item->el_flags & NGQF_TYPE) { 2342 case NGQF_DATA: 2343 /* 2344 * Check things are still ok as when we were queued. 2345 */ 2346 if ((hook == NULL) 2347 || NG_HOOK_NOT_VALID(hook) 2348 || NG_NODE_NOT_VALID(node) ) { 2349 error = EIO; 2350 NG_FREE_ITEM(item); 2351 break; 2352 } 2353 /* 2354 * If no receive method, just silently drop it. 2355 * Give preference to the hook over-ride method 2356 */ 2357 if ((!(rcvdata = hook->hk_rcvdata)) 2358 && (!(rcvdata = NG_HOOK_NODE(hook)->nd_type->rcvdata))) { 2359 error = 0; 2360 NG_FREE_ITEM(item); 2361 break; 2362 } 2363 error = (*rcvdata)(hook, item); 2364 break; 2365 case NGQF_MESG: 2366 if (hook) { 2367 if (NG_HOOK_NOT_VALID(hook)) { 2368 /* 2369 * The hook has been zapped then we can't 2370 * use it. Immediatly drop its reference. 2371 * The message may not need it. 2372 */ 2373 NG_HOOK_UNREF(hook); 2374 hook = NULL; 2375 } 2376 } 2377 /* 2378 * Similarly, if the node is a zombie there is 2379 * nothing we can do with it, drop everything. 2380 */ 2381 if (NG_NODE_NOT_VALID(node)) { 2382 TRAP_ERROR(); 2383 error = EINVAL; 2384 NG_FREE_ITEM(item); 2385 } else { 2386 /* 2387 * Call the appropriate message handler for the object. 2388 * It is up to the message handler to free the message. 2389 * If it's a generic message, handle it generically, 2390 * otherwise call the type's message handler 2391 * (if it exists) 2392 * XXX (race). Remember that a queued message may 2393 * reference a node or hook that has just been 2394 * invalidated. It will exist as the queue code 2395 * is holding a reference, but.. 2396 */ 2397 2398 struct ng_mesg *msg = NGI_MSG(item); 2399 2400 /* 2401 * check if the generic handler owns it. 2402 */ 2403 if ((msg->header.typecookie == NGM_GENERIC_COOKIE) 2404 && ((msg->header.flags & NGF_RESP) == 0)) { 2405 error = ng_generic_msg(node, item, hook); 2406 break; 2407 } 2408 /* 2409 * Now see if there is a handler (hook or node specific) 2410 * in the target node. If none, silently discard. 2411 */ 2412 if (((!hook) || (!(rcvmsg = hook->hk_rcvmsg))) 2413 && (!(rcvmsg = node->nd_type->rcvmsg))) { 2414 TRAP_ERROR(); 2415 error = 0; 2416 NG_FREE_ITEM(item); 2417 break; 2418 } 2419 error = (*rcvmsg)(node, item, hook); 2420 } 2421 break; 2422 case NGQF_FN: 2423 /* 2424 * We have to implicitly trust the hook, 2425 * as some of these are used for system purposes 2426 * where the hook is invalid. In the case of 2427 * the shutdown message we allow it to hit 2428 * even if the node is invalid. 2429 */ 2430 if ((NG_NODE_NOT_VALID(node)) 2431 && (NGI_FN(item) != &ng_rmnode)) { 2432 TRAP_ERROR(); 2433 error = EINVAL; 2434 break; 2435 } 2436 (*NGI_FN(item))(node, hook, NGI_ARG1(item), NGI_ARG2(item)); 2437 NG_FREE_ITEM(item); 2438 break; 2439 2440 } 2441 /* 2442 * We held references on some of the resources 2443 * that we took from the item. Now that we have 2444 * finished doing everything, drop those references. 2445 */ 2446 if (hook) { 2447 NG_HOOK_UNREF(hook); 2448 } 2449 2450 if (was_reader) { 2451 ng_leave_read(&node->nd_input_queue); 2452 } else { 2453 ng_leave_write(&node->nd_input_queue); 2454 } 2455 return (error); 2456} 2457 2458/*********************************************************************** 2459 * Implement the 'generic' control messages 2460 ***********************************************************************/ 2461static int 2462ng_generic_msg(node_p here, item_p item, hook_p lasthook) 2463{ 2464 int error = 0; 2465 struct ng_mesg *msg; 2466 struct ng_mesg *resp = NULL; 2467 2468 NGI_GET_MSG(item, msg); 2469 if (msg->header.typecookie != NGM_GENERIC_COOKIE) { 2470 TRAP_ERROR(); 2471 error = EINVAL; 2472 goto out; 2473 } 2474 switch (msg->header.cmd) { 2475 case NGM_SHUTDOWN: 2476 ng_rmnode(here, NULL, NULL, 0); 2477 break; 2478 case NGM_MKPEER: 2479 { 2480 struct ngm_mkpeer *const mkp = (struct ngm_mkpeer *) msg->data; 2481 2482 if (msg->header.arglen != sizeof(*mkp)) { 2483 TRAP_ERROR(); 2484 error = EINVAL; 2485 break; 2486 } 2487 mkp->type[sizeof(mkp->type) - 1] = '\0'; 2488 mkp->ourhook[sizeof(mkp->ourhook) - 1] = '\0'; 2489 mkp->peerhook[sizeof(mkp->peerhook) - 1] = '\0'; 2490 error = ng_mkpeer(here, mkp->ourhook, mkp->peerhook, mkp->type); 2491 break; 2492 } 2493 case NGM_CONNECT: 2494 { 2495 struct ngm_connect *const con = 2496 (struct ngm_connect *) msg->data; 2497 node_p node2; 2498 2499 if (msg->header.arglen != sizeof(*con)) { 2500 TRAP_ERROR(); 2501 error = EINVAL; 2502 break; 2503 } 2504 con->path[sizeof(con->path) - 1] = '\0'; 2505 con->ourhook[sizeof(con->ourhook) - 1] = '\0'; 2506 con->peerhook[sizeof(con->peerhook) - 1] = '\0'; 2507 /* Don't forget we get a reference.. */ 2508 error = ng_path2noderef(here, con->path, &node2, NULL); 2509 if (error) 2510 break; 2511 error = ng_con_nodes(here, con->ourhook, node2, con->peerhook); 2512 NG_NODE_UNREF(node2); 2513 break; 2514 } 2515 case NGM_NAME: 2516 { 2517 struct ngm_name *const nam = (struct ngm_name *) msg->data; 2518 2519 if (msg->header.arglen != sizeof(*nam)) { 2520 TRAP_ERROR(); 2521 error = EINVAL; 2522 break; 2523 } 2524 nam->name[sizeof(nam->name) - 1] = '\0'; 2525 error = ng_name_node(here, nam->name); 2526 break; 2527 } 2528 case NGM_RMHOOK: 2529 { 2530 struct ngm_rmhook *const rmh = (struct ngm_rmhook *) msg->data; 2531 hook_p hook; 2532 2533 if (msg->header.arglen != sizeof(*rmh)) { 2534 TRAP_ERROR(); 2535 error = EINVAL; 2536 break; 2537 } 2538 rmh->ourhook[sizeof(rmh->ourhook) - 1] = '\0'; 2539 if ((hook = ng_findhook(here, rmh->ourhook)) != NULL) 2540 ng_destroy_hook(hook); 2541 break; 2542 } 2543 case NGM_NODEINFO: 2544 { 2545 struct nodeinfo *ni; 2546 2547 NG_MKRESPONSE(resp, msg, sizeof(*ni), M_NOWAIT); 2548 if (resp == NULL) { 2549 error = ENOMEM; 2550 break; 2551 } 2552 2553 /* Fill in node info */ 2554 ni = (struct nodeinfo *) resp->data; 2555 if (NG_NODE_HAS_NAME(here)) 2556 strncpy(ni->name, NG_NODE_NAME(here), NG_NODELEN); 2557 strncpy(ni->type, here->nd_type->name, NG_TYPELEN); 2558 ni->id = ng_node2ID(here); 2559 ni->hooks = here->nd_numhooks; 2560 break; 2561 } 2562 case NGM_LISTHOOKS: 2563 { 2564 const int nhooks = here->nd_numhooks; 2565 struct hooklist *hl; 2566 struct nodeinfo *ni; 2567 hook_p hook; 2568 2569 /* Get response struct */ 2570 NG_MKRESPONSE(resp, msg, sizeof(*hl) 2571 + (nhooks * sizeof(struct linkinfo)), M_NOWAIT); 2572 if (resp == NULL) { 2573 error = ENOMEM; 2574 break; 2575 } 2576 hl = (struct hooklist *) resp->data; 2577 ni = &hl->nodeinfo; 2578 2579 /* Fill in node info */ 2580 if (NG_NODE_HAS_NAME(here)) 2581 strncpy(ni->name, NG_NODE_NAME(here), NG_NODELEN); 2582 strncpy(ni->type, here->nd_type->name, NG_TYPELEN); 2583 ni->id = ng_node2ID(here); 2584 2585 /* Cycle through the linked list of hooks */ 2586 ni->hooks = 0; 2587 LIST_FOREACH(hook, &here->nd_hooks, hk_hooks) { 2588 struct linkinfo *const link = &hl->link[ni->hooks]; 2589 2590 if (ni->hooks >= nhooks) { 2591 log(LOG_ERR, "%s: number of %s changed\n", 2592 __func__, "hooks"); 2593 break; 2594 } 2595 if (NG_HOOK_NOT_VALID(hook)) 2596 continue; 2597 strncpy(link->ourhook, NG_HOOK_NAME(hook), NG_HOOKLEN); 2598 strncpy(link->peerhook, 2599 NG_PEER_HOOK_NAME(hook), NG_HOOKLEN); 2600 if (NG_PEER_NODE_NAME(hook)[0] != '\0') 2601 strncpy(link->nodeinfo.name, 2602 NG_PEER_NODE_NAME(hook), NG_NODELEN); 2603 strncpy(link->nodeinfo.type, 2604 NG_PEER_NODE(hook)->nd_type->name, NG_TYPELEN); 2605 link->nodeinfo.id = ng_node2ID(NG_PEER_NODE(hook)); 2606 link->nodeinfo.hooks = NG_PEER_NODE(hook)->nd_numhooks; 2607 ni->hooks++; 2608 } 2609 break; 2610 } 2611 2612 case NGM_LISTNAMES: 2613 case NGM_LISTNODES: 2614 { 2615 const int unnamed = (msg->header.cmd == NGM_LISTNODES); 2616 struct namelist *nl; 2617 node_p node; 2618 int num = 0; 2619 2620 mtx_lock(&ng_nodelist_mtx); 2621 /* Count number of nodes */ 2622 LIST_FOREACH(node, &ng_nodelist, nd_nodes) { 2623 if (NG_NODE_IS_VALID(node) 2624 && (unnamed || NG_NODE_HAS_NAME(node))) { 2625 num++; 2626 } 2627 } 2628 mtx_unlock(&ng_nodelist_mtx); 2629 2630 /* Get response struct */ 2631 NG_MKRESPONSE(resp, msg, sizeof(*nl) 2632 + (num * sizeof(struct nodeinfo)), M_NOWAIT); 2633 if (resp == NULL) { 2634 error = ENOMEM; 2635 break; 2636 } 2637 nl = (struct namelist *) resp->data; 2638 2639 /* Cycle through the linked list of nodes */ 2640 nl->numnames = 0; 2641 mtx_lock(&ng_nodelist_mtx); 2642 LIST_FOREACH(node, &ng_nodelist, nd_nodes) { 2643 struct nodeinfo *const np = &nl->nodeinfo[nl->numnames]; 2644 2645 if (nl->numnames >= num) { 2646 log(LOG_ERR, "%s: number of %s changed\n", 2647 __func__, "nodes"); 2648 break; 2649 } 2650 if (NG_NODE_NOT_VALID(node)) 2651 continue; 2652 if (!unnamed && (! NG_NODE_HAS_NAME(node))) 2653 continue; 2654 if (NG_NODE_HAS_NAME(node)) 2655 strncpy(np->name, NG_NODE_NAME(node), NG_NODELEN); 2656 strncpy(np->type, node->nd_type->name, NG_TYPELEN); 2657 np->id = ng_node2ID(node); 2658 np->hooks = node->nd_numhooks; 2659 nl->numnames++; 2660 } 2661 mtx_unlock(&ng_nodelist_mtx); 2662 break; 2663 } 2664 2665 case NGM_LISTTYPES: 2666 { 2667 struct typelist *tl; 2668 struct ng_type *type; 2669 int num = 0; 2670 2671 mtx_lock(&ng_typelist_mtx); 2672 /* Count number of types */ 2673 LIST_FOREACH(type, &ng_typelist, types) { 2674 num++; 2675 } 2676 mtx_unlock(&ng_typelist_mtx); 2677 2678 /* Get response struct */ 2679 NG_MKRESPONSE(resp, msg, sizeof(*tl) 2680 + (num * sizeof(struct typeinfo)), M_NOWAIT); 2681 if (resp == NULL) { 2682 error = ENOMEM; 2683 break; 2684 } 2685 tl = (struct typelist *) resp->data; 2686 2687 /* Cycle through the linked list of types */ 2688 tl->numtypes = 0; 2689 mtx_lock(&ng_typelist_mtx); 2690 LIST_FOREACH(type, &ng_typelist, types) { 2691 struct typeinfo *const tp = &tl->typeinfo[tl->numtypes]; 2692 2693 if (tl->numtypes >= num) { 2694 log(LOG_ERR, "%s: number of %s changed\n", 2695 __func__, "types"); 2696 break; 2697 } 2698 strncpy(tp->type_name, type->name, NG_TYPELEN); 2699 tp->numnodes = type->refs - 1; /* don't count list */ 2700 tl->numtypes++; 2701 } 2702 mtx_unlock(&ng_typelist_mtx); 2703 break; 2704 } 2705 2706 case NGM_BINARY2ASCII: 2707 { 2708 int bufSize = 20 * 1024; /* XXX hard coded constant */ 2709 const struct ng_parse_type *argstype; 2710 const struct ng_cmdlist *c; 2711 struct ng_mesg *binary, *ascii; 2712 2713 /* Data area must contain a valid netgraph message */ 2714 binary = (struct ng_mesg *)msg->data; 2715 if (msg->header.arglen < sizeof(struct ng_mesg) 2716 || (msg->header.arglen - sizeof(struct ng_mesg) 2717 < binary->header.arglen)) { 2718 TRAP_ERROR(); 2719 error = EINVAL; 2720 break; 2721 } 2722 2723 /* Get a response message with lots of room */ 2724 NG_MKRESPONSE(resp, msg, sizeof(*ascii) + bufSize, M_NOWAIT); 2725 if (resp == NULL) { 2726 error = ENOMEM; 2727 break; 2728 } 2729 ascii = (struct ng_mesg *)resp->data; 2730 2731 /* Copy binary message header to response message payload */ 2732 bcopy(binary, ascii, sizeof(*binary)); 2733 2734 /* Find command by matching typecookie and command number */ 2735 for (c = here->nd_type->cmdlist; 2736 c != NULL && c->name != NULL; c++) { 2737 if (binary->header.typecookie == c->cookie 2738 && binary->header.cmd == c->cmd) 2739 break; 2740 } 2741 if (c == NULL || c->name == NULL) { 2742 for (c = ng_generic_cmds; c->name != NULL; c++) { 2743 if (binary->header.typecookie == c->cookie 2744 && binary->header.cmd == c->cmd) 2745 break; 2746 } 2747 if (c->name == NULL) { 2748 NG_FREE_MSG(resp); 2749 error = ENOSYS; 2750 break; 2751 } 2752 } 2753 2754 /* Convert command name to ASCII */ 2755 snprintf(ascii->header.cmdstr, sizeof(ascii->header.cmdstr), 2756 "%s", c->name); 2757 2758 /* Convert command arguments to ASCII */ 2759 argstype = (binary->header.flags & NGF_RESP) ? 2760 c->respType : c->mesgType; 2761 if (argstype == NULL) { 2762 *ascii->data = '\0'; 2763 } else { 2764 if ((error = ng_unparse(argstype, 2765 (u_char *)binary->data, 2766 ascii->data, bufSize)) != 0) { 2767 NG_FREE_MSG(resp); 2768 break; 2769 } 2770 } 2771 2772 /* Return the result as struct ng_mesg plus ASCII string */ 2773 bufSize = strlen(ascii->data) + 1; 2774 ascii->header.arglen = bufSize; 2775 resp->header.arglen = sizeof(*ascii) + bufSize; 2776 break; 2777 } 2778 2779 case NGM_ASCII2BINARY: 2780 { 2781 int bufSize = 2000; /* XXX hard coded constant */ 2782 const struct ng_cmdlist *c; 2783 const struct ng_parse_type *argstype; 2784 struct ng_mesg *ascii, *binary; 2785 int off = 0; 2786 2787 /* Data area must contain at least a struct ng_mesg + '\0' */ 2788 ascii = (struct ng_mesg *)msg->data; 2789 if ((msg->header.arglen < sizeof(*ascii) + 1) 2790 || (ascii->header.arglen < 1) 2791 || (msg->header.arglen 2792 < sizeof(*ascii) + ascii->header.arglen)) { 2793 TRAP_ERROR(); 2794 error = EINVAL; 2795 break; 2796 } 2797 ascii->data[ascii->header.arglen - 1] = '\0'; 2798 2799 /* Get a response message with lots of room */ 2800 NG_MKRESPONSE(resp, msg, sizeof(*binary) + bufSize, M_NOWAIT); 2801 if (resp == NULL) { 2802 error = ENOMEM; 2803 break; 2804 } 2805 binary = (struct ng_mesg *)resp->data; 2806 2807 /* Copy ASCII message header to response message payload */ 2808 bcopy(ascii, binary, sizeof(*ascii)); 2809 2810 /* Find command by matching ASCII command string */ 2811 for (c = here->nd_type->cmdlist; 2812 c != NULL && c->name != NULL; c++) { 2813 if (strcmp(ascii->header.cmdstr, c->name) == 0) 2814 break; 2815 } 2816 if (c == NULL || c->name == NULL) { 2817 for (c = ng_generic_cmds; c->name != NULL; c++) { 2818 if (strcmp(ascii->header.cmdstr, c->name) == 0) 2819 break; 2820 } 2821 if (c->name == NULL) { 2822 NG_FREE_MSG(resp); 2823 error = ENOSYS; 2824 break; 2825 } 2826 } 2827 2828 /* Convert command name to binary */ 2829 binary->header.cmd = c->cmd; 2830 binary->header.typecookie = c->cookie; 2831 2832 /* Convert command arguments to binary */ 2833 argstype = (binary->header.flags & NGF_RESP) ? 2834 c->respType : c->mesgType; 2835 if (argstype == NULL) { 2836 bufSize = 0; 2837 } else { 2838 if ((error = ng_parse(argstype, ascii->data, 2839 &off, (u_char *)binary->data, &bufSize)) != 0) { 2840 NG_FREE_MSG(resp); 2841 break; 2842 } 2843 } 2844 2845 /* Return the result */ 2846 binary->header.arglen = bufSize; 2847 resp->header.arglen = sizeof(*binary) + bufSize; 2848 break; 2849 } 2850 2851 case NGM_TEXT_CONFIG: 2852 case NGM_TEXT_STATUS: 2853 /* 2854 * This one is tricky as it passes the command down to the 2855 * actual node, even though it is a generic type command. 2856 * This means we must assume that the item/msg is already freed 2857 * when control passes back to us. 2858 */ 2859 if (here->nd_type->rcvmsg != NULL) { 2860 NGI_MSG(item) = msg; /* put it back as we found it */ 2861 return((*here->nd_type->rcvmsg)(here, item, lasthook)); 2862 } 2863 /* Fall through if rcvmsg not supported */ 2864 default: 2865 TRAP_ERROR(); 2866 error = EINVAL; 2867 } 2868 /* 2869 * Sometimes a generic message may be statically allocated 2870 * to avoid problems with allocating when in tight memeory situations. 2871 * Don't free it if it is so. 2872 * I break them appart here, because erros may cause a free if the item 2873 * in which case we'd be doing it twice. 2874 * they are kept together above, to simplify freeing. 2875 */ 2876out: 2877 NG_RESPOND_MSG(error, here, item, resp); 2878 if (msg) 2879 NG_FREE_MSG(msg); 2880 return (error); 2881} 2882 2883/* 2884 * Copy a 'meta'. 2885 * 2886 * Returns new meta, or NULL if original meta is NULL or ENOMEM. 2887 */ 2888meta_p 2889ng_copy_meta(meta_p meta) 2890{ 2891 meta_p meta2; 2892 2893 if (meta == NULL) 2894 return (NULL); 2895 MALLOC(meta2, meta_p, meta->used_len, M_NETGRAPH_META, M_NOWAIT); 2896 if (meta2 == NULL) 2897 return (NULL); 2898 meta2->allocated_len = meta->used_len; 2899 bcopy(meta, meta2, meta->used_len); 2900 return (meta2); 2901} 2902 2903/************************************************************************ 2904 Module routines 2905************************************************************************/ 2906 2907/* 2908 * Handle the loading/unloading of a netgraph node type module 2909 */ 2910int 2911ng_mod_event(module_t mod, int event, void *data) 2912{ 2913 struct ng_type *const type = data; 2914 int s, error = 0; 2915 2916 switch (event) { 2917 case MOD_LOAD: 2918 2919 /* Register new netgraph node type */ 2920 s = splnet(); 2921 if ((error = ng_newtype(type)) != 0) { 2922 splx(s); 2923 break; 2924 } 2925 2926 /* Call type specific code */ 2927 if (type->mod_event != NULL) 2928 if ((error = (*type->mod_event)(mod, event, data))) { 2929 mtx_lock(&ng_typelist_mtx); 2930 type->refs--; /* undo it */ 2931 LIST_REMOVE(type, types); 2932 mtx_unlock(&ng_typelist_mtx); 2933 } 2934 splx(s); 2935 break; 2936 2937 case MOD_UNLOAD: 2938 s = splnet(); 2939 if (type->refs > 1) { /* make sure no nodes exist! */ 2940 error = EBUSY; 2941 } else { 2942 if (type->refs == 0) { 2943 /* failed load, nothing to undo */ 2944 splx(s); 2945 break; 2946 } 2947 if (type->mod_event != NULL) { /* check with type */ 2948 error = (*type->mod_event)(mod, event, data); 2949 if (error != 0) { /* type refuses.. */ 2950 splx(s); 2951 break; 2952 } 2953 } 2954 mtx_lock(&ng_typelist_mtx); 2955 LIST_REMOVE(type, types); 2956 mtx_unlock(&ng_typelist_mtx); 2957 } 2958 splx(s); 2959 break; 2960 2961 default: 2962 if (type->mod_event != NULL) 2963 error = (*type->mod_event)(mod, event, data); 2964 else 2965 error = 0; /* XXX ? */ 2966 break; 2967 } 2968 return (error); 2969} 2970 2971/* 2972 * Handle loading and unloading for this code. 2973 * The only thing we need to link into is the NETISR strucure. 2974 */ 2975static int 2976ngb_mod_event(module_t mod, int event, void *data) 2977{ 2978 int s, error = 0; 2979 2980 switch (event) { 2981 case MOD_LOAD: 2982 /* Register line discipline */ 2983 mtx_init(&ng_worklist_mtx, "ng_worklist", NULL, MTX_SPIN); 2984 mtx_init(&ng_typelist_mtx, "netgraph types mutex", NULL, 0); 2985 mtx_init(&ng_nodelist_mtx, "netgraph nodelist mutex", NULL, 0); 2986 mtx_init(&ng_idhash_mtx, "netgraph idhash mutex", NULL, 0); 2987 mtx_init(&ngq_mtx, "netgraph free item list mutex", NULL, 0); 2988 s = splimp(); 2989 /* XXX could use NETISR_MPSAFE but need to verify code */ 2990 netisr_register(NETISR_NETGRAPH, (netisr_t *)ngintr, NULL, 0); 2991 splx(s); 2992 break; 2993 case MOD_UNLOAD: 2994 /* You cant unload it because an interface may be using it. */ 2995 error = EBUSY; 2996 break; 2997 default: 2998 error = EOPNOTSUPP; 2999 break; 3000 } 3001 return (error); 3002} 3003 3004static moduledata_t netgraph_mod = { 3005 "netgraph", 3006 ngb_mod_event, 3007 (NULL) 3008}; 3009DECLARE_MODULE(netgraph, netgraph_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE); 3010SYSCTL_NODE(_net, OID_AUTO, graph, CTLFLAG_RW, 0, "netgraph Family"); 3011SYSCTL_INT(_net_graph, OID_AUTO, abi_version, CTLFLAG_RD, 0, NG_ABI_VERSION,""); 3012SYSCTL_INT(_net_graph, OID_AUTO, msg_version, CTLFLAG_RD, 0, NG_VERSION, ""); 3013 3014/************************************************************************ 3015 Queue element get/free routines 3016************************************************************************/ 3017 3018 3019static int allocated; /* number of items malloc'd */ 3020 3021static int maxalloc = 128; /* limit the damage of a leak */ 3022static int ngqfreemax = 64;/* cache at most this many */ 3023 3024TUNABLE_INT("net.graph.maxalloc", &maxalloc); 3025SYSCTL_INT(_net_graph, OID_AUTO, maxalloc, CTLFLAG_RDTUN, &maxalloc, 3026 0, "Maximum number of queue items to allocate"); 3027 3028TUNABLE_INT("net.graph.ngqfreemax", &ngqfreemax); 3029SYSCTL_INT(_net_graph, OID_AUTO, ngqfreemax, CTLFLAG_RDTUN, &ngqfreemax, 3030 0, "Maximum number of free queue items to cache"); 3031 3032static const int ngqfreelow = 4; /* try malloc if free < this */ 3033static volatile int ngqfreesize; /* number of cached entries */ 3034static volatile item_p ngqfree; /* free ones */ 3035 3036#ifdef NETGRAPH_DEBUG 3037static TAILQ_HEAD(, ng_item) ng_itemlist = TAILQ_HEAD_INITIALIZER(ng_itemlist); 3038#endif 3039/* 3040 * Get a queue entry 3041 * This is usually called when a packet first enters netgraph. 3042 * By definition, this is usually from an interrupt, or from a user. 3043 * Users are not so important, but try be quick for the times that it's 3044 * an interrupt. 3045 * XXX If reserve is low, we should try to get 2 from malloc as this 3046 * would indicate it often fails. 3047 */ 3048static item_p 3049ng_getqblk(void) 3050{ 3051 item_p item = NULL; 3052 3053 /* 3054 * Try get a cached queue block, or else allocate a new one 3055 * If we are less than our reserve, try malloc. If malloc 3056 * fails, then that's what the reserve is for... 3057 * We have our little reserve 3058 * because we use M_NOWAIT for malloc. This just helps us 3059 * avoid dropping packets while not increasing the time 3060 * we take to service the interrupt (on average) (I hope). 3061 */ 3062 mtx_lock(&ngq_mtx); 3063 3064 if ((ngqfreesize < ngqfreelow) || (ngqfree == NULL)) { 3065 if (allocated < maxalloc) { /* don't leak forever */ 3066 MALLOC(item, item_p , 3067 sizeof(*item), M_NETGRAPH_ITEM, 3068 (M_NOWAIT | M_ZERO)); 3069 if (item) { 3070#ifdef NETGRAPH_DEBUG 3071 TAILQ_INSERT_TAIL(&ng_itemlist, item, all); 3072#endif /* NETGRAPH_DEBUG */ 3073 allocated++; 3074 } 3075 } 3076 } 3077 3078 /* 3079 * We didn't or couldn't malloc. 3080 * try get one from our cache. 3081 */ 3082 if (item == NULL && (item = ngqfree) != NULL) { 3083 ngqfree = item->el_next; 3084 ngqfreesize--; 3085 item->el_flags &= ~NGQF_FREE; 3086 } 3087 3088 mtx_unlock(&ngq_mtx); 3089 return (item); 3090} 3091 3092/* 3093 * Release a queue entry 3094 */ 3095void 3096ng_free_item(item_p item) 3097{ 3098 3099 /* 3100 * The item may hold resources on it's own. We need to free 3101 * these before we can free the item. What they are depends upon 3102 * what kind of item it is. it is important that nodes zero 3103 * out pointers to resources that they remove from the item 3104 * or we release them again here. 3105 */ 3106 if (item->el_flags & NGQF_FREE) { 3107 panic(" Freeing free queue item"); 3108 } 3109 switch (item->el_flags & NGQF_TYPE) { 3110 case NGQF_DATA: 3111 /* If we have an mbuf and metadata still attached.. */ 3112 NG_FREE_M(_NGI_M(item)); 3113 NG_FREE_META(_NGI_META(item)); 3114 break; 3115 case NGQF_MESG: 3116 _NGI_RETADDR(item) = 0; 3117 NG_FREE_MSG(_NGI_MSG(item)); 3118 break; 3119 case NGQF_FN: 3120 /* nothing to free really, */ 3121 _NGI_FN(item) = NULL; 3122 _NGI_ARG1(item) = NULL; 3123 _NGI_ARG2(item) = 0; 3124 case NGQF_UNDEF: 3125 break; 3126 } 3127 /* If we still have a node or hook referenced... */ 3128 _NGI_CLR_NODE(item); 3129 _NGI_CLR_HOOK(item); 3130 item->el_flags |= NGQF_FREE; 3131 3132 mtx_lock(&ngq_mtx); 3133 if (ngqfreesize < ngqfreemax) { 3134 ngqfreesize++; 3135 item->el_next = ngqfree; 3136 ngqfree = item; 3137 } else { 3138#ifdef NETGRAPH_DEBUG 3139 TAILQ_REMOVE(&ng_itemlist, item, all); 3140#endif /* NETGRAPH_DEBUG */ 3141 NG_FREE_ITEM_REAL(item); 3142 allocated--; 3143 } 3144 mtx_unlock(&ngq_mtx); 3145} 3146 3147#ifdef NETGRAPH_DEBUG 3148void 3149dumphook (hook_p hook, char *file, int line) 3150{ 3151 printf("hook: name %s, %d refs, Last touched:\n", 3152 _NG_HOOK_NAME(hook), hook->hk_refs); 3153 printf(" Last active @ %s, line %d\n", 3154 hook->lastfile, hook->lastline); 3155 if (line) { 3156 printf(" problem discovered at file %s, line %d\n", file, line); 3157 } 3158} 3159 3160void 3161dumpnode(node_p node, char *file, int line) 3162{ 3163 printf("node: ID [%x]: type '%s', %d hooks, flags 0x%x, %d refs, %s:\n", 3164 _NG_NODE_ID(node), node->nd_type->name, 3165 node->nd_numhooks, node->nd_flags, 3166 node->nd_refs, node->nd_name); 3167 printf(" Last active @ %s, line %d\n", 3168 node->lastfile, node->lastline); 3169 if (line) { 3170 printf(" problem discovered at file %s, line %d\n", file, line); 3171 } 3172} 3173 3174void 3175dumpitem(item_p item, char *file, int line) 3176{ 3177 if (item->el_flags & NGQF_FREE) { 3178 printf(" Free item, freed at %s, line %d\n", 3179 item->lastfile, item->lastline); 3180 } else { 3181 printf(" ACTIVE item, last used at %s, line %d", 3182 item->lastfile, item->lastline); 3183 switch(item->el_flags & NGQF_TYPE) { 3184 case NGQF_DATA: 3185 printf(" - [data]\n"); 3186 break; 3187 case NGQF_MESG: 3188 printf(" - retaddr[%d]:\n", _NGI_RETADDR(item)); 3189 break; 3190 case NGQF_FN: 3191 printf(" - fn@%p (%p, %p, %p, %d (%x))\n", 3192 item->body.fn.fn_fn, 3193 NGI_NODE(item), 3194 NGI_HOOK(item), 3195 item->body.fn.fn_arg1, 3196 item->body.fn.fn_arg2, 3197 item->body.fn.fn_arg2); 3198 break; 3199 case NGQF_UNDEF: 3200 printf(" - UNDEFINED!\n"); 3201 } 3202 } 3203 if (line) { 3204 printf(" problem discovered at file %s, line %d\n", file, line); 3205 if (NGI_NODE(item)) { 3206 printf("node %p ([%x])\n", 3207 NGI_NODE(item), ng_node2ID(NGI_NODE(item))); 3208 } 3209 } 3210} 3211 3212static void 3213ng_dumpitems(void) 3214{ 3215 item_p item; 3216 int i = 1; 3217 TAILQ_FOREACH(item, &ng_itemlist, all) { 3218 printf("[%d] ", i++); 3219 dumpitem(item, NULL, 0); 3220 } 3221} 3222 3223static void 3224ng_dumpnodes(void) 3225{ 3226 node_p node; 3227 int i = 1; 3228 SLIST_FOREACH(node, &ng_allnodes, nd_all) { 3229 printf("[%d] ", i++); 3230 dumpnode(node, NULL, 0); 3231 } 3232} 3233 3234static void 3235ng_dumphooks(void) 3236{ 3237 hook_p hook; 3238 int i = 1; 3239 SLIST_FOREACH(hook, &ng_allhooks, hk_all) { 3240 printf("[%d] ", i++); 3241 dumphook(hook, NULL, 0); 3242 } 3243} 3244 3245static int 3246sysctl_debug_ng_dump_items(SYSCTL_HANDLER_ARGS) 3247{ 3248 int error; 3249 int val; 3250 int i; 3251 3252 val = allocated; 3253 i = 1; 3254 error = sysctl_handle_int(oidp, &val, sizeof(int), req); 3255 if (error != 0 || req->newptr == NULL) 3256 return (error); 3257 if (val == 42) { 3258 ng_dumpitems(); 3259 ng_dumpnodes(); 3260 ng_dumphooks(); 3261 } 3262 return (0); 3263} 3264 3265SYSCTL_PROC(_debug, OID_AUTO, ng_dump_items, CTLTYPE_INT | CTLFLAG_RW, 3266 0, sizeof(int), sysctl_debug_ng_dump_items, "I", "Number of allocated items"); 3267#endif /* NETGRAPH_DEBUG */ 3268 3269 3270/*********************************************************************** 3271* Worklist routines 3272**********************************************************************/ 3273/* NETISR thread enters here */ 3274/* 3275 * Pick a node off the list of nodes with work, 3276 * try get an item to process off it. 3277 * If there are no more, remove the node from the list. 3278 */ 3279static void 3280ngintr(void) 3281{ 3282 item_p item; 3283 node_p node = NULL; 3284 3285 for (;;) { 3286 mtx_lock_spin(&ng_worklist_mtx); 3287 node = TAILQ_FIRST(&ng_worklist); 3288 if (!node) { 3289 mtx_unlock_spin(&ng_worklist_mtx); 3290 break; 3291 } 3292 node->nd_flags &= ~NG_WORKQ; 3293 TAILQ_REMOVE(&ng_worklist, node, nd_work); 3294 mtx_unlock_spin(&ng_worklist_mtx); 3295 /* 3296 * We have the node. We also take over the reference 3297 * that the list had on it. 3298 * Now process as much as you can, until it won't 3299 * let you have another item off the queue. 3300 * All this time, keep the reference 3301 * that lets us be sure that the node still exists. 3302 * Let the reference go at the last minute. 3303 * ng_dequeue will put us back on the worklist 3304 * if there is more too do. This may be of use if there 3305 * are Multiple Processors and multiple Net threads in the 3306 * future. 3307 */ 3308 for (;;) { 3309 mtx_lock_spin(&node->nd_input_queue.q_mtx); 3310 item = ng_dequeue(&node->nd_input_queue); 3311 if (item == NULL) { 3312 mtx_unlock_spin(&node->nd_input_queue.q_mtx); 3313 break; /* go look for another node */ 3314 } else { 3315 mtx_unlock_spin(&node->nd_input_queue.q_mtx); 3316 NGI_GET_NODE(item, node); /* zaps stored node */ 3317 ng_apply_item(node, item); 3318 NG_NODE_UNREF(node); 3319 } 3320 } 3321 NG_NODE_UNREF(node); 3322 } 3323} 3324 3325static void 3326ng_worklist_remove(node_p node) 3327{ 3328 mtx_lock_spin(&ng_worklist_mtx); 3329 if (node->nd_flags & NG_WORKQ) { 3330 node->nd_flags &= ~NG_WORKQ; 3331 TAILQ_REMOVE(&ng_worklist, node, nd_work); 3332 mtx_unlock_spin(&ng_worklist_mtx); 3333 NG_NODE_UNREF(node); 3334 } else { 3335 mtx_unlock_spin(&ng_worklist_mtx); 3336 } 3337} 3338 3339/* 3340 * XXX 3341 * It's posible that a debugging NG_NODE_REF may need 3342 * to be outside the mutex zone 3343 */ 3344static void 3345ng_setisr(node_p node) 3346{ 3347 mtx_lock_spin(&ng_worklist_mtx); 3348 if ((node->nd_flags & NG_WORKQ) == 0) { 3349 /* 3350 * If we are not already on the work queue, 3351 * then put us on. 3352 */ 3353 node->nd_flags |= NG_WORKQ; 3354 TAILQ_INSERT_TAIL(&ng_worklist, node, nd_work); 3355 NG_NODE_REF(node); /* XXX fafe in mutex? */ 3356 } 3357 mtx_unlock_spin(&ng_worklist_mtx); 3358 schednetisr(NETISR_NETGRAPH); 3359} 3360 3361 3362/*********************************************************************** 3363* Externally useable functions to set up a queue item ready for sending 3364***********************************************************************/ 3365 3366#ifdef NETGRAPH_DEBUG 3367#define ITEM_DEBUG_CHECKS \ 3368 do { \ 3369 if (NGI_NODE(item) ) { \ 3370 printf("item already has node"); \ 3371 Debugger("has node"); \ 3372 NGI_CLR_NODE(item); \ 3373 } \ 3374 if (NGI_HOOK(item) ) { \ 3375 printf("item already has hook"); \ 3376 Debugger("has hook"); \ 3377 NGI_CLR_HOOK(item); \ 3378 } \ 3379 } while (0) 3380#else 3381#define ITEM_DEBUG_CHECKS 3382#endif 3383 3384/* 3385 * Put elements into the item. 3386 * Hook and node references will be removed when the item is dequeued. 3387 * (or equivalent) 3388 * (XXX) Unsafe because no reference held by peer on remote node. 3389 * remote node might go away in this timescale. 3390 * We know the hooks can't go away because that would require getting 3391 * a writer item on both nodes and we must have at least a reader 3392 * here to eb able to do this. 3393 * Note that the hook loaded is the REMOTE hook. 3394 * 3395 * This is possibly in the critical path for new data. 3396 */ 3397item_p 3398ng_package_data(struct mbuf *m, meta_p meta) 3399{ 3400 item_p item; 3401 3402 if ((item = ng_getqblk()) == NULL) { 3403 NG_FREE_M(m); 3404 NG_FREE_META(meta); 3405 return (NULL); 3406 } 3407 ITEM_DEBUG_CHECKS; 3408 item->el_flags = NGQF_DATA; 3409 item->el_next = NULL; 3410 NGI_M(item) = m; 3411 NGI_META(item) = meta; 3412 return (item); 3413} 3414 3415/* 3416 * Allocate a queue item and put items into it.. 3417 * Evaluate the address as this will be needed to queue it and 3418 * to work out what some of the fields should be. 3419 * Hook and node references will be removed when the item is dequeued. 3420 * (or equivalent) 3421 */ 3422item_p 3423ng_package_msg(struct ng_mesg *msg) 3424{ 3425 item_p item; 3426 3427 if ((item = ng_getqblk()) == NULL) { 3428 NG_FREE_MSG(msg); 3429 return (NULL); 3430 } 3431 ITEM_DEBUG_CHECKS; 3432 item->el_flags = NGQF_MESG; 3433 item->el_next = NULL; 3434 /* 3435 * Set the current lasthook into the queue item 3436 */ 3437 NGI_MSG(item) = msg; 3438 NGI_RETADDR(item) = 0; 3439 return (item); 3440} 3441 3442 3443 3444#define SET_RETADDR(item, here, retaddr) \ 3445 do { /* Data or fn items don't have retaddrs */ \ 3446 if ((item->el_flags & NGQF_TYPE) == NGQF_MESG) { \ 3447 if (retaddr) { \ 3448 NGI_RETADDR(item) = retaddr; \ 3449 } else { \ 3450 /* \ 3451 * The old return address should be ok. \ 3452 * If there isn't one, use the address \ 3453 * here. \ 3454 */ \ 3455 if (NGI_RETADDR(item) == 0) { \ 3456 NGI_RETADDR(item) \ 3457 = ng_node2ID(here); \ 3458 } \ 3459 } \ 3460 } \ 3461 } while (0) 3462 3463int 3464ng_address_hook(node_p here, item_p item, hook_p hook, ng_ID_t retaddr) 3465{ 3466 hook_p peer; 3467 node_p peernode; 3468 ITEM_DEBUG_CHECKS; 3469 /* 3470 * Quick sanity check.. 3471 * Since a hook holds a reference on it's node, once we know 3472 * that the peer is still connected (even if invalid,) we know 3473 * that the peer node is present, though maybe invalid. 3474 */ 3475 if ((hook == NULL) 3476 || NG_HOOK_NOT_VALID(hook) 3477 || (NG_HOOK_PEER(hook) == NULL) 3478 || NG_HOOK_NOT_VALID(NG_HOOK_PEER(hook)) 3479 || NG_NODE_NOT_VALID(NG_PEER_NODE(hook))) { 3480 NG_FREE_ITEM(item); 3481 TRAP_ERROR(); 3482 return (ENETDOWN); 3483 } 3484 3485 /* 3486 * Transfer our interest to the other (peer) end. 3487 */ 3488 peer = NG_HOOK_PEER(hook); 3489 NG_HOOK_REF(peer); 3490 NGI_SET_HOOK(item, peer); 3491 peernode = NG_PEER_NODE(hook); 3492 NG_NODE_REF(peernode); 3493 NGI_SET_NODE(item, peernode); 3494 SET_RETADDR(item, here, retaddr); 3495 return (0); 3496} 3497 3498int 3499ng_address_path(node_p here, item_p item, char *address, ng_ID_t retaddr) 3500{ 3501 node_p dest = NULL; 3502 hook_p hook = NULL; 3503 int error; 3504 3505 ITEM_DEBUG_CHECKS; 3506 /* 3507 * Note that ng_path2noderef increments the reference count 3508 * on the node for us if it finds one. So we don't have to. 3509 */ 3510 error = ng_path2noderef(here, address, &dest, &hook); 3511 if (error) { 3512 NG_FREE_ITEM(item); 3513 return (error); 3514 } 3515 NGI_SET_NODE(item, dest); 3516 if ( hook) { 3517 NG_HOOK_REF(hook); /* don't let it go while on the queue */ 3518 NGI_SET_HOOK(item, hook); 3519 } 3520 SET_RETADDR(item, here, retaddr); 3521 return (0); 3522} 3523 3524int 3525ng_address_ID(node_p here, item_p item, ng_ID_t ID, ng_ID_t retaddr) 3526{ 3527 node_p dest; 3528 3529 ITEM_DEBUG_CHECKS; 3530 /* 3531 * Find the target node. 3532 */ 3533 dest = ng_ID2noderef(ID); /* GETS REFERENCE! */ 3534 if (dest == NULL) { 3535 NG_FREE_ITEM(item); 3536 TRAP_ERROR(); 3537 return(EINVAL); 3538 } 3539 /* Fill out the contents */ 3540 item->el_flags = NGQF_MESG; 3541 item->el_next = NULL; 3542 NGI_SET_NODE(item, dest); 3543 NGI_CLR_HOOK(item); 3544 SET_RETADDR(item, here, retaddr); 3545 return (0); 3546} 3547 3548/* 3549 * special case to send a message to self (e.g. destroy node) 3550 * Possibly indicate an arrival hook too. 3551 * Useful for removing that hook :-) 3552 */ 3553item_p 3554ng_package_msg_self(node_p here, hook_p hook, struct ng_mesg *msg) 3555{ 3556 item_p item; 3557 3558 /* 3559 * Find the target node. 3560 * If there is a HOOK argument, then use that in preference 3561 * to the address. 3562 */ 3563 if ((item = ng_getqblk()) == NULL) { 3564 NG_FREE_MSG(msg); 3565 return (NULL); 3566 } 3567 3568 /* Fill out the contents */ 3569 item->el_flags = NGQF_MESG; 3570 item->el_next = NULL; 3571 NG_NODE_REF(here); 3572 NGI_SET_NODE(item, here); 3573 if (hook) { 3574 NG_HOOK_REF(hook); 3575 NGI_SET_HOOK(item, hook); 3576 } 3577 NGI_MSG(item) = msg; 3578 NGI_RETADDR(item) = ng_node2ID(here); 3579 return (item); 3580} 3581 3582int 3583ng_send_fn(node_p node, hook_p hook, ng_item_fn *fn, void * arg1, int arg2) 3584{ 3585 item_p item; 3586 3587 if ((item = ng_getqblk()) == NULL) { 3588 return (ENOMEM); 3589 } 3590 item->el_flags = NGQF_FN | NGQF_WRITER; 3591 NG_NODE_REF(node); /* and one for the item */ 3592 NGI_SET_NODE(item, node); 3593 if (hook) { 3594 NG_HOOK_REF(hook); 3595 NGI_SET_HOOK(item, hook); 3596 } 3597 NGI_FN(item) = fn; 3598 NGI_ARG1(item) = arg1; 3599 NGI_ARG2(item) = arg2; 3600 return(ng_snd_item(item, 0)); 3601} 3602 3603/* 3604 * Official timeout routines for Netgraph nodes. 3605 */ 3606static void 3607ng_timeout_trapoline(void *arg) 3608{ 3609 item_p item = arg; 3610 3611 ng_snd_item(item, 0); 3612} 3613 3614 3615struct callout_handle 3616ng_timeout(node_p node, hook_p hook, int ticks, 3617 ng_item_fn *fn, void * arg1, int arg2) 3618{ 3619 item_p item; 3620 3621 if ((item = ng_getqblk()) == NULL) { 3622 struct callout_handle handle; 3623 handle.callout = NULL; 3624 return (handle); 3625 } 3626 item->el_flags = NGQF_FN | NGQF_WRITER; 3627 NG_NODE_REF(node); /* and one for the item */ 3628 NGI_SET_NODE(item, node); 3629 if (hook) { 3630 NG_HOOK_REF(hook); 3631 NGI_SET_HOOK(item, hook); 3632 } 3633 NGI_FN(item) = fn; 3634 NGI_ARG1(item) = arg1; 3635 NGI_ARG2(item) = arg2; 3636 return (timeout(&ng_timeout_trapoline, item, ticks)); 3637} 3638 3639/* A special modified version of untimeout() */ 3640int 3641ng_untimeout(struct callout_handle handle, node_p node) 3642{ 3643 item_p item; 3644 3645 if (handle.callout == NULL) 3646 return (0); 3647 mtx_lock_spin(&callout_lock); 3648 item = handle.callout->c_arg; /* should be an official way to do this */ 3649 if ((handle.callout->c_func == &ng_timeout_trapoline) && 3650 (NGI_NODE(item) == node) && 3651 (callout_stop(handle.callout))) { 3652 /* 3653 * We successfully removed it from the queue before it ran 3654 * So now we need to unreference everything that was 3655 * given extra references. (NG_FREE_ITEM does this). 3656 */ 3657 mtx_unlock_spin(&callout_lock); 3658 NG_FREE_ITEM(item); 3659 return (1); 3660 } 3661 mtx_unlock_spin(&callout_lock); 3662 return (0); 3663} 3664 3665/* 3666 * Set the address, if none given, give the node here. 3667 */ 3668void 3669ng_replace_retaddr(node_p here, item_p item, ng_ID_t retaddr) 3670{ 3671 if (retaddr) { 3672 NGI_RETADDR(item) = retaddr; 3673 } else { 3674 /* 3675 * The old return address should be ok. 3676 * If there isn't one, use the address here. 3677 */ 3678 NGI_RETADDR(item) = ng_node2ID(here); 3679 } 3680} 3681 3682#define TESTING 3683#ifdef TESTING 3684/* just test all the macros */ 3685void 3686ng_macro_test(item_p item); 3687void 3688ng_macro_test(item_p item) 3689{ 3690 node_p node = NULL; 3691 hook_p hook = NULL; 3692 struct mbuf *m; 3693 meta_p meta; 3694 struct ng_mesg *msg; 3695 ng_ID_t retaddr; 3696 int error; 3697 3698 NGI_GET_M(item, m); 3699 NGI_GET_META(item, meta); 3700 NGI_GET_MSG(item, msg); 3701 retaddr = NGI_RETADDR(item); 3702 NG_SEND_DATA(error, hook, m, meta); 3703 NG_SEND_DATA_ONLY(error, hook, m); 3704 NG_FWD_NEW_DATA(error, item, hook, m); 3705 NG_FWD_ITEM_HOOK(error, item, hook); 3706 NG_SEND_MSG_HOOK(error, node, msg, hook, retaddr); 3707 NG_SEND_MSG_ID(error, node, msg, retaddr, retaddr); 3708 NG_SEND_MSG_PATH(error, node, msg, ".:", retaddr); 3709 NG_FWD_MSG_HOOK(error, node, item, hook, retaddr); 3710} 3711#endif /* TESTING */ 3712 3713