5 * Copyright (c) 1996-1999 Whistle Communications, Inc.
8 * Subject to the following obligations and disclaimer of warranty, use and
9 * redistribution of this software, in source or object code forms, with or
10 * without modifications are expressly permitted by Whistle Communications;
11 * provided, however, that:
12 * 1. Any and all reproductions of the source or object code must include the
13 * copyright notice above and the following disclaimer of warranties; and
14 * 2. No rights are granted, in any manner or form, to use Whistle
15 * Communications, Inc. trademarks, including the mark "WHISTLE
16 * COMMUNICATIONS" on advertising, endorsements, or otherwise except as
17 * such appears in the above copyright notice or in the software.
19 * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
20 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
21 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
22 * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
23 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
24 * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
25 * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
26 * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
27 * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
28 * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
29 * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
30 * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
31 * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34 * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
37 * Author: Julian Elischer <julian@freebsd.org>
39 * $FreeBSD: src/sys/netgraph/netgraph.h,v 1.6.2.7 2002/04/14 23:31:08 julian Exp $
40 * $DragonFly: src/sys/netgraph/netgraph.h,v 1.2 2003/06/17 04:28:49 dillon Exp $
41 * $Whistle: netgraph.h,v 1.29 1999/11/01 07:56:13 julian Exp $
44 #ifndef _NETGRAPH_NETGRAPH_H_
45 #define _NETGRAPH_NETGRAPH_H_ 1
47 #include <sys/queue.h>
48 #include <sys/malloc.h>
49 #include <sys/module.h>
52 #error "This file should not be included in user level programs"
55 #define NG_ABI_VERSION NG_VERSION
61 char *name; /* what this node knows this link as */
62 void *private; /* node dependant ID for this hook */
63 int flags; /* info about this hook/link */
64 int refs; /* dont actually free this till 0 */
65 struct ng_hook *peer; /* the other end of this link */
66 struct ng_node *node; /* The node this hook is attached to */
67 LIST_ENTRY(ng_hook) hooks; /* linked list of all hooks on node */
69 typedef struct ng_hook *hook_p;
71 /* Flags for a hook */
72 #define HK_INVALID 0x0001 /* don't trust it! */
74 void ng_unref_hook(hook_p hook); /* don't move this */
75 #define NG_HOOK_REF(hook) atomic_add_int(&(hook)->refs, 1)
76 #define NG_HOOK_NAME(hook) ((hook)->name)
77 #define NG_HOOK_UNREF(hook) ng_unref_hook(hook)
78 #define NG_HOOK_SET_PRIVATE(hook, val) do {(hook)->private = val;} while (0)
79 #define NG_HOOK_SET_RCVMSG(hook, val) do {(hook)->rcvmsg = val;} while (0)
80 #define NG_HOOK_SET_RCVDATA(hook, val) do {(hook)->rcvdata = val;} while (0)
81 #define NG_HOOK_PRIVATE(hook) ((hook)->private)
82 #define NG_HOOK_NOT_VALID(hook) ((hook)->flags & HK_INVALID)
83 #define NG_HOOK_IS_VALID(hook) (!((hook)->flags & HK_INVALID))
84 #define NG_HOOK_NODE(hook) ((hook)->node) /* only rvalue! */
85 #define NG_HOOK_PEER(hook) ((hook)->peer) /* only rvalue! */
88 #define NG_PEER_NODE(hook) NG_HOOK_NODE(NG_HOOK_PEER(hook))
89 #define NG_PEER_HOOK_NAME(hook) NG_HOOK_NAME(NG_HOOK_PEER(hook))
90 #define NG_PEER_NODE_NAME(hook) NG_NODE_NAME(NG_PEER_NODE(hook))
96 char *name; /* optional globally unique name */
97 struct ng_type *type; /* the installed 'type' */
98 int flags; /* see below for bit definitions */
99 int sleepers; /* #procs sleeping on this node */
100 int refs; /* number of references to this node */
101 int numhooks; /* number of hooks */
102 int colour; /* for graph colouring algorithms */
103 void *private; /* node type dependant node ID */
104 ng_ID_t ID; /* Unique per node */
105 LIST_HEAD(hooks, ng_hook) hooks; /* linked list of node hooks */
106 LIST_ENTRY(ng_node) nodes; /* linked list of all nodes */
107 LIST_ENTRY(ng_node) idnodes; /* ID hash collision list */
109 typedef struct ng_node *node_p;
111 /* Flags for a node */
112 #define NG_INVALID 0x001 /* free when all sleepers and refs go to 0 */
113 #define NG_BUSY 0x002 /* callers should sleep or wait */
114 #define NG_TOUCHED 0x004 /* to avoid cycles when 'flooding' */
115 #define NGF_TYPE1 0x10000000 /* reserved for type specific storage */
116 #define NGF_TYPE2 0x20000000 /* reserved for type specific storage */
117 #define NGF_TYPE3 0x40000000 /* reserved for type specific storage */
118 #define NGF_TYPE4 0x80000000 /* reserved for type specific storage */
120 void ng_unref_node(node_p node); /* don't move this */
121 #define NG_NODE_NAME(node) ((node)->name + 0)
122 #define NG_NODE_HAS_NAME(node) ((node)->name[0] + 0)
123 #define NG_NODE_ID(node) ((node)->ID + 0)
124 #define NG_NODE_REF(node) atomic_add_int(&(node)->refs, 1)
125 #define NG_NODE_UNREF(node) ng_unref(node)
126 #define NG_NODE_SET_PRIVATE(node, val) do {(node)->private = val;} while (0)
127 #define NG_NODE_PRIVATE(node) ((node)->private)
128 #define NG_NODE_IS_VALID(node) (!((node)->flags & NG_INVALID))
129 #define NG_NODE_NOT_VALID(node) ((node)->flags & NG_INVALID)
130 #define NG_NODE_NUMHOOKS(node) ((node)->numhooks + 0) /* rvalue */
133 * The structure that holds meta_data about a data packet (e.g. priority)
134 * Nodes might add or subtract options as needed if there is room.
135 * They might reallocate the struct to make more room if they need to.
136 * Meta-data is still experimental.
138 struct meta_field_header {
139 u_long cookie; /* cookie for the field. Skip fields you don't
140 * know about (same cookie as in messgaes) */
141 u_short type; /* field ID */
142 u_short len; /* total len of this field including extra
144 char data[0]; /* data starts here */
147 /* To zero out an option 'in place' set it's cookie to this */
148 #define NGM_INVALID_COOKIE 865455152
150 /* This part of the metadata is always present if the pointer is non NULL */
152 char priority; /* -ve is less priority, 0 is default */
153 char discardability; /* higher is less valuable.. discard first */
154 u_short allocated_len; /* amount malloc'd */
155 u_short used_len; /* sum of all fields, options etc. */
156 u_short flags; /* see below.. generic flags */
157 struct meta_field_header options[0]; /* add as (if) needed */
159 typedef struct ng_meta *meta_p;
161 /* Flags for meta-data */
162 #define NGMF_TEST 0x01 /* discard at the last moment before sending */
163 #define NGMF_TRACE 0x02 /* trace when handing this data to a node */
165 /* node method definitions */
166 typedef int ng_constructor_t(node_p *node);
167 typedef int ng_rcvmsg_t(node_p node, struct ng_mesg *msg,
168 const char *retaddr, struct ng_mesg **resp);
169 typedef int ng_shutdown_t(node_p node);
170 typedef int ng_newhook_t(node_p node, hook_p hook, const char *name);
171 typedef hook_p ng_findhook_t(node_p node, const char *name);
172 typedef int ng_connect_t(hook_p hook);
173 typedef int ng_rcvdata_t(hook_p hook, struct mbuf *m, meta_p meta);
174 typedef int ng_disconnect_t(hook_p hook);
177 * Command list -- each node type specifies the command that it knows
178 * how to convert between ASCII and binary using an array of these.
179 * The last element in the array must be a terminator with cookie=0.
183 u_int32_t cookie; /* command typecookie */
184 int cmd; /* command number */
185 const char *name; /* command name */
186 const struct ng_parse_type *mesgType; /* args if !NGF_RESP */
187 const struct ng_parse_type *respType; /* args if NGF_RESP */
191 * Structure of a node type
195 u_int32_t version; /* must equal NG_VERSION */
196 const char *name; /* Unique type name */
197 modeventhand_t mod_event; /* Module event handler (optional) */
198 ng_constructor_t *constructor; /* Node constructor */
199 ng_rcvmsg_t *rcvmsg; /* control messages come here */
200 ng_shutdown_t *shutdown; /* reset, and free resources */
201 ng_newhook_t *newhook; /* first notification of new hook */
202 ng_findhook_t *findhook; /* only if you have lots of hooks */
203 ng_connect_t *connect; /* final notification of new hook */
204 ng_rcvdata_t *rcvdata; /* date comes here */
205 ng_rcvdata_t *rcvdataq; /* or here if being queued */
206 ng_disconnect_t *disconnect; /* notify on disconnect */
208 const struct ng_cmdlist *cmdlist; /* commands we can convert */
210 /* R/W data private to the base netgraph code DON'T TOUCH! */
211 LIST_ENTRY(ng_type) types; /* linked list of all types */
212 int refs; /* number of instances */
215 /* Send data packet with meta-data */
216 #define NG_SEND_DATA(error, hook, m, a) \
218 (error) = ng_send_data((hook), (m), (a)); \
223 #define NG_SEND_DATA_ONLY(error, hook, m) \
225 (error) = ng_send_data((hook), (m), NULL); \
229 /* Send queued data packet with meta-data */
230 #define NG_SEND_DATAQ(error, hook, m, a) \
232 (error) = ng_send_dataq((hook), (m), (a)); \
237 #define NG_RESPOND_MSG(error, here, retaddr, resp, rptr) \
243 error = ng_queue_msg(here, resp, retaddr); \
245 FREE(resp, M_NETGRAPH); \
250 #define NG_FREE_MSG(msg) \
253 FREE((msg), M_NETGRAPH); \
258 #define NG_FREE_META(a) \
261 FREE((a), M_NETGRAPH); \
266 #define NG_FREE_M(m) \
274 /* Free any data packet and/or meta-data */
275 #define NG_FREE_DATA(m, a) \
282 * Use the NETGRAPH_INIT() macro to link a node type into the
283 * netgraph system. This works for types compiled into the kernel
284 * as well as KLD modules. The first argument should be the type
285 * name (eg, echo) and the second a pointer to the type struct.
287 * If a different link time is desired, e.g., a device driver that
288 * needs to install its netgraph type before probing, use the
289 * NETGRAPH_INIT_ORDERED() macro instead. Deivce drivers probably
290 * want to use SI_SUB_DRIVERS instead of SI_SUB_PSEUDO.
293 #define NETGRAPH_INIT_ORDERED(typename, typestructp, sub, order) \
294 static moduledata_t ng_##typename##_mod = { \
299 DECLARE_MODULE(ng_##typename, ng_##typename##_mod, sub, order)
301 #define NETGRAPH_INIT(tn, tp) \
302 NETGRAPH_INIT_ORDERED(tn, tp, SI_SUB_PSEUDO, SI_ORDER_ANY)
304 /* Special malloc() type for netgraph structs and ctrl messages */
305 MALLOC_DECLARE(M_NETGRAPH);
307 /* declare the base of the netgraph sysctl hierarchy */
308 /* but only if this file cares about sysctls */
310 SYSCTL_DECL(_net_graph);
313 int ng_bypass(hook_p hook1, hook_p hook2);
314 void ng_cutlinks(node_p node);
315 int ng_con_nodes(node_p node,
316 const char *name, node_p node2, const char *name2);
317 meta_p ng_copy_meta(meta_p meta);
318 void ng_destroy_hook(hook_p hook);
319 hook_p ng_findhook(node_p node, const char *name);
320 node_p ng_findname(node_p node, const char *name);
321 struct ng_type *ng_findtype(const char *type);
322 int ng_make_node(const char *type, node_p *nodepp);
323 int ng_make_node_common(struct ng_type *typep, node_p *nodep);
324 int ng_mkpeer(node_p node, const char *name, const char *name2, char *type);
325 int ng_mod_event(module_t mod, int what, void *arg);
326 int ng_name_node(node_p node, const char *name);
327 int ng_newtype(struct ng_type *tp);
328 ng_ID_t ng_node2ID(node_p node);
329 int ng_path2node(node_p here, const char *path, node_p *dest, char **rtnp);
330 int ng_path_parse(char *addr, char **node, char **path, char **hook);
331 int ng_queue_data(hook_p hook, struct mbuf *m, meta_p meta);
332 int ng_queue_msg(node_p here, struct ng_mesg *msg, const char *address);
333 void ng_release_node(node_p node);
334 void ng_rmnode(node_p node);
335 int ng_send_data(hook_p hook, struct mbuf *m, meta_p meta);
336 int ng_send_dataq(hook_p hook, struct mbuf *m, meta_p meta);
337 int ng_send_msg(node_p here, struct ng_mesg *msg,
338 const char *address, struct ng_mesg **resp);
339 void ng_unname(node_p node);
340 void ng_unref(node_p node);
341 int ng_wait_node(node_p node, char *msg);
343 #endif /* _NETGRAPH_NETGRAPH_H_ */