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