---

---

---

001: /*
002:  * include/linux/tipc_config.h: Include file for TIPC configuration interface
003:  *
004:  * Copyright (c) 2003-2006, Ericsson AB
005:  * Copyright (c) 2005-2007, 2010-2011, Wind River Systems
006:  * All rights reserved.
007:  *
008:  * Redistribution and use in source and binary forms, with or without
009:  * modification, are permitted provided that the following conditions are met:
010:  *
011:  * 1. Redistributions of source code must retain the above copyright
012:  *    notice, this list of conditions and the following disclaimer.
013:  * 2. Redistributions in binary form must reproduce the above copyright
014:  *    notice, this list of conditions and the following disclaimer in the
015:  *    documentation and/or other materials provided with the distribution.
016:  * 3. Neither the names of the copyright holders nor the names of its
017:  *    contributors may be used to endorse or promote products derived from
018:  *    this software without specific prior written permission.
019:  *
020:  * Alternatively, this software may be distributed under the terms of the
021:  * GNU General Public License ("GPL") version 2 as published by the Free
022:  * Software Foundation.
023:  *
024:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
025:  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
026:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
027:  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
028:  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
029:  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
030:  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
031:  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
032:  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
033:  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
034:  * POSSIBILITY OF SUCH DAMAGE.
035:  */
036: 
037: #ifndef _LINUX_TIPC_CONFIG_H_
038: #define _LINUX_TIPC_CONFIG_H_
039: 
040: #include <linux/types.h>
041: #include <linux/string.h>
042: #include <asm/byteorder.h>
043: 
044: #include <arpa/inet.h> /* for ntohs etc. */
045: 
046: /*
047:  * Configuration
048:  *
049:  * All configuration management messaging involves sending a request message
050:  * to the TIPC configuration service on a node, which sends a reply message
051:  * back.  (In the future multi-message replies may be supported.)
052:  *
053:  * Both request and reply messages consist of a transport header and payload.
054:  * The transport header contains info about the desired operation;
055:  * the payload consists of zero or more type/length/value (TLV) items
056:  * which specify parameters or results for the operation.
057:  *
058:  * For many operations, the request and reply messages have a fixed number
059:  * of TLVs (usually zero or one); however, some reply messages may return
060:  * a variable number of TLVs.  A failed request is denoted by the presence
061:  * of an "error string" TLV in the reply message instead of the TLV(s) the
062:  * reply should contain if the request succeeds.
063:  */
064: 
065: /*
066:  * Public commands:
067:  * May be issued by any process.
068:  * Accepted by own node, or by remote node only if remote management enabled.
069:  */
070: 
071: #define  TIPC_CMD_NOOP              0x0000    /* tx none, rx none */
072: #define  TIPC_CMD_GET_NODES         0x0001    /* tx net_addr, rx node_info(s) */
073: #define  TIPC_CMD_GET_MEDIA_NAMES   0x0002    /* tx none, rx media_name(s) */
074: #define  TIPC_CMD_GET_BEARER_NAMES  0x0003    /* tx none, rx bearer_name(s) */
075: #define  TIPC_CMD_GET_LINKS         0x0004    /* tx net_addr, rx link_info(s) */
076: #define  TIPC_CMD_SHOW_NAME_TABLE   0x0005    /* tx name_tbl_query, rx ultra_string */
077: #define  TIPC_CMD_SHOW_PORTS        0x0006    /* tx none, rx ultra_string */
078: #define  TIPC_CMD_SHOW_LINK_STATS   0x000B    /* tx link_name, rx ultra_string */
079: #define  TIPC_CMD_SHOW_STATS        0x000F    /* tx unsigned, rx ultra_string */
080: 
081: /*
082:  * Protected commands:
083:  * May only be issued by "network administration capable" process.
084:  * Accepted by own node, or by remote node only if remote management enabled
085:  * and this node is zone manager.
086:  */
087: 
088: #define  TIPC_CMD_GET_REMOTE_MNG    0x4003    /* tx none, rx unsigned */
089: #define  TIPC_CMD_GET_MAX_PORTS     0x4004    /* tx none, rx unsigned */
090: #define  TIPC_CMD_GET_MAX_PUBL      0x4005    /* tx none, rx unsigned */
091: #define  TIPC_CMD_GET_MAX_SUBSCR    0x4006    /* tx none, rx unsigned */
092: #define  TIPC_CMD_GET_MAX_ZONES     0x4007    /* obsoleted */
093: #define  TIPC_CMD_GET_MAX_CLUSTERS  0x4008    /* obsoleted */
094: #define  TIPC_CMD_GET_MAX_NODES     0x4009    /* obsoleted */
095: #define  TIPC_CMD_GET_MAX_SLAVES    0x400A    /* obsoleted */
096: #define  TIPC_CMD_GET_NETID         0x400B    /* tx none, rx unsigned */
097: 
098: #define  TIPC_CMD_ENABLE_BEARER     0x4101    /* tx bearer_config, rx none */
099: #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    /* tx unsigned, rx none */
104: #define  TIPC_CMD_DUMP_LOG          0x410B    /* tx none, rx ultra_string */
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    /* tx unsigned, rx none */
117: #define  TIPC_CMD_SET_MAX_SUBSCR    0x8006    /* tx unsigned, rx none */
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:  * Maximum sizes of TIPC bearer-related names (including terminating NUL)
157:  */
158: 
159: #define TIPC_MAX_MEDIA_NAME     16      /* format = media */
160: #define TIPC_MAX_IF_NAME        16      /* format = interface */
161: #define TIPC_MAX_BEARER_NAME    32      /* format = media:interface */
162: #define TIPC_MAX_LINK_NAME      60      /* format = Z.C.N:interface-Z.C.N:interface */
163: 
164: /*
165:  * Link priority limits (min, default, max, media default)
166:  */
167: 
168: #define TIPC_MIN_LINK_PRI       0
169: #define TIPC_DEF_LINK_PRI       10
170: #define TIPC_MAX_LINK_PRI       31
171: #define TIPC_MEDIA_LINK_PRI     (TIPC_MAX_LINK_PRI + 1)
172: 
173: /*
174:  * Link tolerance limits (min, default, max), in ms
175:  */
176: 
177: #define TIPC_MIN_LINK_TOL 50
178: #define TIPC_DEF_LINK_TOL 1500
179: #define TIPC_MAX_LINK_TOL 30000
180: 
181: #if (TIPC_MIN_LINK_TOL < 16)
182: #error "TIPC_MIN_LINK_TOL is too small (abort limit may be NaN)"
183: #endif
184: 
185: /*
186:  * Link window limits (min, default, max), in packets
187:  */
188: 
189: #define TIPC_MIN_LINK_WIN 16
190: #define TIPC_DEF_LINK_WIN 50
191: #define TIPC_MAX_LINK_WIN 150
192: 
193: 
194: struct tipc_node_info {
195:         __be32 addr;                    /* network address of node */
196:         __be32 up;                      /* 0=down, 1= up */
197: };
198: 
199: struct tipc_link_info {
200:         __be32 dest;                    /* network address of peer node */
201:         __be32 up;                      /* 0=down, 1=up */
202:         char str[TIPC_MAX_LINK_NAME];   /* link name */
203: };
204: 
205: struct tipc_bearer_config {
206:         __be32 priority;                /* Range [1,31]. Override per link  */
207:         __be32 disc_domain;             /* <Z.C.N> describing desired nodes */
208:         char name[TIPC_MAX_BEARER_NAME];
209: };
210: 
211: struct tipc_link_config {
212:         __be32 value;
213:         char name[TIPC_MAX_LINK_NAME];
214: };
215: 
216: #define TIPC_NTQ_ALLTYPES 0x80000000
217: 
218: struct tipc_name_table_query {
219:         __be32 depth;   /* 1:type, 2:+name info, 3:+port info, 4+:+debug info */
220:         __be32 type;    /* {t,l,u} info ignored if high bit of "depth" is set */
221:         __be32 lowbound; /* (i.e. displays all entries of name table) */
222:         __be32 upbound;
223: };
224: 
225: /*
226:  * The error string TLV is a null-terminated string describing the cause
227:  * of the request failure.  To simplify error processing (and to save space)
228:  * the first character of the string can be a special error code character
229:  * (lying by the range 0x80 to 0xFF) which represents a pre-defined reason.
230:  */
231: 
232: #define TIPC_CFG_TLV_ERROR      "\x80"  /* request contains incorrect TLV(s) */
233: #define TIPC_CFG_NOT_NET_ADMIN  "\x81"  /* must be network administrator */
234: #define TIPC_CFG_NOT_ZONE_MSTR  "\x82"  /* must be zone master */
235: #define TIPC_CFG_NO_REMOTE      "\x83"  /* remote management not enabled */
236: #define TIPC_CFG_NOT_SUPPORTED  "\x84"  /* request is not supported by TIPC */
237: #define TIPC_CFG_INVALID_VALUE  "\x85"  /* request has invalid argument value */
238: 
239: /*
240:  * A TLV consists of a descriptor, followed by the TLV value.
241:  * TLV descriptor fields are stored in network byte order;
242:  * TLV values must also be stored in network byte order (where applicable).
243:  * TLV descriptors must be aligned to addresses which are multiple of 4,
244:  * so up to 3 bytes of padding may exist at the end of the TLV value area.
245:  * There must not be any padding between the TLV descriptor and its value.
246:  */
247: 
248: struct tlv_desc {
249:         __be16 tlv_len;         /* TLV length (descriptor + value) */
250:         __be16 tlv_type;                /* TLV identifier */
251: };
252: 
253: #define TLV_ALIGNTO 4
254: 
255: #define TLV_ALIGN(datalen) (((datalen)+(TLV_ALIGNTO-1)) & ~(TLV_ALIGNTO-1))
256: #define TLV_LENGTH(datalen) (sizeof(struct tlv_desc) + (datalen))
257: #define TLV_SPACE(datalen) (TLV_ALIGN(TLV_LENGTH(datalen)))
258: #define TLV_DATA(tlv) ((void *)((char *)(tlv) + TLV_LENGTH(0)))
259: 
260: static __inline__ int TLV_OK(const void *tlv, __u16 space)
261: {
262:         /*
263:          * Would also like to check that "tlv" is a multiple of 4,
264:          * but don't know how to do this in a portable way.
265:          * - Tried doing (!(tlv & (TLV_ALIGNTO-1))), but GCC compiler
266:          *   won't allow binary "&" with a pointer.
267:          * - Tried casting "tlv" to integer type, but causes warning about size
268:          *   mismatch when pointer is bigger than chosen type (int, long, ...).
269:          */
270: 
271:         return (space >= TLV_SPACE(0)) &&
272:                 (ntohs(((struct tlv_desc *)tlv)->tlv_len) <= space);
273: }
274: 
275: static __inline__ int TLV_CHECK(const void *tlv, __u16 space, __u16 exp_type)
276: {
277:         return TLV_OK(tlv, space) &&
278:                 (ntohs(((struct tlv_desc *)tlv)->tlv_type) == exp_type);
279: }
280: 
281: static __inline__ int TLV_SET(void *tlv, __u16 type, void *data, __u16 len)
282: {
283:         struct tlv_desc *tlv_ptr;
284:         int tlv_len;
285: 
286:         tlv_len = TLV_LENGTH(len);
287:         tlv_ptr = (struct tlv_desc *)tlv;
288:         tlv_ptr->tlv_type = htons(type);
289:         tlv_ptr->tlv_len  = htons(tlv_len);
290:         if (len && data)
291:                 memcpy(TLV_DATA(tlv_ptr), data, tlv_len);
292:         return TLV_SPACE(len);
293: }
294: 
295: /*
296:  * A TLV list descriptor simplifies processing of messages
297:  * containing multiple TLVs.
298:  */
299: 
300: struct tlv_list_desc {
301:         struct tlv_desc *tlv_ptr;       /* ptr to current TLV */
302:         __u32 tlv_space;                /* # bytes from curr TLV to list end */
303: };
304: 
305: static __inline__ void TLV_LIST_INIT(struct tlv_list_desc *list,
306:                                  void *data, __u32 space)
307: {
308:         list->tlv_ptr = (struct tlv_desc *)data;
309:         list->tlv_space = space;
310: }
311: 
312: static __inline__ int TLV_LIST_EMPTY(struct tlv_list_desc *list)
313: {
314:         return (list->tlv_space == 0);
315: }
316: 
317: static __inline__ int TLV_LIST_CHECK(struct tlv_list_desc *list, __u16 exp_type)
318: {
319:         return TLV_CHECK(list->tlv_ptr, list->tlv_space, exp_type);
320: }
321: 
322: static __inline__ void *TLV_LIST_DATA(struct tlv_list_desc *list)
323: {
324:         return TLV_DATA(list->tlv_ptr);
325: }
326: 
327: static __inline__ void TLV_LIST_STEP(struct tlv_list_desc *list)
328: {
329:         __u16 tlv_space = TLV_ALIGN(ntohs(list->tlv_ptr->tlv_len));
330: 
331:         list->tlv_ptr = (struct tlv_desc *)((char *)list->tlv_ptr + tlv_space);
332:         list->tlv_space -= tlv_space;
333: }
334: 
335: /*
336:  * Configuration messages exchanged via NETLINK_GENERIC use the following
337:  * family id, name, version and command.
338:  */
339: #define TIPC_GENL_NAME          "TIPC"
340: #define TIPC_GENL_VERSION       0x1
341: #define TIPC_GENL_CMD           0x1
342: 
343: /*
344:  * TIPC specific header used in NETLINK_GENERIC requests.
345:  */
346: struct tipc_genlmsghdr {
347:         __u32 dest;             /* Destination address */
348:         __u16 cmd;              /* Command */
349:         __u16 reserved;         /* Unused */
350: };
351: 
352: #define TIPC_GENL_HDRLEN        NLMSG_ALIGN(sizeof(struct tipc_genlmsghdr))
353: 
354: /*
355:  * Configuration messages exchanged via TIPC sockets use the TIPC configuration
356:  * message header, which is defined below.  This structure is analogous
357:  * to the Netlink message header, but fields are stored in network byte order
358:  * and no padding is permitted between the header and the message data
359:  * that follows.
360:  */
361: 
362: struct tipc_cfg_msg_hdr {
363:         __be32 tcm_len;         /* Message length (including header) */
364:         __be16 tcm_type;        /* Command type */
365:         __be16 tcm_flags;       /* Additional flags */
366:         char  tcm_reserved[8];  /* Unused */
367: };
368: 
369: #define TCM_F_REQUEST   0x1     /* Flag: Request message */
370: #define TCM_F_MORE      0x2     /* Flag: Message to be continued */
371: 
372: #define TCM_ALIGN(datalen)  (((datalen)+3) & ~3)
373: #define TCM_LENGTH(datalen) (sizeof(struct tipc_cfg_msg_hdr) + datalen)
374: #define TCM_SPACE(datalen)  (TCM_ALIGN(TCM_LENGTH(datalen)))
375: #define TCM_DATA(tcm_hdr)   ((void *)((char *)(tcm_hdr) + TCM_LENGTH(0)))
376: 
377: static __inline__ int TCM_SET(void *msg, __u16 cmd, __u16 flags,
378:                           void *data, __u16 data_len)
379: {
380:         struct tipc_cfg_msg_hdr *tcm_hdr;
381:         int msg_len;
382: 
383:         msg_len = TCM_LENGTH(data_len);
384:         tcm_hdr = (struct tipc_cfg_msg_hdr *)msg;
385:         tcm_hdr->tcm_len   = htonl(msg_len);
386:         tcm_hdr->tcm_type  = htons(cmd);
387:         tcm_hdr->tcm_flags = htons(flags);
388:         if (data_len && data)
389:                 memcpy(TCM_DATA(msg), data, data_len);
390:         return TCM_SPACE(data_len);
391: }
392: 
393: #endif
394: 

---

---

---