include/linux/tipc_config.h

   1 /*
   2  * include/linux/tipc_config.h: Include file for TIPC configuration interface
   3  *
   4  * Copyright (c) 2003-2005, Ericsson Research Canada
   5  * Copyright (c) 2005, Wind River Systems
   6  * Copyright (c) 2005-2006, Ericsson AB
   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 <asm/byteorder.h>
  44
  45 /*
  46  * Configuration
  47  *
  48  * All configuration management messaging involves sending a request message
  49  * to the TIPC configuration service on a node, which sends a reply message
  50  * back.  (In the future multi-message replies may be supported.)
  51  *
  52  * Both request and reply messages consist of a transport header and payload.
  53  * The transport header contains info about the desired operation;
  54  * the payload consists of zero or more type/length/value (TLV) items
  55  * which specify parameters or results for the operation.
  56  *
  57  * For many operations, the request and reply messages have a fixed number
  58  * of TLVs (usually zero or one); however, some reply messages may return
  59  * a variable number of TLVs.  A failed request is denoted by the presence
  60  * of an "error string" TLV in the reply message instead of the TLV(s) the
  61  * reply should contain if the request succeeds.
  62  */
  63
  64 /*
  65  * Public commands:
  66  * May be issued by any process.
  67  * Accepted by own node, or by remote node only if remote management enabled.
  68  */
  69
  70 #define  TIPC_CMD_NOOP              0x0000    /* tx none, rx none */
  71 #define  TIPC_CMD_GET_NODES         0x0001    /* tx net_addr, rx node_info(s) */
  72 #define  TIPC_CMD_GET_MEDIA_NAMES   0x0002    /* tx none, rx media_name(s) */
  73 #define  TIPC_CMD_GET_BEARER_NAMES  0x0003    /* tx none, rx bearer_name(s) */
  74 #define  TIPC_CMD_GET_LINKS         0x0004    /* tx net_addr, rx link_info(s) */
  75 #define  TIPC_CMD_SHOW_NAME_TABLE   0x0005    /* tx name_tbl_query, rx ultra_string */
  76 #define  TIPC_CMD_SHOW_PORTS        0x0006    /* tx none, rx ultra_string */
  77 #define  TIPC_CMD_SHOW_LINK_STATS   0x000B    /* tx link_name, 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  * TLV types defined for TIPC
 141  */
 142
 143 #define TIPC_TLV_NONE           0       /* no TLV present */
 144 #define TIPC_TLV_VOID           1       /* empty TLV (0 data bytes)*/
 145 #define TIPC_TLV_UNSIGNED       2       /* 32-bit integer */
 146 #define TIPC_TLV_STRING         3       /* char[128] (max) */
 147 #define TIPC_TLV_LARGE_STRING   4       /* char[2048] (max) */
 148 #define TIPC_TLV_ULTRA_STRING   5       /* char[32768] (max) */
 149
 150 #define TIPC_TLV_ERROR_STRING   16      /* char[128] containing "error code" */
 151 #define TIPC_TLV_NET_ADDR       17      /* 32-bit integer denoting <Z.C.N> */
 152 #define TIPC_TLV_MEDIA_NAME     18      /* char[TIPC_MAX_MEDIA_NAME] */
 153 #define TIPC_TLV_BEARER_NAME    19      /* char[TIPC_MAX_BEARER_NAME] */
 154 #define TIPC_TLV_LINK_NAME      20      /* char[TIPC_MAX_LINK_NAME] */
 155 #define TIPC_TLV_NODE_INFO      21      /* struct tipc_node_info */
 156 #define TIPC_TLV_LINK_INFO      22      /* struct tipc_link_info */
 157 #define TIPC_TLV_BEARER_CONFIG  23      /* struct tipc_bearer_config */
 158 #define TIPC_TLV_LINK_CONFIG    24      /* struct tipc_link_config */
 159 #define TIPC_TLV_NAME_TBL_QUERY 25      /* struct tipc_name_table_query */
 160 #define TIPC_TLV_PORT_REF       26      /* 32-bit port reference */
 161
 162 /*
 163  * Maximum sizes of TIPC bearer-related names (including terminating NUL)
 164  */
 165
 166 #define TIPC_MAX_MEDIA_NAME     16      /* format = media */
 167 #define TIPC_MAX_IF_NAME        16      /* format = interface */
 168 #define TIPC_MAX_BEARER_NAME    32      /* format = media:interface */
 169 #define TIPC_MAX_LINK_NAME      60      /* format = Z.C.N:interface-Z.C.N:interface */
 170
 171 /*
 172  * Link priority limits (range from 0 to # priorities - 1)
 173  */
 174
 175 #define TIPC_NUM_LINK_PRI 32
 176
 177 /*
 178  * Link tolerance limits (min, default, max), in ms
 179  */
 180
 181 #define TIPC_MIN_LINK_TOL 50
 182 #define TIPC_DEF_LINK_TOL 1500
 183 #define TIPC_MAX_LINK_TOL 30000
 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         __u32 addr;                     /* network address of node */
 196         __u32 up;                       /* 0=down, 1= up */
 197 };
 198
 199 struct tipc_link_info {
 200         __u32 dest;                     /* network address of peer node */
 201         __u32 up;                       /* 0=down, 1=up */
 202         char str[TIPC_MAX_LINK_NAME];   /* link name */
 203 };
 204
 205 struct tipc_bearer_config {
 206         __u32 priority;                 /* Range [1,31]. Override per link  */
 207         __u32 detect_scope;
 208         char name[TIPC_MAX_BEARER_NAME];
 209 };
 210
 211 struct tipc_link_config {
 212         __u32 value;
 213         char name[TIPC_MAX_LINK_NAME];
 214 };
 215
 216 #define TIPC_NTQ_ALLTYPES 0x80000000
 217
 218 struct tipc_name_table_query {
 219         __u32 depth;    /* 1:type, 2:+name info, 3:+port info, 4+:+debug info */
 220         __u32 type;     /* {t,l,u} info ignored if high bit of "depth" is set */
 221         __u32 lowbound; /* (i.e. displays all entries of name table) */
 222         __u32 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 #if 0
 240 /* prototypes TLV structures for proposed commands */
 241 struct tipc_link_create {
 242         __u32   domain;
 243         struct tipc_media_addr peer_addr;
 244         char bearer_name[TIPC_MAX_BEARER_NAME];
 245 };
 246
 247 struct tipc_route_info {
 248         __u32 dest;
 249         __u32 router;
 250 };
 251 #endif
 252
 253 /*
 254  * A TLV consists of a descriptor, followed by the TLV value.
 255  * TLV descriptor fields are stored in network byte order;
 256  * TLV values must also be stored in network byte order (where applicable).
 257  * TLV descriptors must be aligned to addresses which are multiple of 4,
 258  * so up to 3 bytes of padding may exist at the end of the TLV value area.
 259  * There must not be any padding between the TLV descriptor and its value.
 260  */
 261
 262 struct tlv_desc {
 263         __u16 tlv_len;          /* TLV length (descriptor + value) */
 264         __u16 tlv_type;         /* TLV identifier */
 265 };
 266
 267 #define TLV_ALIGNTO 4
 268
 269 #define TLV_ALIGN(datalen) (((datalen)+(TLV_ALIGNTO-1)) & ~(TLV_ALIGNTO-1))
 270 #define TLV_LENGTH(datalen) (sizeof(struct tlv_desc) + (datalen))
 271 #define TLV_SPACE(datalen) (TLV_ALIGN(TLV_LENGTH(datalen)))
 272 #define TLV_DATA(tlv) ((void *)((char *)(tlv) + TLV_LENGTH(0)))
 273
 274 static inline int TLV_OK(const void *tlv, __u16 space)
 275 {
 276         /*
 277          * Would also like to check that "tlv" is a multiple of 4,
 278          * but don't know how to do this in a portable way.
 279          * - Tried doing (!(tlv & (TLV_ALIGNTO-1))), but GCC compiler
 280          *   won't allow binary "&" with a pointer.
 281          * - Tried casting "tlv" to integer type, but causes warning about size
 282          *   mismatch when pointer is bigger than chosen type (int, long, ...).
 283          */
 284
 285         return (space >= TLV_SPACE(0)) &&
 286                 (ntohs(((struct tlv_desc *)tlv)->tlv_len) <= space);
 287 }
 288
 289 static inline int TLV_CHECK(const void *tlv, __u16 space, __u16 exp_type)
 290 {
 291         return TLV_OK(tlv, space) &&
 292                 (ntohs(((struct tlv_desc *)tlv)->tlv_type) == exp_type);
 293 }
 294
 295 static inline int TLV_SET(void *tlv, __u16 type, void *data, __u16 len)
 296 {
 297         struct tlv_desc *tlv_ptr;
 298         int tlv_len;
 299
 300         tlv_len = TLV_LENGTH(len);
 301         tlv_ptr = (struct tlv_desc *)tlv;
 302         tlv_ptr->tlv_type = htons(type);
 303         tlv_ptr->tlv_len  = htons(tlv_len);
 304         if (len && data)
 305                 memcpy(TLV_DATA(tlv_ptr), data, tlv_len);
 306         return TLV_SPACE(len);
 307 }
 308
 309 /*
 310  * A TLV list descriptor simplifies processing of messages
 311  * containing multiple TLVs.
 312  */
 313
 314 struct tlv_list_desc {
 315         struct tlv_desc *tlv_ptr;       /* ptr to current TLV */
 316         __u32 tlv_space;                /* # bytes from curr TLV to list end */
 317 };
 318
 319 static inline void TLV_LIST_INIT(struct tlv_list_desc *list,
 320                                  void *data, __u32 space)
 321 {
 322         list->tlv_ptr = (struct tlv_desc *)data;
 323         list->tlv_space = space;
 324 }
 325
 326 static inline int TLV_LIST_EMPTY(struct tlv_list_desc *list)
 327 {
 328         return (list->tlv_space == 0);
 329 }
 330
 331 static inline int TLV_LIST_CHECK(struct tlv_list_desc *list, __u16 exp_type)
 332 {
 333         return TLV_CHECK(list->tlv_ptr, list->tlv_space, exp_type);
 334 }
 335
 336 static inline void *TLV_LIST_DATA(struct tlv_list_desc *list)
 337 {
 338         return TLV_DATA(list->tlv_ptr);
 339 }
 340
 341 static inline void TLV_LIST_STEP(struct tlv_list_desc *list)
 342 {
 343         __u16 tlv_space = TLV_ALIGN(ntohs(list->tlv_ptr->tlv_len));
 344
 345         list->tlv_ptr = (struct tlv_desc *)((char *)list->tlv_ptr + tlv_space);
 346         list->tlv_space -= tlv_space;
 347 }
 348
 349 /*
 350  * Configuration messages exchanged via NETLINK_GENERIC use the following
 351  * family id, name, version and command.
 352  */
 353 #define TIPC_GENL_NAME          "TIPC"
 354 #define TIPC_GENL_VERSION       0x1
 355 #define TIPC_GENL_CMD           0x1
 356
 357 /*
 358  * TIPC specific header used in NETLINK_GENERIC requests.
 359  */
 360 struct tipc_genlmsghdr {
 361         __u32 dest;             /* Destination address */
 362         __u16 cmd;              /* Command */
 363         __u16 reserved;         /* Unused */
 364 };
 365
 366 #define TIPC_GENL_HDRLEN        NLMSG_ALIGN(sizeof(struct tipc_genlmsghdr))
 367
 368 /*
 369  * Configuration messages exchanged via TIPC sockets use the TIPC configuration
 370  * message header, which is defined below.  This structure is analogous
 371  * to the Netlink message header, but fields are stored in network byte order
 372  * and no padding is permitted between the header and the message data
 373  * that follows.
 374  */
 375
 376 struct tipc_cfg_msg_hdr
 377 {
 378         __u32 tcm_len;          /* Message length (including header) */
 379         __u16 tcm_type;         /* Command type */
 380         __u16 tcm_flags;        /* Additional flags */
 381         char  tcm_reserved[8];  /* Unused */
 382 };
 383
 384 #define TCM_F_REQUEST   0x1     /* Flag: Request message */
 385 #define TCM_F_MORE      0x2     /* Flag: Message to be continued */
 386
 387 #define TCM_ALIGN(datalen)  (((datalen)+3) & ~3)
 388 #define TCM_LENGTH(datalen) (sizeof(struct tipc_cfg_msg_hdr) + datalen)
 389 #define TCM_SPACE(datalen)  (TCM_ALIGN(TCM_LENGTH(datalen)))
 390 #define TCM_DATA(tcm_hdr)   ((void *)((char *)(tcm_hdr) + TCM_LENGTH(0)))
 391
 392 static inline int TCM_SET(void *msg, __u16 cmd, __u16 flags,
 393                           void *data, __u16 data_len)
 394 {
 395         struct tipc_cfg_msg_hdr *tcm_hdr;
 396         int msg_len;
 397
 398         msg_len = TCM_LENGTH(data_len);
 399         tcm_hdr = (struct tipc_cfg_msg_hdr *)msg;
 400         tcm_hdr->tcm_len   = htonl(msg_len);
 401         tcm_hdr->tcm_type  = htons(cmd);
 402         tcm_hdr->tcm_flags = htons(flags);
 403         if (data_len && data)
 404                 memcpy(TCM_DATA(msg), data, data_len);
 405         return TCM_SPACE(data_len);
 406 }
 407
 408 #endif