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