xref: /openbmc/linux/net/mptcp/protocol.h (revision 6a143a7c)
1 /* 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 
10 #include <linux/random.h>
11 #include <net/tcp.h>
12 #include <net/inet_connection_sock.h>
13 #include <uapi/linux/mptcp.h>
14 
15 #define MPTCP_SUPPORTED_VERSION	1
16 
17 /* MPTCP option bits */
18 #define OPTION_MPTCP_MPC_SYN	BIT(0)
19 #define OPTION_MPTCP_MPC_SYNACK	BIT(1)
20 #define OPTION_MPTCP_MPC_ACK	BIT(2)
21 #define OPTION_MPTCP_MPJ_SYN	BIT(3)
22 #define OPTION_MPTCP_MPJ_SYNACK	BIT(4)
23 #define OPTION_MPTCP_MPJ_ACK	BIT(5)
24 #define OPTION_MPTCP_ADD_ADDR	BIT(6)
25 #define OPTION_MPTCP_ADD_ADDR6	BIT(7)
26 #define OPTION_MPTCP_RM_ADDR	BIT(8)
27 #define OPTION_MPTCP_FASTCLOSE	BIT(9)
28 #define OPTION_MPTCP_PRIO	BIT(10)
29 
30 /* MPTCP option subtypes */
31 #define MPTCPOPT_MP_CAPABLE	0
32 #define MPTCPOPT_MP_JOIN	1
33 #define MPTCPOPT_DSS		2
34 #define MPTCPOPT_ADD_ADDR	3
35 #define MPTCPOPT_RM_ADDR	4
36 #define MPTCPOPT_MP_PRIO	5
37 #define MPTCPOPT_MP_FAIL	6
38 #define MPTCPOPT_MP_FASTCLOSE	7
39 
40 /* MPTCP suboption lengths */
41 #define TCPOLEN_MPTCP_MPC_SYN		4
42 #define TCPOLEN_MPTCP_MPC_SYNACK	12
43 #define TCPOLEN_MPTCP_MPC_ACK		20
44 #define TCPOLEN_MPTCP_MPC_ACK_DATA	22
45 #define TCPOLEN_MPTCP_MPJ_SYN		12
46 #define TCPOLEN_MPTCP_MPJ_SYNACK	16
47 #define TCPOLEN_MPTCP_MPJ_ACK		24
48 #define TCPOLEN_MPTCP_DSS_BASE		4
49 #define TCPOLEN_MPTCP_DSS_ACK32		4
50 #define TCPOLEN_MPTCP_DSS_ACK64		8
51 #define TCPOLEN_MPTCP_DSS_MAP32		10
52 #define TCPOLEN_MPTCP_DSS_MAP64		14
53 #define TCPOLEN_MPTCP_DSS_CHECKSUM	2
54 #define TCPOLEN_MPTCP_ADD_ADDR		16
55 #define TCPOLEN_MPTCP_ADD_ADDR_PORT	18
56 #define TCPOLEN_MPTCP_ADD_ADDR_BASE	8
57 #define TCPOLEN_MPTCP_ADD_ADDR_BASE_PORT	10
58 #define TCPOLEN_MPTCP_ADD_ADDR6		28
59 #define TCPOLEN_MPTCP_ADD_ADDR6_PORT	30
60 #define TCPOLEN_MPTCP_ADD_ADDR6_BASE	20
61 #define TCPOLEN_MPTCP_ADD_ADDR6_BASE_PORT	22
62 #define TCPOLEN_MPTCP_PORT_LEN		2
63 #define TCPOLEN_MPTCP_PORT_ALIGN	2
64 #define TCPOLEN_MPTCP_RM_ADDR_BASE	3
65 #define TCPOLEN_MPTCP_PRIO		3
66 #define TCPOLEN_MPTCP_PRIO_ALIGN	4
67 #define TCPOLEN_MPTCP_FASTCLOSE		12
68 
69 /* MPTCP MP_JOIN flags */
70 #define MPTCPOPT_BACKUP		BIT(0)
71 #define MPTCPOPT_HMAC_LEN	20
72 #define MPTCPOPT_THMAC_LEN	8
73 
74 /* MPTCP MP_CAPABLE flags */
75 #define MPTCP_VERSION_MASK	(0x0F)
76 #define MPTCP_CAP_CHECKSUM_REQD	BIT(7)
77 #define MPTCP_CAP_EXTENSIBILITY	BIT(6)
78 #define MPTCP_CAP_HMAC_SHA256	BIT(0)
79 #define MPTCP_CAP_FLAG_MASK	(0x3F)
80 
81 /* MPTCP DSS flags */
82 #define MPTCP_DSS_DATA_FIN	BIT(4)
83 #define MPTCP_DSS_DSN64		BIT(3)
84 #define MPTCP_DSS_HAS_MAP	BIT(2)
85 #define MPTCP_DSS_ACK64		BIT(1)
86 #define MPTCP_DSS_HAS_ACK	BIT(0)
87 #define MPTCP_DSS_FLAG_MASK	(0x1F)
88 
89 /* MPTCP ADD_ADDR flags */
90 #define MPTCP_ADDR_ECHO		BIT(0)
91 #define MPTCP_ADDR_IPVERSION_4	4
92 #define MPTCP_ADDR_IPVERSION_6	6
93 
94 /* MPTCP MP_PRIO flags */
95 #define MPTCP_PRIO_BKUP		BIT(0)
96 
97 /* MPTCP socket flags */
98 #define MPTCP_DATA_READY	0
99 #define MPTCP_NOSPACE		1
100 #define MPTCP_WORK_RTX		2
101 #define MPTCP_WORK_EOF		3
102 #define MPTCP_FALLBACK_DONE	4
103 #define MPTCP_WORK_CLOSE_SUBFLOW 5
104 #define MPTCP_PUSH_PENDING	6
105 #define MPTCP_CLEAN_UNA		7
106 #define MPTCP_ERROR_REPORT	8
107 
108 static inline bool before64(__u64 seq1, __u64 seq2)
109 {
110 	return (__s64)(seq1 - seq2) < 0;
111 }
112 
113 #define after64(seq2, seq1)	before64(seq1, seq2)
114 
115 struct mptcp_options_received {
116 	u64	sndr_key;
117 	u64	rcvr_key;
118 	u64	data_ack;
119 	u64	data_seq;
120 	u32	subflow_seq;
121 	u16	data_len;
122 	u16	mp_capable : 1,
123 		mp_join : 1,
124 		fastclose : 1,
125 		dss : 1,
126 		add_addr : 1,
127 		rm_addr : 1,
128 		mp_prio : 1,
129 		family : 4,
130 		echo : 1,
131 		backup : 1;
132 	u32	token;
133 	u32	nonce;
134 	u64	thmac;
135 	u8	hmac[MPTCPOPT_HMAC_LEN];
136 	u8	join_id;
137 	u8	use_map:1,
138 		dsn64:1,
139 		data_fin:1,
140 		use_ack:1,
141 		ack64:1,
142 		mpc_map:1,
143 		__unused:2;
144 	u8	addr_id;
145 	struct mptcp_rm_list rm_list;
146 	union {
147 		struct in_addr	addr;
148 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
149 		struct in6_addr	addr6;
150 #endif
151 	};
152 	u64	ahmac;
153 	u16	port;
154 };
155 
156 static inline __be32 mptcp_option(u8 subopt, u8 len, u8 nib, u8 field)
157 {
158 	return htonl((TCPOPT_MPTCP << 24) | (len << 16) | (subopt << 12) |
159 		     ((nib & 0xF) << 8) | field);
160 }
161 
162 struct mptcp_addr_info {
163 	sa_family_t		family;
164 	__be16			port;
165 	u8			id;
166 	u8			flags;
167 	int			ifindex;
168 	union {
169 		struct in_addr addr;
170 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
171 		struct in6_addr addr6;
172 #endif
173 	};
174 };
175 
176 enum mptcp_pm_status {
177 	MPTCP_PM_ADD_ADDR_RECEIVED,
178 	MPTCP_PM_ADD_ADDR_SEND_ACK,
179 	MPTCP_PM_RM_ADDR_RECEIVED,
180 	MPTCP_PM_ESTABLISHED,
181 	MPTCP_PM_ALREADY_ESTABLISHED,	/* persistent status, set after ESTABLISHED event */
182 	MPTCP_PM_SUBFLOW_ESTABLISHED,
183 };
184 
185 enum mptcp_addr_signal_status {
186 	MPTCP_ADD_ADDR_SIGNAL,
187 	MPTCP_ADD_ADDR_ECHO,
188 	MPTCP_ADD_ADDR_IPV6,
189 	MPTCP_ADD_ADDR_PORT,
190 	MPTCP_RM_ADDR_SIGNAL,
191 };
192 
193 struct mptcp_pm_data {
194 	struct mptcp_addr_info local;
195 	struct mptcp_addr_info remote;
196 	struct list_head anno_list;
197 
198 	spinlock_t	lock;		/*protects the whole PM data */
199 
200 	u8		addr_signal;
201 	bool		server_side;
202 	bool		work_pending;
203 	bool		accept_addr;
204 	bool		accept_subflow;
205 	u8		add_addr_signaled;
206 	u8		add_addr_accepted;
207 	u8		local_addr_used;
208 	u8		subflows;
209 	u8		status;
210 	struct mptcp_rm_list rm_list_tx;
211 	struct mptcp_rm_list rm_list_rx;
212 };
213 
214 struct mptcp_data_frag {
215 	struct list_head list;
216 	u64 data_seq;
217 	u16 data_len;
218 	u16 offset;
219 	u16 overhead;
220 	u16 already_sent;
221 	struct page *page;
222 };
223 
224 /* MPTCP connection sock */
225 struct mptcp_sock {
226 	/* inet_connection_sock must be the first member */
227 	struct inet_connection_sock sk;
228 	u64		local_key;
229 	u64		remote_key;
230 	u64		write_seq;
231 	u64		snd_nxt;
232 	u64		ack_seq;
233 	u64		rcv_wnd_sent;
234 	u64		rcv_data_fin_seq;
235 	int		wmem_reserved;
236 	struct sock	*last_snd;
237 	int		snd_burst;
238 	int		old_wspace;
239 	u64		snd_una;
240 	u64		wnd_end;
241 	unsigned long	timer_ival;
242 	u32		token;
243 	int		rmem_released;
244 	unsigned long	flags;
245 	bool		can_ack;
246 	bool		fully_established;
247 	bool		rcv_data_fin;
248 	bool		snd_data_fin_enable;
249 	bool		rcv_fastclose;
250 	bool		use_64bit_ack; /* Set when we received a 64-bit DSN */
251 	spinlock_t	join_list_lock;
252 	struct sock	*ack_hint;
253 	struct work_struct work;
254 	struct sk_buff  *ooo_last_skb;
255 	struct rb_root  out_of_order_queue;
256 	struct sk_buff_head receive_queue;
257 	struct sk_buff_head skb_tx_cache;	/* this is wmem accounted */
258 	int		tx_pending_data;
259 	int		size_goal_cache;
260 	struct list_head conn_list;
261 	struct list_head rtx_queue;
262 	struct mptcp_data_frag *first_pending;
263 	struct list_head join_list;
264 	struct socket	*subflow; /* outgoing connect/listener/!mp_capable */
265 	struct sock	*first;
266 	struct mptcp_pm_data	pm;
267 	struct {
268 		u32	space;	/* bytes copied in last measurement window */
269 		u32	copied; /* bytes copied in this measurement window */
270 		u64	time;	/* start time of measurement window */
271 		u64	rtt_us; /* last maximum rtt of subflows */
272 	} rcvq_space;
273 };
274 
275 #define mptcp_lock_sock(___sk, cb) do {					\
276 	struct sock *__sk = (___sk); /* silence macro reuse warning */	\
277 	might_sleep();							\
278 	spin_lock_bh(&__sk->sk_lock.slock);				\
279 	if (__sk->sk_lock.owned)					\
280 		__lock_sock(__sk);					\
281 	cb;								\
282 	__sk->sk_lock.owned = 1;					\
283 	spin_unlock(&__sk->sk_lock.slock);				\
284 	mutex_acquire(&__sk->sk_lock.dep_map, 0, 0, _RET_IP_);		\
285 	local_bh_enable();						\
286 } while (0)
287 
288 #define mptcp_data_lock(sk) spin_lock_bh(&(sk)->sk_lock.slock)
289 #define mptcp_data_unlock(sk) spin_unlock_bh(&(sk)->sk_lock.slock)
290 
291 #define mptcp_for_each_subflow(__msk, __subflow)			\
292 	list_for_each_entry(__subflow, &((__msk)->conn_list), node)
293 
294 static inline void msk_owned_by_me(const struct mptcp_sock *msk)
295 {
296 	sock_owned_by_me((const struct sock *)msk);
297 }
298 
299 static inline struct mptcp_sock *mptcp_sk(const struct sock *sk)
300 {
301 	return (struct mptcp_sock *)sk;
302 }
303 
304 static inline int __mptcp_space(const struct sock *sk)
305 {
306 	return tcp_space(sk) + READ_ONCE(mptcp_sk(sk)->rmem_released);
307 }
308 
309 static inline struct mptcp_data_frag *mptcp_send_head(const struct sock *sk)
310 {
311 	const struct mptcp_sock *msk = mptcp_sk(sk);
312 
313 	return READ_ONCE(msk->first_pending);
314 }
315 
316 static inline struct mptcp_data_frag *mptcp_send_next(struct sock *sk)
317 {
318 	struct mptcp_sock *msk = mptcp_sk(sk);
319 	struct mptcp_data_frag *cur;
320 
321 	cur = msk->first_pending;
322 	return list_is_last(&cur->list, &msk->rtx_queue) ? NULL :
323 						     list_next_entry(cur, list);
324 }
325 
326 static inline struct mptcp_data_frag *mptcp_pending_tail(const struct sock *sk)
327 {
328 	struct mptcp_sock *msk = mptcp_sk(sk);
329 
330 	if (!msk->first_pending)
331 		return NULL;
332 
333 	if (WARN_ON_ONCE(list_empty(&msk->rtx_queue)))
334 		return NULL;
335 
336 	return list_last_entry(&msk->rtx_queue, struct mptcp_data_frag, list);
337 }
338 
339 static inline struct mptcp_data_frag *mptcp_rtx_head(const struct sock *sk)
340 {
341 	struct mptcp_sock *msk = mptcp_sk(sk);
342 
343 	if (msk->snd_una == READ_ONCE(msk->snd_nxt))
344 		return NULL;
345 
346 	return list_first_entry_or_null(&msk->rtx_queue, struct mptcp_data_frag, list);
347 }
348 
349 struct mptcp_subflow_request_sock {
350 	struct	tcp_request_sock sk;
351 	u16	mp_capable : 1,
352 		mp_join : 1,
353 		backup : 1;
354 	u8	local_id;
355 	u8	remote_id;
356 	u64	local_key;
357 	u64	idsn;
358 	u32	token;
359 	u32	ssn_offset;
360 	u64	thmac;
361 	u32	local_nonce;
362 	u32	remote_nonce;
363 	struct mptcp_sock	*msk;
364 	struct hlist_nulls_node token_node;
365 };
366 
367 static inline struct mptcp_subflow_request_sock *
368 mptcp_subflow_rsk(const struct request_sock *rsk)
369 {
370 	return (struct mptcp_subflow_request_sock *)rsk;
371 }
372 
373 enum mptcp_data_avail {
374 	MPTCP_SUBFLOW_NODATA,
375 	MPTCP_SUBFLOW_DATA_AVAIL,
376 	MPTCP_SUBFLOW_OOO_DATA
377 };
378 
379 struct mptcp_delegated_action {
380 	struct napi_struct napi;
381 	struct list_head head;
382 };
383 
384 DECLARE_PER_CPU(struct mptcp_delegated_action, mptcp_delegated_actions);
385 
386 #define MPTCP_DELEGATE_SEND		0
387 
388 /* MPTCP subflow context */
389 struct mptcp_subflow_context {
390 	struct	list_head node;/* conn_list of subflows */
391 	u64	local_key;
392 	u64	remote_key;
393 	u64	idsn;
394 	u64	map_seq;
395 	u32	snd_isn;
396 	u32	token;
397 	u32	rel_write_seq;
398 	u32	map_subflow_seq;
399 	u32	ssn_offset;
400 	u32	map_data_len;
401 	u32	request_mptcp : 1,  /* send MP_CAPABLE */
402 		request_join : 1,   /* send MP_JOIN */
403 		request_bkup : 1,
404 		mp_capable : 1,	    /* remote is MPTCP capable */
405 		mp_join : 1,	    /* remote is JOINing */
406 		fully_established : 1,	    /* path validated */
407 		pm_notified : 1,    /* PM hook called for established status */
408 		conn_finished : 1,
409 		map_valid : 1,
410 		mpc_map : 1,
411 		backup : 1,
412 		send_mp_prio : 1,
413 		rx_eof : 1,
414 		can_ack : 1,        /* only after processing the remote a key */
415 		disposable : 1;	    /* ctx can be free at ulp release time */
416 	enum mptcp_data_avail data_avail;
417 	u32	remote_nonce;
418 	u64	thmac;
419 	u32	local_nonce;
420 	u32	remote_token;
421 	u8	hmac[MPTCPOPT_HMAC_LEN];
422 	u8	local_id;
423 	u8	remote_id;
424 
425 	long	delegated_status;
426 	struct	list_head delegated_node;   /* link into delegated_action, protected by local BH */
427 
428 	struct	sock *tcp_sock;	    /* tcp sk backpointer */
429 	struct	sock *conn;	    /* parent mptcp_sock */
430 	const	struct inet_connection_sock_af_ops *icsk_af_ops;
431 	void	(*tcp_data_ready)(struct sock *sk);
432 	void	(*tcp_state_change)(struct sock *sk);
433 	void	(*tcp_write_space)(struct sock *sk);
434 	void	(*tcp_error_report)(struct sock *sk);
435 
436 	struct	rcu_head rcu;
437 };
438 
439 static inline struct mptcp_subflow_context *
440 mptcp_subflow_ctx(const struct sock *sk)
441 {
442 	struct inet_connection_sock *icsk = inet_csk(sk);
443 
444 	/* Use RCU on icsk_ulp_data only for sock diag code */
445 	return (__force struct mptcp_subflow_context *)icsk->icsk_ulp_data;
446 }
447 
448 static inline struct sock *
449 mptcp_subflow_tcp_sock(const struct mptcp_subflow_context *subflow)
450 {
451 	return subflow->tcp_sock;
452 }
453 
454 static inline u64
455 mptcp_subflow_get_map_offset(const struct mptcp_subflow_context *subflow)
456 {
457 	return tcp_sk(mptcp_subflow_tcp_sock(subflow))->copied_seq -
458 		      subflow->ssn_offset -
459 		      subflow->map_subflow_seq;
460 }
461 
462 static inline u64
463 mptcp_subflow_get_mapped_dsn(const struct mptcp_subflow_context *subflow)
464 {
465 	return subflow->map_seq + mptcp_subflow_get_map_offset(subflow);
466 }
467 
468 static inline void mptcp_add_pending_subflow(struct mptcp_sock *msk,
469 					     struct mptcp_subflow_context *subflow)
470 {
471 	sock_hold(mptcp_subflow_tcp_sock(subflow));
472 	spin_lock_bh(&msk->join_list_lock);
473 	list_add_tail(&subflow->node, &msk->join_list);
474 	spin_unlock_bh(&msk->join_list_lock);
475 }
476 
477 void mptcp_subflow_process_delegated(struct sock *ssk);
478 
479 static inline void mptcp_subflow_delegate(struct mptcp_subflow_context *subflow)
480 {
481 	struct mptcp_delegated_action *delegated;
482 	bool schedule;
483 
484 	/* The implied barrier pairs with mptcp_subflow_delegated_done(), and
485 	 * ensures the below list check sees list updates done prior to status
486 	 * bit changes
487 	 */
488 	if (!test_and_set_bit(MPTCP_DELEGATE_SEND, &subflow->delegated_status)) {
489 		/* still on delegated list from previous scheduling */
490 		if (!list_empty(&subflow->delegated_node))
491 			return;
492 
493 		/* the caller held the subflow bh socket lock */
494 		lockdep_assert_in_softirq();
495 
496 		delegated = this_cpu_ptr(&mptcp_delegated_actions);
497 		schedule = list_empty(&delegated->head);
498 		list_add_tail(&subflow->delegated_node, &delegated->head);
499 		sock_hold(mptcp_subflow_tcp_sock(subflow));
500 		if (schedule)
501 			napi_schedule(&delegated->napi);
502 	}
503 }
504 
505 static inline struct mptcp_subflow_context *
506 mptcp_subflow_delegated_next(struct mptcp_delegated_action *delegated)
507 {
508 	struct mptcp_subflow_context *ret;
509 
510 	if (list_empty(&delegated->head))
511 		return NULL;
512 
513 	ret = list_first_entry(&delegated->head, struct mptcp_subflow_context, delegated_node);
514 	list_del_init(&ret->delegated_node);
515 	return ret;
516 }
517 
518 static inline bool mptcp_subflow_has_delegated_action(const struct mptcp_subflow_context *subflow)
519 {
520 	return test_bit(MPTCP_DELEGATE_SEND, &subflow->delegated_status);
521 }
522 
523 static inline void mptcp_subflow_delegated_done(struct mptcp_subflow_context *subflow)
524 {
525 	/* pairs with mptcp_subflow_delegate, ensures delegate_node is updated before
526 	 * touching the status bit
527 	 */
528 	smp_wmb();
529 	clear_bit(MPTCP_DELEGATE_SEND, &subflow->delegated_status);
530 }
531 
532 int mptcp_is_enabled(struct net *net);
533 unsigned int mptcp_get_add_addr_timeout(struct net *net);
534 void mptcp_subflow_fully_established(struct mptcp_subflow_context *subflow,
535 				     struct mptcp_options_received *mp_opt);
536 bool mptcp_subflow_data_available(struct sock *sk);
537 void __init mptcp_subflow_init(void);
538 void mptcp_subflow_shutdown(struct sock *sk, struct sock *ssk, int how);
539 void mptcp_close_ssk(struct sock *sk, struct sock *ssk,
540 		     struct mptcp_subflow_context *subflow);
541 void mptcp_subflow_reset(struct sock *ssk);
542 void mptcp_sock_graft(struct sock *sk, struct socket *parent);
543 struct socket *__mptcp_nmpc_socket(const struct mptcp_sock *msk);
544 
545 /* called with sk socket lock held */
546 int __mptcp_subflow_connect(struct sock *sk, const struct mptcp_addr_info *loc,
547 			    const struct mptcp_addr_info *remote);
548 int mptcp_subflow_create_socket(struct sock *sk, struct socket **new_sock);
549 void mptcp_info2sockaddr(const struct mptcp_addr_info *info,
550 			 struct sockaddr_storage *addr,
551 			 unsigned short family);
552 
553 static inline void mptcp_subflow_tcp_fallback(struct sock *sk,
554 					      struct mptcp_subflow_context *ctx)
555 {
556 	sk->sk_data_ready = ctx->tcp_data_ready;
557 	sk->sk_state_change = ctx->tcp_state_change;
558 	sk->sk_write_space = ctx->tcp_write_space;
559 	sk->sk_error_report = ctx->tcp_error_report;
560 
561 	inet_csk(sk)->icsk_af_ops = ctx->icsk_af_ops;
562 }
563 
564 void __init mptcp_proto_init(void);
565 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
566 int __init mptcp_proto_v6_init(void);
567 #endif
568 
569 struct sock *mptcp_sk_clone(const struct sock *sk,
570 			    const struct mptcp_options_received *mp_opt,
571 			    struct request_sock *req);
572 void mptcp_get_options(const struct sk_buff *skb,
573 		       struct mptcp_options_received *mp_opt);
574 
575 void mptcp_finish_connect(struct sock *sk);
576 static inline bool mptcp_is_fully_established(struct sock *sk)
577 {
578 	return inet_sk_state_load(sk) == TCP_ESTABLISHED &&
579 	       READ_ONCE(mptcp_sk(sk)->fully_established);
580 }
581 void mptcp_rcv_space_init(struct mptcp_sock *msk, const struct sock *ssk);
582 void mptcp_data_ready(struct sock *sk, struct sock *ssk);
583 bool mptcp_finish_join(struct sock *sk);
584 bool mptcp_schedule_work(struct sock *sk);
585 void __mptcp_check_push(struct sock *sk, struct sock *ssk);
586 void __mptcp_data_acked(struct sock *sk);
587 void __mptcp_error_report(struct sock *sk);
588 void mptcp_subflow_eof(struct sock *sk);
589 bool mptcp_update_rcv_data_fin(struct mptcp_sock *msk, u64 data_fin_seq, bool use_64bit);
590 void __mptcp_flush_join_list(struct mptcp_sock *msk);
591 static inline bool mptcp_data_fin_enabled(const struct mptcp_sock *msk)
592 {
593 	return READ_ONCE(msk->snd_data_fin_enable) &&
594 	       READ_ONCE(msk->write_seq) == READ_ONCE(msk->snd_nxt);
595 }
596 
597 static inline bool mptcp_propagate_sndbuf(struct sock *sk, struct sock *ssk)
598 {
599 	if ((sk->sk_userlocks & SOCK_SNDBUF_LOCK) || ssk->sk_sndbuf <= READ_ONCE(sk->sk_sndbuf))
600 		return false;
601 
602 	WRITE_ONCE(sk->sk_sndbuf, ssk->sk_sndbuf);
603 	return true;
604 }
605 
606 static inline void mptcp_write_space(struct sock *sk)
607 {
608 	if (sk_stream_is_writeable(sk)) {
609 		/* pairs with memory barrier in mptcp_poll */
610 		smp_mb();
611 		if (test_and_clear_bit(MPTCP_NOSPACE, &mptcp_sk(sk)->flags))
612 			sk_stream_write_space(sk);
613 	}
614 }
615 
616 void mptcp_destroy_common(struct mptcp_sock *msk);
617 
618 void __init mptcp_token_init(void);
619 static inline void mptcp_token_init_request(struct request_sock *req)
620 {
621 	mptcp_subflow_rsk(req)->token_node.pprev = NULL;
622 }
623 
624 int mptcp_token_new_request(struct request_sock *req);
625 void mptcp_token_destroy_request(struct request_sock *req);
626 int mptcp_token_new_connect(struct sock *sk);
627 void mptcp_token_accept(struct mptcp_subflow_request_sock *r,
628 			struct mptcp_sock *msk);
629 bool mptcp_token_exists(u32 token);
630 struct mptcp_sock *mptcp_token_get_sock(u32 token);
631 struct mptcp_sock *mptcp_token_iter_next(const struct net *net, long *s_slot,
632 					 long *s_num);
633 void mptcp_token_destroy(struct mptcp_sock *msk);
634 
635 void mptcp_crypto_key_sha(u64 key, u32 *token, u64 *idsn);
636 
637 void mptcp_crypto_hmac_sha(u64 key1, u64 key2, u8 *msg, int len, void *hmac);
638 
639 void __init mptcp_pm_init(void);
640 void mptcp_pm_data_init(struct mptcp_sock *msk);
641 void mptcp_pm_new_connection(struct mptcp_sock *msk, const struct sock *ssk, int server_side);
642 void mptcp_pm_fully_established(struct mptcp_sock *msk, const struct sock *ssk, gfp_t gfp);
643 bool mptcp_pm_allow_new_subflow(struct mptcp_sock *msk);
644 void mptcp_pm_connection_closed(struct mptcp_sock *msk);
645 void mptcp_pm_subflow_established(struct mptcp_sock *msk,
646 				  struct mptcp_subflow_context *subflow);
647 void mptcp_pm_subflow_closed(struct mptcp_sock *msk, u8 id);
648 void mptcp_pm_add_addr_received(struct mptcp_sock *msk,
649 				const struct mptcp_addr_info *addr);
650 void mptcp_pm_add_addr_send_ack(struct mptcp_sock *msk);
651 void mptcp_pm_rm_addr_received(struct mptcp_sock *msk,
652 			       const struct mptcp_rm_list *rm_list);
653 void mptcp_pm_mp_prio_received(struct sock *sk, u8 bkup);
654 int mptcp_pm_nl_mp_prio_send_ack(struct mptcp_sock *msk,
655 				 struct mptcp_addr_info *addr,
656 				 u8 bkup);
657 void mptcp_pm_free_anno_list(struct mptcp_sock *msk);
658 bool mptcp_pm_sport_in_anno_list(struct mptcp_sock *msk, const struct sock *sk);
659 struct mptcp_pm_add_entry *
660 mptcp_pm_del_add_timer(struct mptcp_sock *msk,
661 		       struct mptcp_addr_info *addr);
662 
663 int mptcp_pm_announce_addr(struct mptcp_sock *msk,
664 			   const struct mptcp_addr_info *addr,
665 			   bool echo, bool port);
666 int mptcp_pm_remove_addr(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
667 int mptcp_pm_remove_subflow(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
668 
669 void mptcp_event(enum mptcp_event_type type, const struct mptcp_sock *msk,
670 		 const struct sock *ssk, gfp_t gfp);
671 void mptcp_event_addr_announced(const struct mptcp_sock *msk, const struct mptcp_addr_info *info);
672 void mptcp_event_addr_removed(const struct mptcp_sock *msk, u8 id);
673 
674 static inline bool mptcp_pm_should_add_signal(struct mptcp_sock *msk)
675 {
676 	return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_SIGNAL);
677 }
678 
679 static inline bool mptcp_pm_should_add_signal_echo(struct mptcp_sock *msk)
680 {
681 	return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_ECHO);
682 }
683 
684 static inline bool mptcp_pm_should_add_signal_ipv6(struct mptcp_sock *msk)
685 {
686 	return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_IPV6);
687 }
688 
689 static inline bool mptcp_pm_should_add_signal_port(struct mptcp_sock *msk)
690 {
691 	return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_PORT);
692 }
693 
694 static inline bool mptcp_pm_should_rm_signal(struct mptcp_sock *msk)
695 {
696 	return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_RM_ADDR_SIGNAL);
697 }
698 
699 static inline unsigned int mptcp_add_addr_len(int family, bool echo, bool port)
700 {
701 	u8 len = TCPOLEN_MPTCP_ADD_ADDR_BASE;
702 
703 	if (family == AF_INET6)
704 		len = TCPOLEN_MPTCP_ADD_ADDR6_BASE;
705 	if (!echo)
706 		len += MPTCPOPT_THMAC_LEN;
707 	/* account for 2 trailing 'nop' options */
708 	if (port)
709 		len += TCPOLEN_MPTCP_PORT_LEN + TCPOLEN_MPTCP_PORT_ALIGN;
710 
711 	return len;
712 }
713 
714 static inline int mptcp_rm_addr_len(const struct mptcp_rm_list *rm_list)
715 {
716 	if (rm_list->nr == 0 || rm_list->nr > MPTCP_RM_IDS_MAX)
717 		return -EINVAL;
718 
719 	return TCPOLEN_MPTCP_RM_ADDR_BASE + roundup(rm_list->nr - 1, 4) + 1;
720 }
721 
722 bool mptcp_pm_add_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
723 			      struct mptcp_addr_info *saddr, bool *echo, bool *port);
724 bool mptcp_pm_rm_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
725 			     struct mptcp_rm_list *rm_list);
726 int mptcp_pm_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
727 
728 void __init mptcp_pm_nl_init(void);
729 void mptcp_pm_nl_data_init(struct mptcp_sock *msk);
730 void mptcp_pm_nl_work(struct mptcp_sock *msk);
731 void mptcp_pm_nl_rm_subflow_received(struct mptcp_sock *msk,
732 				     const struct mptcp_rm_list *rm_list);
733 int mptcp_pm_nl_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
734 unsigned int mptcp_pm_get_add_addr_signal_max(struct mptcp_sock *msk);
735 unsigned int mptcp_pm_get_add_addr_accept_max(struct mptcp_sock *msk);
736 unsigned int mptcp_pm_get_subflows_max(struct mptcp_sock *msk);
737 unsigned int mptcp_pm_get_local_addr_max(struct mptcp_sock *msk);
738 
739 static inline struct mptcp_ext *mptcp_get_ext(struct sk_buff *skb)
740 {
741 	return (struct mptcp_ext *)skb_ext_find(skb, SKB_EXT_MPTCP);
742 }
743 
744 void mptcp_diag_subflow_init(struct tcp_ulp_ops *ops);
745 
746 static inline bool __mptcp_check_fallback(const struct mptcp_sock *msk)
747 {
748 	return test_bit(MPTCP_FALLBACK_DONE, &msk->flags);
749 }
750 
751 static inline bool mptcp_check_fallback(const struct sock *sk)
752 {
753 	struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
754 	struct mptcp_sock *msk = mptcp_sk(subflow->conn);
755 
756 	return __mptcp_check_fallback(msk);
757 }
758 
759 static inline void __mptcp_do_fallback(struct mptcp_sock *msk)
760 {
761 	if (test_bit(MPTCP_FALLBACK_DONE, &msk->flags)) {
762 		pr_debug("TCP fallback already done (msk=%p)", msk);
763 		return;
764 	}
765 	set_bit(MPTCP_FALLBACK_DONE, &msk->flags);
766 }
767 
768 static inline void mptcp_do_fallback(struct sock *sk)
769 {
770 	struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
771 	struct mptcp_sock *msk = mptcp_sk(subflow->conn);
772 
773 	__mptcp_do_fallback(msk);
774 }
775 
776 #define pr_fallback(a) pr_debug("%s:fallback to TCP (msk=%p)", __func__, a)
777 
778 static inline bool subflow_simultaneous_connect(struct sock *sk)
779 {
780 	struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
781 	struct sock *parent = subflow->conn;
782 
783 	return sk->sk_state == TCP_ESTABLISHED &&
784 	       !mptcp_sk(parent)->pm.server_side &&
785 	       !subflow->conn_finished;
786 }
787 
788 #ifdef CONFIG_SYN_COOKIES
789 void subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
790 				       struct sk_buff *skb);
791 bool mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
792 					struct sk_buff *skb);
793 void __init mptcp_join_cookie_init(void);
794 #else
795 static inline void
796 subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
797 				  struct sk_buff *skb) {}
798 static inline bool
799 mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
800 				   struct sk_buff *skb)
801 {
802 	return false;
803 }
804 
805 static inline void mptcp_join_cookie_init(void) {}
806 #endif
807 
808 #endif /* __MPTCP_PROTOCOL_H */
809