1 /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */ 2 #ifndef _UAPI_MPTCP_H 3 #define _UAPI_MPTCP_H 4 5 #include <linux/const.h> 6 #include <linux/types.h> 7 #include <linux/in.h> /* for sockaddr_in */ 8 #include <linux/in6.h> /* for sockaddr_in6 */ 9 #include <linux/socket.h> /* for sockaddr_storage and sa_family */ 10 11 #ifndef __KERNEL__ 12 #include <sys/socket.h> /* for struct sockaddr */ 13 #endif 14 15 #define MPTCP_SUBFLOW_FLAG_MCAP_REM _BITUL(0) 16 #define MPTCP_SUBFLOW_FLAG_MCAP_LOC _BITUL(1) 17 #define MPTCP_SUBFLOW_FLAG_JOIN_REM _BITUL(2) 18 #define MPTCP_SUBFLOW_FLAG_JOIN_LOC _BITUL(3) 19 #define MPTCP_SUBFLOW_FLAG_BKUP_REM _BITUL(4) 20 #define MPTCP_SUBFLOW_FLAG_BKUP_LOC _BITUL(5) 21 #define MPTCP_SUBFLOW_FLAG_FULLY_ESTABLISHED _BITUL(6) 22 #define MPTCP_SUBFLOW_FLAG_CONNECTED _BITUL(7) 23 #define MPTCP_SUBFLOW_FLAG_MAPVALID _BITUL(8) 24 25 enum { 26 MPTCP_SUBFLOW_ATTR_UNSPEC, 27 MPTCP_SUBFLOW_ATTR_TOKEN_REM, 28 MPTCP_SUBFLOW_ATTR_TOKEN_LOC, 29 MPTCP_SUBFLOW_ATTR_RELWRITE_SEQ, 30 MPTCP_SUBFLOW_ATTR_MAP_SEQ, 31 MPTCP_SUBFLOW_ATTR_MAP_SFSEQ, 32 MPTCP_SUBFLOW_ATTR_SSN_OFFSET, 33 MPTCP_SUBFLOW_ATTR_MAP_DATALEN, 34 MPTCP_SUBFLOW_ATTR_FLAGS, 35 MPTCP_SUBFLOW_ATTR_ID_REM, 36 MPTCP_SUBFLOW_ATTR_ID_LOC, 37 MPTCP_SUBFLOW_ATTR_PAD, 38 __MPTCP_SUBFLOW_ATTR_MAX 39 }; 40 41 #define MPTCP_SUBFLOW_ATTR_MAX (__MPTCP_SUBFLOW_ATTR_MAX - 1) 42 43 /* netlink interface */ 44 #define MPTCP_PM_NAME "mptcp_pm" 45 #define MPTCP_PM_CMD_GRP_NAME "mptcp_pm_cmds" 46 #define MPTCP_PM_EV_GRP_NAME "mptcp_pm_events" 47 #define MPTCP_PM_VER 0x1 48 49 /* 50 * ATTR types defined for MPTCP 51 */ 52 enum { 53 MPTCP_PM_ATTR_UNSPEC, 54 55 MPTCP_PM_ATTR_ADDR, /* nested address */ 56 MPTCP_PM_ATTR_RCV_ADD_ADDRS, /* u32 */ 57 MPTCP_PM_ATTR_SUBFLOWS, /* u32 */ 58 59 __MPTCP_PM_ATTR_MAX 60 }; 61 62 #define MPTCP_PM_ATTR_MAX (__MPTCP_PM_ATTR_MAX - 1) 63 64 enum { 65 MPTCP_PM_ADDR_ATTR_UNSPEC, 66 67 MPTCP_PM_ADDR_ATTR_FAMILY, /* u16 */ 68 MPTCP_PM_ADDR_ATTR_ID, /* u8 */ 69 MPTCP_PM_ADDR_ATTR_ADDR4, /* struct in_addr */ 70 MPTCP_PM_ADDR_ATTR_ADDR6, /* struct in6_addr */ 71 MPTCP_PM_ADDR_ATTR_PORT, /* u16 */ 72 MPTCP_PM_ADDR_ATTR_FLAGS, /* u32 */ 73 MPTCP_PM_ADDR_ATTR_IF_IDX, /* s32 */ 74 75 __MPTCP_PM_ADDR_ATTR_MAX 76 }; 77 78 #define MPTCP_PM_ADDR_ATTR_MAX (__MPTCP_PM_ADDR_ATTR_MAX - 1) 79 80 #define MPTCP_PM_ADDR_FLAG_SIGNAL (1 << 0) 81 #define MPTCP_PM_ADDR_FLAG_SUBFLOW (1 << 1) 82 #define MPTCP_PM_ADDR_FLAG_BACKUP (1 << 2) 83 #define MPTCP_PM_ADDR_FLAG_FULLMESH (1 << 3) 84 85 enum { 86 MPTCP_PM_CMD_UNSPEC, 87 88 MPTCP_PM_CMD_ADD_ADDR, 89 MPTCP_PM_CMD_DEL_ADDR, 90 MPTCP_PM_CMD_GET_ADDR, 91 MPTCP_PM_CMD_FLUSH_ADDRS, 92 MPTCP_PM_CMD_SET_LIMITS, 93 MPTCP_PM_CMD_GET_LIMITS, 94 MPTCP_PM_CMD_SET_FLAGS, 95 96 __MPTCP_PM_CMD_AFTER_LAST 97 }; 98 99 #define MPTCP_INFO_FLAG_FALLBACK _BITUL(0) 100 #define MPTCP_INFO_FLAG_REMOTE_KEY_RECEIVED _BITUL(1) 101 102 struct mptcp_info { 103 __u8 mptcpi_subflows; 104 __u8 mptcpi_add_addr_signal; 105 __u8 mptcpi_add_addr_accepted; 106 __u8 mptcpi_subflows_max; 107 __u8 mptcpi_add_addr_signal_max; 108 __u8 mptcpi_add_addr_accepted_max; 109 __u32 mptcpi_flags; 110 __u32 mptcpi_token; 111 __u64 mptcpi_write_seq; 112 __u64 mptcpi_snd_una; 113 __u64 mptcpi_rcv_nxt; 114 __u8 mptcpi_local_addr_used; 115 __u8 mptcpi_local_addr_max; 116 __u8 mptcpi_csum_enabled; 117 }; 118 119 /* 120 * MPTCP_EVENT_CREATED: token, family, saddr4 | saddr6, daddr4 | daddr6, 121 * sport, dport 122 * A new MPTCP connection has been created. It is the good time to allocate 123 * memory and send ADD_ADDR if needed. Depending on the traffic-patterns 124 * it can take a long time until the MPTCP_EVENT_ESTABLISHED is sent. 125 * 126 * MPTCP_EVENT_ESTABLISHED: token, family, saddr4 | saddr6, daddr4 | daddr6, 127 * sport, dport 128 * A MPTCP connection is established (can start new subflows). 129 * 130 * MPTCP_EVENT_CLOSED: token 131 * A MPTCP connection has stopped. 132 * 133 * MPTCP_EVENT_ANNOUNCED: token, rem_id, family, daddr4 | daddr6 [, dport] 134 * A new address has been announced by the peer. 135 * 136 * MPTCP_EVENT_REMOVED: token, rem_id 137 * An address has been lost by the peer. 138 * 139 * MPTCP_EVENT_SUB_ESTABLISHED: token, family, loc_id, rem_id, 140 * saddr4 | saddr6, daddr4 | daddr6, sport, 141 * dport, backup, if_idx [, error] 142 * A new subflow has been established. 'error' should not be set. 143 * 144 * MPTCP_EVENT_SUB_CLOSED: token, family, loc_id, rem_id, saddr4 | saddr6, 145 * daddr4 | daddr6, sport, dport, backup, if_idx 146 * [, error] 147 * A subflow has been closed. An error (copy of sk_err) could be set if an 148 * error has been detected for this subflow. 149 * 150 * MPTCP_EVENT_SUB_PRIORITY: token, family, loc_id, rem_id, saddr4 | saddr6, 151 * daddr4 | daddr6, sport, dport, backup, if_idx 152 * [, error] 153 * The priority of a subflow has changed. 'error' should not be set. 154 */ 155 enum mptcp_event_type { 156 MPTCP_EVENT_UNSPEC = 0, 157 MPTCP_EVENT_CREATED = 1, 158 MPTCP_EVENT_ESTABLISHED = 2, 159 MPTCP_EVENT_CLOSED = 3, 160 161 MPTCP_EVENT_ANNOUNCED = 6, 162 MPTCP_EVENT_REMOVED = 7, 163 164 MPTCP_EVENT_SUB_ESTABLISHED = 10, 165 MPTCP_EVENT_SUB_CLOSED = 11, 166 167 MPTCP_EVENT_SUB_PRIORITY = 13, 168 }; 169 170 enum mptcp_event_attr { 171 MPTCP_ATTR_UNSPEC = 0, 172 173 MPTCP_ATTR_TOKEN, /* u32 */ 174 MPTCP_ATTR_FAMILY, /* u16 */ 175 MPTCP_ATTR_LOC_ID, /* u8 */ 176 MPTCP_ATTR_REM_ID, /* u8 */ 177 MPTCP_ATTR_SADDR4, /* be32 */ 178 MPTCP_ATTR_SADDR6, /* struct in6_addr */ 179 MPTCP_ATTR_DADDR4, /* be32 */ 180 MPTCP_ATTR_DADDR6, /* struct in6_addr */ 181 MPTCP_ATTR_SPORT, /* be16 */ 182 MPTCP_ATTR_DPORT, /* be16 */ 183 MPTCP_ATTR_BACKUP, /* u8 */ 184 MPTCP_ATTR_ERROR, /* u8 */ 185 MPTCP_ATTR_FLAGS, /* u16 */ 186 MPTCP_ATTR_TIMEOUT, /* u32 */ 187 MPTCP_ATTR_IF_IDX, /* s32 */ 188 MPTCP_ATTR_RESET_REASON,/* u32 */ 189 MPTCP_ATTR_RESET_FLAGS, /* u32 */ 190 191 __MPTCP_ATTR_AFTER_LAST 192 }; 193 194 #define MPTCP_ATTR_MAX (__MPTCP_ATTR_AFTER_LAST - 1) 195 196 /* MPTCP Reset reason codes, rfc8684 */ 197 #define MPTCP_RST_EUNSPEC 0 198 #define MPTCP_RST_EMPTCP 1 199 #define MPTCP_RST_ERESOURCE 2 200 #define MPTCP_RST_EPROHIBIT 3 201 #define MPTCP_RST_EWQ2BIG 4 202 #define MPTCP_RST_EBADPERF 5 203 #define MPTCP_RST_EMIDDLEBOX 6 204 205 struct mptcp_subflow_data { 206 __u32 size_subflow_data; /* size of this structure in userspace */ 207 __u32 num_subflows; /* must be 0, set by kernel */ 208 __u32 size_kernel; /* must be 0, set by kernel */ 209 __u32 size_user; /* size of one element in data[] */ 210 } __attribute__((aligned(8))); 211 212 struct mptcp_subflow_addrs { 213 union { 214 __kernel_sa_family_t sa_family; 215 struct sockaddr sa_local; 216 struct sockaddr_in sin_local; 217 struct sockaddr_in6 sin6_local; 218 struct __kernel_sockaddr_storage ss_local; 219 }; 220 union { 221 struct sockaddr sa_remote; 222 struct sockaddr_in sin_remote; 223 struct sockaddr_in6 sin6_remote; 224 struct __kernel_sockaddr_storage ss_remote; 225 }; 226 }; 227 228 /* MPTCP socket options */ 229 #define MPTCP_INFO 1 230 #define MPTCP_TCPINFO 2 231 #define MPTCP_SUBFLOW_ADDRS 3 232 233 #endif /* _UAPI_MPTCP_H */ 234