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