1 /*
2 * include/uapi/linux/tipc_config.h: Header for TIPC configuration interface
3 *
4 * Copyright (c) 2003-2006, Ericsson AB
5 * Copyright (c) 2005-2007, 2010-2011, Wind River Systems
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the names of the copyright holders nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * Alternatively, this software may be distributed under the terms of the
21 * GNU General Public License ("GPL") version 2 as published by the Free
22 * Software Foundation.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37 #ifndef _LINUX_TIPC_CONFIG_H_
38 #define _LINUX_TIPC_CONFIG_H_
39
40 #include <linux/types.h>
41 #include <linux/string.h>
42 #include <linux/tipc.h>
43 #include <asm/byteorder.h>
44
45 #ifndef __KERNEL__
46 #include <arpa/inet.h> /* for ntohs etc. */
47 #endif
48
49 /*
50 * Configuration
51 *
52 * All configuration management messaging involves sending a request message
53 * to the TIPC configuration service on a node, which sends a reply message
54 * back. (In the future multi-message replies may be supported.)
55 *
56 * Both request and reply messages consist of a transport header and payload.
57 * The transport header contains info about the desired operation;
58 * the payload consists of zero or more type/length/value (TLV) items
59 * which specify parameters or results for the operation.
60 *
61 * For many operations, the request and reply messages have a fixed number
62 * of TLVs (usually zero or one); however, some reply messages may return
63 * a variable number of TLVs. A failed request is denoted by the presence
64 * of an "error string" TLV in the reply message instead of the TLV(s) the
65 * reply should contain if the request succeeds.
66 */
67
68 /*
69 * Public commands:
70 * May be issued by any process.
71 * Accepted by own node, or by remote node only if remote management enabled.
72 */
73
74 #define TIPC_CMD_NOOP 0x0000 /* tx none, rx none */
75 #define TIPC_CMD_GET_NODES 0x0001 /* tx net_addr, rx node_info(s) */
76 #define TIPC_CMD_GET_MEDIA_NAMES 0x0002 /* tx none, rx media_name(s) */
77 #define TIPC_CMD_GET_BEARER_NAMES 0x0003 /* tx none, rx bearer_name(s) */
78 #define TIPC_CMD_GET_LINKS 0x0004 /* tx net_addr, rx link_info(s) */
79 #define TIPC_CMD_SHOW_NAME_TABLE 0x0005 /* tx name_tbl_query, rx ultra_string */
80 #define TIPC_CMD_SHOW_PORTS 0x0006 /* tx none, rx ultra_string */
81 #define TIPC_CMD_SHOW_LINK_STATS 0x000B /* tx link_name, rx ultra_string */
82 #define TIPC_CMD_SHOW_STATS 0x000F /* tx unsigned, rx ultra_string */
83
84 /*
85 * Protected commands:
86 * May only be issued by "network administration capable" process.
87 * Accepted by own node, or by remote node only if remote management enabled
88 * and this node is zone manager.
89 */
90
91 #define TIPC_CMD_GET_REMOTE_MNG 0x4003 /* tx none, rx unsigned */
92 #define TIPC_CMD_GET_MAX_PORTS 0x4004 /* tx none, rx unsigned */
93 #define TIPC_CMD_GET_MAX_PUBL 0x4005 /* obsoleted */
94 #define TIPC_CMD_GET_MAX_SUBSCR 0x4006 /* obsoleted */
95 #define TIPC_CMD_GET_MAX_ZONES 0x4007 /* obsoleted */
96 #define TIPC_CMD_GET_MAX_CLUSTERS 0x4008 /* obsoleted */
97 #define TIPC_CMD_GET_MAX_NODES 0x4009 /* obsoleted */
98 #define TIPC_CMD_GET_MAX_SLAVES 0x400A /* obsoleted */
99 #define TIPC_CMD_GET_NETID 0x400B /* tx none, rx unsigned */
100
101 #define TIPC_CMD_ENABLE_BEARER 0x4101 /* tx bearer_config, rx none */
102 #define TIPC_CMD_DISABLE_BEARER 0x4102 /* tx bearer_name, rx none */
103 #define TIPC_CMD_SET_LINK_TOL 0x4107 /* tx link_config, rx none */
104 #define TIPC_CMD_SET_LINK_PRI 0x4108 /* tx link_config, rx none */
105 #define TIPC_CMD_SET_LINK_WINDOW 0x4109 /* tx link_config, rx none */
106 #define TIPC_CMD_SET_LOG_SIZE 0x410A /* obsoleted */
107 #define TIPC_CMD_DUMP_LOG 0x410B /* obsoleted */
108 #define TIPC_CMD_RESET_LINK_STATS 0x410C /* tx link_name, rx none */
109
110 /*
111 * Private commands:
112 * May only be issued by "network administration capable" process.
113 * Accepted by own node only; cannot be used on a remote node.
114 */
115
116 #define TIPC_CMD_SET_NODE_ADDR 0x8001 /* tx net_addr, rx none */
117 #define TIPC_CMD_SET_REMOTE_MNG 0x8003 /* tx unsigned, rx none */
118 #define TIPC_CMD_SET_MAX_PORTS 0x8004 /* tx unsigned, rx none */
119 #define TIPC_CMD_SET_MAX_PUBL 0x8005 /* obsoleted */
120 #define TIPC_CMD_SET_MAX_SUBSCR 0x8006 /* obsoleted */
121 #define TIPC_CMD_SET_MAX_ZONES 0x8007 /* obsoleted */
122 #define TIPC_CMD_SET_MAX_CLUSTERS 0x8008 /* obsoleted */
123 #define TIPC_CMD_SET_MAX_NODES 0x8009 /* obsoleted */
124 #define TIPC_CMD_SET_MAX_SLAVES 0x800A /* obsoleted */
125 #define TIPC_CMD_SET_NETID 0x800B /* tx unsigned, rx none */
126
127 /*
128 * Reserved commands:
129 * May not be issued by any process.
130 * Used internally by TIPC.
131 */
132
133 #define TIPC_CMD_NOT_NET_ADMIN 0xC001 /* tx none, rx none */
134
135 /*
136 * TLV types defined for TIPC
137 */
138
139 #define TIPC_TLV_NONE 0 /* no TLV present */
140 #define TIPC_TLV_VOID 1 /* empty TLV (0 data bytes)*/
141 #define TIPC_TLV_UNSIGNED 2 /* 32-bit integer */
142 #define TIPC_TLV_STRING 3 /* char[128] (max) */
143 #define TIPC_TLV_LARGE_STRING 4 /* char[2048] (max) */
144 #define TIPC_TLV_ULTRA_STRING 5 /* char[32768] (max) */
145
146 #define TIPC_TLV_ERROR_STRING 16 /* char[128] containing "error code" */
147 #define TIPC_TLV_NET_ADDR 17 /* 32-bit integer denoting <Z.C.N> */
148 #define TIPC_TLV_MEDIA_NAME 18 /* char[TIPC_MAX_MEDIA_NAME] */
149 #define TIPC_TLV_BEARER_NAME 19 /* char[TIPC_MAX_BEARER_NAME] */
150 #define TIPC_TLV_LINK_NAME 20 /* char[TIPC_MAX_LINK_NAME] */
151 #define TIPC_TLV_NODE_INFO 21 /* struct tipc_node_info */
152 #define TIPC_TLV_LINK_INFO 22 /* struct tipc_link_info */
153 #define TIPC_TLV_BEARER_CONFIG 23 /* struct tipc_bearer_config */
154 #define TIPC_TLV_LINK_CONFIG 24 /* struct tipc_link_config */
155 #define TIPC_TLV_NAME_TBL_QUERY 25 /* struct tipc_name_table_query */
156 #define TIPC_TLV_PORT_REF 26 /* 32-bit port reference */
157
158 /*
159 * Link priority limits (min, default, max, media default)
160 */
161
162 #define TIPC_MIN_LINK_PRI 0
163 #define TIPC_DEF_LINK_PRI 10
164 #define TIPC_MAX_LINK_PRI 31
165 #define TIPC_MEDIA_LINK_PRI (TIPC_MAX_LINK_PRI + 1)
166
167 /*
168 * Link tolerance limits (min, default, max), in ms
169 */
170
171 #define TIPC_MIN_LINK_TOL 50
172 #define TIPC_DEF_LINK_TOL 1500
173 #define TIPC_MAX_LINK_TOL 30000
174
175 #if (TIPC_MIN_LINK_TOL < 16)
176 #error "TIPC_MIN_LINK_TOL is too small (abort limit may be NaN)"
177 #endif
178
179 /*
180 * Link window limits (min, default, max), in packets
181 */
182
183 #define TIPC_MIN_LINK_WIN 16
184 #define TIPC_DEF_LINK_WIN 50
185 #define TIPC_MAX_LINK_WIN 8191
186
187
188 struct tipc_node_info {
189 __be32 addr; /* network address of node */
190 __be32 up; /* 0=down, 1= up */
191 };
192
193 struct tipc_link_info {
194 __be32 dest; /* network address of peer node */
195 __be32 up; /* 0=down, 1=up */
196 char str[TIPC_MAX_LINK_NAME]; /* link name */
197 };
198
199 struct tipc_bearer_config {
200 __be32 priority; /* Range [1,31]. Override per link */
201 __be32 disc_domain; /* <Z.C.N> describing desired nodes */
202 char name[TIPC_MAX_BEARER_NAME];
203 };
204
205 struct tipc_link_config {
206 __be32 value;
207 char name[TIPC_MAX_LINK_NAME];
208 };
209
210 #define TIPC_NTQ_ALLTYPES 0x80000000
211
212 struct tipc_name_table_query {
213 __be32 depth; /* 1:type, 2:+name info, 3:+port info, 4+:+debug info */
214 __be32 type; /* {t,l,u} info ignored if high bit of "depth" is set */
215 __be32 lowbound; /* (i.e. displays all entries of name table) */
216 __be32 upbound;
217 };
218
219 /*
220 * The error string TLV is a null-terminated string describing the cause
221 * of the request failure. To simplify error processing (and to save space)
222 * the first character of the string can be a special error code character
223 * (lying by the range 0x80 to 0xFF) which represents a pre-defined reason.
224 */
225
226 #define TIPC_CFG_TLV_ERROR "\x80" /* request contains incorrect TLV(s) */
227 #define TIPC_CFG_NOT_NET_ADMIN "\x81" /* must be network administrator */
228 #define TIPC_CFG_NOT_ZONE_MSTR "\x82" /* must be zone master */
229 #define TIPC_CFG_NO_REMOTE "\x83" /* remote management not enabled */
230 #define TIPC_CFG_NOT_SUPPORTED "\x84" /* request is not supported by TIPC */
231 #define TIPC_CFG_INVALID_VALUE "\x85" /* request has invalid argument value */
232
233 /*
234 * A TLV consists of a descriptor, followed by the TLV value.
235 * TLV descriptor fields are stored in network byte order;
236 * TLV values must also be stored in network byte order (where applicable).
237 * TLV descriptors must be aligned to addresses which are multiple of 4,
238 * so up to 3 bytes of padding may exist at the end of the TLV value area.
239 * There must not be any padding between the TLV descriptor and its value.
240 */
241
242 struct tlv_desc {
243 __be16 tlv_len; /* TLV length (descriptor + value) */
244 __be16 tlv_type; /* TLV identifier */
245 };
246
247 #define TLV_ALIGNTO 4
248
249 #define TLV_ALIGN(datalen) (((datalen)+(TLV_ALIGNTO-1)) & ~(TLV_ALIGNTO-1))
250 #define TLV_LENGTH(datalen) (sizeof(struct tlv_desc) + (datalen))
251 #define TLV_SPACE(datalen) (TLV_ALIGN(TLV_LENGTH(datalen)))
252 #define TLV_DATA(tlv) ((void *)((char *)(tlv) + TLV_LENGTH(0)))
253
TLV_OK(const void * tlv,__u16 space)254 static inline int TLV_OK(const void *tlv, __u16 space)
255 {
256 /*
257 * Would also like to check that "tlv" is a multiple of 4,
258 * but don't know how to do this in a portable way.
259 * - Tried doing (!(tlv & (TLV_ALIGNTO-1))), but GCC compiler
260 * won't allow binary "&" with a pointer.
261 * - Tried casting "tlv" to integer type, but causes warning about size
262 * mismatch when pointer is bigger than chosen type (int, long, ...).
263 */
264
265 return (space >= TLV_SPACE(0)) &&
266 (ntohs(((struct tlv_desc *)tlv)->tlv_len) <= space);
267 }
268
TLV_CHECK(const void * tlv,__u16 space,__u16 exp_type)269 static inline int TLV_CHECK(const void *tlv, __u16 space, __u16 exp_type)
270 {
271 return TLV_OK(tlv, space) &&
272 (ntohs(((struct tlv_desc *)tlv)->tlv_type) == exp_type);
273 }
274
TLV_GET_LEN(struct tlv_desc * tlv)275 static inline int TLV_GET_LEN(struct tlv_desc *tlv)
276 {
277 return ntohs(tlv->tlv_len);
278 }
279
TLV_SET_LEN(struct tlv_desc * tlv,__u16 len)280 static inline void TLV_SET_LEN(struct tlv_desc *tlv, __u16 len)
281 {
282 tlv->tlv_len = htons(len);
283 }
284
TLV_CHECK_TYPE(struct tlv_desc * tlv,__u16 type)285 static inline int TLV_CHECK_TYPE(struct tlv_desc *tlv, __u16 type)
286 {
287 return (ntohs(tlv->tlv_type) == type);
288 }
289
TLV_SET_TYPE(struct tlv_desc * tlv,__u16 type)290 static inline void TLV_SET_TYPE(struct tlv_desc *tlv, __u16 type)
291 {
292 tlv->tlv_type = htons(type);
293 }
294
TLV_SET(void * tlv,__u16 type,void * data,__u16 len)295 static inline int TLV_SET(void *tlv, __u16 type, void *data, __u16 len)
296 {
297 struct tlv_desc *tlv_ptr;
298 int tlv_len;
299
300 tlv_len = TLV_LENGTH(len);
301 tlv_ptr = (struct tlv_desc *)tlv;
302 tlv_ptr->tlv_type = htons(type);
303 tlv_ptr->tlv_len = htons(tlv_len);
304 if (len && data)
305 memcpy(TLV_DATA(tlv_ptr), data, tlv_len);
306 return TLV_SPACE(len);
307 }
308
309 /*
310 * A TLV list descriptor simplifies processing of messages
311 * containing multiple TLVs.
312 */
313
314 struct tlv_list_desc {
315 struct tlv_desc *tlv_ptr; /* ptr to current TLV */
316 __u32 tlv_space; /* # bytes from curr TLV to list end */
317 };
318
TLV_LIST_INIT(struct tlv_list_desc * list,void * data,__u32 space)319 static inline void TLV_LIST_INIT(struct tlv_list_desc *list,
320 void *data, __u32 space)
321 {
322 list->tlv_ptr = (struct tlv_desc *)data;
323 list->tlv_space = space;
324 }
325
TLV_LIST_EMPTY(struct tlv_list_desc * list)326 static inline int TLV_LIST_EMPTY(struct tlv_list_desc *list)
327 {
328 return (list->tlv_space == 0);
329 }
330
TLV_LIST_CHECK(struct tlv_list_desc * list,__u16 exp_type)331 static inline int TLV_LIST_CHECK(struct tlv_list_desc *list, __u16 exp_type)
332 {
333 return TLV_CHECK(list->tlv_ptr, list->tlv_space, exp_type);
334 }
335
TLV_LIST_DATA(struct tlv_list_desc * list)336 static inline void *TLV_LIST_DATA(struct tlv_list_desc *list)
337 {
338 return TLV_DATA(list->tlv_ptr);
339 }
340
TLV_LIST_STEP(struct tlv_list_desc * list)341 static inline void TLV_LIST_STEP(struct tlv_list_desc *list)
342 {
343 __u16 tlv_space = TLV_ALIGN(ntohs(list->tlv_ptr->tlv_len));
344
345 list->tlv_ptr = (struct tlv_desc *)((char *)list->tlv_ptr + tlv_space);
346 list->tlv_space -= tlv_space;
347 }
348
349 /*
350 * Configuration messages exchanged via NETLINK_GENERIC use the following
351 * family id, name, version and command.
352 */
353 #define TIPC_GENL_NAME "TIPC"
354 #define TIPC_GENL_VERSION 0x1
355 #define TIPC_GENL_CMD 0x1
356
357 /*
358 * TIPC specific header used in NETLINK_GENERIC requests.
359 */
360 struct tipc_genlmsghdr {
361 __u32 dest; /* Destination address */
362 __u16 cmd; /* Command */
363 __u16 reserved; /* Unused */
364 };
365
366 #define TIPC_GENL_HDRLEN NLMSG_ALIGN(sizeof(struct tipc_genlmsghdr))
367
368 /*
369 * Configuration messages exchanged via TIPC sockets use the TIPC configuration
370 * message header, which is defined below. This structure is analogous
371 * to the Netlink message header, but fields are stored in network byte order
372 * and no padding is permitted between the header and the message data
373 * that follows.
374 */
375
376 struct tipc_cfg_msg_hdr {
377 __be32 tcm_len; /* Message length (including header) */
378 __be16 tcm_type; /* Command type */
379 __be16 tcm_flags; /* Additional flags */
380 char tcm_reserved[8]; /* Unused */
381 };
382
383 #define TCM_F_REQUEST 0x1 /* Flag: Request message */
384 #define TCM_F_MORE 0x2 /* Flag: Message to be continued */
385
386 #define TCM_ALIGN(datalen) (((datalen)+3) & ~3)
387 #define TCM_LENGTH(datalen) (sizeof(struct tipc_cfg_msg_hdr) + datalen)
388 #define TCM_SPACE(datalen) (TCM_ALIGN(TCM_LENGTH(datalen)))
389 #define TCM_DATA(tcm_hdr) ((void *)((char *)(tcm_hdr) + TCM_LENGTH(0)))
390
TCM_SET(void * msg,__u16 cmd,__u16 flags,void * data,__u16 data_len)391 static inline int TCM_SET(void *msg, __u16 cmd, __u16 flags,
392 void *data, __u16 data_len)
393 {
394 struct tipc_cfg_msg_hdr *tcm_hdr;
395 int msg_len;
396
397 msg_len = TCM_LENGTH(data_len);
398 tcm_hdr = (struct tipc_cfg_msg_hdr *)msg;
399 tcm_hdr->tcm_len = htonl(msg_len);
400 tcm_hdr->tcm_type = htons(cmd);
401 tcm_hdr->tcm_flags = htons(flags);
402 if (data_len && data)
403 memcpy(TCM_DATA(msg), data, data_len);
404 return TCM_SPACE(data_len);
405 }
406
407 #endif
408