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