diff options
Diffstat (limited to 'include/linux/tipc.h')
-rw-r--r-- | include/linux/tipc.h | 598 |
1 files changed, 598 insertions, 0 deletions
diff --git a/include/linux/tipc.h b/include/linux/tipc.h new file mode 100644 index 000000000000..ca754f3317f2 --- /dev/null +++ b/include/linux/tipc.h | |||
@@ -0,0 +1,598 @@ | |||
1 | /* | ||
2 | * include/linux/tipc.h: Include file for TIPC users | ||
3 | * | ||
4 | * Copyright (c) 2003-2005, Ericsson Research Canada | ||
5 | * Copyright (c) 2005, Wind River Systems | ||
6 | * Copyright (c) 2005-2006, Ericsson AB | ||
7 | * All rights reserved. | ||
8 | * | ||
9 | * Redistribution and use in source and binary forms, with or without | ||
10 | * modification, are permitted provided that the following conditions are met: | ||
11 | * | ||
12 | * Redistributions of source code must retain the above copyright notice, this | ||
13 | * list of conditions and the following disclaimer. | ||
14 | * Redistributions in binary form must reproduce the above copyright notice, | ||
15 | * this list of conditions and the following disclaimer in the documentation | ||
16 | * and/or other materials provided with the distribution. | ||
17 | * Neither the names of the copyright holders nor the names of its | ||
18 | * contributors may be used to endorse or promote products derived from this | ||
19 | * software without specific prior written permission. | ||
20 | * | ||
21 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
22 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
23 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
24 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE | ||
25 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | ||
26 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
27 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
28 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
29 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
30 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | ||
31 | * POSSIBILITY OF SUCH DAMAGE. | ||
32 | */ | ||
33 | |||
34 | #ifndef _LINUX_TIPC_H_ | ||
35 | #define _LINUX_TIPC_H_ | ||
36 | |||
37 | #include <linux/types.h> | ||
38 | #include <linux/string.h> | ||
39 | #include <asm/byteorder.h> | ||
40 | |||
41 | /* | ||
42 | * TIPC addressing primitives | ||
43 | */ | ||
44 | |||
45 | struct tipc_portid { | ||
46 | __u32 ref; | ||
47 | __u32 node; | ||
48 | }; | ||
49 | |||
50 | struct tipc_name { | ||
51 | __u32 type; | ||
52 | __u32 instance; | ||
53 | }; | ||
54 | |||
55 | struct tipc_name_seq { | ||
56 | __u32 type; | ||
57 | __u32 lower; | ||
58 | __u32 upper; | ||
59 | }; | ||
60 | |||
61 | static inline __u32 tipc_addr(unsigned int zone, | ||
62 | unsigned int cluster, | ||
63 | unsigned int node) | ||
64 | { | ||
65 | return(zone << 24) | (cluster << 12) | node; | ||
66 | } | ||
67 | |||
68 | static inline unsigned int tipc_zone(__u32 addr) | ||
69 | { | ||
70 | return addr >> 24; | ||
71 | } | ||
72 | |||
73 | static inline unsigned int tipc_cluster(__u32 addr) | ||
74 | { | ||
75 | return(addr >> 12) & 0xfff; | ||
76 | } | ||
77 | |||
78 | static inline unsigned int tipc_node(__u32 addr) | ||
79 | { | ||
80 | return addr & 0xfff; | ||
81 | } | ||
82 | |||
83 | /* | ||
84 | * Application-accessible port name types | ||
85 | */ | ||
86 | |||
87 | #define TIPC_NET_EVENTS 0 /* network event subscription name type */ | ||
88 | #define TIPC_TOP_SRV 1 /* topology service name type */ | ||
89 | #define TIPC_RESERVED_TYPES 64 /* lowest user-publishable name type */ | ||
90 | |||
91 | /* | ||
92 | * Publication scopes when binding port names and port name sequences | ||
93 | */ | ||
94 | |||
95 | #define TIPC_ZONE_SCOPE 1 | ||
96 | #define TIPC_CLUSTER_SCOPE 2 | ||
97 | #define TIPC_NODE_SCOPE 3 | ||
98 | |||
99 | /* | ||
100 | * Limiting values for messages | ||
101 | */ | ||
102 | |||
103 | #define TIPC_MAX_USER_MSG_SIZE 66000 | ||
104 | |||
105 | /* | ||
106 | * Message importance levels | ||
107 | */ | ||
108 | |||
109 | #define TIPC_LOW_IMPORTANCE 0 /* default */ | ||
110 | #define TIPC_MEDIUM_IMPORTANCE 1 | ||
111 | #define TIPC_HIGH_IMPORTANCE 2 | ||
112 | #define TIPC_CRITICAL_IMPORTANCE 3 | ||
113 | |||
114 | /* | ||
115 | * Msg rejection/connection shutdown reasons | ||
116 | */ | ||
117 | |||
118 | #define TIPC_OK 0 | ||
119 | #define TIPC_ERR_NO_NAME 1 | ||
120 | #define TIPC_ERR_NO_PORT 2 | ||
121 | #define TIPC_ERR_NO_NODE 3 | ||
122 | #define TIPC_ERR_OVERLOAD 4 | ||
123 | #define TIPC_CONN_SHUTDOWN 5 | ||
124 | |||
125 | /* | ||
126 | * TIPC topology subscription service definitions | ||
127 | */ | ||
128 | |||
129 | #define TIPC_SUB_PORTS 0x01 /* filter for port availability */ | ||
130 | #define TIPC_SUB_SERVICE 0x02 /* filter for service availability */ | ||
131 | #if 0 | ||
132 | /* The following filter options are not currently implemented */ | ||
133 | #define TIPC_SUB_NO_BIND_EVTS 0x04 /* filter out "publish" events */ | ||
134 | #define TIPC_SUB_NO_UNBIND_EVTS 0x08 /* filter out "withdraw" events */ | ||
135 | #define TIPC_SUB_SINGLE_EVT 0x10 /* expire after first event */ | ||
136 | #endif | ||
137 | |||
138 | #define TIPC_WAIT_FOREVER ~0 /* timeout for permanent subscription */ | ||
139 | |||
140 | struct tipc_subscr { | ||
141 | struct tipc_name_seq seq; /* name sequence of interest */ | ||
142 | __u32 timeout; /* subscription duration (in ms) */ | ||
143 | __u32 filter; /* bitmask of filter options */ | ||
144 | char usr_handle[8]; /* available for subscriber use */ | ||
145 | }; | ||
146 | |||
147 | |||
148 | #define TIPC_PUBLISHED 1 /* publication event */ | ||
149 | #define TIPC_WITHDRAWN 2 /* withdraw event */ | ||
150 | #define TIPC_SUBSCR_TIMEOUT 3 /* subscription timeout event */ | ||
151 | |||
152 | struct tipc_event { | ||
153 | __u32 event; /* event type */ | ||
154 | __u32 found_lower; /* matching name seq instances */ | ||
155 | __u32 found_upper; /* " " " " */ | ||
156 | struct tipc_portid port; /* associated port */ | ||
157 | struct tipc_subscr s; /* associated subscription */ | ||
158 | }; | ||
159 | |||
160 | /* | ||
161 | * Socket API | ||
162 | */ | ||
163 | |||
164 | #ifndef AF_TIPC | ||
165 | #define AF_TIPC 30 | ||
166 | #endif | ||
167 | |||
168 | #ifndef PF_TIPC | ||
169 | #define PF_TIPC AF_TIPC | ||
170 | #endif | ||
171 | |||
172 | #ifndef SOL_TIPC | ||
173 | #define SOL_TIPC 271 | ||
174 | #endif | ||
175 | |||
176 | #define TIPC_ADDR_NAMESEQ 1 | ||
177 | #define TIPC_ADDR_MCAST 1 | ||
178 | #define TIPC_ADDR_NAME 2 | ||
179 | #define TIPC_ADDR_ID 3 | ||
180 | |||
181 | struct sockaddr_tipc { | ||
182 | unsigned short family; | ||
183 | unsigned char addrtype; | ||
184 | signed char scope; | ||
185 | union { | ||
186 | struct tipc_portid id; | ||
187 | struct tipc_name_seq nameseq; | ||
188 | struct { | ||
189 | struct tipc_name name; | ||
190 | __u32 domain; /* 0: own zone */ | ||
191 | } name; | ||
192 | } addr; | ||
193 | }; | ||
194 | |||
195 | /* | ||
196 | * Ancillary data objects supported by recvmsg() | ||
197 | */ | ||
198 | |||
199 | #define TIPC_ERRINFO 1 /* error info */ | ||
200 | #define TIPC_RETDATA 2 /* returned data */ | ||
201 | #define TIPC_DESTNAME 3 /* destination name */ | ||
202 | |||
203 | /* | ||
204 | * TIPC-specific socket option values | ||
205 | */ | ||
206 | |||
207 | #define TIPC_IMPORTANCE 127 /* Default: TIPC_LOW_IMPORTANCE */ | ||
208 | #define TIPC_SRC_DROPPABLE 128 /* Default: 0 (resend congested msg) */ | ||
209 | #define TIPC_DEST_DROPPABLE 129 /* Default: based on socket type */ | ||
210 | #define TIPC_CONN_TIMEOUT 130 /* Default: 8000 (ms) */ | ||
211 | |||
212 | /* | ||
213 | * Bearer | ||
214 | */ | ||
215 | |||
216 | /* Identifiers of supported TIPC media types */ | ||
217 | |||
218 | #define TIPC_MEDIA_TYPE_ETH 1 | ||
219 | |||
220 | /* Maximum sizes of TIPC bearer-related names (including terminating NUL) */ | ||
221 | |||
222 | #define TIPC_MAX_MEDIA_NAME 16 /* format = media */ | ||
223 | #define TIPC_MAX_IF_NAME 16 /* format = interface */ | ||
224 | #define TIPC_MAX_BEARER_NAME 32 /* format = media:interface */ | ||
225 | #define TIPC_MAX_LINK_NAME 60 /* format = Z.C.N:interface-Z.C.N:interface */ | ||
226 | |||
227 | struct tipc_media_addr { | ||
228 | __u32 type; | ||
229 | union { | ||
230 | __u8 eth_addr[6]; /* Ethernet bearer */ | ||
231 | #if 0 | ||
232 | /* Prototypes for other possible bearer types */ | ||
233 | |||
234 | struct { | ||
235 | __u16 sin_family; | ||
236 | __u16 sin_port; | ||
237 | struct { | ||
238 | __u32 s_addr; | ||
239 | } sin_addr; | ||
240 | char pad[4]; | ||
241 | } addr_in; /* IP-based bearer */ | ||
242 | __u16 sock_descr; /* generic socket bearer */ | ||
243 | #endif | ||
244 | } dev_addr; | ||
245 | }; | ||
246 | |||
247 | |||
248 | /* Link priority limits (range from 0 to # priorities - 1) */ | ||
249 | |||
250 | #define TIPC_NUM_LINK_PRI 32 | ||
251 | |||
252 | /* Link tolerance limits (min, default, max), in ms */ | ||
253 | |||
254 | #define TIPC_MIN_LINK_TOL 50 | ||
255 | #define TIPC_DEF_LINK_TOL 1500 | ||
256 | #define TIPC_MAX_LINK_TOL 30000 | ||
257 | |||
258 | /* Link window limits (min, default, max), in packets */ | ||
259 | |||
260 | #define TIPC_MIN_LINK_WIN 16 | ||
261 | #define TIPC_DEF_LINK_WIN 50 | ||
262 | #define TIPC_MAX_LINK_WIN 150 | ||
263 | |||
264 | /* | ||
265 | * Configuration | ||
266 | * | ||
267 | * All configuration management messaging involves sending a request message | ||
268 | * to the TIPC configuration service on a node, which sends a reply message | ||
269 | * back. (In the future multi-message replies may be supported.) | ||
270 | * | ||
271 | * Both request and reply messages consist of a transport header and payload. | ||
272 | * The transport header contains info about the desired operation; | ||
273 | * the payload consists of zero or more type/length/value (TLV) items | ||
274 | * which specify parameters or results for the operation. | ||
275 | * | ||
276 | * For many operations, the request and reply messages have a fixed number | ||
277 | * of TLVs (usually zero or one); however, some reply messages may return | ||
278 | * a variable number of TLVs. A failed request is denoted by the presence | ||
279 | * of an "error string" TLV in the reply message instead of the TLV(s) the | ||
280 | * reply should contain if the request succeeds. | ||
281 | */ | ||
282 | |||
283 | #define TIPC_CFG_SRV 0 /* configuration service name type */ | ||
284 | |||
285 | /* | ||
286 | * Public commands: | ||
287 | * May be issued by any process. | ||
288 | * Accepted by own node, or by remote node only if remote management enabled. | ||
289 | */ | ||
290 | |||
291 | #define TIPC_CMD_NOOP 0x0000 /* tx none, rx none */ | ||
292 | #define TIPC_CMD_GET_NODES 0x0001 /* tx net_addr, rx node_info(s) */ | ||
293 | #define TIPC_CMD_GET_MEDIA_NAMES 0x0002 /* tx none, rx media_name(s) */ | ||
294 | #define TIPC_CMD_GET_BEARER_NAMES 0x0003 /* tx none, rx bearer_name(s) */ | ||
295 | #define TIPC_CMD_GET_LINKS 0x0004 /* tx net_addr, rx link_info(s) */ | ||
296 | #define TIPC_CMD_SHOW_NAME_TABLE 0x0005 /* tx name_tbl_query, rx ultra_string */ | ||
297 | #define TIPC_CMD_SHOW_PORTS 0x0006 /* tx none, rx ultra_string */ | ||
298 | #define TIPC_CMD_SHOW_LINK_STATS 0x000B /* tx link_name, rx ultra_string */ | ||
299 | |||
300 | #if 0 | ||
301 | #define TIPC_CMD_SHOW_PORT_STATS 0x0008 /* tx port_ref, rx ultra_string */ | ||
302 | #define TIPC_CMD_RESET_PORT_STATS 0x0009 /* tx port_ref, rx none */ | ||
303 | #define TIPC_CMD_GET_ROUTES 0x000A /* tx ?, rx ? */ | ||
304 | #define TIPC_CMD_GET_LINK_PEER 0x000D /* tx link_name, rx ? */ | ||
305 | #endif | ||
306 | |||
307 | /* | ||
308 | * Protected commands: | ||
309 | * May only be issued by "network administration capable" process. | ||
310 | * Accepted by own node, or by remote node only if remote management enabled | ||
311 | * and this node is zone manager. | ||
312 | */ | ||
313 | |||
314 | #define TIPC_CMD_GET_REMOTE_MNG 0x4003 /* tx none, rx unsigned */ | ||
315 | #define TIPC_CMD_GET_MAX_PORTS 0x4004 /* tx none, rx unsigned */ | ||
316 | #define TIPC_CMD_GET_MAX_PUBL 0x4005 /* tx none, rx unsigned */ | ||
317 | #define TIPC_CMD_GET_MAX_SUBSCR 0x4006 /* tx none, rx unsigned */ | ||
318 | #define TIPC_CMD_GET_MAX_ZONES 0x4007 /* tx none, rx unsigned */ | ||
319 | #define TIPC_CMD_GET_MAX_CLUSTERS 0x4008 /* tx none, rx unsigned */ | ||
320 | #define TIPC_CMD_GET_MAX_NODES 0x4009 /* tx none, rx unsigned */ | ||
321 | #define TIPC_CMD_GET_MAX_SLAVES 0x400A /* tx none, rx unsigned */ | ||
322 | #define TIPC_CMD_GET_NETID 0x400B /* tx none, rx unsigned */ | ||
323 | |||
324 | #define TIPC_CMD_ENABLE_BEARER 0x4101 /* tx bearer_config, rx none */ | ||
325 | #define TIPC_CMD_DISABLE_BEARER 0x4102 /* tx bearer_name, rx none */ | ||
326 | #define TIPC_CMD_SET_LINK_TOL 0x4107 /* tx link_config, rx none */ | ||
327 | #define TIPC_CMD_SET_LINK_PRI 0x4108 /* tx link_config, rx none */ | ||
328 | #define TIPC_CMD_SET_LINK_WINDOW 0x4109 /* tx link_config, rx none */ | ||
329 | #define TIPC_CMD_SET_LOG_SIZE 0x410A /* tx unsigned, rx none */ | ||
330 | #define TIPC_CMD_DUMP_LOG 0x410B /* tx none, rx ultra_string */ | ||
331 | #define TIPC_CMD_RESET_LINK_STATS 0x410C /* tx link_name, rx none */ | ||
332 | |||
333 | #if 0 | ||
334 | #define TIPC_CMD_CREATE_LINK 0x4103 /* tx link_create, rx none */ | ||
335 | #define TIPC_CMD_REMOVE_LINK 0x4104 /* tx link_name, rx none */ | ||
336 | #define TIPC_CMD_BLOCK_LINK 0x4105 /* tx link_name, rx none */ | ||
337 | #define TIPC_CMD_UNBLOCK_LINK 0x4106 /* tx link_name, rx none */ | ||
338 | #endif | ||
339 | |||
340 | /* | ||
341 | * Private commands: | ||
342 | * May only be issued by "network administration capable" process. | ||
343 | * Accepted by own node only; cannot be used on a remote node. | ||
344 | */ | ||
345 | |||
346 | #define TIPC_CMD_SET_NODE_ADDR 0x8001 /* tx net_addr, rx none */ | ||
347 | #if 0 | ||
348 | #define TIPC_CMD_SET_ZONE_MASTER 0x8002 /* tx none, rx none */ | ||
349 | #endif | ||
350 | #define TIPC_CMD_SET_REMOTE_MNG 0x8003 /* tx unsigned, rx none */ | ||
351 | #define TIPC_CMD_SET_MAX_PORTS 0x8004 /* tx unsigned, rx none */ | ||
352 | #define TIPC_CMD_SET_MAX_PUBL 0x8005 /* tx unsigned, rx none */ | ||
353 | #define TIPC_CMD_SET_MAX_SUBSCR 0x8006 /* tx unsigned, rx none */ | ||
354 | #define TIPC_CMD_SET_MAX_ZONES 0x8007 /* tx unsigned, rx none */ | ||
355 | #define TIPC_CMD_SET_MAX_CLUSTERS 0x8008 /* tx unsigned, rx none */ | ||
356 | #define TIPC_CMD_SET_MAX_NODES 0x8009 /* tx unsigned, rx none */ | ||
357 | #define TIPC_CMD_SET_MAX_SLAVES 0x800A /* tx unsigned, rx none */ | ||
358 | #define TIPC_CMD_SET_NETID 0x800B /* tx unsigned, rx none */ | ||
359 | |||
360 | /* | ||
361 | * TLV types defined for TIPC | ||
362 | */ | ||
363 | |||
364 | #define TIPC_TLV_NONE 0 /* no TLV present */ | ||
365 | #define TIPC_TLV_VOID 1 /* empty TLV (0 data bytes)*/ | ||
366 | #define TIPC_TLV_UNSIGNED 2 /* 32-bit integer */ | ||
367 | #define TIPC_TLV_STRING 3 /* char[128] (max) */ | ||
368 | #define TIPC_TLV_LARGE_STRING 4 /* char[2048] (max) */ | ||
369 | #define TIPC_TLV_ULTRA_STRING 5 /* char[32768] (max) */ | ||
370 | |||
371 | #define TIPC_TLV_ERROR_STRING 16 /* char[128] containing "error code" */ | ||
372 | #define TIPC_TLV_NET_ADDR 17 /* 32-bit integer denoting <Z.C.N> */ | ||
373 | #define TIPC_TLV_MEDIA_NAME 18 /* char[MAX_MEDIA_NAME] */ | ||
374 | #define TIPC_TLV_BEARER_NAME 19 /* char[MAX_BEARER_NAME] */ | ||
375 | #define TIPC_TLV_LINK_NAME 20 /* char[MAX_LINK_NAME] */ | ||
376 | #define TIPC_TLV_NODE_INFO 21 /* struct tipc_node_info */ | ||
377 | #define TIPC_TLV_LINK_INFO 22 /* struct tipc_link_info */ | ||
378 | #define TIPC_TLV_BEARER_CONFIG 23 /* struct tipc_bearer_config */ | ||
379 | #define TIPC_TLV_LINK_CONFIG 24 /* struct tipc_link_config */ | ||
380 | #define TIPC_TLV_NAME_TBL_QUERY 25 /* struct tipc_name_table_query */ | ||
381 | #define TIPC_TLV_PORT_REF 26 /* 32-bit port reference */ | ||
382 | |||
383 | struct tipc_node_info { | ||
384 | __u32 addr; /* network address of node */ | ||
385 | __u32 up; /* 0=down, 1= up */ | ||
386 | }; | ||
387 | |||
388 | struct tipc_link_info { | ||
389 | __u32 dest; /* network address of peer node */ | ||
390 | __u32 up; /* 0=down, 1=up */ | ||
391 | char str[TIPC_MAX_LINK_NAME]; /* link name */ | ||
392 | }; | ||
393 | |||
394 | struct tipc_bearer_config { | ||
395 | __u32 priority; /* Range [1,31]. Override per link */ | ||
396 | __u32 detect_scope; | ||
397 | char name[TIPC_MAX_BEARER_NAME]; | ||
398 | }; | ||
399 | |||
400 | struct tipc_link_config { | ||
401 | __u32 value; | ||
402 | char name[TIPC_MAX_LINK_NAME]; | ||
403 | }; | ||
404 | |||
405 | #define TIPC_NTQ_ALLTYPES 0x80000000 | ||
406 | |||
407 | struct tipc_name_table_query { | ||
408 | __u32 depth; /* 1:type, 2:+name info, 3:+port info, 4+:+debug info */ | ||
409 | __u32 type; /* {t,l,u} info ignored if high bit of "depth" is set */ | ||
410 | __u32 lowbound; /* (i.e. displays all entries of name table) */ | ||
411 | __u32 upbound; | ||
412 | }; | ||
413 | |||
414 | /* | ||
415 | * The error string TLV is a null-terminated string describing the cause | ||
416 | * of the request failure. To simplify error processing (and to save space) | ||
417 | * the first character of the string can be a special error code character | ||
418 | * (lying by the range 0x80 to 0xFF) which represents a pre-defined reason. | ||
419 | */ | ||
420 | |||
421 | #define TIPC_CFG_TLV_ERROR "\x80" /* request contains incorrect TLV(s) */ | ||
422 | #define TIPC_CFG_NOT_NET_ADMIN "\x81" /* must be network administrator */ | ||
423 | #define TIPC_CFG_NOT_ZONE_MSTR "\x82" /* must be zone master */ | ||
424 | #define TIPC_CFG_NO_REMOTE "\x83" /* remote management not enabled */ | ||
425 | #define TIPC_CFG_NOT_SUPPORTED "\x84" /* request is not supported by TIPC */ | ||
426 | #define TIPC_CFG_INVALID_VALUE "\x85" /* request has invalid argument value */ | ||
427 | |||
428 | #if 0 | ||
429 | /* prototypes TLV structures for proposed commands */ | ||
430 | struct tipc_link_create { | ||
431 | __u32 domain; | ||
432 | struct tipc_media_addr peer_addr; | ||
433 | char bearer_name[MAX_BEARER_NAME]; | ||
434 | }; | ||
435 | |||
436 | struct tipc_route_info { | ||
437 | __u32 dest; | ||
438 | __u32 router; | ||
439 | }; | ||
440 | #endif | ||
441 | |||
442 | /* | ||
443 | * A TLV consists of a descriptor, followed by the TLV value. | ||
444 | * TLV descriptor fields are stored in network byte order; | ||
445 | * TLV values must also be stored in network byte order (where applicable). | ||
446 | * TLV descriptors must be aligned to addresses which are multiple of 4, | ||
447 | * so up to 3 bytes of padding may exist at the end of the TLV value area. | ||
448 | * There must not be any padding between the TLV descriptor and its value. | ||
449 | */ | ||
450 | |||
451 | struct tlv_desc { | ||
452 | __u16 tlv_len; /* TLV length (descriptor + value) */ | ||
453 | __u16 tlv_type; /* TLV identifier */ | ||
454 | }; | ||
455 | |||
456 | #define TLV_ALIGNTO 4 | ||
457 | |||
458 | #define TLV_ALIGN(datalen) (((datalen)+(TLV_ALIGNTO-1)) & ~(TLV_ALIGNTO-1)) | ||
459 | #define TLV_LENGTH(datalen) (sizeof(struct tlv_desc) + (datalen)) | ||
460 | #define TLV_SPACE(datalen) (TLV_ALIGN(TLV_LENGTH(datalen))) | ||
461 | #define TLV_DATA(tlv) ((void *)((char *)(tlv) + TLV_LENGTH(0))) | ||
462 | |||
463 | static inline int TLV_OK(const void *tlv, __u16 space) | ||
464 | { | ||
465 | /* | ||
466 | * Would also like to check that "tlv" is a multiple of 4, | ||
467 | * but don't know how to do this in a portable way. | ||
468 | * - Tried doing (!(tlv & (TLV_ALIGNTO-1))), but GCC compiler | ||
469 | * won't allow binary "&" with a pointer. | ||
470 | * - Tried casting "tlv" to integer type, but causes warning about size | ||
471 | * mismatch when pointer is bigger than chosen type (int, long, ...). | ||
472 | */ | ||
473 | |||
474 | return (space >= TLV_SPACE(0)) && | ||
475 | (ntohs(((struct tlv_desc *)tlv)->tlv_len) <= space); | ||
476 | } | ||
477 | |||
478 | static inline int TLV_CHECK(const void *tlv, __u16 space, __u16 exp_type) | ||
479 | { | ||
480 | return TLV_OK(tlv, space) && | ||
481 | (ntohs(((struct tlv_desc *)tlv)->tlv_type) == exp_type); | ||
482 | } | ||
483 | |||
484 | static inline int TLV_SET(void *tlv, __u16 type, void *data, __u16 len) | ||
485 | { | ||
486 | struct tlv_desc *tlv_ptr; | ||
487 | int tlv_len; | ||
488 | |||
489 | tlv_len = TLV_LENGTH(len); | ||
490 | tlv_ptr = (struct tlv_desc *)tlv; | ||
491 | tlv_ptr->tlv_type = htons(type); | ||
492 | tlv_ptr->tlv_len = htons(tlv_len); | ||
493 | if (len && data) | ||
494 | memcpy(TLV_DATA(tlv_ptr), data, tlv_len); | ||
495 | return TLV_SPACE(len); | ||
496 | } | ||
497 | |||
498 | /* | ||
499 | * A TLV list descriptor simplifies processing of messages | ||
500 | * containing multiple TLVs. | ||
501 | */ | ||
502 | |||
503 | struct tlv_list_desc { | ||
504 | struct tlv_desc *tlv_ptr; /* ptr to current TLV */ | ||
505 | __u32 tlv_space; /* # bytes from curr TLV to list end */ | ||
506 | }; | ||
507 | |||
508 | static inline void TLV_LIST_INIT(struct tlv_list_desc *list, | ||
509 | void *data, __u32 space) | ||
510 | { | ||
511 | list->tlv_ptr = (struct tlv_desc *)data; | ||
512 | list->tlv_space = space; | ||
513 | } | ||
514 | |||
515 | static inline int TLV_LIST_EMPTY(struct tlv_list_desc *list) | ||
516 | { | ||
517 | return (list->tlv_space == 0); | ||
518 | } | ||
519 | |||
520 | static inline int TLV_LIST_CHECK(struct tlv_list_desc *list, __u16 exp_type) | ||
521 | { | ||
522 | return TLV_CHECK(list->tlv_ptr, list->tlv_space, exp_type); | ||
523 | } | ||
524 | |||
525 | static inline void *TLV_LIST_DATA(struct tlv_list_desc *list) | ||
526 | { | ||
527 | return TLV_DATA(list->tlv_ptr); | ||
528 | } | ||
529 | |||
530 | static inline void TLV_LIST_STEP(struct tlv_list_desc *list) | ||
531 | { | ||
532 | __u16 tlv_space = TLV_ALIGN(ntohs(list->tlv_ptr->tlv_len)); | ||
533 | |||
534 | list->tlv_ptr = (struct tlv_desc *)((char *)list->tlv_ptr + tlv_space); | ||
535 | list->tlv_space -= tlv_space; | ||
536 | } | ||
537 | |||
538 | /* | ||
539 | * Configuration messages exchanged via NETLINK_GENERIC use the following | ||
540 | * family id, name, version and command. | ||
541 | */ | ||
542 | #define TIPC_GENL_FAMILY 0x222 | ||
543 | #define TIPC_GENL_NAME "TIPC" | ||
544 | #define TIPC_GENL_VERSION 0x1 | ||
545 | #define TIPC_GENL_CMD 0x1 | ||
546 | |||
547 | /* | ||
548 | * TIPC specific header used in NETLINK_GENERIC requests. | ||
549 | */ | ||
550 | struct tipc_genlmsghdr { | ||
551 | __u32 dest; /* Destination address */ | ||
552 | __u16 cmd; /* Command */ | ||
553 | __u16 reserved; /* Unused */ | ||
554 | }; | ||
555 | |||
556 | #define TIPC_GENL_HDRLEN NLMSG_ALIGN(sizeof(struct tipc_genlmsghdr)) | ||
557 | |||
558 | /* | ||
559 | * Configuration messages exchanged via TIPC sockets use the TIPC configuration | ||
560 | * message header, which is defined below. This structure is analogous | ||
561 | * to the Netlink message header, but fields are stored in network byte order | ||
562 | * and no padding is permitted between the header and the message data | ||
563 | * that follows. | ||
564 | */ | ||
565 | |||
566 | struct tipc_cfg_msg_hdr | ||
567 | { | ||
568 | __u32 tcm_len; /* Message length (including header) */ | ||
569 | __u16 tcm_type; /* Command type */ | ||
570 | __u16 tcm_flags; /* Additional flags */ | ||
571 | char tcm_reserved[8]; /* Unused */ | ||
572 | }; | ||
573 | |||
574 | #define TCM_F_REQUEST 0x1 /* Flag: Request message */ | ||
575 | #define TCM_F_MORE 0x2 /* Flag: Message to be continued */ | ||
576 | |||
577 | #define TCM_ALIGN(datalen) (((datalen)+3) & ~3) | ||
578 | #define TCM_LENGTH(datalen) (sizeof(struct tipc_cfg_msg_hdr) + datalen) | ||
579 | #define TCM_SPACE(datalen) (TCM_ALIGN(TCM_LENGTH(datalen))) | ||
580 | #define TCM_DATA(tcm_hdr) ((void *)((char *)(tcm_hdr) + TCM_LENGTH(0))) | ||
581 | |||
582 | static inline int TCM_SET(void *msg, __u16 cmd, __u16 flags, | ||
583 | void *data, __u16 data_len) | ||
584 | { | ||
585 | struct tipc_cfg_msg_hdr *tcm_hdr; | ||
586 | int msg_len; | ||
587 | |||
588 | msg_len = TCM_LENGTH(data_len); | ||
589 | tcm_hdr = (struct tipc_cfg_msg_hdr *)msg; | ||
590 | tcm_hdr->tcm_len = htonl(msg_len); | ||
591 | tcm_hdr->tcm_type = htons(cmd); | ||
592 | tcm_hdr->tcm_flags = htons(flags); | ||
593 | if (data_len && data) | ||
594 | memcpy(TCM_DATA(msg), data, data_len); | ||
595 | return TCM_SPACE(data_len); | ||
596 | } | ||
597 | |||
598 | #endif | ||