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_WORK_EOF 3
117 #define MPTCP_FALLBACK_DONE 4
118 #define MPTCP_WORK_CLOSE_SUBFLOW 5
120 /* MPTCP socket release cb flags */
121 #define MPTCP_PUSH_PENDING 1
122 #define MPTCP_CLEAN_UNA 2
123 #define MPTCP_ERROR_REPORT 3
124 #define MPTCP_RETRANSMIT 4
125 #define MPTCP_FLUSH_JOIN_LIST 5
126 #define MPTCP_CONNECTED 6
127 #define MPTCP_RESET_SCHEDULER 7
129 static inline bool before64(__u64 seq1, __u64 seq2)
131 return (__s64)(seq1 - seq2) < 0;
134 #define after64(seq2, seq1) before64(seq1, seq2)
136 struct mptcp_options_received {
161 u8 hmac[MPTCPOPT_HMAC_LEN];
162 struct mptcp_addr_info addr;
163 struct mptcp_rm_list rm_list;
168 static inline __be32 mptcp_option(u8 subopt, u8 len, u8 nib, u8 field)
170 return htonl((TCPOPT_MPTCP << 24) | (len << 16) | (subopt << 12) |
171 ((nib & 0xF) << 8) | field);
174 enum mptcp_pm_status {
175 MPTCP_PM_ADD_ADDR_RECEIVED,
176 MPTCP_PM_ADD_ADDR_SEND_ACK,
177 MPTCP_PM_RM_ADDR_RECEIVED,
178 MPTCP_PM_ESTABLISHED,
179 MPTCP_PM_SUBFLOW_ESTABLISHED,
180 MPTCP_PM_ALREADY_ESTABLISHED, /* persistent status, set after ESTABLISHED event */
181 MPTCP_PM_MPC_ENDPOINT_ACCOUNTED /* persistent status, set after MPC local address is
182 * accounted int id_avail_bitmap
187 MPTCP_PM_TYPE_KERNEL = 0,
188 MPTCP_PM_TYPE_USERSPACE,
191 __MPTCP_PM_TYPE_MAX = __MPTCP_PM_TYPE_NR - 1,
194 /* Status bits below MPTCP_PM_ALREADY_ESTABLISHED need pm worker actions */
195 #define MPTCP_PM_WORK_MASK ((1 << MPTCP_PM_ALREADY_ESTABLISHED) - 1)
197 enum mptcp_addr_signal_status {
198 MPTCP_ADD_ADDR_SIGNAL,
200 MPTCP_RM_ADDR_SIGNAL,
203 /* max value of mptcp_addr_info.id */
204 #define MPTCP_PM_MAX_ADDR_ID U8_MAX
206 struct mptcp_pm_data {
207 struct mptcp_addr_info local;
208 struct mptcp_addr_info remote;
209 struct list_head anno_list;
210 struct list_head userspace_pm_local_addr_list;
212 spinlock_t lock; /*protects the whole PM data */
219 bool remote_deny_join_id0;
220 u8 add_addr_signaled;
221 u8 add_addr_accepted;
226 DECLARE_BITMAP(id_avail_bitmap, MPTCP_PM_MAX_ADDR_ID + 1);
227 struct mptcp_rm_list rm_list_tx;
228 struct mptcp_rm_list rm_list_rx;
231 struct mptcp_pm_addr_entry {
232 struct list_head list;
233 struct mptcp_addr_info addr;
239 struct mptcp_data_frag {
240 struct list_head list;
249 /* MPTCP connection sock */
251 /* inet_connection_sock must be the first member */
252 struct inet_connection_sock sk;
258 atomic64_t rcv_wnd_sent;
259 u64 rcv_data_fin_seq;
261 struct sock *last_snd;
264 u64 recovery_snd_nxt; /* in recovery mode accept up to this seq;
265 * recovery related fields are under data_lock
270 unsigned long timer_ival;
274 unsigned long cb_flags;
275 unsigned long push_pending;
276 bool recovery; /* closing subflow write queue reinjected */
278 bool fully_established;
280 bool snd_data_fin_enable;
282 bool use_64bit_ack; /* Set when we received a 64-bit DSN */
284 bool allow_infinite_fallback;
291 struct work_struct work;
292 struct sk_buff *ooo_last_skb;
293 struct rb_root out_of_order_queue;
294 struct sk_buff_head receive_queue;
295 struct list_head conn_list;
296 struct list_head rtx_queue;
297 struct mptcp_data_frag *first_pending;
298 struct list_head join_list;
299 struct socket *subflow; /* outgoing connect/listener/!mp_capable
300 * The mptcp ops can safely dereference, using suitable
301 * ONCE annotation, the subflow outside the socket
302 * lock as such sock is freed after close().
305 struct mptcp_pm_data pm;
307 u32 space; /* bytes copied in last measurement window */
308 u32 copied; /* bytes copied in this measurement window */
309 u64 time; /* start time of measurement window */
310 u64 rtt_us; /* last maximum rtt of subflows */
314 char ca_name[TCP_CA_NAME_MAX];
317 #define mptcp_data_lock(sk) spin_lock_bh(&(sk)->sk_lock.slock)
318 #define mptcp_data_unlock(sk) spin_unlock_bh(&(sk)->sk_lock.slock)
320 #define mptcp_for_each_subflow(__msk, __subflow) \
321 list_for_each_entry(__subflow, &((__msk)->conn_list), node)
322 #define mptcp_for_each_subflow_safe(__msk, __subflow, __tmp) \
323 list_for_each_entry_safe(__subflow, __tmp, &((__msk)->conn_list), node)
325 static inline void msk_owned_by_me(const struct mptcp_sock *msk)
327 sock_owned_by_me((const struct sock *)msk);
330 static inline struct mptcp_sock *mptcp_sk(const struct sock *sk)
332 return (struct mptcp_sock *)sk;
335 /* the msk socket don't use the backlog, also account for the bulk
338 static inline int __mptcp_rmem(const struct sock *sk)
340 return atomic_read(&sk->sk_rmem_alloc) - READ_ONCE(mptcp_sk(sk)->rmem_released);
343 static inline int __mptcp_space(const struct sock *sk)
345 return tcp_win_from_space(sk, READ_ONCE(sk->sk_rcvbuf) - __mptcp_rmem(sk));
348 static inline struct mptcp_data_frag *mptcp_send_head(const struct sock *sk)
350 const struct mptcp_sock *msk = mptcp_sk(sk);
352 return READ_ONCE(msk->first_pending);
355 static inline struct mptcp_data_frag *mptcp_send_next(struct sock *sk)
357 struct mptcp_sock *msk = mptcp_sk(sk);
358 struct mptcp_data_frag *cur;
360 cur = msk->first_pending;
361 return list_is_last(&cur->list, &msk->rtx_queue) ? NULL :
362 list_next_entry(cur, list);
365 static inline struct mptcp_data_frag *mptcp_pending_tail(const struct sock *sk)
367 struct mptcp_sock *msk = mptcp_sk(sk);
369 if (!msk->first_pending)
372 if (WARN_ON_ONCE(list_empty(&msk->rtx_queue)))
375 return list_last_entry(&msk->rtx_queue, struct mptcp_data_frag, list);
378 static inline struct mptcp_data_frag *mptcp_rtx_head(const struct sock *sk)
380 struct mptcp_sock *msk = mptcp_sk(sk);
382 if (msk->snd_una == READ_ONCE(msk->snd_nxt))
385 return list_first_entry_or_null(&msk->rtx_queue, struct mptcp_data_frag, list);
388 struct csum_pseudo_header {
395 struct mptcp_subflow_request_sock {
396 struct tcp_request_sock sk;
411 struct mptcp_sock *msk;
412 struct hlist_nulls_node token_node;
415 static inline struct mptcp_subflow_request_sock *
416 mptcp_subflow_rsk(const struct request_sock *rsk)
418 return (struct mptcp_subflow_request_sock *)rsk;
421 enum mptcp_data_avail {
422 MPTCP_SUBFLOW_NODATA,
423 MPTCP_SUBFLOW_DATA_AVAIL,
426 struct mptcp_delegated_action {
427 struct napi_struct napi;
428 struct list_head head;
431 DECLARE_PER_CPU(struct mptcp_delegated_action, mptcp_delegated_actions);
433 #define MPTCP_DELEGATE_SEND 0
434 #define MPTCP_DELEGATE_ACK 1
436 /* MPTCP subflow context */
437 struct mptcp_subflow_context {
438 struct list_head node;/* conn_list of subflows */
442 unsigned long avg_pacing_rate; /* protected by msk socket lock */
453 __wsum map_data_csum;
455 u32 request_mptcp : 1, /* send MP_CAPABLE */
456 request_join : 1, /* send MP_JOIN */
458 mp_capable : 1, /* remote is MPTCP capable */
459 mp_join : 1, /* remote is JOINing */
460 fully_established : 1, /* path validated */
461 pm_notified : 1, /* PM hook called for established status */
471 send_infinite_map : 1,
473 can_ack : 1, /* only after processing the remote a key */
474 disposable : 1, /* ctx can be free at ulp release time */
475 stale : 1, /* unable to snd/rcv data, do not use for xmit */
476 local_id_valid : 1, /* local_id is correctly initialized */
477 valid_csum_seen : 1; /* at least one csum validated */
478 enum mptcp_data_avail data_avail;
483 u8 hmac[MPTCPOPT_HMAC_LEN];
487 u8 reset_transient:1;
491 long delegated_status;
492 unsigned long fail_tout;
496 struct list_head delegated_node; /* link into delegated_action, protected by local BH */
499 u32 stale_rcv_tstamp;
501 struct sock *tcp_sock; /* tcp sk backpointer */
502 struct sock *conn; /* parent mptcp_sock */
503 const struct inet_connection_sock_af_ops *icsk_af_ops;
504 void (*tcp_state_change)(struct sock *sk);
505 void (*tcp_error_report)(struct sock *sk);
510 static inline struct mptcp_subflow_context *
511 mptcp_subflow_ctx(const struct sock *sk)
513 struct inet_connection_sock *icsk = inet_csk(sk);
515 /* Use RCU on icsk_ulp_data only for sock diag code */
516 return (__force struct mptcp_subflow_context *)icsk->icsk_ulp_data;
519 static inline struct sock *
520 mptcp_subflow_tcp_sock(const struct mptcp_subflow_context *subflow)
522 return subflow->tcp_sock;
526 mptcp_subflow_ctx_reset(struct mptcp_subflow_context *subflow)
528 memset(&subflow->reset, 0, sizeof(subflow->reset));
529 subflow->request_mptcp = 1;
533 mptcp_subflow_get_map_offset(const struct mptcp_subflow_context *subflow)
535 return tcp_sk(mptcp_subflow_tcp_sock(subflow))->copied_seq -
536 subflow->ssn_offset -
537 subflow->map_subflow_seq;
541 mptcp_subflow_get_mapped_dsn(const struct mptcp_subflow_context *subflow)
543 return subflow->map_seq + mptcp_subflow_get_map_offset(subflow);
546 void mptcp_subflow_process_delegated(struct sock *ssk);
548 static inline void mptcp_subflow_delegate(struct mptcp_subflow_context *subflow, int action)
550 struct mptcp_delegated_action *delegated;
553 /* the caller held the subflow bh socket lock */
554 lockdep_assert_in_softirq();
556 /* The implied barrier pairs with mptcp_subflow_delegated_done(), and
557 * ensures the below list check sees list updates done prior to status
560 if (!test_and_set_bit(action, &subflow->delegated_status)) {
561 /* still on delegated list from previous scheduling */
562 if (!list_empty(&subflow->delegated_node))
565 delegated = this_cpu_ptr(&mptcp_delegated_actions);
566 schedule = list_empty(&delegated->head);
567 list_add_tail(&subflow->delegated_node, &delegated->head);
568 sock_hold(mptcp_subflow_tcp_sock(subflow));
570 napi_schedule(&delegated->napi);
574 static inline struct mptcp_subflow_context *
575 mptcp_subflow_delegated_next(struct mptcp_delegated_action *delegated)
577 struct mptcp_subflow_context *ret;
579 if (list_empty(&delegated->head))
582 ret = list_first_entry(&delegated->head, struct mptcp_subflow_context, delegated_node);
583 list_del_init(&ret->delegated_node);
587 static inline bool mptcp_subflow_has_delegated_action(const struct mptcp_subflow_context *subflow)
589 return !!READ_ONCE(subflow->delegated_status);
592 static inline void mptcp_subflow_delegated_done(struct mptcp_subflow_context *subflow, int action)
594 /* pairs with mptcp_subflow_delegate, ensures delegate_node is updated before
595 * touching the status bit
598 clear_bit(action, &subflow->delegated_status);
601 int mptcp_is_enabled(const struct net *net);
602 unsigned int mptcp_get_add_addr_timeout(const struct net *net);
603 int mptcp_is_checksum_enabled(const struct net *net);
604 int mptcp_allow_join_id0(const struct net *net);
605 unsigned int mptcp_stale_loss_cnt(const struct net *net);
606 int mptcp_get_pm_type(const struct net *net);
607 void mptcp_subflow_fully_established(struct mptcp_subflow_context *subflow,
608 struct mptcp_options_received *mp_opt);
609 bool __mptcp_retransmit_pending_data(struct sock *sk);
610 void mptcp_check_and_set_pending(struct sock *sk);
611 void __mptcp_push_pending(struct sock *sk, unsigned int flags);
612 bool mptcp_subflow_data_available(struct sock *sk);
613 void __init mptcp_subflow_init(void);
614 void mptcp_subflow_shutdown(struct sock *sk, struct sock *ssk, int how);
615 void mptcp_close_ssk(struct sock *sk, struct sock *ssk,
616 struct mptcp_subflow_context *subflow);
617 void __mptcp_subflow_send_ack(struct sock *ssk);
618 void mptcp_subflow_reset(struct sock *ssk);
619 void mptcp_subflow_queue_clean(struct sock *sk, struct sock *ssk);
620 void mptcp_sock_graft(struct sock *sk, struct socket *parent);
621 struct socket *__mptcp_nmpc_socket(const struct mptcp_sock *msk);
622 bool __mptcp_close(struct sock *sk, long timeout);
623 void mptcp_cancel_work(struct sock *sk);
624 void __mptcp_unaccepted_force_close(struct sock *sk);
626 bool mptcp_addresses_equal(const struct mptcp_addr_info *a,
627 const struct mptcp_addr_info *b, bool use_port);
629 /* called with sk socket lock held */
630 int __mptcp_subflow_connect(struct sock *sk, const struct mptcp_addr_info *loc,
631 const struct mptcp_addr_info *remote);
632 int mptcp_subflow_create_socket(struct sock *sk, unsigned short family,
633 struct socket **new_sock);
634 void mptcp_info2sockaddr(const struct mptcp_addr_info *info,
635 struct sockaddr_storage *addr,
636 unsigned short family);
638 static inline bool __tcp_can_send(const struct sock *ssk)
640 /* only send if our side has not closed yet */
641 return ((1 << inet_sk_state_load(ssk)) & (TCPF_ESTABLISHED | TCPF_CLOSE_WAIT));
644 static inline bool __mptcp_subflow_active(struct mptcp_subflow_context *subflow)
646 /* can't send if JOIN hasn't completed yet (i.e. is usable for mptcp) */
647 if (subflow->request_join && !subflow->fully_established)
650 return __tcp_can_send(mptcp_subflow_tcp_sock(subflow));
653 void mptcp_subflow_set_active(struct mptcp_subflow_context *subflow);
655 bool mptcp_subflow_active(struct mptcp_subflow_context *subflow);
657 void mptcp_subflow_drop_ctx(struct sock *ssk);
659 static inline void mptcp_subflow_tcp_fallback(struct sock *sk,
660 struct mptcp_subflow_context *ctx)
662 sk->sk_data_ready = sock_def_readable;
663 sk->sk_state_change = ctx->tcp_state_change;
664 sk->sk_write_space = sk_stream_write_space;
665 sk->sk_error_report = ctx->tcp_error_report;
667 inet_csk(sk)->icsk_af_ops = ctx->icsk_af_ops;
670 void __init mptcp_proto_init(void);
671 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
672 int __init mptcp_proto_v6_init(void);
675 struct sock *mptcp_sk_clone_init(const struct sock *sk,
676 const struct mptcp_options_received *mp_opt,
678 struct request_sock *req);
679 void mptcp_get_options(const struct sk_buff *skb,
680 struct mptcp_options_received *mp_opt);
682 void mptcp_finish_connect(struct sock *sk);
683 void __mptcp_set_connected(struct sock *sk);
684 void mptcp_reset_tout_timer(struct mptcp_sock *msk, unsigned long fail_tout);
686 static inline void mptcp_stop_tout_timer(struct sock *sk)
688 if (!inet_csk(sk)->icsk_mtup.probe_timestamp)
691 sk_stop_timer(sk, &sk->sk_timer);
692 inet_csk(sk)->icsk_mtup.probe_timestamp = 0;
695 static inline void mptcp_set_close_tout(struct sock *sk, unsigned long tout)
697 /* avoid 0 timestamp, as that means no close timeout */
698 inet_csk(sk)->icsk_mtup.probe_timestamp = tout ? : 1;
701 static inline void mptcp_start_tout_timer(struct sock *sk)
703 mptcp_set_close_tout(sk, tcp_jiffies32);
704 mptcp_reset_tout_timer(mptcp_sk(sk), 0);
707 static inline bool mptcp_is_fully_established(struct sock *sk)
709 return inet_sk_state_load(sk) == TCP_ESTABLISHED &&
710 READ_ONCE(mptcp_sk(sk)->fully_established);
712 void mptcp_rcv_space_init(struct mptcp_sock *msk, const struct sock *ssk);
713 void mptcp_data_ready(struct sock *sk, struct sock *ssk);
714 bool mptcp_finish_join(struct sock *sk);
715 bool mptcp_schedule_work(struct sock *sk);
716 int mptcp_setsockopt(struct sock *sk, int level, int optname,
717 sockptr_t optval, unsigned int optlen);
718 int mptcp_getsockopt(struct sock *sk, int level, int optname,
719 char __user *optval, int __user *option);
721 u64 __mptcp_expand_seq(u64 old_seq, u64 cur_seq);
722 static inline u64 mptcp_expand_seq(u64 old_seq, u64 cur_seq, bool use_64bit)
727 return __mptcp_expand_seq(old_seq, cur_seq);
729 void __mptcp_check_push(struct sock *sk, struct sock *ssk);
730 void __mptcp_data_acked(struct sock *sk);
731 void __mptcp_error_report(struct sock *sk);
732 void mptcp_subflow_eof(struct sock *sk);
733 bool mptcp_update_rcv_data_fin(struct mptcp_sock *msk, u64 data_fin_seq, bool use_64bit);
734 static inline bool mptcp_data_fin_enabled(const struct mptcp_sock *msk)
736 return READ_ONCE(msk->snd_data_fin_enable) &&
737 READ_ONCE(msk->write_seq) == READ_ONCE(msk->snd_nxt);
740 static inline bool mptcp_propagate_sndbuf(struct sock *sk, struct sock *ssk)
742 if ((sk->sk_userlocks & SOCK_SNDBUF_LOCK) || ssk->sk_sndbuf <= READ_ONCE(sk->sk_sndbuf))
745 WRITE_ONCE(sk->sk_sndbuf, ssk->sk_sndbuf);
749 static inline void mptcp_write_space(struct sock *sk)
751 if (sk_stream_is_writeable(sk)) {
752 /* pairs with memory barrier in mptcp_poll */
754 if (test_and_clear_bit(MPTCP_NOSPACE, &mptcp_sk(sk)->flags))
755 sk_stream_write_space(sk);
759 void mptcp_destroy_common(struct mptcp_sock *msk, unsigned int flags);
761 #define MPTCP_TOKEN_MAX_RETRIES 4
763 void __init mptcp_token_init(void);
764 static inline void mptcp_token_init_request(struct request_sock *req)
766 mptcp_subflow_rsk(req)->token_node.pprev = NULL;
769 int mptcp_token_new_request(struct request_sock *req);
770 void mptcp_token_destroy_request(struct request_sock *req);
771 int mptcp_token_new_connect(struct sock *sk);
772 void mptcp_token_accept(struct mptcp_subflow_request_sock *r,
773 struct mptcp_sock *msk);
774 bool mptcp_token_exists(u32 token);
775 struct mptcp_sock *mptcp_token_get_sock(struct net *net, u32 token);
776 struct mptcp_sock *mptcp_token_iter_next(const struct net *net, long *s_slot,
778 void mptcp_token_destroy(struct mptcp_sock *msk);
780 void mptcp_crypto_key_sha(u64 key, u32 *token, u64 *idsn);
782 void mptcp_crypto_hmac_sha(u64 key1, u64 key2, u8 *msg, int len, void *hmac);
783 __sum16 __mptcp_make_csum(u64 data_seq, u32 subflow_seq, u16 data_len, __wsum sum);
785 void __init mptcp_pm_init(void);
786 void mptcp_pm_data_init(struct mptcp_sock *msk);
787 void mptcp_pm_data_reset(struct mptcp_sock *msk);
788 int mptcp_pm_parse_addr(struct nlattr *attr, struct genl_info *info,
789 struct mptcp_addr_info *addr);
790 int mptcp_pm_parse_entry(struct nlattr *attr, struct genl_info *info,
792 struct mptcp_pm_addr_entry *entry);
793 bool mptcp_pm_addr_families_match(const struct sock *sk,
794 const struct mptcp_addr_info *loc,
795 const struct mptcp_addr_info *rem);
796 void mptcp_pm_subflow_chk_stale(const struct mptcp_sock *msk, struct sock *ssk);
797 void mptcp_pm_nl_subflow_chk_stale(const struct mptcp_sock *msk, struct sock *ssk);
798 void mptcp_pm_new_connection(struct mptcp_sock *msk, const struct sock *ssk, int server_side);
799 void mptcp_pm_fully_established(struct mptcp_sock *msk, const struct sock *ssk, gfp_t gfp);
800 bool mptcp_pm_allow_new_subflow(struct mptcp_sock *msk);
801 void mptcp_pm_connection_closed(struct mptcp_sock *msk);
802 void mptcp_pm_subflow_established(struct mptcp_sock *msk);
803 bool mptcp_pm_nl_check_work_pending(struct mptcp_sock *msk);
804 void mptcp_pm_subflow_check_next(struct mptcp_sock *msk, const struct sock *ssk,
805 const struct mptcp_subflow_context *subflow);
806 void mptcp_pm_add_addr_received(const struct sock *ssk,
807 const struct mptcp_addr_info *addr);
808 void mptcp_pm_add_addr_echoed(struct mptcp_sock *msk,
809 const struct mptcp_addr_info *addr);
810 void mptcp_pm_add_addr_send_ack(struct mptcp_sock *msk);
811 void mptcp_pm_nl_addr_send_ack(struct mptcp_sock *msk);
812 void mptcp_pm_rm_addr_received(struct mptcp_sock *msk,
813 const struct mptcp_rm_list *rm_list);
814 void mptcp_pm_mp_prio_received(struct sock *sk, u8 bkup);
815 void mptcp_pm_mp_fail_received(struct sock *sk, u64 fail_seq);
816 int mptcp_pm_nl_mp_prio_send_ack(struct mptcp_sock *msk,
817 struct mptcp_addr_info *addr,
818 struct mptcp_addr_info *rem,
820 bool mptcp_pm_alloc_anno_list(struct mptcp_sock *msk,
821 const struct mptcp_pm_addr_entry *entry);
822 void mptcp_pm_free_anno_list(struct mptcp_sock *msk);
823 bool mptcp_pm_sport_in_anno_list(struct mptcp_sock *msk, const struct sock *sk);
824 struct mptcp_pm_add_entry *
825 mptcp_pm_del_add_timer(struct mptcp_sock *msk,
826 const struct mptcp_addr_info *addr, bool check_id);
827 struct mptcp_pm_add_entry *
828 mptcp_lookup_anno_list_by_saddr(const struct mptcp_sock *msk,
829 const struct mptcp_addr_info *addr);
830 int mptcp_pm_get_flags_and_ifindex_by_id(struct mptcp_sock *msk,
832 u8 *flags, int *ifindex);
833 int mptcp_userspace_pm_get_flags_and_ifindex_by_id(struct mptcp_sock *msk,
835 u8 *flags, int *ifindex);
836 int mptcp_userspace_pm_set_flags(struct net *net, struct nlattr *token,
837 struct mptcp_pm_addr_entry *loc,
838 struct mptcp_pm_addr_entry *rem, u8 bkup);
839 int mptcp_pm_announce_addr(struct mptcp_sock *msk,
840 const struct mptcp_addr_info *addr,
842 int mptcp_pm_remove_addr(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
843 int mptcp_pm_remove_subflow(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
844 void mptcp_pm_remove_addrs(struct mptcp_sock *msk, struct list_head *rm_list);
845 void mptcp_pm_remove_addrs_and_subflows(struct mptcp_sock *msk,
846 struct list_head *rm_list);
848 int mptcp_userspace_pm_append_new_local_addr(struct mptcp_sock *msk,
849 struct mptcp_pm_addr_entry *entry);
850 void mptcp_free_local_addr_list(struct mptcp_sock *msk);
851 int mptcp_nl_cmd_announce(struct sk_buff *skb, struct genl_info *info);
852 int mptcp_nl_cmd_remove(struct sk_buff *skb, struct genl_info *info);
853 int mptcp_nl_cmd_sf_create(struct sk_buff *skb, struct genl_info *info);
854 int mptcp_nl_cmd_sf_destroy(struct sk_buff *skb, struct genl_info *info);
856 void mptcp_event(enum mptcp_event_type type, const struct mptcp_sock *msk,
857 const struct sock *ssk, gfp_t gfp);
858 void mptcp_event_addr_announced(const struct sock *ssk, const struct mptcp_addr_info *info);
859 void mptcp_event_addr_removed(const struct mptcp_sock *msk, u8 id);
860 bool mptcp_userspace_pm_active(const struct mptcp_sock *msk);
862 static inline bool mptcp_pm_should_add_signal(struct mptcp_sock *msk)
864 return READ_ONCE(msk->pm.addr_signal) &
865 (BIT(MPTCP_ADD_ADDR_SIGNAL) | BIT(MPTCP_ADD_ADDR_ECHO));
868 static inline bool mptcp_pm_should_add_signal_addr(struct mptcp_sock *msk)
870 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_SIGNAL);
873 static inline bool mptcp_pm_should_add_signal_echo(struct mptcp_sock *msk)
875 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_ECHO);
878 static inline bool mptcp_pm_should_rm_signal(struct mptcp_sock *msk)
880 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_RM_ADDR_SIGNAL);
883 static inline bool mptcp_pm_is_userspace(const struct mptcp_sock *msk)
885 return READ_ONCE(msk->pm.pm_type) == MPTCP_PM_TYPE_USERSPACE;
888 static inline bool mptcp_pm_is_kernel(const struct mptcp_sock *msk)
890 return READ_ONCE(msk->pm.pm_type) == MPTCP_PM_TYPE_KERNEL;
893 static inline unsigned int mptcp_add_addr_len(int family, bool echo, bool port)
895 u8 len = TCPOLEN_MPTCP_ADD_ADDR_BASE;
897 if (family == AF_INET6)
898 len = TCPOLEN_MPTCP_ADD_ADDR6_BASE;
900 len += MPTCPOPT_THMAC_LEN;
901 /* account for 2 trailing 'nop' options */
903 len += TCPOLEN_MPTCP_PORT_LEN + TCPOLEN_MPTCP_PORT_ALIGN;
908 static inline int mptcp_rm_addr_len(const struct mptcp_rm_list *rm_list)
910 if (rm_list->nr == 0 || rm_list->nr > MPTCP_RM_IDS_MAX)
913 return TCPOLEN_MPTCP_RM_ADDR_BASE + roundup(rm_list->nr - 1, 4) + 1;
916 bool mptcp_pm_add_addr_signal(struct mptcp_sock *msk, const struct sk_buff *skb,
917 unsigned int opt_size, unsigned int remaining,
918 struct mptcp_addr_info *addr, bool *echo,
919 bool *drop_other_suboptions);
920 bool mptcp_pm_rm_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
921 struct mptcp_rm_list *rm_list);
922 int mptcp_pm_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
923 int mptcp_userspace_pm_get_local_id(struct mptcp_sock *msk, struct mptcp_addr_info *skc);
925 void __init mptcp_pm_nl_init(void);
926 void mptcp_pm_nl_work(struct mptcp_sock *msk);
927 void mptcp_pm_nl_rm_subflow_received(struct mptcp_sock *msk,
928 const struct mptcp_rm_list *rm_list);
929 int mptcp_pm_nl_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
930 unsigned int mptcp_pm_get_add_addr_signal_max(const struct mptcp_sock *msk);
931 unsigned int mptcp_pm_get_add_addr_accept_max(const struct mptcp_sock *msk);
932 unsigned int mptcp_pm_get_subflows_max(const struct mptcp_sock *msk);
933 unsigned int mptcp_pm_get_local_addr_max(const struct mptcp_sock *msk);
935 /* called under PM lock */
936 static inline void __mptcp_pm_close_subflow(struct mptcp_sock *msk)
938 if (--msk->pm.subflows < mptcp_pm_get_subflows_max(msk))
939 WRITE_ONCE(msk->pm.accept_subflow, true);
942 static inline void mptcp_pm_close_subflow(struct mptcp_sock *msk)
944 spin_lock_bh(&msk->pm.lock);
945 __mptcp_pm_close_subflow(msk);
946 spin_unlock_bh(&msk->pm.lock);
949 void mptcp_sockopt_sync(struct mptcp_sock *msk, struct sock *ssk);
950 void mptcp_sockopt_sync_locked(struct mptcp_sock *msk, struct sock *ssk);
952 static inline struct mptcp_ext *mptcp_get_ext(const struct sk_buff *skb)
954 return (struct mptcp_ext *)skb_ext_find(skb, SKB_EXT_MPTCP);
957 void mptcp_diag_subflow_init(struct tcp_ulp_ops *ops);
959 static inline bool __mptcp_check_fallback(const struct mptcp_sock *msk)
961 return test_bit(MPTCP_FALLBACK_DONE, &msk->flags);
964 static inline bool mptcp_check_fallback(const struct sock *sk)
966 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
967 struct mptcp_sock *msk = mptcp_sk(subflow->conn);
969 return __mptcp_check_fallback(msk);
972 static inline void __mptcp_do_fallback(struct mptcp_sock *msk)
974 if (test_bit(MPTCP_FALLBACK_DONE, &msk->flags)) {
975 pr_debug("TCP fallback already done (msk=%p)", msk);
978 set_bit(MPTCP_FALLBACK_DONE, &msk->flags);
981 static inline void mptcp_do_fallback(struct sock *ssk)
983 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(ssk);
984 struct sock *sk = subflow->conn;
985 struct mptcp_sock *msk;
988 __mptcp_do_fallback(msk);
989 if (READ_ONCE(msk->snd_data_fin_enable) && !(ssk->sk_shutdown & SEND_SHUTDOWN)) {
990 gfp_t saved_allocation = ssk->sk_allocation;
992 /* we are in a atomic (BH) scope, override ssk default for data
995 ssk->sk_allocation = GFP_ATOMIC;
996 ssk->sk_shutdown |= SEND_SHUTDOWN;
997 tcp_shutdown(ssk, SEND_SHUTDOWN);
998 ssk->sk_allocation = saved_allocation;
1002 #define pr_fallback(a) pr_debug("%s:fallback to TCP (msk=%p)", __func__, a)
1004 static inline bool mptcp_check_infinite_map(struct sk_buff *skb)
1006 struct mptcp_ext *mpext;
1008 mpext = skb ? mptcp_get_ext(skb) : NULL;
1009 if (mpext && mpext->infinite_map)
1015 static inline bool is_active_ssk(struct mptcp_subflow_context *subflow)
1017 return (subflow->request_mptcp || subflow->request_join);
1020 static inline bool subflow_simultaneous_connect(struct sock *sk)
1022 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
1024 return sk->sk_state == TCP_ESTABLISHED &&
1025 is_active_ssk(subflow) &&
1026 !subflow->conn_finished;
1029 #ifdef CONFIG_SYN_COOKIES
1030 void subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
1031 struct sk_buff *skb);
1032 bool mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
1033 struct sk_buff *skb);
1034 void __init mptcp_join_cookie_init(void);
1037 subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
1038 struct sk_buff *skb) {}
1040 mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
1041 struct sk_buff *skb)
1046 static inline void mptcp_join_cookie_init(void) {}
1049 #endif /* __MPTCP_PROTOCOL_H */