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