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