1 /* SPDX-License-Identifier: GPL-2.0 */
4 * Copyright (c) 2017 - 2019, Intel Corporation.
7 #ifndef __MPTCP_PROTOCOL_H
8 #define __MPTCP_PROTOCOL_H
10 #include <linux/random.h>
12 #include <net/inet_connection_sock.h>
13 #include <uapi/linux/mptcp.h>
15 #define MPTCP_SUPPORTED_VERSION 1
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_RM_ADDR BIT(7)
26 #define OPTION_MPTCP_FASTCLOSE BIT(8)
27 #define OPTION_MPTCP_PRIO BIT(9)
28 #define OPTION_MPTCP_RST BIT(10)
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 #define MPTCPOPT_RST 8
41 /* MPTCP suboption lengths */
42 #define TCPOLEN_MPTCP_MPC_SYN 4
43 #define TCPOLEN_MPTCP_MPC_SYNACK 12
44 #define TCPOLEN_MPTCP_MPC_ACK 20
45 #define TCPOLEN_MPTCP_MPC_ACK_DATA 22
46 #define TCPOLEN_MPTCP_MPJ_SYN 12
47 #define TCPOLEN_MPTCP_MPJ_SYNACK 16
48 #define TCPOLEN_MPTCP_MPJ_ACK 24
49 #define TCPOLEN_MPTCP_DSS_BASE 4
50 #define TCPOLEN_MPTCP_DSS_ACK32 4
51 #define TCPOLEN_MPTCP_DSS_ACK64 8
52 #define TCPOLEN_MPTCP_DSS_MAP32 10
53 #define TCPOLEN_MPTCP_DSS_MAP64 14
54 #define TCPOLEN_MPTCP_DSS_CHECKSUM 2
55 #define TCPOLEN_MPTCP_ADD_ADDR 16
56 #define TCPOLEN_MPTCP_ADD_ADDR_PORT 18
57 #define TCPOLEN_MPTCP_ADD_ADDR_BASE 8
58 #define TCPOLEN_MPTCP_ADD_ADDR_BASE_PORT 10
59 #define TCPOLEN_MPTCP_ADD_ADDR6 28
60 #define TCPOLEN_MPTCP_ADD_ADDR6_PORT 30
61 #define TCPOLEN_MPTCP_ADD_ADDR6_BASE 20
62 #define TCPOLEN_MPTCP_ADD_ADDR6_BASE_PORT 22
63 #define TCPOLEN_MPTCP_PORT_LEN 2
64 #define TCPOLEN_MPTCP_PORT_ALIGN 2
65 #define TCPOLEN_MPTCP_RM_ADDR_BASE 3
66 #define TCPOLEN_MPTCP_PRIO 3
67 #define TCPOLEN_MPTCP_PRIO_ALIGN 4
68 #define TCPOLEN_MPTCP_FASTCLOSE 12
69 #define TCPOLEN_MPTCP_RST 4
71 #define TCPOLEN_MPTCP_MPC_ACK_DATA_CSUM (TCPOLEN_MPTCP_DSS_CHECKSUM + TCPOLEN_MPTCP_MPC_ACK_DATA)
73 /* MPTCP MP_JOIN flags */
74 #define MPTCPOPT_BACKUP BIT(0)
75 #define MPTCPOPT_HMAC_LEN 20
76 #define MPTCPOPT_THMAC_LEN 8
78 /* MPTCP MP_CAPABLE flags */
79 #define MPTCP_VERSION_MASK (0x0F)
80 #define MPTCP_CAP_CHECKSUM_REQD BIT(7)
81 #define MPTCP_CAP_EXTENSIBILITY BIT(6)
82 #define MPTCP_CAP_DENY_JOIN_ID0 BIT(5)
83 #define MPTCP_CAP_HMAC_SHA256 BIT(0)
84 #define MPTCP_CAP_FLAG_MASK (0x1F)
87 #define MPTCP_DSS_DATA_FIN BIT(4)
88 #define MPTCP_DSS_DSN64 BIT(3)
89 #define MPTCP_DSS_HAS_MAP BIT(2)
90 #define MPTCP_DSS_ACK64 BIT(1)
91 #define MPTCP_DSS_HAS_ACK BIT(0)
92 #define MPTCP_DSS_FLAG_MASK (0x1F)
94 /* MPTCP ADD_ADDR flags */
95 #define MPTCP_ADDR_ECHO BIT(0)
97 /* MPTCP MP_PRIO flags */
98 #define MPTCP_PRIO_BKUP BIT(0)
100 /* MPTCP TCPRST flags */
101 #define MPTCP_RST_TRANSIENT BIT(0)
103 /* MPTCP socket flags */
104 #define MPTCP_DATA_READY 0
105 #define MPTCP_NOSPACE 1
106 #define MPTCP_WORK_RTX 2
107 #define MPTCP_WORK_EOF 3
108 #define MPTCP_FALLBACK_DONE 4
109 #define MPTCP_WORK_CLOSE_SUBFLOW 5
110 #define MPTCP_PUSH_PENDING 6
111 #define MPTCP_CLEAN_UNA 7
112 #define MPTCP_ERROR_REPORT 8
113 #define MPTCP_RETRANSMIT 9
114 #define MPTCP_WORK_SYNC_SETSOCKOPT 10
115 #define MPTCP_CONNECTED 11
117 static inline bool before64(__u64 seq1, __u64 seq2)
119 return (__s64)(seq1 - seq2) < 0;
122 #define after64(seq2, seq1) before64(seq1, seq2)
124 struct mptcp_options_received {
147 u8 hmac[MPTCPOPT_HMAC_LEN];
156 struct mptcp_addr_info addr;
157 struct mptcp_rm_list rm_list;
160 u8 reset_transient:1;
163 static inline __be32 mptcp_option(u8 subopt, u8 len, u8 nib, u8 field)
165 return htonl((TCPOPT_MPTCP << 24) | (len << 16) | (subopt << 12) |
166 ((nib & 0xF) << 8) | field);
169 enum mptcp_pm_status {
170 MPTCP_PM_ADD_ADDR_RECEIVED,
171 MPTCP_PM_ADD_ADDR_SEND_ACK,
172 MPTCP_PM_RM_ADDR_RECEIVED,
173 MPTCP_PM_ESTABLISHED,
174 MPTCP_PM_ALREADY_ESTABLISHED, /* persistent status, set after ESTABLISHED event */
175 MPTCP_PM_SUBFLOW_ESTABLISHED,
178 enum mptcp_addr_signal_status {
179 MPTCP_ADD_ADDR_SIGNAL,
183 MPTCP_RM_ADDR_SIGNAL,
186 struct mptcp_pm_data {
187 struct mptcp_addr_info local;
188 struct mptcp_addr_info remote;
189 struct list_head anno_list;
191 spinlock_t lock; /*protects the whole PM data */
198 bool remote_deny_join_id0;
199 u8 add_addr_signaled;
200 u8 add_addr_accepted;
204 struct mptcp_rm_list rm_list_tx;
205 struct mptcp_rm_list rm_list_rx;
208 struct mptcp_data_frag {
209 struct list_head list;
218 /* MPTCP connection sock */
220 /* inet_connection_sock must be the first member */
221 struct inet_connection_sock sk;
228 u64 rcv_data_fin_seq;
230 struct sock *last_snd;
233 u64 recovery_snd_nxt; /* in recovery mode accept up to this seq;
234 * recovery related fields are under data_lock
239 unsigned long timer_ival;
243 bool recovery; /* closing subflow write queue reinjected */
245 bool fully_established;
247 bool snd_data_fin_enable;
249 bool use_64bit_ack; /* Set when we received a 64-bit DSN */
251 spinlock_t join_list_lock;
252 struct work_struct work;
253 struct sk_buff *ooo_last_skb;
254 struct rb_root out_of_order_queue;
255 struct sk_buff_head receive_queue;
257 struct list_head conn_list;
258 struct list_head rtx_queue;
259 struct mptcp_data_frag *first_pending;
260 struct list_head join_list;
261 struct socket *subflow; /* outgoing connect/listener/!mp_capable */
263 struct mptcp_pm_data pm;
265 u32 space; /* bytes copied in last measurement window */
266 u32 copied; /* bytes copied in this measurement window */
267 u64 time; /* start time of measurement window */
268 u64 rtt_us; /* last maximum rtt of subflows */
272 char ca_name[TCP_CA_NAME_MAX];
275 #define mptcp_lock_sock(___sk, cb) do { \
276 struct sock *__sk = (___sk); /* silence macro reuse warning */ \
278 spin_lock_bh(&__sk->sk_lock.slock); \
279 if (__sk->sk_lock.owned) \
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_); \
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)
291 #define mptcp_for_each_subflow(__msk, __subflow) \
292 list_for_each_entry(__subflow, &((__msk)->conn_list), node)
294 static inline void msk_owned_by_me(const struct mptcp_sock *msk)
296 sock_owned_by_me((const struct sock *)msk);
299 static inline struct mptcp_sock *mptcp_sk(const struct sock *sk)
301 return (struct mptcp_sock *)sk;
304 /* the msk socket don't use the backlog, also account for the bulk
307 static inline int __mptcp_rmem(const struct sock *sk)
309 return atomic_read(&sk->sk_rmem_alloc) - READ_ONCE(mptcp_sk(sk)->rmem_released);
312 static inline int __mptcp_space(const struct sock *sk)
314 return tcp_win_from_space(sk, READ_ONCE(sk->sk_rcvbuf) - __mptcp_rmem(sk));
317 static inline struct mptcp_data_frag *mptcp_send_head(const struct sock *sk)
319 const struct mptcp_sock *msk = mptcp_sk(sk);
321 return READ_ONCE(msk->first_pending);
324 static inline struct mptcp_data_frag *mptcp_send_next(struct sock *sk)
326 struct mptcp_sock *msk = mptcp_sk(sk);
327 struct mptcp_data_frag *cur;
329 cur = msk->first_pending;
330 return list_is_last(&cur->list, &msk->rtx_queue) ? NULL :
331 list_next_entry(cur, list);
334 static inline struct mptcp_data_frag *mptcp_pending_tail(const struct sock *sk)
336 struct mptcp_sock *msk = mptcp_sk(sk);
338 if (!msk->first_pending)
341 if (WARN_ON_ONCE(list_empty(&msk->rtx_queue)))
344 return list_last_entry(&msk->rtx_queue, struct mptcp_data_frag, list);
347 static inline struct mptcp_data_frag *mptcp_rtx_head(const struct sock *sk)
349 struct mptcp_sock *msk = mptcp_sk(sk);
351 if (msk->snd_una == READ_ONCE(msk->snd_nxt))
354 return list_first_entry_or_null(&msk->rtx_queue, struct mptcp_data_frag, list);
357 struct csum_pseudo_header {
364 struct mptcp_subflow_request_sock {
365 struct tcp_request_sock sk;
380 struct mptcp_sock *msk;
381 struct hlist_nulls_node token_node;
384 static inline struct mptcp_subflow_request_sock *
385 mptcp_subflow_rsk(const struct request_sock *rsk)
387 return (struct mptcp_subflow_request_sock *)rsk;
390 enum mptcp_data_avail {
391 MPTCP_SUBFLOW_NODATA,
392 MPTCP_SUBFLOW_DATA_AVAIL,
395 struct mptcp_delegated_action {
396 struct napi_struct napi;
397 struct list_head head;
400 DECLARE_PER_CPU(struct mptcp_delegated_action, mptcp_delegated_actions);
402 #define MPTCP_DELEGATE_SEND 0
404 /* MPTCP subflow context */
405 struct mptcp_subflow_context {
406 struct list_head node;/* conn_list of subflows */
417 __wsum map_data_csum;
419 u32 request_mptcp : 1, /* send MP_CAPABLE */
420 request_join : 1, /* send MP_JOIN */
422 mp_capable : 1, /* remote is MPTCP capable */
423 mp_join : 1, /* remote is JOINing */
424 fully_established : 1, /* path validated */
425 pm_notified : 1, /* PM hook called for established status */
434 can_ack : 1, /* only after processing the remote a key */
435 disposable : 1, /* ctx can be free at ulp release time */
436 stale : 1; /* unable to snd/rcv data, do not use for xmit */
437 enum mptcp_data_avail data_avail;
442 u8 hmac[MPTCPOPT_HMAC_LEN];
446 u8 reset_transient:1;
450 long delegated_status;
451 struct list_head delegated_node; /* link into delegated_action, protected by local BH */
454 u32 stale_rcv_tstamp;
456 struct sock *tcp_sock; /* tcp sk backpointer */
457 struct sock *conn; /* parent mptcp_sock */
458 const struct inet_connection_sock_af_ops *icsk_af_ops;
459 void (*tcp_data_ready)(struct sock *sk);
460 void (*tcp_state_change)(struct sock *sk);
461 void (*tcp_write_space)(struct sock *sk);
462 void (*tcp_error_report)(struct sock *sk);
467 static inline struct mptcp_subflow_context *
468 mptcp_subflow_ctx(const struct sock *sk)
470 struct inet_connection_sock *icsk = inet_csk(sk);
472 /* Use RCU on icsk_ulp_data only for sock diag code */
473 return (__force struct mptcp_subflow_context *)icsk->icsk_ulp_data;
476 static inline struct sock *
477 mptcp_subflow_tcp_sock(const struct mptcp_subflow_context *subflow)
479 return subflow->tcp_sock;
483 mptcp_subflow_get_map_offset(const struct mptcp_subflow_context *subflow)
485 return tcp_sk(mptcp_subflow_tcp_sock(subflow))->copied_seq -
486 subflow->ssn_offset -
487 subflow->map_subflow_seq;
491 mptcp_subflow_get_mapped_dsn(const struct mptcp_subflow_context *subflow)
493 return subflow->map_seq + mptcp_subflow_get_map_offset(subflow);
496 static inline void mptcp_add_pending_subflow(struct mptcp_sock *msk,
497 struct mptcp_subflow_context *subflow)
499 sock_hold(mptcp_subflow_tcp_sock(subflow));
500 spin_lock_bh(&msk->join_list_lock);
501 list_add_tail(&subflow->node, &msk->join_list);
502 spin_unlock_bh(&msk->join_list_lock);
505 void mptcp_subflow_process_delegated(struct sock *ssk);
507 static inline void mptcp_subflow_delegate(struct mptcp_subflow_context *subflow)
509 struct mptcp_delegated_action *delegated;
512 /* The implied barrier pairs with mptcp_subflow_delegated_done(), and
513 * ensures the below list check sees list updates done prior to status
516 if (!test_and_set_bit(MPTCP_DELEGATE_SEND, &subflow->delegated_status)) {
517 /* still on delegated list from previous scheduling */
518 if (!list_empty(&subflow->delegated_node))
521 /* the caller held the subflow bh socket lock */
522 lockdep_assert_in_softirq();
524 delegated = this_cpu_ptr(&mptcp_delegated_actions);
525 schedule = list_empty(&delegated->head);
526 list_add_tail(&subflow->delegated_node, &delegated->head);
527 sock_hold(mptcp_subflow_tcp_sock(subflow));
529 napi_schedule(&delegated->napi);
533 static inline struct mptcp_subflow_context *
534 mptcp_subflow_delegated_next(struct mptcp_delegated_action *delegated)
536 struct mptcp_subflow_context *ret;
538 if (list_empty(&delegated->head))
541 ret = list_first_entry(&delegated->head, struct mptcp_subflow_context, delegated_node);
542 list_del_init(&ret->delegated_node);
546 static inline bool mptcp_subflow_has_delegated_action(const struct mptcp_subflow_context *subflow)
548 return test_bit(MPTCP_DELEGATE_SEND, &subflow->delegated_status);
551 static inline void mptcp_subflow_delegated_done(struct mptcp_subflow_context *subflow)
553 /* pairs with mptcp_subflow_delegate, ensures delegate_node is updated before
554 * touching the status bit
557 clear_bit(MPTCP_DELEGATE_SEND, &subflow->delegated_status);
560 int mptcp_is_enabled(const struct net *net);
561 unsigned int mptcp_get_add_addr_timeout(const struct net *net);
562 int mptcp_is_checksum_enabled(const struct net *net);
563 int mptcp_allow_join_id0(const struct net *net);
564 unsigned int mptcp_stale_loss_cnt(const struct net *net);
565 void mptcp_subflow_fully_established(struct mptcp_subflow_context *subflow,
566 struct mptcp_options_received *mp_opt);
567 bool __mptcp_retransmit_pending_data(struct sock *sk);
568 void __mptcp_push_pending(struct sock *sk, unsigned int flags);
569 bool mptcp_subflow_data_available(struct sock *sk);
570 void __init mptcp_subflow_init(void);
571 void mptcp_subflow_shutdown(struct sock *sk, struct sock *ssk, int how);
572 void mptcp_close_ssk(struct sock *sk, struct sock *ssk,
573 struct mptcp_subflow_context *subflow);
574 void mptcp_subflow_reset(struct sock *ssk);
575 void mptcp_sock_graft(struct sock *sk, struct socket *parent);
576 struct socket *__mptcp_nmpc_socket(const struct mptcp_sock *msk);
578 /* called with sk socket lock held */
579 int __mptcp_subflow_connect(struct sock *sk, const struct mptcp_addr_info *loc,
580 const struct mptcp_addr_info *remote);
581 int mptcp_subflow_create_socket(struct sock *sk, struct socket **new_sock);
582 void mptcp_info2sockaddr(const struct mptcp_addr_info *info,
583 struct sockaddr_storage *addr,
584 unsigned short family);
586 static inline bool __mptcp_subflow_active(struct mptcp_subflow_context *subflow)
588 struct sock *ssk = mptcp_subflow_tcp_sock(subflow);
590 /* can't send if JOIN hasn't completed yet (i.e. is usable for mptcp) */
591 if (subflow->request_join && !subflow->fully_established)
594 /* only send if our side has not closed yet */
595 return ((1 << ssk->sk_state) & (TCPF_ESTABLISHED | TCPF_CLOSE_WAIT));
598 void mptcp_subflow_set_active(struct mptcp_subflow_context *subflow);
600 bool mptcp_subflow_active(struct mptcp_subflow_context *subflow);
602 static inline void mptcp_subflow_tcp_fallback(struct sock *sk,
603 struct mptcp_subflow_context *ctx)
605 sk->sk_data_ready = ctx->tcp_data_ready;
606 sk->sk_state_change = ctx->tcp_state_change;
607 sk->sk_write_space = ctx->tcp_write_space;
608 sk->sk_error_report = ctx->tcp_error_report;
610 inet_csk(sk)->icsk_af_ops = ctx->icsk_af_ops;
613 void __init mptcp_proto_init(void);
614 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
615 int __init mptcp_proto_v6_init(void);
618 struct sock *mptcp_sk_clone(const struct sock *sk,
619 const struct mptcp_options_received *mp_opt,
620 struct request_sock *req);
621 void mptcp_get_options(const struct sock *sk,
622 const struct sk_buff *skb,
623 struct mptcp_options_received *mp_opt);
625 void mptcp_finish_connect(struct sock *sk);
626 void __mptcp_set_connected(struct sock *sk);
627 static inline bool mptcp_is_fully_established(struct sock *sk)
629 return inet_sk_state_load(sk) == TCP_ESTABLISHED &&
630 READ_ONCE(mptcp_sk(sk)->fully_established);
632 void mptcp_rcv_space_init(struct mptcp_sock *msk, const struct sock *ssk);
633 void mptcp_data_ready(struct sock *sk, struct sock *ssk);
634 bool mptcp_finish_join(struct sock *sk);
635 bool mptcp_schedule_work(struct sock *sk);
636 int mptcp_setsockopt(struct sock *sk, int level, int optname,
637 sockptr_t optval, unsigned int optlen);
638 int mptcp_getsockopt(struct sock *sk, int level, int optname,
639 char __user *optval, int __user *option);
641 u64 __mptcp_expand_seq(u64 old_seq, u64 cur_seq);
642 static inline u64 mptcp_expand_seq(u64 old_seq, u64 cur_seq, bool use_64bit)
647 return __mptcp_expand_seq(old_seq, cur_seq);
649 void __mptcp_check_push(struct sock *sk, struct sock *ssk);
650 void __mptcp_data_acked(struct sock *sk);
651 void __mptcp_error_report(struct sock *sk);
652 void mptcp_subflow_eof(struct sock *sk);
653 bool mptcp_update_rcv_data_fin(struct mptcp_sock *msk, u64 data_fin_seq, bool use_64bit);
654 void __mptcp_flush_join_list(struct mptcp_sock *msk);
655 static inline bool mptcp_data_fin_enabled(const struct mptcp_sock *msk)
657 return READ_ONCE(msk->snd_data_fin_enable) &&
658 READ_ONCE(msk->write_seq) == READ_ONCE(msk->snd_nxt);
661 static inline bool mptcp_propagate_sndbuf(struct sock *sk, struct sock *ssk)
663 if ((sk->sk_userlocks & SOCK_SNDBUF_LOCK) || ssk->sk_sndbuf <= READ_ONCE(sk->sk_sndbuf))
666 WRITE_ONCE(sk->sk_sndbuf, ssk->sk_sndbuf);
670 static inline void mptcp_write_space(struct sock *sk)
672 if (sk_stream_is_writeable(sk)) {
673 /* pairs with memory barrier in mptcp_poll */
675 if (test_and_clear_bit(MPTCP_NOSPACE, &mptcp_sk(sk)->flags))
676 sk_stream_write_space(sk);
680 void mptcp_destroy_common(struct mptcp_sock *msk);
682 #define MPTCP_TOKEN_MAX_RETRIES 4
684 void __init mptcp_token_init(void);
685 static inline void mptcp_token_init_request(struct request_sock *req)
687 mptcp_subflow_rsk(req)->token_node.pprev = NULL;
690 int mptcp_token_new_request(struct request_sock *req);
691 void mptcp_token_destroy_request(struct request_sock *req);
692 int mptcp_token_new_connect(struct sock *sk);
693 void mptcp_token_accept(struct mptcp_subflow_request_sock *r,
694 struct mptcp_sock *msk);
695 bool mptcp_token_exists(u32 token);
696 struct mptcp_sock *mptcp_token_get_sock(u32 token);
697 struct mptcp_sock *mptcp_token_iter_next(const struct net *net, long *s_slot,
699 void mptcp_token_destroy(struct mptcp_sock *msk);
701 void mptcp_crypto_key_sha(u64 key, u32 *token, u64 *idsn);
703 void mptcp_crypto_hmac_sha(u64 key1, u64 key2, u8 *msg, int len, void *hmac);
705 void __init mptcp_pm_init(void);
706 void mptcp_pm_data_init(struct mptcp_sock *msk);
707 void mptcp_pm_subflow_chk_stale(const struct mptcp_sock *msk, struct sock *ssk);
708 void mptcp_pm_nl_subflow_chk_stale(const struct mptcp_sock *msk, struct sock *ssk);
709 void mptcp_pm_new_connection(struct mptcp_sock *msk, const struct sock *ssk, int server_side);
710 void mptcp_pm_fully_established(struct mptcp_sock *msk, const struct sock *ssk, gfp_t gfp);
711 bool mptcp_pm_allow_new_subflow(struct mptcp_sock *msk);
712 void mptcp_pm_connection_closed(struct mptcp_sock *msk);
713 void mptcp_pm_subflow_established(struct mptcp_sock *msk);
714 void mptcp_pm_subflow_closed(struct mptcp_sock *msk, u8 id);
715 void mptcp_pm_add_addr_received(struct mptcp_sock *msk,
716 const struct mptcp_addr_info *addr);
717 void mptcp_pm_add_addr_echoed(struct mptcp_sock *msk,
718 struct mptcp_addr_info *addr);
719 void mptcp_pm_add_addr_send_ack(struct mptcp_sock *msk);
720 void mptcp_pm_nl_addr_send_ack(struct mptcp_sock *msk);
721 void mptcp_pm_rm_addr_received(struct mptcp_sock *msk,
722 const struct mptcp_rm_list *rm_list);
723 void mptcp_pm_mp_prio_received(struct sock *sk, u8 bkup);
724 int mptcp_pm_nl_mp_prio_send_ack(struct mptcp_sock *msk,
725 struct mptcp_addr_info *addr,
727 void mptcp_pm_free_anno_list(struct mptcp_sock *msk);
728 bool mptcp_pm_sport_in_anno_list(struct mptcp_sock *msk, const struct sock *sk);
729 struct mptcp_pm_add_entry *
730 mptcp_pm_del_add_timer(struct mptcp_sock *msk,
731 struct mptcp_addr_info *addr, bool check_id);
732 struct mptcp_pm_add_entry *
733 mptcp_lookup_anno_list_by_saddr(struct mptcp_sock *msk,
734 struct mptcp_addr_info *addr);
735 int mptcp_pm_get_flags_and_ifindex_by_id(struct net *net, unsigned int id,
736 u8 *flags, int *ifindex);
738 int mptcp_pm_announce_addr(struct mptcp_sock *msk,
739 const struct mptcp_addr_info *addr,
741 int mptcp_pm_remove_addr(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
742 int mptcp_pm_remove_subflow(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
744 void mptcp_event(enum mptcp_event_type type, const struct mptcp_sock *msk,
745 const struct sock *ssk, gfp_t gfp);
746 void mptcp_event_addr_announced(const struct mptcp_sock *msk, const struct mptcp_addr_info *info);
747 void mptcp_event_addr_removed(const struct mptcp_sock *msk, u8 id);
749 static inline bool mptcp_pm_should_add_signal(struct mptcp_sock *msk)
751 return READ_ONCE(msk->pm.addr_signal) &
752 (BIT(MPTCP_ADD_ADDR_SIGNAL) | BIT(MPTCP_ADD_ADDR_ECHO));
755 static inline bool mptcp_pm_should_add_signal_addr(struct mptcp_sock *msk)
757 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_SIGNAL);
760 static inline bool mptcp_pm_should_add_signal_echo(struct mptcp_sock *msk)
762 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_ECHO);
765 static inline bool mptcp_pm_should_add_signal_ipv6(struct mptcp_sock *msk)
767 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_IPV6);
770 static inline bool mptcp_pm_should_add_signal_port(struct mptcp_sock *msk)
772 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_PORT);
775 static inline bool mptcp_pm_should_rm_signal(struct mptcp_sock *msk)
777 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_RM_ADDR_SIGNAL);
780 static inline unsigned int mptcp_add_addr_len(int family, bool echo, bool port)
782 u8 len = TCPOLEN_MPTCP_ADD_ADDR_BASE;
784 if (family == AF_INET6)
785 len = TCPOLEN_MPTCP_ADD_ADDR6_BASE;
787 len += MPTCPOPT_THMAC_LEN;
788 /* account for 2 trailing 'nop' options */
790 len += TCPOLEN_MPTCP_PORT_LEN + TCPOLEN_MPTCP_PORT_ALIGN;
795 static inline int mptcp_rm_addr_len(const struct mptcp_rm_list *rm_list)
797 if (rm_list->nr == 0 || rm_list->nr > MPTCP_RM_IDS_MAX)
800 return TCPOLEN_MPTCP_RM_ADDR_BASE + roundup(rm_list->nr - 1, 4) + 1;
803 bool mptcp_pm_add_addr_signal(struct mptcp_sock *msk, struct sk_buff *skb,
804 unsigned int opt_size, unsigned int remaining,
805 struct mptcp_addr_info *saddr, bool *echo,
806 bool *port, bool *drop_other_suboptions);
807 bool mptcp_pm_rm_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
808 struct mptcp_rm_list *rm_list);
809 int mptcp_pm_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
811 void __init mptcp_pm_nl_init(void);
812 void mptcp_pm_nl_data_init(struct mptcp_sock *msk);
813 void mptcp_pm_nl_work(struct mptcp_sock *msk);
814 void mptcp_pm_nl_rm_subflow_received(struct mptcp_sock *msk,
815 const struct mptcp_rm_list *rm_list);
816 int mptcp_pm_nl_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
817 unsigned int mptcp_pm_get_add_addr_signal_max(struct mptcp_sock *msk);
818 unsigned int mptcp_pm_get_add_addr_accept_max(struct mptcp_sock *msk);
819 unsigned int mptcp_pm_get_subflows_max(struct mptcp_sock *msk);
820 unsigned int mptcp_pm_get_local_addr_max(struct mptcp_sock *msk);
822 void mptcp_sockopt_sync(struct mptcp_sock *msk, struct sock *ssk);
823 void mptcp_sockopt_sync_all(struct mptcp_sock *msk);
825 static inline struct mptcp_ext *mptcp_get_ext(const struct sk_buff *skb)
827 return (struct mptcp_ext *)skb_ext_find(skb, SKB_EXT_MPTCP);
830 void mptcp_diag_subflow_init(struct tcp_ulp_ops *ops);
832 static inline bool __mptcp_check_fallback(const struct mptcp_sock *msk)
834 return test_bit(MPTCP_FALLBACK_DONE, &msk->flags);
837 static inline bool mptcp_check_fallback(const struct sock *sk)
839 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
840 struct mptcp_sock *msk = mptcp_sk(subflow->conn);
842 return __mptcp_check_fallback(msk);
845 static inline void __mptcp_do_fallback(struct mptcp_sock *msk)
847 if (test_bit(MPTCP_FALLBACK_DONE, &msk->flags)) {
848 pr_debug("TCP fallback already done (msk=%p)", msk);
851 set_bit(MPTCP_FALLBACK_DONE, &msk->flags);
854 static inline void mptcp_do_fallback(struct sock *sk)
856 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
857 struct mptcp_sock *msk = mptcp_sk(subflow->conn);
859 __mptcp_do_fallback(msk);
862 #define pr_fallback(a) pr_debug("%s:fallback to TCP (msk=%p)", __func__, a)
864 static inline bool subflow_simultaneous_connect(struct sock *sk)
866 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
867 struct sock *parent = subflow->conn;
869 return sk->sk_state == TCP_ESTABLISHED &&
870 !mptcp_sk(parent)->pm.server_side &&
871 !subflow->conn_finished;
874 #ifdef CONFIG_SYN_COOKIES
875 void subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
876 struct sk_buff *skb);
877 bool mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
878 struct sk_buff *skb);
879 void __init mptcp_join_cookie_init(void);
882 subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
883 struct sk_buff *skb) {}
885 mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
891 static inline void mptcp_join_cookie_init(void) {}
894 #endif /* __MPTCP_PROTOCOL_H */