1
2/*
3 * ng_message.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@whistle.com>
38 *
| 1
2/*
3 * ng_message.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@whistle.com>
38 *
|
39 * $FreeBSD: head/sys/netgraph/ng_message.h 62471 2000-07-03 13:34:18Z phk $
| 39 * $FreeBSD: head/sys/netgraph/ng_message.h 64508 2000-08-10 22:45:54Z archie $
|
40 * $Whistle: ng_message.h,v 1.12 1999/01/25 01:17:44 archie Exp $
41 */
42
43#ifndef _NETGRAPH_NG_MESSAGE_H_
44#define _NETGRAPH_NG_MESSAGE_H_ 1
45
46/* ASCII string size limits */
47#define NG_TYPELEN 15 /* max type name len (16 with null) */
48#define NG_HOOKLEN 15 /* max hook name len (16 with null) */
49#define NG_NODELEN 15 /* max node name len (16 with null) */
50#define NG_PATHLEN 511 /* max path len (512 with null) */
51#define NG_CMDSTRLEN 15 /* max command string (16 with null) */
52#define NG_TEXTRESPONSE 1024 /* allow this length for a text response */
53
54/* A netgraph message */
55struct ng_mesg {
56 struct ng_msghdr {
57 u_char version; /* must == NG_VERSION */
58 u_char spare; /* pad to 2 bytes */
59 u_int16_t arglen; /* length of data */
60 u_int32_t flags; /* message status */
61 u_int32_t token; /* match with reply */
62 u_int32_t typecookie; /* node's type cookie */
63 u_int32_t cmd; /* command identifier */
64 u_char cmdstr[NG_CMDSTRLEN+1]; /* cmd string + \0 */
65 } header;
66 char data[0]; /* placeholder for actual data */
67};
68
69/* Keep this in sync with the above structure definition */
70#define NG_GENERIC_NG_MESG_INFO(dtype) { \
71 { \
| 40 * $Whistle: ng_message.h,v 1.12 1999/01/25 01:17:44 archie Exp $
41 */
42
43#ifndef _NETGRAPH_NG_MESSAGE_H_
44#define _NETGRAPH_NG_MESSAGE_H_ 1
45
46/* ASCII string size limits */
47#define NG_TYPELEN 15 /* max type name len (16 with null) */
48#define NG_HOOKLEN 15 /* max hook name len (16 with null) */
49#define NG_NODELEN 15 /* max node name len (16 with null) */
50#define NG_PATHLEN 511 /* max path len (512 with null) */
51#define NG_CMDSTRLEN 15 /* max command string (16 with null) */
52#define NG_TEXTRESPONSE 1024 /* allow this length for a text response */
53
54/* A netgraph message */
55struct ng_mesg {
56 struct ng_msghdr {
57 u_char version; /* must == NG_VERSION */
58 u_char spare; /* pad to 2 bytes */
59 u_int16_t arglen; /* length of data */
60 u_int32_t flags; /* message status */
61 u_int32_t token; /* match with reply */
62 u_int32_t typecookie; /* node's type cookie */
63 u_int32_t cmd; /* command identifier */
64 u_char cmdstr[NG_CMDSTRLEN+1]; /* cmd string + \0 */
65 } header;
66 char data[0]; /* placeholder for actual data */
67};
68
69/* Keep this in sync with the above structure definition */
70#define NG_GENERIC_NG_MESG_INFO(dtype) { \
71 { \
|
72 { "version", &ng_parse_int8_type }, \
73 { "spare", &ng_parse_int8_type }, \
74 { "arglen", &ng_parse_int16_type }, \
75 { "flags", &ng_parse_int32_type }, \
76 { "token", &ng_parse_int32_type }, \
77 { "typecookie", &ng_parse_int32_type }, \
78 { "cmd", &ng_parse_int32_type }, \
| 72 { "version", &ng_parse_uint8_type }, \
73 { "spare", &ng_parse_uint8_type }, \
74 { "arglen", &ng_parse_uint16_type }, \
75 { "flags", &ng_parse_hint32_type }, \
76 { "token", &ng_parse_uint32_type }, \
77 { "typecookie", &ng_parse_uint32_type }, \
78 { "cmd", &ng_parse_uint32_type }, \
|
79 { "cmdstr", &ng_parse_cmdbuf_type }, \
80 { "data", (dtype) }, \
81 { NULL }, \
82 } \
83}
84
85/* Negraph type binary compatibility field */
86#define NG_VERSION 3
87
88/* Flags field flags */
89#define NGF_ORIG 0x0000 /* the msg is the original request */
90#define NGF_RESP 0x0001 /* the message is a response */
91
92/* Type of a unique node ID */
93#define ng_ID_t unsigned int
94
95/*
96 * Here we describe the "generic" messages that all nodes inherently
97 * understand. With the exception of NGM_TEXT_STATUS, these are handled
98 * automatically by the base netgraph code.
99 */
100
101/* Generic message type cookie */
102#define NGM_GENERIC_COOKIE 851672668
103
104/* Generic messages defined for this type cookie */
105#define NGM_SHUTDOWN 1 /* shut down node */
106#define NGM_MKPEER 2 /* create and attach a peer node */
107#define NGM_CONNECT 3 /* connect two nodes */
108#define NGM_NAME 4 /* give a node a name */
109#define NGM_RMHOOK 5 /* break a connection btw. two nodes */
110#define NGM_NODEINFO 6 /* get nodeinfo for the target */
111#define NGM_LISTHOOKS 7 /* get list of hooks on node */
112#define NGM_LISTNAMES 8 /* list all globally named nodes */
113#define NGM_LISTNODES 9 /* list all nodes, named and unnamed */
114#define NGM_LISTTYPES 10 /* list all installed node types */
115#define NGM_TEXT_STATUS 11 /* (optional) get text status report */
116#define NGM_BINARY2ASCII 12 /* convert struct ng_mesg to ascii */
117#define NGM_ASCII2BINARY 13 /* convert ascii to struct ng_mesg */
118#define NGM_TEXT_CONFIG 14 /* (optional) get/set text config */
119
120/* Structure used for NGM_MKPEER */
121struct ngm_mkpeer {
122 char type[NG_TYPELEN + 1]; /* peer type */
123 char ourhook[NG_HOOKLEN + 1]; /* hook name */
124 char peerhook[NG_HOOKLEN + 1]; /* peer hook name */
125};
126
127/* Keep this in sync with the above structure definition */
128#define NG_GENERIC_MKPEER_INFO() { \
129 { \
130 { "type", &ng_parse_typebuf_type }, \
131 { "ourhook", &ng_parse_hookbuf_type }, \
132 { "peerhook", &ng_parse_hookbuf_type }, \
133 { NULL }, \
134 } \
135}
136
137/* Structure used for NGM_CONNECT */
138struct ngm_connect {
139 char path[NG_PATHLEN + 1]; /* peer path */
140 char ourhook[NG_HOOKLEN + 1]; /* hook name */
141 char peerhook[NG_HOOKLEN + 1]; /* peer hook name */
142};
143
144/* Keep this in sync with the above structure definition */
145#define NG_GENERIC_CONNECT_INFO() { \
146 { \
147 { "path", &ng_parse_pathbuf_type }, \
148 { "ourhook", &ng_parse_hookbuf_type }, \
149 { "peerhook", &ng_parse_hookbuf_type }, \
150 { NULL }, \
151 } \
152}
153
154/* Structure used for NGM_NAME */
155struct ngm_name {
156 char name[NG_NODELEN + 1]; /* node name */
157};
158
159/* Keep this in sync with the above structure definition */
160#define NG_GENERIC_NAME_INFO() { \
161 { \
162 { "name", &ng_parse_nodebuf_type }, \
163 { NULL }, \
164 } \
165}
166
167/* Structure used for NGM_RMHOOK */
168struct ngm_rmhook {
169 char ourhook[NG_HOOKLEN + 1]; /* hook name */
170};
171
172/* Keep this in sync with the above structure definition */
173#define NG_GENERIC_RMHOOK_INFO() { \
174 { \
175 { "hook", &ng_parse_hookbuf_type }, \
176 { NULL }, \
177 } \
178}
179
180/* Structure used for NGM_NODEINFO */
181struct nodeinfo {
182 char name[NG_NODELEN + 1]; /* node name (if any) */
183 char type[NG_TYPELEN + 1]; /* peer type */
184 ng_ID_t id; /* unique identifier */
185 u_int32_t hooks; /* number of active hooks */
186};
187
188/* Keep this in sync with the above structure definition */
189#define NG_GENERIC_NODEINFO_INFO() { \
190 { \
191 { "name", &ng_parse_nodebuf_type }, \
192 { "type", &ng_parse_typebuf_type }, \
| 79 { "cmdstr", &ng_parse_cmdbuf_type }, \
80 { "data", (dtype) }, \
81 { NULL }, \
82 } \
83}
84
85/* Negraph type binary compatibility field */
86#define NG_VERSION 3
87
88/* Flags field flags */
89#define NGF_ORIG 0x0000 /* the msg is the original request */
90#define NGF_RESP 0x0001 /* the message is a response */
91
92/* Type of a unique node ID */
93#define ng_ID_t unsigned int
94
95/*
96 * Here we describe the "generic" messages that all nodes inherently
97 * understand. With the exception of NGM_TEXT_STATUS, these are handled
98 * automatically by the base netgraph code.
99 */
100
101/* Generic message type cookie */
102#define NGM_GENERIC_COOKIE 851672668
103
104/* Generic messages defined for this type cookie */
105#define NGM_SHUTDOWN 1 /* shut down node */
106#define NGM_MKPEER 2 /* create and attach a peer node */
107#define NGM_CONNECT 3 /* connect two nodes */
108#define NGM_NAME 4 /* give a node a name */
109#define NGM_RMHOOK 5 /* break a connection btw. two nodes */
110#define NGM_NODEINFO 6 /* get nodeinfo for the target */
111#define NGM_LISTHOOKS 7 /* get list of hooks on node */
112#define NGM_LISTNAMES 8 /* list all globally named nodes */
113#define NGM_LISTNODES 9 /* list all nodes, named and unnamed */
114#define NGM_LISTTYPES 10 /* list all installed node types */
115#define NGM_TEXT_STATUS 11 /* (optional) get text status report */
116#define NGM_BINARY2ASCII 12 /* convert struct ng_mesg to ascii */
117#define NGM_ASCII2BINARY 13 /* convert ascii to struct ng_mesg */
118#define NGM_TEXT_CONFIG 14 /* (optional) get/set text config */
119
120/* Structure used for NGM_MKPEER */
121struct ngm_mkpeer {
122 char type[NG_TYPELEN + 1]; /* peer type */
123 char ourhook[NG_HOOKLEN + 1]; /* hook name */
124 char peerhook[NG_HOOKLEN + 1]; /* peer hook name */
125};
126
127/* Keep this in sync with the above structure definition */
128#define NG_GENERIC_MKPEER_INFO() { \
129 { \
130 { "type", &ng_parse_typebuf_type }, \
131 { "ourhook", &ng_parse_hookbuf_type }, \
132 { "peerhook", &ng_parse_hookbuf_type }, \
133 { NULL }, \
134 } \
135}
136
137/* Structure used for NGM_CONNECT */
138struct ngm_connect {
139 char path[NG_PATHLEN + 1]; /* peer path */
140 char ourhook[NG_HOOKLEN + 1]; /* hook name */
141 char peerhook[NG_HOOKLEN + 1]; /* peer hook name */
142};
143
144/* Keep this in sync with the above structure definition */
145#define NG_GENERIC_CONNECT_INFO() { \
146 { \
147 { "path", &ng_parse_pathbuf_type }, \
148 { "ourhook", &ng_parse_hookbuf_type }, \
149 { "peerhook", &ng_parse_hookbuf_type }, \
150 { NULL }, \
151 } \
152}
153
154/* Structure used for NGM_NAME */
155struct ngm_name {
156 char name[NG_NODELEN + 1]; /* node name */
157};
158
159/* Keep this in sync with the above structure definition */
160#define NG_GENERIC_NAME_INFO() { \
161 { \
162 { "name", &ng_parse_nodebuf_type }, \
163 { NULL }, \
164 } \
165}
166
167/* Structure used for NGM_RMHOOK */
168struct ngm_rmhook {
169 char ourhook[NG_HOOKLEN + 1]; /* hook name */
170};
171
172/* Keep this in sync with the above structure definition */
173#define NG_GENERIC_RMHOOK_INFO() { \
174 { \
175 { "hook", &ng_parse_hookbuf_type }, \
176 { NULL }, \
177 } \
178}
179
180/* Structure used for NGM_NODEINFO */
181struct nodeinfo {
182 char name[NG_NODELEN + 1]; /* node name (if any) */
183 char type[NG_TYPELEN + 1]; /* peer type */
184 ng_ID_t id; /* unique identifier */
185 u_int32_t hooks; /* number of active hooks */
186};
187
188/* Keep this in sync with the above structure definition */
189#define NG_GENERIC_NODEINFO_INFO() { \
190 { \
191 { "name", &ng_parse_nodebuf_type }, \
192 { "type", &ng_parse_typebuf_type }, \
|
193 { "id", &ng_parse_int32_type }, \
194 { "hooks", &ng_parse_int32_type }, \
| 193 { "id", &ng_parse_hint32_type }, \
194 { "hooks", &ng_parse_uint32_type }, \
|
195 { NULL }, \
196 } \
197}
198
199/* Structure used for NGM_LISTHOOKS */
200struct linkinfo {
201 char ourhook[NG_HOOKLEN + 1]; /* hook name */
202 char peerhook[NG_HOOKLEN + 1]; /* peer hook */
203 struct nodeinfo nodeinfo;
204};
205
206/* Keep this in sync with the above structure definition */
207#define NG_GENERIC_LINKINFO_INFO(nitype) { \
208 { \
209 { "ourhook", &ng_parse_hookbuf_type }, \
210 { "peerhook", &ng_parse_hookbuf_type }, \
211 { "nodeinfo", (nitype) }, \
212 { NULL }, \
213 } \
214}
215
216struct hooklist {
217 struct nodeinfo nodeinfo; /* node information */
218 struct linkinfo link[0]; /* info about each hook */
219};
220
221/* Keep this in sync with the above structure definition */
222#define NG_GENERIC_HOOKLIST_INFO(nitype,litype) { \
223 { \
224 { "nodeinfo", (nitype) }, \
225 { "linkinfo", (litype) }, \
226 { NULL }, \
227 } \
228}
229
230/* Structure used for NGM_LISTNAMES/NGM_LISTNODES */
231struct namelist {
232 u_int32_t numnames;
233 struct nodeinfo nodeinfo[0];
234};
235
236/* Keep this in sync with the above structure definition */
237#define NG_GENERIC_LISTNODES_INFO(niarraytype) { \
238 { \
| 195 { NULL }, \
196 } \
197}
198
199/* Structure used for NGM_LISTHOOKS */
200struct linkinfo {
201 char ourhook[NG_HOOKLEN + 1]; /* hook name */
202 char peerhook[NG_HOOKLEN + 1]; /* peer hook */
203 struct nodeinfo nodeinfo;
204};
205
206/* Keep this in sync with the above structure definition */
207#define NG_GENERIC_LINKINFO_INFO(nitype) { \
208 { \
209 { "ourhook", &ng_parse_hookbuf_type }, \
210 { "peerhook", &ng_parse_hookbuf_type }, \
211 { "nodeinfo", (nitype) }, \
212 { NULL }, \
213 } \
214}
215
216struct hooklist {
217 struct nodeinfo nodeinfo; /* node information */
218 struct linkinfo link[0]; /* info about each hook */
219};
220
221/* Keep this in sync with the above structure definition */
222#define NG_GENERIC_HOOKLIST_INFO(nitype,litype) { \
223 { \
224 { "nodeinfo", (nitype) }, \
225 { "linkinfo", (litype) }, \
226 { NULL }, \
227 } \
228}
229
230/* Structure used for NGM_LISTNAMES/NGM_LISTNODES */
231struct namelist {
232 u_int32_t numnames;
233 struct nodeinfo nodeinfo[0];
234};
235
236/* Keep this in sync with the above structure definition */
237#define NG_GENERIC_LISTNODES_INFO(niarraytype) { \
238 { \
|
239 { "numnames", &ng_parse_int32_type }, \
| 239 { "numnames", &ng_parse_uint32_type }, \
|
240 { "nodeinfo", (niarraytype) }, \
241 { NULL }, \
242 } \
243}
244
245/* Structure used for NGM_LISTTYPES */
246struct typeinfo {
247 char type_name[NG_TYPELEN + 1]; /* name of type */
248 u_int32_t numnodes; /* number alive */
249};
250
251/* Keep this in sync with the above structure definition */
252#define NG_GENERIC_TYPEINFO_INFO() { \
253 { \
254 { "typename", &ng_parse_typebuf_type }, \
| 240 { "nodeinfo", (niarraytype) }, \
241 { NULL }, \
242 } \
243}
244
245/* Structure used for NGM_LISTTYPES */
246struct typeinfo {
247 char type_name[NG_TYPELEN + 1]; /* name of type */
248 u_int32_t numnodes; /* number alive */
249};
250
251/* Keep this in sync with the above structure definition */
252#define NG_GENERIC_TYPEINFO_INFO() { \
253 { \
254 { "typename", &ng_parse_typebuf_type }, \
|
255 { "typeinfo", &ng_parse_int32_type }, \
| 255 { "numnodes", &ng_parse_uint32_type }, \
|
256 { NULL }, \
257 } \
258}
259
260struct typelist {
261 u_int32_t numtypes;
262 struct typeinfo typeinfo[0];
263};
264
265/* Keep this in sync with the above structure definition */
266#define NG_GENERIC_TYPELIST_INFO(tiarraytype) { \
267 { \
| 256 { NULL }, \
257 } \
258}
259
260struct typelist {
261 u_int32_t numtypes;
262 struct typeinfo typeinfo[0];
263};
264
265/* Keep this in sync with the above structure definition */
266#define NG_GENERIC_TYPELIST_INFO(tiarraytype) { \
267 { \
|
268 { "numtypes", &ng_parse_int32_type }, \
| 268 { "numtypes", &ng_parse_uint32_type }, \
|
269 { "typeinfo", (tiarraytype) }, \
270 { NULL }, \
271 } \
272}
273
274/*
275 * For netgraph nodes that are somehow associated with file descriptors
276 * (e.g., a device that has a /dev entry and is also a netgraph node),
277 * we define a generic ioctl for requesting the corresponding nodeinfo
278 * structure and for assigning a name (if there isn't one already).
279 *
280 * For these to you need to also #include <sys/ioccom.h>.
281 */
282
283#define NGIOCGINFO _IOR('N', 40, struct nodeinfo) /* get node info */
284#define NGIOCSETNAME _IOW('N', 41, struct ngm_name) /* set node name */
285
286#ifdef _KERNEL
287/*
288 * Allocate and initialize a netgraph message "msg" with "len"
289 * extra bytes of argument. Sets "msg" to NULL if fails.
290 * Does not initialize token.
291 */
292#define NG_MKMESSAGE(msg, cookie, cmdid, len, how) \
293 do { \
294 MALLOC((msg), struct ng_mesg *, sizeof(struct ng_mesg) \
295 + (len), M_NETGRAPH, (how)); \
296 if ((msg) == NULL) \
297 break; \
298 bzero((msg), sizeof(struct ng_mesg) + (len)); \
299 (msg)->header.version = NG_VERSION; \
300 (msg)->header.typecookie = (cookie); \
301 (msg)->header.cmd = (cmdid); \
302 (msg)->header.arglen = (len); \
303 strncpy((msg)->header.cmdstr, #cmdid, \
304 sizeof((msg)->header.cmdstr) - 1); \
305 } while (0)
306
307/*
308 * Allocate and initialize a response "rsp" to a message "msg"
309 * with "len" extra bytes of argument. Sets "rsp" to NULL if fails.
310 */
311#define NG_MKRESPONSE(rsp, msg, len, how) \
312 do { \
313 MALLOC((rsp), struct ng_mesg *, sizeof(struct ng_mesg) \
314 + (len), M_NETGRAPH, (how)); \
315 if ((rsp) == NULL) \
316 break; \
317 bzero((rsp), sizeof(struct ng_mesg) + (len)); \
318 (rsp)->header.version = NG_VERSION; \
319 (rsp)->header.arglen = (len); \
320 (rsp)->header.token = (msg)->header.token; \
321 (rsp)->header.typecookie = (msg)->header.typecookie; \
322 (rsp)->header.cmd = (msg)->header.cmd; \
323 bcopy((msg)->header.cmdstr, (rsp)->header.cmdstr, \
324 sizeof((rsp)->header.cmdstr)); \
325 (rsp)->header.flags |= NGF_RESP; \
326 } while (0)
327#endif /* _KERNEL */
328
329#endif /* _NETGRAPH_NG_MESSAGE_H_ */
330
| 269 { "typeinfo", (tiarraytype) }, \
270 { NULL }, \
271 } \
272}
273
274/*
275 * For netgraph nodes that are somehow associated with file descriptors
276 * (e.g., a device that has a /dev entry and is also a netgraph node),
277 * we define a generic ioctl for requesting the corresponding nodeinfo
278 * structure and for assigning a name (if there isn't one already).
279 *
280 * For these to you need to also #include <sys/ioccom.h>.
281 */
282
283#define NGIOCGINFO _IOR('N', 40, struct nodeinfo) /* get node info */
284#define NGIOCSETNAME _IOW('N', 41, struct ngm_name) /* set node name */
285
286#ifdef _KERNEL
287/*
288 * Allocate and initialize a netgraph message "msg" with "len"
289 * extra bytes of argument. Sets "msg" to NULL if fails.
290 * Does not initialize token.
291 */
292#define NG_MKMESSAGE(msg, cookie, cmdid, len, how) \
293 do { \
294 MALLOC((msg), struct ng_mesg *, sizeof(struct ng_mesg) \
295 + (len), M_NETGRAPH, (how)); \
296 if ((msg) == NULL) \
297 break; \
298 bzero((msg), sizeof(struct ng_mesg) + (len)); \
299 (msg)->header.version = NG_VERSION; \
300 (msg)->header.typecookie = (cookie); \
301 (msg)->header.cmd = (cmdid); \
302 (msg)->header.arglen = (len); \
303 strncpy((msg)->header.cmdstr, #cmdid, \
304 sizeof((msg)->header.cmdstr) - 1); \
305 } while (0)
306
307/*
308 * Allocate and initialize a response "rsp" to a message "msg"
309 * with "len" extra bytes of argument. Sets "rsp" to NULL if fails.
310 */
311#define NG_MKRESPONSE(rsp, msg, len, how) \
312 do { \
313 MALLOC((rsp), struct ng_mesg *, sizeof(struct ng_mesg) \
314 + (len), M_NETGRAPH, (how)); \
315 if ((rsp) == NULL) \
316 break; \
317 bzero((rsp), sizeof(struct ng_mesg) + (len)); \
318 (rsp)->header.version = NG_VERSION; \
319 (rsp)->header.arglen = (len); \
320 (rsp)->header.token = (msg)->header.token; \
321 (rsp)->header.typecookie = (msg)->header.typecookie; \
322 (rsp)->header.cmd = (msg)->header.cmd; \
323 bcopy((msg)->header.cmdstr, (rsp)->header.cmdstr, \
324 sizeof((rsp)->header.cmdstr)); \
325 (rsp)->header.flags |= NGF_RESP; \
326 } while (0)
327#endif /* _KERNEL */
328
329#endif /* _NETGRAPH_NG_MESSAGE_H_ */
330
|