2 * include/linux/tipc.h: Include file for TIPC socket interface
4 * Copyright (c) 2003-2005, Ericsson Research Canada
5 * Copyright (c) 2005, Wind River Systems
6 * Copyright (c) 2005-2006, Ericsson AB
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
12 * Redistributions of source code must retain the above copyright notice, this
13 * list of conditions and the following disclaimer.
14 * Redistributions in binary form must reproduce the above copyright notice,
15 * this list of conditions and the following disclaimer in the documentation
16 * and/or other materials provided with the distribution.
17 * Neither the names of the copyright holders nor the names of its
18 * contributors may be used to endorse or promote products derived from this
19 * software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
25 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
34 #ifndef _LINUX_TIPC_H_
35 #define _LINUX_TIPC_H_
37 #include <linux/types.h>
40 * TIPC addressing primitives
53 struct tipc_name_seq {
59 static inline __u32 tipc_addr(unsigned int zone,
63 return (zone << 24) | (cluster << 12) | node;
66 static inline unsigned int tipc_zone(__u32 addr)
71 static inline unsigned int tipc_cluster(__u32 addr)
73 return (addr >> 12) & 0xfff;
76 static inline unsigned int tipc_node(__u32 addr)
82 * Application-accessible port name types
85 #define TIPC_CFG_SRV 0 /* configuration service name type */
86 #define TIPC_TOP_SRV 1 /* topology service name type */
87 #define TIPC_RESERVED_TYPES 64 /* lowest user-publishable name type */
90 * Publication scopes when binding port names and port name sequences
93 #define TIPC_ZONE_SCOPE 1
94 #define TIPC_CLUSTER_SCOPE 2
95 #define TIPC_NODE_SCOPE 3
98 * Limiting values for messages
101 #define TIPC_MAX_USER_MSG_SIZE 66000
104 * Message importance levels
107 #define TIPC_LOW_IMPORTANCE 0 /* default */
108 #define TIPC_MEDIUM_IMPORTANCE 1
109 #define TIPC_HIGH_IMPORTANCE 2
110 #define TIPC_CRITICAL_IMPORTANCE 3
113 * Msg rejection/connection shutdown reasons
117 #define TIPC_ERR_NO_NAME 1
118 #define TIPC_ERR_NO_PORT 2
119 #define TIPC_ERR_NO_NODE 3
120 #define TIPC_ERR_OVERLOAD 4
121 #define TIPC_CONN_SHUTDOWN 5
124 * TIPC topology subscription service definitions
127 #define TIPC_SUB_PORTS 0x01 /* filter for port availability */
128 #define TIPC_SUB_SERVICE 0x02 /* filter for service availability */
130 /* The following filter options are not currently implemented */
131 #define TIPC_SUB_NO_BIND_EVTS 0x04 /* filter out "publish" events */
132 #define TIPC_SUB_NO_UNBIND_EVTS 0x08 /* filter out "withdraw" events */
133 #define TIPC_SUB_SINGLE_EVT 0x10 /* expire after first event */
136 #define TIPC_WAIT_FOREVER ~0 /* timeout for permanent subscription */
139 struct tipc_name_seq seq; /* name sequence of interest */
140 __u32 timeout; /* subscription duration (in ms) */
141 __u32 filter; /* bitmask of filter options */
142 char usr_handle[8]; /* available for subscriber use */
145 #define TIPC_PUBLISHED 1 /* publication event */
146 #define TIPC_WITHDRAWN 2 /* withdraw event */
147 #define TIPC_SUBSCR_TIMEOUT 3 /* subscription timeout event */
150 __u32 event; /* event type */
151 __u32 found_lower; /* matching name seq instances */
152 __u32 found_upper; /* " " " " */
153 struct tipc_portid port; /* associated port */
154 struct tipc_subscr s; /* associated subscription */
166 #define PF_TIPC AF_TIPC
173 #define TIPC_ADDR_NAMESEQ 1
174 #define TIPC_ADDR_MCAST 1
175 #define TIPC_ADDR_NAME 2
176 #define TIPC_ADDR_ID 3
178 struct sockaddr_tipc {
179 unsigned short family;
180 unsigned char addrtype;
183 struct tipc_portid id;
184 struct tipc_name_seq nameseq;
186 struct tipc_name name;
187 __u32 domain; /* 0: own zone */
193 * Ancillary data objects supported by recvmsg()
196 #define TIPC_ERRINFO 1 /* error info */
197 #define TIPC_RETDATA 2 /* returned data */
198 #define TIPC_DESTNAME 3 /* destination name */
201 * TIPC-specific socket option values
204 #define TIPC_IMPORTANCE 127 /* Default: TIPC_LOW_IMPORTANCE */
205 #define TIPC_SRC_DROPPABLE 128 /* Default: 0 (resend congested msg) */
206 #define TIPC_DEST_DROPPABLE 129 /* Default: based on socket type */
207 #define TIPC_CONN_TIMEOUT 130 /* Default: 8000 (ms) */