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