blob: 0743f48a0644327062dc5b0ba90745b7da3f1155 [file] [log] [blame]
Mat Martineauf870fa02020-01-21 16:56:15 -08001/* SPDX-License-Identifier: GPL-2.0 */
2/* Multipath TCP
3 *
4 * Copyright (c) 2017 - 2019, Intel Corporation.
5 */
6
7#ifndef __MPTCP_PROTOCOL_H
8#define __MPTCP_PROTOCOL_H
9
Peter Krystad79c09492020-01-21 16:56:20 -080010#include <linux/random.h>
11#include <net/tcp.h>
12#include <net/inet_connection_sock.h>
13
Christoph Paaschcc7972e2020-01-21 16:56:31 -080014#define MPTCP_SUPPORTED_VERSION 1
Peter Krystadeda7acd2020-01-21 16:56:16 -080015
16/* MPTCP option bits */
17#define OPTION_MPTCP_MPC_SYN BIT(0)
18#define OPTION_MPTCP_MPC_SYNACK BIT(1)
19#define OPTION_MPTCP_MPC_ACK BIT(2)
Peter Krystadf2962342020-03-27 14:48:39 -070020#define OPTION_MPTCP_MPJ_SYN BIT(3)
21#define OPTION_MPTCP_MPJ_SYNACK BIT(4)
22#define OPTION_MPTCP_MPJ_ACK BIT(5)
Peter Krystad3df523a2020-03-27 14:48:37 -070023#define OPTION_MPTCP_ADD_ADDR BIT(6)
24#define OPTION_MPTCP_ADD_ADDR6 BIT(7)
25#define OPTION_MPTCP_RM_ADDR BIT(8)
Florian Westphal50c504a2020-12-10 14:25:04 -080026#define OPTION_MPTCP_FASTCLOSE BIT(9)
Peter Krystadeda7acd2020-01-21 16:56:16 -080027
28/* MPTCP option subtypes */
29#define MPTCPOPT_MP_CAPABLE 0
30#define MPTCPOPT_MP_JOIN 1
31#define MPTCPOPT_DSS 2
32#define MPTCPOPT_ADD_ADDR 3
33#define MPTCPOPT_RM_ADDR 4
34#define MPTCPOPT_MP_PRIO 5
35#define MPTCPOPT_MP_FAIL 6
36#define MPTCPOPT_MP_FASTCLOSE 7
37
38/* MPTCP suboption lengths */
Christoph Paaschcc7972e2020-01-21 16:56:31 -080039#define TCPOLEN_MPTCP_MPC_SYN 4
Peter Krystadeda7acd2020-01-21 16:56:16 -080040#define TCPOLEN_MPTCP_MPC_SYNACK 12
41#define TCPOLEN_MPTCP_MPC_ACK 20
Christoph Paaschcc7972e2020-01-21 16:56:31 -080042#define TCPOLEN_MPTCP_MPC_ACK_DATA 22
Peter Krystadf2962342020-03-27 14:48:39 -070043#define TCPOLEN_MPTCP_MPJ_SYN 12
44#define TCPOLEN_MPTCP_MPJ_SYNACK 16
45#define TCPOLEN_MPTCP_MPJ_ACK 24
Mat Martineau6d0060f2020-01-21 16:56:23 -080046#define TCPOLEN_MPTCP_DSS_BASE 4
Mat Martineau648ef4b2020-01-21 16:56:24 -080047#define TCPOLEN_MPTCP_DSS_ACK32 4
Mat Martineau6d0060f2020-01-21 16:56:23 -080048#define TCPOLEN_MPTCP_DSS_ACK64 8
Mat Martineau648ef4b2020-01-21 16:56:24 -080049#define TCPOLEN_MPTCP_DSS_MAP32 10
Mat Martineau6d0060f2020-01-21 16:56:23 -080050#define TCPOLEN_MPTCP_DSS_MAP64 14
51#define TCPOLEN_MPTCP_DSS_CHECKSUM 2
Peter Krystad3df523a2020-03-27 14:48:37 -070052#define TCPOLEN_MPTCP_ADD_ADDR 16
Geliang Tang22fb85f2020-12-09 15:51:20 -080053#define TCPOLEN_MPTCP_ADD_ADDR_PORT 20
Peter Krystad3df523a2020-03-27 14:48:37 -070054#define TCPOLEN_MPTCP_ADD_ADDR_BASE 8
Geliang Tang22fb85f2020-12-09 15:51:20 -080055#define TCPOLEN_MPTCP_ADD_ADDR_BASE_PORT 12
Peter Krystad3df523a2020-03-27 14:48:37 -070056#define TCPOLEN_MPTCP_ADD_ADDR6 28
Geliang Tang22fb85f2020-12-09 15:51:20 -080057#define TCPOLEN_MPTCP_ADD_ADDR6_PORT 32
Peter Krystad3df523a2020-03-27 14:48:37 -070058#define TCPOLEN_MPTCP_ADD_ADDR6_BASE 20
Geliang Tang22fb85f2020-12-09 15:51:20 -080059#define TCPOLEN_MPTCP_ADD_ADDR6_BASE_PORT 24
60#define TCPOLEN_MPTCP_PORT_LEN 4
Peter Krystad3df523a2020-03-27 14:48:37 -070061#define TCPOLEN_MPTCP_RM_ADDR_BASE 4
Florian Westphal50c504a2020-12-10 14:25:04 -080062#define TCPOLEN_MPTCP_FASTCLOSE 12
Peter Krystadeda7acd2020-01-21 16:56:16 -080063
Peter Krystadec3edaa2020-03-27 14:48:40 -070064/* MPTCP MP_JOIN flags */
Peter Krystadf2962342020-03-27 14:48:39 -070065#define MPTCPOPT_BACKUP BIT(0)
66#define MPTCPOPT_HMAC_LEN 20
Peter Krystadec3edaa2020-03-27 14:48:40 -070067#define MPTCPOPT_THMAC_LEN 8
Peter Krystadf2962342020-03-27 14:48:39 -070068
Peter Krystadeda7acd2020-01-21 16:56:16 -080069/* MPTCP MP_CAPABLE flags */
70#define MPTCP_VERSION_MASK (0x0F)
71#define MPTCP_CAP_CHECKSUM_REQD BIT(7)
72#define MPTCP_CAP_EXTENSIBILITY BIT(6)
Paolo Abeni65492c52020-01-21 16:56:30 -080073#define MPTCP_CAP_HMAC_SHA256 BIT(0)
Peter Krystadeda7acd2020-01-21 16:56:16 -080074#define MPTCP_CAP_FLAG_MASK (0x3F)
75
Mat Martineau6d0060f2020-01-21 16:56:23 -080076/* MPTCP DSS flags */
77#define MPTCP_DSS_DATA_FIN BIT(4)
78#define MPTCP_DSS_DSN64 BIT(3)
79#define MPTCP_DSS_HAS_MAP BIT(2)
80#define MPTCP_DSS_ACK64 BIT(1)
81#define MPTCP_DSS_HAS_ACK BIT(0)
Mat Martineau648ef4b2020-01-21 16:56:24 -080082#define MPTCP_DSS_FLAG_MASK (0x1F)
83
Peter Krystad3df523a2020-03-27 14:48:37 -070084/* MPTCP ADD_ADDR flags */
85#define MPTCP_ADDR_ECHO BIT(0)
Peter Krystad3df523a2020-03-27 14:48:37 -070086#define MPTCP_ADDR_IPVERSION_4 4
87#define MPTCP_ADDR_IPVERSION_6 6
88
Mat Martineau648ef4b2020-01-21 16:56:24 -080089/* MPTCP socket flags */
Florian Westphald99bfed2020-02-17 16:54:38 +010090#define MPTCP_DATA_READY 0
Florian Westphal8edf0862020-11-16 10:48:12 +010091#define MPTCP_NOSPACE 1
Paolo Abeni3b1d6212020-03-27 14:48:48 -070092#define MPTCP_WORK_RTX 2
Florian Westphal59832e22020-04-02 13:44:52 +020093#define MPTCP_WORK_EOF 3
Davide Carattie1ff9e82020-06-29 22:26:20 +020094#define MPTCP_FALLBACK_DONE 4
Paolo Abeni0e4f35d2020-10-09 19:00:01 +020095#define MPTCP_WORK_CLOSE_SUBFLOW 5
Paolo Abeni6e628cd2020-11-27 11:10:27 +010096#define MPTCP_PUSH_PENDING 6
97#define MPTCP_CLEAN_UNA 7
Paolo Abeni15cc1042021-02-11 15:30:37 -080098#define MPTCP_ERROR_REPORT 8
Mat Martineau6d0060f2020-01-21 16:56:23 -080099
Paolo Abenieaa2ffa2020-11-16 10:48:08 +0100100static inline bool before64(__u64 seq1, __u64 seq2)
101{
102 return (__s64)(seq1 - seq2) < 0;
103}
104
105#define after64(seq2, seq1) before64(seq1, seq2)
106
Paolo Abenicfde1412020-04-30 15:01:52 +0200107struct mptcp_options_received {
108 u64 sndr_key;
109 u64 rcvr_key;
110 u64 data_ack;
111 u64 data_seq;
112 u32 subflow_seq;
113 u16 data_len;
114 u16 mp_capable : 1,
115 mp_join : 1,
Florian Westphal50c504a2020-12-10 14:25:04 -0800116 fastclose : 1,
Paolo Abenicfde1412020-04-30 15:01:52 +0200117 dss : 1,
118 add_addr : 1,
119 rm_addr : 1,
120 family : 4,
121 echo : 1,
122 backup : 1;
123 u32 token;
124 u32 nonce;
125 u64 thmac;
Geliang Tangba34c3d2020-12-10 14:25:01 -0800126 u8 hmac[MPTCPOPT_HMAC_LEN];
Paolo Abenicfde1412020-04-30 15:01:52 +0200127 u8 join_id;
128 u8 use_map:1,
129 dsn64:1,
130 data_fin:1,
131 use_ack:1,
132 ack64:1,
133 mpc_map:1,
134 __unused:2;
135 u8 addr_id;
136 u8 rm_id;
137 union {
138 struct in_addr addr;
139#if IS_ENABLED(CONFIG_MPTCP_IPV6)
140 struct in6_addr addr6;
141#endif
142 };
143 u64 ahmac;
144 u16 port;
145};
146
Peter Krystad3df523a2020-03-27 14:48:37 -0700147static inline __be32 mptcp_option(u8 subopt, u8 len, u8 nib, u8 field)
148{
149 return htonl((TCPOPT_MPTCP << 24) | (len << 16) | (subopt << 12) |
150 ((nib & 0xF) << 8) | field);
151}
152
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700153struct mptcp_addr_info {
154 sa_family_t family;
155 __be16 port;
156 u8 id;
Paolo Abenief0da3b2020-09-14 10:01:15 +0200157 u8 flags;
158 int ifindex;
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700159 union {
160 struct in_addr addr;
161#if IS_ENABLED(CONFIG_MPTCP_IPV6)
162 struct in6_addr addr6;
163#endif
164 };
165};
166
167enum mptcp_pm_status {
168 MPTCP_PM_ADD_ADDR_RECEIVED,
Geliang Tang84dfe362020-11-19 11:46:00 -0800169 MPTCP_PM_ADD_ADDR_SEND_ACK,
Geliang Tangd0876b22020-09-24 08:29:49 +0800170 MPTCP_PM_RM_ADDR_RECEIVED,
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700171 MPTCP_PM_ESTABLISHED,
Paolo Abeni5b950ff2020-12-09 12:03:29 +0100172 MPTCP_PM_ALREADY_ESTABLISHED, /* persistent status, set after ESTABLISHED event */
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700173 MPTCP_PM_SUBFLOW_ESTABLISHED,
174};
175
Geliang Tang13ad9f02020-12-09 15:51:27 -0800176enum mptcp_addr_signal_status {
Geliang Tangd91d3222020-11-19 11:45:59 -0800177 MPTCP_ADD_ADDR_SIGNAL,
178 MPTCP_ADD_ADDR_ECHO,
Geliang Tang84dfe362020-11-19 11:46:00 -0800179 MPTCP_ADD_ADDR_IPV6,
Geliang Tang4a2777a82020-12-09 15:51:22 -0800180 MPTCP_ADD_ADDR_PORT,
Geliang Tang42842a42020-12-09 15:51:26 -0800181 MPTCP_RM_ADDR_SIGNAL,
Geliang Tangd91d3222020-11-19 11:45:59 -0800182};
183
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700184struct mptcp_pm_data {
185 struct mptcp_addr_info local;
186 struct mptcp_addr_info remote;
Geliang Tangb6c08382020-09-24 08:29:54 +0800187 struct list_head anno_list;
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700188
189 spinlock_t lock; /*protects the whole PM data */
190
Geliang Tang13ad9f02020-12-09 15:51:27 -0800191 u8 addr_signal;
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700192 bool server_side;
193 bool work_pending;
194 bool accept_addr;
195 bool accept_subflow;
196 u8 add_addr_signaled;
197 u8 add_addr_accepted;
198 u8 local_addr_used;
199 u8 subflows;
200 u8 add_addr_signal_max;
201 u8 add_addr_accept_max;
202 u8 local_addr_max;
203 u8 subflows_max;
204 u8 status;
Geliang Tang5cb104a2020-09-24 08:29:48 +0800205 u8 rm_id;
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700206};
207
Paolo Abeni18b683b2020-03-27 14:48:43 -0700208struct mptcp_data_frag {
209 struct list_head list;
210 u64 data_seq;
Paolo Abenif0e6a4c2020-11-16 10:48:07 +0100211 u16 data_len;
212 u16 offset;
213 u16 overhead;
214 u16 already_sent;
Paolo Abeni18b683b2020-03-27 14:48:43 -0700215 struct page *page;
216};
217
Mat Martineauf870fa02020-01-21 16:56:15 -0800218/* MPTCP connection sock */
219struct mptcp_sock {
220 /* inet_connection_sock must be the first member */
221 struct inet_connection_sock sk;
Peter Krystadcec37a62020-01-21 16:56:18 -0800222 u64 local_key;
223 u64 remote_key;
Mat Martineau6d0060f2020-01-21 16:56:23 -0800224 u64 write_seq;
Paolo Abenieaa2ffa2020-11-16 10:48:08 +0100225 u64 snd_nxt;
Mat Martineau6d0060f2020-01-21 16:56:23 -0800226 u64 ack_seq;
Florian Westphalfa3fe2b2020-11-19 11:46:02 -0800227 u64 rcv_wnd_sent;
Mat Martineau3721b9b2020-07-28 15:12:03 -0700228 u64 rcv_data_fin_seq;
Paolo Abenie93da922020-11-27 11:10:23 +0100229 int wmem_reserved;
Paolo Abenid5f49192020-09-14 10:01:17 +0200230 struct sock *last_snd;
231 int snd_burst;
Paolo Abeniea4ca582020-11-19 11:46:03 -0800232 int old_wspace;
Paolo Abeni7439d682020-11-27 11:10:26 +0100233 u64 snd_una;
234 u64 wnd_end;
Paolo Abenib51f9b82020-03-27 14:48:44 -0700235 unsigned long timer_ival;
Peter Krystad79c09492020-01-21 16:56:20 -0800236 u32 token;
Paolo Abeniea4ca582020-11-19 11:46:03 -0800237 int rmem_pending;
Paolo Abeni87952602020-11-27 11:10:24 +0100238 int rmem_released;
Mat Martineau648ef4b2020-01-21 16:56:24 -0800239 unsigned long flags;
Christoph Paaschd22f4982020-01-21 16:56:32 -0800240 bool can_ack;
Paolo Abenib93df082020-07-23 13:02:32 +0200241 bool fully_established;
Mat Martineau3721b9b2020-07-28 15:12:03 -0700242 bool rcv_data_fin;
Mat Martineau7279da62020-07-28 15:12:02 -0700243 bool snd_data_fin_enable;
Florian Westphal50c504a2020-12-10 14:25:04 -0800244 bool rcv_fastclose;
Davide Caratti37198e92020-10-06 18:26:17 +0200245 bool use_64bit_ack; /* Set when we received a 64-bit DSN */
Peter Krystadec3edaa2020-03-27 14:48:40 -0700246 spinlock_t join_list_lock;
Paolo Abeniea4ca582020-11-19 11:46:03 -0800247 struct sock *ack_hint;
Paolo Abeni80992012020-02-26 10:14:47 +0100248 struct work_struct work;
Paolo Abeniab174ad2020-09-14 10:01:12 +0200249 struct sk_buff *ooo_last_skb;
250 struct rb_root out_of_order_queue;
Paolo Abeni87952602020-11-27 11:10:24 +0100251 struct sk_buff_head receive_queue;
Paolo Abeni724cfd22020-11-27 11:10:25 +0100252 struct sk_buff_head skb_tx_cache; /* this is wmem accounted */
253 int tx_pending_data;
254 int size_goal_cache;
Peter Krystadcec37a62020-01-21 16:56:18 -0800255 struct list_head conn_list;
Paolo Abeni18b683b2020-03-27 14:48:43 -0700256 struct list_head rtx_queue;
Paolo Abenif0e6a4c2020-11-16 10:48:07 +0100257 struct mptcp_data_frag *first_pending;
Peter Krystadec3edaa2020-03-27 14:48:40 -0700258 struct list_head join_list;
Mat Martineauf870fa02020-01-21 16:56:15 -0800259 struct socket *subflow; /* outgoing connect/listener/!mp_capable */
Paolo Abeni8ab183d2020-01-21 16:56:33 -0800260 struct sock *first;
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700261 struct mptcp_pm_data pm;
Florian Westphala6b118f2020-06-30 21:24:45 +0200262 struct {
263 u32 space; /* bytes copied in last measurement window */
264 u32 copied; /* bytes copied in this measurement window */
265 u64 time; /* start time of measurement window */
266 u64 rtt_us; /* last maximum rtt of subflows */
267 } rcvq_space;
Mat Martineauf870fa02020-01-21 16:56:15 -0800268};
269
Paolo Abeniad80b0f2020-11-27 11:10:22 +0100270#define mptcp_lock_sock(___sk, cb) do { \
271 struct sock *__sk = (___sk); /* silence macro reuse warning */ \
272 might_sleep(); \
273 spin_lock_bh(&__sk->sk_lock.slock); \
274 if (__sk->sk_lock.owned) \
275 __lock_sock(__sk); \
276 cb; \
277 __sk->sk_lock.owned = 1; \
278 spin_unlock(&__sk->sk_lock.slock); \
279 mutex_acquire(&__sk->sk_lock.dep_map, 0, 0, _RET_IP_); \
280 local_bh_enable(); \
281} while (0)
282
Paolo Abeni87952602020-11-27 11:10:24 +0100283#define mptcp_data_lock(sk) spin_lock_bh(&(sk)->sk_lock.slock)
284#define mptcp_data_unlock(sk) spin_unlock_bh(&(sk)->sk_lock.slock)
285
Peter Krystadcec37a62020-01-21 16:56:18 -0800286#define mptcp_for_each_subflow(__msk, __subflow) \
287 list_for_each_entry(__subflow, &((__msk)->conn_list), node)
288
Mat Martineauf870fa02020-01-21 16:56:15 -0800289static inline struct mptcp_sock *mptcp_sk(const struct sock *sk)
290{
291 return (struct mptcp_sock *)sk;
292}
293
Paolo Abeniea4ca582020-11-19 11:46:03 -0800294static inline int __mptcp_space(const struct sock *sk)
295{
296 return tcp_space(sk) + READ_ONCE(mptcp_sk(sk)->rmem_pending);
297}
298
Paolo Abenif0e6a4c2020-11-16 10:48:07 +0100299static inline struct mptcp_data_frag *mptcp_send_head(const struct sock *sk)
300{
301 const struct mptcp_sock *msk = mptcp_sk(sk);
302
303 return READ_ONCE(msk->first_pending);
304}
305
306static inline struct mptcp_data_frag *mptcp_send_next(struct sock *sk)
307{
308 struct mptcp_sock *msk = mptcp_sk(sk);
309 struct mptcp_data_frag *cur;
310
311 cur = msk->first_pending;
312 return list_is_last(&cur->list, &msk->rtx_queue) ? NULL :
313 list_next_entry(cur, list);
314}
315
316static inline struct mptcp_data_frag *mptcp_pending_tail(const struct sock *sk)
317{
318 struct mptcp_sock *msk = mptcp_sk(sk);
319
320 if (!msk->first_pending)
321 return NULL;
322
323 if (WARN_ON_ONCE(list_empty(&msk->rtx_queue)))
324 return NULL;
325
326 return list_last_entry(&msk->rtx_queue, struct mptcp_data_frag, list);
327}
328
Paolo Abeni18b683b2020-03-27 14:48:43 -0700329static inline struct mptcp_data_frag *mptcp_rtx_tail(const struct sock *sk)
330{
331 struct mptcp_sock *msk = mptcp_sk(sk);
332
Paolo Abeni7439d682020-11-27 11:10:26 +0100333 if (!before64(msk->snd_nxt, READ_ONCE(msk->snd_una)))
Paolo Abeni18b683b2020-03-27 14:48:43 -0700334 return NULL;
335
336 return list_last_entry(&msk->rtx_queue, struct mptcp_data_frag, list);
337}
338
Florian Westphal7948f6c2020-03-27 14:48:46 -0700339static inline struct mptcp_data_frag *mptcp_rtx_head(const struct sock *sk)
340{
341 struct mptcp_sock *msk = mptcp_sk(sk);
342
Geliang Tanga386bc52020-06-15 16:34:28 +0800343 return list_first_entry_or_null(&msk->rtx_queue, struct mptcp_data_frag, list);
Florian Westphal7948f6c2020-03-27 14:48:46 -0700344}
345
Peter Krystadcec37a62020-01-21 16:56:18 -0800346struct mptcp_subflow_request_sock {
347 struct tcp_request_sock sk;
Christoph Paaschd22f4982020-01-21 16:56:32 -0800348 u16 mp_capable : 1,
Peter Krystadcec37a62020-01-21 16:56:18 -0800349 mp_join : 1,
Paolo Abenifca5c822020-04-20 16:25:06 +0200350 backup : 1;
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700351 u8 local_id;
Peter Krystadf2962342020-03-27 14:48:39 -0700352 u8 remote_id;
Peter Krystadcec37a62020-01-21 16:56:18 -0800353 u64 local_key;
Peter Krystad79c09492020-01-21 16:56:20 -0800354 u64 idsn;
355 u32 token;
Mat Martineau648ef4b2020-01-21 16:56:24 -0800356 u32 ssn_offset;
Peter Krystadf2962342020-03-27 14:48:39 -0700357 u64 thmac;
358 u32 local_nonce;
359 u32 remote_nonce;
Paolo Abeni8fd4de12020-06-17 12:08:56 +0200360 struct mptcp_sock *msk;
Paolo Abeni2c5ebd02020-06-26 19:30:00 +0200361 struct hlist_nulls_node token_node;
Peter Krystadcec37a62020-01-21 16:56:18 -0800362};
363
364static inline struct mptcp_subflow_request_sock *
365mptcp_subflow_rsk(const struct request_sock *rsk)
366{
367 return (struct mptcp_subflow_request_sock *)rsk;
368}
369
Paolo Abeni67193312020-09-14 10:01:09 +0200370enum mptcp_data_avail {
371 MPTCP_SUBFLOW_NODATA,
372 MPTCP_SUBFLOW_DATA_AVAIL,
373 MPTCP_SUBFLOW_OOO_DATA
374};
375
Peter Krystad2303f992020-01-21 16:56:17 -0800376/* MPTCP subflow context */
377struct mptcp_subflow_context {
Peter Krystadcec37a62020-01-21 16:56:18 -0800378 struct list_head node;/* conn_list of subflows */
379 u64 local_key;
380 u64 remote_key;
Peter Krystad79c09492020-01-21 16:56:20 -0800381 u64 idsn;
Mat Martineau648ef4b2020-01-21 16:56:24 -0800382 u64 map_seq;
Christoph Paaschcc7972e2020-01-21 16:56:31 -0800383 u32 snd_isn;
Peter Krystad79c09492020-01-21 16:56:20 -0800384 u32 token;
Mat Martineau6d0060f2020-01-21 16:56:23 -0800385 u32 rel_write_seq;
Mat Martineau648ef4b2020-01-21 16:56:24 -0800386 u32 map_subflow_seq;
387 u32 ssn_offset;
388 u32 map_data_len;
Peter Krystadcec37a62020-01-21 16:56:18 -0800389 u32 request_mptcp : 1, /* send MP_CAPABLE */
Peter Krystadec3edaa2020-03-27 14:48:40 -0700390 request_join : 1, /* send MP_JOIN */
391 request_bkup : 1,
Peter Krystadcec37a62020-01-21 16:56:18 -0800392 mp_capable : 1, /* remote is MPTCP capable */
Peter Krystadf2962342020-03-27 14:48:39 -0700393 mp_join : 1, /* remote is JOINing */
Paolo Abeni0be534f2020-03-19 11:06:30 +0100394 fully_established : 1, /* path validated */
Peter Krystadf2962342020-03-27 14:48:39 -0700395 pm_notified : 1, /* PM hook called for established status */
Mat Martineau648ef4b2020-01-21 16:56:24 -0800396 conn_finished : 1,
397 map_valid : 1,
Christoph Paaschd22f4982020-01-21 16:56:32 -0800398 mpc_map : 1,
Peter Krystadf2962342020-03-27 14:48:39 -0700399 backup : 1,
Christoph Paaschd22f4982020-01-21 16:56:32 -0800400 rx_eof : 1,
Paolo Abenie16163b2020-11-16 10:48:09 +0100401 can_ack : 1, /* only after processing the remote a key */
402 disposable : 1; /* ctx can be free at ulp release time */
Paolo Abeni67193312020-09-14 10:01:09 +0200403 enum mptcp_data_avail data_avail;
Peter Krystadf2962342020-03-27 14:48:39 -0700404 u32 remote_nonce;
405 u64 thmac;
406 u32 local_nonce;
Peter Krystadec3edaa2020-03-27 14:48:40 -0700407 u32 remote_token;
408 u8 hmac[MPTCPOPT_HMAC_LEN];
Peter Krystadf2962342020-03-27 14:48:39 -0700409 u8 local_id;
410 u8 remote_id;
Mat Martineau648ef4b2020-01-21 16:56:24 -0800411
Peter Krystad2303f992020-01-21 16:56:17 -0800412 struct sock *tcp_sock; /* tcp sk backpointer */
413 struct sock *conn; /* parent mptcp_sock */
Peter Krystadcec37a62020-01-21 16:56:18 -0800414 const struct inet_connection_sock_af_ops *icsk_af_ops;
Mat Martineau648ef4b2020-01-21 16:56:24 -0800415 void (*tcp_data_ready)(struct sock *sk);
416 void (*tcp_state_change)(struct sock *sk);
417 void (*tcp_write_space)(struct sock *sk);
Paolo Abeni15cc1042021-02-11 15:30:37 -0800418 void (*tcp_error_report)(struct sock *sk);
Mat Martineau648ef4b2020-01-21 16:56:24 -0800419
Peter Krystad2303f992020-01-21 16:56:17 -0800420 struct rcu_head rcu;
421};
422
423static inline struct mptcp_subflow_context *
424mptcp_subflow_ctx(const struct sock *sk)
425{
426 struct inet_connection_sock *icsk = inet_csk(sk);
427
428 /* Use RCU on icsk_ulp_data only for sock diag code */
429 return (__force struct mptcp_subflow_context *)icsk->icsk_ulp_data;
430}
431
432static inline struct sock *
433mptcp_subflow_tcp_sock(const struct mptcp_subflow_context *subflow)
434{
435 return subflow->tcp_sock;
436}
437
Mat Martineau648ef4b2020-01-21 16:56:24 -0800438static inline u64
439mptcp_subflow_get_map_offset(const struct mptcp_subflow_context *subflow)
440{
441 return tcp_sk(mptcp_subflow_tcp_sock(subflow))->copied_seq -
442 subflow->ssn_offset -
443 subflow->map_subflow_seq;
444}
445
446static inline u64
447mptcp_subflow_get_mapped_dsn(const struct mptcp_subflow_context *subflow)
448{
449 return subflow->map_seq + mptcp_subflow_get_map_offset(subflow);
450}
451
Paolo Abeni0397c6d2020-11-19 11:45:58 -0800452static inline void mptcp_add_pending_subflow(struct mptcp_sock *msk,
453 struct mptcp_subflow_context *subflow)
454{
455 sock_hold(mptcp_subflow_tcp_sock(subflow));
456 spin_lock_bh(&msk->join_list_lock);
457 list_add_tail(&subflow->node, &msk->join_list);
458 spin_unlock_bh(&msk->join_list_lock);
459}
460
Mat Martineau648ef4b2020-01-21 16:56:24 -0800461int mptcp_is_enabled(struct net *net);
Geliang Tang93f323b2020-11-03 11:05:07 -0800462unsigned int mptcp_get_add_addr_timeout(struct net *net);
Paolo Abenib93df082020-07-23 13:02:32 +0200463void mptcp_subflow_fully_established(struct mptcp_subflow_context *subflow,
464 struct mptcp_options_received *mp_opt);
Mat Martineau648ef4b2020-01-21 16:56:24 -0800465bool mptcp_subflow_data_available(struct sock *sk);
Paolo Abenid39dcec2020-06-26 19:29:59 +0200466void __init mptcp_subflow_init(void);
Geliang Tangd0876b22020-09-24 08:29:49 +0800467void mptcp_subflow_shutdown(struct sock *sk, struct sock *ssk, int how);
468void __mptcp_close_ssk(struct sock *sk, struct sock *ssk,
Paolo Abenie16163b2020-11-16 10:48:09 +0100469 struct mptcp_subflow_context *subflow);
Paolo Abenid5824842020-10-09 19:00:00 +0200470void mptcp_subflow_reset(struct sock *ssk);
Peter Krystadec3edaa2020-03-27 14:48:40 -0700471
472/* called with sk socket lock held */
Paolo Abenief0da3b2020-09-14 10:01:15 +0200473int __mptcp_subflow_connect(struct sock *sk, const struct mptcp_addr_info *loc,
Peter Krystadec3edaa2020-03-27 14:48:40 -0700474 const struct mptcp_addr_info *remote);
Peter Krystad2303f992020-01-21 16:56:17 -0800475int mptcp_subflow_create_socket(struct sock *sk, struct socket **new_sock);
476
Mat Martineau648ef4b2020-01-21 16:56:24 -0800477static inline void mptcp_subflow_tcp_fallback(struct sock *sk,
478 struct mptcp_subflow_context *ctx)
479{
480 sk->sk_data_ready = ctx->tcp_data_ready;
481 sk->sk_state_change = ctx->tcp_state_change;
482 sk->sk_write_space = ctx->tcp_write_space;
Paolo Abeni15cc1042021-02-11 15:30:37 -0800483 sk->sk_error_report = ctx->tcp_error_report;
Mat Martineau648ef4b2020-01-21 16:56:24 -0800484
485 inet_csk(sk)->icsk_af_ops = ctx->icsk_af_ops;
486}
487
Paolo Abenid39dcec2020-06-26 19:29:59 +0200488void __init mptcp_proto_init(void);
Matthieu Baerts784325e2020-01-21 16:56:28 -0800489#if IS_ENABLED(CONFIG_MPTCP_IPV6)
Paolo Abenid39dcec2020-06-26 19:29:59 +0200490int __init mptcp_proto_v6_init(void);
Matthieu Baerts784325e2020-01-21 16:56:28 -0800491#endif
Mat Martineau648ef4b2020-01-21 16:56:24 -0800492
Paolo Abenifca5c822020-04-20 16:25:06 +0200493struct sock *mptcp_sk_clone(const struct sock *sk,
Paolo Abenicfde1412020-04-30 15:01:52 +0200494 const struct mptcp_options_received *mp_opt,
Paolo Abenifca5c822020-04-20 16:25:06 +0200495 struct request_sock *req);
Peter Krystadcec37a62020-01-21 16:56:18 -0800496void mptcp_get_options(const struct sk_buff *skb,
Paolo Abenicfde1412020-04-30 15:01:52 +0200497 struct mptcp_options_received *mp_opt);
Peter Krystadcec37a62020-01-21 16:56:18 -0800498
499void mptcp_finish_connect(struct sock *sk);
Paolo Abenib93df082020-07-23 13:02:32 +0200500static inline bool mptcp_is_fully_established(struct sock *sk)
501{
502 return inet_sk_state_load(sk) == TCP_ESTABLISHED &&
503 READ_ONCE(mptcp_sk(sk)->fully_established);
504}
Florian Westphala6b118f2020-06-30 21:24:45 +0200505void mptcp_rcv_space_init(struct mptcp_sock *msk, const struct sock *ssk);
Florian Westphal2e522132020-02-26 10:14:51 +0100506void mptcp_data_ready(struct sock *sk, struct sock *ssk);
Peter Krystadf2962342020-03-27 14:48:39 -0700507bool mptcp_finish_join(struct sock *sk);
Paolo Abeniba8f48f2020-11-16 10:48:05 +0100508bool mptcp_schedule_work(struct sock *sk);
Paolo Abeni219d0492020-12-16 12:48:34 +0100509void __mptcp_check_push(struct sock *sk, struct sock *ssk);
Paolo Abeni7439d682020-11-27 11:10:26 +0100510void __mptcp_data_acked(struct sock *sk);
Paolo Abeni15cc1042021-02-11 15:30:37 -0800511void __mptcp_error_report(struct sock *sk);
Florian Westphal59832e22020-04-02 13:44:52 +0200512void mptcp_subflow_eof(struct sock *sk);
Mat Martineau1a49b2c2020-09-29 15:08:20 -0700513bool mptcp_update_rcv_data_fin(struct mptcp_sock *msk, u64 data_fin_seq, bool use_64bit);
Geliang Tang84dfe362020-11-19 11:46:00 -0800514void __mptcp_flush_join_list(struct mptcp_sock *msk);
Paolo Abenie16163b2020-11-16 10:48:09 +0100515static inline bool mptcp_data_fin_enabled(const struct mptcp_sock *msk)
516{
517 return READ_ONCE(msk->snd_data_fin_enable) &&
518 READ_ONCE(msk->write_seq) == READ_ONCE(msk->snd_nxt);
519}
520
Geliang Tang5c8c1642020-09-24 08:29:57 +0800521void mptcp_destroy_common(struct mptcp_sock *msk);
Peter Krystadcec37a62020-01-21 16:56:18 -0800522
Paolo Abeni2c5ebd02020-06-26 19:30:00 +0200523void __init mptcp_token_init(void);
524static inline void mptcp_token_init_request(struct request_sock *req)
525{
526 mptcp_subflow_rsk(req)->token_node.pprev = NULL;
527}
528
Peter Krystad79c09492020-01-21 16:56:20 -0800529int mptcp_token_new_request(struct request_sock *req);
Paolo Abeni2c5ebd02020-06-26 19:30:00 +0200530void mptcp_token_destroy_request(struct request_sock *req);
Peter Krystad79c09492020-01-21 16:56:20 -0800531int mptcp_token_new_connect(struct sock *sk);
Paolo Abeni2c5ebd02020-06-26 19:30:00 +0200532void mptcp_token_accept(struct mptcp_subflow_request_sock *r,
533 struct mptcp_sock *msk);
Florian Westphalc83a47e2020-07-30 21:25:54 +0200534bool mptcp_token_exists(u32 token);
Peter Krystadf2962342020-03-27 14:48:39 -0700535struct mptcp_sock *mptcp_token_get_sock(u32 token);
Paolo Abeni96d890d2020-07-09 15:12:40 +0200536struct mptcp_sock *mptcp_token_iter_next(const struct net *net, long *s_slot,
537 long *s_num);
Paolo Abeni2c5ebd02020-06-26 19:30:00 +0200538void mptcp_token_destroy(struct mptcp_sock *msk);
Peter Krystad79c09492020-01-21 16:56:20 -0800539
540void mptcp_crypto_key_sha(u64 key, u32 *token, u64 *idsn);
Peter Krystad79c09492020-01-21 16:56:20 -0800541
Peter Krystad3df523a2020-03-27 14:48:37 -0700542void mptcp_crypto_hmac_sha(u64 key1, u64 key2, u8 *msg, int len, void *hmac);
Peter Krystad79c09492020-01-21 16:56:20 -0800543
Paolo Abenid39dcec2020-06-26 19:29:59 +0200544void __init mptcp_pm_init(void);
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700545void mptcp_pm_data_init(struct mptcp_sock *msk);
546void mptcp_pm_new_connection(struct mptcp_sock *msk, int server_side);
547void mptcp_pm_fully_established(struct mptcp_sock *msk);
548bool mptcp_pm_allow_new_subflow(struct mptcp_sock *msk);
549void mptcp_pm_connection_closed(struct mptcp_sock *msk);
550void mptcp_pm_subflow_established(struct mptcp_sock *msk,
551 struct mptcp_subflow_context *subflow);
552void mptcp_pm_subflow_closed(struct mptcp_sock *msk, u8 id);
553void mptcp_pm_add_addr_received(struct mptcp_sock *msk,
554 const struct mptcp_addr_info *addr);
Geliang Tang84dfe362020-11-19 11:46:00 -0800555void mptcp_pm_add_addr_send_ack(struct mptcp_sock *msk);
Geliang Tangd0876b22020-09-24 08:29:49 +0800556void mptcp_pm_rm_addr_received(struct mptcp_sock *msk, u8 rm_id);
Geliang Tangb6c08382020-09-24 08:29:54 +0800557void mptcp_pm_free_anno_list(struct mptcp_sock *msk);
Geliang Tang00cfd772020-09-24 08:30:02 +0800558struct mptcp_pm_add_entry *
559mptcp_pm_del_add_timer(struct mptcp_sock *msk,
560 struct mptcp_addr_info *addr);
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700561
562int mptcp_pm_announce_addr(struct mptcp_sock *msk,
Geliang Tang6a6c05a2020-09-24 08:29:50 +0800563 const struct mptcp_addr_info *addr,
Geliang Tang0f5c9e32020-12-09 15:51:24 -0800564 bool echo, bool port);
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700565int mptcp_pm_remove_addr(struct mptcp_sock *msk, u8 local_id);
Geliang Tang0ee42612020-09-24 08:29:55 +0800566int mptcp_pm_remove_subflow(struct mptcp_sock *msk, u8 local_id);
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700567
Geliang Tangf643b802020-09-24 08:29:47 +0800568static inline bool mptcp_pm_should_add_signal(struct mptcp_sock *msk)
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700569{
Geliang Tang13ad9f02020-12-09 15:51:27 -0800570 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_SIGNAL);
Geliang Tangd91d3222020-11-19 11:45:59 -0800571}
572
573static inline bool mptcp_pm_should_add_signal_echo(struct mptcp_sock *msk)
574{
Geliang Tang13ad9f02020-12-09 15:51:27 -0800575 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_ECHO);
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700576}
577
Geliang Tang84dfe362020-11-19 11:46:00 -0800578static inline bool mptcp_pm_should_add_signal_ipv6(struct mptcp_sock *msk)
579{
Geliang Tang13ad9f02020-12-09 15:51:27 -0800580 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_IPV6);
Geliang Tang84dfe362020-11-19 11:46:00 -0800581}
582
Geliang Tang4a2777a82020-12-09 15:51:22 -0800583static inline bool mptcp_pm_should_add_signal_port(struct mptcp_sock *msk)
584{
Geliang Tang13ad9f02020-12-09 15:51:27 -0800585 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_PORT);
Geliang Tang4a2777a82020-12-09 15:51:22 -0800586}
587
Geliang Tang5cb104a2020-09-24 08:29:48 +0800588static inline bool mptcp_pm_should_rm_signal(struct mptcp_sock *msk)
589{
Geliang Tang13ad9f02020-12-09 15:51:27 -0800590 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_RM_ADDR_SIGNAL);
Geliang Tang5cb104a2020-09-24 08:29:48 +0800591}
592
Geliang Tang4a2777a82020-12-09 15:51:22 -0800593static inline unsigned int mptcp_add_addr_len(int family, bool echo, bool port)
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700594{
Geliang Tang2ec72fa2020-12-09 15:51:21 -0800595 u8 len = TCPOLEN_MPTCP_ADD_ADDR_BASE;
596
597 if (family == AF_INET6)
598 len = TCPOLEN_MPTCP_ADD_ADDR6_BASE;
599 if (!echo)
600 len += MPTCPOPT_THMAC_LEN;
Geliang Tang4a2777a82020-12-09 15:51:22 -0800601 if (port)
602 len += TCPOLEN_MPTCP_PORT_LEN;
Geliang Tang2ec72fa2020-12-09 15:51:21 -0800603
604 return len;
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700605}
606
Geliang Tangf643b802020-09-24 08:29:47 +0800607bool mptcp_pm_add_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
Geliang Tang4a2777a82020-12-09 15:51:22 -0800608 struct mptcp_addr_info *saddr, bool *echo, bool *port);
Geliang Tang5cb104a2020-09-24 08:29:48 +0800609bool mptcp_pm_rm_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
610 u8 *rm_id);
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700611int mptcp_pm_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
612
Paolo Abenid39dcec2020-06-26 19:29:59 +0200613void __init mptcp_pm_nl_init(void);
Paolo Abeni01cacb02020-03-27 14:48:51 -0700614void mptcp_pm_nl_data_init(struct mptcp_sock *msk);
615void mptcp_pm_nl_fully_established(struct mptcp_sock *msk);
616void mptcp_pm_nl_subflow_established(struct mptcp_sock *msk);
617void mptcp_pm_nl_add_addr_received(struct mptcp_sock *msk);
Geliang Tang84dfe362020-11-19 11:46:00 -0800618void mptcp_pm_nl_add_addr_send_ack(struct mptcp_sock *msk);
Geliang Tangd0876b22020-09-24 08:29:49 +0800619void mptcp_pm_nl_rm_addr_received(struct mptcp_sock *msk);
Geliang Tang0ee42612020-09-24 08:29:55 +0800620void mptcp_pm_nl_rm_subflow_received(struct mptcp_sock *msk, u8 rm_id);
Paolo Abeni01cacb02020-03-27 14:48:51 -0700621int mptcp_pm_nl_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
622
Mat Martineau6d0060f2020-01-21 16:56:23 -0800623static inline struct mptcp_ext *mptcp_get_ext(struct sk_buff *skb)
624{
625 return (struct mptcp_ext *)skb_ext_find(skb, SKB_EXT_MPTCP);
626}
627
Davide Caratti5147dfb2020-03-27 14:48:49 -0700628void mptcp_diag_subflow_init(struct tcp_ulp_ops *ops);
629
Paolo Abenid5f49192020-09-14 10:01:17 +0200630static inline bool __mptcp_check_fallback(const struct mptcp_sock *msk)
Davide Carattie1ff9e82020-06-29 22:26:20 +0200631{
632 return test_bit(MPTCP_FALLBACK_DONE, &msk->flags);
633}
634
Paolo Abenid5f49192020-09-14 10:01:17 +0200635static inline bool mptcp_check_fallback(const struct sock *sk)
Davide Carattie1ff9e82020-06-29 22:26:20 +0200636{
637 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
638 struct mptcp_sock *msk = mptcp_sk(subflow->conn);
639
640 return __mptcp_check_fallback(msk);
641}
642
643static inline void __mptcp_do_fallback(struct mptcp_sock *msk)
644{
645 if (test_bit(MPTCP_FALLBACK_DONE, &msk->flags)) {
646 pr_debug("TCP fallback already done (msk=%p)", msk);
647 return;
648 }
649 set_bit(MPTCP_FALLBACK_DONE, &msk->flags);
650}
651
652static inline void mptcp_do_fallback(struct sock *sk)
653{
654 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
655 struct mptcp_sock *msk = mptcp_sk(subflow->conn);
656
657 __mptcp_do_fallback(msk);
658}
659
660#define pr_fallback(a) pr_debug("%s:fallback to TCP (msk=%p)", __func__, a)
661
Davide Caratti8fd73802020-06-29 22:26:21 +0200662static inline bool subflow_simultaneous_connect(struct sock *sk)
663{
664 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
665 struct sock *parent = subflow->conn;
666
667 return sk->sk_state == TCP_ESTABLISHED &&
668 !mptcp_sk(parent)->pm.server_side &&
669 !subflow->conn_finished;
670}
671
Florian Westphal9466a1c2020-07-30 21:25:56 +0200672#ifdef CONFIG_SYN_COOKIES
673void subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
674 struct sk_buff *skb);
675bool mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
676 struct sk_buff *skb);
677void __init mptcp_join_cookie_init(void);
678#else
679static inline void
680subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
681 struct sk_buff *skb) {}
682static inline bool
683mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
684 struct sk_buff *skb)
685{
686 return false;
687}
688
689static inline void mptcp_join_cookie_init(void) {}
690#endif
691
Mat Martineauf870fa02020-01-21 16:56:15 -0800692#endif /* __MPTCP_PROTOCOL_H */