1607ca46eSDavid Howells /* 28941bbcdSYing Xue * include/uapi/linux/tipc.h: Header for TIPC socket interface 3607ca46eSDavid Howells * 4*01fd12bbSJon Paul Maloy * Copyright (c) 2003-2006, 2015-2016 Ericsson AB 5607ca46eSDavid Howells * Copyright (c) 2005, 2010-2011, Wind River Systems 6607ca46eSDavid Howells * All rights reserved. 7607ca46eSDavid Howells * 8607ca46eSDavid Howells * Redistribution and use in source and binary forms, with or without 9607ca46eSDavid Howells * modification, are permitted provided that the following conditions are met: 10607ca46eSDavid Howells * 11607ca46eSDavid Howells * 1. Redistributions of source code must retain the above copyright 12607ca46eSDavid Howells * notice, this list of conditions and the following disclaimer. 13607ca46eSDavid Howells * 2. Redistributions in binary form must reproduce the above copyright 14607ca46eSDavid Howells * notice, this list of conditions and the following disclaimer in the 15607ca46eSDavid Howells * documentation and/or other materials provided with the distribution. 16607ca46eSDavid Howells * 3. Neither the names of the copyright holders nor the names of its 17607ca46eSDavid Howells * contributors may be used to endorse or promote products derived from 18607ca46eSDavid Howells * this software without specific prior written permission. 19607ca46eSDavid Howells * 20607ca46eSDavid Howells * Alternatively, this software may be distributed under the terms of the 21607ca46eSDavid Howells * GNU General Public License ("GPL") version 2 as published by the Free 22607ca46eSDavid Howells * Software Foundation. 23607ca46eSDavid Howells * 24607ca46eSDavid Howells * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 25607ca46eSDavid Howells * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26607ca46eSDavid Howells * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27607ca46eSDavid Howells * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 28607ca46eSDavid Howells * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 29607ca46eSDavid Howells * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 30607ca46eSDavid Howells * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 31607ca46eSDavid Howells * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 32607ca46eSDavid Howells * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 33607ca46eSDavid Howells * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 34607ca46eSDavid Howells * POSSIBILITY OF SUCH DAMAGE. 35607ca46eSDavid Howells */ 36607ca46eSDavid Howells 37607ca46eSDavid Howells #ifndef _LINUX_TIPC_H_ 38607ca46eSDavid Howells #define _LINUX_TIPC_H_ 39607ca46eSDavid Howells 40607ca46eSDavid Howells #include <linux/types.h> 4178acb1f9SErik Hugne #include <linux/sockios.h> 42607ca46eSDavid Howells 43607ca46eSDavid Howells /* 44607ca46eSDavid Howells * TIPC addressing primitives 45607ca46eSDavid Howells */ 46607ca46eSDavid Howells 47607ca46eSDavid Howells struct tipc_portid { 48607ca46eSDavid Howells __u32 ref; 49607ca46eSDavid Howells __u32 node; 50607ca46eSDavid Howells }; 51607ca46eSDavid Howells 52607ca46eSDavid Howells struct tipc_name { 53607ca46eSDavid Howells __u32 type; 54607ca46eSDavid Howells __u32 instance; 55607ca46eSDavid Howells }; 56607ca46eSDavid Howells 57607ca46eSDavid Howells struct tipc_name_seq { 58607ca46eSDavid Howells __u32 type; 59607ca46eSDavid Howells __u32 lower; 60607ca46eSDavid Howells __u32 upper; 61607ca46eSDavid Howells }; 62607ca46eSDavid Howells 639ff26e9fSParthasarathy Bhuvaragan /* TIPC Address Size, Offset, Mask specification for Z.C.N 649ff26e9fSParthasarathy Bhuvaragan */ 659ff26e9fSParthasarathy Bhuvaragan #define TIPC_NODE_BITS 12 669ff26e9fSParthasarathy Bhuvaragan #define TIPC_CLUSTER_BITS 12 679ff26e9fSParthasarathy Bhuvaragan #define TIPC_ZONE_BITS 8 689ff26e9fSParthasarathy Bhuvaragan 699ff26e9fSParthasarathy Bhuvaragan #define TIPC_NODE_OFFSET 0 709ff26e9fSParthasarathy Bhuvaragan #define TIPC_CLUSTER_OFFSET TIPC_NODE_BITS 719ff26e9fSParthasarathy Bhuvaragan #define TIPC_ZONE_OFFSET (TIPC_CLUSTER_OFFSET + TIPC_CLUSTER_BITS) 729ff26e9fSParthasarathy Bhuvaragan 739ff26e9fSParthasarathy Bhuvaragan #define TIPC_NODE_SIZE ((1UL << TIPC_NODE_BITS) - 1) 749ff26e9fSParthasarathy Bhuvaragan #define TIPC_CLUSTER_SIZE ((1UL << TIPC_CLUSTER_BITS) - 1) 759ff26e9fSParthasarathy Bhuvaragan #define TIPC_ZONE_SIZE ((1UL << TIPC_ZONE_BITS) - 1) 769ff26e9fSParthasarathy Bhuvaragan 779ff26e9fSParthasarathy Bhuvaragan #define TIPC_NODE_MASK (TIPC_NODE_SIZE << TIPC_NODE_OFFSET) 789ff26e9fSParthasarathy Bhuvaragan #define TIPC_CLUSTER_MASK (TIPC_CLUSTER_SIZE << TIPC_CLUSTER_OFFSET) 799ff26e9fSParthasarathy Bhuvaragan #define TIPC_ZONE_MASK (TIPC_ZONE_SIZE << TIPC_ZONE_OFFSET) 809ff26e9fSParthasarathy Bhuvaragan 819ff26e9fSParthasarathy Bhuvaragan #define TIPC_ZONE_CLUSTER_MASK (TIPC_ZONE_MASK | TIPC_CLUSTER_MASK) 829ff26e9fSParthasarathy Bhuvaragan 83607ca46eSDavid Howells static inline __u32 tipc_addr(unsigned int zone, 84607ca46eSDavid Howells unsigned int cluster, 85607ca46eSDavid Howells unsigned int node) 86607ca46eSDavid Howells { 879ff26e9fSParthasarathy Bhuvaragan return (zone << TIPC_ZONE_OFFSET) | 889ff26e9fSParthasarathy Bhuvaragan (cluster << TIPC_CLUSTER_OFFSET) | 899ff26e9fSParthasarathy Bhuvaragan node; 90607ca46eSDavid Howells } 91607ca46eSDavid Howells 92607ca46eSDavid Howells static inline unsigned int tipc_zone(__u32 addr) 93607ca46eSDavid Howells { 949ff26e9fSParthasarathy Bhuvaragan return addr >> TIPC_ZONE_OFFSET; 95607ca46eSDavid Howells } 96607ca46eSDavid Howells 97607ca46eSDavid Howells static inline unsigned int tipc_cluster(__u32 addr) 98607ca46eSDavid Howells { 999ff26e9fSParthasarathy Bhuvaragan return (addr & TIPC_CLUSTER_MASK) >> TIPC_CLUSTER_OFFSET; 100607ca46eSDavid Howells } 101607ca46eSDavid Howells 102607ca46eSDavid Howells static inline unsigned int tipc_node(__u32 addr) 103607ca46eSDavid Howells { 1049ff26e9fSParthasarathy Bhuvaragan return addr & TIPC_NODE_MASK; 105607ca46eSDavid Howells } 106607ca46eSDavid Howells 107607ca46eSDavid Howells /* 108607ca46eSDavid Howells * Application-accessible port name types 109607ca46eSDavid Howells */ 110607ca46eSDavid Howells 111607ca46eSDavid Howells #define TIPC_CFG_SRV 0 /* configuration service name type */ 112607ca46eSDavid Howells #define TIPC_TOP_SRV 1 /* topology service name type */ 113a89778d8SErik Hugne #define TIPC_LINK_STATE 2 /* link state name type */ 114607ca46eSDavid Howells #define TIPC_RESERVED_TYPES 64 /* lowest user-publishable name type */ 115607ca46eSDavid Howells 116607ca46eSDavid Howells /* 117607ca46eSDavid Howells * Publication scopes when binding port names and port name sequences 118607ca46eSDavid Howells */ 119607ca46eSDavid Howells 120607ca46eSDavid Howells #define TIPC_ZONE_SCOPE 1 121607ca46eSDavid Howells #define TIPC_CLUSTER_SCOPE 2 122607ca46eSDavid Howells #define TIPC_NODE_SCOPE 3 123607ca46eSDavid Howells 124607ca46eSDavid Howells /* 125607ca46eSDavid Howells * Limiting values for messages 126607ca46eSDavid Howells */ 127607ca46eSDavid Howells 128607ca46eSDavid Howells #define TIPC_MAX_USER_MSG_SIZE 66000U 129607ca46eSDavid Howells 130607ca46eSDavid Howells /* 131607ca46eSDavid Howells * Message importance levels 132607ca46eSDavid Howells */ 133607ca46eSDavid Howells 134607ca46eSDavid Howells #define TIPC_LOW_IMPORTANCE 0 135607ca46eSDavid Howells #define TIPC_MEDIUM_IMPORTANCE 1 136607ca46eSDavid Howells #define TIPC_HIGH_IMPORTANCE 2 137607ca46eSDavid Howells #define TIPC_CRITICAL_IMPORTANCE 3 138607ca46eSDavid Howells 139607ca46eSDavid Howells /* 140607ca46eSDavid Howells * Msg rejection/connection shutdown reasons 141607ca46eSDavid Howells */ 142607ca46eSDavid Howells 143607ca46eSDavid Howells #define TIPC_OK 0 144607ca46eSDavid Howells #define TIPC_ERR_NO_NAME 1 145607ca46eSDavid Howells #define TIPC_ERR_NO_PORT 2 146607ca46eSDavid Howells #define TIPC_ERR_NO_NODE 3 147607ca46eSDavid Howells #define TIPC_ERR_OVERLOAD 4 148607ca46eSDavid Howells #define TIPC_CONN_SHUTDOWN 5 149607ca46eSDavid Howells 150607ca46eSDavid Howells /* 151607ca46eSDavid Howells * TIPC topology subscription service definitions 152607ca46eSDavid Howells */ 153607ca46eSDavid Howells 154607ca46eSDavid Howells #define TIPC_SUB_PORTS 0x01 /* filter for port availability */ 155607ca46eSDavid Howells #define TIPC_SUB_SERVICE 0x02 /* filter for service availability */ 156607ca46eSDavid Howells #define TIPC_SUB_CANCEL 0x04 /* cancel a subscription */ 157607ca46eSDavid Howells 158607ca46eSDavid Howells #define TIPC_WAIT_FOREVER (~0) /* timeout for permanent subscription */ 159607ca46eSDavid Howells 160607ca46eSDavid Howells struct tipc_subscr { 161607ca46eSDavid Howells struct tipc_name_seq seq; /* name sequence of interest */ 162607ca46eSDavid Howells __u32 timeout; /* subscription duration (in ms) */ 163607ca46eSDavid Howells __u32 filter; /* bitmask of filter options */ 164607ca46eSDavid Howells char usr_handle[8]; /* available for subscriber use */ 165607ca46eSDavid Howells }; 166607ca46eSDavid Howells 167607ca46eSDavid Howells #define TIPC_PUBLISHED 1 /* publication event */ 168607ca46eSDavid Howells #define TIPC_WITHDRAWN 2 /* withdraw event */ 169607ca46eSDavid Howells #define TIPC_SUBSCR_TIMEOUT 3 /* subscription timeout event */ 170607ca46eSDavid Howells 171607ca46eSDavid Howells struct tipc_event { 172607ca46eSDavid Howells __u32 event; /* event type */ 173607ca46eSDavid Howells __u32 found_lower; /* matching name seq instances */ 174607ca46eSDavid Howells __u32 found_upper; /* " " " " */ 175607ca46eSDavid Howells struct tipc_portid port; /* associated port */ 176607ca46eSDavid Howells struct tipc_subscr s; /* associated subscription */ 177607ca46eSDavid Howells }; 178607ca46eSDavid Howells 179607ca46eSDavid Howells /* 180607ca46eSDavid Howells * Socket API 181607ca46eSDavid Howells */ 182607ca46eSDavid Howells 183607ca46eSDavid Howells #ifndef AF_TIPC 184607ca46eSDavid Howells #define AF_TIPC 30 185607ca46eSDavid Howells #endif 186607ca46eSDavid Howells 187607ca46eSDavid Howells #ifndef PF_TIPC 188607ca46eSDavid Howells #define PF_TIPC AF_TIPC 189607ca46eSDavid Howells #endif 190607ca46eSDavid Howells 191607ca46eSDavid Howells #ifndef SOL_TIPC 192607ca46eSDavid Howells #define SOL_TIPC 271 193607ca46eSDavid Howells #endif 194607ca46eSDavid Howells 195607ca46eSDavid Howells #define TIPC_ADDR_NAMESEQ 1 196607ca46eSDavid Howells #define TIPC_ADDR_MCAST 1 197607ca46eSDavid Howells #define TIPC_ADDR_NAME 2 198607ca46eSDavid Howells #define TIPC_ADDR_ID 3 199607ca46eSDavid Howells 200607ca46eSDavid Howells struct sockaddr_tipc { 201607ca46eSDavid Howells unsigned short family; 202607ca46eSDavid Howells unsigned char addrtype; 203607ca46eSDavid Howells signed char scope; 204607ca46eSDavid Howells union { 205607ca46eSDavid Howells struct tipc_portid id; 206607ca46eSDavid Howells struct tipc_name_seq nameseq; 207607ca46eSDavid Howells struct { 208607ca46eSDavid Howells struct tipc_name name; 209607ca46eSDavid Howells __u32 domain; 210607ca46eSDavid Howells } name; 211607ca46eSDavid Howells } addr; 212607ca46eSDavid Howells }; 213607ca46eSDavid Howells 214607ca46eSDavid Howells /* 215607ca46eSDavid Howells * Ancillary data objects supported by recvmsg() 216607ca46eSDavid Howells */ 217607ca46eSDavid Howells 218607ca46eSDavid Howells #define TIPC_ERRINFO 1 /* error info */ 219607ca46eSDavid Howells #define TIPC_RETDATA 2 /* returned data */ 220607ca46eSDavid Howells #define TIPC_DESTNAME 3 /* destination name */ 221607ca46eSDavid Howells 222607ca46eSDavid Howells /* 223*01fd12bbSJon Paul Maloy * TIPC-specific socket option names 224607ca46eSDavid Howells */ 225607ca46eSDavid Howells 226607ca46eSDavid Howells #define TIPC_IMPORTANCE 127 /* Default: TIPC_LOW_IMPORTANCE */ 227607ca46eSDavid Howells #define TIPC_SRC_DROPPABLE 128 /* Default: based on socket type */ 228607ca46eSDavid Howells #define TIPC_DEST_DROPPABLE 129 /* Default: based on socket type */ 229607ca46eSDavid Howells #define TIPC_CONN_TIMEOUT 130 /* Default: 8000 (ms) */ 230607ca46eSDavid Howells #define TIPC_NODE_RECVQ_DEPTH 131 /* Default: none (read only) */ 231607ca46eSDavid Howells #define TIPC_SOCK_RECVQ_DEPTH 132 /* Default: none (read only) */ 232*01fd12bbSJon Paul Maloy #define TIPC_MCAST_BROADCAST 133 /* Default: TIPC selects. No arg */ 233*01fd12bbSJon Paul Maloy #define TIPC_MCAST_REPLICAST 134 /* Default: TIPC selects. No arg */ 234607ca46eSDavid Howells 23578acb1f9SErik Hugne /* 23678acb1f9SErik Hugne * Maximum sizes of TIPC bearer-related names (including terminating NULL) 23778acb1f9SErik Hugne * The string formatting for each name element is: 23878acb1f9SErik Hugne * media: media 23978acb1f9SErik Hugne * interface: media:interface name 24078acb1f9SErik Hugne * link: Z.C.N:interface-Z.C.N:interface 24178acb1f9SErik Hugne * 24278acb1f9SErik Hugne */ 24378acb1f9SErik Hugne 24478acb1f9SErik Hugne #define TIPC_MAX_MEDIA_NAME 16 24578acb1f9SErik Hugne #define TIPC_MAX_IF_NAME 16 24678acb1f9SErik Hugne #define TIPC_MAX_BEARER_NAME 32 24778acb1f9SErik Hugne #define TIPC_MAX_LINK_NAME 60 24878acb1f9SErik Hugne 24978acb1f9SErik Hugne #define SIOCGETLINKNAME SIOCPROTOPRIVATE 25078acb1f9SErik Hugne 25178acb1f9SErik Hugne struct tipc_sioc_ln_req { 25278acb1f9SErik Hugne __u32 peer; 25378acb1f9SErik Hugne __u32 bearer_id; 25478acb1f9SErik Hugne char linkname[TIPC_MAX_LINK_NAME]; 25578acb1f9SErik Hugne }; 256607ca46eSDavid Howells #endif 257