6 * Copyright (c) 1996-1999 Whistle Communications, Inc.
9 * Subject to the following obligations and disclaimer of warranty, use and
10 * redistribution of this software, in source or object code forms, with or
11 * without modifications are expressly permitted by Whistle Communications;
12 * provided, however, that:
13 * 1. Any and all reproductions of the source or object code must include the
14 * copyright notice above and the following disclaimer of warranties; and
15 * 2. No rights are granted, in any manner or form, to use Whistle
16 * Communications, Inc. trademarks, including the mark "WHISTLE
17 * COMMUNICATIONS" on advertising, endorsements, or otherwise except as
18 * such appears in the above copyright notice or in the software.
20 * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
21 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
22 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
23 * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
24 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
25 * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
26 * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
27 * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
28 * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
29 * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
30 * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
31 * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
32 * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35 * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
38 * Authors: Julian Elischer <julian@freebsd.org>
39 * Archie Cobbs <archie@freebsd.org>
42 * $Whistle: ng_base.c,v 1.39 1999/01/28 23:54:53 julian Exp $
46 * This file implements the base netgraph code.
49 #include <sys/param.h>
50 #include <sys/systm.h>
51 #include <sys/ctype.h>
52 #include <sys/errno.h>
54 #include <sys/kernel.h>
56 #include <sys/limits.h>
57 #include <sys/malloc.h>
59 #include <sys/queue.h>
60 #include <sys/sysctl.h>
61 #include <sys/syslog.h>
62 #include <sys/refcount.h>
65 #include <net/netisr.h>
67 #include <netgraph/ng_message.h>
68 #include <netgraph/netgraph.h>
69 #include <netgraph/ng_parse.h>
71 MODULE_VERSION(netgraph, NG_ABI_VERSION);
73 /* Mutex to protect topology events. */
74 static struct mtx ng_topo_mtx;
77 static struct mtx ng_nodelist_mtx; /* protects global node/hook lists */
78 static struct mtx ngq_mtx; /* protects the queue item list */
80 static SLIST_HEAD(, ng_node) ng_allnodes;
81 static LIST_HEAD(, ng_node) ng_freenodes; /* in debug, we never free() them */
82 static SLIST_HEAD(, ng_hook) ng_allhooks;
83 static LIST_HEAD(, ng_hook) ng_freehooks; /* in debug, we never free() them */
85 static void ng_dumpitems(void);
86 static void ng_dumpnodes(void);
87 static void ng_dumphooks(void);
89 #endif /* NETGRAPH_DEBUG */
91 * DEAD versions of the structures.
92 * In order to avoid races, it is sometimes neccesary to point
93 * at SOMETHING even though theoretically, the current entity is
94 * INVALID. Use these to avoid these races.
96 struct ng_type ng_deadtype = {
100 NULL, /* constructor */
107 NULL, /* disconnect */
111 struct ng_node ng_deadnode = {
119 LIST_HEAD_INITIALIZER(ng_deadnode.hooks),
120 {}, /* all_nodes list entry */
121 {}, /* id hashtable list entry */
122 {}, /* workqueue entry */
124 {}, /* should never use! (should hang) */
126 &ng_deadnode.nd_input_queue.queue,
129 #ifdef NETGRAPH_DEBUG
134 #endif /* NETGRAPH_DEBUG */
137 struct ng_hook ng_deadhook = {
140 HK_INVALID | HK_DEAD,
141 1, /* refs always >= 1 */
142 0, /* undefined data link type */
143 &ng_deadhook, /* Peer is self */
144 &ng_deadnode, /* attached to deadnode */
146 NULL, /* override rcvmsg() */
147 NULL, /* override rcvdata() */
148 #ifdef NETGRAPH_DEBUG
153 #endif /* NETGRAPH_DEBUG */
157 * END DEAD STRUCTURES
159 /* List nodes with unallocated work */
160 static TAILQ_HEAD(, ng_node) ng_worklist = TAILQ_HEAD_INITIALIZER(ng_worklist);
161 static struct mtx ng_worklist_mtx; /* MUST LOCK NODE FIRST */
163 /* List of installed types */
164 static LIST_HEAD(, ng_type) ng_typelist;
165 static struct mtx ng_typelist_mtx;
167 /* Hash related definitions */
168 /* XXX Don't need to initialise them because it's a LIST */
169 #define NG_ID_HASH_SIZE 128 /* most systems wont need even this many */
170 static LIST_HEAD(, ng_node) ng_ID_hash[NG_ID_HASH_SIZE];
171 static struct mtx ng_idhash_mtx;
172 /* Method to find a node.. used twice so do it here */
173 #define NG_IDHASH_FN(ID) ((ID) % (NG_ID_HASH_SIZE))
174 #define NG_IDHASH_FIND(ID, node) \
176 mtx_assert(&ng_idhash_mtx, MA_OWNED); \
177 LIST_FOREACH(node, &ng_ID_hash[NG_IDHASH_FN(ID)], \
179 if (NG_NODE_IS_VALID(node) \
180 && (NG_NODE_ID(node) == ID)) { \
186 #define NG_NAME_HASH_SIZE 128 /* most systems wont need even this many */
187 static LIST_HEAD(, ng_node) ng_name_hash[NG_NAME_HASH_SIZE];
188 static struct mtx ng_namehash_mtx;
189 #define NG_NAMEHASH(NAME, HASH) \
193 for (c = (const u_char*)(NAME); *c; c++)\
195 (HASH) = h % (NG_NAME_HASH_SIZE); \
199 /* Internal functions */
200 static int ng_add_hook(node_p node, const char *name, hook_p * hookp);
201 static int ng_generic_msg(node_p here, item_p item, hook_p lasthook);
202 static ng_ID_t ng_decodeidname(const char *name);
203 static int ngb_mod_event(module_t mod, int event, void *data);
204 static void ng_worklist_remove(node_p node);
205 static void ngintr(void);
206 static int ng_apply_item(node_p node, item_p item, int rw);
207 static void ng_flush_input_queue(struct ng_queue * ngq);
208 static void ng_setisr(node_p node);
209 static node_p ng_ID2noderef(ng_ID_t ID);
210 static int ng_con_nodes(item_p item, node_p node, const char *name,
211 node_p node2, const char *name2);
212 static int ng_con_part2(node_p node, item_p item, hook_p hook);
213 static int ng_con_part3(node_p node, item_p item, hook_p hook);
214 static int ng_mkpeer(node_p node, const char *name,
215 const char *name2, char *type);
217 /* Imported, these used to be externally visible, some may go back. */
218 void ng_destroy_hook(hook_p hook);
219 node_p ng_name2noderef(node_p node, const char *name);
220 int ng_path2noderef(node_p here, const char *path,
221 node_p *dest, hook_p *lasthook);
222 int ng_make_node(const char *type, node_p *nodepp);
223 int ng_path_parse(char *addr, char **node, char **path, char **hook);
224 void ng_rmnode(node_p node, hook_p dummy1, void *dummy2, int dummy3);
225 void ng_unname(node_p node);
228 /* Our own netgraph malloc type */
229 MALLOC_DEFINE(M_NETGRAPH, "netgraph", "netgraph structures and ctrl messages");
230 MALLOC_DEFINE(M_NETGRAPH_HOOK, "netgraph_hook", "netgraph hook structures");
231 MALLOC_DEFINE(M_NETGRAPH_NODE, "netgraph_node", "netgraph node structures");
232 MALLOC_DEFINE(M_NETGRAPH_ITEM, "netgraph_item", "netgraph item structures");
233 MALLOC_DEFINE(M_NETGRAPH_MSG, "netgraph_msg", "netgraph name storage");
235 /* Should not be visible outside this file */
237 #define _NG_ALLOC_HOOK(hook) \
238 MALLOC(hook, hook_p, sizeof(*hook), M_NETGRAPH_HOOK, M_NOWAIT | M_ZERO)
239 #define _NG_ALLOC_NODE(node) \
240 MALLOC(node, node_p, sizeof(*node), M_NETGRAPH_NODE, M_NOWAIT | M_ZERO)
242 #define NG_QUEUE_LOCK_INIT(n) \
243 mtx_init(&(n)->q_mtx, "ng_node", NULL, MTX_DEF)
244 #define NG_QUEUE_LOCK(n) \
245 mtx_lock(&(n)->q_mtx)
246 #define NG_QUEUE_UNLOCK(n) \
247 mtx_unlock(&(n)->q_mtx)
248 #define NG_WORKLIST_LOCK_INIT() \
249 mtx_init(&ng_worklist_mtx, "ng_worklist", NULL, MTX_DEF)
250 #define NG_WORKLIST_LOCK() \
251 mtx_lock(&ng_worklist_mtx)
252 #define NG_WORKLIST_UNLOCK() \
253 mtx_unlock(&ng_worklist_mtx)
255 #ifdef NETGRAPH_DEBUG /*----------------------------------------------*/
258 * In an attempt to help track reference count screwups
259 * we do not free objects back to the malloc system, but keep them
260 * in a local cache where we can examine them and keep information safely
261 * after they have been freed.
262 * We use this scheme for nodes and hooks, and to some extent for items.
264 static __inline hook_p
268 SLIST_ENTRY(ng_hook) temp;
269 mtx_lock(&ng_nodelist_mtx);
270 hook = LIST_FIRST(&ng_freehooks);
272 LIST_REMOVE(hook, hk_hooks);
273 bcopy(&hook->hk_all, &temp, sizeof(temp));
274 bzero(hook, sizeof(struct ng_hook));
275 bcopy(&temp, &hook->hk_all, sizeof(temp));
276 mtx_unlock(&ng_nodelist_mtx);
277 hook->hk_magic = HK_MAGIC;
279 mtx_unlock(&ng_nodelist_mtx);
280 _NG_ALLOC_HOOK(hook);
282 hook->hk_magic = HK_MAGIC;
283 mtx_lock(&ng_nodelist_mtx);
284 SLIST_INSERT_HEAD(&ng_allhooks, hook, hk_all);
285 mtx_unlock(&ng_nodelist_mtx);
291 static __inline node_p
295 SLIST_ENTRY(ng_node) temp;
296 mtx_lock(&ng_nodelist_mtx);
297 node = LIST_FIRST(&ng_freenodes);
299 LIST_REMOVE(node, nd_nodes);
300 bcopy(&node->nd_all, &temp, sizeof(temp));
301 bzero(node, sizeof(struct ng_node));
302 bcopy(&temp, &node->nd_all, sizeof(temp));
303 mtx_unlock(&ng_nodelist_mtx);
304 node->nd_magic = ND_MAGIC;
306 mtx_unlock(&ng_nodelist_mtx);
307 _NG_ALLOC_NODE(node);
309 node->nd_magic = ND_MAGIC;
310 mtx_lock(&ng_nodelist_mtx);
311 SLIST_INSERT_HEAD(&ng_allnodes, node, nd_all);
312 mtx_unlock(&ng_nodelist_mtx);
318 #define NG_ALLOC_HOOK(hook) do { (hook) = ng_alloc_hook(); } while (0)
319 #define NG_ALLOC_NODE(node) do { (node) = ng_alloc_node(); } while (0)
322 #define NG_FREE_HOOK(hook) \
324 mtx_lock(&ng_nodelist_mtx); \
325 LIST_INSERT_HEAD(&ng_freehooks, hook, hk_hooks); \
326 hook->hk_magic = 0; \
327 mtx_unlock(&ng_nodelist_mtx); \
330 #define NG_FREE_NODE(node) \
332 mtx_lock(&ng_nodelist_mtx); \
333 LIST_INSERT_HEAD(&ng_freenodes, node, nd_nodes); \
334 node->nd_magic = 0; \
335 mtx_unlock(&ng_nodelist_mtx); \
338 #else /* NETGRAPH_DEBUG */ /*----------------------------------------------*/
340 #define NG_ALLOC_HOOK(hook) _NG_ALLOC_HOOK(hook)
341 #define NG_ALLOC_NODE(node) _NG_ALLOC_NODE(node)
343 #define NG_FREE_HOOK(hook) do { FREE((hook), M_NETGRAPH_HOOK); } while (0)
344 #define NG_FREE_NODE(node) do { FREE((node), M_NETGRAPH_NODE); } while (0)
346 #endif /* NETGRAPH_DEBUG */ /*----------------------------------------------*/
348 /* Set this to kdb_enter("X") to catch all errors as they occur */
353 static ng_ID_t nextID = 1;
356 #define CHECK_DATA_MBUF(m) do { \
361 for (total = 0, n = (m); n != NULL; n = n->m_next) { \
363 if (n->m_nextpkt != NULL) \
364 panic("%s: m_nextpkt", __func__); \
367 if ((m)->m_pkthdr.len != total) { \
368 panic("%s: %d != %d", \
369 __func__, (m)->m_pkthdr.len, total); \
373 #define CHECK_DATA_MBUF(m)
376 #define ERROUT(x) do { error = (x); goto done; } while (0)
378 /************************************************************************
379 Parse type definitions for generic messages
380 ************************************************************************/
382 /* Handy structure parse type defining macro */
383 #define DEFINE_PARSE_STRUCT_TYPE(lo, up, args) \
384 static const struct ng_parse_struct_field \
385 ng_ ## lo ## _type_fields[] = NG_GENERIC_ ## up ## _INFO args; \
386 static const struct ng_parse_type ng_generic_ ## lo ## _type = { \
387 &ng_parse_struct_type, \
388 &ng_ ## lo ## _type_fields \
391 DEFINE_PARSE_STRUCT_TYPE(mkpeer, MKPEER, ());
392 DEFINE_PARSE_STRUCT_TYPE(connect, CONNECT, ());
393 DEFINE_PARSE_STRUCT_TYPE(name, NAME, ());
394 DEFINE_PARSE_STRUCT_TYPE(rmhook, RMHOOK, ());
395 DEFINE_PARSE_STRUCT_TYPE(nodeinfo, NODEINFO, ());
396 DEFINE_PARSE_STRUCT_TYPE(typeinfo, TYPEINFO, ());
397 DEFINE_PARSE_STRUCT_TYPE(linkinfo, LINKINFO, (&ng_generic_nodeinfo_type));
399 /* Get length of an array when the length is stored as a 32 bit
400 value immediately preceding the array -- as with struct namelist
401 and struct typelist. */
403 ng_generic_list_getLength(const struct ng_parse_type *type,
404 const u_char *start, const u_char *buf)
406 return *((const u_int32_t *)(buf - 4));
409 /* Get length of the array of struct linkinfo inside a struct hooklist */
411 ng_generic_linkinfo_getLength(const struct ng_parse_type *type,
412 const u_char *start, const u_char *buf)
414 const struct hooklist *hl = (const struct hooklist *)start;
416 return hl->nodeinfo.hooks;
419 /* Array type for a variable length array of struct namelist */
420 static const struct ng_parse_array_info ng_nodeinfoarray_type_info = {
421 &ng_generic_nodeinfo_type,
422 &ng_generic_list_getLength
424 static const struct ng_parse_type ng_generic_nodeinfoarray_type = {
425 &ng_parse_array_type,
426 &ng_nodeinfoarray_type_info
429 /* Array type for a variable length array of struct typelist */
430 static const struct ng_parse_array_info ng_typeinfoarray_type_info = {
431 &ng_generic_typeinfo_type,
432 &ng_generic_list_getLength
434 static const struct ng_parse_type ng_generic_typeinfoarray_type = {
435 &ng_parse_array_type,
436 &ng_typeinfoarray_type_info
439 /* Array type for array of struct linkinfo in struct hooklist */
440 static const struct ng_parse_array_info ng_generic_linkinfo_array_type_info = {
441 &ng_generic_linkinfo_type,
442 &ng_generic_linkinfo_getLength
444 static const struct ng_parse_type ng_generic_linkinfo_array_type = {
445 &ng_parse_array_type,
446 &ng_generic_linkinfo_array_type_info
449 DEFINE_PARSE_STRUCT_TYPE(typelist, TYPELIST, (&ng_generic_nodeinfoarray_type));
450 DEFINE_PARSE_STRUCT_TYPE(hooklist, HOOKLIST,
451 (&ng_generic_nodeinfo_type, &ng_generic_linkinfo_array_type));
452 DEFINE_PARSE_STRUCT_TYPE(listnodes, LISTNODES,
453 (&ng_generic_nodeinfoarray_type));
455 /* List of commands and how to convert arguments to/from ASCII */
456 static const struct ng_cmdlist ng_generic_cmds[] = {
468 &ng_generic_mkpeer_type,
475 &ng_generic_connect_type,
482 &ng_generic_name_type,
489 &ng_generic_rmhook_type,
497 &ng_generic_nodeinfo_type
504 &ng_generic_hooklist_type
511 &ng_generic_listnodes_type /* same as NGM_LISTNODES */
518 &ng_generic_listnodes_type
525 &ng_generic_typeinfo_type
532 &ng_parse_string_type
539 &ng_parse_string_type
545 &ng_parse_ng_mesg_type,
546 &ng_parse_ng_mesg_type
552 &ng_parse_ng_mesg_type,
553 &ng_parse_ng_mesg_type
558 /************************************************************************
560 ************************************************************************/
563 * Instantiate a node of the requested type
566 ng_make_node(const char *typename, node_p *nodepp)
568 struct ng_type *type;
571 /* Check that the type makes sense */
572 if (typename == NULL) {
577 /* Locate the node type. If we fail we return. Do not try to load
580 if ((type = ng_findtype(typename)) == NULL)
584 * If we have a constructor, then make the node and
585 * call the constructor to do type specific initialisation.
587 if (type->constructor != NULL) {
588 if ((error = ng_make_node_common(type, nodepp)) == 0) {
589 if ((error = ((*type->constructor)(*nodepp)) != 0)) {
590 NG_NODE_UNREF(*nodepp);
595 * Node has no constructor. We cannot ask for one
596 * to be made. It must be brought into existence by
597 * some external agency. The external agency should
598 * call ng_make_node_common() directly to get the
599 * netgraph part initialised.
608 * Generic node creation. Called by node initialisation for externally
609 * instantiated nodes (e.g. hardware, sockets, etc ).
610 * The returned node has a reference count of 1.
613 ng_make_node_common(struct ng_type *type, node_p *nodepp)
617 /* Require the node type to have been already installed */
618 if (ng_findtype(type->name) == NULL) {
623 /* Make a node and try attach it to the type */
629 node->nd_type = type;
630 NG_NODE_REF(node); /* note reference */
633 NG_QUEUE_LOCK_INIT(&node->nd_input_queue);
634 node->nd_input_queue.queue = NULL;
635 node->nd_input_queue.last = &node->nd_input_queue.queue;
636 node->nd_input_queue.q_flags = 0;
637 node->nd_input_queue.q_node = node;
639 /* Initialize hook list for new node */
640 LIST_INIT(&node->nd_hooks);
642 /* Link us into the name hash. */
643 mtx_lock(&ng_namehash_mtx);
644 LIST_INSERT_HEAD(&ng_name_hash[0], node, nd_nodes);
645 mtx_unlock(&ng_namehash_mtx);
647 /* get an ID and put us in the hash chain */
648 mtx_lock(&ng_idhash_mtx);
649 for (;;) { /* wrap protection, even if silly */
651 node->nd_ID = nextID++; /* 137/second for 1 year before wrap */
653 /* Is there a problem with the new number? */
654 NG_IDHASH_FIND(node->nd_ID, node2); /* already taken? */
655 if ((node->nd_ID != 0) && (node2 == NULL)) {
659 LIST_INSERT_HEAD(&ng_ID_hash[NG_IDHASH_FN(node->nd_ID)],
661 mtx_unlock(&ng_idhash_mtx);
669 * Forceably start the shutdown process on a node. Either call
670 * its shutdown method, or do the default shutdown if there is
671 * no type-specific method.
673 * We can only be called from a shutdown message, so we know we have
674 * a writer lock, and therefore exclusive access. It also means
675 * that we should not be on the work queue, but we check anyhow.
677 * Persistent node types must have a type-specific method which
678 * allocates a new node in which case, this one is irretrievably going away,
679 * or cleans up anything it needs, and just makes the node valid again,
680 * in which case we allow the node to survive.
682 * XXX We need to think of how to tell a persistent node that we
683 * REALLY need to go away because the hardware has gone or we
684 * are rebooting.... etc.
687 ng_rmnode(node_p node, hook_p dummy1, void *dummy2, int dummy3)
691 /* Check if it's already shutting down */
692 if ((node->nd_flags & NGF_CLOSING) != 0)
695 if (node == &ng_deadnode) {
696 printf ("shutdown called on deadnode\n");
700 /* Add an extra reference so it doesn't go away during this */
704 * Mark it invalid so any newcomers know not to try use it
705 * Also add our own mark so we can't recurse
706 * note that NGF_INVALID does not do this as it's also set during
709 node->nd_flags |= NGF_INVALID|NGF_CLOSING;
711 /* If node has its pre-shutdown method, then call it first*/
712 if (node->nd_type && node->nd_type->close)
713 (*node->nd_type->close)(node);
715 /* Notify all remaining connected nodes to disconnect */
716 while ((hook = LIST_FIRST(&node->nd_hooks)) != NULL)
717 ng_destroy_hook(hook);
720 * Drain the input queue forceably.
721 * it has no hooks so what's it going to do, bleed on someone?
722 * Theoretically we came here from a queue entry that was added
723 * Just before the queue was closed, so it should be empty anyway.
724 * Also removes us from worklist if needed.
726 ng_flush_input_queue(&node->nd_input_queue);
728 /* Ask the type if it has anything to do in this case */
729 if (node->nd_type && node->nd_type->shutdown) {
730 (*node->nd_type->shutdown)(node);
731 if (NG_NODE_IS_VALID(node)) {
733 * Well, blow me down if the node code hasn't declared
734 * that it doesn't want to die.
735 * Presumably it is a persistant node.
736 * If we REALLY want it to go away,
737 * e.g. hardware going away,
738 * Our caller should set NGF_REALLY_DIE in nd_flags.
740 node->nd_flags &= ~(NGF_INVALID|NGF_CLOSING);
741 NG_NODE_UNREF(node); /* Assume they still have theirs */
744 } else { /* do the default thing */
748 ng_unname(node); /* basically a NOP these days */
751 * Remove extra reference, possibly the last
752 * Possible other holders of references may include
753 * timeout callouts, but theoretically the node's supposed to
754 * have cancelled them. Possibly hardware dependencies may
755 * force a driver to 'linger' with a reference.
761 * Remove a reference to the node, possibly the last.
762 * deadnode always acts as it it were the last.
765 ng_unref_node(node_p node)
769 if (node == &ng_deadnode) {
774 v = node->nd_refs - 1;
775 } while (! atomic_cmpset_int(&node->nd_refs, v + 1, v));
777 if (v == 0) { /* we were the last */
779 mtx_lock(&ng_namehash_mtx);
780 node->nd_type->refs--; /* XXX maybe should get types lock? */
781 LIST_REMOVE(node, nd_nodes);
782 mtx_unlock(&ng_namehash_mtx);
784 mtx_lock(&ng_idhash_mtx);
785 LIST_REMOVE(node, nd_idnodes);
786 mtx_unlock(&ng_idhash_mtx);
788 mtx_destroy(&node->nd_input_queue.q_mtx);
794 /************************************************************************
796 ************************************************************************/
798 ng_ID2noderef(ng_ID_t ID)
801 mtx_lock(&ng_idhash_mtx);
802 NG_IDHASH_FIND(ID, node);
805 mtx_unlock(&ng_idhash_mtx);
810 ng_node2ID(node_p node)
812 return (node ? NG_NODE_ID(node) : 0);
815 /************************************************************************
817 ************************************************************************/
820 * Assign a node a name. Once assigned, the name cannot be changed.
823 ng_name_node(node_p node, const char *name)
828 /* Check the name is valid */
829 for (i = 0; i < NG_NODESIZ; i++) {
830 if (name[i] == '\0' || name[i] == '.' || name[i] == ':')
833 if (i == 0 || name[i] != '\0') {
837 if (ng_decodeidname(name) != 0) { /* valid IDs not allowed here */
842 /* Check the name isn't already being used */
843 if ((node2 = ng_name2noderef(node, name)) != NULL) {
844 NG_NODE_UNREF(node2);
850 strlcpy(NG_NODE_NAME(node), name, NG_NODESIZ);
852 /* Update name hash. */
853 NG_NAMEHASH(name, hash);
854 mtx_lock(&ng_namehash_mtx);
855 LIST_REMOVE(node, nd_nodes);
856 LIST_INSERT_HEAD(&ng_name_hash[hash], node, nd_nodes);
857 mtx_unlock(&ng_namehash_mtx);
863 * Find a node by absolute name. The name should NOT end with ':'
864 * The name "." means "this node" and "[xxx]" means "the node
865 * with ID (ie, at address) xxx".
867 * Returns the node if found, else NULL.
868 * Eventually should add something faster than a sequential search.
869 * Note it acquires a reference on the node so you can be sure it's still
873 ng_name2noderef(node_p here, const char *name)
879 /* "." means "this node" */
880 if (strcmp(name, ".") == 0) {
885 /* Check for name-by-ID */
886 if ((temp = ng_decodeidname(name)) != 0) {
887 return (ng_ID2noderef(temp));
890 /* Find node by name */
891 NG_NAMEHASH(name, hash);
892 mtx_lock(&ng_namehash_mtx);
893 LIST_FOREACH(node, &ng_name_hash[hash], nd_nodes) {
894 if (NG_NODE_IS_VALID(node) &&
895 (strcmp(NG_NODE_NAME(node), name) == 0)) {
901 mtx_unlock(&ng_namehash_mtx);
906 * Decode an ID name, eg. "[f03034de]". Returns 0 if the
907 * string is not valid, otherwise returns the value.
910 ng_decodeidname(const char *name)
912 const int len = strlen(name);
916 /* Check for proper length, brackets, no leading junk */
919 || (name[len - 1] != ']')
920 || (!isxdigit(name[1]))) {
925 val = strtoul(name + 1, &eptr, 16);
926 if ((eptr - name != len - 1)
927 || (val == ULONG_MAX)
935 * Remove a name from a node. This should only be called
936 * when shutting down and removing the node.
937 * IF we allow name changing this may be more resurrected.
940 ng_unname(node_p node)
944 /************************************************************************
946 Names are not optional. Hooks are always connected, except for a
947 brief moment within these routines. On invalidation or during creation
948 they are connected to the 'dead' hook.
949 ************************************************************************/
952 * Remove a hook reference
955 ng_unref_hook(hook_p hook)
959 if (hook == &ng_deadhook) {
964 } while (! atomic_cmpset_int(&hook->hk_refs, v, v - 1));
966 if (v == 1) { /* we were the last */
967 if (_NG_HOOK_NODE(hook)) { /* it'll probably be ng_deadnode */
968 _NG_NODE_UNREF((_NG_HOOK_NODE(hook)));
969 hook->hk_node = NULL;
976 * Add an unconnected hook to a node. Only used internally.
977 * Assumes node is locked. (XXX not yet true )
980 ng_add_hook(node_p node, const char *name, hook_p *hookp)
985 /* Check that the given name is good */
990 if (ng_findhook(node, name) != NULL) {
995 /* Allocate the hook and link it up */
1001 hook->hk_refs = 1; /* add a reference for us to return */
1002 hook->hk_flags = HK_INVALID;
1003 hook->hk_peer = &ng_deadhook; /* start off this way */
1004 hook->hk_node = node;
1005 NG_NODE_REF(node); /* each hook counts as a reference */
1008 strlcpy(NG_HOOK_NAME(hook), name, NG_HOOKSIZ);
1011 * Check if the node type code has something to say about it
1012 * If it fails, the unref of the hook will also unref the node.
1014 if (node->nd_type->newhook != NULL) {
1015 if ((error = (*node->nd_type->newhook)(node, hook, name))) {
1016 NG_HOOK_UNREF(hook); /* this frees the hook */
1021 * The 'type' agrees so far, so go ahead and link it in.
1022 * We'll ask again later when we actually connect the hooks.
1024 LIST_INSERT_HEAD(&node->nd_hooks, hook, hk_hooks);
1025 node->nd_numhooks++;
1026 NG_HOOK_REF(hook); /* one for the node */
1036 * Node types may supply their own optimized routines for finding
1037 * hooks. If none is supplied, we just do a linear search.
1038 * XXX Possibly we should add a reference to the hook?
1041 ng_findhook(node_p node, const char *name)
1045 if (node->nd_type->findhook != NULL)
1046 return (*node->nd_type->findhook)(node, name);
1047 LIST_FOREACH(hook, &node->nd_hooks, hk_hooks) {
1048 if (NG_HOOK_IS_VALID(hook)
1049 && (strcmp(NG_HOOK_NAME(hook), name) == 0))
1058 * As hooks are always attached, this really destroys two hooks.
1059 * The one given, and the one attached to it. Disconnect the hooks
1060 * from each other first. We reconnect the peer hook to the 'dead'
1061 * hook so that it can still exist after we depart. We then
1062 * send the peer its own destroy message. This ensures that we only
1063 * interact with the peer's structures when it is locked processing that
1064 * message. We hold a reference to the peer hook so we are guaranteed that
1065 * the peer hook and node are still going to exist until
1066 * we are finished there as the hook holds a ref on the node.
1067 * We run this same code again on the peer hook, but that time it is already
1068 * attached to the 'dead' hook.
1070 * This routine is called at all stages of hook creation
1071 * on error detection and must be able to handle any such stage.
1074 ng_destroy_hook(hook_p hook)
1079 if (hook == &ng_deadhook) { /* better safe than sorry */
1080 printf("ng_destroy_hook called on deadhook\n");
1085 * Protect divorce process with mutex, to avoid races on
1086 * simultaneous disconnect.
1088 mtx_lock(&ng_topo_mtx);
1090 hook->hk_flags |= HK_INVALID;
1092 peer = NG_HOOK_PEER(hook);
1093 node = NG_HOOK_NODE(hook);
1095 if (peer && (peer != &ng_deadhook)) {
1097 * Set the peer to point to ng_deadhook
1098 * from this moment on we are effectively independent it.
1099 * send it an rmhook message of it's own.
1101 peer->hk_peer = &ng_deadhook; /* They no longer know us */
1102 hook->hk_peer = &ng_deadhook; /* Nor us, them */
1103 if (NG_HOOK_NODE(peer) == &ng_deadnode) {
1105 * If it's already divorced from a node,
1108 mtx_unlock(&ng_topo_mtx);
1110 mtx_unlock(&ng_topo_mtx);
1111 ng_rmhook_self(peer); /* Send it a surprise */
1113 NG_HOOK_UNREF(peer); /* account for peer link */
1114 NG_HOOK_UNREF(hook); /* account for peer link */
1116 mtx_unlock(&ng_topo_mtx);
1118 mtx_assert(&ng_topo_mtx, MA_NOTOWNED);
1121 * Remove the hook from the node's list to avoid possible recursion
1122 * in case the disconnection results in node shutdown.
1124 if (node == &ng_deadnode) { /* happens if called from ng_con_nodes() */
1127 LIST_REMOVE(hook, hk_hooks);
1128 node->nd_numhooks--;
1129 if (node->nd_type->disconnect) {
1131 * The type handler may elect to destroy the node so don't
1132 * trust its existence after this point. (except
1133 * that we still hold a reference on it. (which we
1134 * inherrited from the hook we are destroying)
1136 (*node->nd_type->disconnect) (hook);
1140 * Note that because we will point to ng_deadnode, the original node
1141 * is not decremented automatically so we do that manually.
1143 _NG_HOOK_NODE(hook) = &ng_deadnode;
1144 NG_NODE_UNREF(node); /* We no longer point to it so adjust count */
1145 NG_HOOK_UNREF(hook); /* Account for linkage (in list) to node */
1149 * Take two hooks on a node and merge the connection so that the given node
1150 * is effectively bypassed.
1153 ng_bypass(hook_p hook1, hook_p hook2)
1155 if (hook1->hk_node != hook2->hk_node) {
1159 hook1->hk_peer->hk_peer = hook2->hk_peer;
1160 hook2->hk_peer->hk_peer = hook1->hk_peer;
1162 hook1->hk_peer = &ng_deadhook;
1163 hook2->hk_peer = &ng_deadhook;
1165 NG_HOOK_UNREF(hook1);
1166 NG_HOOK_UNREF(hook2);
1168 /* XXX If we ever cache methods on hooks update them as well */
1169 ng_destroy_hook(hook1);
1170 ng_destroy_hook(hook2);
1175 * Install a new netgraph type
1178 ng_newtype(struct ng_type *tp)
1180 const size_t namelen = strlen(tp->name);
1182 /* Check version and type name fields */
1183 if ((tp->version != NG_ABI_VERSION)
1185 || (namelen >= NG_TYPESIZ)) {
1187 if (tp->version != NG_ABI_VERSION) {
1188 printf("Netgraph: Node type rejected. ABI mismatch. Suggest recompile\n");
1193 /* Check for name collision */
1194 if (ng_findtype(tp->name) != NULL) {
1200 /* Link in new type */
1201 mtx_lock(&ng_typelist_mtx);
1202 LIST_INSERT_HEAD(&ng_typelist, tp, types);
1203 tp->refs = 1; /* first ref is linked list */
1204 mtx_unlock(&ng_typelist_mtx);
1209 * unlink a netgraph type
1210 * If no examples exist
1213 ng_rmtype(struct ng_type *tp)
1215 /* Check for name collision */
1216 if (tp->refs != 1) {
1222 mtx_lock(&ng_typelist_mtx);
1223 LIST_REMOVE(tp, types);
1224 mtx_unlock(&ng_typelist_mtx);
1229 * Look for a type of the name given
1232 ng_findtype(const char *typename)
1234 struct ng_type *type;
1236 mtx_lock(&ng_typelist_mtx);
1237 LIST_FOREACH(type, &ng_typelist, types) {
1238 if (strcmp(type->name, typename) == 0)
1241 mtx_unlock(&ng_typelist_mtx);
1245 /************************************************************************
1247 ************************************************************************/
1249 * Connect two nodes using the specified hooks, using queued functions.
1252 ng_con_part3(node_p node, item_p item, hook_p hook)
1257 * When we run, we know that the node 'node' is locked for us.
1258 * Our caller has a reference on the hook.
1259 * Our caller has a reference on the node.
1260 * (In this case our caller is ng_apply_item() ).
1261 * The peer hook has a reference on the hook.
1262 * We are all set up except for the final call to the node, and
1263 * the clearing of the INVALID flag.
1265 if (NG_HOOK_NODE(hook) == &ng_deadnode) {
1267 * The node must have been freed again since we last visited
1268 * here. ng_destry_hook() has this effect but nothing else does.
1269 * We should just release our references and
1270 * free anything we can think of.
1271 * Since we know it's been destroyed, and it's our caller
1272 * that holds the references, just return.
1276 if (hook->hk_node->nd_type->connect) {
1277 if ((error = (*hook->hk_node->nd_type->connect) (hook))) {
1278 ng_destroy_hook(hook); /* also zaps peer */
1279 printf("failed in ng_con_part3()\n");
1284 * XXX this is wrong for SMP. Possibly we need
1285 * to separate out 'create' and 'invalid' flags.
1286 * should only set flags on hooks we have locked under our node.
1288 hook->hk_flags &= ~HK_INVALID;
1295 ng_con_part2(node_p node, item_p item, hook_p hook)
1301 * When we run, we know that the node 'node' is locked for us.
1302 * Our caller has a reference on the hook.
1303 * Our caller has a reference on the node.
1304 * (In this case our caller is ng_apply_item() ).
1305 * The peer hook has a reference on the hook.
1306 * our node pointer points to the 'dead' node.
1307 * First check the hook name is unique.
1308 * Should not happen because we checked before queueing this.
1310 if (ng_findhook(node, NG_HOOK_NAME(hook)) != NULL) {
1312 ng_destroy_hook(hook); /* should destroy peer too */
1313 printf("failed in ng_con_part2()\n");
1317 * Check if the node type code has something to say about it
1318 * If it fails, the unref of the hook will also unref the attached node,
1319 * however since that node is 'ng_deadnode' this will do nothing.
1320 * The peer hook will also be destroyed.
1322 if (node->nd_type->newhook != NULL) {
1323 if ((error = (*node->nd_type->newhook)(node, hook,
1325 ng_destroy_hook(hook); /* should destroy peer too */
1326 printf("failed in ng_con_part2()\n");
1332 * The 'type' agrees so far, so go ahead and link it in.
1333 * We'll ask again later when we actually connect the hooks.
1335 hook->hk_node = node; /* just overwrite ng_deadnode */
1336 NG_NODE_REF(node); /* each hook counts as a reference */
1337 LIST_INSERT_HEAD(&node->nd_hooks, hook, hk_hooks);
1338 node->nd_numhooks++;
1339 NG_HOOK_REF(hook); /* one for the node */
1342 * We now have a symmetrical situation, where both hooks have been
1343 * linked to their nodes, the newhook methods have been called
1344 * And the references are all correct. The hooks are still marked
1345 * as invalid, as we have not called the 'connect' methods
1347 * We can call the local one immediately as we have the
1348 * node locked, but we need to queue the remote one.
1350 if (hook->hk_node->nd_type->connect) {
1351 if ((error = (*hook->hk_node->nd_type->connect) (hook))) {
1352 ng_destroy_hook(hook); /* also zaps peer */
1353 printf("failed in ng_con_part2(A)\n");
1359 * Acquire topo mutex to avoid race with ng_destroy_hook().
1361 mtx_lock(&ng_topo_mtx);
1362 peer = hook->hk_peer;
1363 if (peer == &ng_deadhook) {
1364 mtx_unlock(&ng_topo_mtx);
1365 printf("failed in ng_con_part2(B)\n");
1366 ng_destroy_hook(hook);
1369 mtx_unlock(&ng_topo_mtx);
1371 if ((error = ng_send_fn2(peer->hk_node, peer, item, &ng_con_part3,
1372 NULL, 0, NG_REUSE_ITEM))) {
1373 printf("failed in ng_con_part2(C)\n");
1374 ng_destroy_hook(hook); /* also zaps peer */
1375 return (error); /* item was consumed. */
1377 hook->hk_flags &= ~HK_INVALID; /* need both to be able to work */
1378 return (0); /* item was consumed. */
1385 * Connect this node with another node. We assume that this node is
1386 * currently locked, as we are only called from an NGM_CONNECT message.
1389 ng_con_nodes(item_p item, node_p node, const char *name,
1390 node_p node2, const char *name2)
1396 if (ng_findhook(node2, name2) != NULL) {
1399 if ((error = ng_add_hook(node, name, &hook))) /* gives us a ref */
1401 /* Allocate the other hook and link it up */
1402 NG_ALLOC_HOOK(hook2);
1403 if (hook2 == NULL) {
1405 ng_destroy_hook(hook); /* XXX check ref counts so far */
1406 NG_HOOK_UNREF(hook); /* including our ref */
1409 hook2->hk_refs = 1; /* start with a reference for us. */
1410 hook2->hk_flags = HK_INVALID;
1411 hook2->hk_peer = hook; /* Link the two together */
1412 hook->hk_peer = hook2;
1413 NG_HOOK_REF(hook); /* Add a ref for the peer to each*/
1415 hook2->hk_node = &ng_deadnode;
1416 strlcpy(NG_HOOK_NAME(hook2), name2, NG_HOOKSIZ);
1419 * Queue the function above.
1420 * Procesing continues in that function in the lock context of
1423 if ((error = ng_send_fn2(node2, hook2, item, &ng_con_part2, NULL, 0,
1425 printf("failed in ng_con_nodes(): %d\n", error);
1426 ng_destroy_hook(hook); /* also zaps peer */
1429 NG_HOOK_UNREF(hook); /* Let each hook go if it wants to */
1430 NG_HOOK_UNREF(hook2);
1435 * Make a peer and connect.
1436 * We assume that the local node is locked.
1437 * The new node probably doesn't need a lock until
1438 * it has a hook, because it cannot really have any work until then,
1439 * but we should think about it a bit more.
1441 * The problem may come if the other node also fires up
1442 * some hardware or a timer or some other source of activation,
1443 * also it may already get a command msg via it's ID.
1445 * We could use the same method as ng_con_nodes() but we'd have
1446 * to add ability to remove the node when failing. (Not hard, just
1447 * make arg1 point to the node to remove).
1448 * Unless of course we just ignore failure to connect and leave
1449 * an unconnected node?
1452 ng_mkpeer(node_p node, const char *name, const char *name2, char *type)
1455 hook_p hook1, hook2;
1458 if ((error = ng_make_node(type, &node2))) {
1462 if ((error = ng_add_hook(node, name, &hook1))) { /* gives us a ref */
1463 ng_rmnode(node2, NULL, NULL, 0);
1467 if ((error = ng_add_hook(node2, name2, &hook2))) {
1468 ng_rmnode(node2, NULL, NULL, 0);
1469 ng_destroy_hook(hook1);
1470 NG_HOOK_UNREF(hook1);
1475 * Actually link the two hooks together.
1477 hook1->hk_peer = hook2;
1478 hook2->hk_peer = hook1;
1480 /* Each hook is referenced by the other */
1484 /* Give each node the opportunity to veto the pending connection */
1485 if (hook1->hk_node->nd_type->connect) {
1486 error = (*hook1->hk_node->nd_type->connect) (hook1);
1489 if ((error == 0) && hook2->hk_node->nd_type->connect) {
1490 error = (*hook2->hk_node->nd_type->connect) (hook2);
1495 * drop the references we were holding on the two hooks.
1498 ng_destroy_hook(hook2); /* also zaps hook1 */
1499 ng_rmnode(node2, NULL, NULL, 0);
1501 /* As a last act, allow the hooks to be used */
1502 hook1->hk_flags &= ~HK_INVALID;
1503 hook2->hk_flags &= ~HK_INVALID;
1505 NG_HOOK_UNREF(hook1);
1506 NG_HOOK_UNREF(hook2);
1510 /************************************************************************
1511 Utility routines to send self messages
1512 ************************************************************************/
1514 /* Shut this node down as soon as everyone is clear of it */
1515 /* Should add arg "immediately" to jump the queue */
1517 ng_rmnode_self(node_p node)
1521 if (node == &ng_deadnode)
1523 node->nd_flags |= NGF_INVALID;
1524 if (node->nd_flags & NGF_CLOSING)
1527 error = ng_send_fn(node, NULL, &ng_rmnode, NULL, 0);
1532 ng_rmhook_part2(node_p node, hook_p hook, void *arg1, int arg2)
1534 ng_destroy_hook(hook);
1539 ng_rmhook_self(hook_p hook)
1542 node_p node = NG_HOOK_NODE(hook);
1544 if (node == &ng_deadnode)
1547 error = ng_send_fn(node, hook, &ng_rmhook_part2, NULL, 0);
1551 /***********************************************************************
1552 * Parse and verify a string of the form: <NODE:><PATH>
1554 * Such a string can refer to a specific node or a specific hook
1555 * on a specific node, depending on how you look at it. In the
1556 * latter case, the PATH component must not end in a dot.
1558 * Both <NODE:> and <PATH> are optional. The <PATH> is a string
1559 * of hook names separated by dots. This breaks out the original
1560 * string, setting *nodep to "NODE" (or NULL if none) and *pathp
1561 * to "PATH" (or NULL if degenerate). Also, *hookp will point to
1562 * the final hook component of <PATH>, if any, otherwise NULL.
1564 * This returns -1 if the path is malformed. The char ** are optional.
1565 ***********************************************************************/
1567 ng_path_parse(char *addr, char **nodep, char **pathp, char **hookp)
1569 char *node, *path, *hook;
1573 * Extract absolute NODE, if any
1575 for (path = addr; *path && *path != ':'; path++);
1577 node = addr; /* Here's the NODE */
1578 *path++ = '\0'; /* Here's the PATH */
1580 /* Node name must not be empty */
1584 /* A name of "." is OK; otherwise '.' not allowed */
1585 if (strcmp(node, ".") != 0) {
1586 for (k = 0; node[k]; k++)
1591 node = NULL; /* No absolute NODE */
1592 path = addr; /* Here's the PATH */
1595 /* Snoop for illegal characters in PATH */
1596 for (k = 0; path[k]; k++)
1600 /* Check for no repeated dots in PATH */
1601 for (k = 0; path[k]; k++)
1602 if (path[k] == '.' && path[k + 1] == '.')
1605 /* Remove extra (degenerate) dots from beginning or end of PATH */
1608 if (*path && path[strlen(path) - 1] == '.')
1609 path[strlen(path) - 1] = 0;
1611 /* If PATH has a dot, then we're not talking about a hook */
1613 for (hook = path, k = 0; path[k]; k++)
1614 if (path[k] == '.') {
1632 * Given a path, which may be absolute or relative, and a starting node,
1633 * return the destination node.
1636 ng_path2noderef(node_p here, const char *address,
1637 node_p *destp, hook_p *lasthook)
1639 char fullpath[NG_PATHSIZ];
1640 char *nodename, *path, pbuf[2];
1641 node_p node, oldnode;
1646 if (destp == NULL) {
1652 /* Make a writable copy of address for ng_path_parse() */
1653 strncpy(fullpath, address, sizeof(fullpath) - 1);
1654 fullpath[sizeof(fullpath) - 1] = '\0';
1656 /* Parse out node and sequence of hooks */
1657 if (ng_path_parse(fullpath, &nodename, &path, NULL) < 0) {
1662 pbuf[0] = '.'; /* Needs to be writable */
1668 * For an absolute address, jump to the starting node.
1669 * Note that this holds a reference on the node for us.
1670 * Don't forget to drop the reference if we don't need it.
1673 node = ng_name2noderef(here, nodename);
1688 * Now follow the sequence of hooks
1690 * We actually cannot guarantee that the sequence
1691 * is not being demolished as we crawl along it
1692 * without extra-ordinary locking etc.
1693 * So this is a bit dodgy to say the least.
1694 * We can probably hold up some things by holding
1695 * the nodelist mutex for the time of this
1696 * crawl if we wanted.. At least that way we wouldn't have to
1697 * worry about the nodes disappearing, but the hooks would still
1700 for (cp = path; node != NULL && *cp != '\0'; ) {
1704 * Break out the next path segment. Replace the dot we just
1705 * found with a NUL; "cp" points to the next segment (or the
1708 for (segment = cp; *cp != '\0'; cp++) {
1716 if (*segment == '\0')
1719 /* We have a segment, so look for a hook by that name */
1720 hook = ng_findhook(node, segment);
1722 /* Can't get there from here... */
1724 || NG_HOOK_PEER(hook) == NULL
1725 || NG_HOOK_NOT_VALID(hook)
1726 || NG_HOOK_NOT_VALID(NG_HOOK_PEER(hook))) {
1728 NG_NODE_UNREF(node);
1730 printf("hooknotvalid %s %s %d %d %d %d ",
1734 NG_HOOK_PEER(hook) == NULL,
1735 NG_HOOK_NOT_VALID(hook),
1736 NG_HOOK_NOT_VALID(NG_HOOK_PEER(hook)));
1742 * Hop on over to the next node
1744 * Big race conditions here as hooks and nodes go away
1745 * *** Idea.. store an ng_ID_t in each hook and use that
1746 * instead of the direct hook in this crawl?
1749 if ((node = NG_PEER_NODE(hook)))
1750 NG_NODE_REF(node); /* XXX RACE */
1751 NG_NODE_UNREF(oldnode); /* XXX another race */
1752 if (NG_NODE_NOT_VALID(node)) {
1753 NG_NODE_UNREF(node); /* XXX more races */
1758 /* If node somehow missing, fail here (probably this is not needed) */
1766 if (lasthook != NULL)
1767 *lasthook = (hook ? NG_HOOK_PEER(hook) : NULL);
1771 /***************************************************************\
1772 * Input queue handling.
1773 * All activities are submitted to the node via the input queue
1774 * which implements a multiple-reader/single-writer gate.
1775 * Items which cannot be handled immediately are queued.
1777 * read-write queue locking inline functions *
1778 \***************************************************************/
1780 static __inline item_p ng_dequeue(struct ng_queue * ngq, int *rw);
1781 static __inline item_p ng_acquire_read(struct ng_queue * ngq,
1783 static __inline item_p ng_acquire_write(struct ng_queue * ngq,
1785 static __inline void ng_leave_read(struct ng_queue * ngq);
1786 static __inline void ng_leave_write(struct ng_queue * ngq);
1787 static __inline void ng_queue_rw(struct ng_queue * ngq,
1788 item_p item, int rw);
1791 * Definition of the bits fields in the ng_queue flag word.
1792 * Defined here rather than in netgraph.h because no-one should fiddle
1795 * The ordering here may be important! don't shuffle these.
1798 Safety Barrier--------+ (adjustable to suit taste) (not used yet)
1801 +-------+-------+-------+-------+-------+-------+-------+-------+
1802 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
1803 | |A|c|t|i|v|e| |R|e|a|d|e|r| |C|o|u|n|t| | | | | | | | | |P|A|
1804 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |O|W|
1805 +-------+-------+-------+-------+-------+-------+-------+-------+
1806 \___________________________ ____________________________/ | |
1808 [active reader count] | |
1810 Operation Pending -------------------------------+ |
1812 Active Writer ---------------------------------------+
1816 #define WRITER_ACTIVE 0x00000001
1817 #define OP_PENDING 0x00000002
1818 #define READER_INCREMENT 0x00000004
1819 #define READER_MASK 0xfffffffc /* Not valid if WRITER_ACTIVE is set */
1820 #define SAFETY_BARRIER 0x00100000 /* 128K items queued should be enough */
1822 /* Defines of more elaborate states on the queue */
1823 /* Mask of bits a new read cares about */
1824 #define NGQ_RMASK (WRITER_ACTIVE|OP_PENDING)
1826 /* Mask of bits a new write cares about */
1827 #define NGQ_WMASK (NGQ_RMASK|READER_MASK)
1829 /* Test to decide if there is something on the queue. */
1830 #define QUEUE_ACTIVE(QP) ((QP)->q_flags & OP_PENDING)
1832 /* How to decide what the next queued item is. */
1833 #define HEAD_IS_READER(QP) NGI_QUEUED_READER((QP)->queue)
1834 #define HEAD_IS_WRITER(QP) NGI_QUEUED_WRITER((QP)->queue) /* notused */
1836 /* Read the status to decide if the next item on the queue can now run. */
1837 #define QUEUED_READER_CAN_PROCEED(QP) \
1838 (((QP)->q_flags & (NGQ_RMASK & ~OP_PENDING)) == 0)
1839 #define QUEUED_WRITER_CAN_PROCEED(QP) \
1840 (((QP)->q_flags & (NGQ_WMASK & ~OP_PENDING)) == 0)
1842 /* Is there a chance of getting ANY work off the queue? */
1843 #define NEXT_QUEUED_ITEM_CAN_PROCEED(QP) \
1844 (QUEUE_ACTIVE(QP) && \
1845 ((HEAD_IS_READER(QP)) ? QUEUED_READER_CAN_PROCEED(QP) : \
1846 QUEUED_WRITER_CAN_PROCEED(QP)))
1853 * Taking into account the current state of the queue and node, possibly take
1854 * the next entry off the queue and return it. Return NULL if there was
1855 * nothing we could return, either because there really was nothing there, or
1856 * because the node was in a state where it cannot yet process the next item
1859 * This MUST MUST MUST be called with the mutex held.
1861 static __inline item_p
1862 ng_dequeue(struct ng_queue *ngq, int *rw)
1867 mtx_assert(&ngq->q_mtx, MA_OWNED);
1869 * If there is nothing queued, then just return.
1870 * No point in continuing.
1871 * XXXGL: assert this?
1873 if (!QUEUE_ACTIVE(ngq)) {
1874 CTR4(KTR_NET, "%20s: node [%x] (%p) queue empty; "
1875 "queue flags 0x%lx", __func__,
1876 ngq->q_node->nd_ID, ngq->q_node, ngq->q_flags);
1881 * From here, we can assume there is a head item.
1882 * We need to find out what it is and if it can be dequeued, given
1883 * the current state of the node.
1885 if (HEAD_IS_READER(ngq)) {
1886 if (!QUEUED_READER_CAN_PROCEED(ngq)) {
1888 * It's a reader but we can't use it.
1889 * We are stalled so make sure we don't
1890 * get called again until something changes.
1892 ng_worklist_remove(ngq->q_node);
1893 CTR4(KTR_NET, "%20s: node [%x] (%p) queued reader "
1894 "can't proceed; queue flags 0x%lx", __func__,
1895 ngq->q_node->nd_ID, ngq->q_node, ngq->q_flags);
1899 * Head of queue is a reader and we have no write active.
1900 * We don't care how many readers are already active.
1901 * Add the correct increment for the reader count.
1903 add_arg = READER_INCREMENT;
1905 } else if (QUEUED_WRITER_CAN_PROCEED(ngq)) {
1907 * There is a pending write, no readers and no active writer.
1908 * This means we can go ahead with the pending writer. Note
1909 * the fact that we now have a writer, ready for when we take
1912 * We don't need to worry about a possible collision with the
1915 * The fasttrack thread may take a long time to discover that we
1916 * are running so we would have an inconsistent state in the
1917 * flags for a while. Since we ignore the reader count
1918 * entirely when the WRITER_ACTIVE flag is set, this should
1919 * not matter (in fact it is defined that way). If it tests
1920 * the flag before this operation, the OP_PENDING flag
1921 * will make it fail, and if it tests it later, the
1922 * WRITER_ACTIVE flag will do the same. If it is SO slow that
1923 * we have actually completed the operation, and neither flag
1924 * is set by the time that it tests the flags, then it is
1925 * actually ok for it to continue. If it completes and we've
1926 * finished and the read pending is set it still fails.
1928 * So we can just ignore it, as long as we can ensure that the
1929 * transition from WRITE_PENDING state to the WRITER_ACTIVE
1932 * After failing, first it will be held back by the mutex, then
1933 * when it can proceed, it will queue its request, then it
1934 * would arrive at this function. Usually it will have to
1935 * leave empty handed because the ACTIVE WRITER bit will be
1938 * Adjust the flags for the new active writer.
1940 add_arg = WRITER_ACTIVE;
1943 * We want to write "active writer, no readers " Now go make
1944 * it true. In fact there may be a number in the readers
1945 * count but we know it is not true and will be fixed soon.
1946 * We will fix the flags for the next pending entry in a
1951 * We can't dequeue anything.. return and say so. Probably we
1952 * have a write pending and the readers count is non zero. If
1953 * we got here because a reader hit us just at the wrong
1954 * moment with the fasttrack code, and put us in a strange
1955 * state, then it will be coming through in just a moment,
1956 * (just as soon as we release the mutex) and keep things
1958 * Make sure we remove ourselves from the work queue. It
1959 * would be a waste of effort to do all this again.
1961 ng_worklist_remove(ngq->q_node);
1962 CTR4(KTR_NET, "%20s: node [%x] (%p) can't dequeue anything; "
1963 "queue flags 0x%lx", __func__,
1964 ngq->q_node->nd_ID, ngq->q_node, ngq->q_flags);
1969 * Now we dequeue the request (whatever it may be) and correct the
1970 * pending flags and the next and last pointers.
1973 ngq->queue = item->el_next;
1974 CTR6(KTR_NET, "%20s: node [%x] (%p) dequeued item %p with flags 0x%lx; "
1975 "queue flags 0x%lx", __func__,
1976 ngq->q_node->nd_ID,ngq->q_node, item, item->el_flags, ngq->q_flags);
1977 if (ngq->last == &(item->el_next)) {
1979 * that was the last entry in the queue so set the 'last
1980 * pointer up correctly and make sure the pending flag is
1983 add_arg += -OP_PENDING;
1984 ngq->last = &(ngq->queue);
1986 * Whatever flag was set will be cleared and
1987 * the new acive field will be set by the add as well,
1988 * so we don't need to change add_arg.
1989 * But we know we don't need to be on the work list.
1991 atomic_add_long(&ngq->q_flags, add_arg);
1992 ng_worklist_remove(ngq->q_node);
1995 * Since there is still something on the queue
1996 * we don't need to change the PENDING flag.
1998 atomic_add_long(&ngq->q_flags, add_arg);
2000 CTR6(KTR_NET, "%20s: node [%x] (%p) returning item %p as %s; "
2001 "queue flags 0x%lx", __func__,
2002 ngq->q_node->nd_ID, ngq->q_node, item, *rw ? "WRITER" : "READER" ,
2008 * Queue a packet to be picked up by someone else.
2009 * We really don't care who, but we can't or don't want to hang around
2010 * to process it ourselves. We are probably an interrupt routine..
2011 * If the queue could be run, flag the netisr handler to start.
2013 static __inline void
2014 ng_queue_rw(struct ng_queue * ngq, item_p item, int rw)
2016 mtx_assert(&ngq->q_mtx, MA_OWNED);
2019 NGI_SET_WRITER(item);
2021 NGI_SET_READER(item);
2022 item->el_next = NULL; /* maybe not needed */
2024 CTR5(KTR_NET, "%20s: node [%x] (%p) queued item %p as %s", __func__,
2025 ngq->q_node->nd_ID, ngq->q_node, item, rw ? "WRITER" : "READER" );
2027 * If it was the first item in the queue then we need to
2028 * set the last pointer and the type flags.
2030 if (ngq->last == &(ngq->queue)) {
2031 atomic_add_long(&ngq->q_flags, OP_PENDING);
2032 CTR3(KTR_NET, "%20s: node [%x] (%p) set OP_PENDING", __func__,
2033 ngq->q_node->nd_ID, ngq->q_node);
2036 ngq->last = &(item->el_next);
2038 * We can take the worklist lock with the node locked
2039 * BUT NOT THE REVERSE!
2041 if (NEXT_QUEUED_ITEM_CAN_PROCEED(ngq))
2042 ng_setisr(ngq->q_node);
2047 * This function 'cheats' in that it first tries to 'grab' the use of the
2048 * node, without going through the mutex. We can do this becasue of the
2049 * semantics of the lock. The semantics include a clause that says that the
2050 * value of the readers count is invalid if the WRITER_ACTIVE flag is set. It
2051 * also says that the WRITER_ACTIVE flag cannot be set if the readers count
2052 * is not zero. Note that this talks about what is valid to SET the
2053 * WRITER_ACTIVE flag, because from the moment it is set, the value if the
2054 * reader count is immaterial, and not valid. The two 'pending' flags have a
2055 * similar effect, in that If they are orthogonal to the two active fields in
2056 * how they are set, but if either is set, the attempted 'grab' need to be
2057 * backed out because there is earlier work, and we maintain ordering in the
2058 * queue. The result of this is that the reader request can try obtain use of
2059 * the node with only a single atomic addition, and without any of the mutex
2060 * overhead. If this fails the operation degenerates to the same as for other
2064 static __inline item_p
2065 ng_acquire_read(struct ng_queue *ngq, item_p item)
2067 KASSERT(ngq != &ng_deadnode.nd_input_queue,
2068 ("%s: working on deadnode", __func__));
2070 /* ######### Hack alert ######### */
2071 atomic_add_long(&ngq->q_flags, READER_INCREMENT);
2072 if ((ngq->q_flags & NGQ_RMASK) == 0) {
2073 /* Successfully grabbed node */
2074 CTR4(KTR_NET, "%20s: node [%x] (%p) fast acquired item %p",
2075 __func__, ngq->q_node->nd_ID, ngq->q_node, item);
2078 /* undo the damage if we didn't succeed */
2079 atomic_subtract_long(&ngq->q_flags, READER_INCREMENT);
2081 /* ######### End Hack alert ######### */
2084 * Try again. Another processor (or interrupt for that matter) may
2085 * have removed the last queued item that was stopping us from
2086 * running, between the previous test, and the moment that we took
2087 * the mutex. (Or maybe a writer completed.)
2088 * Even if another fast-track reader hits during this period
2089 * we don't care as multiple readers is OK.
2091 if ((ngq->q_flags & NGQ_RMASK) == 0) {
2092 atomic_add_long(&ngq->q_flags, READER_INCREMENT);
2093 NG_QUEUE_UNLOCK(ngq);
2094 CTR4(KTR_NET, "%20s: node [%x] (%p) slow acquired item %p",
2095 __func__, ngq->q_node->nd_ID, ngq->q_node, item);
2100 * and queue the request for later.
2102 ng_queue_rw(ngq, item, NGQRW_R);
2103 NG_QUEUE_UNLOCK(ngq);
2108 static __inline item_p
2109 ng_acquire_write(struct ng_queue *ngq, item_p item)
2111 KASSERT(ngq != &ng_deadnode.nd_input_queue,
2112 ("%s: working on deadnode", __func__));
2117 * If there are no readers, no writer, and no pending packets, then
2118 * we can just go ahead. In all other situations we need to queue the
2121 if ((ngq->q_flags & NGQ_WMASK) == 0) {
2122 /* collision could happen *HERE* */
2123 atomic_add_long(&ngq->q_flags, WRITER_ACTIVE);
2124 NG_QUEUE_UNLOCK(ngq);
2125 if (ngq->q_flags & READER_MASK) {
2126 /* Collision with fast-track reader */
2127 atomic_subtract_long(&ngq->q_flags, WRITER_ACTIVE);
2130 CTR4(KTR_NET, "%20s: node [%x] (%p) acquired item %p",
2131 __func__, ngq->q_node->nd_ID, ngq->q_node, item);
2136 * and queue the request for later.
2138 ng_queue_rw(ngq, item, NGQRW_W);
2139 NG_QUEUE_UNLOCK(ngq);
2145 static __inline item_p
2146 ng_upgrade_write(struct ng_queue *ngq, item_p item)
2148 KASSERT(ngq != &ng_deadnode.nd_input_queue,
2149 ("%s: working on deadnode", __func__));
2151 NGI_SET_WRITER(item);
2153 mtx_lock_spin(&(ngq->q_mtx));
2156 * There will never be no readers as we are there ourselves.
2157 * Set the WRITER_ACTIVE flags ASAP to block out fast track readers.
2158 * The caller we are running from will call ng_leave_read()
2159 * soon, so we must account for that. We must leave again with the
2160 * READER lock. If we find other readers, then
2161 * queue the request for later. However "later" may be rignt now
2162 * if there are no readers. We don't really care if there are queued
2163 * items as we will bypass them anyhow.
2165 atomic_add_long(&ngq->q_flags, WRITER_ACTIVE - READER_INCREMENT);
2166 if (ngq->q_flags & (NGQ_WMASK & ~OP_PENDING) == WRITER_ACTIVE) {
2167 mtx_unlock_spin(&(ngq->q_mtx));
2169 /* It's just us, act on the item. */
2170 /* will NOT drop writer lock when done */
2171 ng_apply_item(node, item, 0);
2174 * Having acted on the item, atomically
2175 * down grade back to READER and finish up
2177 atomic_add_long(&ngq->q_flags,
2178 READER_INCREMENT - WRITER_ACTIVE);
2180 /* Our caller will call ng_leave_read() */
2184 * It's not just us active, so queue us AT THE HEAD.
2185 * "Why?" I hear you ask.
2186 * Put us at the head of the queue as we've already been
2187 * through it once. If there is nothing else waiting,
2188 * set the correct flags.
2190 if ((item->el_next = ngq->queue) == NULL) {
2192 * Set up the "last" pointer.
2193 * We are the only (and thus last) item
2195 ngq->last = &(item->el_next);
2197 /* We've gone from, 0 to 1 item in the queue */
2198 atomic_add_long(&ngq->q_flags, OP_PENDING);
2200 CTR3(KTR_NET, "%20s: node [%x] (%p) set OP_PENDING", __func__,
2201 ngq->q_node->nd_ID, ngq->q_node);
2204 CTR5(KTR_NET, "%20s: node [%x] (%p) requeued item %p as WRITER",
2205 __func__, ngq->q_node->nd_ID, ngq->q_node, item );
2207 /* Reverse what we did above. That downgrades us back to reader */
2208 atomic_add_long(&ngq->q_flags, READER_INCREMENT - WRITER_ACTIVE);
2209 if (NEXT_QUEUED_ITEM_CAN_PROCEED(ngq))
2210 ng_setisr(ngq->q_node);
2211 mtx_unlock_spin(&(ngq->q_mtx));
2218 static __inline void
2219 ng_leave_read(struct ng_queue *ngq)
2221 atomic_subtract_long(&ngq->q_flags, READER_INCREMENT);
2224 static __inline void
2225 ng_leave_write(struct ng_queue *ngq)
2227 atomic_subtract_long(&ngq->q_flags, WRITER_ACTIVE);
2231 ng_flush_input_queue(struct ng_queue * ngq)
2236 while (ngq->queue) {
2238 ngq->queue = item->el_next;
2239 if (ngq->last == &(item->el_next)) {
2240 ngq->last = &(ngq->queue);
2241 atomic_add_long(&ngq->q_flags, -OP_PENDING);
2243 NG_QUEUE_UNLOCK(ngq);
2245 /* If the item is supplying a callback, call it with an error */
2246 if (item->apply != NULL) {
2247 if (item->depth == 1)
2248 item->apply->error = ENOENT;
2249 if (refcount_release(&item->apply->refs)) {
2250 (*item->apply->apply)(item->apply->context,
2251 item->apply->error);
2258 * Take us off the work queue if we are there.
2259 * We definately have no work to be done.
2261 ng_worklist_remove(ngq->q_node);
2262 NG_QUEUE_UNLOCK(ngq);
2265 /***********************************************************************
2266 * Externally visible method for sending or queueing messages or data.
2267 ***********************************************************************/
2270 * The module code should have filled out the item correctly by this stage:
2272 * reference to destination node.
2273 * Reference to destination rcv hook if relevant.
2274 * apply pointer must be or NULL or reference valid struct ng_apply_info.
2279 * ID of original sender node. (return address)
2285 * The nodes have several routines and macros to help with this task:
2289 ng_snd_item(item_p item, int flags)
2294 struct ng_queue *ngq;
2297 /* We are sending item, so it must be present! */
2298 KASSERT(item != NULL, ("ng_snd_item: item is NULL"));
2300 #ifdef NETGRAPH_DEBUG
2301 _ngi_check(item, __FILE__, __LINE__);
2304 /* Item was sent once more, postpone apply() call. */
2306 refcount_acquire(&item->apply->refs);
2308 node = NGI_NODE(item);
2309 /* Node is never optional. */
2310 KASSERT(node != NULL, ("ng_snd_item: node is NULL"));
2312 hook = NGI_HOOK(item);
2313 /* Valid hook and mbuf are mandatory for data. */
2314 if ((item->el_flags & NGQF_TYPE) == NGQF_DATA) {
2315 KASSERT(hook != NULL, ("ng_snd_item: hook for data is NULL"));
2316 if (NGI_M(item) == NULL)
2318 CHECK_DATA_MBUF(NGI_M(item));
2322 * If the item or the node specifies single threading, force
2323 * writer semantics. Similarly, the node may say one hook always
2324 * produces writers. These are overrides.
2326 if (((item->el_flags & NGQF_RW) == NGQF_WRITER) ||
2327 (node->nd_flags & NGF_FORCE_WRITER) ||
2328 (hook && (hook->hk_flags & HK_FORCE_WRITER))) {
2335 * If sender or receiver requests queued delivery or stack usage
2336 * level is dangerous - enqueue message.
2338 if ((flags & NG_QUEUE) || (hook && (hook->hk_flags & HK_QUEUE))) {
2342 #ifdef GET_STACK_USAGE
2344 * Most of netgraph nodes have small stack consumption and
2345 * for them 25% of free stack space is more than enough.
2346 * Nodes/hooks with higher stack usage should be marked as
2347 * HI_STACK. For them 50% of stack will be guaranteed then.
2348 * XXX: Values 25% and 50% are completely empirical.
2351 GET_STACK_USAGE(st, su);
2353 if ((sl * 4 < st) ||
2354 ((sl * 2 < st) && ((node->nd_flags & NGF_HI_STACK) ||
2355 (hook && (hook->hk_flags & HK_HI_STACK))))) {
2361 ngq = &node->nd_input_queue;
2363 /* Put it on the queue for that node*/
2364 #ifdef NETGRAPH_DEBUG
2365 _ngi_check(item, __FILE__, __LINE__);
2369 ng_queue_rw(ngq, item, rw);
2370 NG_QUEUE_UNLOCK(ngq);
2372 return ((flags & NG_PROGRESS) ? EINPROGRESS : 0);
2376 * We already decided how we will be queueud or treated.
2377 * Try get the appropriate operating permission.
2380 item = ng_acquire_read(ngq, item);
2382 item = ng_acquire_write(ngq, item);
2385 /* Item was queued while trying to get permission. */
2387 return ((flags & NG_PROGRESS) ? EINPROGRESS : 0);
2389 #ifdef NETGRAPH_DEBUG
2390 _ngi_check(item, __FILE__, __LINE__);
2393 NGI_GET_NODE(item, node); /* zaps stored node */
2396 error = ng_apply_item(node, item, rw); /* drops r/w lock when done */
2399 * If the node goes away when we remove the reference,
2400 * whatever we just did caused it.. whatever we do, DO NOT
2401 * access the node again!
2403 if (NG_NODE_UNREF(node) == 0)
2407 if (NEXT_QUEUED_ITEM_CAN_PROCEED(ngq))
2408 ng_setisr(ngq->q_node);
2409 NG_QUEUE_UNLOCK(ngq);
2414 /* If was not sent, apply callback here. */
2415 if (item->apply != NULL) {
2416 if (item->depth == 0 && error != 0)
2417 item->apply->error = error;
2418 if (refcount_release(&item->apply->refs)) {
2419 (*item->apply->apply)(item->apply->context,
2420 item->apply->error);
2429 * We have an item that was possibly queued somewhere.
2430 * It should contain all the information needed
2431 * to run it on the appropriate node/hook.
2432 * If there is apply pointer and we own the last reference, call apply().
2435 ng_apply_item(node_p node, item_p item, int rw)
2438 ng_rcvdata_t *rcvdata;
2439 ng_rcvmsg_t *rcvmsg;
2440 struct ng_apply_info *apply;
2441 int error = 0, depth;
2443 /* Node and item are never optional. */
2444 KASSERT(node != NULL, ("ng_apply_item: node is NULL"));
2445 KASSERT(item != NULL, ("ng_apply_item: item is NULL"));
2447 NGI_GET_HOOK(item, hook); /* clears stored hook */
2448 #ifdef NETGRAPH_DEBUG
2449 _ngi_check(item, __FILE__, __LINE__);
2452 apply = item->apply;
2453 depth = item->depth;
2455 switch (item->el_flags & NGQF_TYPE) {
2458 * Check things are still ok as when we were queued.
2460 KASSERT(hook != NULL, ("ng_apply_item: hook for data is NULL"));
2461 if (NG_HOOK_NOT_VALID(hook) ||
2462 NG_NODE_NOT_VALID(node)) {
2468 * If no receive method, just silently drop it.
2469 * Give preference to the hook over-ride method
2471 if ((!(rcvdata = hook->hk_rcvdata))
2472 && (!(rcvdata = NG_HOOK_NODE(hook)->nd_type->rcvdata))) {
2477 error = (*rcvdata)(hook, item);
2480 if (hook && NG_HOOK_NOT_VALID(hook)) {
2482 * The hook has been zapped then we can't use it.
2483 * Immediately drop its reference.
2484 * The message may not need it.
2486 NG_HOOK_UNREF(hook);
2490 * Similarly, if the node is a zombie there is
2491 * nothing we can do with it, drop everything.
2493 if (NG_NODE_NOT_VALID(node)) {
2500 * Call the appropriate message handler for the object.
2501 * It is up to the message handler to free the message.
2502 * If it's a generic message, handle it generically,
2503 * otherwise call the type's message handler (if it exists).
2504 * XXX (race). Remember that a queued message may
2505 * reference a node or hook that has just been
2506 * invalidated. It will exist as the queue code
2507 * is holding a reference, but..
2509 if ((NGI_MSG(item)->header.typecookie == NGM_GENERIC_COOKIE) &&
2510 ((NGI_MSG(item)->header.flags & NGF_RESP) == 0)) {
2511 error = ng_generic_msg(node, item, hook);
2514 if (((!hook) || (!(rcvmsg = hook->hk_rcvmsg))) &&
2515 (!(rcvmsg = node->nd_type->rcvmsg))) {
2521 error = (*rcvmsg)(node, item, hook);
2526 * We have to implicitly trust the hook,
2527 * as some of these are used for system purposes
2528 * where the hook is invalid. In the case of
2529 * the shutdown message we allow it to hit
2530 * even if the node is invalid.
2532 if ((NG_NODE_NOT_VALID(node))
2533 && (NGI_FN(item) != &ng_rmnode)) {
2539 if ((item->el_flags & NGQF_TYPE) == NGQF_FN) {
2540 (*NGI_FN(item))(node, hook, NGI_ARG1(item),
2543 } else /* it is NGQF_FN2 */
2544 error = (*NGI_FN2(item))(node, item, hook);
2548 * We held references on some of the resources
2549 * that we took from the item. Now that we have
2550 * finished doing everything, drop those references.
2553 NG_HOOK_UNREF(hook);
2556 ng_leave_read(&node->nd_input_queue);
2558 ng_leave_write(&node->nd_input_queue);
2560 /* Apply callback. */
2561 if (apply != NULL) {
2562 if (depth == 1 && error != 0)
2563 apply->error = error;
2564 if (refcount_release(&apply->refs))
2565 (*apply->apply)(apply->context, apply->error);
2571 /***********************************************************************
2572 * Implement the 'generic' control messages
2573 ***********************************************************************/
2575 ng_generic_msg(node_p here, item_p item, hook_p lasthook)
2578 struct ng_mesg *msg;
2579 struct ng_mesg *resp = NULL;
2581 NGI_GET_MSG(item, msg);
2582 if (msg->header.typecookie != NGM_GENERIC_COOKIE) {
2587 switch (msg->header.cmd) {
2589 ng_rmnode(here, NULL, NULL, 0);
2593 struct ngm_mkpeer *const mkp = (struct ngm_mkpeer *) msg->data;
2595 if (msg->header.arglen != sizeof(*mkp)) {
2600 mkp->type[sizeof(mkp->type) - 1] = '\0';
2601 mkp->ourhook[sizeof(mkp->ourhook) - 1] = '\0';
2602 mkp->peerhook[sizeof(mkp->peerhook) - 1] = '\0';
2603 error = ng_mkpeer(here, mkp->ourhook, mkp->peerhook, mkp->type);
2608 struct ngm_connect *const con =
2609 (struct ngm_connect *) msg->data;
2612 if (msg->header.arglen != sizeof(*con)) {
2617 con->path[sizeof(con->path) - 1] = '\0';
2618 con->ourhook[sizeof(con->ourhook) - 1] = '\0';
2619 con->peerhook[sizeof(con->peerhook) - 1] = '\0';
2620 /* Don't forget we get a reference.. */
2621 error = ng_path2noderef(here, con->path, &node2, NULL);
2624 error = ng_con_nodes(item, here, con->ourhook,
2625 node2, con->peerhook);
2626 NG_NODE_UNREF(node2);
2631 struct ngm_name *const nam = (struct ngm_name *) msg->data;
2633 if (msg->header.arglen != sizeof(*nam)) {
2638 nam->name[sizeof(nam->name) - 1] = '\0';
2639 error = ng_name_node(here, nam->name);
2644 struct ngm_rmhook *const rmh = (struct ngm_rmhook *) msg->data;
2647 if (msg->header.arglen != sizeof(*rmh)) {
2652 rmh->ourhook[sizeof(rmh->ourhook) - 1] = '\0';
2653 if ((hook = ng_findhook(here, rmh->ourhook)) != NULL)
2654 ng_destroy_hook(hook);
2659 struct nodeinfo *ni;
2661 NG_MKRESPONSE(resp, msg, sizeof(*ni), M_NOWAIT);
2667 /* Fill in node info */
2668 ni = (struct nodeinfo *) resp->data;
2669 if (NG_NODE_HAS_NAME(here))
2670 strcpy(ni->name, NG_NODE_NAME(here));
2671 strcpy(ni->type, here->nd_type->name);
2672 ni->id = ng_node2ID(here);
2673 ni->hooks = here->nd_numhooks;
2678 const int nhooks = here->nd_numhooks;
2679 struct hooklist *hl;
2680 struct nodeinfo *ni;
2683 /* Get response struct */
2684 NG_MKRESPONSE(resp, msg, sizeof(*hl)
2685 + (nhooks * sizeof(struct linkinfo)), M_NOWAIT);
2690 hl = (struct hooklist *) resp->data;
2693 /* Fill in node info */
2694 if (NG_NODE_HAS_NAME(here))
2695 strcpy(ni->name, NG_NODE_NAME(here));
2696 strcpy(ni->type, here->nd_type->name);
2697 ni->id = ng_node2ID(here);
2699 /* Cycle through the linked list of hooks */
2701 LIST_FOREACH(hook, &here->nd_hooks, hk_hooks) {
2702 struct linkinfo *const link = &hl->link[ni->hooks];
2704 if (ni->hooks >= nhooks) {
2705 log(LOG_ERR, "%s: number of %s changed\n",
2709 if (NG_HOOK_NOT_VALID(hook))
2711 strcpy(link->ourhook, NG_HOOK_NAME(hook));
2712 strcpy(link->peerhook, NG_PEER_HOOK_NAME(hook));
2713 if (NG_PEER_NODE_NAME(hook)[0] != '\0')
2714 strcpy(link->nodeinfo.name,
2715 NG_PEER_NODE_NAME(hook));
2716 strcpy(link->nodeinfo.type,
2717 NG_PEER_NODE(hook)->nd_type->name);
2718 link->nodeinfo.id = ng_node2ID(NG_PEER_NODE(hook));
2719 link->nodeinfo.hooks = NG_PEER_NODE(hook)->nd_numhooks;
2728 const int unnamed = (msg->header.cmd == NGM_LISTNODES);
2729 struct namelist *nl;
2733 mtx_lock(&ng_namehash_mtx);
2734 /* Count number of nodes */
2735 for (i = 0; i < NG_NAME_HASH_SIZE; i++) {
2736 LIST_FOREACH(node, &ng_name_hash[i], nd_nodes) {
2737 if (NG_NODE_IS_VALID(node) &&
2738 (unnamed || NG_NODE_HAS_NAME(node))) {
2743 mtx_unlock(&ng_namehash_mtx);
2745 /* Get response struct */
2746 NG_MKRESPONSE(resp, msg, sizeof(*nl)
2747 + (num * sizeof(struct nodeinfo)), M_NOWAIT);
2752 nl = (struct namelist *) resp->data;
2754 /* Cycle through the linked list of nodes */
2756 mtx_lock(&ng_namehash_mtx);
2757 for (i = 0; i < NG_NAME_HASH_SIZE; i++) {
2758 LIST_FOREACH(node, &ng_name_hash[i], nd_nodes) {
2759 struct nodeinfo *const np =
2760 &nl->nodeinfo[nl->numnames];
2762 if (NG_NODE_NOT_VALID(node))
2764 if (!unnamed && (! NG_NODE_HAS_NAME(node)))
2766 if (nl->numnames >= num) {
2767 log(LOG_ERR, "%s: number of nodes changed\n",
2771 if (NG_NODE_HAS_NAME(node))
2772 strcpy(np->name, NG_NODE_NAME(node));
2773 strcpy(np->type, node->nd_type->name);
2774 np->id = ng_node2ID(node);
2775 np->hooks = node->nd_numhooks;
2779 mtx_unlock(&ng_namehash_mtx);
2785 struct typelist *tl;
2786 struct ng_type *type;
2789 mtx_lock(&ng_typelist_mtx);
2790 /* Count number of types */
2791 LIST_FOREACH(type, &ng_typelist, types) {
2794 mtx_unlock(&ng_typelist_mtx);
2796 /* Get response struct */
2797 NG_MKRESPONSE(resp, msg, sizeof(*tl)
2798 + (num * sizeof(struct typeinfo)), M_NOWAIT);
2803 tl = (struct typelist *) resp->data;
2805 /* Cycle through the linked list of types */
2807 mtx_lock(&ng_typelist_mtx);
2808 LIST_FOREACH(type, &ng_typelist, types) {
2809 struct typeinfo *const tp = &tl->typeinfo[tl->numtypes];
2811 if (tl->numtypes >= num) {
2812 log(LOG_ERR, "%s: number of %s changed\n",
2816 strcpy(tp->type_name, type->name);
2817 tp->numnodes = type->refs - 1; /* don't count list */
2820 mtx_unlock(&ng_typelist_mtx);
2824 case NGM_BINARY2ASCII:
2826 int bufSize = 20 * 1024; /* XXX hard coded constant */
2827 const struct ng_parse_type *argstype;
2828 const struct ng_cmdlist *c;
2829 struct ng_mesg *binary, *ascii;
2831 /* Data area must contain a valid netgraph message */
2832 binary = (struct ng_mesg *)msg->data;
2833 if (msg->header.arglen < sizeof(struct ng_mesg) ||
2834 (msg->header.arglen - sizeof(struct ng_mesg) <
2835 binary->header.arglen)) {
2841 /* Get a response message with lots of room */
2842 NG_MKRESPONSE(resp, msg, sizeof(*ascii) + bufSize, M_NOWAIT);
2847 ascii = (struct ng_mesg *)resp->data;
2849 /* Copy binary message header to response message payload */
2850 bcopy(binary, ascii, sizeof(*binary));
2852 /* Find command by matching typecookie and command number */
2853 for (c = here->nd_type->cmdlist;
2854 c != NULL && c->name != NULL; c++) {
2855 if (binary->header.typecookie == c->cookie
2856 && binary->header.cmd == c->cmd)
2859 if (c == NULL || c->name == NULL) {
2860 for (c = ng_generic_cmds; c->name != NULL; c++) {
2861 if (binary->header.typecookie == c->cookie
2862 && binary->header.cmd == c->cmd)
2865 if (c->name == NULL) {
2872 /* Convert command name to ASCII */
2873 snprintf(ascii->header.cmdstr, sizeof(ascii->header.cmdstr),
2876 /* Convert command arguments to ASCII */
2877 argstype = (binary->header.flags & NGF_RESP) ?
2878 c->respType : c->mesgType;
2879 if (argstype == NULL) {
2880 *ascii->data = '\0';
2882 if ((error = ng_unparse(argstype,
2883 (u_char *)binary->data,
2884 ascii->data, bufSize)) != 0) {
2890 /* Return the result as struct ng_mesg plus ASCII string */
2891 bufSize = strlen(ascii->data) + 1;
2892 ascii->header.arglen = bufSize;
2893 resp->header.arglen = sizeof(*ascii) + bufSize;
2897 case NGM_ASCII2BINARY:
2899 int bufSize = 2000; /* XXX hard coded constant */
2900 const struct ng_cmdlist *c;
2901 const struct ng_parse_type *argstype;
2902 struct ng_mesg *ascii, *binary;
2905 /* Data area must contain at least a struct ng_mesg + '\0' */
2906 ascii = (struct ng_mesg *)msg->data;
2907 if ((msg->header.arglen < sizeof(*ascii) + 1) ||
2908 (ascii->header.arglen < 1) ||
2909 (msg->header.arglen < sizeof(*ascii) +
2910 ascii->header.arglen)) {
2915 ascii->data[ascii->header.arglen - 1] = '\0';
2917 /* Get a response message with lots of room */
2918 NG_MKRESPONSE(resp, msg, sizeof(*binary) + bufSize, M_NOWAIT);
2923 binary = (struct ng_mesg *)resp->data;
2925 /* Copy ASCII message header to response message payload */
2926 bcopy(ascii, binary, sizeof(*ascii));
2928 /* Find command by matching ASCII command string */
2929 for (c = here->nd_type->cmdlist;
2930 c != NULL && c->name != NULL; c++) {
2931 if (strcmp(ascii->header.cmdstr, c->name) == 0)
2934 if (c == NULL || c->name == NULL) {
2935 for (c = ng_generic_cmds; c->name != NULL; c++) {
2936 if (strcmp(ascii->header.cmdstr, c->name) == 0)
2939 if (c->name == NULL) {
2946 /* Convert command name to binary */
2947 binary->header.cmd = c->cmd;
2948 binary->header.typecookie = c->cookie;
2950 /* Convert command arguments to binary */
2951 argstype = (binary->header.flags & NGF_RESP) ?
2952 c->respType : c->mesgType;
2953 if (argstype == NULL) {
2956 if ((error = ng_parse(argstype, ascii->data,
2957 &off, (u_char *)binary->data, &bufSize)) != 0) {
2963 /* Return the result */
2964 binary->header.arglen = bufSize;
2965 resp->header.arglen = sizeof(*binary) + bufSize;
2969 case NGM_TEXT_CONFIG:
2970 case NGM_TEXT_STATUS:
2972 * This one is tricky as it passes the command down to the
2973 * actual node, even though it is a generic type command.
2974 * This means we must assume that the item/msg is already freed
2975 * when control passes back to us.
2977 if (here->nd_type->rcvmsg != NULL) {
2978 NGI_MSG(item) = msg; /* put it back as we found it */
2979 return((*here->nd_type->rcvmsg)(here, item, lasthook));
2981 /* Fall through if rcvmsg not supported */
2987 * Sometimes a generic message may be statically allocated
2988 * to avoid problems with allocating when in tight memeory situations.
2989 * Don't free it if it is so.
2990 * I break them appart here, because erros may cause a free if the item
2991 * in which case we'd be doing it twice.
2992 * they are kept together above, to simplify freeing.
2995 NG_RESPOND_MSG(error, here, item, resp);
3001 /************************************************************************
3002 Queue element get/free routines
3003 ************************************************************************/
3005 uma_zone_t ng_qzone;
3006 static int maxalloc = 4096;/* limit the damage of a leak */
3007 static int maxdata = 512; /* limit the damage of a DoS */
3008 static int useddata = 0;
3010 TUNABLE_INT("net.graph.maxalloc", &maxalloc);
3011 SYSCTL_INT(_net_graph, OID_AUTO, maxalloc, CTLFLAG_RDTUN, &maxalloc,
3012 0, "Maximum number of queue items to allocate");
3013 TUNABLE_INT("net.graph.maxdata", &maxdata);
3014 SYSCTL_INT(_net_graph, OID_AUTO, maxdata, CTLFLAG_RW | CTLFLAG_TUN, &maxdata,
3015 0, "Maximum number of queue data items to allocate");
3017 #ifdef NETGRAPH_DEBUG
3018 static TAILQ_HEAD(, ng_item) ng_itemlist = TAILQ_HEAD_INITIALIZER(ng_itemlist);
3019 static int allocated; /* number of items malloc'd */
3023 * Get a queue entry.
3024 * This is usually called when a packet first enters netgraph.
3025 * By definition, this is usually from an interrupt, or from a user.
3026 * Users are not so important, but try be quick for the times that it's
3029 static __inline item_p
3030 ng_getqblk(int flags)
3035 wait = (flags & NG_WAITOK) ? M_WAITOK : M_NOWAIT;
3037 item = uma_zalloc(ng_qzone, wait | M_ZERO);
3039 #ifdef NETGRAPH_DEBUG
3042 TAILQ_INSERT_TAIL(&ng_itemlist, item, all);
3044 mtx_unlock(&ngq_mtx);
3052 * Release a queue entry
3055 ng_free_item(item_p item)
3058 * The item may hold resources on it's own. We need to free
3059 * these before we can free the item. What they are depends upon
3060 * what kind of item it is. it is important that nodes zero
3061 * out pointers to resources that they remove from the item
3062 * or we release them again here.
3064 switch (item->el_flags & NGQF_TYPE) {
3066 atomic_subtract_int(&useddata, 1);
3067 /* If we have an mbuf still attached.. */
3068 NG_FREE_M(_NGI_M(item));
3071 _NGI_RETADDR(item) = 0;
3072 NG_FREE_MSG(_NGI_MSG(item));
3076 /* nothing to free really, */
3077 _NGI_FN(item) = NULL;
3078 _NGI_ARG1(item) = NULL;
3079 _NGI_ARG2(item) = 0;
3082 /* If we still have a node or hook referenced... */
3083 _NGI_CLR_NODE(item);
3084 _NGI_CLR_HOOK(item);
3086 #ifdef NETGRAPH_DEBUG
3088 TAILQ_REMOVE(&ng_itemlist, item, all);
3090 mtx_unlock(&ngq_mtx);
3092 uma_zfree(ng_qzone, item);
3095 /************************************************************************
3097 ************************************************************************/
3100 * Handle the loading/unloading of a netgraph node type module
3103 ng_mod_event(module_t mod, int event, void *data)
3105 struct ng_type *const type = data;
3111 /* Register new netgraph node type */
3113 if ((error = ng_newtype(type)) != 0) {
3118 /* Call type specific code */
3119 if (type->mod_event != NULL)
3120 if ((error = (*type->mod_event)(mod, event, data))) {
3121 mtx_lock(&ng_typelist_mtx);
3122 type->refs--; /* undo it */
3123 LIST_REMOVE(type, types);
3124 mtx_unlock(&ng_typelist_mtx);
3131 if (type->refs > 1) { /* make sure no nodes exist! */
3134 if (type->refs == 0) {
3135 /* failed load, nothing to undo */
3139 if (type->mod_event != NULL) { /* check with type */
3140 error = (*type->mod_event)(mod, event, data);
3141 if (error != 0) { /* type refuses.. */
3146 mtx_lock(&ng_typelist_mtx);
3147 LIST_REMOVE(type, types);
3148 mtx_unlock(&ng_typelist_mtx);
3154 if (type->mod_event != NULL)
3155 error = (*type->mod_event)(mod, event, data);
3157 error = EOPNOTSUPP; /* XXX ? */
3164 * Handle loading and unloading for this code.
3165 * The only thing we need to link into is the NETISR strucure.
3168 ngb_mod_event(module_t mod, int event, void *data)
3174 /* Initialize everything. */
3175 NG_WORKLIST_LOCK_INIT();
3176 mtx_init(&ng_typelist_mtx, "netgraph types mutex", NULL,
3178 mtx_init(&ng_idhash_mtx, "netgraph idhash mutex", NULL,
3180 mtx_init(&ng_namehash_mtx, "netgraph namehash mutex", NULL,
3182 mtx_init(&ng_topo_mtx, "netgraph topology mutex", NULL,
3184 #ifdef NETGRAPH_DEBUG
3185 mtx_init(&ng_nodelist_mtx, "netgraph nodelist mutex", NULL,
3187 mtx_init(&ngq_mtx, "netgraph item list mutex", NULL,
3190 ng_qzone = uma_zcreate("NetGraph items", sizeof(struct ng_item),
3191 NULL, NULL, NULL, NULL, UMA_ALIGN_CACHE, 0);
3192 uma_zone_set_max(ng_qzone, maxalloc);
3193 netisr_register(NETISR_NETGRAPH, (netisr_t *)ngintr, NULL,
3197 /* You can't unload it because an interface may be using it. */
3207 static moduledata_t netgraph_mod = {
3212 DECLARE_MODULE(netgraph, netgraph_mod, SI_SUB_NETGRAPH, SI_ORDER_MIDDLE);
3213 SYSCTL_NODE(_net, OID_AUTO, graph, CTLFLAG_RW, 0, "netgraph Family");
3214 SYSCTL_INT(_net_graph, OID_AUTO, abi_version, CTLFLAG_RD, 0, NG_ABI_VERSION,"");
3215 SYSCTL_INT(_net_graph, OID_AUTO, msg_version, CTLFLAG_RD, 0, NG_VERSION, "");
3217 #ifdef NETGRAPH_DEBUG
3219 dumphook (hook_p hook, char *file, int line)
3221 printf("hook: name %s, %d refs, Last touched:\n",
3222 _NG_HOOK_NAME(hook), hook->hk_refs);
3223 printf(" Last active @ %s, line %d\n",
3224 hook->lastfile, hook->lastline);
3226 printf(" problem discovered at file %s, line %d\n", file, line);
3231 dumpnode(node_p node, char *file, int line)
3233 printf("node: ID [%x]: type '%s', %d hooks, flags 0x%x, %d refs, %s:\n",
3234 _NG_NODE_ID(node), node->nd_type->name,
3235 node->nd_numhooks, node->nd_flags,
3236 node->nd_refs, node->nd_name);
3237 printf(" Last active @ %s, line %d\n",
3238 node->lastfile, node->lastline);
3240 printf(" problem discovered at file %s, line %d\n", file, line);
3245 dumpitem(item_p item, char *file, int line)
3247 printf(" ACTIVE item, last used at %s, line %d",
3248 item->lastfile, item->lastline);
3249 switch(item->el_flags & NGQF_TYPE) {
3251 printf(" - [data]\n");
3254 printf(" - retaddr[%d]:\n", _NGI_RETADDR(item));
3257 printf(" - fn@%p (%p, %p, %p, %d (%x))\n",
3261 item->body.fn.fn_arg1,
3262 item->body.fn.fn_arg2,
3263 item->body.fn.fn_arg2);
3266 printf(" - fn2@%p (%p, %p, %p, %d (%x))\n",
3270 item->body.fn.fn_arg1,
3271 item->body.fn.fn_arg2,
3272 item->body.fn.fn_arg2);
3276 printf(" problem discovered at file %s, line %d\n", file, line);
3277 if (_NGI_NODE(item)) {
3278 printf("node %p ([%x])\n",
3279 _NGI_NODE(item), ng_node2ID(_NGI_NODE(item)));
3289 TAILQ_FOREACH(item, &ng_itemlist, all) {
3290 printf("[%d] ", i++);
3291 dumpitem(item, NULL, 0);
3300 mtx_lock(&ng_nodelist_mtx);
3301 SLIST_FOREACH(node, &ng_allnodes, nd_all) {
3302 printf("[%d] ", i++);
3303 dumpnode(node, NULL, 0);
3305 mtx_unlock(&ng_nodelist_mtx);
3313 mtx_lock(&ng_nodelist_mtx);
3314 SLIST_FOREACH(hook, &ng_allhooks, hk_all) {
3315 printf("[%d] ", i++);
3316 dumphook(hook, NULL, 0);
3318 mtx_unlock(&ng_nodelist_mtx);
3322 sysctl_debug_ng_dump_items(SYSCTL_HANDLER_ARGS)
3330 error = sysctl_handle_int(oidp, &val, 0, req);
3331 if (error != 0 || req->newptr == NULL)
3341 SYSCTL_PROC(_debug, OID_AUTO, ng_dump_items, CTLTYPE_INT | CTLFLAG_RW,
3342 0, sizeof(int), sysctl_debug_ng_dump_items, "I", "Number of allocated items");
3343 #endif /* NETGRAPH_DEBUG */
3346 /***********************************************************************
3348 **********************************************************************/
3349 /* NETISR thread enters here */
3351 * Pick a node off the list of nodes with work,
3352 * try get an item to process off it.
3353 * If there are no more, remove the node from the list.
3363 node = TAILQ_FIRST(&ng_worklist);
3365 NG_WORKLIST_UNLOCK();
3368 node->nd_flags &= ~NGF_WORKQ;
3369 TAILQ_REMOVE(&ng_worklist, node, nd_work);
3370 NG_WORKLIST_UNLOCK();
3371 CTR3(KTR_NET, "%20s: node [%x] (%p) taken off worklist",
3372 __func__, node->nd_ID, node);
3374 * We have the node. We also take over the reference
3375 * that the list had on it.
3376 * Now process as much as you can, until it won't
3377 * let you have another item off the queue.
3378 * All this time, keep the reference
3379 * that lets us be sure that the node still exists.
3380 * Let the reference go at the last minute.
3385 NG_QUEUE_LOCK(&node->nd_input_queue);
3386 item = ng_dequeue(&node->nd_input_queue, &rw);
3388 NG_QUEUE_UNLOCK(&node->nd_input_queue);
3389 break; /* go look for another node */
3391 NG_QUEUE_UNLOCK(&node->nd_input_queue);
3392 NGI_GET_NODE(item, node); /* zaps stored node */
3393 ng_apply_item(node, item, rw);
3394 NG_NODE_UNREF(node);
3397 NG_NODE_UNREF(node);
3402 ng_worklist_remove(node_p node)
3404 mtx_assert(&node->nd_input_queue.q_mtx, MA_OWNED);
3407 if (node->nd_flags & NGF_WORKQ) {
3408 node->nd_flags &= ~NGF_WORKQ;
3409 TAILQ_REMOVE(&ng_worklist, node, nd_work);
3410 NG_WORKLIST_UNLOCK();
3411 NG_NODE_UNREF(node);
3412 CTR3(KTR_NET, "%20s: node [%x] (%p) removed from worklist",
3413 __func__, node->nd_ID, node);
3415 NG_WORKLIST_UNLOCK();
3421 * It's posible that a debugging NG_NODE_REF may need
3422 * to be outside the mutex zone
3425 ng_setisr(node_p node)
3428 mtx_assert(&node->nd_input_queue.q_mtx, MA_OWNED);
3430 if ((node->nd_flags & NGF_WORKQ) == 0) {
3432 * If we are not already on the work queue,
3435 node->nd_flags |= NGF_WORKQ;
3437 TAILQ_INSERT_TAIL(&ng_worklist, node, nd_work);
3438 NG_WORKLIST_UNLOCK();
3439 NG_NODE_REF(node); /* XXX fafe in mutex? */
3440 CTR3(KTR_NET, "%20s: node [%x] (%p) put on worklist", __func__,
3443 CTR3(KTR_NET, "%20s: node [%x] (%p) already on worklist",
3444 __func__, node->nd_ID, node);
3445 schednetisr(NETISR_NETGRAPH);
3449 /***********************************************************************
3450 * Externally useable functions to set up a queue item ready for sending
3451 ***********************************************************************/
3453 #ifdef NETGRAPH_DEBUG
3454 #define ITEM_DEBUG_CHECKS \
3456 if (NGI_NODE(item) ) { \
3457 printf("item already has node"); \
3458 kdb_enter(KDB_WHY_NETGRAPH, "has node"); \
3459 NGI_CLR_NODE(item); \
3461 if (NGI_HOOK(item) ) { \
3462 printf("item already has hook"); \
3463 kdb_enter(KDB_WHY_NETGRAPH, "has hook"); \
3464 NGI_CLR_HOOK(item); \
3468 #define ITEM_DEBUG_CHECKS
3472 * Put mbuf into the item.
3473 * Hook and node references will be removed when the item is dequeued.
3475 * (XXX) Unsafe because no reference held by peer on remote node.
3476 * remote node might go away in this timescale.
3477 * We know the hooks can't go away because that would require getting
3478 * a writer item on both nodes and we must have at least a reader
3479 * here to be able to do this.
3480 * Note that the hook loaded is the REMOTE hook.
3482 * This is possibly in the critical path for new data.
3485 ng_package_data(struct mbuf *m, int flags)
3489 if (atomic_fetchadd_int(&useddata, 1) >= maxdata) {
3490 atomic_subtract_int(&useddata, 1);
3494 if ((item = ng_getqblk(flags)) == NULL) {
3499 item->el_flags = NGQF_DATA | NGQF_READER;
3505 * Allocate a queue item and put items into it..
3506 * Evaluate the address as this will be needed to queue it and
3507 * to work out what some of the fields should be.
3508 * Hook and node references will be removed when the item is dequeued.
3512 ng_package_msg(struct ng_mesg *msg, int flags)
3516 if ((item = ng_getqblk(flags)) == NULL) {
3521 /* Messages items count as writers unless explicitly exempted. */
3522 if (msg->header.cmd & NGM_READONLY)
3523 item->el_flags = NGQF_MESG | NGQF_READER;
3525 item->el_flags = NGQF_MESG | NGQF_WRITER;
3527 * Set the current lasthook into the queue item
3529 NGI_MSG(item) = msg;
3530 NGI_RETADDR(item) = 0;
3536 #define SET_RETADDR(item, here, retaddr) \
3537 do { /* Data or fn items don't have retaddrs */ \
3538 if ((item->el_flags & NGQF_TYPE) == NGQF_MESG) { \
3540 NGI_RETADDR(item) = retaddr; \
3543 * The old return address should be ok. \
3544 * If there isn't one, use the address \
3547 if (NGI_RETADDR(item) == 0) { \
3549 = ng_node2ID(here); \
3556 ng_address_hook(node_p here, item_p item, hook_p hook, ng_ID_t retaddr)
3562 * Quick sanity check..
3563 * Since a hook holds a reference on it's node, once we know
3564 * that the peer is still connected (even if invalid,) we know
3565 * that the peer node is present, though maybe invalid.
3568 || NG_HOOK_NOT_VALID(hook)
3569 || NG_HOOK_NOT_VALID(NG_HOOK_PEER(hook))
3570 || NG_NODE_NOT_VALID(NG_PEER_NODE(hook))) {
3577 * Transfer our interest to the other (peer) end.
3579 peer = NG_HOOK_PEER(hook);
3581 NGI_SET_HOOK(item, peer);
3582 peernode = NG_PEER_NODE(hook);
3583 NG_NODE_REF(peernode);
3584 NGI_SET_NODE(item, peernode);
3585 SET_RETADDR(item, here, retaddr);
3590 ng_address_path(node_p here, item_p item, char *address, ng_ID_t retaddr)
3598 * Note that ng_path2noderef increments the reference count
3599 * on the node for us if it finds one. So we don't have to.
3601 error = ng_path2noderef(here, address, &dest, &hook);
3606 NGI_SET_NODE(item, dest);
3608 NG_HOOK_REF(hook); /* don't let it go while on the queue */
3609 NGI_SET_HOOK(item, hook);
3611 SET_RETADDR(item, here, retaddr);
3616 ng_address_ID(node_p here, item_p item, ng_ID_t ID, ng_ID_t retaddr)
3622 * Find the target node.
3624 dest = ng_ID2noderef(ID); /* GETS REFERENCE! */
3630 /* Fill out the contents */
3631 NGI_SET_NODE(item, dest);
3633 SET_RETADDR(item, here, retaddr);
3638 * special case to send a message to self (e.g. destroy node)
3639 * Possibly indicate an arrival hook too.
3640 * Useful for removing that hook :-)
3643 ng_package_msg_self(node_p here, hook_p hook, struct ng_mesg *msg)
3648 * Find the target node.
3649 * If there is a HOOK argument, then use that in preference
3652 if ((item = ng_getqblk(NG_NOFLAGS)) == NULL) {
3657 /* Fill out the contents */
3658 item->el_flags = NGQF_MESG | NGQF_WRITER;
3660 NGI_SET_NODE(item, here);
3663 NGI_SET_HOOK(item, hook);
3665 NGI_MSG(item) = msg;
3666 NGI_RETADDR(item) = ng_node2ID(here);
3671 * Send ng_item_fn function call to the specified node.
3675 ng_send_fn(node_p node, hook_p hook, ng_item_fn *fn, void * arg1, int arg2)
3678 return ng_send_fn1(node, hook, fn, arg1, arg2, NG_NOFLAGS);
3682 ng_send_fn1(node_p node, hook_p hook, ng_item_fn *fn, void * arg1, int arg2,
3687 if ((item = ng_getqblk(flags)) == NULL) {
3690 item->el_flags = NGQF_FN | NGQF_WRITER;
3691 NG_NODE_REF(node); /* and one for the item */
3692 NGI_SET_NODE(item, node);
3695 NGI_SET_HOOK(item, hook);
3698 NGI_ARG1(item) = arg1;
3699 NGI_ARG2(item) = arg2;
3700 return(ng_snd_item(item, flags));
3704 * Send ng_item_fn2 function call to the specified node.
3706 * If an optional pitem parameter is supplied, its apply
3707 * callback will be copied to the new item. If also NG_REUSE_ITEM
3708 * flag is set, no new item will be allocated, but pitem will
3712 ng_send_fn2(node_p node, hook_p hook, item_p pitem, ng_item_fn2 *fn, void *arg1,
3713 int arg2, int flags)
3717 KASSERT((pitem != NULL || (flags & NG_REUSE_ITEM) == 0),
3718 ("%s: NG_REUSE_ITEM but no pitem", __func__));
3721 * Allocate a new item if no supplied or
3722 * if we can't use supplied one.
3724 if (pitem == NULL || (flags & NG_REUSE_ITEM) == 0) {
3725 if ((item = ng_getqblk(flags)) == NULL)
3728 if ((pitem->el_flags & NGQF_TYPE) == NGQF_DATA)
3729 atomic_subtract_int(&useddata, 1);
3733 item->el_flags = NGQF_FN2 | NGQF_WRITER;
3734 NG_NODE_REF(node); /* and one for the item */
3735 NGI_SET_NODE(item, node);
3738 NGI_SET_HOOK(item, hook);
3741 NGI_ARG1(item) = arg1;
3742 NGI_ARG2(item) = arg2;
3743 if (pitem != NULL && (flags & NG_REUSE_ITEM) == 0)
3744 item->apply = pitem->apply;
3745 return(ng_snd_item(item, flags));
3749 * Official timeout routines for Netgraph nodes.
3752 ng_callout_trampoline(void *arg)
3756 ng_snd_item(item, 0);
3761 ng_callout(struct callout *c, node_p node, hook_p hook, int ticks,
3762 ng_item_fn *fn, void * arg1, int arg2)
3766 if ((item = ng_getqblk(NG_NOFLAGS)) == NULL)
3769 item->el_flags = NGQF_FN | NGQF_WRITER;
3770 NG_NODE_REF(node); /* and one for the item */
3771 NGI_SET_NODE(item, node);
3774 NGI_SET_HOOK(item, hook);
3777 NGI_ARG1(item) = arg1;
3778 NGI_ARG2(item) = arg2;
3780 if (callout_reset(c, ticks, &ng_callout_trampoline, item) == 1 &&
3782 NG_FREE_ITEM(oitem);
3786 /* A special modified version of untimeout() */
3788 ng_uncallout(struct callout *c, node_p node)
3793 KASSERT(c != NULL, ("ng_uncallout: NULL callout"));
3794 KASSERT(node != NULL, ("ng_uncallout: NULL node"));
3796 rval = callout_stop(c);
3798 /* Do an extra check */
3799 if ((rval > 0) && (c->c_func == &ng_callout_trampoline) &&
3800 (NGI_NODE(item) == node)) {
3802 * We successfully removed it from the queue before it ran
3803 * So now we need to unreference everything that was
3804 * given extra references. (NG_FREE_ITEM does this).
3814 * Set the address, if none given, give the node here.
3817 ng_replace_retaddr(node_p here, item_p item, ng_ID_t retaddr)
3820 NGI_RETADDR(item) = retaddr;
3823 * The old return address should be ok.
3824 * If there isn't one, use the address here.
3826 NGI_RETADDR(item) = ng_node2ID(here);
3832 /* just test all the macros */
3834 ng_macro_test(item_p item);
3836 ng_macro_test(item_p item)
3841 struct ng_mesg *msg;
3846 NGI_GET_MSG(item, msg);
3847 retaddr = NGI_RETADDR(item);
3848 NG_SEND_DATA(error, hook, m, NULL);
3849 NG_SEND_DATA_ONLY(error, hook, m);
3850 NG_FWD_NEW_DATA(error, item, hook, m);
3851 NG_FWD_ITEM_HOOK(error, item, hook);
3852 NG_SEND_MSG_HOOK(error, node, msg, hook, retaddr);
3853 NG_SEND_MSG_ID(error, node, msg, retaddr, retaddr);
3854 NG_SEND_MSG_PATH(error, node, msg, ".:", retaddr);
3855 NG_FWD_MSG_HOOK(error, node, item, hook, retaddr);
3857 #endif /* TESTING */