modules: add/correct module versions and depends
[dragonfly.git] / sys / netgraph / netgraph.h
1
2 /*
3  * netgraph.h
4  *
5  * Copyright (c) 1996-1999 Whistle Communications, Inc.
6  * All rights reserved.
7  * 
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.
18  * 
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
35  * OF SUCH DAMAGE.
36  *
37  * Author: Julian Elischer <julian@freebsd.org>
38  *
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.4 2006/05/21 03:43:47 dillon 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 _SYS_QUEUE_H_
48 #include <sys/queue.h>
49 #endif
50 #ifndef _SYS_MALLOC_H_
51 #include <sys/malloc.h>
52 #endif
53 #ifndef _SYS_MODULE_H_
54 #include <sys/module.h>
55 #endif
56 #ifndef _SYS_MBUF_H_
57 #include <sys/mbuf.h>
58 #endif
59 #ifndef _NETGRAPH_NG_MESSAGE_H_
60 #include <netgraph/ng_message.h>
61 #endif
62
63 #ifndef _KERNEL
64
65 #error "This file should not be included in user level programs"
66
67 #else
68
69 #define NG_ABI_VERSION NG_VERSION
70
71 /*
72  * Structure of a hook
73  */
74 struct ng_hook {
75         char   *name;           /* what this node knows this link as */
76         void   *private;        /* node dependant ID for this hook */
77         int     flags;          /* info about this hook/link */
78         int     refs;           /* dont actually free this till 0 */
79         struct  ng_hook *peer;  /* the other end of this link */
80         struct  ng_node *node;  /* The node this hook is attached to */
81         LIST_ENTRY(ng_hook) hooks;      /* linked list of all hooks on node */
82 };
83 typedef struct ng_hook *hook_p;
84
85 /* Flags for a hook */
86 #define HK_INVALID              0x0001  /* don't trust it! */
87
88 void ng_unref_hook(hook_p hook); /* don't move this */
89 #define NG_HOOK_REF(hook)       atomic_add_int(&(hook)->refs, 1)
90 #define NG_HOOK_NAME(hook)      ((hook)->name)
91 #define NG_HOOK_UNREF(hook)     ng_unref_hook(hook)
92 #define NG_HOOK_SET_PRIVATE(hook, val)  do {(hook)->private = val;} while (0)
93 #define NG_HOOK_SET_RCVMSG(hook, val)   do {(hook)->rcvmsg = val;} while (0)
94 #define NG_HOOK_SET_RCVDATA(hook, val)  do {(hook)->rcvdata = val;} while (0)
95 #define NG_HOOK_PRIVATE(hook)   ((hook)->private)
96 #define NG_HOOK_NOT_VALID(hook) ((hook)->flags & HK_INVALID)
97 #define NG_HOOK_IS_VALID(hook)  (!((hook)->flags & HK_INVALID))
98 #define NG_HOOK_NODE(hook)      ((hook)->node) /* only rvalue! */
99 #define NG_HOOK_PEER(hook)      ((hook)->peer) /* only rvalue! */
100
101 /* Some shortcuts */
102 #define NG_PEER_NODE(hook)      NG_HOOK_NODE(NG_HOOK_PEER(hook))
103 #define NG_PEER_HOOK_NAME(hook) NG_HOOK_NAME(NG_HOOK_PEER(hook))
104 #define NG_PEER_NODE_NAME(hook) NG_NODE_NAME(NG_PEER_NODE(hook))
105
106 /*
107  * Structure of a node
108  */
109 struct ng_node {
110         char   *name;           /* optional globally unique name */
111         struct  ng_type *type;  /* the installed 'type' */
112         int     flags;          /* see below for bit definitions */
113         int     sleepers;       /* #procs sleeping on this node */
114         int     refs;           /* number of references to this node */
115         int     numhooks;       /* number of hooks */
116         int     colour;         /* for graph colouring algorithms */
117         void   *private;        /* node type dependant node ID */
118         ng_ID_t         ID;     /* Unique per node */
119         LIST_HEAD(hooks, ng_hook) hooks;        /* linked list of node hooks */
120         LIST_ENTRY(ng_node)       nodes;        /* linked list of all nodes */
121         LIST_ENTRY(ng_node)       idnodes;      /* ID hash collision list */
122 };
123 typedef struct ng_node *node_p;
124
125 /* Flags for a node */
126 #define NG_INVALID      0x001   /* free when all sleepers and refs go to 0 */
127 #define NG_BUSY         0x002   /* callers should sleep or wait */
128 #define NG_TOUCHED      0x004   /* to avoid cycles when 'flooding' */
129 #define NGF_TYPE1       0x10000000      /* reserved for type specific storage */
130 #define NGF_TYPE2       0x20000000      /* reserved for type specific storage */
131 #define NGF_TYPE3       0x40000000      /* reserved for type specific storage */
132 #define NGF_TYPE4       0x80000000      /* reserved for type specific storage */
133
134 void    ng_unref_node(node_p node); /* don't move this */
135 #define NG_NODE_NAME(node)      ((node)->name + 0)
136 #define NG_NODE_HAS_NAME(node)  ((node)->name[0] + 0)
137 #define NG_NODE_ID(node)        ((node)->ID + 0)
138 #define NG_NODE_REF(node)       atomic_add_int(&(node)->refs, 1)
139 #define NG_NODE_UNREF(node)     ng_unref(node)
140 #define NG_NODE_SET_PRIVATE(node, val)  do {(node)->private = val;} while (0)
141 #define NG_NODE_PRIVATE(node)   ((node)->private)
142 #define NG_NODE_IS_VALID(node)  (!((node)->flags & NG_INVALID))
143 #define NG_NODE_NOT_VALID(node) ((node)->flags & NG_INVALID)
144 #define NG_NODE_NUMHOOKS(node)  ((node)->numhooks + 0) /* rvalue */
145
146 /*
147  * The structure that holds meta_data about a data packet (e.g. priority)
148  * Nodes might add or subtract options as needed if there is room.
149  * They might reallocate the struct to make more room if they need to.
150  * Meta-data is still experimental.
151  */
152 struct meta_field_header {
153         u_long  cookie;         /* cookie for the field. Skip fields you don't
154                                  * know about (same cookie as in messgaes) */
155         u_short type;           /* field ID */
156         u_short len;            /* total len of this field including extra
157                                  * data */
158         char    data[0];        /* data starts here */
159 };
160
161 /* To zero out an option 'in place' set it's cookie to this */
162 #define NGM_INVALID_COOKIE      865455152
163
164 /* This part of the metadata is always present if the pointer is non NULL */
165 struct ng_meta {
166         char    priority;       /* -ve is less priority,  0 is default */
167         char    discardability; /* higher is less valuable.. discard first */
168         u_short allocated_len;  /* amount malloc'd */
169         u_short used_len;       /* sum of all fields, options etc. */
170         u_short flags;          /* see below.. generic flags */
171         struct meta_field_header options[0];    /* add as (if) needed */
172 };
173 typedef struct ng_meta *meta_p;
174
175 /* Flags for meta-data */
176 #define NGMF_TEST       0x01    /* discard at the last moment before sending */
177 #define NGMF_TRACE      0x02    /* trace when handing this data to a node */
178
179 /* node method definitions */
180 typedef int     ng_constructor_t(node_p *node);
181 typedef int     ng_rcvmsg_t(node_p node, struct ng_mesg *msg,
182                         const char *retaddr, struct ng_mesg **resp);
183 typedef int     ng_shutdown_t(node_p node);
184 typedef int     ng_newhook_t(node_p node, hook_p hook, const char *name);
185 typedef hook_p  ng_findhook_t(node_p node, const char *name);
186 typedef int     ng_connect_t(hook_p hook);
187 typedef int     ng_rcvdata_t(hook_p hook, struct mbuf *m, meta_p meta);
188 typedef int     ng_disconnect_t(hook_p hook);
189
190 /*
191  * Command list -- each node type specifies the command that it knows
192  * how to convert between ASCII and binary using an array of these.
193  * The last element in the array must be a terminator with cookie=0.
194  */
195
196 struct ng_cmdlist {
197         u_int32_t                       cookie;         /* command typecookie */
198         int                             cmd;            /* command number */
199         const char                      *name;          /* command name */
200         const struct ng_parse_type      *mesgType;      /* args if !NGF_RESP */
201         const struct ng_parse_type      *respType;      /* args if NGF_RESP */
202 };
203
204 /*
205  * Structure of a node type
206  */
207 struct ng_type {
208
209         u_int32_t       version;        /* must equal NG_VERSION */
210         const char      *name;          /* Unique type name */
211         modeventhand_t  mod_event;      /* Module event handler (optional) */
212         ng_constructor_t *constructor;  /* Node constructor */
213         ng_rcvmsg_t     *rcvmsg;        /* control messages come here */
214         ng_shutdown_t   *shutdown;      /* reset, and free resources */
215         ng_newhook_t    *newhook;       /* first notification of new hook */
216         ng_findhook_t   *findhook;      /* only if you have lots of hooks */
217         ng_connect_t    *connect;       /* final notification of new hook */
218         ng_rcvdata_t    *rcvdata;       /* date comes here */
219         ng_rcvdata_t    *rcvdataq;      /* or here if being queued */
220         ng_disconnect_t *disconnect;    /* notify on disconnect */
221
222         const struct    ng_cmdlist *cmdlist;    /* commands we can convert */
223
224         /* R/W data private to the base netgraph code DON'T TOUCH! */
225         LIST_ENTRY(ng_type) types;              /* linked list of all types */
226         int                 refs;               /* number of instances */
227 };
228
229 /* Send data packet with meta-data */
230 #define NG_SEND_DATA(error, hook, m, a)                                 \
231         do {                                                            \
232                 (error) = ng_send_data((hook), (m), (a));               \
233                 (m) = NULL;                                             \
234                 (a) = NULL;                                             \
235         } while (0)
236
237 #define NG_SEND_DATA_ONLY(error, hook, m)                               \
238         do {                                                            \
239                 (error) = ng_send_data((hook), (m), NULL);              \
240                 (m) = NULL;                                             \
241         } while (0)
242
243 /* Send  queued data packet with meta-data */
244 #define NG_SEND_DATAQ(error, hook, m, a)                                \
245         do {                                                            \
246                 (error) = ng_send_dataq((hook), (m), (a));              \
247                 (m) = NULL;                                             \
248                 (a) = NULL;                                             \
249         } while (0)
250
251 #define NG_RESPOND_MSG(error, here, retaddr, resp, rptr)                \
252         do {                                                            \
253                 if (rptr) {                                             \
254                         *rptr = resp;                                   \
255                 } else if (resp) {                                      \
256                         if (retaddr) {                                  \
257                                 error = ng_queue_msg(here, resp, retaddr); \
258                         } else {                                        \
259                                 FREE(resp, M_NETGRAPH);                 \
260                         }                                               \
261                 }                                                       \
262         } while (0)
263
264 #define NG_FREE_MSG(msg)                                                \
265         do {                                                            \
266                 if ((msg)) {                                            \
267                         FREE((msg), M_NETGRAPH);                        \
268                         (msg) = NULL;                                   \
269                 }                                                       \
270         } while (0)
271
272 #define NG_FREE_META(a)                                                 \
273         do {                                                            \
274                 if ((a)) {                                              \
275                         FREE((a), M_NETGRAPH);                          \
276                         (a) = NULL;                                     \
277                 }                                                       \
278         } while (0)
279
280 #define NG_FREE_M(m)                                                    \
281         do {                                                            \
282                 if ((m)) {                                              \
283                         m_freem((m));                                   \
284                         (m) = NULL;                                     \
285                 }                                                       \
286         } while (0)
287
288 /* Free any data packet and/or meta-data */
289 #define NG_FREE_DATA(m, a)                                              \
290         do {                                                            \
291                 NG_FREE_M((m));                                         \
292                 NG_FREE_META((a));                                      \
293         } while (0)
294
295 /*
296  * Use the NETGRAPH_INIT() macro to link a node type into the
297  * netgraph system. This works for types compiled into the kernel
298  * as well as KLD modules. The first argument should be the type
299  * name (eg, echo) and the second a pointer to the type struct.
300  *
301  * If a different link time is desired, e.g., a device driver that
302  * needs to install its netgraph type before probing, use the
303  * NETGRAPH_INIT_ORDERED() macro instead. Deivce drivers probably
304  * want to use SI_SUB_DRIVERS instead of SI_SUB_PSEUDO.
305  */
306
307 #define NETGRAPH_INIT_ORDERED(typename, typestructp, sub, order)        \
308 static moduledata_t ng_##typename##_mod = {                             \
309         "ng_" #typename,                                                \
310         ng_mod_event,                                                   \
311         (typestructp)                                                   \
312 };                                                                      \
313 DECLARE_MODULE(ng_##typename, ng_##typename##_mod, sub, order);         \
314 MODULE_VERSION(ng_##typename, NG_ABI_VERSION)
315
316 #define NETGRAPH_INIT(tn, tp)                                           \
317         NETGRAPH_INIT_ORDERED(tn, tp, SI_SUB_PSEUDO, SI_ORDER_ANY)
318
319 /* Special malloc() type for netgraph structs and ctrl messages */
320 MALLOC_DECLARE(M_NETGRAPH);
321
322 /* declare the base of the netgraph sysctl hierarchy */
323 /* but only if this file cares about sysctls */
324 #ifdef  SYSCTL_DECL
325 SYSCTL_DECL(_net_graph);
326 #endif
327
328 int     ng_bypass(hook_p hook1, hook_p hook2);
329 void    ng_cutlinks(node_p node);
330 int     ng_con_nodes(node_p node,
331              const char *name, node_p node2, const char *name2);
332 meta_p  ng_copy_meta(meta_p meta);
333 void    ng_destroy_hook(hook_p hook);
334 hook_p  ng_findhook(node_p node, const char *name);
335 node_p  ng_findname(node_p node, const char *name);
336 struct  ng_type *ng_findtype(const char *type);
337 int     ng_make_node(const char *type, node_p *nodepp);
338 int     ng_make_node_common(struct ng_type *typep, node_p *nodep);
339 int     ng_mkpeer(node_p node, const char *name, const char *name2, char *type);
340 int     ng_mod_event(module_t mod, int what, void *arg);
341 int     ng_name_node(node_p node, const char *name);
342 int     ng_newtype(struct ng_type *tp);
343 ng_ID_t ng_node2ID(node_p node);
344 int     ng_path2node(node_p here, const char *path, node_p *dest, char **rtnp);
345 int     ng_path_parse(char *addr, char **node, char **path, char **hook);
346 int     ng_queue_data(hook_p hook, struct mbuf *m, meta_p meta);
347 int     ng_queue_msg(node_p here, struct ng_mesg *msg, const char *address);
348 void    ng_release_node(node_p node);
349 void    ng_rmnode(node_p node);
350 int     ng_send_data(hook_p hook, struct mbuf *m, meta_p meta);
351 int     ng_send_dataq(hook_p hook, struct mbuf *m, meta_p meta);
352 int     ng_send_msg(node_p here, struct ng_mesg *msg,
353             const char *address, struct ng_mesg **resp);
354 void    ng_unname(node_p node);
355 void    ng_unref(node_p node);
356 int     ng_wait_node(node_p node, char *msg);
357
358 #endif  /* _KERNEL */
359 #endif  /* _NETGRAPH_NETGRAPH_H_ */
360