1e2be04c7SGreg Kroah-Hartman /* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) */
2607ca46eSDavid Howells /*
38941bbcdSYing Xue * include/uapi/linux/tipc.h: Header for TIPC socket interface
4607ca46eSDavid Howells *
501fd12bbSJon Paul Maloy * Copyright (c) 2003-2006, 2015-2016 Ericsson AB
6607ca46eSDavid Howells * Copyright (c) 2005, 2010-2011, Wind River Systems
7607ca46eSDavid Howells * All rights reserved.
8607ca46eSDavid Howells *
9607ca46eSDavid Howells * Redistribution and use in source and binary forms, with or without
10607ca46eSDavid Howells * modification, are permitted provided that the following conditions are met:
11607ca46eSDavid Howells *
12607ca46eSDavid Howells * 1. Redistributions of source code must retain the above copyright
13607ca46eSDavid Howells * notice, this list of conditions and the following disclaimer.
14607ca46eSDavid Howells * 2. Redistributions in binary form must reproduce the above copyright
15607ca46eSDavid Howells * notice, this list of conditions and the following disclaimer in the
16607ca46eSDavid Howells * documentation and/or other materials provided with the distribution.
17607ca46eSDavid Howells * 3. Neither the names of the copyright holders nor the names of its
18607ca46eSDavid Howells * contributors may be used to endorse or promote products derived from
19607ca46eSDavid Howells * this software without specific prior written permission.
20607ca46eSDavid Howells *
21607ca46eSDavid Howells * Alternatively, this software may be distributed under the terms of the
22607ca46eSDavid Howells * GNU General Public License ("GPL") version 2 as published by the Free
23607ca46eSDavid Howells * Software Foundation.
24607ca46eSDavid Howells *
25607ca46eSDavid Howells * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
26607ca46eSDavid Howells * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27607ca46eSDavid Howells * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28607ca46eSDavid Howells * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
29607ca46eSDavid Howells * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30607ca46eSDavid Howells * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31607ca46eSDavid Howells * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32607ca46eSDavid Howells * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33607ca46eSDavid Howells * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34607ca46eSDavid Howells * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35607ca46eSDavid Howells * POSSIBILITY OF SUCH DAMAGE.
36607ca46eSDavid Howells */
37607ca46eSDavid Howells
38607ca46eSDavid Howells #ifndef _LINUX_TIPC_H_
39607ca46eSDavid Howells #define _LINUX_TIPC_H_
40607ca46eSDavid Howells
41607ca46eSDavid Howells #include <linux/types.h>
4278acb1f9SErik Hugne #include <linux/sockios.h>
43607ca46eSDavid Howells
44607ca46eSDavid Howells /*
45607ca46eSDavid Howells * TIPC addressing primitives
46607ca46eSDavid Howells */
47607ca46eSDavid Howells
487a74d39cSJon Maloy struct tipc_socket_addr {
49607ca46eSDavid Howells __u32 ref;
50607ca46eSDavid Howells __u32 node;
51607ca46eSDavid Howells };
52607ca46eSDavid Howells
537a74d39cSJon Maloy struct tipc_service_addr {
54607ca46eSDavid Howells __u32 type;
55607ca46eSDavid Howells __u32 instance;
56607ca46eSDavid Howells };
57607ca46eSDavid Howells
587a74d39cSJon Maloy struct tipc_service_range {
59607ca46eSDavid Howells __u32 type;
60607ca46eSDavid Howells __u32 lower;
61607ca46eSDavid Howells __u32 upper;
62607ca46eSDavid Howells };
63607ca46eSDavid Howells
64607ca46eSDavid Howells /*
657a74d39cSJon Maloy * Application-accessible service types
66607ca46eSDavid Howells */
67607ca46eSDavid Howells
687a74d39cSJon Maloy #define TIPC_NODE_STATE 0 /* node state service type */
697a74d39cSJon Maloy #define TIPC_TOP_SRV 1 /* topology server service type */
707a74d39cSJon Maloy #define TIPC_LINK_STATE 2 /* link state service type */
717a74d39cSJon Maloy #define TIPC_RESERVED_TYPES 64 /* lowest user-allowed service type */
72607ca46eSDavid Howells
73607ca46eSDavid Howells /*
747a74d39cSJon Maloy * Publication scopes when binding service / service range
75607ca46eSDavid Howells */
76928df188SJon Maloy enum tipc_scope {
77928df188SJon Maloy TIPC_CLUSTER_SCOPE = 2, /* 0 can also be used */
78928df188SJon Maloy TIPC_NODE_SCOPE = 3
79928df188SJon Maloy };
80607ca46eSDavid Howells
81607ca46eSDavid Howells /*
82607ca46eSDavid Howells * Limiting values for messages
83607ca46eSDavid Howells */
84607ca46eSDavid Howells
85607ca46eSDavid Howells #define TIPC_MAX_USER_MSG_SIZE 66000U
86607ca46eSDavid Howells
87607ca46eSDavid Howells /*
88607ca46eSDavid Howells * Message importance levels
89607ca46eSDavid Howells */
90607ca46eSDavid Howells
91607ca46eSDavid Howells #define TIPC_LOW_IMPORTANCE 0
92607ca46eSDavid Howells #define TIPC_MEDIUM_IMPORTANCE 1
93607ca46eSDavid Howells #define TIPC_HIGH_IMPORTANCE 2
94607ca46eSDavid Howells #define TIPC_CRITICAL_IMPORTANCE 3
95607ca46eSDavid Howells
96607ca46eSDavid Howells /*
97607ca46eSDavid Howells * Msg rejection/connection shutdown reasons
98607ca46eSDavid Howells */
99607ca46eSDavid Howells
100607ca46eSDavid Howells #define TIPC_OK 0
101607ca46eSDavid Howells #define TIPC_ERR_NO_NAME 1
102607ca46eSDavid Howells #define TIPC_ERR_NO_PORT 2
103607ca46eSDavid Howells #define TIPC_ERR_NO_NODE 3
104607ca46eSDavid Howells #define TIPC_ERR_OVERLOAD 4
105607ca46eSDavid Howells #define TIPC_CONN_SHUTDOWN 5
106607ca46eSDavid Howells
107607ca46eSDavid Howells /*
108607ca46eSDavid Howells * TIPC topology subscription service definitions
109607ca46eSDavid Howells */
110607ca46eSDavid Howells
1117a74d39cSJon Maloy #define TIPC_SUB_PORTS 0x01 /* filter: evt at each match */
1127a74d39cSJon Maloy #define TIPC_SUB_SERVICE 0x02 /* filter: evt at first up/last down */
1137a74d39cSJon Maloy #define TIPC_SUB_CANCEL 0x04 /* filter: cancel a subscription */
114607ca46eSDavid Howells
115607ca46eSDavid Howells #define TIPC_WAIT_FOREVER (~0) /* timeout for permanent subscription */
116607ca46eSDavid Howells
117607ca46eSDavid Howells struct tipc_subscr {
1187a74d39cSJon Maloy struct tipc_service_range seq; /* range of interest */
119607ca46eSDavid Howells __u32 timeout; /* subscription duration (in ms) */
120607ca46eSDavid Howells __u32 filter; /* bitmask of filter options */
121607ca46eSDavid Howells char usr_handle[8]; /* available for subscriber use */
122607ca46eSDavid Howells };
123607ca46eSDavid Howells
124607ca46eSDavid Howells #define TIPC_PUBLISHED 1 /* publication event */
1257a74d39cSJon Maloy #define TIPC_WITHDRAWN 2 /* withdrawal event */
126607ca46eSDavid Howells #define TIPC_SUBSCR_TIMEOUT 3 /* subscription timeout event */
127607ca46eSDavid Howells
128607ca46eSDavid Howells struct tipc_event {
129607ca46eSDavid Howells __u32 event; /* event type */
1307a74d39cSJon Maloy __u32 found_lower; /* matching range */
1317a74d39cSJon Maloy __u32 found_upper; /* " " */
1327a74d39cSJon Maloy struct tipc_socket_addr port; /* associated socket */
133607ca46eSDavid Howells struct tipc_subscr s; /* associated subscription */
134607ca46eSDavid Howells };
135607ca46eSDavid Howells
136607ca46eSDavid Howells /*
137607ca46eSDavid Howells * Socket API
138607ca46eSDavid Howells */
139607ca46eSDavid Howells
140607ca46eSDavid Howells #ifndef AF_TIPC
141607ca46eSDavid Howells #define AF_TIPC 30
142607ca46eSDavid Howells #endif
143607ca46eSDavid Howells
144607ca46eSDavid Howells #ifndef PF_TIPC
145607ca46eSDavid Howells #define PF_TIPC AF_TIPC
146607ca46eSDavid Howells #endif
147607ca46eSDavid Howells
148607ca46eSDavid Howells #ifndef SOL_TIPC
149607ca46eSDavid Howells #define SOL_TIPC 271
150607ca46eSDavid Howells #endif
151607ca46eSDavid Howells
152607ca46eSDavid Howells #define TIPC_ADDR_MCAST 1
1537a74d39cSJon Maloy #define TIPC_SERVICE_RANGE 1
1547a74d39cSJon Maloy #define TIPC_SERVICE_ADDR 2
1557a74d39cSJon Maloy #define TIPC_SOCKET_ADDR 3
156607ca46eSDavid Howells
157607ca46eSDavid Howells struct sockaddr_tipc {
158607ca46eSDavid Howells unsigned short family;
159607ca46eSDavid Howells unsigned char addrtype;
160607ca46eSDavid Howells signed char scope;
161607ca46eSDavid Howells union {
1627a74d39cSJon Maloy struct tipc_socket_addr id;
1637a74d39cSJon Maloy struct tipc_service_range nameseq;
164607ca46eSDavid Howells struct {
1657a74d39cSJon Maloy struct tipc_service_addr name;
166607ca46eSDavid Howells __u32 domain;
167607ca46eSDavid Howells } name;
168607ca46eSDavid Howells } addr;
169607ca46eSDavid Howells };
170607ca46eSDavid Howells
171607ca46eSDavid Howells /*
172607ca46eSDavid Howells * Ancillary data objects supported by recvmsg()
173607ca46eSDavid Howells */
174607ca46eSDavid Howells
175607ca46eSDavid Howells #define TIPC_ERRINFO 1 /* error info */
176607ca46eSDavid Howells #define TIPC_RETDATA 2 /* returned data */
177607ca46eSDavid Howells #define TIPC_DESTNAME 3 /* destination name */
178607ca46eSDavid Howells
179607ca46eSDavid Howells /*
18001fd12bbSJon Paul Maloy * TIPC-specific socket option names
181607ca46eSDavid Howells */
182607ca46eSDavid Howells
183607ca46eSDavid Howells #define TIPC_IMPORTANCE 127 /* Default: TIPC_LOW_IMPORTANCE */
184607ca46eSDavid Howells #define TIPC_SRC_DROPPABLE 128 /* Default: based on socket type */
185607ca46eSDavid Howells #define TIPC_DEST_DROPPABLE 129 /* Default: based on socket type */
186607ca46eSDavid Howells #define TIPC_CONN_TIMEOUT 130 /* Default: 8000 (ms) */
187607ca46eSDavid Howells #define TIPC_NODE_RECVQ_DEPTH 131 /* Default: none (read only) */
188607ca46eSDavid Howells #define TIPC_SOCK_RECVQ_DEPTH 132 /* Default: none (read only) */
18901fd12bbSJon Paul Maloy #define TIPC_MCAST_BROADCAST 133 /* Default: TIPC selects. No arg */
19001fd12bbSJon Paul Maloy #define TIPC_MCAST_REPLICAST 134 /* Default: TIPC selects. No arg */
19175da2163SJon Maloy #define TIPC_GROUP_JOIN 135 /* Takes struct tipc_group_req* */
19275da2163SJon Maloy #define TIPC_GROUP_LEAVE 136 /* No argument */
19342e5425aSTung Nguyen #define TIPC_SOCK_RECVQ_USED 137 /* Default: none (read only) */
194c0bceb97SJon Maloy #define TIPC_NODELAY 138 /* Default: false */
19575da2163SJon Maloy
19675da2163SJon Maloy /*
19775da2163SJon Maloy * Flag values
19875da2163SJon Maloy */
19975da2163SJon Maloy #define TIPC_GROUP_LOOPBACK 0x1 /* Receive copy of sent msg when match */
200ae236fb2SJon Maloy #define TIPC_GROUP_MEMBER_EVTS 0x2 /* Receive membership events in socket */
20175da2163SJon Maloy
20275da2163SJon Maloy struct tipc_group_req {
20375da2163SJon Maloy __u32 type; /* group id */
20475da2163SJon Maloy __u32 instance; /* member id */
205928df188SJon Maloy __u32 scope; /* cluster/node */
20675da2163SJon Maloy __u32 flags;
20775da2163SJon Maloy };
208607ca46eSDavid Howells
20978acb1f9SErik Hugne /*
21078acb1f9SErik Hugne * Maximum sizes of TIPC bearer-related names (including terminating NULL)
21178acb1f9SErik Hugne * The string formatting for each name element is:
21278acb1f9SErik Hugne * media: media
21378acb1f9SErik Hugne * interface: media:interface name
2143e5cf362SJon Maloy * link: node:interface-node:interface
21578acb1f9SErik Hugne */
2163e5cf362SJon Maloy #define TIPC_NODEID_LEN 16
21778acb1f9SErik Hugne #define TIPC_MAX_MEDIA_NAME 16
21878acb1f9SErik Hugne #define TIPC_MAX_IF_NAME 16
21978acb1f9SErik Hugne #define TIPC_MAX_BEARER_NAME 32
2207494cfa6SJon Maloy #define TIPC_MAX_LINK_NAME 68
22178acb1f9SErik Hugne
22278acb1f9SErik Hugne #define SIOCGETLINKNAME SIOCPROTOPRIVATE
2233e5cf362SJon Maloy #define SIOCGETNODEID (SIOCPROTOPRIVATE + 1)
22478acb1f9SErik Hugne
22578acb1f9SErik Hugne struct tipc_sioc_ln_req {
22678acb1f9SErik Hugne __u32 peer;
22778acb1f9SErik Hugne __u32 bearer_id;
22878acb1f9SErik Hugne char linkname[TIPC_MAX_LINK_NAME];
22978acb1f9SErik Hugne };
230928df188SJon Maloy
2313e5cf362SJon Maloy struct tipc_sioc_nodeid_req {
2323e5cf362SJon Maloy __u32 peer;
2333e5cf362SJon Maloy char node_id[TIPC_NODEID_LEN];
2343e5cf362SJon Maloy };
235928df188SJon Maloy
236134bdac3STuong Lien /*
237134bdac3STuong Lien * TIPC Crypto, AEAD
238134bdac3STuong Lien */
239134bdac3STuong Lien #define TIPC_AEAD_ALG_NAME (32)
240134bdac3STuong Lien
241134bdac3STuong Lien struct tipc_aead_key {
242134bdac3STuong Lien char alg_name[TIPC_AEAD_ALG_NAME];
243134bdac3STuong Lien unsigned int keylen; /* in bytes */
244134bdac3STuong Lien char key[];
245134bdac3STuong Lien };
246134bdac3STuong Lien
247134bdac3STuong Lien #define TIPC_AEAD_KEYLEN_MIN (16 + 4)
248134bdac3STuong Lien #define TIPC_AEAD_KEYLEN_MAX (32 + 4)
249134bdac3STuong Lien #define TIPC_AEAD_KEY_SIZE_MAX (sizeof(struct tipc_aead_key) + \
250134bdac3STuong Lien TIPC_AEAD_KEYLEN_MAX)
251134bdac3STuong Lien
tipc_aead_key_size(struct tipc_aead_key * key)252134bdac3STuong Lien static inline int tipc_aead_key_size(struct tipc_aead_key *key)
253134bdac3STuong Lien {
254134bdac3STuong Lien return sizeof(*key) + key->keylen;
255134bdac3STuong Lien }
256134bdac3STuong Lien
257*23700da2STuong Lien #define TIPC_REKEYING_NOW (~0U)
258*23700da2STuong Lien
259928df188SJon Maloy /* The macros and functions below are deprecated:
260928df188SJon Maloy */
261928df188SJon Maloy
2627a74d39cSJon Maloy #define TIPC_CFG_SRV 0
263928df188SJon Maloy #define TIPC_ZONE_SCOPE 1
264928df188SJon Maloy
2657a74d39cSJon Maloy #define TIPC_ADDR_NAMESEQ 1
2667a74d39cSJon Maloy #define TIPC_ADDR_NAME 2
2677a74d39cSJon Maloy #define TIPC_ADDR_ID 3
2687a74d39cSJon Maloy
269928df188SJon Maloy #define TIPC_NODE_BITS 12
270928df188SJon Maloy #define TIPC_CLUSTER_BITS 12
271928df188SJon Maloy #define TIPC_ZONE_BITS 8
272928df188SJon Maloy
273928df188SJon Maloy #define TIPC_NODE_OFFSET 0
274928df188SJon Maloy #define TIPC_CLUSTER_OFFSET TIPC_NODE_BITS
275928df188SJon Maloy #define TIPC_ZONE_OFFSET (TIPC_CLUSTER_OFFSET + TIPC_CLUSTER_BITS)
276928df188SJon Maloy
277928df188SJon Maloy #define TIPC_NODE_SIZE ((1UL << TIPC_NODE_BITS) - 1)
278928df188SJon Maloy #define TIPC_CLUSTER_SIZE ((1UL << TIPC_CLUSTER_BITS) - 1)
279928df188SJon Maloy #define TIPC_ZONE_SIZE ((1UL << TIPC_ZONE_BITS) - 1)
280928df188SJon Maloy
281928df188SJon Maloy #define TIPC_NODE_MASK (TIPC_NODE_SIZE << TIPC_NODE_OFFSET)
282928df188SJon Maloy #define TIPC_CLUSTER_MASK (TIPC_CLUSTER_SIZE << TIPC_CLUSTER_OFFSET)
283928df188SJon Maloy #define TIPC_ZONE_MASK (TIPC_ZONE_SIZE << TIPC_ZONE_OFFSET)
284928df188SJon Maloy
285928df188SJon Maloy #define TIPC_ZONE_CLUSTER_MASK (TIPC_ZONE_MASK | TIPC_CLUSTER_MASK)
286928df188SJon Maloy
2877a74d39cSJon Maloy #define tipc_portid tipc_socket_addr
2887a74d39cSJon Maloy #define tipc_name tipc_service_addr
2897a74d39cSJon Maloy #define tipc_name_seq tipc_service_range
2907a74d39cSJon Maloy
tipc_addr(unsigned int zone,unsigned int cluster,unsigned int node)291928df188SJon Maloy static inline __u32 tipc_addr(unsigned int zone,
292928df188SJon Maloy unsigned int cluster,
293928df188SJon Maloy unsigned int node)
294928df188SJon Maloy {
295928df188SJon Maloy return (zone << TIPC_ZONE_OFFSET) |
296928df188SJon Maloy (cluster << TIPC_CLUSTER_OFFSET) |
297928df188SJon Maloy node;
298928df188SJon Maloy }
299928df188SJon Maloy
tipc_zone(__u32 addr)300928df188SJon Maloy static inline unsigned int tipc_zone(__u32 addr)
301928df188SJon Maloy {
302928df188SJon Maloy return addr >> TIPC_ZONE_OFFSET;
303928df188SJon Maloy }
304928df188SJon Maloy
tipc_cluster(__u32 addr)305928df188SJon Maloy static inline unsigned int tipc_cluster(__u32 addr)
306928df188SJon Maloy {
307928df188SJon Maloy return (addr & TIPC_CLUSTER_MASK) >> TIPC_CLUSTER_OFFSET;
308928df188SJon Maloy }
309928df188SJon Maloy
tipc_node(__u32 addr)310928df188SJon Maloy static inline unsigned int tipc_node(__u32 addr)
311928df188SJon Maloy {
312928df188SJon Maloy return addr & TIPC_NODE_MASK;
313928df188SJon Maloy }
314928df188SJon Maloy
315607ca46eSDavid Howells #endif
316