[TIPC] Update of file headers
[linux-2.6.git] / include / linux / tipc_config.h
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, 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
78 #if 0
79 #define  TIPC_CMD_SHOW_PORT_STATS   0x0008    /* tx port_ref, rx ultra_string */
80 #define  TIPC_CMD_RESET_PORT_STATS  0x0009    /* tx port_ref, rx none */
81 #define  TIPC_CMD_GET_ROUTES        0x000A    /* tx ?, rx ? */
82 #define  TIPC_CMD_GET_LINK_PEER     0x000D    /* tx link_name, rx ? */
83 #endif
84
85 /* 
86  * Protected commands:
87  * May only be issued by "network administration capable" process.
88  * Accepted by own node, or by remote node only if remote management enabled
89  * and this node is zone manager.                       
90  */
91
92 #define  TIPC_CMD_GET_REMOTE_MNG    0x4003    /* tx none, rx unsigned */
93 #define  TIPC_CMD_GET_MAX_PORTS     0x4004    /* tx none, rx unsigned */
94 #define  TIPC_CMD_GET_MAX_PUBL      0x4005    /* tx none, rx unsigned */
95 #define  TIPC_CMD_GET_MAX_SUBSCR    0x4006    /* tx none, rx unsigned */
96 #define  TIPC_CMD_GET_MAX_ZONES     0x4007    /* tx none, rx unsigned */
97 #define  TIPC_CMD_GET_MAX_CLUSTERS  0x4008    /* tx none, rx unsigned */
98 #define  TIPC_CMD_GET_MAX_NODES     0x4009    /* tx none, rx unsigned */
99 #define  TIPC_CMD_GET_MAX_SLAVES    0x400A    /* tx none, rx unsigned */
100 #define  TIPC_CMD_GET_NETID         0x400B    /* tx none, rx unsigned */
101
102 #define  TIPC_CMD_ENABLE_BEARER     0x4101    /* tx bearer_config, rx none */
103 #define  TIPC_CMD_DISABLE_BEARER    0x4102    /* tx bearer_name, rx none */
104 #define  TIPC_CMD_SET_LINK_TOL      0x4107    /* tx link_config, rx none */
105 #define  TIPC_CMD_SET_LINK_PRI      0x4108    /* tx link_config, rx none */
106 #define  TIPC_CMD_SET_LINK_WINDOW   0x4109    /* tx link_config, rx none */
107 #define  TIPC_CMD_SET_LOG_SIZE      0x410A    /* tx unsigned, rx none */
108 #define  TIPC_CMD_DUMP_LOG          0x410B    /* tx none, rx ultra_string */
109 #define  TIPC_CMD_RESET_LINK_STATS  0x410C    /* tx link_name, rx none */
110
111 #if 0
112 #define  TIPC_CMD_CREATE_LINK       0x4103    /* tx link_create, rx none */
113 #define  TIPC_CMD_REMOVE_LINK       0x4104    /* tx link_name, rx none */
114 #define  TIPC_CMD_BLOCK_LINK        0x4105    /* tx link_name, rx none */
115 #define  TIPC_CMD_UNBLOCK_LINK      0x4106    /* tx link_name, rx none */
116 #endif
117
118 /* 
119  * Private commands:
120  * May only be issued by "network administration capable" process.
121  * Accepted by own node only; cannot be used on a remote node.                       
122  */
123
124 #define  TIPC_CMD_SET_NODE_ADDR     0x8001    /* tx net_addr, rx none */
125 #if 0
126 #define  TIPC_CMD_SET_ZONE_MASTER   0x8002    /* tx none, rx none */
127 #endif
128 #define  TIPC_CMD_SET_REMOTE_MNG    0x8003    /* tx unsigned, rx none */
129 #define  TIPC_CMD_SET_MAX_PORTS     0x8004    /* tx unsigned, rx none */
130 #define  TIPC_CMD_SET_MAX_PUBL      0x8005    /* tx unsigned, rx none */
131 #define  TIPC_CMD_SET_MAX_SUBSCR    0x8006    /* tx unsigned, rx none */
132 #define  TIPC_CMD_SET_MAX_ZONES     0x8007    /* tx unsigned, rx none */
133 #define  TIPC_CMD_SET_MAX_CLUSTERS  0x8008    /* tx unsigned, rx none */
134 #define  TIPC_CMD_SET_MAX_NODES     0x8009    /* tx unsigned, rx none */
135 #define  TIPC_CMD_SET_MAX_SLAVES    0x800A    /* tx unsigned, rx none */
136 #define  TIPC_CMD_SET_NETID         0x800B    /* tx unsigned, rx none */
137
138 /*
139  * TLV types defined for TIPC
140  */
141
142 #define TIPC_TLV_NONE           0       /* no TLV present */
143 #define TIPC_TLV_VOID           1       /* empty TLV (0 data bytes)*/
144 #define TIPC_TLV_UNSIGNED       2       /* 32-bit integer */
145 #define TIPC_TLV_STRING         3       /* char[128] (max) */
146 #define TIPC_TLV_LARGE_STRING   4       /* char[2048] (max) */
147 #define TIPC_TLV_ULTRA_STRING   5       /* char[32768] (max) */
148
149 #define TIPC_TLV_ERROR_STRING   16      /* char[128] containing "error code" */
150 #define TIPC_TLV_NET_ADDR       17      /* 32-bit integer denoting <Z.C.N> */
151 #define TIPC_TLV_MEDIA_NAME     18      /* char[TIPC_MAX_MEDIA_NAME] */
152 #define TIPC_TLV_BEARER_NAME    19      /* char[TIPC_MAX_BEARER_NAME] */
153 #define TIPC_TLV_LINK_NAME      20      /* char[TIPC_MAX_LINK_NAME] */
154 #define TIPC_TLV_NODE_INFO      21      /* struct tipc_node_info */
155 #define TIPC_TLV_LINK_INFO      22      /* struct tipc_link_info */
156 #define TIPC_TLV_BEARER_CONFIG  23      /* struct tipc_bearer_config */
157 #define TIPC_TLV_LINK_CONFIG    24      /* struct tipc_link_config */
158 #define TIPC_TLV_NAME_TBL_QUERY 25      /* struct tipc_name_table_query */
159 #define TIPC_TLV_PORT_REF       26      /* 32-bit port reference */
160
161 /*
162  * Maximum sizes of TIPC bearer-related names (including terminating NUL)
163  */ 
164
165 #define TIPC_MAX_MEDIA_NAME     16      /* format = media */
166 #define TIPC_MAX_IF_NAME        16      /* format = interface */
167 #define TIPC_MAX_BEARER_NAME    32      /* format = media:interface */
168 #define TIPC_MAX_LINK_NAME      60      /* format = Z.C.N:interface-Z.C.N:interface */
169
170 /*
171  * Link priority limits (range from 0 to # priorities - 1)
172  */
173
174 #define TIPC_NUM_LINK_PRI 32
175
176 /*
177  * Link tolerance limits (min, default, max), in ms
178  */
179
180 #define TIPC_MIN_LINK_TOL 50
181 #define TIPC_DEF_LINK_TOL 1500
182 #define TIPC_MAX_LINK_TOL 30000
183
184 /*
185  * Link window limits (min, default, max), in packets
186  */
187
188 #define TIPC_MIN_LINK_WIN 16
189 #define TIPC_DEF_LINK_WIN 50
190 #define TIPC_MAX_LINK_WIN 150
191
192
193 struct tipc_node_info {
194         __u32 addr;                     /* network address of node */
195         __u32 up;                       /* 0=down, 1= up */
196 };
197
198 struct tipc_link_info {
199         __u32 dest;                     /* network address of peer node */
200         __u32 up;                       /* 0=down, 1=up */
201         char str[TIPC_MAX_LINK_NAME];   /* link name */
202 };
203
204 struct tipc_bearer_config {
205         __u32 priority;                 /* Range [1,31]. Override per link  */
206         __u32 detect_scope;     
207         char name[TIPC_MAX_BEARER_NAME];
208 };
209
210 struct tipc_link_config {
211         __u32 value;
212         char name[TIPC_MAX_LINK_NAME];
213 };
214
215 #define TIPC_NTQ_ALLTYPES 0x80000000
216
217 struct tipc_name_table_query {
218         __u32 depth;    /* 1:type, 2:+name info, 3:+port info, 4+:+debug info */
219         __u32 type;     /* {t,l,u} info ignored if high bit of "depth" is set */
220         __u32 lowbound; /* (i.e. displays all entries of name table) */
221         __u32 upbound;
222 };
223
224 /*
225  * The error string TLV is a null-terminated string describing the cause 
226  * of the request failure.  To simplify error processing (and to save space)
227  * the first character of the string can be a special error code character
228  * (lying by the range 0x80 to 0xFF) which represents a pre-defined reason.
229  */
230
231 #define TIPC_CFG_TLV_ERROR      "\x80"  /* request contains incorrect TLV(s) */
232 #define TIPC_CFG_NOT_NET_ADMIN  "\x81"  /* must be network administrator */
233 #define TIPC_CFG_NOT_ZONE_MSTR  "\x82"  /* must be zone master */
234 #define TIPC_CFG_NO_REMOTE      "\x83"  /* remote management not enabled */
235 #define TIPC_CFG_NOT_SUPPORTED  "\x84"  /* request is not supported by TIPC */
236 #define TIPC_CFG_INVALID_VALUE  "\x85"  /* request has invalid argument value */
237
238 #if 0
239 /* prototypes TLV structures for proposed commands */
240 struct tipc_link_create {
241         __u32   domain;
242         struct tipc_media_addr peer_addr;
243         char bearer_name[TIPC_MAX_BEARER_NAME];
244 };
245
246 struct tipc_route_info {
247         __u32 dest;
248         __u32 router;
249 };
250 #endif
251
252 /*
253  * A TLV consists of a descriptor, followed by the TLV value.
254  * TLV descriptor fields are stored in network byte order; 
255  * TLV values must also be stored in network byte order (where applicable).
256  * TLV descriptors must be aligned to addresses which are multiple of 4,
257  * so up to 3 bytes of padding may exist at the end of the TLV value area.
258  * There must not be any padding between the TLV descriptor and its value.
259  */
260
261 struct tlv_desc {
262         __u16 tlv_len;          /* TLV length (descriptor + value) */
263         __u16 tlv_type;         /* TLV identifier */
264 };
265
266 #define TLV_ALIGNTO 4
267
268 #define TLV_ALIGN(datalen) (((datalen)+(TLV_ALIGNTO-1)) & ~(TLV_ALIGNTO-1))
269 #define TLV_LENGTH(datalen) (sizeof(struct tlv_desc) + (datalen))
270 #define TLV_SPACE(datalen) (TLV_ALIGN(TLV_LENGTH(datalen)))
271 #define TLV_DATA(tlv) ((void *)((char *)(tlv) + TLV_LENGTH(0)))
272
273 static inline int TLV_OK(const void *tlv, __u16 space)
274 {
275         /*
276          * Would also like to check that "tlv" is a multiple of 4,
277          * but don't know how to do this in a portable way.
278          * - Tried doing (!(tlv & (TLV_ALIGNTO-1))), but GCC compiler
279          *   won't allow binary "&" with a pointer.
280          * - Tried casting "tlv" to integer type, but causes warning about size
281          *   mismatch when pointer is bigger than chosen type (int, long, ...).
282          */
283
284         return (space >= TLV_SPACE(0)) &&
285                 (ntohs(((struct tlv_desc *)tlv)->tlv_len) <= space);
286 }
287
288 static inline int TLV_CHECK(const void *tlv, __u16 space, __u16 exp_type)
289 {
290         return TLV_OK(tlv, space) && 
291                 (ntohs(((struct tlv_desc *)tlv)->tlv_type) == exp_type);
292 }
293
294 static inline int TLV_SET(void *tlv, __u16 type, void *data, __u16 len)
295 {
296         struct tlv_desc *tlv_ptr;
297         int tlv_len;
298
299         tlv_len = TLV_LENGTH(len);
300         tlv_ptr = (struct tlv_desc *)tlv;
301         tlv_ptr->tlv_type = htons(type);
302         tlv_ptr->tlv_len  = htons(tlv_len);
303         if (len && data)
304                 memcpy(TLV_DATA(tlv_ptr), data, tlv_len);
305         return TLV_SPACE(len);
306 }
307
308 /*
309  * A TLV list descriptor simplifies processing of messages 
310  * containing multiple TLVs.
311  */
312
313 struct tlv_list_desc {
314         struct tlv_desc *tlv_ptr;       /* ptr to current TLV */
315         __u32 tlv_space;                /* # bytes from curr TLV to list end */
316 };
317
318 static inline void TLV_LIST_INIT(struct tlv_list_desc *list, 
319                                  void *data, __u32 space)
320 {
321         list->tlv_ptr = (struct tlv_desc *)data;
322         list->tlv_space = space;
323 }
324              
325 static inline int TLV_LIST_EMPTY(struct tlv_list_desc *list)
326
327         return (list->tlv_space == 0);
328 }
329
330 static inline int TLV_LIST_CHECK(struct tlv_list_desc *list, __u16 exp_type)
331 {
332         return TLV_CHECK(list->tlv_ptr, list->tlv_space, exp_type);
333 }
334
335 static inline void *TLV_LIST_DATA(struct tlv_list_desc *list)
336 {
337         return TLV_DATA(list->tlv_ptr);
338 }
339
340 static inline void TLV_LIST_STEP(struct tlv_list_desc *list)
341 {
342         __u16 tlv_space = TLV_ALIGN(ntohs(list->tlv_ptr->tlv_len));
343
344         list->tlv_ptr = (struct tlv_desc *)((char *)list->tlv_ptr + tlv_space);
345         list->tlv_space -= tlv_space;
346 }
347
348 /*
349  * Configuration messages exchanged via NETLINK_GENERIC use the following
350  * family id, name, version and command.
351  */
352 #define TIPC_GENL_NAME          "TIPC"
353 #define TIPC_GENL_VERSION       0x1
354 #define TIPC_GENL_CMD           0x1
355
356 /*
357  * TIPC specific header used in NETLINK_GENERIC requests.
358  */
359 struct tipc_genlmsghdr {
360         __u32 dest;             /* Destination address */
361         __u16 cmd;              /* Command */
362         __u16 reserved;         /* Unused */
363 };
364
365 #define TIPC_GENL_HDRLEN        NLMSG_ALIGN(sizeof(struct tipc_genlmsghdr))
366
367 /*
368  * Configuration messages exchanged via TIPC sockets use the TIPC configuration 
369  * message header, which is defined below.  This structure is analogous 
370  * to the Netlink message header, but fields are stored in network byte order 
371  * and no padding is permitted between the header and the message data 
372  * that follows.
373  */
374
375 struct tipc_cfg_msg_hdr
376 {
377         __u32 tcm_len;          /* Message length (including header) */
378         __u16 tcm_type;         /* Command type */
379         __u16 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
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