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: src/sys/netgraph/netgraph.h,v 1.74 2008/06/24 18:49:49 gnn Exp $ 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/malloc.h> 53 #include <sys/module.h> 54 #include <sys/mutex2.h> 55 #include <netgraph7/ng_message.h> /* NG_HOOKSIZ, NG_NODESIZ */ 56 #include "dragonfly.h" 57 58 #ifdef HAVE_KERNEL_OPTION_HEADERS 59 #include "opt_netgraph.h" 60 #endif 61 62 /* debugging options */ 63 #define NG_SEPARATE_MALLOC /* make modules use their own malloc types */ 64 65 /* 66 * This defines the in-kernel binary interface version. 67 * It is possible to change this but leave the external message 68 * API the same. Each type also has it's own cookies for versioning as well. 69 * Change it for NETGRAPH_DEBUG version so we cannot mix debug and non debug 70 * modules. 71 */ 72 #define _NG_ABI_VERSION 12 73 #ifdef NETGRAPH_DEBUG /*----------------------------------------------*/ 74 #define NG_ABI_VERSION (_NG_ABI_VERSION + 0x10000) 75 #else /* NETGRAPH_DEBUG */ /*----------------------------------------------*/ 76 #define NG_ABI_VERSION _NG_ABI_VERSION 77 #endif /* NETGRAPH_DEBUG */ /*----------------------------------------------*/ 78 79 80 /* 81 * Forward references for the basic structures so we can 82 * define the typedefs and use them in the structures themselves. 83 */ 84 struct ng_hook ; 85 struct ng_node ; 86 struct ng_item ; 87 struct ng_apply_info ; 88 typedef struct ng_apply_info *apply_p; 89 typedef struct ng_item *item_p; 90 typedef struct ng_node *node_p; 91 typedef struct ng_hook *hook_p; 92 93 /* node method definitions */ 94 typedef int ng_constructor_t(node_p node); 95 typedef int ng_close_t(node_p node); 96 typedef int ng_shutdown_t(node_p node); 97 typedef int ng_newhook_t(node_p node, hook_p hook, const char *name); 98 typedef hook_p ng_findhook_t(node_p node, const char *name); 99 typedef int ng_connect_t(hook_p hook); 100 typedef int ng_rcvmsg_t(node_p node, item_p item, hook_p lasthook); 101 typedef int ng_rcvdata_t(hook_p hook, item_p item); 102 typedef int ng_disconnect_t(hook_p hook); 103 typedef int ng_rcvitem (node_p node, hook_p hook, item_p item); 104 105 /*********************************************************************** 106 ***************** Hook Structure and Methods ************************** 107 *********************************************************************** 108 * 109 * Structure of a hook 110 */ 111 struct ng_hook { 112 char hk_name[NG_HOOKSIZ]; /* what this node knows this link as */ 113 void *hk_private; /* node dependant ID for this hook */ 114 int hk_flags; /* info about this hook/link */ 115 int hk_type; /* tbd: hook data link type */ 116 struct ng_hook *hk_peer; /* the other end of this link */ 117 struct ng_node *hk_node; /* The node this hook is attached to */ 118 LIST_ENTRY(ng_hook) hk_hooks; /* linked list of all hooks on node */ 119 ng_rcvmsg_t *hk_rcvmsg; /* control messages come here */ 120 ng_rcvdata_t *hk_rcvdata; /* data comes here */ 121 int hk_refs; /* dont actually free this till 0 */ 122 #ifdef NETGRAPH_DEBUG /*----------------------------------------------*/ 123 #define HK_MAGIC 0x78573011 124 int hk_magic; 125 char *lastfile; 126 int lastline; 127 SLIST_ENTRY(ng_hook) hk_all; /* all existing items */ 128 #endif /* NETGRAPH_DEBUG */ /*----------------------------------------------*/ 129 }; 130 /* Flags for a hook */ 131 #define HK_INVALID 0x0001 /* don't trust it! */ 132 #define HK_QUEUE 0x0002 /* queue for later delivery */ 133 #define HK_FORCE_WRITER 0x0004 /* Incoming data queued as a writer */ 134 #define HK_DEAD 0x0008 /* This is the dead hook.. don't free */ 135 #define HK_HI_STACK 0x0010 /* Hook has hi stack usage */ 136 137 /* 138 * Public Methods for hook 139 * If you can't do it with these you probably shouldn;t be doing it. 140 */ 141 void ng_unref_hook(hook_p hook); /* don't move this */ 142 #define _NG_HOOK_REF(hook) atomic_add_int(&(hook)->hk_refs, 1) 143 #define _NG_HOOK_NAME(hook) ((hook)->hk_name) 144 #define _NG_HOOK_UNREF(hook) ng_unref_hook(hook) 145 #define _NG_HOOK_SET_PRIVATE(hook, val) do {(hook)->hk_private = val;} while (0) 146 #define _NG_HOOK_SET_RCVMSG(hook, val) do {(hook)->hk_rcvmsg = val;} while (0) 147 #define _NG_HOOK_SET_RCVDATA(hook, val) do {(hook)->hk_rcvdata = val;} while (0) 148 #define _NG_HOOK_PRIVATE(hook) ((hook)->hk_private) 149 #define _NG_HOOK_NOT_VALID(hook) ((hook)->hk_flags & HK_INVALID) 150 #define _NG_HOOK_IS_VALID(hook) (!((hook)->hk_flags & HK_INVALID)) 151 #define _NG_HOOK_NODE(hook) ((hook)->hk_node) /* only rvalue! */ 152 #define _NG_HOOK_PEER(hook) ((hook)->hk_peer) /* only rvalue! */ 153 #define _NG_HOOK_FORCE_WRITER(hook) \ 154 do { hook->hk_flags |= HK_FORCE_WRITER; } while (0) 155 #define _NG_HOOK_FORCE_QUEUE(hook) do { hook->hk_flags |= HK_QUEUE; } while (0) 156 #define _NG_HOOK_HI_STACK(hook) do { hook->hk_flags |= HK_HI_STACK; } while (0) 157 158 /* Some shortcuts */ 159 #define NG_PEER_NODE(hook) NG_HOOK_NODE(NG_HOOK_PEER(hook)) 160 #define NG_PEER_HOOK_NAME(hook) NG_HOOK_NAME(NG_HOOK_PEER(hook)) 161 #define NG_PEER_NODE_NAME(hook) NG_NODE_NAME(NG_PEER_NODE(hook)) 162 163 #ifdef NETGRAPH_DEBUG /*----------------------------------------------*/ 164 #define _NN_ __FILE__,__LINE__ 165 void dumphook (hook_p hook, char *file, int line); 166 static __inline void _chkhook(hook_p hook, char *file, int line); 167 static __inline void _ng_hook_ref(hook_p hook, char * file, int line); 168 static __inline char * _ng_hook_name(hook_p hook, char * file, int line); 169 static __inline void _ng_hook_unref(hook_p hook, char * file, int line); 170 static __inline void _ng_hook_set_private(hook_p hook, 171 void * val, char * file, int line); 172 static __inline void _ng_hook_set_rcvmsg(hook_p hook, 173 ng_rcvmsg_t *val, char * file, int line); 174 static __inline void _ng_hook_set_rcvdata(hook_p hook, 175 ng_rcvdata_t *val, char * file, int line); 176 static __inline void * _ng_hook_private(hook_p hook, char * file, int line); 177 static __inline int _ng_hook_not_valid(hook_p hook, char * file, int line); 178 static __inline int _ng_hook_is_valid(hook_p hook, char * file, int line); 179 static __inline node_p _ng_hook_node(hook_p hook, char * file, int line); 180 static __inline hook_p _ng_hook_peer(hook_p hook, char * file, int line); 181 static __inline void _ng_hook_force_writer(hook_p hook, char * file, 182 int line); 183 static __inline void _ng_hook_force_queue(hook_p hook, char * file, int line); 184 185 static __inline void 186 _chkhook(hook_p hook, char *file, int line) 187 { 188 if (hook->hk_magic != HK_MAGIC) { 189 kprintf("Accessing freed hook "); 190 dumphook(hook, file, line); 191 } 192 hook->lastline = line; 193 hook->lastfile = file; 194 } 195 196 static __inline void 197 _ng_hook_ref(hook_p hook, char * file, int line) 198 { 199 _chkhook(hook, file, line); 200 _NG_HOOK_REF(hook); 201 } 202 203 static __inline char * 204 _ng_hook_name(hook_p hook, char * file, int line) 205 { 206 _chkhook(hook, file, line); 207 return (_NG_HOOK_NAME(hook)); 208 } 209 210 static __inline void 211 _ng_hook_unref(hook_p hook, char * file, int line) 212 { 213 _chkhook(hook, file, line); 214 _NG_HOOK_UNREF(hook); 215 } 216 217 static __inline void 218 _ng_hook_set_private(hook_p hook, void *val, char * file, int line) 219 { 220 _chkhook(hook, file, line); 221 _NG_HOOK_SET_PRIVATE(hook, val); 222 } 223 224 static __inline void 225 _ng_hook_set_rcvmsg(hook_p hook, ng_rcvmsg_t *val, char * file, int line) 226 { 227 _chkhook(hook, file, line); 228 _NG_HOOK_SET_RCVMSG(hook, val); 229 } 230 231 static __inline void 232 _ng_hook_set_rcvdata(hook_p hook, ng_rcvdata_t *val, char * file, int line) 233 { 234 _chkhook(hook, file, line); 235 _NG_HOOK_SET_RCVDATA(hook, val); 236 } 237 238 static __inline void * 239 _ng_hook_private(hook_p hook, char * file, int line) 240 { 241 _chkhook(hook, file, line); 242 return (_NG_HOOK_PRIVATE(hook)); 243 } 244 245 static __inline int 246 _ng_hook_not_valid(hook_p hook, char * file, int line) 247 { 248 _chkhook(hook, file, line); 249 return (_NG_HOOK_NOT_VALID(hook)); 250 } 251 252 static __inline int 253 _ng_hook_is_valid(hook_p hook, char * file, int line) 254 { 255 _chkhook(hook, file, line); 256 return (_NG_HOOK_IS_VALID(hook)); 257 } 258 259 static __inline node_p 260 _ng_hook_node(hook_p hook, char * file, int line) 261 { 262 _chkhook(hook, file, line); 263 return (_NG_HOOK_NODE(hook)); 264 } 265 266 static __inline hook_p 267 _ng_hook_peer(hook_p hook, char * file, int line) 268 { 269 _chkhook(hook, file, line); 270 return (_NG_HOOK_PEER(hook)); 271 } 272 273 static __inline void 274 _ng_hook_force_writer(hook_p hook, char * file, int line) 275 { 276 _chkhook(hook, file, line); 277 _NG_HOOK_FORCE_WRITER(hook); 278 } 279 280 static __inline void 281 _ng_hook_force_queue(hook_p hook, char * file, int line) 282 { 283 _chkhook(hook, file, line); 284 _NG_HOOK_FORCE_QUEUE(hook); 285 } 286 287 static __inline void 288 _ng_hook_hi_stack(hook_p hook, char * file, int line) 289 { 290 _chkhook(hook, file, line); 291 _NG_HOOK_HI_STACK(hook); 292 } 293 294 295 #define NG_HOOK_REF(hook) _ng_hook_ref(hook, _NN_) 296 #define NG_HOOK_NAME(hook) _ng_hook_name(hook, _NN_) 297 #define NG_HOOK_UNREF(hook) _ng_hook_unref(hook, _NN_) 298 #define NG_HOOK_SET_PRIVATE(hook, val) _ng_hook_set_private(hook, val, _NN_) 299 #define NG_HOOK_SET_RCVMSG(hook, val) _ng_hook_set_rcvmsg(hook, val, _NN_) 300 #define NG_HOOK_SET_RCVDATA(hook, val) _ng_hook_set_rcvdata(hook, val, _NN_) 301 #define NG_HOOK_PRIVATE(hook) _ng_hook_private(hook, _NN_) 302 #define NG_HOOK_NOT_VALID(hook) _ng_hook_not_valid(hook, _NN_) 303 #define NG_HOOK_IS_VALID(hook) _ng_hook_is_valid(hook, _NN_) 304 #define NG_HOOK_NODE(hook) _ng_hook_node(hook, _NN_) 305 #define NG_HOOK_PEER(hook) _ng_hook_peer(hook, _NN_) 306 #define NG_HOOK_FORCE_WRITER(hook) _ng_hook_force_writer(hook, _NN_) 307 #define NG_HOOK_FORCE_QUEUE(hook) _ng_hook_force_queue(hook, _NN_) 308 #define NG_HOOK_HI_STACK(hook) _ng_hook_hi_stack(hook, _NN_) 309 310 #else /* NETGRAPH_DEBUG */ /*----------------------------------------------*/ 311 312 #define NG_HOOK_REF(hook) _NG_HOOK_REF(hook) 313 #define NG_HOOK_NAME(hook) _NG_HOOK_NAME(hook) 314 #define NG_HOOK_UNREF(hook) _NG_HOOK_UNREF(hook) 315 #define NG_HOOK_SET_PRIVATE(hook, val) _NG_HOOK_SET_PRIVATE(hook, val) 316 #define NG_HOOK_SET_RCVMSG(hook, val) _NG_HOOK_SET_RCVMSG(hook, val) 317 #define NG_HOOK_SET_RCVDATA(hook, val) _NG_HOOK_SET_RCVDATA(hook, val) 318 #define NG_HOOK_PRIVATE(hook) _NG_HOOK_PRIVATE(hook) 319 #define NG_HOOK_NOT_VALID(hook) _NG_HOOK_NOT_VALID(hook) 320 #define NG_HOOK_IS_VALID(hook) _NG_HOOK_IS_VALID(hook) 321 #define NG_HOOK_NODE(hook) _NG_HOOK_NODE(hook) 322 #define NG_HOOK_PEER(hook) _NG_HOOK_PEER(hook) 323 #define NG_HOOK_FORCE_WRITER(hook) _NG_HOOK_FORCE_WRITER(hook) 324 #define NG_HOOK_FORCE_QUEUE(hook) _NG_HOOK_FORCE_QUEUE(hook) 325 #define NG_HOOK_HI_STACK(hook) _NG_HOOK_HI_STACK(hook) 326 327 #endif /* NETGRAPH_DEBUG */ /*----------------------------------------------*/ 328 329 /*********************************************************************** 330 ***************** Node Structure and Methods ************************** 331 *********************************************************************** 332 * Structure of a node 333 */ 334 struct ng_node { 335 char nd_name[NG_NODESIZ]; /* optional globally unique name */ 336 struct ng_type *nd_type; /* the installed 'type' */ 337 int nd_flags; /* see below for bit definitions */ 338 int nd_numhooks; /* number of hooks */ 339 void *nd_private; /* node type dependant node ID */ 340 ng_ID_t nd_ID; /* Unique per node */ 341 LIST_HEAD(hooks, ng_hook) nd_hooks; /* linked list of node hooks */ 342 LIST_ENTRY(ng_node) nd_nodes; /* name hash collision list */ 343 LIST_ENTRY(ng_node) nd_idnodes; /* ID hash collision list */ 344 struct lwkt_token nd_token; 345 int nd_refs; /* # of references to this node */ 346 #ifdef NETGRAPH_DEBUG /*----------------------------------------------*/ 347 #define ND_MAGIC 0x59264837 348 int nd_magic; 349 char *lastfile; 350 int lastline; 351 SLIST_ENTRY(ng_node) nd_all; /* all existing nodes */ 352 #endif /* NETGRAPH_DEBUG */ /*----------------------------------------------*/ 353 }; 354 355 /* Flags for a node */ 356 #define NGF_INVALID 0x00000001 /* free when refs go to 0 */ 357 #define NG_INVALID NGF_INVALID /* compat for old code */ 358 #define NGF_FORCE_WRITER 0x00000004 /* Never multithread this node */ 359 #define NG_FORCE_WRITER NGF_FORCE_WRITER /* compat for old code */ 360 #define NGF_CLOSING 0x00000008 /* ng_rmnode() at work */ 361 #define NG_CLOSING NGF_CLOSING /* compat for old code */ 362 #define NGF_REALLY_DIE 0x00000010 /* "persistent" node is unloading */ 363 #define NG_REALLY_DIE NGF_REALLY_DIE /* compat for old code */ 364 #define NGF_HI_STACK 0x00000020 /* node has hi stack usage */ 365 #define NGF_TYPE1 0x10000000 /* reserved for type specific storage */ 366 #define NGF_TYPE2 0x20000000 /* reserved for type specific storage */ 367 #define NGF_TYPE3 0x40000000 /* reserved for type specific storage */ 368 #define NGF_TYPE4 0x80000000 /* reserved for type specific storage */ 369 370 /* 371 * Public methods for nodes. 372 * If you can't do it with these you probably shouldn't be doing it. 373 */ 374 void ng_unref_node(node_p node); /* don't move this */ 375 #define _NG_NODE_NAME(node) ((node)->nd_name + 0) 376 #define _NG_NODE_HAS_NAME(node) ((node)->nd_name[0] + 0) 377 #define _NG_NODE_ID(node) ((node)->nd_ID + 0) 378 #define _NG_NODE_REF(node) atomic_add_int(&(node)->nd_refs, 1) 379 #define _NG_NODE_UNREF(node) ng_unref_node(node) 380 #define _NG_NODE_SET_PRIVATE(node, val) do {(node)->nd_private = val;} while (0) 381 #define _NG_NODE_PRIVATE(node) ((node)->nd_private) 382 #define _NG_NODE_IS_VALID(node) (!((node)->nd_flags & NGF_INVALID)) 383 #define _NG_NODE_NOT_VALID(node) ((node)->nd_flags & NGF_INVALID) 384 #define _NG_NODE_NUMHOOKS(node) ((node)->nd_numhooks + 0) /* rvalue */ 385 #define _NG_NODE_FORCE_WRITER(node) \ 386 do{ node->nd_flags |= NGF_FORCE_WRITER; }while (0) 387 #define _NG_NODE_HI_STACK(node) \ 388 do{ node->nd_flags |= NGF_HI_STACK; }while (0) 389 #define _NG_NODE_REALLY_DIE(node) \ 390 do{ node->nd_flags |= (NGF_REALLY_DIE|NGF_INVALID); }while (0) 391 #define _NG_NODE_REVIVE(node) \ 392 do { node->nd_flags &= ~NGF_INVALID; } while (0) 393 /* 394 * The hook iterator. 395 * This macro will call a function of type ng_fn_eachhook for each 396 * hook attached to the node. If the function returns 0, then the 397 * iterator will stop and return a pointer to the hook that returned 0. 398 */ 399 typedef int ng_fn_eachhook(hook_p hook, void* arg); 400 #define _NG_NODE_FOREACH_HOOK(node, fn, arg, rethook) \ 401 do { \ 402 hook_p _hook; \ 403 (rethook) = NULL; \ 404 LIST_FOREACH(_hook, &((node)->nd_hooks), hk_hooks) { \ 405 if ((fn)(_hook, arg) == 0) { \ 406 (rethook) = _hook; \ 407 break; \ 408 } \ 409 } \ 410 } while (0) 411 412 #ifdef NETGRAPH_DEBUG /*----------------------------------------------*/ 413 void dumpnode(node_p node, char *file, int line); 414 static __inline void _chknode(node_p node, char *file, int line); 415 static __inline char * _ng_node_name(node_p node, char *file, int line); 416 static __inline int _ng_node_has_name(node_p node, char *file, int line); 417 static __inline ng_ID_t _ng_node_id(node_p node, char *file, int line); 418 static __inline void _ng_node_ref(node_p node, char *file, int line); 419 static __inline int _ng_node_unref(node_p node, char *file, int line); 420 static __inline void _ng_node_set_private(node_p node, void * val, 421 char *file, int line); 422 static __inline void * _ng_node_private(node_p node, char *file, int line); 423 static __inline int _ng_node_is_valid(node_p node, char *file, int line); 424 static __inline int _ng_node_not_valid(node_p node, char *file, int line); 425 static __inline int _ng_node_numhooks(node_p node, char *file, int line); 426 static __inline void _ng_node_force_writer(node_p node, char *file, int line); 427 static __inline hook_p _ng_node_foreach_hook(node_p node, 428 ng_fn_eachhook *fn, void *arg, char *file, int line); 429 static __inline void _ng_node_revive(node_p node, char *file, int line); 430 431 static __inline void 432 _chknode(node_p node, char *file, int line) 433 { 434 if (node->nd_magic != ND_MAGIC) { 435 kprintf("Accessing freed node "); 436 dumpnode(node, file, line); 437 } 438 node->lastline = line; 439 node->lastfile = file; 440 } 441 442 static __inline char * 443 _ng_node_name(node_p node, char *file, int line) 444 { 445 _chknode(node, file, line); 446 return(_NG_NODE_NAME(node)); 447 } 448 449 static __inline int 450 _ng_node_has_name(node_p node, char *file, int line) 451 { 452 _chknode(node, file, line); 453 return(_NG_NODE_HAS_NAME(node)); 454 } 455 456 static __inline ng_ID_t 457 _ng_node_id(node_p node, char *file, int line) 458 { 459 _chknode(node, file, line); 460 return(_NG_NODE_ID(node)); 461 } 462 463 static __inline void 464 _ng_node_ref(node_p node, char *file, int line) 465 { 466 _chknode(node, file, line); 467 _NG_NODE_REF(node); 468 } 469 470 static __inline int 471 _ng_node_unref(node_p node, char *file, int line) 472 { 473 _chknode(node, file, line); 474 return (_NG_NODE_UNREF(node)); 475 } 476 477 static __inline void 478 _ng_node_set_private(node_p node, void * val, char *file, int line) 479 { 480 _chknode(node, file, line); 481 _NG_NODE_SET_PRIVATE(node, val); 482 } 483 484 static __inline void * 485 _ng_node_private(node_p node, char *file, int line) 486 { 487 _chknode(node, file, line); 488 return (_NG_NODE_PRIVATE(node)); 489 } 490 491 static __inline int 492 _ng_node_is_valid(node_p node, char *file, int line) 493 { 494 _chknode(node, file, line); 495 return(_NG_NODE_IS_VALID(node)); 496 } 497 498 static __inline int 499 _ng_node_not_valid(node_p node, char *file, int line) 500 { 501 _chknode(node, file, line); 502 return(_NG_NODE_NOT_VALID(node)); 503 } 504 505 static __inline int 506 _ng_node_numhooks(node_p node, char *file, int line) 507 { 508 _chknode(node, file, line); 509 return(_NG_NODE_NUMHOOKS(node)); 510 } 511 512 static __inline void 513 _ng_node_force_writer(node_p node, char *file, int line) 514 { 515 _chknode(node, file, line); 516 _NG_NODE_FORCE_WRITER(node); 517 } 518 519 static __inline void 520 _ng_node_hi_stack(node_p node, char *file, int line) 521 { 522 _chknode(node, file, line); 523 _NG_NODE_HI_STACK(node); 524 } 525 526 static __inline void 527 _ng_node_really_die(node_p node, char *file, int line) 528 { 529 _chknode(node, file, line); 530 _NG_NODE_REALLY_DIE(node); 531 } 532 533 static __inline void 534 _ng_node_revive(node_p node, char *file, int line) 535 { 536 _chknode(node, file, line); 537 _NG_NODE_REVIVE(node); 538 } 539 540 static __inline hook_p 541 _ng_node_foreach_hook(node_p node, ng_fn_eachhook *fn, void *arg, 542 char *file, int line) 543 { 544 hook_p hook; 545 _chknode(node, file, line); 546 _NG_NODE_FOREACH_HOOK(node, fn, arg, hook); 547 return (hook); 548 } 549 550 #define NG_NODE_NAME(node) _ng_node_name(node, _NN_) 551 #define NG_NODE_HAS_NAME(node) _ng_node_has_name(node, _NN_) 552 #define NG_NODE_ID(node) _ng_node_id(node, _NN_) 553 #define NG_NODE_REF(node) _ng_node_ref(node, _NN_) 554 #define NG_NODE_UNREF(node) _ng_node_unref(node, _NN_) 555 #define NG_NODE_SET_PRIVATE(node, val) _ng_node_set_private(node, val, _NN_) 556 #define NG_NODE_PRIVATE(node) _ng_node_private(node, _NN_) 557 #define NG_NODE_IS_VALID(node) _ng_node_is_valid(node, _NN_) 558 #define NG_NODE_NOT_VALID(node) _ng_node_not_valid(node, _NN_) 559 #define NG_NODE_FORCE_WRITER(node) _ng_node_force_writer(node, _NN_) 560 #define NG_NODE_HI_STACK(node) _ng_node_hi_stack(node, _NN_) 561 #define NG_NODE_REALLY_DIE(node) _ng_node_really_die(node, _NN_) 562 #define NG_NODE_NUMHOOKS(node) _ng_node_numhooks(node, _NN_) 563 #define NG_NODE_REVIVE(node) _ng_node_revive(node, _NN_) 564 #define NG_NODE_FOREACH_HOOK(node, fn, arg, rethook) \ 565 do { \ 566 rethook = _ng_node_foreach_hook(node, fn, (void *)arg, _NN_); \ 567 } while (0) 568 569 #else /* NETGRAPH_DEBUG */ /*----------------------------------------------*/ 570 571 #define NG_NODE_NAME(node) _NG_NODE_NAME(node) 572 #define NG_NODE_HAS_NAME(node) _NG_NODE_HAS_NAME(node) 573 #define NG_NODE_ID(node) _NG_NODE_ID(node) 574 #define NG_NODE_REF(node) _NG_NODE_REF(node) 575 #define NG_NODE_UNREF(node) _NG_NODE_UNREF(node) 576 #define NG_NODE_SET_PRIVATE(node, val) _NG_NODE_SET_PRIVATE(node, val) 577 #define NG_NODE_PRIVATE(node) _NG_NODE_PRIVATE(node) 578 #define NG_NODE_IS_VALID(node) _NG_NODE_IS_VALID(node) 579 #define NG_NODE_NOT_VALID(node) _NG_NODE_NOT_VALID(node) 580 #define NG_NODE_FORCE_WRITER(node) _NG_NODE_FORCE_WRITER(node) 581 #define NG_NODE_HI_STACK(node) _NG_NODE_HI_STACK(node) 582 #define NG_NODE_REALLY_DIE(node) _NG_NODE_REALLY_DIE(node) 583 #define NG_NODE_NUMHOOKS(node) _NG_NODE_NUMHOOKS(node) 584 #define NG_NODE_REVIVE(node) _NG_NODE_REVIVE(node) 585 #define NG_NODE_FOREACH_HOOK(node, fn, arg, rethook) \ 586 _NG_NODE_FOREACH_HOOK(node, fn, arg, rethook) 587 #endif /* NETGRAPH_DEBUG */ /*----------------------------------------------*/ 588 589 /*********************************************************************** 590 ************* Node Queue and Item Structures and Methods ************** 591 *********************************************************************** 592 * 593 */ 594 typedef void ng_item_fn(node_p node, hook_p hook, void *arg1, int arg2); 595 typedef int ng_item_fn2(node_p node, struct ng_item *item, hook_p hook); 596 typedef void ng_apply_t(void *context, int error); 597 struct ng_apply_info { 598 ng_apply_t *apply; 599 void *context; 600 }; 601 struct ng_item { 602 struct lwkt_msg el_lmsg; 603 u_long el_flags; 604 STAILQ_ENTRY(ng_item) el_next; 605 node_p el_dest; /* The node it will be applied against (or NULL) */ 606 hook_p el_hook; /* Entering hook. Optional in Control messages */ 607 union { 608 struct mbuf *da_m; 609 struct { 610 struct ng_mesg *msg_msg; 611 ng_ID_t msg_retaddr; 612 } msg; 613 struct { 614 union { 615 ng_item_fn *fn_fn; 616 ng_item_fn2 *fn_fn2; 617 } fn_fn; 618 void *fn_arg1; 619 int fn_arg2; 620 } fn; 621 } body; 622 /* 623 * Optional callback called when item is being applied, 624 * and its context. 625 */ 626 struct ng_apply_info *apply; 627 u_int refs; 628 #ifdef NETGRAPH_DEBUG /*----------------------------------------------*/ 629 char *lastfile; 630 int lastline; 631 TAILQ_ENTRY(ng_item) all; /* all existing items */ 632 #endif /* NETGRAPH_DEBUG */ /*----------------------------------------------*/ 633 }; 634 635 #define NGQF_TYPE 0x03 /* MASK of content definition */ 636 #define NGQF_MESG 0x00 /* the queue element is a message */ 637 #define NGQF_DATA 0x01 /* the queue element is data */ 638 #define NGQF_FN 0x02 /* the queue element is a function */ 639 #define NGQF_FN2 0x03 /* the queue element is a new function */ 640 641 #define NGQF_RW 0x04 /* MASK for wanted queue mode */ 642 #define NGQF_READER 0x04 /* wants to be a reader */ 643 #define NGQF_WRITER 0x00 /* wants to be a writer */ 644 645 #define NGQF_QMODE 0x08 /* MASK for how it was queued */ 646 #define NGQF_QREADER 0x08 /* was queued as a reader */ 647 #define NGQF_QWRITER 0x00 /* was queued as a writer */ 648 649 #define NGQF_FREE 0x10 /* mark for freeing */ 650 651 /* 652 * Get the mbuf (etc) out of an item. 653 * Sets the value in the item to NULL in case we need to call NG_FREE_ITEM() 654 * with it, (to avoid freeing the things twice). 655 * If you don't want to zero out the item then realise that the 656 * item still owns it. 657 * Retaddr is different. There are no references on that. It's just a number. 658 * The debug versions must be either all used everywhere or not at all. 659 */ 660 661 #define _NGI_M(i) ((i)->body.da_m) 662 #define _NGI_MSG(i) ((i)->body.msg.msg_msg) 663 #define _NGI_RETADDR(i) ((i)->body.msg.msg_retaddr) 664 #define _NGI_FN(i) ((i)->body.fn.fn_fn.fn_fn) 665 #define _NGI_FN2(i) ((i)->body.fn.fn_fn.fn_fn2) 666 #define _NGI_ARG1(i) ((i)->body.fn.fn_arg1) 667 #define _NGI_ARG2(i) ((i)->body.fn.fn_arg2) 668 #define _NGI_NODE(i) ((i)->el_dest) 669 #define _NGI_HOOK(i) ((i)->el_hook) 670 #define _NGI_SET_HOOK(i,h) do { _NGI_HOOK(i) = h; h = NULL;} while (0) 671 #define _NGI_CLR_HOOK(i) do { \ 672 hook_p _hook = _NGI_HOOK(i); \ 673 if (_hook) { \ 674 _NG_HOOK_UNREF(_hook); \ 675 _NGI_HOOK(i) = NULL; \ 676 } \ 677 } while (0) 678 #define _NGI_SET_NODE(i,n) do { _NGI_NODE(i) = n; n = NULL;} while (0) 679 #define _NGI_CLR_NODE(i) do { \ 680 node_p _node = _NGI_NODE(i); \ 681 if (_node) { \ 682 _NG_NODE_UNREF(_node); \ 683 _NGI_NODE(i) = NULL; \ 684 } \ 685 } while (0) 686 687 #ifdef NETGRAPH_DEBUG /*----------------------------------------------*/ 688 void dumpitem(item_p item, char *file, int line); 689 static __inline void _ngi_check(item_p item, char *file, int line) ; 690 static __inline struct mbuf ** _ngi_m(item_p item, char *file, int line) ; 691 static __inline ng_ID_t * _ngi_retaddr(item_p item, char *file, int line); 692 static __inline struct ng_mesg ** _ngi_msg(item_p item, char *file, int line) ; 693 static __inline ng_item_fn ** _ngi_fn(item_p item, char *file, int line) ; 694 static __inline ng_item_fn2 ** _ngi_fn2(item_p item, char *file, int line) ; 695 static __inline void ** _ngi_arg1(item_p item, char *file, int line) ; 696 static __inline int * _ngi_arg2(item_p item, char *file, int line) ; 697 static __inline node_p _ngi_node(item_p item, char *file, int line); 698 static __inline hook_p _ngi_hook(item_p item, char *file, int line); 699 700 static __inline void 701 _ngi_check(item_p item, char *file, int line) 702 { 703 (item)->lastline = line; 704 (item)->lastfile = file; 705 } 706 707 static __inline struct mbuf ** 708 _ngi_m(item_p item, char *file, int line) 709 { 710 _ngi_check(item, file, line); 711 return (&_NGI_M(item)); 712 } 713 714 static __inline struct ng_mesg ** 715 _ngi_msg(item_p item, char *file, int line) 716 { 717 _ngi_check(item, file, line); 718 return (&_NGI_MSG(item)); 719 } 720 721 static __inline ng_ID_t * 722 _ngi_retaddr(item_p item, char *file, int line) 723 { 724 _ngi_check(item, file, line); 725 return (&_NGI_RETADDR(item)); 726 } 727 728 static __inline ng_item_fn ** 729 _ngi_fn(item_p item, char *file, int line) 730 { 731 _ngi_check(item, file, line); 732 return (&_NGI_FN(item)); 733 } 734 735 static __inline ng_item_fn2 ** 736 _ngi_fn2(item_p item, char *file, int line) 737 { 738 _ngi_check(item, file, line); 739 return (&_NGI_FN2(item)); 740 } 741 742 static __inline void ** 743 _ngi_arg1(item_p item, char *file, int line) 744 { 745 _ngi_check(item, file, line); 746 return (&_NGI_ARG1(item)); 747 } 748 749 static __inline int * 750 _ngi_arg2(item_p item, char *file, int line) 751 { 752 _ngi_check(item, file, line); 753 return (&_NGI_ARG2(item)); 754 } 755 756 static __inline node_p 757 _ngi_node(item_p item, char *file, int line) 758 { 759 _ngi_check(item, file, line); 760 return (_NGI_NODE(item)); 761 } 762 763 static __inline hook_p 764 _ngi_hook(item_p item, char *file, int line) 765 { 766 _ngi_check(item, file, line); 767 return (_NGI_HOOK(item)); 768 } 769 770 #define NGI_M(i) (*_ngi_m(i, _NN_)) 771 #define NGI_MSG(i) (*_ngi_msg(i, _NN_)) 772 #define NGI_RETADDR(i) (*_ngi_retaddr(i, _NN_)) 773 #define NGI_FN(i) (*_ngi_fn(i, _NN_)) 774 #define NGI_FN2(i) (*_ngi_fn2(i, _NN_)) 775 #define NGI_ARG1(i) (*_ngi_arg1(i, _NN_)) 776 #define NGI_ARG2(i) (*_ngi_arg2(i, _NN_)) 777 #define NGI_HOOK(i) _ngi_hook(i, _NN_) 778 #define NGI_NODE(i) _ngi_node(i, _NN_) 779 #define NGI_SET_HOOK(i,h) \ 780 do { _ngi_check(i, _NN_); _NGI_SET_HOOK(i, h); } while (0) 781 #define NGI_CLR_HOOK(i) \ 782 do { _ngi_check(i, _NN_); _NGI_CLR_HOOK(i); } while (0) 783 #define NGI_SET_NODE(i,n) \ 784 do { _ngi_check(i, _NN_); _NGI_SET_NODE(i, n); } while (0) 785 #define NGI_CLR_NODE(i) \ 786 do { _ngi_check(i, _NN_); _NGI_CLR_NODE(i); } while (0) 787 788 #define NG_FREE_ITEM(item) \ 789 do { \ 790 _ngi_check(item, _NN_); \ 791 item->el_flags |= NGQF_FREE; \ 792 item = NULL; \ 793 } while (0) 794 795 #define SAVE_LINE(item) \ 796 do { \ 797 (item)->lastline = __LINE__; \ 798 (item)->lastfile = __FILE__; \ 799 } while (0) 800 801 #else /* NETGRAPH_DEBUG */ /*----------------------------------------------*/ 802 803 #define NGI_M(i) _NGI_M(i) 804 #define NGI_MSG(i) _NGI_MSG(i) 805 #define NGI_RETADDR(i) _NGI_RETADDR(i) 806 #define NGI_FN(i) _NGI_FN(i) 807 #define NGI_FN2(i) _NGI_FN2(i) 808 #define NGI_ARG1(i) _NGI_ARG1(i) 809 #define NGI_ARG2(i) _NGI_ARG2(i) 810 #define NGI_NODE(i) _NGI_NODE(i) 811 #define NGI_HOOK(i) _NGI_HOOK(i) 812 #define NGI_SET_HOOK(i,h) _NGI_SET_HOOK(i,h) 813 #define NGI_CLR_HOOK(i) _NGI_CLR_HOOK(i) 814 #define NGI_SET_NODE(i,n) _NGI_SET_NODE(i,n) 815 #define NGI_CLR_NODE(i) _NGI_CLR_NODE(i) 816 817 #define NG_FREE_ITEM(item) \ 818 do { \ 819 KKASSERT(!(item->el_flags & NGQF_FREE)); \ 820 item->el_flags |= NGQF_FREE; \ 821 } while (0) 822 #define SAVE_LINE(item) do {} while (0) 823 824 #endif /* NETGRAPH_DEBUG */ /*----------------------------------------------*/ 825 826 #define NGI_GET_M(i,m) \ 827 do { \ 828 (m) = NGI_M(i); \ 829 _NGI_M(i) = NULL; \ 830 } while (0) 831 832 #define NGI_GET_MSG(i,m) \ 833 do { \ 834 (m) = NGI_MSG(i); \ 835 _NGI_MSG(i) = NULL; \ 836 } while (0) 837 838 #define NGI_GET_NODE(i,n) /* YOU NOW HAVE THE REFERENCE */ \ 839 do { \ 840 (n) = NGI_NODE(i); \ 841 _NGI_NODE(i) = NULL; \ 842 } while (0) 843 844 #define NGI_GET_HOOK(i,h) \ 845 do { \ 846 (h) = NGI_HOOK(i); \ 847 _NGI_HOOK(i) = NULL; \ 848 } while (0) 849 850 #define NGI_SET_WRITER(i) ((i)->el_flags &= ~NGQF_QMODE) 851 #define NGI_SET_READER(i) ((i)->el_flags |= NGQF_QREADER) 852 853 #define NGI_QUEUED_READER(i) ((i)->el_flags & NGQF_QREADER) 854 #define NGI_QUEUED_WRITER(i) (((i)->el_flags & NGQF_QMODE) == NGQF_QWRITER) 855 856 /********************************************************************** 857 * Data macros. Send, manipulate and free. 858 **********************************************************************/ 859 /* 860 * Assuming the data is already ok, just set the new address and send 861 */ 862 #define NG_FWD_ITEM_HOOK_FLAGS(error, item, hook, flags) \ 863 do { \ 864 (error) = \ 865 ng_address_hook(NULL, (item), (hook), NG_NOFLAGS); \ 866 if (error == 0) { \ 867 SAVE_LINE(item); \ 868 (error) = ng_snd_item((item), (flags)); \ 869 } \ 870 (item) = NULL; \ 871 } while (0) 872 #define NG_FWD_ITEM_HOOK(error, item, hook) \ 873 NG_FWD_ITEM_HOOK_FLAGS(error, item, hook, NG_NOFLAGS) 874 875 /* 876 * Forward a data packet. Mbuf pointer is updated to new value. We 877 * presume you dealt with the old one when you update it to the new one 878 * (or it maybe the old one). We got a packet and possibly had to modify 879 * the mbuf. You should probably use NGI_GET_M() if you are going to use 880 * this too. 881 */ 882 #define NG_FWD_NEW_DATA_FLAGS(error, item, hook, m, flags) \ 883 do { \ 884 NGI_M(item) = (m); \ 885 (m) = NULL; \ 886 NG_FWD_ITEM_HOOK_FLAGS(error, item, hook, flags); \ 887 } while (0) 888 #define NG_FWD_NEW_DATA(error, item, hook, m) \ 889 NG_FWD_NEW_DATA_FLAGS(error, item, hook, m, NG_NOFLAGS) 890 891 /* Send a previously unpackaged mbuf. XXX: This should be called 892 * NG_SEND_DATA in future, but this name is kept for compatibility 893 * reasons. 894 */ 895 #define NG_SEND_DATA_FLAGS(error, hook, m, flags) \ 896 do { \ 897 item_p _item; \ 898 if ((_item = ng_package_data((m), flags))) { \ 899 NG_FWD_ITEM_HOOK_FLAGS(error, _item, hook, flags);\ 900 } else { \ 901 (error) = ENOMEM; \ 902 } \ 903 (m) = NULL; \ 904 } while (0) 905 906 #define NG_SEND_DATA_ONLY(error, hook, m) \ 907 NG_SEND_DATA_FLAGS(error, hook, m, NG_NOFLAGS) 908 /* NG_SEND_DATA() compat for meta-data times */ 909 #define NG_SEND_DATA(error, hook, m, x) \ 910 NG_SEND_DATA_FLAGS(error, hook, m, NG_NOFLAGS) 911 912 #define NG_FREE_MSG(msg) \ 913 do { \ 914 if ((msg)) { \ 915 kfree((msg), M_NETGRAPH_MSG); \ 916 (msg) = NULL; \ 917 } \ 918 } while (0) 919 920 #define NG_FREE_M(m) \ 921 do { \ 922 if ((m)) { \ 923 m_freem((m)); \ 924 (m) = NULL; \ 925 } \ 926 } while (0) 927 928 /***************************************** 929 * Message macros 930 *****************************************/ 931 932 #define NG_SEND_MSG_HOOK(error, here, msg, hook, retaddr) \ 933 do { \ 934 item_p _item; \ 935 if ((_item = ng_package_msg(msg, NG_NOFLAGS)) == NULL) {\ 936 (msg) = NULL; \ 937 (error) = ENOMEM; \ 938 break; \ 939 } \ 940 if (((error) = ng_address_hook((here), (_item), \ 941 (hook), (retaddr))) == 0) { \ 942 SAVE_LINE(_item); \ 943 (error) = ng_snd_item((_item), 0); \ 944 } \ 945 (msg) = NULL; \ 946 } while (0) 947 948 #define NG_SEND_MSG_PATH(error, here, msg, path, retaddr) \ 949 do { \ 950 item_p _item; \ 951 if ((_item = ng_package_msg(msg, NG_NOFLAGS)) == NULL) {\ 952 (msg) = NULL; \ 953 (error) = ENOMEM; \ 954 break; \ 955 } \ 956 if (((error) = ng_address_path((here), (_item), \ 957 (path), (retaddr))) == 0) { \ 958 SAVE_LINE(_item); \ 959 (error) = ng_snd_item((_item), 0); \ 960 } \ 961 (msg) = NULL; \ 962 } while (0) 963 964 #define NG_SEND_MSG_ID(error, here, msg, ID, retaddr) \ 965 do { \ 966 item_p _item; \ 967 if ((_item = ng_package_msg(msg, NG_NOFLAGS)) == NULL) {\ 968 (msg) = NULL; \ 969 (error) = ENOMEM; \ 970 break; \ 971 } \ 972 if (((error) = ng_address_ID((here), (_item), \ 973 (ID), (retaddr))) == 0) { \ 974 SAVE_LINE(_item); \ 975 (error) = ng_snd_item((_item), 0); \ 976 } \ 977 (msg) = NULL; \ 978 } while (0) 979 980 /* 981 * Redirect the message to the next hop using the given hook. 982 * ng_retarget_msg() frees the item if there is an error 983 * and returns an error code. It returns 0 on success. 984 */ 985 #define NG_FWD_MSG_HOOK(error, here, item, hook, retaddr) \ 986 do { \ 987 if (((error) = ng_address_hook((here), (item), \ 988 (hook), (retaddr))) == 0) { \ 989 SAVE_LINE(item); \ 990 (error) = ng_snd_item((item), 0); \ 991 } \ 992 (item) = NULL; \ 993 } while (0) 994 995 /* 996 * Send a queue item back to it's originator with a response message. 997 * Assume original message was removed and freed separatly. 998 */ 999 #define NG_RESPOND_MSG(error, here, item, resp) \ 1000 do { \ 1001 if (resp) { \ 1002 ng_ID_t _dest = NGI_RETADDR(item); \ 1003 NGI_RETADDR(item) = 0; \ 1004 NGI_MSG(item) = resp; \ 1005 if ((error = ng_address_ID((here), (item), \ 1006 _dest, 0)) == 0) { \ 1007 SAVE_LINE(item); \ 1008 (error) = ng_snd_item((item), NG_QUEUE);\ 1009 } \ 1010 } else { \ 1011 NG_FREE_ITEM(item); \ 1012 } \ 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) 1144 apply_p ng_alloc_apply(void); 1145 void ng_free_apply(apply_p apply); 1146 1147 /* Flags for netgraph functions. */ 1148 #define NG_NOFLAGS 0x00000000 /* no special options */ 1149 #define NG_QUEUE 0x00000001 /* enqueue item, don't dispatch */ 1150 #define NG_WAITOK 0x00000002 /* use M_WAITOK, etc. */ 1151 /* XXXGL: NG_PROGRESS unused since ng_base.c rev. 1.136. Should be deleted? */ 1152 #define NG_PROGRESS 0x00000004 /* return EINPROGRESS if queued */ 1153 #define NG_REUSE_ITEM 0x00000008 /* supplied item should be reused */ 1154 1155 /* 1156 * prototypes the user should DEFINITELY not use directly 1157 */ 1158 void ng_free_item(item_p item); /* Use NG_FREE_ITEM instead */ 1159 int ng_mod_event(module_t mod, int what, void *arg); 1160 1161 /* 1162 * Tag definitions and constants 1163 */ 1164 1165 #define NG_TAG_PRIO 1 1166 1167 struct ng_tag_prio { 1168 struct m_tag tag; 1169 char priority; 1170 char discardability; 1171 }; 1172 1173 #define NG_PRIO_CUTOFF 32 1174 #define NG_PRIO_LINKSTATE 64 1175 1176 /* Macros and declarations to keep compatibility with metadata, which 1177 * is obsoleted now. To be deleted. 1178 */ 1179 typedef void *meta_p; 1180 #define _NGI_META(i) NULL 1181 #define NGI_META(i) NULL 1182 #define NG_FREE_META(meta) 1183 #define NGI_GET_META(i,m) 1184 #define ng_copy_meta(meta) NULL 1185 1186 #endif /* _NETGRAPH_NETGRAPH_H_ */ 1187