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 /* List of all active nodes */
74 static LIST_HEAD(, ng_node) ng_nodelist;
75 static struct mtx ng_nodelist_mtx;
77 /* Mutex to protect topology events. */
78 static struct mtx ng_topo_mtx;
81 static struct mtx ngq_mtx; /* protects the queue item list */
83 static SLIST_HEAD(, ng_node) ng_allnodes;
84 static LIST_HEAD(, ng_node) ng_freenodes; /* in debug, we never free() them */
85 static SLIST_HEAD(, ng_hook) ng_allhooks;
86 static LIST_HEAD(, ng_hook) ng_freehooks; /* in debug, we never free() them */
88 static void ng_dumpitems(void);
89 static void ng_dumpnodes(void);
90 static void ng_dumphooks(void);
92 #endif /* NETGRAPH_DEBUG */
94 * DEAD versions of the structures.
95 * In order to avoid races, it is sometimes neccesary to point
96 * at SOMETHING even though theoretically, the current entity is
97 * INVALID. Use these to avoid these races.
99 struct ng_type ng_deadtype = {
103 NULL, /* constructor */
110 NULL, /* disconnect */
114 struct ng_node ng_deadnode = {
122 LIST_HEAD_INITIALIZER(ng_deadnode.hooks),
123 {}, /* all_nodes list entry */
124 {}, /* id hashtable list entry */
125 {}, /* workqueue entry */
127 {}, /* should never use! (should hang) */
129 &ng_deadnode.nd_input_queue.queue,
132 #ifdef NETGRAPH_DEBUG
137 #endif /* NETGRAPH_DEBUG */
140 struct ng_hook ng_deadhook = {
143 HK_INVALID | HK_DEAD,
144 1, /* refs always >= 1 */
145 0, /* undefined data link type */
146 &ng_deadhook, /* Peer is self */
147 &ng_deadnode, /* attached to deadnode */
149 NULL, /* override rcvmsg() */
150 NULL, /* override rcvdata() */
151 #ifdef NETGRAPH_DEBUG
156 #endif /* NETGRAPH_DEBUG */
160 * END DEAD STRUCTURES
162 /* List nodes with unallocated work */
163 static TAILQ_HEAD(, ng_node) ng_worklist = TAILQ_HEAD_INITIALIZER(ng_worklist);
164 static struct mtx ng_worklist_mtx; /* MUST LOCK NODE FIRST */
166 /* List of installed types */
167 static LIST_HEAD(, ng_type) ng_typelist;
168 static struct mtx ng_typelist_mtx;
170 /* Hash related definitions */
171 /* XXX Don't need to initialise them because it's a LIST */
172 #define NG_ID_HASH_SIZE 32 /* most systems wont need even this many */
173 static LIST_HEAD(, ng_node) ng_ID_hash[NG_ID_HASH_SIZE];
174 static struct mtx ng_idhash_mtx;
175 /* Method to find a node.. used twice so do it here */
176 #define NG_IDHASH_FN(ID) ((ID) % (NG_ID_HASH_SIZE))
177 #define NG_IDHASH_FIND(ID, node) \
179 mtx_assert(&ng_idhash_mtx, MA_OWNED); \
180 LIST_FOREACH(node, &ng_ID_hash[NG_IDHASH_FN(ID)], \
182 if (NG_NODE_IS_VALID(node) \
183 && (NG_NODE_ID(node) == ID)) { \
190 /* Internal functions */
191 static int ng_add_hook(node_p node, const char *name, hook_p * hookp);
192 static int ng_generic_msg(node_p here, item_p item, hook_p lasthook);
193 static ng_ID_t ng_decodeidname(const char *name);
194 static int ngb_mod_event(module_t mod, int event, void *data);
195 static void ng_worklist_remove(node_p node);
196 static void ngintr(void);
197 static int ng_apply_item(node_p node, item_p item, int rw);
198 static void ng_flush_input_queue(struct ng_queue * ngq);
199 static void ng_setisr(node_p node);
200 static node_p ng_ID2noderef(ng_ID_t ID);
201 static int ng_con_nodes(item_p item, node_p node, const char *name,
202 node_p node2, const char *name2);
203 static int ng_con_part2(node_p node, item_p item, hook_p hook);
204 static int ng_con_part3(node_p node, item_p item, hook_p hook);
205 static int ng_mkpeer(node_p node, const char *name,
206 const char *name2, char *type);
208 /* Imported, these used to be externally visible, some may go back. */
209 void ng_destroy_hook(hook_p hook);
210 node_p ng_name2noderef(node_p node, const char *name);
211 int ng_path2noderef(node_p here, const char *path,
212 node_p *dest, hook_p *lasthook);
213 int ng_make_node(const char *type, node_p *nodepp);
214 int ng_path_parse(char *addr, char **node, char **path, char **hook);
215 void ng_rmnode(node_p node, hook_p dummy1, void *dummy2, int dummy3);
216 void ng_unname(node_p node);
219 /* Our own netgraph malloc type */
220 MALLOC_DEFINE(M_NETGRAPH, "netgraph", "netgraph structures and ctrl messages");
221 MALLOC_DEFINE(M_NETGRAPH_HOOK, "netgraph_hook", "netgraph hook structures");
222 MALLOC_DEFINE(M_NETGRAPH_NODE, "netgraph_node", "netgraph node structures");
223 MALLOC_DEFINE(M_NETGRAPH_ITEM, "netgraph_item", "netgraph item structures");
224 MALLOC_DEFINE(M_NETGRAPH_MSG, "netgraph_msg", "netgraph name storage");
226 /* Should not be visible outside this file */
228 #define _NG_ALLOC_HOOK(hook) \
229 MALLOC(hook, hook_p, sizeof(*hook), M_NETGRAPH_HOOK, M_NOWAIT | M_ZERO)
230 #define _NG_ALLOC_NODE(node) \
231 MALLOC(node, node_p, sizeof(*node), M_NETGRAPH_NODE, M_NOWAIT | M_ZERO)
233 #define NG_QUEUE_LOCK_INIT(n) \
234 mtx_init(&(n)->q_mtx, "ng_node", NULL, MTX_DEF)
235 #define NG_QUEUE_LOCK(n) \
236 mtx_lock(&(n)->q_mtx)
237 #define NG_QUEUE_UNLOCK(n) \
238 mtx_unlock(&(n)->q_mtx)
239 #define NG_WORKLIST_LOCK_INIT() \
240 mtx_init(&ng_worklist_mtx, "ng_worklist", NULL, MTX_DEF)
241 #define NG_WORKLIST_LOCK() \
242 mtx_lock(&ng_worklist_mtx)
243 #define NG_WORKLIST_UNLOCK() \
244 mtx_unlock(&ng_worklist_mtx)
246 #ifdef NETGRAPH_DEBUG /*----------------------------------------------*/
249 * In an attempt to help track reference count screwups
250 * we do not free objects back to the malloc system, but keep them
251 * in a local cache where we can examine them and keep information safely
252 * after they have been freed.
253 * We use this scheme for nodes and hooks, and to some extent for items.
255 static __inline hook_p
259 SLIST_ENTRY(ng_hook) temp;
260 mtx_lock(&ng_nodelist_mtx);
261 hook = LIST_FIRST(&ng_freehooks);
263 LIST_REMOVE(hook, hk_hooks);
264 bcopy(&hook->hk_all, &temp, sizeof(temp));
265 bzero(hook, sizeof(struct ng_hook));
266 bcopy(&temp, &hook->hk_all, sizeof(temp));
267 mtx_unlock(&ng_nodelist_mtx);
268 hook->hk_magic = HK_MAGIC;
270 mtx_unlock(&ng_nodelist_mtx);
271 _NG_ALLOC_HOOK(hook);
273 hook->hk_magic = HK_MAGIC;
274 mtx_lock(&ng_nodelist_mtx);
275 SLIST_INSERT_HEAD(&ng_allhooks, hook, hk_all);
276 mtx_unlock(&ng_nodelist_mtx);
282 static __inline node_p
286 SLIST_ENTRY(ng_node) temp;
287 mtx_lock(&ng_nodelist_mtx);
288 node = LIST_FIRST(&ng_freenodes);
290 LIST_REMOVE(node, nd_nodes);
291 bcopy(&node->nd_all, &temp, sizeof(temp));
292 bzero(node, sizeof(struct ng_node));
293 bcopy(&temp, &node->nd_all, sizeof(temp));
294 mtx_unlock(&ng_nodelist_mtx);
295 node->nd_magic = ND_MAGIC;
297 mtx_unlock(&ng_nodelist_mtx);
298 _NG_ALLOC_NODE(node);
300 node->nd_magic = ND_MAGIC;
301 mtx_lock(&ng_nodelist_mtx);
302 SLIST_INSERT_HEAD(&ng_allnodes, node, nd_all);
303 mtx_unlock(&ng_nodelist_mtx);
309 #define NG_ALLOC_HOOK(hook) do { (hook) = ng_alloc_hook(); } while (0)
310 #define NG_ALLOC_NODE(node) do { (node) = ng_alloc_node(); } while (0)
313 #define NG_FREE_HOOK(hook) \
315 mtx_lock(&ng_nodelist_mtx); \
316 LIST_INSERT_HEAD(&ng_freehooks, hook, hk_hooks); \
317 hook->hk_magic = 0; \
318 mtx_unlock(&ng_nodelist_mtx); \
321 #define NG_FREE_NODE(node) \
323 mtx_lock(&ng_nodelist_mtx); \
324 LIST_INSERT_HEAD(&ng_freenodes, node, nd_nodes); \
325 node->nd_magic = 0; \
326 mtx_unlock(&ng_nodelist_mtx); \
329 #else /* NETGRAPH_DEBUG */ /*----------------------------------------------*/
331 #define NG_ALLOC_HOOK(hook) _NG_ALLOC_HOOK(hook)
332 #define NG_ALLOC_NODE(node) _NG_ALLOC_NODE(node)
334 #define NG_FREE_HOOK(hook) do { FREE((hook), M_NETGRAPH_HOOK); } while (0)
335 #define NG_FREE_NODE(node) do { FREE((node), M_NETGRAPH_NODE); } while (0)
337 #endif /* NETGRAPH_DEBUG */ /*----------------------------------------------*/
339 /* Set this to kdb_enter("X") to catch all errors as they occur */
344 static ng_ID_t nextID = 1;
347 #define CHECK_DATA_MBUF(m) do { \
352 for (total = 0, n = (m); n != NULL; n = n->m_next) { \
354 if (n->m_nextpkt != NULL) \
355 panic("%s: m_nextpkt", __func__); \
358 if ((m)->m_pkthdr.len != total) { \
359 panic("%s: %d != %d", \
360 __func__, (m)->m_pkthdr.len, total); \
364 #define CHECK_DATA_MBUF(m)
367 #define ERROUT(x) do { error = (x); goto done; } while (0)
369 /************************************************************************
370 Parse type definitions for generic messages
371 ************************************************************************/
373 /* Handy structure parse type defining macro */
374 #define DEFINE_PARSE_STRUCT_TYPE(lo, up, args) \
375 static const struct ng_parse_struct_field \
376 ng_ ## lo ## _type_fields[] = NG_GENERIC_ ## up ## _INFO args; \
377 static const struct ng_parse_type ng_generic_ ## lo ## _type = { \
378 &ng_parse_struct_type, \
379 &ng_ ## lo ## _type_fields \
382 DEFINE_PARSE_STRUCT_TYPE(mkpeer, MKPEER, ());
383 DEFINE_PARSE_STRUCT_TYPE(connect, CONNECT, ());
384 DEFINE_PARSE_STRUCT_TYPE(name, NAME, ());
385 DEFINE_PARSE_STRUCT_TYPE(rmhook, RMHOOK, ());
386 DEFINE_PARSE_STRUCT_TYPE(nodeinfo, NODEINFO, ());
387 DEFINE_PARSE_STRUCT_TYPE(typeinfo, TYPEINFO, ());
388 DEFINE_PARSE_STRUCT_TYPE(linkinfo, LINKINFO, (&ng_generic_nodeinfo_type));
390 /* Get length of an array when the length is stored as a 32 bit
391 value immediately preceding the array -- as with struct namelist
392 and struct typelist. */
394 ng_generic_list_getLength(const struct ng_parse_type *type,
395 const u_char *start, const u_char *buf)
397 return *((const u_int32_t *)(buf - 4));
400 /* Get length of the array of struct linkinfo inside a struct hooklist */
402 ng_generic_linkinfo_getLength(const struct ng_parse_type *type,
403 const u_char *start, const u_char *buf)
405 const struct hooklist *hl = (const struct hooklist *)start;
407 return hl->nodeinfo.hooks;
410 /* Array type for a variable length array of struct namelist */
411 static const struct ng_parse_array_info ng_nodeinfoarray_type_info = {
412 &ng_generic_nodeinfo_type,
413 &ng_generic_list_getLength
415 static const struct ng_parse_type ng_generic_nodeinfoarray_type = {
416 &ng_parse_array_type,
417 &ng_nodeinfoarray_type_info
420 /* Array type for a variable length array of struct typelist */
421 static const struct ng_parse_array_info ng_typeinfoarray_type_info = {
422 &ng_generic_typeinfo_type,
423 &ng_generic_list_getLength
425 static const struct ng_parse_type ng_generic_typeinfoarray_type = {
426 &ng_parse_array_type,
427 &ng_typeinfoarray_type_info
430 /* Array type for array of struct linkinfo in struct hooklist */
431 static const struct ng_parse_array_info ng_generic_linkinfo_array_type_info = {
432 &ng_generic_linkinfo_type,
433 &ng_generic_linkinfo_getLength
435 static const struct ng_parse_type ng_generic_linkinfo_array_type = {
436 &ng_parse_array_type,
437 &ng_generic_linkinfo_array_type_info
440 DEFINE_PARSE_STRUCT_TYPE(typelist, TYPELIST, (&ng_generic_nodeinfoarray_type));
441 DEFINE_PARSE_STRUCT_TYPE(hooklist, HOOKLIST,
442 (&ng_generic_nodeinfo_type, &ng_generic_linkinfo_array_type));
443 DEFINE_PARSE_STRUCT_TYPE(listnodes, LISTNODES,
444 (&ng_generic_nodeinfoarray_type));
446 /* List of commands and how to convert arguments to/from ASCII */
447 static const struct ng_cmdlist ng_generic_cmds[] = {
459 &ng_generic_mkpeer_type,
466 &ng_generic_connect_type,
473 &ng_generic_name_type,
480 &ng_generic_rmhook_type,
488 &ng_generic_nodeinfo_type
495 &ng_generic_hooklist_type
502 &ng_generic_listnodes_type /* same as NGM_LISTNODES */
509 &ng_generic_listnodes_type
516 &ng_generic_typeinfo_type
523 &ng_parse_string_type
530 &ng_parse_string_type
536 &ng_parse_ng_mesg_type,
537 &ng_parse_ng_mesg_type
543 &ng_parse_ng_mesg_type,
544 &ng_parse_ng_mesg_type
549 /************************************************************************
551 ************************************************************************/
554 * Instantiate a node of the requested type
557 ng_make_node(const char *typename, node_p *nodepp)
559 struct ng_type *type;
562 /* Check that the type makes sense */
563 if (typename == NULL) {
568 /* Locate the node type. If we fail we return. Do not try to load
571 if ((type = ng_findtype(typename)) == NULL)
575 * If we have a constructor, then make the node and
576 * call the constructor to do type specific initialisation.
578 if (type->constructor != NULL) {
579 if ((error = ng_make_node_common(type, nodepp)) == 0) {
580 if ((error = ((*type->constructor)(*nodepp)) != 0)) {
581 NG_NODE_UNREF(*nodepp);
586 * Node has no constructor. We cannot ask for one
587 * to be made. It must be brought into existence by
588 * some external agency. The external agency should
589 * call ng_make_node_common() directly to get the
590 * netgraph part initialised.
599 * Generic node creation. Called by node initialisation for externally
600 * instantiated nodes (e.g. hardware, sockets, etc ).
601 * The returned node has a reference count of 1.
604 ng_make_node_common(struct ng_type *type, node_p *nodepp)
608 /* Require the node type to have been already installed */
609 if (ng_findtype(type->name) == NULL) {
614 /* Make a node and try attach it to the type */
620 node->nd_type = type;
621 NG_NODE_REF(node); /* note reference */
624 NG_QUEUE_LOCK_INIT(&node->nd_input_queue);
625 node->nd_input_queue.queue = NULL;
626 node->nd_input_queue.last = &node->nd_input_queue.queue;
627 node->nd_input_queue.q_flags = 0;
628 node->nd_input_queue.q_node = node;
630 /* Initialize hook list for new node */
631 LIST_INIT(&node->nd_hooks);
633 /* Link us into the node linked list */
634 mtx_lock(&ng_nodelist_mtx);
635 LIST_INSERT_HEAD(&ng_nodelist, node, nd_nodes);
636 mtx_unlock(&ng_nodelist_mtx);
639 /* get an ID and put us in the hash chain */
640 mtx_lock(&ng_idhash_mtx);
641 for (;;) { /* wrap protection, even if silly */
643 node->nd_ID = nextID++; /* 137/second for 1 year before wrap */
645 /* Is there a problem with the new number? */
646 NG_IDHASH_FIND(node->nd_ID, node2); /* already taken? */
647 if ((node->nd_ID != 0) && (node2 == NULL)) {
651 LIST_INSERT_HEAD(&ng_ID_hash[NG_IDHASH_FN(node->nd_ID)],
653 mtx_unlock(&ng_idhash_mtx);
661 * Forceably start the shutdown process on a node. Either call
662 * its shutdown method, or do the default shutdown if there is
663 * no type-specific method.
665 * We can only be called from a shutdown message, so we know we have
666 * a writer lock, and therefore exclusive access. It also means
667 * that we should not be on the work queue, but we check anyhow.
669 * Persistent node types must have a type-specific method which
670 * allocates a new node in which case, this one is irretrievably going away,
671 * or cleans up anything it needs, and just makes the node valid again,
672 * in which case we allow the node to survive.
674 * XXX We need to think of how to tell a persistent node that we
675 * REALLY need to go away because the hardware has gone or we
676 * are rebooting.... etc.
679 ng_rmnode(node_p node, hook_p dummy1, void *dummy2, int dummy3)
683 /* Check if it's already shutting down */
684 if ((node->nd_flags & NGF_CLOSING) != 0)
687 if (node == &ng_deadnode) {
688 printf ("shutdown called on deadnode\n");
692 /* Add an extra reference so it doesn't go away during this */
696 * Mark it invalid so any newcomers know not to try use it
697 * Also add our own mark so we can't recurse
698 * note that NGF_INVALID does not do this as it's also set during
701 node->nd_flags |= NGF_INVALID|NGF_CLOSING;
703 /* If node has its pre-shutdown method, then call it first*/
704 if (node->nd_type && node->nd_type->close)
705 (*node->nd_type->close)(node);
707 /* Notify all remaining connected nodes to disconnect */
708 while ((hook = LIST_FIRST(&node->nd_hooks)) != NULL)
709 ng_destroy_hook(hook);
712 * Drain the input queue forceably.
713 * it has no hooks so what's it going to do, bleed on someone?
714 * Theoretically we came here from a queue entry that was added
715 * Just before the queue was closed, so it should be empty anyway.
716 * Also removes us from worklist if needed.
718 ng_flush_input_queue(&node->nd_input_queue);
720 /* Ask the type if it has anything to do in this case */
721 if (node->nd_type && node->nd_type->shutdown) {
722 (*node->nd_type->shutdown)(node);
723 if (NG_NODE_IS_VALID(node)) {
725 * Well, blow me down if the node code hasn't declared
726 * that it doesn't want to die.
727 * Presumably it is a persistant node.
728 * If we REALLY want it to go away,
729 * e.g. hardware going away,
730 * Our caller should set NGF_REALLY_DIE in nd_flags.
732 node->nd_flags &= ~(NGF_INVALID|NGF_CLOSING);
733 NG_NODE_UNREF(node); /* Assume they still have theirs */
736 } else { /* do the default thing */
740 ng_unname(node); /* basically a NOP these days */
743 * Remove extra reference, possibly the last
744 * Possible other holders of references may include
745 * timeout callouts, but theoretically the node's supposed to
746 * have cancelled them. Possibly hardware dependencies may
747 * force a driver to 'linger' with a reference.
753 * Remove a reference to the node, possibly the last.
754 * deadnode always acts as it it were the last.
757 ng_unref_node(node_p node)
761 if (node == &ng_deadnode) {
766 v = node->nd_refs - 1;
767 } while (! atomic_cmpset_int(&node->nd_refs, v + 1, v));
769 if (v == 0) { /* we were the last */
771 mtx_lock(&ng_nodelist_mtx);
772 node->nd_type->refs--; /* XXX maybe should get types lock? */
773 LIST_REMOVE(node, nd_nodes);
774 mtx_unlock(&ng_nodelist_mtx);
776 mtx_lock(&ng_idhash_mtx);
777 LIST_REMOVE(node, nd_idnodes);
778 mtx_unlock(&ng_idhash_mtx);
780 mtx_destroy(&node->nd_input_queue.q_mtx);
786 /************************************************************************
788 ************************************************************************/
790 ng_ID2noderef(ng_ID_t ID)
793 mtx_lock(&ng_idhash_mtx);
794 NG_IDHASH_FIND(ID, node);
797 mtx_unlock(&ng_idhash_mtx);
802 ng_node2ID(node_p node)
804 return (node ? NG_NODE_ID(node) : 0);
807 /************************************************************************
809 ************************************************************************/
812 * Assign a node a name. Once assigned, the name cannot be changed.
815 ng_name_node(node_p node, const char *name)
820 /* Check the name is valid */
821 for (i = 0; i < NG_NODESIZ; i++) {
822 if (name[i] == '\0' || name[i] == '.' || name[i] == ':')
825 if (i == 0 || name[i] != '\0') {
829 if (ng_decodeidname(name) != 0) { /* valid IDs not allowed here */
834 /* Check the name isn't already being used */
835 if ((node2 = ng_name2noderef(node, name)) != NULL) {
836 NG_NODE_UNREF(node2);
842 strlcpy(NG_NODE_NAME(node), name, NG_NODESIZ);
848 * Find a node by absolute name. The name should NOT end with ':'
849 * The name "." means "this node" and "[xxx]" means "the node
850 * with ID (ie, at address) xxx".
852 * Returns the node if found, else NULL.
853 * Eventually should add something faster than a sequential search.
854 * Note it acquires a reference on the node so you can be sure it's still
858 ng_name2noderef(node_p here, const char *name)
863 /* "." means "this node" */
864 if (strcmp(name, ".") == 0) {
869 /* Check for name-by-ID */
870 if ((temp = ng_decodeidname(name)) != 0) {
871 return (ng_ID2noderef(temp));
874 /* Find node by name */
875 mtx_lock(&ng_nodelist_mtx);
876 LIST_FOREACH(node, &ng_nodelist, nd_nodes) {
877 if (NG_NODE_IS_VALID(node)
878 && NG_NODE_HAS_NAME(node)
879 && (strcmp(NG_NODE_NAME(node), name) == 0)) {
885 mtx_unlock(&ng_nodelist_mtx);
890 * Decode an ID name, eg. "[f03034de]". Returns 0 if the
891 * string is not valid, otherwise returns the value.
894 ng_decodeidname(const char *name)
896 const int len = strlen(name);
900 /* Check for proper length, brackets, no leading junk */
903 || (name[len - 1] != ']')
904 || (!isxdigit(name[1]))) {
909 val = strtoul(name + 1, &eptr, 16);
910 if ((eptr - name != len - 1)
911 || (val == ULONG_MAX)
919 * Remove a name from a node. This should only be called
920 * when shutting down and removing the node.
921 * IF we allow name changing this may be more resurrected.
924 ng_unname(node_p node)
928 /************************************************************************
930 Names are not optional. Hooks are always connected, except for a
931 brief moment within these routines. On invalidation or during creation
932 they are connected to the 'dead' hook.
933 ************************************************************************/
936 * Remove a hook reference
939 ng_unref_hook(hook_p hook)
943 if (hook == &ng_deadhook) {
948 } while (! atomic_cmpset_int(&hook->hk_refs, v, v - 1));
950 if (v == 1) { /* we were the last */
951 if (_NG_HOOK_NODE(hook)) { /* it'll probably be ng_deadnode */
952 _NG_NODE_UNREF((_NG_HOOK_NODE(hook)));
953 hook->hk_node = NULL;
960 * Add an unconnected hook to a node. Only used internally.
961 * Assumes node is locked. (XXX not yet true )
964 ng_add_hook(node_p node, const char *name, hook_p *hookp)
969 /* Check that the given name is good */
974 if (ng_findhook(node, name) != NULL) {
979 /* Allocate the hook and link it up */
985 hook->hk_refs = 1; /* add a reference for us to return */
986 hook->hk_flags = HK_INVALID;
987 hook->hk_peer = &ng_deadhook; /* start off this way */
988 hook->hk_node = node;
989 NG_NODE_REF(node); /* each hook counts as a reference */
992 strlcpy(NG_HOOK_NAME(hook), name, NG_HOOKSIZ);
995 * Check if the node type code has something to say about it
996 * If it fails, the unref of the hook will also unref the node.
998 if (node->nd_type->newhook != NULL) {
999 if ((error = (*node->nd_type->newhook)(node, hook, name))) {
1000 NG_HOOK_UNREF(hook); /* this frees the hook */
1005 * The 'type' agrees so far, so go ahead and link it in.
1006 * We'll ask again later when we actually connect the hooks.
1008 LIST_INSERT_HEAD(&node->nd_hooks, hook, hk_hooks);
1009 node->nd_numhooks++;
1010 NG_HOOK_REF(hook); /* one for the node */
1020 * Node types may supply their own optimized routines for finding
1021 * hooks. If none is supplied, we just do a linear search.
1022 * XXX Possibly we should add a reference to the hook?
1025 ng_findhook(node_p node, const char *name)
1029 if (node->nd_type->findhook != NULL)
1030 return (*node->nd_type->findhook)(node, name);
1031 LIST_FOREACH(hook, &node->nd_hooks, hk_hooks) {
1032 if (NG_HOOK_IS_VALID(hook)
1033 && (strcmp(NG_HOOK_NAME(hook), name) == 0))
1042 * As hooks are always attached, this really destroys two hooks.
1043 * The one given, and the one attached to it. Disconnect the hooks
1044 * from each other first. We reconnect the peer hook to the 'dead'
1045 * hook so that it can still exist after we depart. We then
1046 * send the peer its own destroy message. This ensures that we only
1047 * interact with the peer's structures when it is locked processing that
1048 * message. We hold a reference to the peer hook so we are guaranteed that
1049 * the peer hook and node are still going to exist until
1050 * we are finished there as the hook holds a ref on the node.
1051 * We run this same code again on the peer hook, but that time it is already
1052 * attached to the 'dead' hook.
1054 * This routine is called at all stages of hook creation
1055 * on error detection and must be able to handle any such stage.
1058 ng_destroy_hook(hook_p hook)
1063 if (hook == &ng_deadhook) { /* better safe than sorry */
1064 printf("ng_destroy_hook called on deadhook\n");
1069 * Protect divorce process with mutex, to avoid races on
1070 * simultaneous disconnect.
1072 mtx_lock(&ng_topo_mtx);
1074 hook->hk_flags |= HK_INVALID;
1076 peer = NG_HOOK_PEER(hook);
1077 node = NG_HOOK_NODE(hook);
1079 if (peer && (peer != &ng_deadhook)) {
1081 * Set the peer to point to ng_deadhook
1082 * from this moment on we are effectively independent it.
1083 * send it an rmhook message of it's own.
1085 peer->hk_peer = &ng_deadhook; /* They no longer know us */
1086 hook->hk_peer = &ng_deadhook; /* Nor us, them */
1087 if (NG_HOOK_NODE(peer) == &ng_deadnode) {
1089 * If it's already divorced from a node,
1092 mtx_unlock(&ng_topo_mtx);
1094 mtx_unlock(&ng_topo_mtx);
1095 ng_rmhook_self(peer); /* Send it a surprise */
1097 NG_HOOK_UNREF(peer); /* account for peer link */
1098 NG_HOOK_UNREF(hook); /* account for peer link */
1100 mtx_unlock(&ng_topo_mtx);
1102 mtx_assert(&ng_topo_mtx, MA_NOTOWNED);
1105 * Remove the hook from the node's list to avoid possible recursion
1106 * in case the disconnection results in node shutdown.
1108 if (node == &ng_deadnode) { /* happens if called from ng_con_nodes() */
1111 LIST_REMOVE(hook, hk_hooks);
1112 node->nd_numhooks--;
1113 if (node->nd_type->disconnect) {
1115 * The type handler may elect to destroy the node so don't
1116 * trust its existence after this point. (except
1117 * that we still hold a reference on it. (which we
1118 * inherrited from the hook we are destroying)
1120 (*node->nd_type->disconnect) (hook);
1124 * Note that because we will point to ng_deadnode, the original node
1125 * is not decremented automatically so we do that manually.
1127 _NG_HOOK_NODE(hook) = &ng_deadnode;
1128 NG_NODE_UNREF(node); /* We no longer point to it so adjust count */
1129 NG_HOOK_UNREF(hook); /* Account for linkage (in list) to node */
1133 * Take two hooks on a node and merge the connection so that the given node
1134 * is effectively bypassed.
1137 ng_bypass(hook_p hook1, hook_p hook2)
1139 if (hook1->hk_node != hook2->hk_node) {
1143 hook1->hk_peer->hk_peer = hook2->hk_peer;
1144 hook2->hk_peer->hk_peer = hook1->hk_peer;
1146 hook1->hk_peer = &ng_deadhook;
1147 hook2->hk_peer = &ng_deadhook;
1149 NG_HOOK_UNREF(hook1);
1150 NG_HOOK_UNREF(hook2);
1152 /* XXX If we ever cache methods on hooks update them as well */
1153 ng_destroy_hook(hook1);
1154 ng_destroy_hook(hook2);
1159 * Install a new netgraph type
1162 ng_newtype(struct ng_type *tp)
1164 const size_t namelen = strlen(tp->name);
1166 /* Check version and type name fields */
1167 if ((tp->version != NG_ABI_VERSION)
1169 || (namelen >= NG_TYPESIZ)) {
1171 if (tp->version != NG_ABI_VERSION) {
1172 printf("Netgraph: Node type rejected. ABI mismatch. Suggest recompile\n");
1177 /* Check for name collision */
1178 if (ng_findtype(tp->name) != NULL) {
1184 /* Link in new type */
1185 mtx_lock(&ng_typelist_mtx);
1186 LIST_INSERT_HEAD(&ng_typelist, tp, types);
1187 tp->refs = 1; /* first ref is linked list */
1188 mtx_unlock(&ng_typelist_mtx);
1193 * unlink a netgraph type
1194 * If no examples exist
1197 ng_rmtype(struct ng_type *tp)
1199 /* Check for name collision */
1200 if (tp->refs != 1) {
1206 mtx_lock(&ng_typelist_mtx);
1207 LIST_REMOVE(tp, types);
1208 mtx_unlock(&ng_typelist_mtx);
1213 * Look for a type of the name given
1216 ng_findtype(const char *typename)
1218 struct ng_type *type;
1220 mtx_lock(&ng_typelist_mtx);
1221 LIST_FOREACH(type, &ng_typelist, types) {
1222 if (strcmp(type->name, typename) == 0)
1225 mtx_unlock(&ng_typelist_mtx);
1229 /************************************************************************
1231 ************************************************************************/
1233 * Connect two nodes using the specified hooks, using queued functions.
1236 ng_con_part3(node_p node, item_p item, hook_p hook)
1241 * When we run, we know that the node 'node' is locked for us.
1242 * Our caller has a reference on the hook.
1243 * Our caller has a reference on the node.
1244 * (In this case our caller is ng_apply_item() ).
1245 * The peer hook has a reference on the hook.
1246 * We are all set up except for the final call to the node, and
1247 * the clearing of the INVALID flag.
1249 if (NG_HOOK_NODE(hook) == &ng_deadnode) {
1251 * The node must have been freed again since we last visited
1252 * here. ng_destry_hook() has this effect but nothing else does.
1253 * We should just release our references and
1254 * free anything we can think of.
1255 * Since we know it's been destroyed, and it's our caller
1256 * that holds the references, just return.
1260 if (hook->hk_node->nd_type->connect) {
1261 if ((error = (*hook->hk_node->nd_type->connect) (hook))) {
1262 ng_destroy_hook(hook); /* also zaps peer */
1263 printf("failed in ng_con_part3()\n");
1268 * XXX this is wrong for SMP. Possibly we need
1269 * to separate out 'create' and 'invalid' flags.
1270 * should only set flags on hooks we have locked under our node.
1272 hook->hk_flags &= ~HK_INVALID;
1279 ng_con_part2(node_p node, item_p item, hook_p hook)
1285 * When we run, we know that the node 'node' is locked for us.
1286 * Our caller has a reference on the hook.
1287 * Our caller has a reference on the node.
1288 * (In this case our caller is ng_apply_item() ).
1289 * The peer hook has a reference on the hook.
1290 * our node pointer points to the 'dead' node.
1291 * First check the hook name is unique.
1292 * Should not happen because we checked before queueing this.
1294 if (ng_findhook(node, NG_HOOK_NAME(hook)) != NULL) {
1296 ng_destroy_hook(hook); /* should destroy peer too */
1297 printf("failed in ng_con_part2()\n");
1301 * Check if the node type code has something to say about it
1302 * If it fails, the unref of the hook will also unref the attached node,
1303 * however since that node is 'ng_deadnode' this will do nothing.
1304 * The peer hook will also be destroyed.
1306 if (node->nd_type->newhook != NULL) {
1307 if ((error = (*node->nd_type->newhook)(node, hook,
1309 ng_destroy_hook(hook); /* should destroy peer too */
1310 printf("failed in ng_con_part2()\n");
1316 * The 'type' agrees so far, so go ahead and link it in.
1317 * We'll ask again later when we actually connect the hooks.
1319 hook->hk_node = node; /* just overwrite ng_deadnode */
1320 NG_NODE_REF(node); /* each hook counts as a reference */
1321 LIST_INSERT_HEAD(&node->nd_hooks, hook, hk_hooks);
1322 node->nd_numhooks++;
1323 NG_HOOK_REF(hook); /* one for the node */
1326 * We now have a symmetrical situation, where both hooks have been
1327 * linked to their nodes, the newhook methods have been called
1328 * And the references are all correct. The hooks are still marked
1329 * as invalid, as we have not called the 'connect' methods
1331 * We can call the local one immediately as we have the
1332 * node locked, but we need to queue the remote one.
1334 if (hook->hk_node->nd_type->connect) {
1335 if ((error = (*hook->hk_node->nd_type->connect) (hook))) {
1336 ng_destroy_hook(hook); /* also zaps peer */
1337 printf("failed in ng_con_part2(A)\n");
1343 * Acquire topo mutex to avoid race with ng_destroy_hook().
1345 mtx_lock(&ng_topo_mtx);
1346 peer = hook->hk_peer;
1347 if (peer == &ng_deadhook) {
1348 mtx_unlock(&ng_topo_mtx);
1349 printf("failed in ng_con_part2(B)\n");
1350 ng_destroy_hook(hook);
1353 mtx_unlock(&ng_topo_mtx);
1355 if ((error = ng_send_fn2(peer->hk_node, peer, item, &ng_con_part3,
1356 NULL, 0, NG_REUSE_ITEM))) {
1357 printf("failed in ng_con_part2(C)\n");
1358 ng_destroy_hook(hook); /* also zaps peer */
1359 return (error); /* item was consumed. */
1361 hook->hk_flags &= ~HK_INVALID; /* need both to be able to work */
1362 return (0); /* item was consumed. */
1369 * Connect this node with another node. We assume that this node is
1370 * currently locked, as we are only called from an NGM_CONNECT message.
1373 ng_con_nodes(item_p item, node_p node, const char *name,
1374 node_p node2, const char *name2)
1380 if (ng_findhook(node2, name2) != NULL) {
1383 if ((error = ng_add_hook(node, name, &hook))) /* gives us a ref */
1385 /* Allocate the other hook and link it up */
1386 NG_ALLOC_HOOK(hook2);
1387 if (hook2 == NULL) {
1389 ng_destroy_hook(hook); /* XXX check ref counts so far */
1390 NG_HOOK_UNREF(hook); /* including our ref */
1393 hook2->hk_refs = 1; /* start with a reference for us. */
1394 hook2->hk_flags = HK_INVALID;
1395 hook2->hk_peer = hook; /* Link the two together */
1396 hook->hk_peer = hook2;
1397 NG_HOOK_REF(hook); /* Add a ref for the peer to each*/
1399 hook2->hk_node = &ng_deadnode;
1400 strlcpy(NG_HOOK_NAME(hook2), name2, NG_HOOKSIZ);
1403 * Queue the function above.
1404 * Procesing continues in that function in the lock context of
1407 if ((error = ng_send_fn2(node2, hook2, item, &ng_con_part2, NULL, 0,
1409 printf("failed in ng_con_nodes(): %d\n", error);
1410 ng_destroy_hook(hook); /* also zaps peer */
1413 NG_HOOK_UNREF(hook); /* Let each hook go if it wants to */
1414 NG_HOOK_UNREF(hook2);
1419 * Make a peer and connect.
1420 * We assume that the local node is locked.
1421 * The new node probably doesn't need a lock until
1422 * it has a hook, because it cannot really have any work until then,
1423 * but we should think about it a bit more.
1425 * The problem may come if the other node also fires up
1426 * some hardware or a timer or some other source of activation,
1427 * also it may already get a command msg via it's ID.
1429 * We could use the same method as ng_con_nodes() but we'd have
1430 * to add ability to remove the node when failing. (Not hard, just
1431 * make arg1 point to the node to remove).
1432 * Unless of course we just ignore failure to connect and leave
1433 * an unconnected node?
1436 ng_mkpeer(node_p node, const char *name, const char *name2, char *type)
1439 hook_p hook1, hook2;
1442 if ((error = ng_make_node(type, &node2))) {
1446 if ((error = ng_add_hook(node, name, &hook1))) { /* gives us a ref */
1447 ng_rmnode(node2, NULL, NULL, 0);
1451 if ((error = ng_add_hook(node2, name2, &hook2))) {
1452 ng_rmnode(node2, NULL, NULL, 0);
1453 ng_destroy_hook(hook1);
1454 NG_HOOK_UNREF(hook1);
1459 * Actually link the two hooks together.
1461 hook1->hk_peer = hook2;
1462 hook2->hk_peer = hook1;
1464 /* Each hook is referenced by the other */
1468 /* Give each node the opportunity to veto the pending connection */
1469 if (hook1->hk_node->nd_type->connect) {
1470 error = (*hook1->hk_node->nd_type->connect) (hook1);
1473 if ((error == 0) && hook2->hk_node->nd_type->connect) {
1474 error = (*hook2->hk_node->nd_type->connect) (hook2);
1479 * drop the references we were holding on the two hooks.
1482 ng_destroy_hook(hook2); /* also zaps hook1 */
1483 ng_rmnode(node2, NULL, NULL, 0);
1485 /* As a last act, allow the hooks to be used */
1486 hook1->hk_flags &= ~HK_INVALID;
1487 hook2->hk_flags &= ~HK_INVALID;
1489 NG_HOOK_UNREF(hook1);
1490 NG_HOOK_UNREF(hook2);
1494 /************************************************************************
1495 Utility routines to send self messages
1496 ************************************************************************/
1498 /* Shut this node down as soon as everyone is clear of it */
1499 /* Should add arg "immediately" to jump the queue */
1501 ng_rmnode_self(node_p node)
1505 if (node == &ng_deadnode)
1507 node->nd_flags |= NGF_INVALID;
1508 if (node->nd_flags & NGF_CLOSING)
1511 error = ng_send_fn(node, NULL, &ng_rmnode, NULL, 0);
1516 ng_rmhook_part2(node_p node, hook_p hook, void *arg1, int arg2)
1518 ng_destroy_hook(hook);
1523 ng_rmhook_self(hook_p hook)
1526 node_p node = NG_HOOK_NODE(hook);
1528 if (node == &ng_deadnode)
1531 error = ng_send_fn(node, hook, &ng_rmhook_part2, NULL, 0);
1535 /***********************************************************************
1536 * Parse and verify a string of the form: <NODE:><PATH>
1538 * Such a string can refer to a specific node or a specific hook
1539 * on a specific node, depending on how you look at it. In the
1540 * latter case, the PATH component must not end in a dot.
1542 * Both <NODE:> and <PATH> are optional. The <PATH> is a string
1543 * of hook names separated by dots. This breaks out the original
1544 * string, setting *nodep to "NODE" (or NULL if none) and *pathp
1545 * to "PATH" (or NULL if degenerate). Also, *hookp will point to
1546 * the final hook component of <PATH>, if any, otherwise NULL.
1548 * This returns -1 if the path is malformed. The char ** are optional.
1549 ***********************************************************************/
1551 ng_path_parse(char *addr, char **nodep, char **pathp, char **hookp)
1553 char *node, *path, *hook;
1557 * Extract absolute NODE, if any
1559 for (path = addr; *path && *path != ':'; path++);
1561 node = addr; /* Here's the NODE */
1562 *path++ = '\0'; /* Here's the PATH */
1564 /* Node name must not be empty */
1568 /* A name of "." is OK; otherwise '.' not allowed */
1569 if (strcmp(node, ".") != 0) {
1570 for (k = 0; node[k]; k++)
1575 node = NULL; /* No absolute NODE */
1576 path = addr; /* Here's the PATH */
1579 /* Snoop for illegal characters in PATH */
1580 for (k = 0; path[k]; k++)
1584 /* Check for no repeated dots in PATH */
1585 for (k = 0; path[k]; k++)
1586 if (path[k] == '.' && path[k + 1] == '.')
1589 /* Remove extra (degenerate) dots from beginning or end of PATH */
1592 if (*path && path[strlen(path) - 1] == '.')
1593 path[strlen(path) - 1] = 0;
1595 /* If PATH has a dot, then we're not talking about a hook */
1597 for (hook = path, k = 0; path[k]; k++)
1598 if (path[k] == '.') {
1616 * Given a path, which may be absolute or relative, and a starting node,
1617 * return the destination node.
1620 ng_path2noderef(node_p here, const char *address,
1621 node_p *destp, hook_p *lasthook)
1623 char fullpath[NG_PATHSIZ];
1624 char *nodename, *path, pbuf[2];
1625 node_p node, oldnode;
1630 if (destp == NULL) {
1636 /* Make a writable copy of address for ng_path_parse() */
1637 strncpy(fullpath, address, sizeof(fullpath) - 1);
1638 fullpath[sizeof(fullpath) - 1] = '\0';
1640 /* Parse out node and sequence of hooks */
1641 if (ng_path_parse(fullpath, &nodename, &path, NULL) < 0) {
1646 pbuf[0] = '.'; /* Needs to be writable */
1652 * For an absolute address, jump to the starting node.
1653 * Note that this holds a reference on the node for us.
1654 * Don't forget to drop the reference if we don't need it.
1657 node = ng_name2noderef(here, nodename);
1672 * Now follow the sequence of hooks
1674 * We actually cannot guarantee that the sequence
1675 * is not being demolished as we crawl along it
1676 * without extra-ordinary locking etc.
1677 * So this is a bit dodgy to say the least.
1678 * We can probably hold up some things by holding
1679 * the nodelist mutex for the time of this
1680 * crawl if we wanted.. At least that way we wouldn't have to
1681 * worry about the nodes disappearing, but the hooks would still
1684 for (cp = path; node != NULL && *cp != '\0'; ) {
1688 * Break out the next path segment. Replace the dot we just
1689 * found with a NUL; "cp" points to the next segment (or the
1692 for (segment = cp; *cp != '\0'; cp++) {
1700 if (*segment == '\0')
1703 /* We have a segment, so look for a hook by that name */
1704 hook = ng_findhook(node, segment);
1706 /* Can't get there from here... */
1708 || NG_HOOK_PEER(hook) == NULL
1709 || NG_HOOK_NOT_VALID(hook)
1710 || NG_HOOK_NOT_VALID(NG_HOOK_PEER(hook))) {
1712 NG_NODE_UNREF(node);
1714 printf("hooknotvalid %s %s %d %d %d %d ",
1718 NG_HOOK_PEER(hook) == NULL,
1719 NG_HOOK_NOT_VALID(hook),
1720 NG_HOOK_NOT_VALID(NG_HOOK_PEER(hook)));
1726 * Hop on over to the next node
1728 * Big race conditions here as hooks and nodes go away
1729 * *** Idea.. store an ng_ID_t in each hook and use that
1730 * instead of the direct hook in this crawl?
1733 if ((node = NG_PEER_NODE(hook)))
1734 NG_NODE_REF(node); /* XXX RACE */
1735 NG_NODE_UNREF(oldnode); /* XXX another race */
1736 if (NG_NODE_NOT_VALID(node)) {
1737 NG_NODE_UNREF(node); /* XXX more races */
1742 /* If node somehow missing, fail here (probably this is not needed) */
1750 if (lasthook != NULL)
1751 *lasthook = (hook ? NG_HOOK_PEER(hook) : NULL);
1755 /***************************************************************\
1756 * Input queue handling.
1757 * All activities are submitted to the node via the input queue
1758 * which implements a multiple-reader/single-writer gate.
1759 * Items which cannot be handled immediately are queued.
1761 * read-write queue locking inline functions *
1762 \***************************************************************/
1764 static __inline item_p ng_dequeue(struct ng_queue * ngq, int *rw);
1765 static __inline item_p ng_acquire_read(struct ng_queue * ngq,
1767 static __inline item_p ng_acquire_write(struct ng_queue * ngq,
1769 static __inline void ng_leave_read(struct ng_queue * ngq);
1770 static __inline void ng_leave_write(struct ng_queue * ngq);
1771 static __inline void ng_queue_rw(struct ng_queue * ngq,
1772 item_p item, int rw);
1775 * Definition of the bits fields in the ng_queue flag word.
1776 * Defined here rather than in netgraph.h because no-one should fiddle
1779 * The ordering here may be important! don't shuffle these.
1782 Safety Barrier--------+ (adjustable to suit taste) (not used yet)
1785 +-------+-------+-------+-------+-------+-------+-------+-------+
1786 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
1787 | |A|c|t|i|v|e| |R|e|a|d|e|r| |C|o|u|n|t| | | | | | | | | |P|A|
1788 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |O|W|
1789 +-------+-------+-------+-------+-------+-------+-------+-------+
1790 \___________________________ ____________________________/ | |
1792 [active reader count] | |
1794 Operation Pending -------------------------------+ |
1796 Active Writer ---------------------------------------+
1800 #define WRITER_ACTIVE 0x00000001
1801 #define OP_PENDING 0x00000002
1802 #define READER_INCREMENT 0x00000004
1803 #define READER_MASK 0xfffffffc /* Not valid if WRITER_ACTIVE is set */
1804 #define SAFETY_BARRIER 0x00100000 /* 128K items queued should be enough */
1806 /* Defines of more elaborate states on the queue */
1807 /* Mask of bits a new read cares about */
1808 #define NGQ_RMASK (WRITER_ACTIVE|OP_PENDING)
1810 /* Mask of bits a new write cares about */
1811 #define NGQ_WMASK (NGQ_RMASK|READER_MASK)
1813 /* Test to decide if there is something on the queue. */
1814 #define QUEUE_ACTIVE(QP) ((QP)->q_flags & OP_PENDING)
1816 /* How to decide what the next queued item is. */
1817 #define HEAD_IS_READER(QP) NGI_QUEUED_READER((QP)->queue)
1818 #define HEAD_IS_WRITER(QP) NGI_QUEUED_WRITER((QP)->queue) /* notused */
1820 /* Read the status to decide if the next item on the queue can now run. */
1821 #define QUEUED_READER_CAN_PROCEED(QP) \
1822 (((QP)->q_flags & (NGQ_RMASK & ~OP_PENDING)) == 0)
1823 #define QUEUED_WRITER_CAN_PROCEED(QP) \
1824 (((QP)->q_flags & (NGQ_WMASK & ~OP_PENDING)) == 0)
1826 /* Is there a chance of getting ANY work off the queue? */
1827 #define NEXT_QUEUED_ITEM_CAN_PROCEED(QP) \
1828 (QUEUE_ACTIVE(QP) && \
1829 ((HEAD_IS_READER(QP)) ? QUEUED_READER_CAN_PROCEED(QP) : \
1830 QUEUED_WRITER_CAN_PROCEED(QP)))
1837 * Taking into account the current state of the queue and node, possibly take
1838 * the next entry off the queue and return it. Return NULL if there was
1839 * nothing we could return, either because there really was nothing there, or
1840 * because the node was in a state where it cannot yet process the next item
1843 * This MUST MUST MUST be called with the mutex held.
1845 static __inline item_p
1846 ng_dequeue(struct ng_queue *ngq, int *rw)
1851 mtx_assert(&ngq->q_mtx, MA_OWNED);
1853 * If there is nothing queued, then just return.
1854 * No point in continuing.
1855 * XXXGL: assert this?
1857 if (!QUEUE_ACTIVE(ngq)) {
1858 CTR4(KTR_NET, "%20s: node [%x] (%p) queue empty; "
1859 "queue flags 0x%lx", __func__,
1860 ngq->q_node->nd_ID, ngq->q_node, ngq->q_flags);
1865 * From here, we can assume there is a head item.
1866 * We need to find out what it is and if it can be dequeued, given
1867 * the current state of the node.
1869 if (HEAD_IS_READER(ngq)) {
1870 if (!QUEUED_READER_CAN_PROCEED(ngq)) {
1872 * It's a reader but we can't use it.
1873 * We are stalled so make sure we don't
1874 * get called again until something changes.
1876 ng_worklist_remove(ngq->q_node);
1877 CTR4(KTR_NET, "%20s: node [%x] (%p) queued reader "
1878 "can't proceed; queue flags 0x%lx", __func__,
1879 ngq->q_node->nd_ID, ngq->q_node, ngq->q_flags);
1883 * Head of queue is a reader and we have no write active.
1884 * We don't care how many readers are already active.
1885 * Add the correct increment for the reader count.
1887 add_arg = READER_INCREMENT;
1889 } else if (QUEUED_WRITER_CAN_PROCEED(ngq)) {
1891 * There is a pending write, no readers and no active writer.
1892 * This means we can go ahead with the pending writer. Note
1893 * the fact that we now have a writer, ready for when we take
1896 * We don't need to worry about a possible collision with the
1899 * The fasttrack thread may take a long time to discover that we
1900 * are running so we would have an inconsistent state in the
1901 * flags for a while. Since we ignore the reader count
1902 * entirely when the WRITER_ACTIVE flag is set, this should
1903 * not matter (in fact it is defined that way). If it tests
1904 * the flag before this operation, the OP_PENDING flag
1905 * will make it fail, and if it tests it later, the
1906 * WRITER_ACTIVE flag will do the same. If it is SO slow that
1907 * we have actually completed the operation, and neither flag
1908 * is set by the time that it tests the flags, then it is
1909 * actually ok for it to continue. If it completes and we've
1910 * finished and the read pending is set it still fails.
1912 * So we can just ignore it, as long as we can ensure that the
1913 * transition from WRITE_PENDING state to the WRITER_ACTIVE
1916 * After failing, first it will be held back by the mutex, then
1917 * when it can proceed, it will queue its request, then it
1918 * would arrive at this function. Usually it will have to
1919 * leave empty handed because the ACTIVE WRITER bit will be
1922 * Adjust the flags for the new active writer.
1924 add_arg = WRITER_ACTIVE;
1927 * We want to write "active writer, no readers " Now go make
1928 * it true. In fact there may be a number in the readers
1929 * count but we know it is not true and will be fixed soon.
1930 * We will fix the flags for the next pending entry in a
1935 * We can't dequeue anything.. return and say so. Probably we
1936 * have a write pending and the readers count is non zero. If
1937 * we got here because a reader hit us just at the wrong
1938 * moment with the fasttrack code, and put us in a strange
1939 * state, then it will be coming through in just a moment,
1940 * (just as soon as we release the mutex) and keep things
1942 * Make sure we remove ourselves from the work queue. It
1943 * would be a waste of effort to do all this again.
1945 ng_worklist_remove(ngq->q_node);
1946 CTR4(KTR_NET, "%20s: node [%x] (%p) can't dequeue anything; "
1947 "queue flags 0x%lx", __func__,
1948 ngq->q_node->nd_ID, ngq->q_node, ngq->q_flags);
1953 * Now we dequeue the request (whatever it may be) and correct the
1954 * pending flags and the next and last pointers.
1957 ngq->queue = item->el_next;
1958 CTR6(KTR_NET, "%20s: node [%x] (%p) dequeued item %p with flags 0x%lx; "
1959 "queue flags 0x%lx", __func__,
1960 ngq->q_node->nd_ID,ngq->q_node, item, item->el_flags, ngq->q_flags);
1961 if (ngq->last == &(item->el_next)) {
1963 * that was the last entry in the queue so set the 'last
1964 * pointer up correctly and make sure the pending flag is
1967 add_arg += -OP_PENDING;
1968 ngq->last = &(ngq->queue);
1970 * Whatever flag was set will be cleared and
1971 * the new acive field will be set by the add as well,
1972 * so we don't need to change add_arg.
1973 * But we know we don't need to be on the work list.
1975 atomic_add_long(&ngq->q_flags, add_arg);
1976 ng_worklist_remove(ngq->q_node);
1979 * Since there is still something on the queue
1980 * we don't need to change the PENDING flag.
1982 atomic_add_long(&ngq->q_flags, add_arg);
1984 * If we see more doable work, make sure we are
1985 * on the work queue.
1987 if (NEXT_QUEUED_ITEM_CAN_PROCEED(ngq)) {
1988 ng_setisr(ngq->q_node);
1991 CTR6(KTR_NET, "%20s: node [%x] (%p) returning item %p as %s; "
1992 "queue flags 0x%lx", __func__,
1993 ngq->q_node->nd_ID, ngq->q_node, item, *rw ? "WRITER" : "READER" ,
1999 * Queue a packet to be picked up by someone else.
2000 * We really don't care who, but we can't or don't want to hang around
2001 * to process it ourselves. We are probably an interrupt routine..
2002 * If the queue could be run, flag the netisr handler to start.
2004 static __inline void
2005 ng_queue_rw(struct ng_queue * ngq, item_p item, int rw)
2007 mtx_assert(&ngq->q_mtx, MA_OWNED);
2010 NGI_SET_WRITER(item);
2012 NGI_SET_READER(item);
2013 item->el_next = NULL; /* maybe not needed */
2015 CTR5(KTR_NET, "%20s: node [%x] (%p) queued item %p as %s", __func__,
2016 ngq->q_node->nd_ID, ngq->q_node, item, rw ? "WRITER" : "READER" );
2018 * If it was the first item in the queue then we need to
2019 * set the last pointer and the type flags.
2021 if (ngq->last == &(ngq->queue)) {
2022 atomic_add_long(&ngq->q_flags, OP_PENDING);
2023 CTR3(KTR_NET, "%20s: node [%x] (%p) set OP_PENDING", __func__,
2024 ngq->q_node->nd_ID, ngq->q_node);
2027 ngq->last = &(item->el_next);
2029 * We can take the worklist lock with the node locked
2030 * BUT NOT THE REVERSE!
2032 if (NEXT_QUEUED_ITEM_CAN_PROCEED(ngq))
2033 ng_setisr(ngq->q_node);
2038 * This function 'cheats' in that it first tries to 'grab' the use of the
2039 * node, without going through the mutex. We can do this becasue of the
2040 * semantics of the lock. The semantics include a clause that says that the
2041 * value of the readers count is invalid if the WRITER_ACTIVE flag is set. It
2042 * also says that the WRITER_ACTIVE flag cannot be set if the readers count
2043 * is not zero. Note that this talks about what is valid to SET the
2044 * WRITER_ACTIVE flag, because from the moment it is set, the value if the
2045 * reader count is immaterial, and not valid. The two 'pending' flags have a
2046 * similar effect, in that If they are orthogonal to the two active fields in
2047 * how they are set, but if either is set, the attempted 'grab' need to be
2048 * backed out because there is earlier work, and we maintain ordering in the
2049 * queue. The result of this is that the reader request can try obtain use of
2050 * the node with only a single atomic addition, and without any of the mutex
2051 * overhead. If this fails the operation degenerates to the same as for other
2055 static __inline item_p
2056 ng_acquire_read(struct ng_queue *ngq, item_p item)
2058 KASSERT(ngq != &ng_deadnode.nd_input_queue,
2059 ("%s: working on deadnode", __func__));
2061 /* ######### Hack alert ######### */
2062 atomic_add_long(&ngq->q_flags, READER_INCREMENT);
2063 if ((ngq->q_flags & NGQ_RMASK) == 0) {
2064 /* Successfully grabbed node */
2065 CTR4(KTR_NET, "%20s: node [%x] (%p) fast acquired item %p",
2066 __func__, ngq->q_node->nd_ID, ngq->q_node, item);
2069 /* undo the damage if we didn't succeed */
2070 atomic_subtract_long(&ngq->q_flags, READER_INCREMENT);
2072 /* ######### End Hack alert ######### */
2075 * Try again. Another processor (or interrupt for that matter) may
2076 * have removed the last queued item that was stopping us from
2077 * running, between the previous test, and the moment that we took
2078 * the mutex. (Or maybe a writer completed.)
2079 * Even if another fast-track reader hits during this period
2080 * we don't care as multiple readers is OK.
2082 if ((ngq->q_flags & NGQ_RMASK) == 0) {
2083 atomic_add_long(&ngq->q_flags, READER_INCREMENT);
2084 NG_QUEUE_UNLOCK(ngq);
2085 CTR4(KTR_NET, "%20s: node [%x] (%p) slow acquired item %p",
2086 __func__, ngq->q_node->nd_ID, ngq->q_node, item);
2091 * and queue the request for later.
2093 ng_queue_rw(ngq, item, NGQRW_R);
2094 NG_QUEUE_UNLOCK(ngq);
2099 static __inline item_p
2100 ng_acquire_write(struct ng_queue *ngq, item_p item)
2102 KASSERT(ngq != &ng_deadnode.nd_input_queue,
2103 ("%s: working on deadnode", __func__));
2108 * If there are no readers, no writer, and no pending packets, then
2109 * we can just go ahead. In all other situations we need to queue the
2112 if ((ngq->q_flags & NGQ_WMASK) == 0) {
2113 /* collision could happen *HERE* */
2114 atomic_add_long(&ngq->q_flags, WRITER_ACTIVE);
2115 NG_QUEUE_UNLOCK(ngq);
2116 if (ngq->q_flags & READER_MASK) {
2117 /* Collision with fast-track reader */
2118 atomic_subtract_long(&ngq->q_flags, WRITER_ACTIVE);
2121 CTR4(KTR_NET, "%20s: node [%x] (%p) acquired item %p",
2122 __func__, ngq->q_node->nd_ID, ngq->q_node, item);
2127 * and queue the request for later.
2129 ng_queue_rw(ngq, item, NGQRW_W);
2130 NG_QUEUE_UNLOCK(ngq);
2136 static __inline item_p
2137 ng_upgrade_write(struct ng_queue *ngq, item_p item)
2139 KASSERT(ngq != &ng_deadnode.nd_input_queue,
2140 ("%s: working on deadnode", __func__));
2142 NGI_SET_WRITER(item);
2144 mtx_lock_spin(&(ngq->q_mtx));
2147 * There will never be no readers as we are there ourselves.
2148 * Set the WRITER_ACTIVE flags ASAP to block out fast track readers.
2149 * The caller we are running from will call ng_leave_read()
2150 * soon, so we must account for that. We must leave again with the
2151 * READER lock. If we find other readers, then
2152 * queue the request for later. However "later" may be rignt now
2153 * if there are no readers. We don't really care if there are queued
2154 * items as we will bypass them anyhow.
2156 atomic_add_long(&ngq->q_flags, WRITER_ACTIVE - READER_INCREMENT);
2157 if (ngq->q_flags & (NGQ_WMASK & ~OP_PENDING) == WRITER_ACTIVE) {
2158 mtx_unlock_spin(&(ngq->q_mtx));
2160 /* It's just us, act on the item. */
2161 /* will NOT drop writer lock when done */
2162 ng_apply_item(node, item, 0);
2165 * Having acted on the item, atomically
2166 * down grade back to READER and finish up
2168 atomic_add_long(&ngq->q_flags,
2169 READER_INCREMENT - WRITER_ACTIVE);
2171 /* Our caller will call ng_leave_read() */
2175 * It's not just us active, so queue us AT THE HEAD.
2176 * "Why?" I hear you ask.
2177 * Put us at the head of the queue as we've already been
2178 * through it once. If there is nothing else waiting,
2179 * set the correct flags.
2181 if ((item->el_next = ngq->queue) == NULL) {
2183 * Set up the "last" pointer.
2184 * We are the only (and thus last) item
2186 ngq->last = &(item->el_next);
2188 /* We've gone from, 0 to 1 item in the queue */
2189 atomic_add_long(&ngq->q_flags, OP_PENDING);
2191 CTR3(KTR_NET, "%20s: node [%x] (%p) set OP_PENDING", __func__,
2192 ngq->q_node->nd_ID, ngq->q_node);
2195 CTR5(KTR_NET, "%20s: node [%x] (%p) requeued item %p as WRITER",
2196 __func__, ngq->q_node->nd_ID, ngq->q_node, item );
2198 /* Reverse what we did above. That downgrades us back to reader */
2199 atomic_add_long(&ngq->q_flags, READER_INCREMENT - WRITER_ACTIVE);
2200 if (NEXT_QUEUED_ITEM_CAN_PROCEED(ngq))
2201 ng_setisr(ngq->q_node);
2202 mtx_unlock_spin(&(ngq->q_mtx));
2209 static __inline void
2210 ng_leave_read(struct ng_queue *ngq)
2212 atomic_subtract_long(&ngq->q_flags, READER_INCREMENT);
2215 static __inline void
2216 ng_leave_write(struct ng_queue *ngq)
2218 atomic_subtract_long(&ngq->q_flags, WRITER_ACTIVE);
2222 ng_flush_input_queue(struct ng_queue * ngq)
2227 while (ngq->queue) {
2229 ngq->queue = item->el_next;
2230 if (ngq->last == &(item->el_next)) {
2231 ngq->last = &(ngq->queue);
2232 atomic_add_long(&ngq->q_flags, -OP_PENDING);
2234 NG_QUEUE_UNLOCK(ngq);
2236 /* If the item is supplying a callback, call it with an error */
2237 if (item->apply != NULL &&
2238 refcount_release(&item->apply->refs)) {
2239 (*item->apply->apply)(item->apply->context, ENOENT);
2245 * Take us off the work queue if we are there.
2246 * We definately have no work to be done.
2248 ng_worklist_remove(ngq->q_node);
2249 NG_QUEUE_UNLOCK(ngq);
2252 /***********************************************************************
2253 * Externally visible method for sending or queueing messages or data.
2254 ***********************************************************************/
2257 * The module code should have filled out the item correctly by this stage:
2259 * reference to destination node.
2260 * Reference to destination rcv hook if relevant.
2261 * apply pointer must be or NULL or reference valid struct ng_apply_info.
2266 * ID of original sender node. (return address)
2272 * The nodes have several routines and macros to help with this task:
2276 ng_snd_item(item_p item, int flags)
2281 struct ng_queue *ngq;
2286 return (EINVAL); /* failed to get queue element */
2289 #ifdef NETGRAPH_DEBUG
2290 _ngi_check(item, __FILE__, __LINE__);
2294 refcount_acquire(&item->apply->refs);
2296 node = NGI_NODE(item);
2299 ERROUT(EINVAL); /* No address */
2302 hook = NGI_HOOK(item);
2303 switch(item->el_flags & NGQF_TYPE) {
2307 * Delivered to a node via a non-optional hook.
2308 * Both should be present in the item even though
2309 * the node is derivable from the hook.
2310 * References are held on both by the item.
2313 /* Protect nodes from sending NULL pointers
2316 if (NGI_M(item) == NULL)
2319 CHECK_DATA_MBUF(NGI_M(item));
2324 if ((NG_HOOK_NOT_VALID(hook))
2325 || (NG_NODE_NOT_VALID(NG_HOOK_NODE(hook)))) {
2332 * Delivered to a node.
2334 * References are held by the item on the node and
2335 * the hook if it is present.
2345 switch(item->el_flags & NGQF_RW) {
2353 panic("%s: invalid item flags %lx", __func__, item->el_flags);
2357 * If the node specifies single threading, force writer semantics.
2358 * Similarly, the node may say one hook always produces writers.
2359 * These are overrides.
2361 if ((node->nd_flags & NGF_FORCE_WRITER)
2362 || (hook && (hook->hk_flags & HK_FORCE_WRITER)))
2366 * If sender or receiver requests queued delivery or stack usage
2367 * level is dangerous - enqueue message.
2370 if ((flags & NG_QUEUE) || (hook && (hook->hk_flags & HK_QUEUE))) {
2373 #ifdef GET_STACK_USAGE
2376 * Most of netgraph nodes has small stack consumption and
2377 * for them it is more then enogh 20% of free stack.
2378 * Nodes/hooks with higher stack usage should be marked as
2379 * HI_STACK. For them 50% of stack will be guarantied.
2380 * XXX: Values 50% (64/128) and 80% (100/128) are completely
2384 GET_STACK_USAGE(st, su);
2385 su = (su * 128) / st;
2387 ((su > 64) && ((node->nd_flags & NGF_HI_STACK) ||
2388 (hook && (hook->hk_flags & HK_HI_STACK))))) {
2394 ngq = &node->nd_input_queue;
2396 /* Put it on the queue for that node*/
2397 #ifdef NETGRAPH_DEBUG
2398 _ngi_check(item, __FILE__, __LINE__);
2401 ng_queue_rw(ngq, item, rw);
2402 NG_QUEUE_UNLOCK(ngq);
2404 if (flags & NG_PROGRESS)
2405 return (EINPROGRESS);
2411 * We already decided how we will be queueud or treated.
2412 * Try get the appropriate operating permission.
2415 item = ng_acquire_read(ngq, item);
2417 item = ng_acquire_write(ngq, item);
2421 if (flags & NG_PROGRESS)
2422 return (EINPROGRESS);
2427 #ifdef NETGRAPH_DEBUG
2428 _ngi_check(item, __FILE__, __LINE__);
2431 NGI_GET_NODE(item, node); /* zaps stored node */
2433 error = ng_apply_item(node, item, rw); /* drops r/w lock when done */
2436 * If the node goes away when we remove the reference,
2437 * whatever we just did caused it.. whatever we do, DO NOT
2438 * access the node again!
2440 if (NG_NODE_UNREF(node) == 0) {
2445 if (NEXT_QUEUED_ITEM_CAN_PROCEED(ngq))
2446 ng_setisr(ngq->q_node);
2447 NG_QUEUE_UNLOCK(ngq);
2452 /* Apply callback. */
2453 if (item->apply != NULL && refcount_release(&item->apply->refs))
2454 (*item->apply->apply)(item->apply->context, error);
2461 * We have an item that was possibly queued somewhere.
2462 * It should contain all the information needed
2463 * to run it on the appropriate node/hook.
2464 * If there is apply pointer and we own the last reference, call apply().
2467 ng_apply_item(node_p node, item_p item, int rw)
2471 ng_rcvdata_t *rcvdata;
2472 ng_rcvmsg_t *rcvmsg;
2473 struct ng_apply_info *apply;
2475 NGI_GET_HOOK(item, hook); /* clears stored hook */
2476 #ifdef NETGRAPH_DEBUG
2477 _ngi_check(item, __FILE__, __LINE__);
2480 apply = item->apply;
2482 switch (item->el_flags & NGQF_TYPE) {
2485 * Check things are still ok as when we were queued.
2488 || NG_HOOK_NOT_VALID(hook)
2489 || NG_NODE_NOT_VALID(node) ) {
2495 * If no receive method, just silently drop it.
2496 * Give preference to the hook over-ride method
2498 if ((!(rcvdata = hook->hk_rcvdata))
2499 && (!(rcvdata = NG_HOOK_NODE(hook)->nd_type->rcvdata))) {
2504 error = (*rcvdata)(hook, item);
2507 if (hook && NG_HOOK_NOT_VALID(hook)) {
2509 * The hook has been zapped then we can't use it.
2510 * Immediately drop its reference.
2511 * The message may not need it.
2513 NG_HOOK_UNREF(hook);
2517 * Similarly, if the node is a zombie there is
2518 * nothing we can do with it, drop everything.
2520 if (NG_NODE_NOT_VALID(node)) {
2527 * Call the appropriate message handler for the object.
2528 * It is up to the message handler to free the message.
2529 * If it's a generic message, handle it generically,
2530 * otherwise call the type's message handler (if it exists).
2531 * XXX (race). Remember that a queued message may
2532 * reference a node or hook that has just been
2533 * invalidated. It will exist as the queue code
2534 * is holding a reference, but..
2536 if ((NGI_MSG(item)->header.typecookie == NGM_GENERIC_COOKIE) &&
2537 ((NGI_MSG(item)->header.flags & NGF_RESP) == 0)) {
2538 error = ng_generic_msg(node, item, hook);
2541 if (((!hook) || (!(rcvmsg = hook->hk_rcvmsg))) &&
2542 (!(rcvmsg = node->nd_type->rcvmsg))) {
2548 error = (*rcvmsg)(node, item, hook);
2553 * We have to implicitly trust the hook,
2554 * as some of these are used for system purposes
2555 * where the hook is invalid. In the case of
2556 * the shutdown message we allow it to hit
2557 * even if the node is invalid.
2559 if ((NG_NODE_NOT_VALID(node))
2560 && (NGI_FN(item) != &ng_rmnode)) {
2566 if ((item->el_flags & NGQF_TYPE) == NGQF_FN) {
2567 (*NGI_FN(item))(node, hook, NGI_ARG1(item),
2570 } else /* it is NGQF_FN2 */
2571 error = (*NGI_FN2(item))(node, item, hook);
2575 * We held references on some of the resources
2576 * that we took from the item. Now that we have
2577 * finished doing everything, drop those references.
2580 NG_HOOK_UNREF(hook);
2582 if (rw == NGQRW_R) {
2583 ng_leave_read(&node->nd_input_queue);
2585 ng_leave_write(&node->nd_input_queue);
2588 /* Apply callback. */
2589 if (apply != NULL && refcount_release(&apply->refs))
2590 (*apply->apply)(apply->context, error);
2595 /***********************************************************************
2596 * Implement the 'generic' control messages
2597 ***********************************************************************/
2599 ng_generic_msg(node_p here, item_p item, hook_p lasthook)
2602 struct ng_mesg *msg;
2603 struct ng_mesg *resp = NULL;
2605 NGI_GET_MSG(item, msg);
2606 if (msg->header.typecookie != NGM_GENERIC_COOKIE) {
2611 switch (msg->header.cmd) {
2613 ng_rmnode(here, NULL, NULL, 0);
2617 struct ngm_mkpeer *const mkp = (struct ngm_mkpeer *) msg->data;
2619 if (msg->header.arglen != sizeof(*mkp)) {
2624 mkp->type[sizeof(mkp->type) - 1] = '\0';
2625 mkp->ourhook[sizeof(mkp->ourhook) - 1] = '\0';
2626 mkp->peerhook[sizeof(mkp->peerhook) - 1] = '\0';
2627 error = ng_mkpeer(here, mkp->ourhook, mkp->peerhook, mkp->type);
2632 struct ngm_connect *const con =
2633 (struct ngm_connect *) msg->data;
2636 if (msg->header.arglen != sizeof(*con)) {
2641 con->path[sizeof(con->path) - 1] = '\0';
2642 con->ourhook[sizeof(con->ourhook) - 1] = '\0';
2643 con->peerhook[sizeof(con->peerhook) - 1] = '\0';
2644 /* Don't forget we get a reference.. */
2645 error = ng_path2noderef(here, con->path, &node2, NULL);
2648 error = ng_con_nodes(item, here, con->ourhook,
2649 node2, con->peerhook);
2650 NG_NODE_UNREF(node2);
2655 struct ngm_name *const nam = (struct ngm_name *) msg->data;
2657 if (msg->header.arglen != sizeof(*nam)) {
2662 nam->name[sizeof(nam->name) - 1] = '\0';
2663 error = ng_name_node(here, nam->name);
2668 struct ngm_rmhook *const rmh = (struct ngm_rmhook *) msg->data;
2671 if (msg->header.arglen != sizeof(*rmh)) {
2676 rmh->ourhook[sizeof(rmh->ourhook) - 1] = '\0';
2677 if ((hook = ng_findhook(here, rmh->ourhook)) != NULL)
2678 ng_destroy_hook(hook);
2683 struct nodeinfo *ni;
2685 NG_MKRESPONSE(resp, msg, sizeof(*ni), M_NOWAIT);
2691 /* Fill in node info */
2692 ni = (struct nodeinfo *) resp->data;
2693 if (NG_NODE_HAS_NAME(here))
2694 strcpy(ni->name, NG_NODE_NAME(here));
2695 strcpy(ni->type, here->nd_type->name);
2696 ni->id = ng_node2ID(here);
2697 ni->hooks = here->nd_numhooks;
2702 const int nhooks = here->nd_numhooks;
2703 struct hooklist *hl;
2704 struct nodeinfo *ni;
2707 /* Get response struct */
2708 NG_MKRESPONSE(resp, msg, sizeof(*hl)
2709 + (nhooks * sizeof(struct linkinfo)), M_NOWAIT);
2714 hl = (struct hooklist *) resp->data;
2717 /* Fill in node info */
2718 if (NG_NODE_HAS_NAME(here))
2719 strcpy(ni->name, NG_NODE_NAME(here));
2720 strcpy(ni->type, here->nd_type->name);
2721 ni->id = ng_node2ID(here);
2723 /* Cycle through the linked list of hooks */
2725 LIST_FOREACH(hook, &here->nd_hooks, hk_hooks) {
2726 struct linkinfo *const link = &hl->link[ni->hooks];
2728 if (ni->hooks >= nhooks) {
2729 log(LOG_ERR, "%s: number of %s changed\n",
2733 if (NG_HOOK_NOT_VALID(hook))
2735 strcpy(link->ourhook, NG_HOOK_NAME(hook));
2736 strcpy(link->peerhook, NG_PEER_HOOK_NAME(hook));
2737 if (NG_PEER_NODE_NAME(hook)[0] != '\0')
2738 strcpy(link->nodeinfo.name,
2739 NG_PEER_NODE_NAME(hook));
2740 strcpy(link->nodeinfo.type,
2741 NG_PEER_NODE(hook)->nd_type->name);
2742 link->nodeinfo.id = ng_node2ID(NG_PEER_NODE(hook));
2743 link->nodeinfo.hooks = NG_PEER_NODE(hook)->nd_numhooks;
2752 const int unnamed = (msg->header.cmd == NGM_LISTNODES);
2753 struct namelist *nl;
2757 mtx_lock(&ng_nodelist_mtx);
2758 /* Count number of nodes */
2759 LIST_FOREACH(node, &ng_nodelist, nd_nodes) {
2760 if (NG_NODE_IS_VALID(node)
2761 && (unnamed || NG_NODE_HAS_NAME(node))) {
2765 mtx_unlock(&ng_nodelist_mtx);
2767 /* Get response struct */
2768 NG_MKRESPONSE(resp, msg, sizeof(*nl)
2769 + (num * sizeof(struct nodeinfo)), M_NOWAIT);
2774 nl = (struct namelist *) resp->data;
2776 /* Cycle through the linked list of nodes */
2778 mtx_lock(&ng_nodelist_mtx);
2779 LIST_FOREACH(node, &ng_nodelist, nd_nodes) {
2780 struct nodeinfo *const np = &nl->nodeinfo[nl->numnames];
2782 if (NG_NODE_NOT_VALID(node))
2784 if (!unnamed && (! NG_NODE_HAS_NAME(node)))
2786 if (nl->numnames >= num) {
2787 log(LOG_ERR, "%s: number of %s changed\n",
2791 if (NG_NODE_HAS_NAME(node))
2792 strcpy(np->name, NG_NODE_NAME(node));
2793 strcpy(np->type, node->nd_type->name);
2794 np->id = ng_node2ID(node);
2795 np->hooks = node->nd_numhooks;
2798 mtx_unlock(&ng_nodelist_mtx);
2804 struct typelist *tl;
2805 struct ng_type *type;
2808 mtx_lock(&ng_typelist_mtx);
2809 /* Count number of types */
2810 LIST_FOREACH(type, &ng_typelist, types) {
2813 mtx_unlock(&ng_typelist_mtx);
2815 /* Get response struct */
2816 NG_MKRESPONSE(resp, msg, sizeof(*tl)
2817 + (num * sizeof(struct typeinfo)), M_NOWAIT);
2822 tl = (struct typelist *) resp->data;
2824 /* Cycle through the linked list of types */
2826 mtx_lock(&ng_typelist_mtx);
2827 LIST_FOREACH(type, &ng_typelist, types) {
2828 struct typeinfo *const tp = &tl->typeinfo[tl->numtypes];
2830 if (tl->numtypes >= num) {
2831 log(LOG_ERR, "%s: number of %s changed\n",
2835 strcpy(tp->type_name, type->name);
2836 tp->numnodes = type->refs - 1; /* don't count list */
2839 mtx_unlock(&ng_typelist_mtx);
2843 case NGM_BINARY2ASCII:
2845 int bufSize = 20 * 1024; /* XXX hard coded constant */
2846 const struct ng_parse_type *argstype;
2847 const struct ng_cmdlist *c;
2848 struct ng_mesg *binary, *ascii;
2850 /* Data area must contain a valid netgraph message */
2851 binary = (struct ng_mesg *)msg->data;
2852 if (msg->header.arglen < sizeof(struct ng_mesg) ||
2853 (msg->header.arglen - sizeof(struct ng_mesg) <
2854 binary->header.arglen)) {
2860 /* Get a response message with lots of room */
2861 NG_MKRESPONSE(resp, msg, sizeof(*ascii) + bufSize, M_NOWAIT);
2866 ascii = (struct ng_mesg *)resp->data;
2868 /* Copy binary message header to response message payload */
2869 bcopy(binary, ascii, sizeof(*binary));
2871 /* Find command by matching typecookie and command number */
2872 for (c = here->nd_type->cmdlist;
2873 c != NULL && c->name != NULL; c++) {
2874 if (binary->header.typecookie == c->cookie
2875 && binary->header.cmd == c->cmd)
2878 if (c == NULL || c->name == NULL) {
2879 for (c = ng_generic_cmds; c->name != NULL; c++) {
2880 if (binary->header.typecookie == c->cookie
2881 && binary->header.cmd == c->cmd)
2884 if (c->name == NULL) {
2891 /* Convert command name to ASCII */
2892 snprintf(ascii->header.cmdstr, sizeof(ascii->header.cmdstr),
2895 /* Convert command arguments to ASCII */
2896 argstype = (binary->header.flags & NGF_RESP) ?
2897 c->respType : c->mesgType;
2898 if (argstype == NULL) {
2899 *ascii->data = '\0';
2901 if ((error = ng_unparse(argstype,
2902 (u_char *)binary->data,
2903 ascii->data, bufSize)) != 0) {
2909 /* Return the result as struct ng_mesg plus ASCII string */
2910 bufSize = strlen(ascii->data) + 1;
2911 ascii->header.arglen = bufSize;
2912 resp->header.arglen = sizeof(*ascii) + bufSize;
2916 case NGM_ASCII2BINARY:
2918 int bufSize = 2000; /* XXX hard coded constant */
2919 const struct ng_cmdlist *c;
2920 const struct ng_parse_type *argstype;
2921 struct ng_mesg *ascii, *binary;
2924 /* Data area must contain at least a struct ng_mesg + '\0' */
2925 ascii = (struct ng_mesg *)msg->data;
2926 if ((msg->header.arglen < sizeof(*ascii) + 1) ||
2927 (ascii->header.arglen < 1) ||
2928 (msg->header.arglen < sizeof(*ascii) +
2929 ascii->header.arglen)) {
2934 ascii->data[ascii->header.arglen - 1] = '\0';
2936 /* Get a response message with lots of room */
2937 NG_MKRESPONSE(resp, msg, sizeof(*binary) + bufSize, M_NOWAIT);
2942 binary = (struct ng_mesg *)resp->data;
2944 /* Copy ASCII message header to response message payload */
2945 bcopy(ascii, binary, sizeof(*ascii));
2947 /* Find command by matching ASCII command string */
2948 for (c = here->nd_type->cmdlist;
2949 c != NULL && c->name != NULL; c++) {
2950 if (strcmp(ascii->header.cmdstr, c->name) == 0)
2953 if (c == NULL || c->name == NULL) {
2954 for (c = ng_generic_cmds; c->name != NULL; c++) {
2955 if (strcmp(ascii->header.cmdstr, c->name) == 0)
2958 if (c->name == NULL) {
2965 /* Convert command name to binary */
2966 binary->header.cmd = c->cmd;
2967 binary->header.typecookie = c->cookie;
2969 /* Convert command arguments to binary */
2970 argstype = (binary->header.flags & NGF_RESP) ?
2971 c->respType : c->mesgType;
2972 if (argstype == NULL) {
2975 if ((error = ng_parse(argstype, ascii->data,
2976 &off, (u_char *)binary->data, &bufSize)) != 0) {
2982 /* Return the result */
2983 binary->header.arglen = bufSize;
2984 resp->header.arglen = sizeof(*binary) + bufSize;
2988 case NGM_TEXT_CONFIG:
2989 case NGM_TEXT_STATUS:
2991 * This one is tricky as it passes the command down to the
2992 * actual node, even though it is a generic type command.
2993 * This means we must assume that the item/msg is already freed
2994 * when control passes back to us.
2996 if (here->nd_type->rcvmsg != NULL) {
2997 NGI_MSG(item) = msg; /* put it back as we found it */
2998 return((*here->nd_type->rcvmsg)(here, item, lasthook));
3000 /* Fall through if rcvmsg not supported */
3006 * Sometimes a generic message may be statically allocated
3007 * to avoid problems with allocating when in tight memeory situations.
3008 * Don't free it if it is so.
3009 * I break them appart here, because erros may cause a free if the item
3010 * in which case we'd be doing it twice.
3011 * they are kept together above, to simplify freeing.
3014 NG_RESPOND_MSG(error, here, item, resp);
3020 /************************************************************************
3021 Queue element get/free routines
3022 ************************************************************************/
3024 uma_zone_t ng_qzone;
3025 static int maxalloc = 512; /* limit the damage of a leak */
3027 TUNABLE_INT("net.graph.maxalloc", &maxalloc);
3028 SYSCTL_INT(_net_graph, OID_AUTO, maxalloc, CTLFLAG_RDTUN, &maxalloc,
3029 0, "Maximum number of queue items to allocate");
3031 #ifdef NETGRAPH_DEBUG
3032 static TAILQ_HEAD(, ng_item) ng_itemlist = TAILQ_HEAD_INITIALIZER(ng_itemlist);
3033 static int allocated; /* number of items malloc'd */
3037 * Get a queue entry.
3038 * This is usually called when a packet first enters netgraph.
3039 * By definition, this is usually from an interrupt, or from a user.
3040 * Users are not so important, but try be quick for the times that it's
3043 static __inline item_p
3044 ng_getqblk(int flags)
3049 wait = (flags & NG_WAITOK) ? M_WAITOK : M_NOWAIT;
3051 item = uma_zalloc(ng_qzone, wait | M_ZERO);
3053 #ifdef NETGRAPH_DEBUG
3056 TAILQ_INSERT_TAIL(&ng_itemlist, item, all);
3058 mtx_unlock(&ngq_mtx);
3066 * Release a queue entry
3069 ng_free_item(item_p item)
3072 * The item may hold resources on it's own. We need to free
3073 * these before we can free the item. What they are depends upon
3074 * what kind of item it is. it is important that nodes zero
3075 * out pointers to resources that they remove from the item
3076 * or we release them again here.
3078 switch (item->el_flags & NGQF_TYPE) {
3080 /* If we have an mbuf still attached.. */
3081 NG_FREE_M(_NGI_M(item));
3084 _NGI_RETADDR(item) = 0;
3085 NG_FREE_MSG(_NGI_MSG(item));
3089 /* nothing to free really, */
3090 _NGI_FN(item) = NULL;
3091 _NGI_ARG1(item) = NULL;
3092 _NGI_ARG2(item) = 0;
3095 /* If we still have a node or hook referenced... */
3096 _NGI_CLR_NODE(item);
3097 _NGI_CLR_HOOK(item);
3099 #ifdef NETGRAPH_DEBUG
3101 TAILQ_REMOVE(&ng_itemlist, item, all);
3103 mtx_unlock(&ngq_mtx);
3105 uma_zfree(ng_qzone, item);
3108 /************************************************************************
3110 ************************************************************************/
3113 * Handle the loading/unloading of a netgraph node type module
3116 ng_mod_event(module_t mod, int event, void *data)
3118 struct ng_type *const type = data;
3124 /* Register new netgraph node type */
3126 if ((error = ng_newtype(type)) != 0) {
3131 /* Call type specific code */
3132 if (type->mod_event != NULL)
3133 if ((error = (*type->mod_event)(mod, event, data))) {
3134 mtx_lock(&ng_typelist_mtx);
3135 type->refs--; /* undo it */
3136 LIST_REMOVE(type, types);
3137 mtx_unlock(&ng_typelist_mtx);
3144 if (type->refs > 1) { /* make sure no nodes exist! */
3147 if (type->refs == 0) {
3148 /* failed load, nothing to undo */
3152 if (type->mod_event != NULL) { /* check with type */
3153 error = (*type->mod_event)(mod, event, data);
3154 if (error != 0) { /* type refuses.. */
3159 mtx_lock(&ng_typelist_mtx);
3160 LIST_REMOVE(type, types);
3161 mtx_unlock(&ng_typelist_mtx);
3167 if (type->mod_event != NULL)
3168 error = (*type->mod_event)(mod, event, data);
3170 error = EOPNOTSUPP; /* XXX ? */
3177 * Handle loading and unloading for this code.
3178 * The only thing we need to link into is the NETISR strucure.
3181 ngb_mod_event(module_t mod, int event, void *data)
3187 /* Initialize everything. */
3188 NG_WORKLIST_LOCK_INIT();
3189 mtx_init(&ng_typelist_mtx, "netgraph types mutex", NULL,
3191 mtx_init(&ng_nodelist_mtx, "netgraph nodelist mutex", NULL,
3193 mtx_init(&ng_idhash_mtx, "netgraph idhash mutex", NULL,
3195 mtx_init(&ng_topo_mtx, "netgraph topology mutex", NULL,
3197 #ifdef NETGRAPH_DEBUG
3198 mtx_init(&ngq_mtx, "netgraph item list mutex", NULL,
3201 ng_qzone = uma_zcreate("NetGraph items", sizeof(struct ng_item),
3202 NULL, NULL, NULL, NULL, UMA_ALIGN_CACHE, 0);
3203 uma_zone_set_max(ng_qzone, maxalloc);
3204 netisr_register(NETISR_NETGRAPH, (netisr_t *)ngintr, NULL,
3208 /* You can't unload it because an interface may be using it. */
3218 static moduledata_t netgraph_mod = {
3223 DECLARE_MODULE(netgraph, netgraph_mod, SI_SUB_NETGRAPH, SI_ORDER_MIDDLE);
3224 SYSCTL_NODE(_net, OID_AUTO, graph, CTLFLAG_RW, 0, "netgraph Family");
3225 SYSCTL_INT(_net_graph, OID_AUTO, abi_version, CTLFLAG_RD, 0, NG_ABI_VERSION,"");
3226 SYSCTL_INT(_net_graph, OID_AUTO, msg_version, CTLFLAG_RD, 0, NG_VERSION, "");
3228 #ifdef NETGRAPH_DEBUG
3230 dumphook (hook_p hook, char *file, int line)
3232 printf("hook: name %s, %d refs, Last touched:\n",
3233 _NG_HOOK_NAME(hook), hook->hk_refs);
3234 printf(" Last active @ %s, line %d\n",
3235 hook->lastfile, hook->lastline);
3237 printf(" problem discovered at file %s, line %d\n", file, line);
3242 dumpnode(node_p node, char *file, int line)
3244 printf("node: ID [%x]: type '%s', %d hooks, flags 0x%x, %d refs, %s:\n",
3245 _NG_NODE_ID(node), node->nd_type->name,
3246 node->nd_numhooks, node->nd_flags,
3247 node->nd_refs, node->nd_name);
3248 printf(" Last active @ %s, line %d\n",
3249 node->lastfile, node->lastline);
3251 printf(" problem discovered at file %s, line %d\n", file, line);
3256 dumpitem(item_p item, char *file, int line)
3258 printf(" ACTIVE item, last used at %s, line %d",
3259 item->lastfile, item->lastline);
3260 switch(item->el_flags & NGQF_TYPE) {
3262 printf(" - [data]\n");
3265 printf(" - retaddr[%d]:\n", _NGI_RETADDR(item));
3268 printf(" - fn@%p (%p, %p, %p, %d (%x))\n",
3272 item->body.fn.fn_arg1,
3273 item->body.fn.fn_arg2,
3274 item->body.fn.fn_arg2);
3277 printf(" - fn2@%p (%p, %p, %p, %d (%x))\n",
3281 item->body.fn.fn_arg1,
3282 item->body.fn.fn_arg2,
3283 item->body.fn.fn_arg2);
3287 printf(" problem discovered at file %s, line %d\n", file, line);
3288 if (_NGI_NODE(item)) {
3289 printf("node %p ([%x])\n",
3290 _NGI_NODE(item), ng_node2ID(_NGI_NODE(item)));
3300 TAILQ_FOREACH(item, &ng_itemlist, all) {
3301 printf("[%d] ", i++);
3302 dumpitem(item, NULL, 0);
3311 mtx_lock(&ng_nodelist_mtx);
3312 SLIST_FOREACH(node, &ng_allnodes, nd_all) {
3313 printf("[%d] ", i++);
3314 dumpnode(node, NULL, 0);
3316 mtx_unlock(&ng_nodelist_mtx);
3324 mtx_lock(&ng_nodelist_mtx);
3325 SLIST_FOREACH(hook, &ng_allhooks, hk_all) {
3326 printf("[%d] ", i++);
3327 dumphook(hook, NULL, 0);
3329 mtx_unlock(&ng_nodelist_mtx);
3333 sysctl_debug_ng_dump_items(SYSCTL_HANDLER_ARGS)
3341 error = sysctl_handle_int(oidp, &val, 0, req);
3342 if (error != 0 || req->newptr == NULL)
3352 SYSCTL_PROC(_debug, OID_AUTO, ng_dump_items, CTLTYPE_INT | CTLFLAG_RW,
3353 0, sizeof(int), sysctl_debug_ng_dump_items, "I", "Number of allocated items");
3354 #endif /* NETGRAPH_DEBUG */
3357 /***********************************************************************
3359 **********************************************************************/
3360 /* NETISR thread enters here */
3362 * Pick a node off the list of nodes with work,
3363 * try get an item to process off it.
3364 * If there are no more, remove the node from the list.
3374 node = TAILQ_FIRST(&ng_worklist);
3376 NG_WORKLIST_UNLOCK();
3379 node->nd_flags &= ~NGF_WORKQ;
3380 TAILQ_REMOVE(&ng_worklist, node, nd_work);
3381 NG_WORKLIST_UNLOCK();
3382 CTR3(KTR_NET, "%20s: node [%x] (%p) taken off worklist",
3383 __func__, node->nd_ID, node);
3385 * We have the node. We also take over the reference
3386 * that the list had on it.
3387 * Now process as much as you can, until it won't
3388 * let you have another item off the queue.
3389 * All this time, keep the reference
3390 * that lets us be sure that the node still exists.
3391 * Let the reference go at the last minute.
3392 * ng_dequeue will put us back on the worklist
3393 * if there is more too do. This may be of use if there
3394 * are Multiple Processors and multiple Net threads in the
3400 NG_QUEUE_LOCK(&node->nd_input_queue);
3401 item = ng_dequeue(&node->nd_input_queue, &rw);
3403 NG_QUEUE_UNLOCK(&node->nd_input_queue);
3404 break; /* go look for another node */
3406 NG_QUEUE_UNLOCK(&node->nd_input_queue);
3407 NGI_GET_NODE(item, node); /* zaps stored node */
3408 ng_apply_item(node, item, rw);
3409 NG_NODE_UNREF(node);
3412 NG_NODE_UNREF(node);
3417 ng_worklist_remove(node_p node)
3419 mtx_assert(&node->nd_input_queue.q_mtx, MA_OWNED);
3422 if (node->nd_flags & NGF_WORKQ) {
3423 node->nd_flags &= ~NGF_WORKQ;
3424 TAILQ_REMOVE(&ng_worklist, node, nd_work);
3425 NG_WORKLIST_UNLOCK();
3426 NG_NODE_UNREF(node);
3427 CTR3(KTR_NET, "%20s: node [%x] (%p) removed from worklist",
3428 __func__, node->nd_ID, node);
3430 NG_WORKLIST_UNLOCK();
3436 * It's posible that a debugging NG_NODE_REF may need
3437 * to be outside the mutex zone
3440 ng_setisr(node_p node)
3443 mtx_assert(&node->nd_input_queue.q_mtx, MA_OWNED);
3445 if ((node->nd_flags & NGF_WORKQ) == 0) {
3447 * If we are not already on the work queue,
3450 node->nd_flags |= NGF_WORKQ;
3452 TAILQ_INSERT_TAIL(&ng_worklist, node, nd_work);
3453 NG_WORKLIST_UNLOCK();
3454 NG_NODE_REF(node); /* XXX fafe in mutex? */
3455 CTR3(KTR_NET, "%20s: node [%x] (%p) put on worklist", __func__,
3458 CTR3(KTR_NET, "%20s: node [%x] (%p) already on worklist",
3459 __func__, node->nd_ID, node);
3460 schednetisr(NETISR_NETGRAPH);
3464 /***********************************************************************
3465 * Externally useable functions to set up a queue item ready for sending
3466 ***********************************************************************/
3468 #ifdef NETGRAPH_DEBUG
3469 #define ITEM_DEBUG_CHECKS \
3471 if (NGI_NODE(item) ) { \
3472 printf("item already has node"); \
3473 kdb_enter(KDB_WHY_NETGRAPH, "has node"); \
3474 NGI_CLR_NODE(item); \
3476 if (NGI_HOOK(item) ) { \
3477 printf("item already has hook"); \
3478 kdb_enter(KDB_WHY_NETGRAPH, "has hook"); \
3479 NGI_CLR_HOOK(item); \
3483 #define ITEM_DEBUG_CHECKS
3487 * Put mbuf into the item.
3488 * Hook and node references will be removed when the item is dequeued.
3490 * (XXX) Unsafe because no reference held by peer on remote node.
3491 * remote node might go away in this timescale.
3492 * We know the hooks can't go away because that would require getting
3493 * a writer item on both nodes and we must have at least a reader
3494 * here to be able to do this.
3495 * Note that the hook loaded is the REMOTE hook.
3497 * This is possibly in the critical path for new data.
3500 ng_package_data(struct mbuf *m, int flags)
3504 if ((item = ng_getqblk(flags)) == NULL) {
3509 item->el_flags = NGQF_DATA | NGQF_READER;
3510 item->el_next = NULL;
3516 * Allocate a queue item and put items into it..
3517 * Evaluate the address as this will be needed to queue it and
3518 * to work out what some of the fields should be.
3519 * Hook and node references will be removed when the item is dequeued.
3523 ng_package_msg(struct ng_mesg *msg, int flags)
3527 if ((item = ng_getqblk(flags)) == NULL) {
3532 /* Messages items count as writers unless explicitly exempted. */
3533 if (msg->header.cmd & NGM_READONLY)
3534 item->el_flags = NGQF_MESG | NGQF_READER;
3536 item->el_flags = NGQF_MESG | NGQF_WRITER;
3537 item->el_next = NULL;
3539 * Set the current lasthook into the queue item
3541 NGI_MSG(item) = msg;
3542 NGI_RETADDR(item) = 0;
3548 #define SET_RETADDR(item, here, retaddr) \
3549 do { /* Data or fn items don't have retaddrs */ \
3550 if ((item->el_flags & NGQF_TYPE) == NGQF_MESG) { \
3552 NGI_RETADDR(item) = retaddr; \
3555 * The old return address should be ok. \
3556 * If there isn't one, use the address \
3559 if (NGI_RETADDR(item) == 0) { \
3561 = ng_node2ID(here); \
3568 ng_address_hook(node_p here, item_p item, hook_p hook, ng_ID_t retaddr)
3574 * Quick sanity check..
3575 * Since a hook holds a reference on it's node, once we know
3576 * that the peer is still connected (even if invalid,) we know
3577 * that the peer node is present, though maybe invalid.
3580 || NG_HOOK_NOT_VALID(hook)
3581 || (NG_HOOK_PEER(hook) == NULL)
3582 || NG_HOOK_NOT_VALID(NG_HOOK_PEER(hook))
3583 || NG_NODE_NOT_VALID(NG_PEER_NODE(hook))) {
3590 * Transfer our interest to the other (peer) end.
3592 peer = NG_HOOK_PEER(hook);
3594 NGI_SET_HOOK(item, peer);
3595 peernode = NG_PEER_NODE(hook);
3596 NG_NODE_REF(peernode);
3597 NGI_SET_NODE(item, peernode);
3598 SET_RETADDR(item, here, retaddr);
3603 ng_address_path(node_p here, item_p item, char *address, ng_ID_t retaddr)
3611 * Note that ng_path2noderef increments the reference count
3612 * on the node for us if it finds one. So we don't have to.
3614 error = ng_path2noderef(here, address, &dest, &hook);
3619 NGI_SET_NODE(item, dest);
3621 NG_HOOK_REF(hook); /* don't let it go while on the queue */
3622 NGI_SET_HOOK(item, hook);
3624 SET_RETADDR(item, here, retaddr);
3629 ng_address_ID(node_p here, item_p item, ng_ID_t ID, ng_ID_t retaddr)
3635 * Find the target node.
3637 dest = ng_ID2noderef(ID); /* GETS REFERENCE! */
3643 /* Fill out the contents */
3644 NGI_SET_NODE(item, dest);
3646 SET_RETADDR(item, here, retaddr);
3651 * special case to send a message to self (e.g. destroy node)
3652 * Possibly indicate an arrival hook too.
3653 * Useful for removing that hook :-)
3656 ng_package_msg_self(node_p here, hook_p hook, struct ng_mesg *msg)
3661 * Find the target node.
3662 * If there is a HOOK argument, then use that in preference
3665 if ((item = ng_getqblk(NG_NOFLAGS)) == NULL) {
3670 /* Fill out the contents */
3671 item->el_flags = NGQF_MESG | NGQF_WRITER;
3672 item->el_next = NULL;
3674 NGI_SET_NODE(item, here);
3677 NGI_SET_HOOK(item, hook);
3679 NGI_MSG(item) = msg;
3680 NGI_RETADDR(item) = ng_node2ID(here);
3685 * Send ng_item_fn function call to the specified node.
3689 ng_send_fn(node_p node, hook_p hook, ng_item_fn *fn, void * arg1, int arg2)
3692 return ng_send_fn1(node, hook, fn, arg1, arg2, NG_NOFLAGS);
3696 ng_send_fn1(node_p node, hook_p hook, ng_item_fn *fn, void * arg1, int arg2,
3701 if ((item = ng_getqblk(flags)) == NULL) {
3704 item->el_flags = NGQF_FN | NGQF_WRITER;
3705 NG_NODE_REF(node); /* and one for the item */
3706 NGI_SET_NODE(item, node);
3709 NGI_SET_HOOK(item, hook);
3712 NGI_ARG1(item) = arg1;
3713 NGI_ARG2(item) = arg2;
3714 return(ng_snd_item(item, flags));
3718 * Send ng_item_fn2 function call to the specified node.
3720 * If an optional pitem parameter is supplied, its apply
3721 * callback will be copied to the new item. If also NG_REUSE_ITEM
3722 * flag is set, no new item will be allocated, but pitem will
3726 ng_send_fn2(node_p node, hook_p hook, item_p pitem, ng_item_fn2 *fn, void *arg1,
3727 int arg2, int flags)
3731 KASSERT((pitem != NULL || (flags & NG_REUSE_ITEM) == 0),
3732 ("%s: NG_REUSE_ITEM but no pitem", __func__));
3735 * Allocate a new item if no supplied or
3736 * if we can't use supplied one.
3738 if (pitem == NULL || (flags & NG_REUSE_ITEM) == 0) {
3739 if ((item = ng_getqblk(flags)) == NULL)
3744 item->el_flags = NGQF_FN2 | NGQF_WRITER;
3745 NG_NODE_REF(node); /* and one for the item */
3746 NGI_SET_NODE(item, node);
3749 NGI_SET_HOOK(item, hook);
3752 NGI_ARG1(item) = arg1;
3753 NGI_ARG2(item) = arg2;
3754 if (pitem != NULL && (flags & NG_REUSE_ITEM) == 0)
3755 item->apply = pitem->apply;
3756 return(ng_snd_item(item, flags));
3760 * Official timeout routines for Netgraph nodes.
3763 ng_callout_trampoline(void *arg)
3767 ng_snd_item(item, 0);
3772 ng_callout(struct callout *c, node_p node, hook_p hook, int ticks,
3773 ng_item_fn *fn, void * arg1, int arg2)
3777 if ((item = ng_getqblk(NG_NOFLAGS)) == NULL)
3780 item->el_flags = NGQF_FN | NGQF_WRITER;
3781 NG_NODE_REF(node); /* and one for the item */
3782 NGI_SET_NODE(item, node);
3785 NGI_SET_HOOK(item, hook);
3788 NGI_ARG1(item) = arg1;
3789 NGI_ARG2(item) = arg2;
3791 if (callout_reset(c, ticks, &ng_callout_trampoline, item) == 1 &&
3793 NG_FREE_ITEM(oitem);
3797 /* A special modified version of untimeout() */
3799 ng_uncallout(struct callout *c, node_p node)
3804 KASSERT(c != NULL, ("ng_uncallout: NULL callout"));
3805 KASSERT(node != NULL, ("ng_uncallout: NULL node"));
3807 rval = callout_stop(c);
3809 /* Do an extra check */
3810 if ((rval > 0) && (c->c_func == &ng_callout_trampoline) &&
3811 (NGI_NODE(item) == node)) {
3813 * We successfully removed it from the queue before it ran
3814 * So now we need to unreference everything that was
3815 * given extra references. (NG_FREE_ITEM does this).
3825 * Set the address, if none given, give the node here.
3828 ng_replace_retaddr(node_p here, item_p item, ng_ID_t retaddr)
3831 NGI_RETADDR(item) = retaddr;
3834 * The old return address should be ok.
3835 * If there isn't one, use the address here.
3837 NGI_RETADDR(item) = ng_node2ID(here);
3843 /* just test all the macros */
3845 ng_macro_test(item_p item);
3847 ng_macro_test(item_p item)
3852 struct ng_mesg *msg;
3857 NGI_GET_MSG(item, msg);
3858 retaddr = NGI_RETADDR(item);
3859 NG_SEND_DATA(error, hook, m, NULL);
3860 NG_SEND_DATA_ONLY(error, hook, m);
3861 NG_FWD_NEW_DATA(error, item, hook, m);
3862 NG_FWD_ITEM_HOOK(error, item, hook);
3863 NG_SEND_MSG_HOOK(error, node, msg, hook, retaddr);
3864 NG_SEND_MSG_ID(error, node, msg, retaddr, retaddr);
3865 NG_SEND_MSG_PATH(error, node, msg, ".:", retaddr);
3866 NG_FWD_MSG_HOOK(error, node, item, hook, retaddr);
3868 #endif /* TESTING */