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 (min, default, max, media default) 172 */ 173 174 #define TIPC_MIN_LINK_PRI 0 175 #define TIPC_DEF_LINK_PRI 10 176 #define TIPC_MAX_LINK_PRI 31 177 #define TIPC_MEDIA_LINK_PRI (TIPC_MAX_LINK_PRI + 1) 178 179 /* 180 * Link tolerance limits (min, default, max), in ms 181 */ 182 183 #define TIPC_MIN_LINK_TOL 50 184 #define TIPC_DEF_LINK_TOL 1500 185 #define TIPC_MAX_LINK_TOL 30000 186 187 /* 188 * Link window limits (min, default, max), in packets 189 */ 190 191 #define TIPC_MIN_LINK_WIN 16 192 #define TIPC_DEF_LINK_WIN 50 193 #define TIPC_MAX_LINK_WIN 150 194 195 196 struct tipc_node_info { 197 __be32 addr; /* network address of node */ 198 __be32 up; /* 0=down, 1= up */ 199 }; 200 201 struct tipc_link_info { 202 __be32 dest; /* network address of peer node */ 203 __be32 up; /* 0=down, 1=up */ 204 char str[TIPC_MAX_LINK_NAME]; /* link name */ 205 }; 206 207 struct tipc_bearer_config { 208 __be32 priority; /* Range [1,31]. Override per link */ 209 __be32 detect_scope; 210 char name[TIPC_MAX_BEARER_NAME]; 211 }; 212 213 struct tipc_link_config { 214 __be32 value; 215 char name[TIPC_MAX_LINK_NAME]; 216 }; 217 218 #define TIPC_NTQ_ALLTYPES 0x80000000 219 220 struct tipc_name_table_query { 221 __be32 depth; /* 1:type, 2:+name info, 3:+port info, 4+:+debug info */ 222 __be32 type; /* {t,l,u} info ignored if high bit of "depth" is set */ 223 __be32 lowbound; /* (i.e. displays all entries of name table) */ 224 __be32 upbound; 225 }; 226 227 /* 228 * The error string TLV is a null-terminated string describing the cause 229 * of the request failure. To simplify error processing (and to save space) 230 * the first character of the string can be a special error code character 231 * (lying by the range 0x80 to 0xFF) which represents a pre-defined reason. 232 */ 233 234 #define TIPC_CFG_TLV_ERROR "\x80" /* request contains incorrect TLV(s) */ 235 #define TIPC_CFG_NOT_NET_ADMIN "\x81" /* must be network administrator */ 236 #define TIPC_CFG_NOT_ZONE_MSTR "\x82" /* must be zone master */ 237 #define TIPC_CFG_NO_REMOTE "\x83" /* remote management not enabled */ 238 #define TIPC_CFG_NOT_SUPPORTED "\x84" /* request is not supported by TIPC */ 239 #define TIPC_CFG_INVALID_VALUE "\x85" /* request has invalid argument value */ 240 241 #if 0 242 /* prototypes TLV structures for proposed commands */ 243 struct tipc_link_create { 244 __u32 domain; 245 struct tipc_media_addr peer_addr; 246 char bearer_name[TIPC_MAX_BEARER_NAME]; 247 }; 248 249 struct tipc_route_info { 250 __u32 dest; 251 __u32 router; 252 }; 253 #endif 254 255 /* 256 * A TLV consists of a descriptor, followed by the TLV value. 257 * TLV descriptor fields are stored in network byte order; 258 * TLV values must also be stored in network byte order (where applicable). 259 * TLV descriptors must be aligned to addresses which are multiple of 4, 260 * so up to 3 bytes of padding may exist at the end of the TLV value area. 261 * There must not be any padding between the TLV descriptor and its value. 262 */ 263 264 struct tlv_desc { 265 __be16 tlv_len; /* TLV length (descriptor + value) */ 266 __be16 tlv_type; /* TLV identifier */ 267 }; 268 269 #define TLV_ALIGNTO 4 270 271 #define TLV_ALIGN(datalen) (((datalen)+(TLV_ALIGNTO-1)) & ~(TLV_ALIGNTO-1)) 272 #define TLV_LENGTH(datalen) (sizeof(struct tlv_desc) + (datalen)) 273 #define TLV_SPACE(datalen) (TLV_ALIGN(TLV_LENGTH(datalen))) 274 #define TLV_DATA(tlv) ((void *)((char *)(tlv) + TLV_LENGTH(0))) 275 276 static __inline__ int TLV_OK(const void *tlv, __u16 space) 277 { 278 /* 279 * Would also like to check that "tlv" is a multiple of 4, 280 * but don't know how to do this in a portable way. 281 * - Tried doing (!(tlv & (TLV_ALIGNTO-1))), but GCC compiler 282 * won't allow binary "&" with a pointer. 283 * - Tried casting "tlv" to integer type, but causes warning about size 284 * mismatch when pointer is bigger than chosen type (int, long, ...). 285 */ 286 287 return (space >= TLV_SPACE(0)) && 288 (ntohs(((struct tlv_desc *)tlv)->tlv_len) <= space); 289 } 290 291 static __inline__ int TLV_CHECK(const void *tlv, __u16 space, __u16 exp_type) 292 { 293 return TLV_OK(tlv, space) && 294 (ntohs(((struct tlv_desc *)tlv)->tlv_type) == exp_type); 295 } 296 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 = htons(type); 305 tlv_ptr->tlv_len = htons(tlv_len); 306 if (len && data) 307 memcpy(TLV_DATA(tlv_ptr), data, tlv_len); 308 return TLV_SPACE(len); 309 } 310 311 /* 312 * A TLV list descriptor simplifies processing of messages 313 * containing multiple TLVs. 314 */ 315 316 struct tlv_list_desc { 317 struct tlv_desc *tlv_ptr; /* ptr to current TLV */ 318 __u32 tlv_space; /* # bytes from curr TLV to list end */ 319 }; 320 321 static __inline__ void TLV_LIST_INIT(struct tlv_list_desc *list, 322 void *data, __u32 space) 323 { 324 list->tlv_ptr = (struct tlv_desc *)data; 325 list->tlv_space = space; 326 } 327 328 static __inline__ int TLV_LIST_EMPTY(struct tlv_list_desc *list) 329 { 330 return (list->tlv_space == 0); 331 } 332 333 static __inline__ int TLV_LIST_CHECK(struct tlv_list_desc *list, __u16 exp_type) 334 { 335 return TLV_CHECK(list->tlv_ptr, list->tlv_space, exp_type); 336 } 337 338 static __inline__ void *TLV_LIST_DATA(struct tlv_list_desc *list) 339 { 340 return TLV_DATA(list->tlv_ptr); 341 } 342 343 static __inline__ void TLV_LIST_STEP(struct tlv_list_desc *list) 344 { 345 __u16 tlv_space = TLV_ALIGN(ntohs(list->tlv_ptr->tlv_len)); 346 347 list->tlv_ptr = (struct tlv_desc *)((char *)list->tlv_ptr + tlv_space); 348 list->tlv_space -= tlv_space; 349 } 350 351 /* 352 * Configuration messages exchanged via NETLINK_GENERIC use the following 353 * family id, name, version and command. 354 */ 355 #define TIPC_GENL_NAME "TIPC" 356 #define TIPC_GENL_VERSION 0x1 357 #define TIPC_GENL_CMD 0x1 358 359 /* 360 * TIPC specific header used in NETLINK_GENERIC requests. 361 */ 362 struct tipc_genlmsghdr { 363 __u32 dest; /* Destination address */ 364 __u16 cmd; /* Command */ 365 __u16 reserved; /* Unused */ 366 }; 367 368 #define TIPC_GENL_HDRLEN NLMSG_ALIGN(sizeof(struct tipc_genlmsghdr)) 369 370 /* 371 * Configuration messages exchanged via TIPC sockets use the TIPC configuration 372 * message header, which is defined below. This structure is analogous 373 * to the Netlink message header, but fields are stored in network byte order 374 * and no padding is permitted between the header and the message data 375 * that follows. 376 */ 377 378 struct tipc_cfg_msg_hdr 379 { 380 __be32 tcm_len; /* Message length (including header) */ 381 __be16 tcm_type; /* Command type */ 382 __be16 tcm_flags; /* Additional flags */ 383 char tcm_reserved[8]; /* Unused */ 384 }; 385 386 #define TCM_F_REQUEST 0x1 /* Flag: Request message */ 387 #define TCM_F_MORE 0x2 /* Flag: Message to be continued */ 388 389 #define TCM_ALIGN(datalen) (((datalen)+3) & ~3) 390 #define TCM_LENGTH(datalen) (sizeof(struct tipc_cfg_msg_hdr) + datalen) 391 #define TCM_SPACE(datalen) (TCM_ALIGN(TCM_LENGTH(datalen))) 392 #define TCM_DATA(tcm_hdr) ((void *)((char *)(tcm_hdr) + TCM_LENGTH(0))) 393 394 static __inline__ int TCM_SET(void *msg, __u16 cmd, __u16 flags, 395 void *data, __u16 data_len) 396 { 397 struct tipc_cfg_msg_hdr *tcm_hdr; 398 int msg_len; 399 400 msg_len = TCM_LENGTH(data_len); 401 tcm_hdr = (struct tipc_cfg_msg_hdr *)msg; 402 tcm_hdr->tcm_len = htonl(msg_len); 403 tcm_hdr->tcm_type = htons(cmd); 404 tcm_hdr->tcm_flags = htons(flags); 405 if (data_len && data) 406 memcpy(TCM_DATA(msg), data, data_len); 407 return TCM_SPACE(data_len); 408 } 409 410 #endif 411
