xref: /freebsd/sys/netgraph/netgraph.h (revision d37ea99837e6ad50837fd9fe1771ddf1c3ba6002)
1 /*
2  * netgraph.h
3  *
4  * Copyright (c) 1996-1999 Whistle Communications, Inc.
5  * All rights reserved.
6  *
7  * Subject to the following obligations and disclaimer of warranty, use and
8  * redistribution of this software, in source or object code forms, with or
9  * without modifications are expressly permitted by Whistle Communications;
10  * provided, however, that:
11  * 1. Any and all reproductions of the source or object code must include the
12  *    copyright notice above and the following disclaimer of warranties; and
13  * 2. No rights are granted, in any manner or form, to use Whistle
14  *    Communications, Inc. trademarks, including the mark "WHISTLE
15  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
16  *    such appears in the above copyright notice or in the software.
17  *
18  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
19  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
20  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
21  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
23  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
24  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
25  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
26  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
27  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
28  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
29  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
30  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
31  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
33  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
34  * OF SUCH DAMAGE.
35  *
36  * Author: Julian Elischer <julian@freebsd.org>
37  *
38  * $FreeBSD$
39  * $Whistle: netgraph.h,v 1.29 1999/11/01 07:56:13 julian Exp $
40  */
41 
42 #ifndef _NETGRAPH_NETGRAPH_H_
43 #define _NETGRAPH_NETGRAPH_H_
44 
45 #ifndef _KERNEL
46 #error "This file should not be included in user level programs"
47 #endif
48 
49 #include <sys/queue.h>
50 #include <sys/lock.h>
51 #include <sys/malloc.h>
52 #include <sys/module.h>
53 #include <sys/mutex.h>
54 /* debugging options */
55 #define NETGRAPH_DEBUG
56 #define NG_SEPARATE_MALLOC	/* make modules use their own malloc types */
57 
58 /*
59  * This defines the in-kernel binary interface version.
60  * It is possible to change this but leave the external message
61  * API the same. Each type also has it's own cookies for versioning as well.
62  * Change it for NETGRAPH_DEBUG version so we cannot mix debug and non debug
63  * modules.
64  */
65 #define _NG_ABI_VERSION 9
66 #ifdef	NETGRAPH_DEBUG /*----------------------------------------------*/
67 #define NG_ABI_VERSION	(_NG_ABI_VERSION + 0x10000)
68 #else	/* NETGRAPH_DEBUG */ /*----------------------------------------------*/
69 #define NG_ABI_VERSION	_NG_ABI_VERSION
70 #endif	/* NETGRAPH_DEBUG */ /*----------------------------------------------*/
71 
72 
73 /*
74  * Forward references for the basic structures so we can
75  * define the typedefs and use them in the structures themselves.
76  */
77 struct ng_hook ;
78 struct ng_node ;
79 struct ng_item ;
80 typedef	struct ng_item *item_p;
81 typedef struct ng_node *node_p;
82 typedef struct ng_hook *hook_p;
83 
84 /* node method definitions */
85 typedef	int	ng_constructor_t(node_p node);
86 typedef	int	ng_close_t(node_p node);
87 typedef	int	ng_shutdown_t(node_p node);
88 typedef	int	ng_newhook_t(node_p node, hook_p hook, const char *name);
89 typedef	hook_p	ng_findhook_t(node_p node, const char *name);
90 typedef	int	ng_connect_t(hook_p hook);
91 typedef	int	ng_rcvmsg_t(node_p node, item_p item, hook_p lasthook);
92 typedef	int	ng_rcvdata_t(hook_p hook, item_p item);
93 typedef	int	ng_disconnect_t(hook_p hook);
94 typedef	int	ng_rcvitem (node_p node, hook_p hook, item_p item);
95 
96 /***********************************************************************
97  ***************** Hook Structure and Methods **************************
98  ***********************************************************************
99  *
100  * Structure of a hook
101  */
102 struct ng_hook {
103 	char	hk_name[NG_HOOKSIZ];	/* what this node knows this link as */
104 	void   *hk_private;		/* node dependant ID for this hook */
105 	int	hk_flags;		/* info about this hook/link */
106 	int	hk_refs;		/* dont actually free this till 0 */
107 	struct	ng_hook *hk_peer;	/* the other end of this link */
108 	struct	ng_node *hk_node;	/* The node this hook is attached to */
109 	LIST_ENTRY(ng_hook) hk_hooks;	/* linked list of all hooks on node */
110 	ng_rcvmsg_t	*hk_rcvmsg;	/* control messages come here */
111 	ng_rcvdata_t	*hk_rcvdata;	/* data comes here */
112 #ifdef	NETGRAPH_DEBUG /*----------------------------------------------*/
113 #define HK_MAGIC 0x78573011
114 	int	hk_magic;
115 	char	*lastfile;
116 	int	lastline;
117 	SLIST_ENTRY(ng_hook)	  hk_all;		/* all existing items */
118 #endif	/* NETGRAPH_DEBUG */ /*----------------------------------------------*/
119 };
120 /* Flags for a hook */
121 #define HK_INVALID		0x0001	/* don't trust it! */
122 #define HK_QUEUE		0x0002	/* queue for later delivery */
123 #define HK_FORCE_WRITER		0x0004	/* Incoming data queued as a writer */
124 #define HK_DEAD			0x0008	/* This is the dead hook.. don't free */
125 
126 /*
127  * Public Methods for hook
128  * If you can't do it with these you probably shouldn;t be doing it.
129  */
130 void ng_unref_hook(hook_p hook); /* don't move this */
131 #define	_NG_HOOK_REF(hook)	atomic_add_int(&(hook)->hk_refs, 1)
132 #define _NG_HOOK_NAME(hook)	((hook)->hk_name)
133 #define _NG_HOOK_UNREF(hook)	ng_unref_hook(hook)
134 #define	_NG_HOOK_SET_PRIVATE(hook, val)	do {(hook)->hk_private = val;} while (0)
135 #define	_NG_HOOK_SET_RCVMSG(hook, val)	do {(hook)->hk_rcvmsg = val;} while (0)
136 #define	_NG_HOOK_SET_RCVDATA(hook, val)	do {(hook)->hk_rcvdata = val;} while (0)
137 #define	_NG_HOOK_PRIVATE(hook)	((hook)->hk_private)
138 #define _NG_HOOK_NOT_VALID(hook)	((hook)->hk_flags & HK_INVALID)
139 #define _NG_HOOK_IS_VALID(hook)	(!((hook)->hk_flags & HK_INVALID))
140 #define _NG_HOOK_NODE(hook)	((hook)->hk_node) /* only rvalue! */
141 #define _NG_HOOK_PEER(hook)	((hook)->hk_peer) /* only rvalue! */
142 #define _NG_HOOK_FORCE_WRITER(hook)				\
143 		do { hook->hk_flags |= HK_FORCE_WRITER; } while (0)
144 #define _NG_HOOK_FORCE_QUEUE(hook) do { hook->hk_flags |= HK_QUEUE; } while (0)
145 
146 /* Some shortcuts */
147 #define NG_PEER_NODE(hook)	NG_HOOK_NODE(NG_HOOK_PEER(hook))
148 #define NG_PEER_HOOK_NAME(hook)	NG_HOOK_NAME(NG_HOOK_PEER(hook))
149 #define NG_PEER_NODE_NAME(hook)	NG_NODE_NAME(NG_PEER_NODE(hook))
150 
151 #ifdef	NETGRAPH_DEBUG /*----------------------------------------------*/
152 #define _NN_ __FILE__,__LINE__
153 void	dumphook (hook_p hook, char *file, int line);
154 static __inline void	_chkhook(hook_p hook, char *file, int line);
155 static __inline void	_ng_hook_ref(hook_p hook, char * file, int line);
156 static __inline char *	_ng_hook_name(hook_p hook, char * file, int line);
157 static __inline void	_ng_hook_unref(hook_p hook, char * file, int line);
158 static __inline void	_ng_hook_set_private(hook_p hook,
159 				void * val, char * file, int line);
160 static __inline void	_ng_hook_set_rcvmsg(hook_p hook,
161 				ng_rcvmsg_t *val, char * file, int line);
162 static __inline void	_ng_hook_set_rcvdata(hook_p hook,
163 				ng_rcvdata_t *val, char * file, int line);
164 static __inline void *	_ng_hook_private(hook_p hook, char * file, int line);
165 static __inline int	_ng_hook_not_valid(hook_p hook, char * file, int line);
166 static __inline int	_ng_hook_is_valid(hook_p hook, char * file, int line);
167 static __inline node_p	_ng_hook_node(hook_p hook, char * file, int line);
168 static __inline hook_p	_ng_hook_peer(hook_p hook, char * file, int line);
169 static __inline void	_ng_hook_force_writer(hook_p hook, char * file,
170 					int line);
171 static __inline void	_ng_hook_force_queue(hook_p hook, char * file, int line);
172 
173 static void __inline
174 _chkhook(hook_p hook, char *file, int line)
175 {
176 	if (hook->hk_magic != HK_MAGIC) {
177 		printf("Accessing freed hook ");
178 		dumphook(hook, file, line);
179 	}
180 	hook->lastline = line;
181 	hook->lastfile = file;
182 }
183 
184 static __inline void
185 _ng_hook_ref(hook_p hook, char * file, int line)
186 {
187 	_chkhook(hook, file, line);
188 	_NG_HOOK_REF(hook);
189 }
190 
191 static __inline char *
192 _ng_hook_name(hook_p hook, char * file, int line)
193 {
194 	_chkhook(hook, file, line);
195 	return (_NG_HOOK_NAME(hook));
196 }
197 
198 static __inline void
199 _ng_hook_unref(hook_p hook, char * file, int line)
200 {
201 	_chkhook(hook, file, line);
202 	_NG_HOOK_UNREF(hook);
203 }
204 
205 static __inline void
206 _ng_hook_set_private(hook_p hook, void *val, char * file, int line)
207 {
208 	_chkhook(hook, file, line);
209 	_NG_HOOK_SET_PRIVATE(hook, val);
210 }
211 
212 static __inline void
213 _ng_hook_set_rcvmsg(hook_p hook, ng_rcvmsg_t *val, char * file, int line)
214 {
215 	_chkhook(hook, file, line);
216 	_NG_HOOK_SET_RCVMSG(hook, val);
217 }
218 
219 static __inline void
220 _ng_hook_set_rcvdata(hook_p hook, ng_rcvdata_t *val, char * file, int line)
221 {
222 	_chkhook(hook, file, line);
223 	_NG_HOOK_SET_RCVDATA(hook, val);
224 }
225 
226 static __inline void *
227 _ng_hook_private(hook_p hook, char * file, int line)
228 {
229 	_chkhook(hook, file, line);
230 	return (_NG_HOOK_PRIVATE(hook));
231 }
232 
233 static __inline int
234 _ng_hook_not_valid(hook_p hook, char * file, int line)
235 {
236 	_chkhook(hook, file, line);
237 	return (_NG_HOOK_NOT_VALID(hook));
238 }
239 
240 static __inline int
241 _ng_hook_is_valid(hook_p hook, char * file, int line)
242 {
243 	_chkhook(hook, file, line);
244 	return (_NG_HOOK_IS_VALID(hook));
245 }
246 
247 static __inline node_p
248 _ng_hook_node(hook_p hook, char * file, int line)
249 {
250 	_chkhook(hook, file, line);
251 	return (_NG_HOOK_NODE(hook));
252 }
253 
254 static __inline hook_p
255 _ng_hook_peer(hook_p hook, char * file, int line)
256 {
257 	_chkhook(hook, file, line);
258 	return (_NG_HOOK_PEER(hook));
259 }
260 
261 static __inline void
262 _ng_hook_force_writer(hook_p hook, char * file, int line)
263 {
264 	_chkhook(hook, file, line);
265 	_NG_HOOK_FORCE_WRITER(hook);
266 }
267 
268 static __inline void
269 _ng_hook_force_queue(hook_p hook, char * file, int line)
270 {
271 	_chkhook(hook, file, line);
272 	_NG_HOOK_FORCE_QUEUE(hook);
273 }
274 
275 
276 #define	NG_HOOK_REF(hook)		_ng_hook_ref(hook, _NN_)
277 #define NG_HOOK_NAME(hook)		_ng_hook_name(hook, _NN_)
278 #define NG_HOOK_UNREF(hook)		_ng_hook_unref(hook, _NN_)
279 #define	NG_HOOK_SET_PRIVATE(hook, val)	_ng_hook_set_private(hook, val, _NN_)
280 #define	NG_HOOK_SET_RCVMSG(hook, val)	_ng_hook_set_rcvmsg(hook, val, _NN_)
281 #define	NG_HOOK_SET_RCVDATA(hook, val)	_ng_hook_set_rcvdata(hook, val, _NN_)
282 #define	NG_HOOK_PRIVATE(hook)		_ng_hook_private(hook, _NN_)
283 #define NG_HOOK_NOT_VALID(hook)		_ng_hook_not_valid(hook, _NN_)
284 #define NG_HOOK_IS_VALID(hook)		_ng_hook_is_valid(hook, _NN_)
285 #define NG_HOOK_NODE(hook)		_ng_hook_node(hook, _NN_)
286 #define NG_HOOK_PEER(hook)		_ng_hook_peer(hook, _NN_)
287 #define NG_HOOK_FORCE_WRITER(hook)	_ng_hook_force_writer(hook, _NN_)
288 #define NG_HOOK_FORCE_QUEUE(hook)	_ng_hook_force_queue(hook, _NN_)
289 
290 #else	/* NETGRAPH_DEBUG */ /*----------------------------------------------*/
291 
292 #define	NG_HOOK_REF(hook)		_NG_HOOK_REF(hook)
293 #define NG_HOOK_NAME(hook)		_NG_HOOK_NAME(hook)
294 #define NG_HOOK_UNREF(hook)		_NG_HOOK_UNREF(hook)
295 #define	NG_HOOK_SET_PRIVATE(hook, val)	_NG_HOOK_SET_PRIVATE(hook, val)
296 #define	NG_HOOK_SET_RCVMSG(hook, val)	_NG_HOOK_SET_RCVMSG(hook, val)
297 #define	NG_HOOK_SET_RCVDATA(hook, val)	_NG_HOOK_SET_RCVDATA(hook, val)
298 #define	NG_HOOK_PRIVATE(hook)		_NG_HOOK_PRIVATE(hook)
299 #define NG_HOOK_NOT_VALID(hook)		_NG_HOOK_NOT_VALID(hook)
300 #define NG_HOOK_IS_VALID(hook)		_NG_HOOK_IS_VALID(hook)
301 #define NG_HOOK_NODE(hook)		_NG_HOOK_NODE(hook)
302 #define NG_HOOK_PEER(hook)		_NG_HOOK_PEER(hook)
303 #define NG_HOOK_FORCE_WRITER(hook)	_NG_HOOK_FORCE_WRITER(hook)
304 #define NG_HOOK_FORCE_QUEUE(hook)	_NG_HOOK_FORCE_QUEUE(hook)
305 
306 #endif	/* NETGRAPH_DEBUG */ /*----------------------------------------------*/
307 
308 /***********************************************************************
309  ***************** Node Structure and Methods **************************
310  ***********************************************************************
311  * Structure of a node
312  * including the eembedded queue structure.
313  *
314  * The structure for queueing Netgraph request items
315  * embedded in the node structure
316  */
317 struct ng_queue {
318 	u_long          q_flags;
319 	struct mtx      q_mtx;
320 	item_p queue;
321 	item_p *last;
322 	struct ng_node *q_node;		/* find the front of the node.. */
323 };
324 
325 struct ng_node {
326 	char	nd_name[NG_NODESIZ];	/* optional globally unique name */
327 	struct	ng_type *nd_type;	/* the installed 'type' */
328 	int	nd_flags;		/* see below for bit definitions */
329 	int	nd_refs;		/* # of references to this node */
330 	int	nd_numhooks;		/* number of hooks */
331 	void   *nd_private;		/* node type dependant node ID */
332 	ng_ID_t	nd_ID;			/* Unique per node */
333 	LIST_HEAD(hooks, ng_hook) nd_hooks;	/* linked list of node hooks */
334 	LIST_ENTRY(ng_node)	  nd_nodes;	/* linked list of all nodes */
335 	LIST_ENTRY(ng_node)	  nd_idnodes;	/* ID hash collision list */
336 	TAILQ_ENTRY(ng_node)	  nd_work;	/* nodes with work to do */
337 	struct	ng_queue	  nd_input_queue; /* input queue for locking */
338 #ifdef	NETGRAPH_DEBUG /*----------------------------------------------*/
339 #define ND_MAGIC 0x59264837
340 	int	nd_magic;
341 	char	*lastfile;
342 	int	lastline;
343 	SLIST_ENTRY(ng_node)	  nd_all;	/* all existing nodes */
344 #endif	/* NETGRAPH_DEBUG */ /*----------------------------------------------*/
345 };
346 
347 /* Flags for a node */
348 #define NG_INVALID	0x00000001	/* free when refs go to 0 */
349 #define NG_WORKQ	0x00000002	/* node is on the work queue */
350 #define NG_FORCE_WRITER	0x00000004	/* Never multithread this node */
351 #define NG_CLOSING	0x00000008	/* ng_rmnode() at work */
352 #define NG_REALLY_DIE	0x00000010	/* "persistant" node is unloading */
353 #define NGF_TYPE1	0x10000000	/* reserved for type specific storage */
354 #define NGF_TYPE2	0x20000000	/* reserved for type specific storage */
355 #define NGF_TYPE3	0x40000000	/* reserved for type specific storage */
356 #define NGF_TYPE4	0x80000000	/* reserved for type specific storage */
357 
358 /*
359  * Public methods for nodes.
360  * If you can't do it with these you probably shouldn't be doing it.
361  */
362 int	ng_unref_node(node_p node); /* don't move this */
363 #define _NG_NODE_NAME(node)	((node)->nd_name + 0)
364 #define _NG_NODE_HAS_NAME(node)	((node)->nd_name[0] + 0)
365 #define _NG_NODE_ID(node)	((node)->nd_ID + 0)
366 #define	_NG_NODE_REF(node)	atomic_add_int(&(node)->nd_refs, 1)
367 #define	_NG_NODE_UNREF(node)	ng_unref_node(node)
368 #define	_NG_NODE_SET_PRIVATE(node, val)	do {(node)->nd_private = val;} while (0)
369 #define	_NG_NODE_PRIVATE(node)	((node)->nd_private)
370 #define _NG_NODE_IS_VALID(node)	(!((node)->nd_flags & NG_INVALID))
371 #define _NG_NODE_NOT_VALID(node)	((node)->nd_flags & NG_INVALID)
372 #define _NG_NODE_NUMHOOKS(node)	((node)->nd_numhooks + 0) /* rvalue */
373 #define _NG_NODE_FORCE_WRITER(node)					\
374 	do{ node->nd_flags |= NG_FORCE_WRITER; }while (0)
375 #define _NG_NODE_REALLY_DIE(node)					\
376 	do{ node->nd_flags |= (NG_REALLY_DIE|NG_INVALID); }while (0)
377 /*
378  * The hook iterator.
379  * This macro will call a function of type ng_fn_eachhook for each
380  * hook attached to the node. If the function returns 0, then the
381  * iterator will stop and return a pointer to the hook that returned 0.
382  */
383 typedef	int	ng_fn_eachhook(hook_p hook, void* arg);
384 #define _NG_NODE_FOREACH_HOOK(node, fn, arg, rethook)			\
385 	do {								\
386 		hook_p _hook;						\
387 		(rethook) = NULL;					\
388 		LIST_FOREACH(_hook, &((node)->nd_hooks), hk_hooks) {	\
389 			if ((fn)(_hook, arg) == 0) {			\
390 				(rethook) = _hook;			\
391 				break;					\
392 			}						\
393 		}							\
394 	} while (0)
395 
396 #ifdef	NETGRAPH_DEBUG /*----------------------------------------------*/
397 void	dumpnode(node_p node, char *file, int line);
398 static void __inline _chknode(node_p node, char *file, int line);
399 static __inline char * _ng_node_name(node_p node, char *file, int line);
400 static __inline int _ng_node_has_name(node_p node, char *file, int line);
401 static __inline ng_ID_t _ng_node_id(node_p node, char *file, int line);
402 void ng_ref_node(node_p node);
403 static __inline void _ng_node_ref(node_p node, char *file, int line);
404 static __inline int _ng_node_unref(node_p node, char *file, int line);
405 static __inline void _ng_node_set_private(node_p node, void * val,
406 							char *file, int line);
407 static __inline void * _ng_node_private(node_p node, char *file, int line);
408 static __inline int _ng_node_is_valid(node_p node, char *file, int line);
409 static __inline int _ng_node_not_valid(node_p node, char *file, int line);
410 static __inline int _ng_node_numhooks(node_p node, char *file, int line);
411 static __inline void _ng_node_force_writer(node_p node, char *file, int line);
412 static __inline hook_p _ng_node_foreach_hook(node_p node,
413 			ng_fn_eachhook *fn, void *arg, char *file, int line);
414 
415 static void __inline
416 _chknode(node_p node, char *file, int line)
417 {
418 	if (node->nd_magic != ND_MAGIC) {
419 		printf("Accessing freed node ");
420 		dumpnode(node, file, line);
421 	}
422 	node->lastline = line;
423 	node->lastfile = file;
424 }
425 
426 static __inline char *
427 _ng_node_name(node_p node, char *file, int line)
428 {
429 	_chknode(node, file, line);
430 	return(_NG_NODE_NAME(node));
431 }
432 
433 static __inline int
434 _ng_node_has_name(node_p node, char *file, int line)
435 {
436 	_chknode(node, file, line);
437 	return(_NG_NODE_HAS_NAME(node));
438 }
439 
440 static __inline ng_ID_t
441 _ng_node_id(node_p node, char *file, int line)
442 {
443 	_chknode(node, file, line);
444 	return(_NG_NODE_ID(node));
445 }
446 
447 static __inline void
448 _ng_node_ref(node_p node, char *file, int line)
449 {
450 	_chknode(node, file, line);
451 	/*_NG_NODE_REF(node);*/
452 	ng_ref_node(node);
453 }
454 
455 static __inline int
456 _ng_node_unref(node_p node, char *file, int line)
457 {
458 	_chknode(node, file, line);
459 	return (_NG_NODE_UNREF(node));
460 }
461 
462 static __inline void
463 _ng_node_set_private(node_p node, void * val, char *file, int line)
464 {
465 	_chknode(node, file, line);
466 	_NG_NODE_SET_PRIVATE(node, val);
467 }
468 
469 static __inline void *
470 _ng_node_private(node_p node, char *file, int line)
471 {
472 	_chknode(node, file, line);
473 	return (_NG_NODE_PRIVATE(node));
474 }
475 
476 static __inline int
477 _ng_node_is_valid(node_p node, char *file, int line)
478 {
479 	_chknode(node, file, line);
480 	return(_NG_NODE_IS_VALID(node));
481 }
482 
483 static __inline int
484 _ng_node_not_valid(node_p node, char *file, int line)
485 {
486 	_chknode(node, file, line);
487 	return(_NG_NODE_NOT_VALID(node));
488 }
489 
490 static __inline int
491 _ng_node_numhooks(node_p node, char *file, int line)
492 {
493 	_chknode(node, file, line);
494 	return(_NG_NODE_NUMHOOKS(node));
495 }
496 
497 static __inline void
498 _ng_node_force_writer(node_p node, char *file, int line)
499 {
500 	_chknode(node, file, line);
501 	_NG_NODE_FORCE_WRITER(node);
502 }
503 
504 static __inline void
505 _ng_node_really_die(node_p node, char *file, int line)
506 {
507 	_chknode(node, file, line);
508 	_NG_NODE_REALLY_DIE(node);
509 }
510 
511 static __inline hook_p
512 _ng_node_foreach_hook(node_p node, ng_fn_eachhook *fn, void *arg,
513 						char *file, int line)
514 {
515 	hook_p hook;
516 	_chknode(node, file, line);
517 	_NG_NODE_FOREACH_HOOK(node, fn, arg, hook);
518 	return (hook);
519 }
520 
521 #define NG_NODE_NAME(node)		_ng_node_name(node, _NN_)
522 #define NG_NODE_HAS_NAME(node)		_ng_node_has_name(node, _NN_)
523 #define NG_NODE_ID(node)		_ng_node_id(node, _NN_)
524 #define NG_NODE_REF(node)		_ng_node_ref(node, _NN_)
525 #define	NG_NODE_UNREF(node)		_ng_node_unref(node, _NN_)
526 #define	NG_NODE_SET_PRIVATE(node, val)	_ng_node_set_private(node, val, _NN_)
527 #define	NG_NODE_PRIVATE(node)		_ng_node_private(node, _NN_)
528 #define NG_NODE_IS_VALID(node)		_ng_node_is_valid(node, _NN_)
529 #define NG_NODE_NOT_VALID(node)		_ng_node_not_valid(node, _NN_)
530 #define NG_NODE_FORCE_WRITER(node) 	_ng_node_force_writer(node, _NN_)
531 #define NG_NODE_REALLY_DIE(node) 	_ng_node_really_die(node, _NN_)
532 #define NG_NODE_NUMHOOKS(node)		_ng_node_numhooks(node, _NN_)
533 #define NG_NODE_FOREACH_HOOK(node, fn, arg, rethook)			      \
534 	do {								      \
535 		rethook = _ng_node_foreach_hook(node, fn, (void *)arg, _NN_); \
536 	} while (0)
537 
538 #else	/* NETGRAPH_DEBUG */ /*----------------------------------------------*/
539 
540 #define NG_NODE_NAME(node)		_NG_NODE_NAME(node)
541 #define NG_NODE_HAS_NAME(node)		_NG_NODE_HAS_NAME(node)
542 #define NG_NODE_ID(node)		_NG_NODE_ID(node)
543 #define	NG_NODE_REF(node)		_NG_NODE_REF(node)
544 #define	NG_NODE_UNREF(node)		_NG_NODE_UNREF(node)
545 #define	NG_NODE_SET_PRIVATE(node, val)	_NG_NODE_SET_PRIVATE(node, val)
546 #define	NG_NODE_PRIVATE(node)		_NG_NODE_PRIVATE(node)
547 #define NG_NODE_IS_VALID(node)		_NG_NODE_IS_VALID(node)
548 #define NG_NODE_NOT_VALID(node)		_NG_NODE_NOT_VALID(node)
549 #define NG_NODE_FORCE_WRITER(node) 	_NG_NODE_FORCE_WRITER(node)
550 #define NG_NODE_REALLY_DIE(node) 	_NG_NODE_REALLY_DIE(node)
551 #define NG_NODE_NUMHOOKS(node)		_NG_NODE_NUMHOOKS(node)
552 #define NG_NODE_FOREACH_HOOK(node, fn, arg, rethook)			\
553 		_NG_NODE_FOREACH_HOOK(node, fn, arg, rethook)
554 #endif	/* NETGRAPH_DEBUG */ /*----------------------------------------------*/
555 
556 /***********************************************************************
557  ************* Node Queue and Item Structures and Methods **************
558  ***********************************************************************
559  *
560  */
561 typedef	void	ng_item_fn(node_p node, hook_p hook, void *arg1, int arg2);
562 struct ng_item {
563 	u_long	el_flags;
564 	item_p	el_next;
565 	node_p	el_dest; /* The node it will be applied against (or NULL) */
566 	hook_p	el_hook; /* Entering hook. Optional in Control messages */
567 	union {
568 		struct mbuf	*da_m;
569 		struct {
570 			struct ng_mesg	*msg_msg;
571 			ng_ID_t		msg_retaddr;
572 		} msg;
573 		struct {
574 			ng_item_fn	*fn_fn;
575 			void 		*fn_arg1;
576 			int		fn_arg2;
577 		} fn;
578 	} body;
579 #ifdef	NETGRAPH_DEBUG /*----------------------------------------------*/
580 	char *lastfile;
581 	int  lastline;
582 	TAILQ_ENTRY(ng_item)	  all;		/* all existing items */
583 #endif	/* NETGRAPH_DEBUG */ /*----------------------------------------------*/
584 };
585 
586 #define NGQF_TYPE	0x03		/* MASK of content definition */
587 #define NGQF_MESG	0x00		/* the queue element is a message */
588 #define NGQF_DATA	0x01		/* the queue element is data */
589 #define NGQF_FN		0x02		/* the queue element is a function */
590 #define NGQF_UNDEF	0x03		/* UNDEFINED */
591 
592 #define NGQF_RW		0x04		/* MASK for queue entry read/write */
593 #define NGQF_READER	0x04		/* queued as a reader */
594 #define NGQF_WRITER	0x00		/* queued as a writer */
595 
596 #define NGQF_FREE	0x08
597 
598 /*
599  * Get the mbuf (etc) out of an item.
600  * Sets the value in the item to NULL in case we need to call NG_FREE_ITEM()
601  * with it, (to avoid freeing the things twice).
602  * If you don't want to zero out the item then realise that the
603  * item still owns it.
604  * Retaddr is different. There are no references on that. It's just a number.
605  * The debug versions must be either all used everywhere or not at all.
606  */
607 
608 #define _NGI_M(i) ((i)->body.da_m)
609 #define _NGI_MSG(i) ((i)->body.msg.msg_msg)
610 #define _NGI_RETADDR(i) ((i)->body.msg.msg_retaddr)
611 #define	_NGI_FN(i) ((i)->body.fn.fn_fn)
612 #define	_NGI_ARG1(i) ((i)->body.fn.fn_arg1)
613 #define	_NGI_ARG2(i) ((i)->body.fn.fn_arg2)
614 #define	_NGI_NODE(i) ((i)->el_dest)
615 #define	_NGI_HOOK(i) ((i)->el_hook)
616 #define	_NGI_SET_HOOK(i,h) do { _NGI_HOOK(i) = h; h = NULL;} while (0)
617 #define	_NGI_CLR_HOOK(i)   do {						\
618 		hook_p _hook = _NGI_HOOK(i);				\
619 		if (_hook) {						\
620 			_NG_HOOK_UNREF(_hook);				\
621 			_NGI_HOOK(i) = NULL;				\
622 		}							\
623 	} while (0)
624 #define	_NGI_SET_NODE(i,n) do { _NGI_NODE(i) = n; n = NULL;} while (0)
625 #define	_NGI_CLR_NODE(i)   do {						\
626 		node_p _node = _NGI_NODE(i);				\
627 		if (_node) {						\
628 			_NG_NODE_UNREF(_node);				\
629 			_NGI_NODE(i) = NULL;				\
630 		}							\
631 	} while (0)
632 
633 #ifdef NETGRAPH_DEBUG /*----------------------------------------------*/
634 void				dumpitem(item_p item, char *file, int line);
635 static __inline void		_ngi_check(item_p item, char *file, int line) ;
636 static __inline struct mbuf **	_ngi_m(item_p item, char *file, int line) ;
637 static __inline ng_ID_t *	_ngi_retaddr(item_p item, char *file, int line);
638 static __inline struct ng_mesg ** _ngi_msg(item_p item, char *file, int line) ;
639 static __inline ng_item_fn **	_ngi_fn(item_p item, char *file, int line) ;
640 static __inline void **		_ngi_arg1(item_p item, char *file, int line) ;
641 static __inline int *		_ngi_arg2(item_p item, char *file, int line) ;
642 static __inline node_p		_ngi_node(item_p item, char *file, int line);
643 static __inline hook_p		_ngi_hook(item_p item, char *file, int line);
644 
645 static __inline void
646 _ngi_check(item_p item, char *file, int line)
647 {
648 	if (item->el_flags & NGQF_FREE) {
649 		dumpitem(item, file, line);
650 		panic ("free item!");
651 	}
652 	(item)->lastline = line;
653 	(item)->lastfile = file;
654 }
655 
656 static __inline struct mbuf **
657 _ngi_m(item_p item, char *file, int line)
658 {
659 	_ngi_check(item, file, line);
660 	return (&_NGI_M(item));
661 }
662 
663 static __inline struct ng_mesg **
664 _ngi_msg(item_p item, char *file, int line)
665 {
666 	_ngi_check(item, file, line);
667 	return (&_NGI_MSG(item));
668 }
669 
670 static __inline ng_ID_t *
671 _ngi_retaddr(item_p item, char *file, int line)
672 {
673 	_ngi_check(item, file, line);
674 	return (&_NGI_RETADDR(item));
675 }
676 
677 static __inline ng_item_fn **
678 _ngi_fn(item_p item, char *file, int line)
679 {
680 	_ngi_check(item, file, line);
681 	return (&_NGI_FN(item));
682 }
683 
684 static __inline void **
685 _ngi_arg1(item_p item, char *file, int line)
686 {
687 	_ngi_check(item, file, line);
688 	return (&_NGI_ARG1(item));
689 }
690 
691 static __inline int *
692 _ngi_arg2(item_p item, char *file, int line)
693 {
694 	_ngi_check(item, file, line);
695 	return (&_NGI_ARG2(item));
696 }
697 
698 static __inline node_p
699 _ngi_node(item_p item, char *file, int line)
700 {
701 	_ngi_check(item, file, line);
702 	return (_NGI_NODE(item));
703 }
704 
705 static __inline hook_p
706 _ngi_hook(item_p item, char *file, int line)
707 {
708 	_ngi_check(item, file, line);
709 	return (_NGI_HOOK(item));
710 }
711 
712 #define NGI_M(i)	(*_ngi_m(i, _NN_))
713 #define NGI_MSG(i)	(*_ngi_msg(i, _NN_))
714 #define NGI_RETADDR(i)	(*_ngi_retaddr(i, _NN_))
715 #define NGI_FN(i)	(*_ngi_fn(i, _NN_))
716 #define NGI_ARG1(i)	(*_ngi_arg1(i, _NN_))
717 #define NGI_ARG2(i)	(*_ngi_arg2(i, _NN_))
718 #define NGI_HOOK(i)	_ngi_hook(i, _NN_)
719 #define NGI_NODE(i)	_ngi_node(i, _NN_)
720 #define	NGI_SET_HOOK(i,h)						\
721 	do { _ngi_check(i, _NN_); _NGI_SET_HOOK(i, h); } while (0)
722 #define	NGI_CLR_HOOK(i)							\
723 	do { _ngi_check(i, _NN_); _NGI_CLR_HOOK(i); } while (0)
724 #define	NGI_SET_NODE(i,n)						\
725 	do { _ngi_check(i, _NN_); _NGI_SET_NODE(i, n); } while (0)
726 #define	NGI_CLR_NODE(i)							\
727 	do { _ngi_check(i, _NN_); _NGI_CLR_NODE(i); } while (0)
728 
729 #define NG_FREE_ITEM(item)						\
730 	do {								\
731 		_ngi_check(item, _NN_);					\
732 		ng_free_item((item));					\
733 	} while (0)
734 
735 #define	SAVE_LINE(item)							\
736 	do {								\
737 		(item)->lastline = __LINE__;				\
738 		(item)->lastfile = __FILE__;				\
739 	} while (0)
740 
741 #else	/* NETGRAPH_DEBUG */ /*----------------------------------------------*/
742 
743 #define NGI_M(i)	_NGI_M(i)
744 #define NGI_MSG(i)	_NGI_MSG(i)
745 #define NGI_RETADDR(i)	_NGI_RETADDR(i)
746 #define NGI_FN(i)	_NGI_FN(i)
747 #define NGI_ARG1(i)	_NGI_ARG1(i)
748 #define NGI_ARG2(i)	_NGI_ARG2(i)
749 #define	NGI_NODE(i)	_NGI_NODE(i)
750 #define	NGI_HOOK(i)	_NGI_HOOK(i)
751 #define	NGI_SET_HOOK(i,h) _NGI_SET_HOOK(i,h)
752 #define	NGI_CLR_HOOK(i)	  _NGI_CLR_HOOK(i)
753 #define	NGI_SET_NODE(i,n) _NGI_SET_NODE(i,n)
754 #define	NGI_CLR_NODE(i)	  _NGI_CLR_NODE(i)
755 
756 #define	NG_FREE_ITEM(item)	ng_free_item((item))
757 #define	SAVE_LINE(item)		do {} while (0)
758 
759 #endif	/* NETGRAPH_DEBUG */ /*----------------------------------------------*/
760 
761 #define NGI_GET_M(i,m)							\
762 	do {								\
763 		(m) = NGI_M(i);						\
764 		_NGI_M(i) = NULL;					\
765 	} while (0)
766 
767 #define NGI_GET_MSG(i,m)						\
768 	do {								\
769 		(m) = NGI_MSG(i);					\
770 		_NGI_MSG(i) = NULL;					\
771 	} while (0)
772 
773 #define NGI_GET_NODE(i,n)	/* YOU NOW HAVE THE REFERENCE */	\
774 	do {								\
775 		(n) = NGI_NODE(i);					\
776 		_NGI_NODE(i) = NULL;					\
777 	} while (0)
778 
779 #define NGI_GET_HOOK(i,h)						\
780 	do {								\
781 		(h) = NGI_HOOK(i);					\
782 		_NGI_HOOK(i) = NULL;					\
783 	} while (0)
784 
785 
786 /**********************************************************************
787 * Data macros.  Send, manipulate and free.
788 **********************************************************************/
789 /*
790  * Assuming the data is already ok, just set the new address and send
791  */
792 #define NG_FWD_ITEM_HOOK(error, item, hook)				\
793 	do {								\
794 		(error) =						\
795 		    ng_address_hook(NULL, (item), (hook), 0);	\
796 		if (error == 0) {					\
797 			SAVE_LINE(item);				\
798 			(error) = ng_snd_item((item), 0);		\
799 		}							\
800 		(item) = NULL;						\
801 	} while (0)
802 
803 /*
804  * Forward a data packet. Mbuf pointer is updated to new value. We
805  * presume you dealt with the old one when you update it to the new one
806  * (or it maybe the old one). We got a packet and possibly had to modify
807  * the mbuf. You should probably use NGI_GET_M() if you are going to use
808  * this too.
809  */
810 #define NG_FWD_NEW_DATA(error, item, hook, m)				\
811 	do {								\
812 		NGI_M(item) = (m);					\
813 		(m) = NULL;						\
814 		NG_FWD_ITEM_HOOK(error, item, hook);			\
815 	} while (0)
816 
817 /* Send a previously unpackaged mbuf. XXX: This should be called
818  * NG_SEND_DATA in future, but this name is kept for compatibility
819  * reasons.
820  */
821 #define NG_SEND_DATA_ONLY(error, hook, m)				\
822 	do {								\
823 		item_p _item;						\
824 		if ((_item = ng_package_data((m), NULL))) {		\
825 			NG_FWD_ITEM_HOOK(error, _item, hook);		\
826 		} else {						\
827 			(error) = ENOMEM;				\
828 		}							\
829 		(m) = NULL;						\
830 	} while (0)
831 
832 #define NG_SEND_DATA(error, hook, m, x) NG_SEND_DATA_ONLY(error, hook, m)
833 
834 #define NG_FREE_MSG(msg)						\
835 	do {								\
836 		if ((msg)) {						\
837 			FREE((msg), M_NETGRAPH_MSG);			\
838 			(msg) = NULL;					\
839 		}	 						\
840 	} while (0)
841 
842 #define NG_FREE_M(m)							\
843 	do {								\
844 		if ((m)) {						\
845 			m_freem((m));					\
846 			(m) = NULL;					\
847 		}							\
848 	} while (0)
849 
850 /*****************************************
851 * Message macros
852 *****************************************/
853 
854 #define NG_SEND_MSG_HOOK(error, here, msg, hook, retaddr)		\
855 	do {								\
856 		item_p _item;						\
857 		if ((_item = ng_package_msg(msg)) == NULL) {		\
858 			(msg) = NULL;					\
859 			(error) = ENOMEM;				\
860 			break;						\
861 		}							\
862 		if (((error) = ng_address_hook((here), (_item),		\
863 					(hook), (retaddr))) == 0) {	\
864 			SAVE_LINE(_item);				\
865 			(error) = ng_snd_item((_item), 0);		\
866 		}							\
867 		(msg) = NULL;						\
868 	} while (0)
869 
870 #define NG_SEND_MSG_PATH(error, here, msg, path, retaddr)		\
871 	do {								\
872 		item_p _item;						\
873 		if ((_item = ng_package_msg(msg)) == NULL) {		\
874 			(msg) = NULL;					\
875 			(error) = ENOMEM;				\
876 			break;						\
877 		}							\
878 		if (((error) = ng_address_path((here), (_item),		\
879 					(path), (retaddr))) == 0) {	\
880 			SAVE_LINE(_item);				\
881 			(error) = ng_snd_item((_item), 0);		\
882 		}							\
883 		(msg) = NULL;						\
884 	} while (0)
885 
886 #define NG_SEND_MSG_ID(error, here, msg, ID, retaddr)			\
887 	do {								\
888 		item_p _item;						\
889 		if ((_item = ng_package_msg(msg)) == NULL) {		\
890 			(msg) = NULL;					\
891 			(error) = ENOMEM;				\
892 			break;						\
893 		}							\
894 		if (((error) = ng_address_ID((here), (_item),		\
895 					(ID), (retaddr))) == 0) {	\
896 			SAVE_LINE(_item);				\
897 			(error) = ng_snd_item((_item), 0);		\
898 		}							\
899 		(msg) = NULL;						\
900 	} while (0)
901 
902 /*
903  * Redirect the message to the next hop using the given hook.
904  * ng_retarget_msg() frees the item if there is an error
905  * and returns an error code.  It returns 0 on success.
906  */
907 #define NG_FWD_MSG_HOOK(error, here, item, hook, retaddr)		\
908 	do {								\
909 		if (((error) = ng_address_hook((here), (item),		\
910 					(hook), (retaddr))) == 0) {	\
911 			SAVE_LINE(item);				\
912 			(error) = ng_snd_item((item), 0);		\
913 		}							\
914 		(item) = NULL;						\
915 	} while (0)
916 
917 /*
918  * Send a queue item back to it's originator with a response message.
919  * Assume original message was removed and freed separatly.
920  */
921 #define NG_RESPOND_MSG(error, here, item, resp)				\
922 	do {								\
923 		if (resp) {						\
924 			ng_ID_t _dest = NGI_RETADDR(item);		\
925 			NGI_RETADDR(item) = 0;				\
926 			NGI_MSG(item) = resp;				\
927 			if ((ng_address_ID((here), (item),		\
928 					_dest, 0)) == 0) {		\
929 				SAVE_LINE(item);			\
930 				(error) = ng_snd_item((item), 1);	\
931 			} else {					\
932 				(error) = EINVAL;			\
933 			}						\
934 		} else {						\
935 			NG_FREE_ITEM(item);				\
936 		}							\
937 		(item) = NULL;						\
938 	} while (0)
939 
940 
941 /***********************************************************************
942  ******** Structures Definitions and Macros for defining a node  *******
943  ***********************************************************************
944  *
945  * Here we define the structures needed to actually define a new node
946  * type.
947  */
948 
949 /*
950  * Command list -- each node type specifies the command that it knows
951  * how to convert between ASCII and binary using an array of these.
952  * The last element in the array must be a terminator with cookie=0.
953  */
954 
955 struct ng_cmdlist {
956 	u_int32_t			cookie;		/* command typecookie */
957 	int				cmd;		/* command number */
958 	const char			*name;		/* command name */
959 	const struct ng_parse_type	*mesgType;	/* args if !NGF_RESP */
960 	const struct ng_parse_type	*respType;	/* args if NGF_RESP */
961 };
962 
963 /*
964  * Structure of a node type
965  * If data is sent to the "rcvdata()" entrypoint then the system
966  * may decide to defer it until later by queing it with the normal netgraph
967  * input queuing system.  This is decidde by the HK_QUEUE flag being set in
968  * the flags word of the peer (receiving) hook. The dequeuing mechanism will
969  * ensure it is not requeued again.
970  * Note the input queueing system is to allow modules
971  * to 'release the stack' or to pass data across spl layers.
972  * The data will be redelivered as soon as the NETISR code runs
973  * which may be almost immediatly.  A node may also do it's own queueing
974  * for other reasons (e.g. device output queuing).
975  */
976 struct ng_type {
977 
978 	u_int32_t	version; 	/* must equal NG_API_VERSION */
979 	const char	*name;		/* Unique type name */
980 	modeventhand_t	mod_event;	/* Module event handler (optional) */
981 	ng_constructor_t *constructor;	/* Node constructor */
982 	ng_rcvmsg_t	*rcvmsg;	/* control messages come here */
983 	ng_close_t	*close;		/* warn about forthcoming shutdown */
984 	ng_shutdown_t	*shutdown;	/* reset, and free resources */
985 	ng_newhook_t	*newhook;	/* first notification of new hook */
986 	ng_findhook_t	*findhook;	/* only if you have lots of hooks */
987 	ng_connect_t	*connect;	/* final notification of new hook */
988 	ng_rcvdata_t	*rcvdata;	/* data comes here */
989 	ng_disconnect_t	*disconnect;	/* notify on disconnect */
990 
991 	const struct	ng_cmdlist *cmdlist;	/* commands we can convert */
992 
993 	/* R/W data private to the base netgraph code DON'T TOUCH! */
994 	LIST_ENTRY(ng_type) types;		/* linked list of all types */
995 	int		    refs;		/* number of instances */
996 };
997 
998 /*
999  * Use the NETGRAPH_INIT() macro to link a node type into the
1000  * netgraph system. This works for types compiled into the kernel
1001  * as well as KLD modules. The first argument should be the type
1002  * name (eg, echo) and the second a pointer to the type struct.
1003  *
1004  * If a different link time is desired, e.g., a device driver that
1005  * needs to install its netgraph type before probing, use the
1006  * NETGRAPH_INIT_ORDERED() macro instead. Deivce drivers probably
1007  * want to use SI_SUB_DRIVERS instead of SI_SUB_PSEUDO.
1008  */
1009 
1010 #define NETGRAPH_INIT_ORDERED(typename, typestructp, sub, order)	\
1011 static moduledata_t ng_##typename##_mod = {				\
1012 	"ng_" #typename,						\
1013 	ng_mod_event,							\
1014 	(typestructp)							\
1015 };									\
1016 DECLARE_MODULE(ng_##typename, ng_##typename##_mod, sub, order);		\
1017 MODULE_DEPEND(ng_##typename, netgraph,	NG_ABI_VERSION,			\
1018 					NG_ABI_VERSION,			\
1019 					NG_ABI_VERSION)
1020 
1021 #define NETGRAPH_INIT(tn, tp)						\
1022 	NETGRAPH_INIT_ORDERED(tn, tp, SI_SUB_PSEUDO, SI_ORDER_ANY)
1023 
1024 /* Special malloc() type for netgraph structs and ctrl messages */
1025 /* Only these two types should be visible to nodes */
1026 MALLOC_DECLARE(M_NETGRAPH);
1027 MALLOC_DECLARE(M_NETGRAPH_MSG);
1028 
1029 /* declare the base of the netgraph sysclt hierarchy */
1030 /* but only if this file cares about sysctls */
1031 #ifdef	SYSCTL_DECL
1032 SYSCTL_DECL(_net_graph);
1033 #endif
1034 
1035 /*
1036  * Methods that the nodes can use.
1037  * Many of these methods should usually NOT be used directly but via
1038  * Macros above.
1039  */
1040 int	ng_address_ID(node_p here, item_p item, ng_ID_t ID, ng_ID_t retaddr);
1041 int	ng_address_hook(node_p here, item_p item, hook_p hook, ng_ID_t retaddr);
1042 int	ng_address_path(node_p here, item_p item, char *address, ng_ID_t raddr);
1043 int	ng_bypass(hook_p hook1, hook_p hook2);
1044 hook_p	ng_findhook(node_p node, const char *name);
1045 int	ng_make_node_common(struct ng_type *typep, node_p *nodep);
1046 int	ng_name_node(node_p node, const char *name);
1047 int	ng_newtype(struct ng_type *tp);
1048 ng_ID_t ng_node2ID(node_p node);
1049 item_p	ng_package_data(struct mbuf *m, void *dummy);
1050 item_p	ng_package_msg(struct ng_mesg *msg);
1051 item_p	ng_package_msg_self(node_p here, hook_p hook, struct ng_mesg *msg);
1052 void	ng_replace_retaddr(node_p here, item_p item, ng_ID_t retaddr);
1053 int	ng_rmhook_self(hook_p hook);	/* if a node wants to kill a hook */
1054 int	ng_rmnode_self(node_p here);	/* if a node wants to suicide */
1055 int	ng_rmtype(struct ng_type *tp);
1056 int	ng_snd_item(item_p item, int queue);
1057 int 	ng_send_fn(node_p node, hook_p hook, ng_item_fn *fn,
1058 	void *arg1, int arg2);
1059 int	ng_untimeout(struct callout_handle handle, node_p node);
1060 struct callout_handle
1061 	ng_timeout(node_p node, hook_p hook, int ticks,
1062 	    ng_item_fn *fn, void * arg1, int arg2);
1063 
1064 /*
1065  * prototypes the user should DEFINITELY not use directly
1066  */
1067 void	ng_free_item(item_p item); /* Use NG_FREE_ITEM instead */
1068 int	ng_mod_event(module_t mod, int what, void *arg);
1069 
1070 /*
1071  * Tag definitions and constants
1072  */
1073 
1074 #define	NG_TAG_PRIO	1
1075 
1076 struct ng_tag_prio {
1077 	struct m_tag	tag;
1078 	char	priority;
1079 	char	discardability;
1080 };
1081 
1082 #define	NG_PRIO_CUTOFF		32
1083 #define	NG_PRIO_LINKSTATE	64
1084 
1085 /* Macros and declarations to keep compatibility with metadata, which
1086  * is obsoleted now. To be deleted.
1087  */
1088 typedef void *meta_p;
1089 #define _NGI_META(i)	NULL
1090 #define NGI_META(i)	NULL
1091 #define NG_FREE_META(meta)
1092 #define NGI_GET_META(i,m)
1093 #define	ng_copy_meta(meta) NULL
1094 
1095 #endif /* _NETGRAPH_NETGRAPH_H_ */
1096