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 * 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.
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.
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.
38 #ifndef _LINUX_TIPC_H_
39 #define _LINUX_TIPC_H_
41 #include <linux/types.h>
44 * TIPC addressing primitives
57 struct tipc_name_seq {
63 static inline __u32 tipc_addr(unsigned int zone,
67 return (zone << 24) | (cluster << 12) | node;
70 static inline unsigned int tipc_zone(__u32 addr)
75 static inline unsigned int tipc_cluster(__u32 addr)
77 return (addr >> 12) & 0xfff;
80 static inline unsigned int tipc_node(__u32 addr)
86 * Application-accessible port name types
89 #define TIPC_CFG_SRV 0 /* configuration service name type */
90 #define TIPC_TOP_SRV 1 /* topology service name type */
91 #define TIPC_RESERVED_TYPES 64 /* lowest user-publishable name type */
94 * Publication scopes when binding port names and port name sequences
97 #define TIPC_ZONE_SCOPE 1
98 #define TIPC_CLUSTER_SCOPE 2
99 #define TIPC_NODE_SCOPE 3
102 * Limiting values for messages
105 #define TIPC_MAX_USER_MSG_SIZE 66000
108 * Message importance levels
111 #define TIPC_LOW_IMPORTANCE 0 /* default */
112 #define TIPC_MEDIUM_IMPORTANCE 1
113 #define TIPC_HIGH_IMPORTANCE 2
114 #define TIPC_CRITICAL_IMPORTANCE 3
117 * Msg rejection/connection shutdown reasons
121 #define TIPC_ERR_NO_NAME 1
122 #define TIPC_ERR_NO_PORT 2
123 #define TIPC_ERR_NO_NODE 3
124 #define TIPC_ERR_OVERLOAD 4
125 #define TIPC_CONN_SHUTDOWN 5
128 * TIPC topology subscription service definitions
131 #define TIPC_SUB_PORTS 0x01 /* filter for port availability */
132 #define TIPC_SUB_SERVICE 0x02 /* filter for service availability */
134 /* The following filter options are not currently implemented */
135 #define TIPC_SUB_NO_BIND_EVTS 0x04 /* filter out "publish" events */
136 #define TIPC_SUB_NO_UNBIND_EVTS 0x08 /* filter out "withdraw" events */
137 #define TIPC_SUB_SINGLE_EVT 0x10 /* expire after first event */
140 #define TIPC_WAIT_FOREVER ~0 /* timeout for permanent subscription */
143 struct tipc_name_seq seq; /* name sequence of interest */
144 __u32 timeout; /* subscription duration (in ms) */
145 __u32 filter; /* bitmask of filter options */
146 char usr_handle[8]; /* available for subscriber use */
149 #define TIPC_PUBLISHED 1 /* publication event */
150 #define TIPC_WITHDRAWN 2 /* withdraw event */
151 #define TIPC_SUBSCR_TIMEOUT 3 /* subscription timeout event */
154 __u32 event; /* event type */
155 __u32 found_lower; /* matching name seq instances */
156 __u32 found_upper; /* " " " " */
157 struct tipc_portid port; /* associated port */
158 struct tipc_subscr s; /* associated subscription */
170 #define PF_TIPC AF_TIPC
177 #define TIPC_ADDR_NAMESEQ 1
178 #define TIPC_ADDR_MCAST 1
179 #define TIPC_ADDR_NAME 2
180 #define TIPC_ADDR_ID 3
182 struct sockaddr_tipc {
183 unsigned short family;
184 unsigned char addrtype;
187 struct tipc_portid id;
188 struct tipc_name_seq nameseq;
190 struct tipc_name name;
191 __u32 domain; /* 0: own zone */
197 * Ancillary data objects supported by recvmsg()
200 #define TIPC_ERRINFO 1 /* error info */
201 #define TIPC_RETDATA 2 /* returned data */
202 #define TIPC_DESTNAME 3 /* destination name */
205 * TIPC-specific socket option values
208 #define TIPC_IMPORTANCE 127 /* Default: TIPC_LOW_IMPORTANCE */
209 #define TIPC_SRC_DROPPABLE 128 /* Default: 0 (resend congested msg) */
210 #define TIPC_DEST_DROPPABLE 129 /* Default: based on socket type */
211 #define TIPC_CONN_TIMEOUT 130 /* Default: 8000 (ms) */