blob: 82d5626323b18665f83feafea43be70b0c1fcb92 [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)
Peter Krystadeda7acd2020-01-21 16:56:16 -080026
27/* MPTCP option subtypes */
28#define MPTCPOPT_MP_CAPABLE 0
29#define MPTCPOPT_MP_JOIN 1
30#define MPTCPOPT_DSS 2
31#define MPTCPOPT_ADD_ADDR 3
32#define MPTCPOPT_RM_ADDR 4
33#define MPTCPOPT_MP_PRIO 5
34#define MPTCPOPT_MP_FAIL 6
35#define MPTCPOPT_MP_FASTCLOSE 7
36
37/* MPTCP suboption lengths */
Christoph Paaschcc7972e2020-01-21 16:56:31 -080038#define TCPOLEN_MPTCP_MPC_SYN 4
Peter Krystadeda7acd2020-01-21 16:56:16 -080039#define TCPOLEN_MPTCP_MPC_SYNACK 12
40#define TCPOLEN_MPTCP_MPC_ACK 20
Christoph Paaschcc7972e2020-01-21 16:56:31 -080041#define TCPOLEN_MPTCP_MPC_ACK_DATA 22
Peter Krystadf2962342020-03-27 14:48:39 -070042#define TCPOLEN_MPTCP_MPJ_SYN 12
43#define TCPOLEN_MPTCP_MPJ_SYNACK 16
44#define TCPOLEN_MPTCP_MPJ_ACK 24
Mat Martineau6d0060f2020-01-21 16:56:23 -080045#define TCPOLEN_MPTCP_DSS_BASE 4
Mat Martineau648ef4b2020-01-21 16:56:24 -080046#define TCPOLEN_MPTCP_DSS_ACK32 4
Mat Martineau6d0060f2020-01-21 16:56:23 -080047#define TCPOLEN_MPTCP_DSS_ACK64 8
Mat Martineau648ef4b2020-01-21 16:56:24 -080048#define TCPOLEN_MPTCP_DSS_MAP32 10
Mat Martineau6d0060f2020-01-21 16:56:23 -080049#define TCPOLEN_MPTCP_DSS_MAP64 14
50#define TCPOLEN_MPTCP_DSS_CHECKSUM 2
Peter Krystad3df523a2020-03-27 14:48:37 -070051#define TCPOLEN_MPTCP_ADD_ADDR 16
52#define TCPOLEN_MPTCP_ADD_ADDR_PORT 18
53#define TCPOLEN_MPTCP_ADD_ADDR_BASE 8
54#define TCPOLEN_MPTCP_ADD_ADDR_BASE_PORT 10
55#define TCPOLEN_MPTCP_ADD_ADDR6 28
56#define TCPOLEN_MPTCP_ADD_ADDR6_PORT 30
57#define TCPOLEN_MPTCP_ADD_ADDR6_BASE 20
58#define TCPOLEN_MPTCP_ADD_ADDR6_BASE_PORT 22
59#define TCPOLEN_MPTCP_PORT_LEN 2
60#define TCPOLEN_MPTCP_RM_ADDR_BASE 4
Peter Krystadeda7acd2020-01-21 16:56:16 -080061
Peter Krystadec3edaa2020-03-27 14:48:40 -070062/* MPTCP MP_JOIN flags */
Peter Krystadf2962342020-03-27 14:48:39 -070063#define MPTCPOPT_BACKUP BIT(0)
64#define MPTCPOPT_HMAC_LEN 20
Peter Krystadec3edaa2020-03-27 14:48:40 -070065#define MPTCPOPT_THMAC_LEN 8
Peter Krystadf2962342020-03-27 14:48:39 -070066
Peter Krystadeda7acd2020-01-21 16:56:16 -080067/* MPTCP MP_CAPABLE flags */
68#define MPTCP_VERSION_MASK (0x0F)
69#define MPTCP_CAP_CHECKSUM_REQD BIT(7)
70#define MPTCP_CAP_EXTENSIBILITY BIT(6)
Paolo Abeni65492c52020-01-21 16:56:30 -080071#define MPTCP_CAP_HMAC_SHA256 BIT(0)
Peter Krystadeda7acd2020-01-21 16:56:16 -080072#define MPTCP_CAP_FLAG_MASK (0x3F)
73
Mat Martineau6d0060f2020-01-21 16:56:23 -080074/* MPTCP DSS flags */
75#define MPTCP_DSS_DATA_FIN BIT(4)
76#define MPTCP_DSS_DSN64 BIT(3)
77#define MPTCP_DSS_HAS_MAP BIT(2)
78#define MPTCP_DSS_ACK64 BIT(1)
79#define MPTCP_DSS_HAS_ACK BIT(0)
Mat Martineau648ef4b2020-01-21 16:56:24 -080080#define MPTCP_DSS_FLAG_MASK (0x1F)
81
Peter Krystad3df523a2020-03-27 14:48:37 -070082/* MPTCP ADD_ADDR flags */
83#define MPTCP_ADDR_ECHO BIT(0)
Peter Krystad3df523a2020-03-27 14:48:37 -070084#define MPTCP_ADDR_IPVERSION_4 4
85#define MPTCP_ADDR_IPVERSION_6 6
86
Mat Martineau648ef4b2020-01-21 16:56:24 -080087/* MPTCP socket flags */
Florian Westphald99bfed2020-02-17 16:54:38 +010088#define MPTCP_DATA_READY 0
Florian Westphal8edf0862020-11-16 10:48:12 +010089#define MPTCP_NOSPACE 1
Paolo Abeni3b1d6212020-03-27 14:48:48 -070090#define MPTCP_WORK_RTX 2
Florian Westphal59832e22020-04-02 13:44:52 +020091#define MPTCP_WORK_EOF 3
Davide Carattie1ff9e82020-06-29 22:26:20 +020092#define MPTCP_FALLBACK_DONE 4
Paolo Abeni0e4f35d2020-10-09 19:00:01 +020093#define MPTCP_WORK_CLOSE_SUBFLOW 5
Mat Martineau6d0060f2020-01-21 16:56:23 -080094
Paolo Abenieaa2ffa2020-11-16 10:48:08 +010095static inline bool before64(__u64 seq1, __u64 seq2)
96{
97 return (__s64)(seq1 - seq2) < 0;
98}
99
100#define after64(seq2, seq1) before64(seq1, seq2)
101
Paolo Abenicfde1412020-04-30 15:01:52 +0200102struct mptcp_options_received {
103 u64 sndr_key;
104 u64 rcvr_key;
105 u64 data_ack;
106 u64 data_seq;
107 u32 subflow_seq;
108 u16 data_len;
109 u16 mp_capable : 1,
110 mp_join : 1,
111 dss : 1,
112 add_addr : 1,
113 rm_addr : 1,
114 family : 4,
115 echo : 1,
116 backup : 1;
117 u32 token;
118 u32 nonce;
119 u64 thmac;
120 u8 hmac[20];
121 u8 join_id;
122 u8 use_map:1,
123 dsn64:1,
124 data_fin:1,
125 use_ack:1,
126 ack64:1,
127 mpc_map:1,
128 __unused:2;
129 u8 addr_id;
130 u8 rm_id;
131 union {
132 struct in_addr addr;
133#if IS_ENABLED(CONFIG_MPTCP_IPV6)
134 struct in6_addr addr6;
135#endif
136 };
137 u64 ahmac;
138 u16 port;
139};
140
Peter Krystad3df523a2020-03-27 14:48:37 -0700141static inline __be32 mptcp_option(u8 subopt, u8 len, u8 nib, u8 field)
142{
143 return htonl((TCPOPT_MPTCP << 24) | (len << 16) | (subopt << 12) |
144 ((nib & 0xF) << 8) | field);
145}
146
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700147struct mptcp_addr_info {
148 sa_family_t family;
149 __be16 port;
150 u8 id;
Paolo Abenief0da3b2020-09-14 10:01:15 +0200151 u8 flags;
152 int ifindex;
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700153 union {
154 struct in_addr addr;
155#if IS_ENABLED(CONFIG_MPTCP_IPV6)
156 struct in6_addr addr6;
157#endif
158 };
159};
160
161enum mptcp_pm_status {
162 MPTCP_PM_ADD_ADDR_RECEIVED,
Geliang Tang84dfe362020-11-19 11:46:00 -0800163 MPTCP_PM_ADD_ADDR_SEND_ACK,
Geliang Tangd0876b22020-09-24 08:29:49 +0800164 MPTCP_PM_RM_ADDR_RECEIVED,
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700165 MPTCP_PM_ESTABLISHED,
166 MPTCP_PM_SUBFLOW_ESTABLISHED,
167};
168
Geliang Tangd91d3222020-11-19 11:45:59 -0800169enum mptcp_add_addr_status {
170 MPTCP_ADD_ADDR_SIGNAL,
171 MPTCP_ADD_ADDR_ECHO,
Geliang Tang84dfe362020-11-19 11:46:00 -0800172 MPTCP_ADD_ADDR_IPV6,
Geliang Tangd91d3222020-11-19 11:45:59 -0800173};
174
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700175struct mptcp_pm_data {
176 struct mptcp_addr_info local;
177 struct mptcp_addr_info remote;
Geliang Tangb6c08382020-09-24 08:29:54 +0800178 struct list_head anno_list;
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700179
180 spinlock_t lock; /*protects the whole PM data */
181
Geliang Tangd91d3222020-11-19 11:45:59 -0800182 u8 add_addr_signal;
Geliang Tang5cb104a2020-09-24 08:29:48 +0800183 bool rm_addr_signal;
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700184 bool server_side;
185 bool work_pending;
186 bool accept_addr;
187 bool accept_subflow;
188 u8 add_addr_signaled;
189 u8 add_addr_accepted;
190 u8 local_addr_used;
191 u8 subflows;
192 u8 add_addr_signal_max;
193 u8 add_addr_accept_max;
194 u8 local_addr_max;
195 u8 subflows_max;
196 u8 status;
Geliang Tang5cb104a2020-09-24 08:29:48 +0800197 u8 rm_id;
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700198};
199
Paolo Abeni18b683b2020-03-27 14:48:43 -0700200struct mptcp_data_frag {
201 struct list_head list;
202 u64 data_seq;
Paolo Abenif0e6a4c2020-11-16 10:48:07 +0100203 u16 data_len;
204 u16 offset;
205 u16 overhead;
206 u16 already_sent;
Paolo Abeni18b683b2020-03-27 14:48:43 -0700207 struct page *page;
208};
209
Mat Martineauf870fa02020-01-21 16:56:15 -0800210/* MPTCP connection sock */
211struct mptcp_sock {
212 /* inet_connection_sock must be the first member */
213 struct inet_connection_sock sk;
Peter Krystadcec37a62020-01-21 16:56:18 -0800214 u64 local_key;
215 u64 remote_key;
Mat Martineau6d0060f2020-01-21 16:56:23 -0800216 u64 write_seq;
Paolo Abenieaa2ffa2020-11-16 10:48:08 +0100217 u64 snd_nxt;
Mat Martineau6d0060f2020-01-21 16:56:23 -0800218 u64 ack_seq;
Florian Westphalfa3fe2b2020-11-19 11:46:02 -0800219 u64 rcv_wnd_sent;
Mat Martineau3721b9b2020-07-28 15:12:03 -0700220 u64 rcv_data_fin_seq;
Paolo Abenid5f49192020-09-14 10:01:17 +0200221 struct sock *last_snd;
222 int snd_burst;
Paolo Abeniea4ca582020-11-19 11:46:03 -0800223 int old_wspace;
Paolo Abenicc9d2562020-03-27 14:48:42 -0700224 atomic64_t snd_una;
Florian Westphal6f8a6122020-11-16 10:48:13 +0100225 atomic64_t wnd_end;
Paolo Abenib51f9b82020-03-27 14:48:44 -0700226 unsigned long timer_ival;
Peter Krystad79c09492020-01-21 16:56:20 -0800227 u32 token;
Paolo Abeniea4ca582020-11-19 11:46:03 -0800228 int rmem_pending;
Mat Martineau648ef4b2020-01-21 16:56:24 -0800229 unsigned long flags;
Christoph Paaschd22f4982020-01-21 16:56:32 -0800230 bool can_ack;
Paolo Abenib93df082020-07-23 13:02:32 +0200231 bool fully_established;
Mat Martineau3721b9b2020-07-28 15:12:03 -0700232 bool rcv_data_fin;
Mat Martineau7279da62020-07-28 15:12:02 -0700233 bool snd_data_fin_enable;
Davide Caratti37198e92020-10-06 18:26:17 +0200234 bool use_64bit_ack; /* Set when we received a 64-bit DSN */
Peter Krystadec3edaa2020-03-27 14:48:40 -0700235 spinlock_t join_list_lock;
Paolo Abeniea4ca582020-11-19 11:46:03 -0800236 struct sock *ack_hint;
Paolo Abeni80992012020-02-26 10:14:47 +0100237 struct work_struct work;
Paolo Abeniab174ad2020-09-14 10:01:12 +0200238 struct sk_buff *ooo_last_skb;
239 struct rb_root out_of_order_queue;
Peter Krystadcec37a62020-01-21 16:56:18 -0800240 struct list_head conn_list;
Paolo Abeni18b683b2020-03-27 14:48:43 -0700241 struct list_head rtx_queue;
Paolo Abenif0e6a4c2020-11-16 10:48:07 +0100242 struct mptcp_data_frag *first_pending;
Peter Krystadec3edaa2020-03-27 14:48:40 -0700243 struct list_head join_list;
Mat Martineau6d0060f2020-01-21 16:56:23 -0800244 struct skb_ext *cached_ext; /* for the next sendmsg */
Mat Martineauf870fa02020-01-21 16:56:15 -0800245 struct socket *subflow; /* outgoing connect/listener/!mp_capable */
Paolo Abeni8ab183d2020-01-21 16:56:33 -0800246 struct sock *first;
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700247 struct mptcp_pm_data pm;
Florian Westphala6b118f2020-06-30 21:24:45 +0200248 struct {
249 u32 space; /* bytes copied in last measurement window */
250 u32 copied; /* bytes copied in this measurement window */
251 u64 time; /* start time of measurement window */
252 u64 rtt_us; /* last maximum rtt of subflows */
253 } rcvq_space;
Mat Martineauf870fa02020-01-21 16:56:15 -0800254};
255
Peter Krystadcec37a62020-01-21 16:56:18 -0800256#define mptcp_for_each_subflow(__msk, __subflow) \
257 list_for_each_entry(__subflow, &((__msk)->conn_list), node)
258
Mat Martineauf870fa02020-01-21 16:56:15 -0800259static inline struct mptcp_sock *mptcp_sk(const struct sock *sk)
260{
261 return (struct mptcp_sock *)sk;
262}
263
Paolo Abeniea4ca582020-11-19 11:46:03 -0800264static inline int __mptcp_space(const struct sock *sk)
265{
266 return tcp_space(sk) + READ_ONCE(mptcp_sk(sk)->rmem_pending);
267}
268
Paolo Abenif0e6a4c2020-11-16 10:48:07 +0100269static inline struct mptcp_data_frag *mptcp_send_head(const struct sock *sk)
270{
271 const struct mptcp_sock *msk = mptcp_sk(sk);
272
273 return READ_ONCE(msk->first_pending);
274}
275
276static inline struct mptcp_data_frag *mptcp_send_next(struct sock *sk)
277{
278 struct mptcp_sock *msk = mptcp_sk(sk);
279 struct mptcp_data_frag *cur;
280
281 cur = msk->first_pending;
282 return list_is_last(&cur->list, &msk->rtx_queue) ? NULL :
283 list_next_entry(cur, list);
284}
285
286static inline struct mptcp_data_frag *mptcp_pending_tail(const struct sock *sk)
287{
288 struct mptcp_sock *msk = mptcp_sk(sk);
289
290 if (!msk->first_pending)
291 return NULL;
292
293 if (WARN_ON_ONCE(list_empty(&msk->rtx_queue)))
294 return NULL;
295
296 return list_last_entry(&msk->rtx_queue, struct mptcp_data_frag, list);
297}
298
Paolo Abeni18b683b2020-03-27 14:48:43 -0700299static inline struct mptcp_data_frag *mptcp_rtx_tail(const struct sock *sk)
300{
301 struct mptcp_sock *msk = mptcp_sk(sk);
302
Paolo Abenieaa2ffa2020-11-16 10:48:08 +0100303 if (!before64(msk->snd_nxt, atomic64_read(&msk->snd_una)))
Paolo Abeni18b683b2020-03-27 14:48:43 -0700304 return NULL;
305
306 return list_last_entry(&msk->rtx_queue, struct mptcp_data_frag, list);
307}
308
Florian Westphal7948f6c2020-03-27 14:48:46 -0700309static inline struct mptcp_data_frag *mptcp_rtx_head(const struct sock *sk)
310{
311 struct mptcp_sock *msk = mptcp_sk(sk);
312
Geliang Tanga386bc52020-06-15 16:34:28 +0800313 return list_first_entry_or_null(&msk->rtx_queue, struct mptcp_data_frag, list);
Florian Westphal7948f6c2020-03-27 14:48:46 -0700314}
315
Peter Krystadcec37a62020-01-21 16:56:18 -0800316struct mptcp_subflow_request_sock {
317 struct tcp_request_sock sk;
Christoph Paaschd22f4982020-01-21 16:56:32 -0800318 u16 mp_capable : 1,
Peter Krystadcec37a62020-01-21 16:56:18 -0800319 mp_join : 1,
Paolo Abenifca5c822020-04-20 16:25:06 +0200320 backup : 1;
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700321 u8 local_id;
Peter Krystadf2962342020-03-27 14:48:39 -0700322 u8 remote_id;
Peter Krystadcec37a62020-01-21 16:56:18 -0800323 u64 local_key;
Peter Krystad79c09492020-01-21 16:56:20 -0800324 u64 idsn;
325 u32 token;
Mat Martineau648ef4b2020-01-21 16:56:24 -0800326 u32 ssn_offset;
Peter Krystadf2962342020-03-27 14:48:39 -0700327 u64 thmac;
328 u32 local_nonce;
329 u32 remote_nonce;
Paolo Abeni8fd4de12020-06-17 12:08:56 +0200330 struct mptcp_sock *msk;
Paolo Abeni2c5ebd02020-06-26 19:30:00 +0200331 struct hlist_nulls_node token_node;
Peter Krystadcec37a62020-01-21 16:56:18 -0800332};
333
334static inline struct mptcp_subflow_request_sock *
335mptcp_subflow_rsk(const struct request_sock *rsk)
336{
337 return (struct mptcp_subflow_request_sock *)rsk;
338}
339
Paolo Abeni67193312020-09-14 10:01:09 +0200340enum mptcp_data_avail {
341 MPTCP_SUBFLOW_NODATA,
342 MPTCP_SUBFLOW_DATA_AVAIL,
343 MPTCP_SUBFLOW_OOO_DATA
344};
345
Peter Krystad2303f992020-01-21 16:56:17 -0800346/* MPTCP subflow context */
347struct mptcp_subflow_context {
Peter Krystadcec37a62020-01-21 16:56:18 -0800348 struct list_head node;/* conn_list of subflows */
349 u64 local_key;
350 u64 remote_key;
Peter Krystad79c09492020-01-21 16:56:20 -0800351 u64 idsn;
Mat Martineau648ef4b2020-01-21 16:56:24 -0800352 u64 map_seq;
Christoph Paaschcc7972e2020-01-21 16:56:31 -0800353 u32 snd_isn;
Peter Krystad79c09492020-01-21 16:56:20 -0800354 u32 token;
Mat Martineau6d0060f2020-01-21 16:56:23 -0800355 u32 rel_write_seq;
Mat Martineau648ef4b2020-01-21 16:56:24 -0800356 u32 map_subflow_seq;
357 u32 ssn_offset;
358 u32 map_data_len;
Peter Krystadcec37a62020-01-21 16:56:18 -0800359 u32 request_mptcp : 1, /* send MP_CAPABLE */
Peter Krystadec3edaa2020-03-27 14:48:40 -0700360 request_join : 1, /* send MP_JOIN */
361 request_bkup : 1,
Peter Krystadcec37a62020-01-21 16:56:18 -0800362 mp_capable : 1, /* remote is MPTCP capable */
Peter Krystadf2962342020-03-27 14:48:39 -0700363 mp_join : 1, /* remote is JOINing */
Paolo Abeni0be534f2020-03-19 11:06:30 +0100364 fully_established : 1, /* path validated */
Peter Krystadf2962342020-03-27 14:48:39 -0700365 pm_notified : 1, /* PM hook called for established status */
Mat Martineau648ef4b2020-01-21 16:56:24 -0800366 conn_finished : 1,
367 map_valid : 1,
Christoph Paaschd22f4982020-01-21 16:56:32 -0800368 mpc_map : 1,
Peter Krystadf2962342020-03-27 14:48:39 -0700369 backup : 1,
Christoph Paaschd22f4982020-01-21 16:56:32 -0800370 rx_eof : 1,
Paolo Abenie16163b2020-11-16 10:48:09 +0100371 can_ack : 1, /* only after processing the remote a key */
372 disposable : 1; /* ctx can be free at ulp release time */
Paolo Abeni67193312020-09-14 10:01:09 +0200373 enum mptcp_data_avail data_avail;
Peter Krystadf2962342020-03-27 14:48:39 -0700374 u32 remote_nonce;
375 u64 thmac;
376 u32 local_nonce;
Peter Krystadec3edaa2020-03-27 14:48:40 -0700377 u32 remote_token;
378 u8 hmac[MPTCPOPT_HMAC_LEN];
Peter Krystadf2962342020-03-27 14:48:39 -0700379 u8 local_id;
380 u8 remote_id;
Mat Martineau648ef4b2020-01-21 16:56:24 -0800381
Peter Krystad2303f992020-01-21 16:56:17 -0800382 struct sock *tcp_sock; /* tcp sk backpointer */
383 struct sock *conn; /* parent mptcp_sock */
Peter Krystadcec37a62020-01-21 16:56:18 -0800384 const struct inet_connection_sock_af_ops *icsk_af_ops;
Mat Martineau648ef4b2020-01-21 16:56:24 -0800385 void (*tcp_data_ready)(struct sock *sk);
386 void (*tcp_state_change)(struct sock *sk);
387 void (*tcp_write_space)(struct sock *sk);
388
Peter Krystad2303f992020-01-21 16:56:17 -0800389 struct rcu_head rcu;
390};
391
392static inline struct mptcp_subflow_context *
393mptcp_subflow_ctx(const struct sock *sk)
394{
395 struct inet_connection_sock *icsk = inet_csk(sk);
396
397 /* Use RCU on icsk_ulp_data only for sock diag code */
398 return (__force struct mptcp_subflow_context *)icsk->icsk_ulp_data;
399}
400
401static inline struct sock *
402mptcp_subflow_tcp_sock(const struct mptcp_subflow_context *subflow)
403{
404 return subflow->tcp_sock;
405}
406
Mat Martineau648ef4b2020-01-21 16:56:24 -0800407static inline u64
408mptcp_subflow_get_map_offset(const struct mptcp_subflow_context *subflow)
409{
410 return tcp_sk(mptcp_subflow_tcp_sock(subflow))->copied_seq -
411 subflow->ssn_offset -
412 subflow->map_subflow_seq;
413}
414
415static inline u64
416mptcp_subflow_get_mapped_dsn(const struct mptcp_subflow_context *subflow)
417{
418 return subflow->map_seq + mptcp_subflow_get_map_offset(subflow);
419}
420
Paolo Abeni0397c6d2020-11-19 11:45:58 -0800421static inline void mptcp_add_pending_subflow(struct mptcp_sock *msk,
422 struct mptcp_subflow_context *subflow)
423{
424 sock_hold(mptcp_subflow_tcp_sock(subflow));
425 spin_lock_bh(&msk->join_list_lock);
426 list_add_tail(&subflow->node, &msk->join_list);
427 spin_unlock_bh(&msk->join_list_lock);
428}
429
Mat Martineau648ef4b2020-01-21 16:56:24 -0800430int mptcp_is_enabled(struct net *net);
Geliang Tang93f323b2020-11-03 11:05:07 -0800431unsigned int mptcp_get_add_addr_timeout(struct net *net);
Paolo Abenib93df082020-07-23 13:02:32 +0200432void mptcp_subflow_fully_established(struct mptcp_subflow_context *subflow,
433 struct mptcp_options_received *mp_opt);
Mat Martineau648ef4b2020-01-21 16:56:24 -0800434bool mptcp_subflow_data_available(struct sock *sk);
Paolo Abenid39dcec2020-06-26 19:29:59 +0200435void __init mptcp_subflow_init(void);
Geliang Tangd0876b22020-09-24 08:29:49 +0800436void mptcp_subflow_shutdown(struct sock *sk, struct sock *ssk, int how);
437void __mptcp_close_ssk(struct sock *sk, struct sock *ssk,
Paolo Abenie16163b2020-11-16 10:48:09 +0100438 struct mptcp_subflow_context *subflow);
Paolo Abenid5824842020-10-09 19:00:00 +0200439void mptcp_subflow_reset(struct sock *ssk);
Peter Krystadec3edaa2020-03-27 14:48:40 -0700440
441/* called with sk socket lock held */
Paolo Abenief0da3b2020-09-14 10:01:15 +0200442int __mptcp_subflow_connect(struct sock *sk, const struct mptcp_addr_info *loc,
Peter Krystadec3edaa2020-03-27 14:48:40 -0700443 const struct mptcp_addr_info *remote);
Peter Krystad2303f992020-01-21 16:56:17 -0800444int mptcp_subflow_create_socket(struct sock *sk, struct socket **new_sock);
445
Mat Martineau648ef4b2020-01-21 16:56:24 -0800446static inline void mptcp_subflow_tcp_fallback(struct sock *sk,
447 struct mptcp_subflow_context *ctx)
448{
449 sk->sk_data_ready = ctx->tcp_data_ready;
450 sk->sk_state_change = ctx->tcp_state_change;
451 sk->sk_write_space = ctx->tcp_write_space;
452
453 inet_csk(sk)->icsk_af_ops = ctx->icsk_af_ops;
454}
455
Paolo Abenid39dcec2020-06-26 19:29:59 +0200456void __init mptcp_proto_init(void);
Matthieu Baerts784325e2020-01-21 16:56:28 -0800457#if IS_ENABLED(CONFIG_MPTCP_IPV6)
Paolo Abenid39dcec2020-06-26 19:29:59 +0200458int __init mptcp_proto_v6_init(void);
Matthieu Baerts784325e2020-01-21 16:56:28 -0800459#endif
Mat Martineau648ef4b2020-01-21 16:56:24 -0800460
Paolo Abenifca5c822020-04-20 16:25:06 +0200461struct sock *mptcp_sk_clone(const struct sock *sk,
Paolo Abenicfde1412020-04-30 15:01:52 +0200462 const struct mptcp_options_received *mp_opt,
Paolo Abenifca5c822020-04-20 16:25:06 +0200463 struct request_sock *req);
Peter Krystadcec37a62020-01-21 16:56:18 -0800464void mptcp_get_options(const struct sk_buff *skb,
Paolo Abenicfde1412020-04-30 15:01:52 +0200465 struct mptcp_options_received *mp_opt);
Peter Krystadcec37a62020-01-21 16:56:18 -0800466
467void mptcp_finish_connect(struct sock *sk);
Paolo Abenib93df082020-07-23 13:02:32 +0200468static inline bool mptcp_is_fully_established(struct sock *sk)
469{
470 return inet_sk_state_load(sk) == TCP_ESTABLISHED &&
471 READ_ONCE(mptcp_sk(sk)->fully_established);
472}
Florian Westphala6b118f2020-06-30 21:24:45 +0200473void mptcp_rcv_space_init(struct mptcp_sock *msk, const struct sock *ssk);
Florian Westphal2e522132020-02-26 10:14:51 +0100474void mptcp_data_ready(struct sock *sk, struct sock *ssk);
Peter Krystadf2962342020-03-27 14:48:39 -0700475bool mptcp_finish_join(struct sock *sk);
Paolo Abeniba8f48f2020-11-16 10:48:05 +0100476bool mptcp_schedule_work(struct sock *sk);
Paolo Abenib51f9b82020-03-27 14:48:44 -0700477void mptcp_data_acked(struct sock *sk);
Florian Westphal59832e22020-04-02 13:44:52 +0200478void mptcp_subflow_eof(struct sock *sk);
Mat Martineau1a49b2c2020-09-29 15:08:20 -0700479bool mptcp_update_rcv_data_fin(struct mptcp_sock *msk, u64 data_fin_seq, bool use_64bit);
Geliang Tang84dfe362020-11-19 11:46:00 -0800480void __mptcp_flush_join_list(struct mptcp_sock *msk);
Paolo Abenie16163b2020-11-16 10:48:09 +0100481static inline bool mptcp_data_fin_enabled(const struct mptcp_sock *msk)
482{
483 return READ_ONCE(msk->snd_data_fin_enable) &&
484 READ_ONCE(msk->write_seq) == READ_ONCE(msk->snd_nxt);
485}
486
Geliang Tang5c8c1642020-09-24 08:29:57 +0800487void mptcp_destroy_common(struct mptcp_sock *msk);
Peter Krystadcec37a62020-01-21 16:56:18 -0800488
Paolo Abeni2c5ebd02020-06-26 19:30:00 +0200489void __init mptcp_token_init(void);
490static inline void mptcp_token_init_request(struct request_sock *req)
491{
492 mptcp_subflow_rsk(req)->token_node.pprev = NULL;
493}
494
Peter Krystad79c09492020-01-21 16:56:20 -0800495int mptcp_token_new_request(struct request_sock *req);
Paolo Abeni2c5ebd02020-06-26 19:30:00 +0200496void mptcp_token_destroy_request(struct request_sock *req);
Peter Krystad79c09492020-01-21 16:56:20 -0800497int mptcp_token_new_connect(struct sock *sk);
Paolo Abeni2c5ebd02020-06-26 19:30:00 +0200498void mptcp_token_accept(struct mptcp_subflow_request_sock *r,
499 struct mptcp_sock *msk);
Florian Westphalc83a47e2020-07-30 21:25:54 +0200500bool mptcp_token_exists(u32 token);
Peter Krystadf2962342020-03-27 14:48:39 -0700501struct mptcp_sock *mptcp_token_get_sock(u32 token);
Paolo Abeni96d890d2020-07-09 15:12:40 +0200502struct mptcp_sock *mptcp_token_iter_next(const struct net *net, long *s_slot,
503 long *s_num);
Paolo Abeni2c5ebd02020-06-26 19:30:00 +0200504void mptcp_token_destroy(struct mptcp_sock *msk);
Peter Krystad79c09492020-01-21 16:56:20 -0800505
506void mptcp_crypto_key_sha(u64 key, u32 *token, u64 *idsn);
Peter Krystad79c09492020-01-21 16:56:20 -0800507
Peter Krystad3df523a2020-03-27 14:48:37 -0700508void mptcp_crypto_hmac_sha(u64 key1, u64 key2, u8 *msg, int len, void *hmac);
Peter Krystad79c09492020-01-21 16:56:20 -0800509
Paolo Abenid39dcec2020-06-26 19:29:59 +0200510void __init mptcp_pm_init(void);
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700511void mptcp_pm_data_init(struct mptcp_sock *msk);
512void mptcp_pm_new_connection(struct mptcp_sock *msk, int server_side);
513void mptcp_pm_fully_established(struct mptcp_sock *msk);
514bool mptcp_pm_allow_new_subflow(struct mptcp_sock *msk);
515void mptcp_pm_connection_closed(struct mptcp_sock *msk);
516void mptcp_pm_subflow_established(struct mptcp_sock *msk,
517 struct mptcp_subflow_context *subflow);
518void mptcp_pm_subflow_closed(struct mptcp_sock *msk, u8 id);
519void mptcp_pm_add_addr_received(struct mptcp_sock *msk,
520 const struct mptcp_addr_info *addr);
Geliang Tang84dfe362020-11-19 11:46:00 -0800521void mptcp_pm_add_addr_send_ack(struct mptcp_sock *msk);
Geliang Tangd0876b22020-09-24 08:29:49 +0800522void mptcp_pm_rm_addr_received(struct mptcp_sock *msk, u8 rm_id);
Geliang Tangb6c08382020-09-24 08:29:54 +0800523void mptcp_pm_free_anno_list(struct mptcp_sock *msk);
Geliang Tang00cfd772020-09-24 08:30:02 +0800524struct mptcp_pm_add_entry *
525mptcp_pm_del_add_timer(struct mptcp_sock *msk,
526 struct mptcp_addr_info *addr);
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700527
528int mptcp_pm_announce_addr(struct mptcp_sock *msk,
Geliang Tang6a6c05a2020-09-24 08:29:50 +0800529 const struct mptcp_addr_info *addr,
530 bool echo);
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700531int mptcp_pm_remove_addr(struct mptcp_sock *msk, u8 local_id);
Geliang Tang0ee42612020-09-24 08:29:55 +0800532int mptcp_pm_remove_subflow(struct mptcp_sock *msk, u8 local_id);
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700533
Geliang Tangf643b802020-09-24 08:29:47 +0800534static inline bool mptcp_pm_should_add_signal(struct mptcp_sock *msk)
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700535{
Geliang Tangd91d3222020-11-19 11:45:59 -0800536 return READ_ONCE(msk->pm.add_addr_signal) & BIT(MPTCP_ADD_ADDR_SIGNAL);
537}
538
539static inline bool mptcp_pm_should_add_signal_echo(struct mptcp_sock *msk)
540{
541 return READ_ONCE(msk->pm.add_addr_signal) & BIT(MPTCP_ADD_ADDR_ECHO);
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700542}
543
Geliang Tang84dfe362020-11-19 11:46:00 -0800544static inline bool mptcp_pm_should_add_signal_ipv6(struct mptcp_sock *msk)
545{
546 return READ_ONCE(msk->pm.add_addr_signal) & BIT(MPTCP_ADD_ADDR_IPV6);
547}
548
Geliang Tang5cb104a2020-09-24 08:29:48 +0800549static inline bool mptcp_pm_should_rm_signal(struct mptcp_sock *msk)
550{
551 return READ_ONCE(msk->pm.rm_addr_signal);
552}
553
Matthieu Baerts456afe02020-10-03 17:36:56 +0200554static inline unsigned int mptcp_add_addr_len(int family, bool echo)
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700555{
556 if (family == AF_INET)
Matthieu Baerts456afe02020-10-03 17:36:56 +0200557 return echo ? TCPOLEN_MPTCP_ADD_ADDR_BASE
558 : TCPOLEN_MPTCP_ADD_ADDR;
559 return echo ? TCPOLEN_MPTCP_ADD_ADDR6_BASE : TCPOLEN_MPTCP_ADD_ADDR6;
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700560}
561
Geliang Tangf643b802020-09-24 08:29:47 +0800562bool mptcp_pm_add_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
Geliang Tang6a6c05a2020-09-24 08:29:50 +0800563 struct mptcp_addr_info *saddr, bool *echo);
Geliang Tang5cb104a2020-09-24 08:29:48 +0800564bool mptcp_pm_rm_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
565 u8 *rm_id);
Peter Krystad1b1c7a02020-03-27 14:48:38 -0700566int mptcp_pm_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
567
Paolo Abenid39dcec2020-06-26 19:29:59 +0200568void __init mptcp_pm_nl_init(void);
Paolo Abeni01cacb02020-03-27 14:48:51 -0700569void mptcp_pm_nl_data_init(struct mptcp_sock *msk);
570void mptcp_pm_nl_fully_established(struct mptcp_sock *msk);
571void mptcp_pm_nl_subflow_established(struct mptcp_sock *msk);
572void mptcp_pm_nl_add_addr_received(struct mptcp_sock *msk);
Geliang Tang84dfe362020-11-19 11:46:00 -0800573void mptcp_pm_nl_add_addr_send_ack(struct mptcp_sock *msk);
Geliang Tangd0876b22020-09-24 08:29:49 +0800574void mptcp_pm_nl_rm_addr_received(struct mptcp_sock *msk);
Geliang Tang0ee42612020-09-24 08:29:55 +0800575void mptcp_pm_nl_rm_subflow_received(struct mptcp_sock *msk, u8 rm_id);
Paolo Abeni01cacb02020-03-27 14:48:51 -0700576int mptcp_pm_nl_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
577
Mat Martineau6d0060f2020-01-21 16:56:23 -0800578static inline struct mptcp_ext *mptcp_get_ext(struct sk_buff *skb)
579{
580 return (struct mptcp_ext *)skb_ext_find(skb, SKB_EXT_MPTCP);
581}
582
Davide Caratti5147dfb2020-03-27 14:48:49 -0700583void mptcp_diag_subflow_init(struct tcp_ulp_ops *ops);
584
Paolo Abenid5f49192020-09-14 10:01:17 +0200585static inline bool __mptcp_check_fallback(const struct mptcp_sock *msk)
Davide Carattie1ff9e82020-06-29 22:26:20 +0200586{
587 return test_bit(MPTCP_FALLBACK_DONE, &msk->flags);
588}
589
Paolo Abenid5f49192020-09-14 10:01:17 +0200590static inline bool mptcp_check_fallback(const struct sock *sk)
Davide Carattie1ff9e82020-06-29 22:26:20 +0200591{
592 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
593 struct mptcp_sock *msk = mptcp_sk(subflow->conn);
594
595 return __mptcp_check_fallback(msk);
596}
597
598static inline void __mptcp_do_fallback(struct mptcp_sock *msk)
599{
600 if (test_bit(MPTCP_FALLBACK_DONE, &msk->flags)) {
601 pr_debug("TCP fallback already done (msk=%p)", msk);
602 return;
603 }
604 set_bit(MPTCP_FALLBACK_DONE, &msk->flags);
605}
606
607static inline void mptcp_do_fallback(struct sock *sk)
608{
609 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
610 struct mptcp_sock *msk = mptcp_sk(subflow->conn);
611
612 __mptcp_do_fallback(msk);
613}
614
615#define pr_fallback(a) pr_debug("%s:fallback to TCP (msk=%p)", __func__, a)
616
Davide Caratti8fd73802020-06-29 22:26:21 +0200617static inline bool subflow_simultaneous_connect(struct sock *sk)
618{
619 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
620 struct sock *parent = subflow->conn;
621
622 return sk->sk_state == TCP_ESTABLISHED &&
623 !mptcp_sk(parent)->pm.server_side &&
624 !subflow->conn_finished;
625}
626
Florian Westphal9466a1c2020-07-30 21:25:56 +0200627#ifdef CONFIG_SYN_COOKIES
628void subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
629 struct sk_buff *skb);
630bool mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
631 struct sk_buff *skb);
632void __init mptcp_join_cookie_init(void);
633#else
634static inline void
635subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
636 struct sk_buff *skb) {}
637static inline bool
638mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
639 struct sk_buff *skb)
640{
641 return false;
642}
643
644static inline void mptcp_join_cookie_init(void) {}
645#endif
646
Mat Martineauf870fa02020-01-21 16:56:15 -0800647#endif /* __MPTCP_PROTOCOL_H */