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 MPTCP_PM_ATTR_TOKEN, /* u32 */ 59 MPTCP_PM_ATTR_LOC_ID, /* u8 */ 60 MPTCP_PM_ATTR_ADDR_REMOTE, /* nested address */ 61 62 __MPTCP_PM_ATTR_MAX 63 }; 64 65 #define MPTCP_PM_ATTR_MAX (__MPTCP_PM_ATTR_MAX - 1) 66 67 enum { 68 MPTCP_PM_ADDR_ATTR_UNSPEC, 69 70 MPTCP_PM_ADDR_ATTR_FAMILY, /* u16 */ 71 MPTCP_PM_ADDR_ATTR_ID, /* u8 */ 72 MPTCP_PM_ADDR_ATTR_ADDR4, /* struct in_addr */ 73 MPTCP_PM_ADDR_ATTR_ADDR6, /* struct in6_addr */ 74 MPTCP_PM_ADDR_ATTR_PORT, /* u16 */ 75 MPTCP_PM_ADDR_ATTR_FLAGS, /* u32 */ 76 MPTCP_PM_ADDR_ATTR_IF_IDX, /* s32 */ 77 78 __MPTCP_PM_ADDR_ATTR_MAX 79 }; 80 81 #define MPTCP_PM_ADDR_ATTR_MAX (__MPTCP_PM_ADDR_ATTR_MAX - 1) 82 83 #define MPTCP_PM_ADDR_FLAG_SIGNAL (1 << 0) 84 #define MPTCP_PM_ADDR_FLAG_SUBFLOW (1 << 1) 85 #define MPTCP_PM_ADDR_FLAG_BACKUP (1 << 2) 86 #define MPTCP_PM_ADDR_FLAG_FULLMESH (1 << 3) 87 #define MPTCP_PM_ADDR_FLAG_IMPLICIT (1 << 4) 88 89 enum { 90 MPTCP_PM_CMD_UNSPEC, 91 92 MPTCP_PM_CMD_ADD_ADDR, 93 MPTCP_PM_CMD_DEL_ADDR, 94 MPTCP_PM_CMD_GET_ADDR, 95 MPTCP_PM_CMD_FLUSH_ADDRS, 96 MPTCP_PM_CMD_SET_LIMITS, 97 MPTCP_PM_CMD_GET_LIMITS, 98 MPTCP_PM_CMD_SET_FLAGS, 99 MPTCP_PM_CMD_ANNOUNCE, 100 MPTCP_PM_CMD_REMOVE, 101 MPTCP_PM_CMD_SUBFLOW_CREATE, 102 MPTCP_PM_CMD_SUBFLOW_DESTROY, 103 104 __MPTCP_PM_CMD_AFTER_LAST 105 }; 106 107 #define MPTCP_INFO_FLAG_FALLBACK _BITUL(0) 108 #define MPTCP_INFO_FLAG_REMOTE_KEY_RECEIVED _BITUL(1) 109 110 struct mptcp_info { 111 __u8 mptcpi_subflows; 112 __u8 mptcpi_add_addr_signal; 113 __u8 mptcpi_add_addr_accepted; 114 __u8 mptcpi_subflows_max; 115 __u8 mptcpi_add_addr_signal_max; 116 __u8 mptcpi_add_addr_accepted_max; 117 __u32 mptcpi_flags; 118 __u32 mptcpi_token; 119 __u64 mptcpi_write_seq; 120 __u64 mptcpi_snd_una; 121 __u64 mptcpi_rcv_nxt; 122 __u8 mptcpi_local_addr_used; 123 __u8 mptcpi_local_addr_max; 124 __u8 mptcpi_csum_enabled; 125 }; 126 127 /* 128 * MPTCP_EVENT_CREATED: token, family, saddr4 | saddr6, daddr4 | daddr6, 129 * sport, dport 130 * A new MPTCP connection has been created. It is the good time to allocate 131 * memory and send ADD_ADDR if needed. Depending on the traffic-patterns 132 * it can take a long time until the MPTCP_EVENT_ESTABLISHED is sent. 133 * 134 * MPTCP_EVENT_ESTABLISHED: token, family, saddr4 | saddr6, daddr4 | daddr6, 135 * sport, dport 136 * A MPTCP connection is established (can start new subflows). 137 * 138 * MPTCP_EVENT_CLOSED: token 139 * A MPTCP connection has stopped. 140 * 141 * MPTCP_EVENT_ANNOUNCED: token, rem_id, family, daddr4 | daddr6 [, dport] 142 * A new address has been announced by the peer. 143 * 144 * MPTCP_EVENT_REMOVED: token, rem_id 145 * An address has been lost by the peer. 146 * 147 * MPTCP_EVENT_SUB_ESTABLISHED: token, family, loc_id, rem_id, 148 * saddr4 | saddr6, daddr4 | daddr6, sport, 149 * dport, backup, if_idx [, error] 150 * A new subflow has been established. 'error' should not be set. 151 * 152 * MPTCP_EVENT_SUB_CLOSED: token, family, loc_id, rem_id, saddr4 | saddr6, 153 * daddr4 | daddr6, sport, dport, backup, if_idx 154 * [, error] 155 * A subflow has been closed. An error (copy of sk_err) could be set if an 156 * error has been detected for this subflow. 157 * 158 * MPTCP_EVENT_SUB_PRIORITY: token, family, loc_id, rem_id, saddr4 | saddr6, 159 * daddr4 | daddr6, sport, dport, backup, if_idx 160 * [, error] 161 * The priority of a subflow has changed. 'error' should not be set. 162 */ 163 enum mptcp_event_type { 164 MPTCP_EVENT_UNSPEC = 0, 165 MPTCP_EVENT_CREATED = 1, 166 MPTCP_EVENT_ESTABLISHED = 2, 167 MPTCP_EVENT_CLOSED = 3, 168 169 MPTCP_EVENT_ANNOUNCED = 6, 170 MPTCP_EVENT_REMOVED = 7, 171 172 MPTCP_EVENT_SUB_ESTABLISHED = 10, 173 MPTCP_EVENT_SUB_CLOSED = 11, 174 175 MPTCP_EVENT_SUB_PRIORITY = 13, 176 }; 177 178 enum mptcp_event_attr { 179 MPTCP_ATTR_UNSPEC = 0, 180 181 MPTCP_ATTR_TOKEN, /* u32 */ 182 MPTCP_ATTR_FAMILY, /* u16 */ 183 MPTCP_ATTR_LOC_ID, /* u8 */ 184 MPTCP_ATTR_REM_ID, /* u8 */ 185 MPTCP_ATTR_SADDR4, /* be32 */ 186 MPTCP_ATTR_SADDR6, /* struct in6_addr */ 187 MPTCP_ATTR_DADDR4, /* be32 */ 188 MPTCP_ATTR_DADDR6, /* struct in6_addr */ 189 MPTCP_ATTR_SPORT, /* be16 */ 190 MPTCP_ATTR_DPORT, /* be16 */ 191 MPTCP_ATTR_BACKUP, /* u8 */ 192 MPTCP_ATTR_ERROR, /* u8 */ 193 MPTCP_ATTR_FLAGS, /* u16 */ 194 MPTCP_ATTR_TIMEOUT, /* u32 */ 195 MPTCP_ATTR_IF_IDX, /* s32 */ 196 MPTCP_ATTR_RESET_REASON,/* u32 */ 197 MPTCP_ATTR_RESET_FLAGS, /* u32 */ 198 MPTCP_ATTR_SERVER_SIDE, /* u8 */ 199 200 __MPTCP_ATTR_AFTER_LAST 201 }; 202 203 #define MPTCP_ATTR_MAX (__MPTCP_ATTR_AFTER_LAST - 1) 204 205 /* MPTCP Reset reason codes, rfc8684 */ 206 #define MPTCP_RST_EUNSPEC 0 207 #define MPTCP_RST_EMPTCP 1 208 #define MPTCP_RST_ERESOURCE 2 209 #define MPTCP_RST_EPROHIBIT 3 210 #define MPTCP_RST_EWQ2BIG 4 211 #define MPTCP_RST_EBADPERF 5 212 #define MPTCP_RST_EMIDDLEBOX 6 213 214 struct mptcp_subflow_data { 215 __u32 size_subflow_data; /* size of this structure in userspace */ 216 __u32 num_subflows; /* must be 0, set by kernel */ 217 __u32 size_kernel; /* must be 0, set by kernel */ 218 __u32 size_user; /* size of one element in data[] */ 219 } __attribute__((aligned(8))); 220 221 struct mptcp_subflow_addrs { 222 union { 223 __kernel_sa_family_t sa_family; 224 struct sockaddr sa_local; 225 struct sockaddr_in sin_local; 226 struct sockaddr_in6 sin6_local; 227 struct __kernel_sockaddr_storage ss_local; 228 }; 229 union { 230 struct sockaddr sa_remote; 231 struct sockaddr_in sin_remote; 232 struct sockaddr_in6 sin6_remote; 233 struct __kernel_sockaddr_storage ss_remote; 234 }; 235 }; 236 237 /* MPTCP socket options */ 238 #define MPTCP_INFO 1 239 #define MPTCP_TCPINFO 2 240 #define MPTCP_SUBFLOW_ADDRS 3 241 242 #endif /* _UAPI_MPTCP_H */ 243