tipc_config.h 15 KB

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