tipc.h 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232
  1. /*
  2. * include/uapi/linux/tipc.h: Header for TIPC socket interface
  3. *
  4. * Copyright (c) 2003-2006, Ericsson AB
  5. * Copyright (c) 2005, 2010-2011, 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_H_
  37. #define _LINUX_TIPC_H_
  38. #include <linux/types.h>
  39. #include <linux/sockios.h>
  40. /*
  41. * TIPC addressing primitives
  42. */
  43. struct tipc_portid {
  44. __u32 ref;
  45. __u32 node;
  46. };
  47. struct tipc_name {
  48. __u32 type;
  49. __u32 instance;
  50. };
  51. struct tipc_name_seq {
  52. __u32 type;
  53. __u32 lower;
  54. __u32 upper;
  55. };
  56. static __inline__ __u32 tipc_addr(unsigned int zone,
  57. unsigned int cluster,
  58. unsigned int node)
  59. {
  60. return (zone << 24) | (cluster << 12) | node;
  61. }
  62. static __inline__ unsigned int tipc_zone(__u32 addr)
  63. {
  64. return addr >> 24;
  65. }
  66. static __inline__ unsigned int tipc_cluster(__u32 addr)
  67. {
  68. return (addr >> 12) & 0xfff;
  69. }
  70. static __inline__ unsigned int tipc_node(__u32 addr)
  71. {
  72. return addr & 0xfff;
  73. }
  74. /*
  75. * Application-accessible port name types
  76. */
  77. #define TIPC_CFG_SRV 0 /* configuration service name type */
  78. #define TIPC_TOP_SRV 1 /* topology service name type */
  79. #define TIPC_LINK_STATE 2 /* link state name type */
  80. #define TIPC_RESERVED_TYPES 64 /* lowest user-publishable name type */
  81. /*
  82. * Publication scopes when binding port names and port name sequences
  83. */
  84. #define TIPC_ZONE_SCOPE 1
  85. #define TIPC_CLUSTER_SCOPE 2
  86. #define TIPC_NODE_SCOPE 3
  87. /*
  88. * Limiting values for messages
  89. */
  90. #define TIPC_MAX_USER_MSG_SIZE 66000U
  91. /*
  92. * Message importance levels
  93. */
  94. #define TIPC_LOW_IMPORTANCE 0
  95. #define TIPC_MEDIUM_IMPORTANCE 1
  96. #define TIPC_HIGH_IMPORTANCE 2
  97. #define TIPC_CRITICAL_IMPORTANCE 3
  98. /*
  99. * Msg rejection/connection shutdown reasons
  100. */
  101. #define TIPC_OK 0
  102. #define TIPC_ERR_NO_NAME 1
  103. #define TIPC_ERR_NO_PORT 2
  104. #define TIPC_ERR_NO_NODE 3
  105. #define TIPC_ERR_OVERLOAD 4
  106. #define TIPC_CONN_SHUTDOWN 5
  107. /*
  108. * TIPC topology subscription service definitions
  109. */
  110. #define TIPC_SUB_PORTS 0x01 /* filter for port availability */
  111. #define TIPC_SUB_SERVICE 0x02 /* filter for service availability */
  112. #define TIPC_SUB_CANCEL 0x04 /* cancel a subscription */
  113. #define TIPC_WAIT_FOREVER (~0) /* timeout for permanent subscription */
  114. struct tipc_subscr {
  115. struct tipc_name_seq seq; /* name sequence of interest */
  116. __u32 timeout; /* subscription duration (in ms) */
  117. __u32 filter; /* bitmask of filter options */
  118. char usr_handle[8]; /* available for subscriber use */
  119. };
  120. #define TIPC_PUBLISHED 1 /* publication event */
  121. #define TIPC_WITHDRAWN 2 /* withdraw event */
  122. #define TIPC_SUBSCR_TIMEOUT 3 /* subscription timeout event */
  123. struct tipc_event {
  124. __u32 event; /* event type */
  125. __u32 found_lower; /* matching name seq instances */
  126. __u32 found_upper; /* " " " " */
  127. struct tipc_portid port; /* associated port */
  128. struct tipc_subscr s; /* associated subscription */
  129. };
  130. /*
  131. * Socket API
  132. */
  133. #ifndef AF_TIPC
  134. #define AF_TIPC 30
  135. #endif
  136. #ifndef PF_TIPC
  137. #define PF_TIPC AF_TIPC
  138. #endif
  139. #ifndef SOL_TIPC
  140. #define SOL_TIPC 271
  141. #endif
  142. #define TIPC_ADDR_NAMESEQ 1
  143. #define TIPC_ADDR_MCAST 1
  144. #define TIPC_ADDR_NAME 2
  145. #define TIPC_ADDR_ID 3
  146. struct sockaddr_tipc {
  147. unsigned short family;
  148. unsigned char addrtype;
  149. signed char scope;
  150. union {
  151. struct tipc_portid id;
  152. struct tipc_name_seq nameseq;
  153. struct {
  154. struct tipc_name name;
  155. __u32 domain;
  156. } name;
  157. } addr;
  158. };
  159. /*
  160. * Ancillary data objects supported by recvmsg()
  161. */
  162. #define TIPC_ERRINFO 1 /* error info */
  163. #define TIPC_RETDATA 2 /* returned data */
  164. #define TIPC_DESTNAME 3 /* destination name */
  165. /*
  166. * TIPC-specific socket option values
  167. */
  168. #define TIPC_IMPORTANCE 127 /* Default: TIPC_LOW_IMPORTANCE */
  169. #define TIPC_SRC_DROPPABLE 128 /* Default: based on socket type */
  170. #define TIPC_DEST_DROPPABLE 129 /* Default: based on socket type */
  171. #define TIPC_CONN_TIMEOUT 130 /* Default: 8000 (ms) */
  172. #define TIPC_NODE_RECVQ_DEPTH 131 /* Default: none (read only) */
  173. #define TIPC_SOCK_RECVQ_DEPTH 132 /* Default: none (read only) */
  174. /*
  175. * Maximum sizes of TIPC bearer-related names (including terminating NULL)
  176. * The string formatting for each name element is:
  177. * media: media
  178. * interface: media:interface name
  179. * link: Z.C.N:interface-Z.C.N:interface
  180. *
  181. */
  182. #define TIPC_MAX_MEDIA_NAME 16
  183. #define TIPC_MAX_IF_NAME 16
  184. #define TIPC_MAX_BEARER_NAME 32
  185. #define TIPC_MAX_LINK_NAME 60
  186. #define SIOCGETLINKNAME SIOCPROTOPRIVATE
  187. struct tipc_sioc_ln_req {
  188. __u32 peer;
  189. __u32 bearer_id;
  190. char linkname[TIPC_MAX_LINK_NAME];
  191. };
  192. #endif