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>
14 #include <net/genetlink.h>
16 #define MPTCP_SUPPORTED_VERSION 1
18 /* MPTCP option bits */
19 #define OPTION_MPTCP_MPC_SYN BIT(0)
20 #define OPTION_MPTCP_MPC_SYNACK BIT(1)
21 #define OPTION_MPTCP_MPC_ACK BIT(2)
22 #define OPTION_MPTCP_MPJ_SYN BIT(3)
23 #define OPTION_MPTCP_MPJ_SYNACK BIT(4)
24 #define OPTION_MPTCP_MPJ_ACK BIT(5)
25 #define OPTION_MPTCP_ADD_ADDR BIT(6)
26 #define OPTION_MPTCP_RM_ADDR BIT(7)
27 #define OPTION_MPTCP_FASTCLOSE BIT(8)
28 #define OPTION_MPTCP_PRIO BIT(9)
29 #define OPTION_MPTCP_RST BIT(10)
30 #define OPTION_MPTCP_DSS BIT(11)
31 #define OPTION_MPTCP_FAIL BIT(12)
33 #define OPTION_MPTCP_CSUMREQD BIT(13)
35 #define OPTIONS_MPTCP_MPC (OPTION_MPTCP_MPC_SYN | OPTION_MPTCP_MPC_SYNACK | \
37 #define OPTIONS_MPTCP_MPJ (OPTION_MPTCP_MPJ_SYN | OPTION_MPTCP_MPJ_SYNACK | \
40 /* MPTCP option subtypes */
41 #define MPTCPOPT_MP_CAPABLE 0
42 #define MPTCPOPT_MP_JOIN 1
43 #define MPTCPOPT_DSS 2
44 #define MPTCPOPT_ADD_ADDR 3
45 #define MPTCPOPT_RM_ADDR 4
46 #define MPTCPOPT_MP_PRIO 5
47 #define MPTCPOPT_MP_FAIL 6
48 #define MPTCPOPT_MP_FASTCLOSE 7
49 #define MPTCPOPT_RST 8
51 /* MPTCP suboption lengths */
52 #define TCPOLEN_MPTCP_MPC_SYN 4
53 #define TCPOLEN_MPTCP_MPC_SYNACK 12
54 #define TCPOLEN_MPTCP_MPC_ACK 20
55 #define TCPOLEN_MPTCP_MPC_ACK_DATA 22
56 #define TCPOLEN_MPTCP_MPJ_SYN 12
57 #define TCPOLEN_MPTCP_MPJ_SYNACK 16
58 #define TCPOLEN_MPTCP_MPJ_ACK 24
59 #define TCPOLEN_MPTCP_DSS_BASE 4
60 #define TCPOLEN_MPTCP_DSS_ACK32 4
61 #define TCPOLEN_MPTCP_DSS_ACK64 8
62 #define TCPOLEN_MPTCP_DSS_MAP32 10
63 #define TCPOLEN_MPTCP_DSS_MAP64 14
64 #define TCPOLEN_MPTCP_DSS_CHECKSUM 2
65 #define TCPOLEN_MPTCP_ADD_ADDR 16
66 #define TCPOLEN_MPTCP_ADD_ADDR_PORT 18
67 #define TCPOLEN_MPTCP_ADD_ADDR_BASE 8
68 #define TCPOLEN_MPTCP_ADD_ADDR_BASE_PORT 10
69 #define TCPOLEN_MPTCP_ADD_ADDR6 28
70 #define TCPOLEN_MPTCP_ADD_ADDR6_PORT 30
71 #define TCPOLEN_MPTCP_ADD_ADDR6_BASE 20
72 #define TCPOLEN_MPTCP_ADD_ADDR6_BASE_PORT 22
73 #define TCPOLEN_MPTCP_PORT_LEN 2
74 #define TCPOLEN_MPTCP_PORT_ALIGN 2
75 #define TCPOLEN_MPTCP_RM_ADDR_BASE 3
76 #define TCPOLEN_MPTCP_PRIO 3
77 #define TCPOLEN_MPTCP_PRIO_ALIGN 4
78 #define TCPOLEN_MPTCP_FASTCLOSE 12
79 #define TCPOLEN_MPTCP_RST 4
80 #define TCPOLEN_MPTCP_FAIL 12
82 #define TCPOLEN_MPTCP_MPC_ACK_DATA_CSUM (TCPOLEN_MPTCP_DSS_CHECKSUM + TCPOLEN_MPTCP_MPC_ACK_DATA)
84 /* MPTCP MP_JOIN flags */
85 #define MPTCPOPT_BACKUP BIT(0)
86 #define MPTCPOPT_THMAC_LEN 8
88 /* MPTCP MP_CAPABLE flags */
89 #define MPTCP_VERSION_MASK (0x0F)
90 #define MPTCP_CAP_CHECKSUM_REQD BIT(7)
91 #define MPTCP_CAP_EXTENSIBILITY BIT(6)
92 #define MPTCP_CAP_DENY_JOIN_ID0 BIT(5)
93 #define MPTCP_CAP_HMAC_SHA256 BIT(0)
94 #define MPTCP_CAP_FLAG_MASK (0x1F)
97 #define MPTCP_DSS_DATA_FIN BIT(4)
98 #define MPTCP_DSS_DSN64 BIT(3)
99 #define MPTCP_DSS_HAS_MAP BIT(2)
100 #define MPTCP_DSS_ACK64 BIT(1)
101 #define MPTCP_DSS_HAS_ACK BIT(0)
102 #define MPTCP_DSS_FLAG_MASK (0x1F)
104 /* MPTCP ADD_ADDR flags */
105 #define MPTCP_ADDR_ECHO BIT(0)
107 /* MPTCP MP_PRIO flags */
108 #define MPTCP_PRIO_BKUP BIT(0)
110 /* MPTCP TCPRST flags */
111 #define MPTCP_RST_TRANSIENT BIT(0)
113 /* MPTCP socket atomic flags */
114 #define MPTCP_NOSPACE 1
115 #define MPTCP_WORK_RTX 2
116 #define MPTCP_FALLBACK_DONE 4
117 #define MPTCP_WORK_CLOSE_SUBFLOW 5
119 /* MPTCP socket release cb flags */
120 #define MPTCP_PUSH_PENDING 1
121 #define MPTCP_CLEAN_UNA 2
122 #define MPTCP_ERROR_REPORT 3
123 #define MPTCP_RETRANSMIT 4
124 #define MPTCP_FLUSH_JOIN_LIST 5
125 #define MPTCP_CONNECTED 6
127 struct mptcp_skb_cb {
134 #define MPTCP_SKB_CB(__skb) ((struct mptcp_skb_cb *)&((__skb)->cb[0]))
136 static inline bool before64(__u64 seq1, __u64 seq2)
138 return (__s64)(seq1 - seq2) < 0;
141 #define after64(seq2, seq1) before64(seq1, seq2)
143 struct mptcp_options_received {
168 u8 hmac[MPTCPOPT_HMAC_LEN];
169 struct mptcp_addr_info addr;
170 struct mptcp_rm_list rm_list;
175 static inline __be32 mptcp_option(u8 subopt, u8 len, u8 nib, u8 field)
177 return htonl((TCPOPT_MPTCP << 24) | (len << 16) | (subopt << 12) |
178 ((nib & 0xF) << 8) | field);
181 enum mptcp_pm_status {
182 MPTCP_PM_ADD_ADDR_RECEIVED,
183 MPTCP_PM_ADD_ADDR_SEND_ACK,
184 MPTCP_PM_RM_ADDR_RECEIVED,
185 MPTCP_PM_ESTABLISHED,
186 MPTCP_PM_SUBFLOW_ESTABLISHED,
187 MPTCP_PM_ALREADY_ESTABLISHED, /* persistent status, set after ESTABLISHED event */
188 MPTCP_PM_MPC_ENDPOINT_ACCOUNTED /* persistent status, set after MPC local address is
189 * accounted int id_avail_bitmap
194 MPTCP_PM_TYPE_KERNEL = 0,
195 MPTCP_PM_TYPE_USERSPACE,
198 __MPTCP_PM_TYPE_MAX = __MPTCP_PM_TYPE_NR - 1,
201 /* Status bits below MPTCP_PM_ALREADY_ESTABLISHED need pm worker actions */
202 #define MPTCP_PM_WORK_MASK ((1 << MPTCP_PM_ALREADY_ESTABLISHED) - 1)
204 enum mptcp_addr_signal_status {
205 MPTCP_ADD_ADDR_SIGNAL,
207 MPTCP_RM_ADDR_SIGNAL,
210 /* max value of mptcp_addr_info.id */
211 #define MPTCP_PM_MAX_ADDR_ID U8_MAX
213 struct mptcp_pm_data {
214 struct mptcp_addr_info local;
215 struct mptcp_addr_info remote;
216 struct list_head anno_list;
217 struct list_head userspace_pm_local_addr_list;
219 spinlock_t lock; /*protects the whole PM data */
226 bool remote_deny_join_id0;
227 u8 add_addr_signaled;
228 u8 add_addr_accepted;
233 DECLARE_BITMAP(id_avail_bitmap, MPTCP_PM_MAX_ADDR_ID + 1);
234 struct mptcp_rm_list rm_list_tx;
235 struct mptcp_rm_list rm_list_rx;
238 struct mptcp_pm_addr_entry {
239 struct list_head list;
240 struct mptcp_addr_info addr;
246 struct mptcp_data_frag {
247 struct list_head list;
256 /* MPTCP connection sock */
258 /* inet_connection_sock must be the first member */
259 struct inet_connection_sock sk;
267 atomic64_t rcv_wnd_sent;
268 u64 rcv_data_fin_seq;
273 u64 recovery_snd_nxt; /* in recovery mode accept up to this seq;
274 * recovery related fields are under data_lock
280 unsigned long timer_ival;
284 unsigned long cb_flags;
285 unsigned long push_pending;
286 bool recovery; /* closing subflow write queue reinjected */
288 bool fully_established;
290 bool snd_data_fin_enable;
292 bool use_64bit_ack; /* Set when we received a 64-bit DSN */
294 bool allow_infinite_fallback;
302 struct work_struct work;
303 struct sk_buff *ooo_last_skb;
304 struct rb_root out_of_order_queue;
305 struct sk_buff_head receive_queue;
306 struct list_head conn_list;
307 struct list_head rtx_queue;
308 struct mptcp_data_frag *first_pending;
309 struct list_head join_list;
310 struct sock *first; /* The mptcp ops can safely dereference, using suitable
311 * ONCE annotation, the subflow outside the socket
312 * lock as such sock is freed after close().
314 struct mptcp_pm_data pm;
315 struct mptcp_sched_ops *sched;
317 u32 space; /* bytes copied in last measurement window */
318 u32 copied; /* bytes copied in this measurement window */
319 u64 time; /* start time of measurement window */
320 u64 rtt_us; /* last maximum rtt of subflows */
326 char ca_name[TCP_CA_NAME_MAX];
329 #define mptcp_data_lock(sk) spin_lock_bh(&(sk)->sk_lock.slock)
330 #define mptcp_data_unlock(sk) spin_unlock_bh(&(sk)->sk_lock.slock)
332 #define mptcp_for_each_subflow(__msk, __subflow) \
333 list_for_each_entry(__subflow, &((__msk)->conn_list), node)
334 #define mptcp_for_each_subflow_safe(__msk, __subflow, __tmp) \
335 list_for_each_entry_safe(__subflow, __tmp, &((__msk)->conn_list), node)
337 static inline void msk_owned_by_me(const struct mptcp_sock *msk)
339 sock_owned_by_me((const struct sock *)msk);
342 #define mptcp_sk(ptr) container_of_const(ptr, struct mptcp_sock, sk.icsk_inet.sk)
344 /* the msk socket don't use the backlog, also account for the bulk
347 static inline int __mptcp_rmem(const struct sock *sk)
349 return atomic_read(&sk->sk_rmem_alloc) - READ_ONCE(mptcp_sk(sk)->rmem_released);
352 static inline int mptcp_win_from_space(const struct sock *sk, int space)
354 return __tcp_win_from_space(mptcp_sk(sk)->scaling_ratio, space);
357 static inline int __mptcp_space(const struct sock *sk)
359 return mptcp_win_from_space(sk, READ_ONCE(sk->sk_rcvbuf) - __mptcp_rmem(sk));
362 static inline struct mptcp_data_frag *mptcp_send_head(const struct sock *sk)
364 const struct mptcp_sock *msk = mptcp_sk(sk);
366 return READ_ONCE(msk->first_pending);
369 static inline struct mptcp_data_frag *mptcp_send_next(struct sock *sk)
371 struct mptcp_sock *msk = mptcp_sk(sk);
372 struct mptcp_data_frag *cur;
374 cur = msk->first_pending;
375 return list_is_last(&cur->list, &msk->rtx_queue) ? NULL :
376 list_next_entry(cur, list);
379 static inline struct mptcp_data_frag *mptcp_pending_tail(const struct sock *sk)
381 const struct mptcp_sock *msk = mptcp_sk(sk);
383 if (!msk->first_pending)
386 if (WARN_ON_ONCE(list_empty(&msk->rtx_queue)))
389 return list_last_entry(&msk->rtx_queue, struct mptcp_data_frag, list);
392 static inline struct mptcp_data_frag *mptcp_rtx_head(struct sock *sk)
394 struct mptcp_sock *msk = mptcp_sk(sk);
396 if (msk->snd_una == READ_ONCE(msk->snd_nxt))
399 return list_first_entry_or_null(&msk->rtx_queue, struct mptcp_data_frag, list);
402 struct csum_pseudo_header {
409 struct mptcp_subflow_request_sock {
410 struct tcp_request_sock sk;
425 struct mptcp_sock *msk;
426 struct hlist_nulls_node token_node;
429 static inline struct mptcp_subflow_request_sock *
430 mptcp_subflow_rsk(const struct request_sock *rsk)
432 return (struct mptcp_subflow_request_sock *)rsk;
435 enum mptcp_data_avail {
436 MPTCP_SUBFLOW_NODATA,
437 MPTCP_SUBFLOW_DATA_AVAIL,
440 struct mptcp_delegated_action {
441 struct napi_struct napi;
442 struct list_head head;
445 DECLARE_PER_CPU(struct mptcp_delegated_action, mptcp_delegated_actions);
447 #define MPTCP_DELEGATE_SCHEDULED 0
448 #define MPTCP_DELEGATE_SEND 1
449 #define MPTCP_DELEGATE_ACK 2
451 #define MPTCP_DELEGATE_ACTIONS_MASK (~BIT(MPTCP_DELEGATE_SCHEDULED))
452 /* MPTCP subflow context */
453 struct mptcp_subflow_context {
454 struct list_head node;/* conn_list of subflows */
458 unsigned long avg_pacing_rate; /* protected by msk socket lock */
469 __wsum map_data_csum;
471 u32 request_mptcp : 1, /* send MP_CAPABLE */
472 request_join : 1, /* send MP_JOIN */
474 mp_capable : 1, /* remote is MPTCP capable */
475 mp_join : 1, /* remote is JOINing */
476 fully_established : 1, /* path validated */
477 pm_notified : 1, /* PM hook called for established status */
487 send_infinite_map : 1,
488 remote_key_valid : 1, /* received the peer key from */
489 disposable : 1, /* ctx can be free at ulp release time */
490 stale : 1, /* unable to snd/rcv data, do not use for xmit */
491 local_id_valid : 1, /* local_id is correctly initialized */
492 valid_csum_seen : 1, /* at least one csum validated */
493 is_mptfo : 1, /* subflow is doing TFO */
495 enum mptcp_data_avail data_avail;
502 u8 hmac[MPTCPOPT_HMAC_LEN]; /* MPJ subflow only */
503 u64 iasn; /* initial ack sequence number, MPC subflows only */
508 u8 reset_transient:1;
514 long delegated_status;
515 unsigned long fail_tout;
519 struct list_head delegated_node; /* link into delegated_action, protected by local BH */
522 u32 stale_rcv_tstamp;
524 struct sock *tcp_sock; /* tcp sk backpointer */
525 struct sock *conn; /* parent mptcp_sock */
526 const struct inet_connection_sock_af_ops *icsk_af_ops;
527 void (*tcp_state_change)(struct sock *sk);
528 void (*tcp_error_report)(struct sock *sk);
533 static inline struct mptcp_subflow_context *
534 mptcp_subflow_ctx(const struct sock *sk)
536 struct inet_connection_sock *icsk = inet_csk(sk);
538 /* Use RCU on icsk_ulp_data only for sock diag code */
539 return (__force struct mptcp_subflow_context *)icsk->icsk_ulp_data;
542 static inline struct sock *
543 mptcp_subflow_tcp_sock(const struct mptcp_subflow_context *subflow)
545 return subflow->tcp_sock;
549 mptcp_subflow_ctx_reset(struct mptcp_subflow_context *subflow)
551 memset(&subflow->reset, 0, sizeof(subflow->reset));
552 subflow->request_mptcp = 1;
556 mptcp_subflow_get_map_offset(const struct mptcp_subflow_context *subflow)
558 return tcp_sk(mptcp_subflow_tcp_sock(subflow))->copied_seq -
559 subflow->ssn_offset -
560 subflow->map_subflow_seq;
564 mptcp_subflow_get_mapped_dsn(const struct mptcp_subflow_context *subflow)
566 return subflow->map_seq + mptcp_subflow_get_map_offset(subflow);
569 void mptcp_subflow_process_delegated(struct sock *ssk, long actions);
571 static inline void mptcp_subflow_delegate(struct mptcp_subflow_context *subflow, int action)
573 long old, set_bits = BIT(MPTCP_DELEGATE_SCHEDULED) | BIT(action);
574 struct mptcp_delegated_action *delegated;
577 /* the caller held the subflow bh socket lock */
578 lockdep_assert_in_softirq();
580 /* The implied barrier pairs with tcp_release_cb_override()
581 * mptcp_napi_poll(), and ensures the below list check sees list
582 * updates done prior to delegated status bits changes
584 old = set_mask_bits(&subflow->delegated_status, 0, set_bits);
585 if (!(old & BIT(MPTCP_DELEGATE_SCHEDULED))) {
586 if (WARN_ON_ONCE(!list_empty(&subflow->delegated_node)))
589 delegated = this_cpu_ptr(&mptcp_delegated_actions);
590 schedule = list_empty(&delegated->head);
591 list_add_tail(&subflow->delegated_node, &delegated->head);
592 sock_hold(mptcp_subflow_tcp_sock(subflow));
594 napi_schedule(&delegated->napi);
598 static inline struct mptcp_subflow_context *
599 mptcp_subflow_delegated_next(struct mptcp_delegated_action *delegated)
601 struct mptcp_subflow_context *ret;
603 if (list_empty(&delegated->head))
606 ret = list_first_entry(&delegated->head, struct mptcp_subflow_context, delegated_node);
607 list_del_init(&ret->delegated_node);
611 int mptcp_is_enabled(const struct net *net);
612 unsigned int mptcp_get_add_addr_timeout(const struct net *net);
613 int mptcp_is_checksum_enabled(const struct net *net);
614 int mptcp_allow_join_id0(const struct net *net);
615 unsigned int mptcp_stale_loss_cnt(const struct net *net);
616 int mptcp_get_pm_type(const struct net *net);
617 const char *mptcp_get_scheduler(const struct net *net);
618 void mptcp_subflow_fully_established(struct mptcp_subflow_context *subflow,
619 const struct mptcp_options_received *mp_opt);
620 bool __mptcp_retransmit_pending_data(struct sock *sk);
621 void mptcp_check_and_set_pending(struct sock *sk);
622 void __mptcp_push_pending(struct sock *sk, unsigned int flags);
623 bool mptcp_subflow_data_available(struct sock *sk);
624 void __init mptcp_subflow_init(void);
625 void mptcp_subflow_shutdown(struct sock *sk, struct sock *ssk, int how);
626 void mptcp_close_ssk(struct sock *sk, struct sock *ssk,
627 struct mptcp_subflow_context *subflow);
628 void __mptcp_subflow_send_ack(struct sock *ssk);
629 void mptcp_subflow_reset(struct sock *ssk);
630 void mptcp_subflow_queue_clean(struct sock *sk, struct sock *ssk);
631 void mptcp_sock_graft(struct sock *sk, struct socket *parent);
632 struct sock *__mptcp_nmpc_sk(struct mptcp_sock *msk);
633 bool __mptcp_close(struct sock *sk, long timeout);
634 void mptcp_cancel_work(struct sock *sk);
635 void __mptcp_unaccepted_force_close(struct sock *sk);
636 void mptcp_set_owner_r(struct sk_buff *skb, struct sock *sk);
638 bool mptcp_addresses_equal(const struct mptcp_addr_info *a,
639 const struct mptcp_addr_info *b, bool use_port);
640 void mptcp_local_address(const struct sock_common *skc, struct mptcp_addr_info *addr);
642 /* called with sk socket lock held */
643 int __mptcp_subflow_connect(struct sock *sk, const struct mptcp_addr_info *loc,
644 const struct mptcp_addr_info *remote);
645 int mptcp_subflow_create_socket(struct sock *sk, unsigned short family,
646 struct socket **new_sock);
647 void mptcp_info2sockaddr(const struct mptcp_addr_info *info,
648 struct sockaddr_storage *addr,
649 unsigned short family);
650 struct mptcp_sched_ops *mptcp_sched_find(const char *name);
651 int mptcp_register_scheduler(struct mptcp_sched_ops *sched);
652 void mptcp_unregister_scheduler(struct mptcp_sched_ops *sched);
653 void mptcp_sched_init(void);
654 int mptcp_init_sched(struct mptcp_sock *msk,
655 struct mptcp_sched_ops *sched);
656 void mptcp_release_sched(struct mptcp_sock *msk);
657 void mptcp_subflow_set_scheduled(struct mptcp_subflow_context *subflow,
659 struct sock *mptcp_subflow_get_send(struct mptcp_sock *msk);
660 struct sock *mptcp_subflow_get_retrans(struct mptcp_sock *msk);
661 int mptcp_sched_get_send(struct mptcp_sock *msk);
662 int mptcp_sched_get_retrans(struct mptcp_sock *msk);
664 static inline bool __tcp_can_send(const struct sock *ssk)
666 /* only send if our side has not closed yet */
667 return ((1 << inet_sk_state_load(ssk)) & (TCPF_ESTABLISHED | TCPF_CLOSE_WAIT));
670 static inline bool __mptcp_subflow_active(struct mptcp_subflow_context *subflow)
672 /* can't send if JOIN hasn't completed yet (i.e. is usable for mptcp) */
673 if (subflow->request_join && !subflow->fully_established)
676 return __tcp_can_send(mptcp_subflow_tcp_sock(subflow));
679 void mptcp_subflow_set_active(struct mptcp_subflow_context *subflow);
681 bool mptcp_subflow_active(struct mptcp_subflow_context *subflow);
683 void mptcp_subflow_drop_ctx(struct sock *ssk);
685 static inline void mptcp_subflow_tcp_fallback(struct sock *sk,
686 struct mptcp_subflow_context *ctx)
688 sk->sk_data_ready = sock_def_readable;
689 sk->sk_state_change = ctx->tcp_state_change;
690 sk->sk_write_space = sk_stream_write_space;
691 sk->sk_error_report = ctx->tcp_error_report;
693 inet_csk(sk)->icsk_af_ops = ctx->icsk_af_ops;
696 void __init mptcp_proto_init(void);
697 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
698 int __init mptcp_proto_v6_init(void);
701 struct sock *mptcp_sk_clone_init(const struct sock *sk,
702 const struct mptcp_options_received *mp_opt,
704 struct request_sock *req);
705 void mptcp_get_options(const struct sk_buff *skb,
706 struct mptcp_options_received *mp_opt);
708 void mptcp_finish_connect(struct sock *sk);
709 void __mptcp_set_connected(struct sock *sk);
710 void mptcp_reset_tout_timer(struct mptcp_sock *msk, unsigned long fail_tout);
712 static inline void mptcp_stop_tout_timer(struct sock *sk)
714 if (!inet_csk(sk)->icsk_mtup.probe_timestamp)
717 sk_stop_timer(sk, &sk->sk_timer);
718 inet_csk(sk)->icsk_mtup.probe_timestamp = 0;
721 static inline void mptcp_set_close_tout(struct sock *sk, unsigned long tout)
723 /* avoid 0 timestamp, as that means no close timeout */
724 inet_csk(sk)->icsk_mtup.probe_timestamp = tout ? : 1;
727 static inline void mptcp_start_tout_timer(struct sock *sk)
729 mptcp_set_close_tout(sk, tcp_jiffies32);
730 mptcp_reset_tout_timer(mptcp_sk(sk), 0);
733 static inline bool mptcp_is_fully_established(struct sock *sk)
735 return inet_sk_state_load(sk) == TCP_ESTABLISHED &&
736 READ_ONCE(mptcp_sk(sk)->fully_established);
738 void mptcp_rcv_space_init(struct mptcp_sock *msk, const struct sock *ssk);
739 void mptcp_data_ready(struct sock *sk, struct sock *ssk);
740 bool mptcp_finish_join(struct sock *sk);
741 bool mptcp_schedule_work(struct sock *sk);
742 int mptcp_setsockopt(struct sock *sk, int level, int optname,
743 sockptr_t optval, unsigned int optlen);
744 int mptcp_getsockopt(struct sock *sk, int level, int optname,
745 char __user *optval, int __user *option);
747 u64 __mptcp_expand_seq(u64 old_seq, u64 cur_seq);
748 static inline u64 mptcp_expand_seq(u64 old_seq, u64 cur_seq, bool use_64bit)
753 return __mptcp_expand_seq(old_seq, cur_seq);
755 void __mptcp_check_push(struct sock *sk, struct sock *ssk);
756 void __mptcp_data_acked(struct sock *sk);
757 void __mptcp_error_report(struct sock *sk);
758 bool mptcp_update_rcv_data_fin(struct mptcp_sock *msk, u64 data_fin_seq, bool use_64bit);
759 static inline bool mptcp_data_fin_enabled(const struct mptcp_sock *msk)
761 return READ_ONCE(msk->snd_data_fin_enable) &&
762 READ_ONCE(msk->write_seq) == READ_ONCE(msk->snd_nxt);
765 static inline bool mptcp_propagate_sndbuf(struct sock *sk, struct sock *ssk)
767 if ((sk->sk_userlocks & SOCK_SNDBUF_LOCK) || ssk->sk_sndbuf <= READ_ONCE(sk->sk_sndbuf))
770 WRITE_ONCE(sk->sk_sndbuf, ssk->sk_sndbuf);
774 static inline void mptcp_write_space(struct sock *sk)
776 if (sk_stream_is_writeable(sk)) {
777 /* pairs with memory barrier in mptcp_poll */
779 if (test_and_clear_bit(MPTCP_NOSPACE, &mptcp_sk(sk)->flags))
780 sk_stream_write_space(sk);
784 void mptcp_destroy_common(struct mptcp_sock *msk, unsigned int flags);
786 #define MPTCP_TOKEN_MAX_RETRIES 4
788 void __init mptcp_token_init(void);
789 static inline void mptcp_token_init_request(struct request_sock *req)
791 mptcp_subflow_rsk(req)->token_node.pprev = NULL;
794 int mptcp_token_new_request(struct request_sock *req);
795 void mptcp_token_destroy_request(struct request_sock *req);
796 int mptcp_token_new_connect(struct sock *ssk);
797 void mptcp_token_accept(struct mptcp_subflow_request_sock *r,
798 struct mptcp_sock *msk);
799 bool mptcp_token_exists(u32 token);
800 struct mptcp_sock *mptcp_token_get_sock(struct net *net, u32 token);
801 struct mptcp_sock *mptcp_token_iter_next(const struct net *net, long *s_slot,
803 void mptcp_token_destroy(struct mptcp_sock *msk);
805 void mptcp_crypto_key_sha(u64 key, u32 *token, u64 *idsn);
807 void mptcp_crypto_hmac_sha(u64 key1, u64 key2, u8 *msg, int len, void *hmac);
808 __sum16 __mptcp_make_csum(u64 data_seq, u32 subflow_seq, u16 data_len, __wsum sum);
810 void __init mptcp_pm_init(void);
811 void mptcp_pm_data_init(struct mptcp_sock *msk);
812 void mptcp_pm_data_reset(struct mptcp_sock *msk);
813 int mptcp_pm_parse_addr(struct nlattr *attr, struct genl_info *info,
814 struct mptcp_addr_info *addr);
815 int mptcp_pm_parse_entry(struct nlattr *attr, struct genl_info *info,
817 struct mptcp_pm_addr_entry *entry);
818 bool mptcp_pm_addr_families_match(const struct sock *sk,
819 const struct mptcp_addr_info *loc,
820 const struct mptcp_addr_info *rem);
821 void mptcp_pm_subflow_chk_stale(const struct mptcp_sock *msk, struct sock *ssk);
822 void mptcp_pm_nl_subflow_chk_stale(const struct mptcp_sock *msk, struct sock *ssk);
823 void mptcp_pm_new_connection(struct mptcp_sock *msk, const struct sock *ssk, int server_side);
824 void mptcp_pm_fully_established(struct mptcp_sock *msk, const struct sock *ssk);
825 bool mptcp_pm_allow_new_subflow(struct mptcp_sock *msk);
826 void mptcp_pm_connection_closed(struct mptcp_sock *msk);
827 void mptcp_pm_subflow_established(struct mptcp_sock *msk);
828 bool mptcp_pm_nl_check_work_pending(struct mptcp_sock *msk);
829 void mptcp_pm_subflow_check_next(struct mptcp_sock *msk, const struct sock *ssk,
830 const struct mptcp_subflow_context *subflow);
831 void mptcp_pm_add_addr_received(const struct sock *ssk,
832 const struct mptcp_addr_info *addr);
833 void mptcp_pm_add_addr_echoed(struct mptcp_sock *msk,
834 const struct mptcp_addr_info *addr);
835 void mptcp_pm_add_addr_send_ack(struct mptcp_sock *msk);
836 void mptcp_pm_nl_addr_send_ack(struct mptcp_sock *msk);
837 void mptcp_pm_rm_addr_received(struct mptcp_sock *msk,
838 const struct mptcp_rm_list *rm_list);
839 void mptcp_pm_mp_prio_received(struct sock *sk, u8 bkup);
840 void mptcp_pm_mp_fail_received(struct sock *sk, u64 fail_seq);
841 int mptcp_pm_nl_mp_prio_send_ack(struct mptcp_sock *msk,
842 struct mptcp_addr_info *addr,
843 struct mptcp_addr_info *rem,
845 bool mptcp_pm_alloc_anno_list(struct mptcp_sock *msk,
846 const struct mptcp_addr_info *addr);
847 void mptcp_pm_free_anno_list(struct mptcp_sock *msk);
848 bool mptcp_pm_sport_in_anno_list(struct mptcp_sock *msk, const struct sock *sk);
849 struct mptcp_pm_add_entry *
850 mptcp_pm_del_add_timer(struct mptcp_sock *msk,
851 const struct mptcp_addr_info *addr, bool check_id);
852 struct mptcp_pm_add_entry *
853 mptcp_lookup_anno_list_by_saddr(const struct mptcp_sock *msk,
854 const struct mptcp_addr_info *addr);
855 int mptcp_pm_get_flags_and_ifindex_by_id(struct mptcp_sock *msk,
857 u8 *flags, int *ifindex);
858 int mptcp_pm_nl_get_flags_and_ifindex_by_id(struct mptcp_sock *msk, unsigned int id,
859 u8 *flags, int *ifindex);
860 int mptcp_userspace_pm_get_flags_and_ifindex_by_id(struct mptcp_sock *msk,
862 u8 *flags, int *ifindex);
863 int mptcp_pm_set_flags(struct net *net, struct nlattr *token,
864 struct mptcp_pm_addr_entry *loc,
865 struct mptcp_pm_addr_entry *rem, u8 bkup);
866 int mptcp_pm_nl_set_flags(struct net *net, struct mptcp_pm_addr_entry *addr, u8 bkup);
867 int mptcp_userspace_pm_set_flags(struct net *net, struct nlattr *token,
868 struct mptcp_pm_addr_entry *loc,
869 struct mptcp_pm_addr_entry *rem, u8 bkup);
870 int mptcp_pm_announce_addr(struct mptcp_sock *msk,
871 const struct mptcp_addr_info *addr,
873 int mptcp_pm_remove_addr(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
874 int mptcp_pm_remove_subflow(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
875 void mptcp_pm_remove_addrs(struct mptcp_sock *msk, struct list_head *rm_list);
876 void mptcp_pm_remove_addrs_and_subflows(struct mptcp_sock *msk,
877 struct list_head *rm_list);
879 void mptcp_free_local_addr_list(struct mptcp_sock *msk);
880 int mptcp_nl_cmd_announce(struct sk_buff *skb, struct genl_info *info);
881 int mptcp_nl_cmd_remove(struct sk_buff *skb, struct genl_info *info);
882 int mptcp_nl_cmd_sf_create(struct sk_buff *skb, struct genl_info *info);
883 int mptcp_nl_cmd_sf_destroy(struct sk_buff *skb, struct genl_info *info);
885 void mptcp_event(enum mptcp_event_type type, const struct mptcp_sock *msk,
886 const struct sock *ssk, gfp_t gfp);
887 void mptcp_event_addr_announced(const struct sock *ssk, const struct mptcp_addr_info *info);
888 void mptcp_event_addr_removed(const struct mptcp_sock *msk, u8 id);
889 void mptcp_event_pm_listener(const struct sock *ssk,
890 enum mptcp_event_type event);
891 bool mptcp_userspace_pm_active(const struct mptcp_sock *msk);
893 void mptcp_fastopen_gen_msk_ackseq(struct mptcp_sock *msk, struct mptcp_subflow_context *subflow,
894 const struct mptcp_options_received *mp_opt);
895 void mptcp_fastopen_subflow_synack_set_params(struct mptcp_subflow_context *subflow,
896 struct request_sock *req);
898 static inline bool mptcp_pm_should_add_signal(struct mptcp_sock *msk)
900 return READ_ONCE(msk->pm.addr_signal) &
901 (BIT(MPTCP_ADD_ADDR_SIGNAL) | BIT(MPTCP_ADD_ADDR_ECHO));
904 static inline bool mptcp_pm_should_add_signal_addr(struct mptcp_sock *msk)
906 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_SIGNAL);
909 static inline bool mptcp_pm_should_add_signal_echo(struct mptcp_sock *msk)
911 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_ECHO);
914 static inline bool mptcp_pm_should_rm_signal(struct mptcp_sock *msk)
916 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_RM_ADDR_SIGNAL);
919 static inline bool mptcp_pm_is_userspace(const struct mptcp_sock *msk)
921 return READ_ONCE(msk->pm.pm_type) == MPTCP_PM_TYPE_USERSPACE;
924 static inline bool mptcp_pm_is_kernel(const struct mptcp_sock *msk)
926 return READ_ONCE(msk->pm.pm_type) == MPTCP_PM_TYPE_KERNEL;
929 static inline unsigned int mptcp_add_addr_len(int family, bool echo, bool port)
931 u8 len = TCPOLEN_MPTCP_ADD_ADDR_BASE;
933 if (family == AF_INET6)
934 len = TCPOLEN_MPTCP_ADD_ADDR6_BASE;
936 len += MPTCPOPT_THMAC_LEN;
937 /* account for 2 trailing 'nop' options */
939 len += TCPOLEN_MPTCP_PORT_LEN + TCPOLEN_MPTCP_PORT_ALIGN;
944 static inline int mptcp_rm_addr_len(const struct mptcp_rm_list *rm_list)
946 if (rm_list->nr == 0 || rm_list->nr > MPTCP_RM_IDS_MAX)
949 return TCPOLEN_MPTCP_RM_ADDR_BASE + roundup(rm_list->nr - 1, 4) + 1;
952 bool mptcp_pm_add_addr_signal(struct mptcp_sock *msk, const struct sk_buff *skb,
953 unsigned int opt_size, unsigned int remaining,
954 struct mptcp_addr_info *addr, bool *echo,
955 bool *drop_other_suboptions);
956 bool mptcp_pm_rm_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
957 struct mptcp_rm_list *rm_list);
958 int mptcp_pm_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
959 int mptcp_pm_nl_get_local_id(struct mptcp_sock *msk, struct mptcp_addr_info *skc);
960 int mptcp_userspace_pm_get_local_id(struct mptcp_sock *msk, struct mptcp_addr_info *skc);
962 void __init mptcp_pm_nl_init(void);
963 void mptcp_pm_nl_work(struct mptcp_sock *msk);
964 void mptcp_pm_nl_rm_subflow_received(struct mptcp_sock *msk,
965 const struct mptcp_rm_list *rm_list);
966 unsigned int mptcp_pm_get_add_addr_signal_max(const struct mptcp_sock *msk);
967 unsigned int mptcp_pm_get_add_addr_accept_max(const struct mptcp_sock *msk);
968 unsigned int mptcp_pm_get_subflows_max(const struct mptcp_sock *msk);
969 unsigned int mptcp_pm_get_local_addr_max(const struct mptcp_sock *msk);
971 /* called under PM lock */
972 static inline void __mptcp_pm_close_subflow(struct mptcp_sock *msk)
974 if (--msk->pm.subflows < mptcp_pm_get_subflows_max(msk))
975 WRITE_ONCE(msk->pm.accept_subflow, true);
978 static inline void mptcp_pm_close_subflow(struct mptcp_sock *msk)
980 spin_lock_bh(&msk->pm.lock);
981 __mptcp_pm_close_subflow(msk);
982 spin_unlock_bh(&msk->pm.lock);
985 void mptcp_sockopt_sync(struct mptcp_sock *msk, struct sock *ssk);
986 void mptcp_sockopt_sync_locked(struct mptcp_sock *msk, struct sock *ssk);
988 static inline struct mptcp_ext *mptcp_get_ext(const struct sk_buff *skb)
990 return (struct mptcp_ext *)skb_ext_find(skb, SKB_EXT_MPTCP);
993 void mptcp_diag_subflow_init(struct tcp_ulp_ops *ops);
995 static inline bool __mptcp_check_fallback(const struct mptcp_sock *msk)
997 return test_bit(MPTCP_FALLBACK_DONE, &msk->flags);
1000 static inline bool mptcp_check_fallback(const struct sock *sk)
1002 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
1003 struct mptcp_sock *msk = mptcp_sk(subflow->conn);
1005 return __mptcp_check_fallback(msk);
1008 static inline void __mptcp_do_fallback(struct mptcp_sock *msk)
1010 if (test_bit(MPTCP_FALLBACK_DONE, &msk->flags)) {
1011 pr_debug("TCP fallback already done (msk=%p)", msk);
1014 set_bit(MPTCP_FALLBACK_DONE, &msk->flags);
1017 static inline void mptcp_do_fallback(struct sock *ssk)
1019 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(ssk);
1020 struct sock *sk = subflow->conn;
1021 struct mptcp_sock *msk;
1024 __mptcp_do_fallback(msk);
1025 if (READ_ONCE(msk->snd_data_fin_enable) && !(ssk->sk_shutdown & SEND_SHUTDOWN)) {
1026 gfp_t saved_allocation = ssk->sk_allocation;
1028 /* we are in a atomic (BH) scope, override ssk default for data
1031 ssk->sk_allocation = GFP_ATOMIC;
1032 ssk->sk_shutdown |= SEND_SHUTDOWN;
1033 tcp_shutdown(ssk, SEND_SHUTDOWN);
1034 ssk->sk_allocation = saved_allocation;
1038 #define pr_fallback(a) pr_debug("%s:fallback to TCP (msk=%p)", __func__, a)
1040 static inline bool mptcp_check_infinite_map(struct sk_buff *skb)
1042 struct mptcp_ext *mpext;
1044 mpext = skb ? mptcp_get_ext(skb) : NULL;
1045 if (mpext && mpext->infinite_map)
1051 static inline bool is_active_ssk(struct mptcp_subflow_context *subflow)
1053 return (subflow->request_mptcp || subflow->request_join);
1056 static inline bool subflow_simultaneous_connect(struct sock *sk)
1058 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
1060 return sk->sk_state == TCP_ESTABLISHED &&
1061 is_active_ssk(subflow) &&
1062 !subflow->conn_finished;
1065 #ifdef CONFIG_SYN_COOKIES
1066 void subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
1067 struct sk_buff *skb);
1068 bool mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
1069 struct sk_buff *skb);
1070 void __init mptcp_join_cookie_init(void);
1073 subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
1074 struct sk_buff *skb) {}
1076 mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
1077 struct sk_buff *skb)
1082 static inline void mptcp_join_cookie_init(void) {}
1085 #endif /* __MPTCP_PROTOCOL_H */