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)
29 #define OPTION_MPTCP_DSS BIT(11)
30 #define OPTION_MPTCP_FAIL BIT(12)
32 #define OPTION_MPTCP_CSUMREQD BIT(13)
34 #define OPTIONS_MPTCP_MPC (OPTION_MPTCP_MPC_SYN | OPTION_MPTCP_MPC_SYNACK | \
36 #define OPTIONS_MPTCP_MPJ (OPTION_MPTCP_MPJ_SYN | OPTION_MPTCP_MPJ_SYNACK | \
39 /* MPTCP option subtypes */
40 #define MPTCPOPT_MP_CAPABLE 0
41 #define MPTCPOPT_MP_JOIN 1
42 #define MPTCPOPT_DSS 2
43 #define MPTCPOPT_ADD_ADDR 3
44 #define MPTCPOPT_RM_ADDR 4
45 #define MPTCPOPT_MP_PRIO 5
46 #define MPTCPOPT_MP_FAIL 6
47 #define MPTCPOPT_MP_FASTCLOSE 7
48 #define MPTCPOPT_RST 8
50 /* MPTCP suboption lengths */
51 #define TCPOLEN_MPTCP_MPC_SYN 4
52 #define TCPOLEN_MPTCP_MPC_SYNACK 12
53 #define TCPOLEN_MPTCP_MPC_ACK 20
54 #define TCPOLEN_MPTCP_MPC_ACK_DATA 22
55 #define TCPOLEN_MPTCP_MPJ_SYN 12
56 #define TCPOLEN_MPTCP_MPJ_SYNACK 16
57 #define TCPOLEN_MPTCP_MPJ_ACK 24
58 #define TCPOLEN_MPTCP_DSS_BASE 4
59 #define TCPOLEN_MPTCP_DSS_ACK32 4
60 #define TCPOLEN_MPTCP_DSS_ACK64 8
61 #define TCPOLEN_MPTCP_DSS_MAP32 10
62 #define TCPOLEN_MPTCP_DSS_MAP64 14
63 #define TCPOLEN_MPTCP_DSS_CHECKSUM 2
64 #define TCPOLEN_MPTCP_ADD_ADDR 16
65 #define TCPOLEN_MPTCP_ADD_ADDR_PORT 18
66 #define TCPOLEN_MPTCP_ADD_ADDR_BASE 8
67 #define TCPOLEN_MPTCP_ADD_ADDR_BASE_PORT 10
68 #define TCPOLEN_MPTCP_ADD_ADDR6 28
69 #define TCPOLEN_MPTCP_ADD_ADDR6_PORT 30
70 #define TCPOLEN_MPTCP_ADD_ADDR6_BASE 20
71 #define TCPOLEN_MPTCP_ADD_ADDR6_BASE_PORT 22
72 #define TCPOLEN_MPTCP_PORT_LEN 2
73 #define TCPOLEN_MPTCP_PORT_ALIGN 2
74 #define TCPOLEN_MPTCP_RM_ADDR_BASE 3
75 #define TCPOLEN_MPTCP_PRIO 3
76 #define TCPOLEN_MPTCP_PRIO_ALIGN 4
77 #define TCPOLEN_MPTCP_FASTCLOSE 12
78 #define TCPOLEN_MPTCP_RST 4
79 #define TCPOLEN_MPTCP_FAIL 12
81 #define TCPOLEN_MPTCP_MPC_ACK_DATA_CSUM (TCPOLEN_MPTCP_DSS_CHECKSUM + TCPOLEN_MPTCP_MPC_ACK_DATA)
83 /* MPTCP MP_JOIN flags */
84 #define MPTCPOPT_BACKUP BIT(0)
85 #define MPTCPOPT_HMAC_LEN 20
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
128 static inline bool before64(__u64 seq1, __u64 seq2)
130 return (__s64)(seq1 - seq2) < 0;
133 #define after64(seq2, seq1) before64(seq1, seq2)
135 struct mptcp_options_received {
160 u8 hmac[MPTCPOPT_HMAC_LEN];
161 struct mptcp_addr_info addr;
162 struct mptcp_rm_list rm_list;
167 static inline __be32 mptcp_option(u8 subopt, u8 len, u8 nib, u8 field)
169 return htonl((TCPOPT_MPTCP << 24) | (len << 16) | (subopt << 12) |
170 ((nib & 0xF) << 8) | field);
173 enum mptcp_pm_status {
174 MPTCP_PM_ADD_ADDR_RECEIVED,
175 MPTCP_PM_ADD_ADDR_SEND_ACK,
176 MPTCP_PM_RM_ADDR_RECEIVED,
177 MPTCP_PM_ESTABLISHED,
178 MPTCP_PM_SUBFLOW_ESTABLISHED,
179 MPTCP_PM_ALREADY_ESTABLISHED, /* persistent status, set after ESTABLISHED event */
180 MPTCP_PM_MPC_ENDPOINT_ACCOUNTED /* persistent status, set after MPC local address is
181 * accounted int id_avail_bitmap
185 /* Status bits below MPTCP_PM_ALREADY_ESTABLISHED need pm worker actions */
186 #define MPTCP_PM_WORK_MASK ((1 << MPTCP_PM_ALREADY_ESTABLISHED) - 1)
188 enum mptcp_addr_signal_status {
189 MPTCP_ADD_ADDR_SIGNAL,
191 MPTCP_RM_ADDR_SIGNAL,
194 /* max value of mptcp_addr_info.id */
195 #define MPTCP_PM_MAX_ADDR_ID U8_MAX
197 struct mptcp_pm_data {
198 struct mptcp_addr_info local;
199 struct mptcp_addr_info remote;
200 struct list_head anno_list;
202 spinlock_t lock; /*protects the whole PM data */
209 bool remote_deny_join_id0;
210 u8 add_addr_signaled;
211 u8 add_addr_accepted;
215 DECLARE_BITMAP(id_avail_bitmap, MPTCP_PM_MAX_ADDR_ID + 1);
216 struct mptcp_rm_list rm_list_tx;
217 struct mptcp_rm_list rm_list_rx;
220 struct mptcp_data_frag {
221 struct list_head list;
230 /* MPTCP connection sock */
232 /* inet_connection_sock must be the first member */
233 struct inet_connection_sock sk;
240 u64 rcv_data_fin_seq;
242 struct sock *last_snd;
245 u64 recovery_snd_nxt; /* in recovery mode accept up to this seq;
246 * recovery related fields are under data_lock
251 unsigned long timer_ival;
255 unsigned long cb_flags;
256 unsigned long push_pending;
257 bool recovery; /* closing subflow write queue reinjected */
259 bool fully_established;
261 bool snd_data_fin_enable;
263 bool use_64bit_ack; /* Set when we received a 64-bit DSN */
268 struct work_struct work;
269 struct sk_buff *ooo_last_skb;
270 struct rb_root out_of_order_queue;
271 struct sk_buff_head receive_queue;
272 struct list_head conn_list;
273 struct list_head rtx_queue;
274 struct mptcp_data_frag *first_pending;
275 struct list_head join_list;
276 struct socket *subflow; /* outgoing connect/listener/!mp_capable */
278 struct mptcp_pm_data pm;
280 u32 space; /* bytes copied in last measurement window */
281 u32 copied; /* bytes copied in this measurement window */
282 u64 time; /* start time of measurement window */
283 u64 rtt_us; /* last maximum rtt of subflows */
287 char ca_name[TCP_CA_NAME_MAX];
290 #define mptcp_data_lock(sk) spin_lock_bh(&(sk)->sk_lock.slock)
291 #define mptcp_data_unlock(sk) spin_unlock_bh(&(sk)->sk_lock.slock)
293 #define mptcp_for_each_subflow(__msk, __subflow) \
294 list_for_each_entry(__subflow, &((__msk)->conn_list), node)
296 static inline void msk_owned_by_me(const struct mptcp_sock *msk)
298 sock_owned_by_me((const struct sock *)msk);
301 static inline struct mptcp_sock *mptcp_sk(const struct sock *sk)
303 return (struct mptcp_sock *)sk;
306 /* the msk socket don't use the backlog, also account for the bulk
309 static inline int __mptcp_rmem(const struct sock *sk)
311 return atomic_read(&sk->sk_rmem_alloc) - READ_ONCE(mptcp_sk(sk)->rmem_released);
314 static inline int __mptcp_space(const struct sock *sk)
316 return tcp_win_from_space(sk, READ_ONCE(sk->sk_rcvbuf) - __mptcp_rmem(sk));
319 static inline struct mptcp_data_frag *mptcp_send_head(const struct sock *sk)
321 const struct mptcp_sock *msk = mptcp_sk(sk);
323 return READ_ONCE(msk->first_pending);
326 static inline struct mptcp_data_frag *mptcp_send_next(struct sock *sk)
328 struct mptcp_sock *msk = mptcp_sk(sk);
329 struct mptcp_data_frag *cur;
331 cur = msk->first_pending;
332 return list_is_last(&cur->list, &msk->rtx_queue) ? NULL :
333 list_next_entry(cur, list);
336 static inline struct mptcp_data_frag *mptcp_pending_tail(const struct sock *sk)
338 struct mptcp_sock *msk = mptcp_sk(sk);
340 if (!msk->first_pending)
343 if (WARN_ON_ONCE(list_empty(&msk->rtx_queue)))
346 return list_last_entry(&msk->rtx_queue, struct mptcp_data_frag, list);
349 static inline struct mptcp_data_frag *mptcp_rtx_head(const struct sock *sk)
351 struct mptcp_sock *msk = mptcp_sk(sk);
353 if (msk->snd_una == READ_ONCE(msk->snd_nxt))
356 return list_first_entry_or_null(&msk->rtx_queue, struct mptcp_data_frag, list);
359 struct csum_pseudo_header {
366 struct mptcp_subflow_request_sock {
367 struct tcp_request_sock sk;
382 struct mptcp_sock *msk;
383 struct hlist_nulls_node token_node;
386 static inline struct mptcp_subflow_request_sock *
387 mptcp_subflow_rsk(const struct request_sock *rsk)
389 return (struct mptcp_subflow_request_sock *)rsk;
392 enum mptcp_data_avail {
393 MPTCP_SUBFLOW_NODATA,
394 MPTCP_SUBFLOW_DATA_AVAIL,
397 struct mptcp_delegated_action {
398 struct napi_struct napi;
399 struct list_head head;
402 DECLARE_PER_CPU(struct mptcp_delegated_action, mptcp_delegated_actions);
404 #define MPTCP_DELEGATE_SEND 0
405 #define MPTCP_DELEGATE_ACK 1
407 /* MPTCP subflow context */
408 struct mptcp_subflow_context {
409 struct list_head node;/* conn_list of subflows */
413 unsigned long avg_pacing_rate; /* protected by msk socket lock */
424 __wsum map_data_csum;
426 u32 request_mptcp : 1, /* send MP_CAPABLE */
427 request_join : 1, /* send MP_JOIN */
429 mp_capable : 1, /* remote is MPTCP capable */
430 mp_join : 1, /* remote is JOINing */
431 fully_established : 1, /* path validated */
432 pm_notified : 1, /* PM hook called for established status */
443 can_ack : 1, /* only after processing the remote a key */
444 disposable : 1, /* ctx can be free at ulp release time */
445 stale : 1, /* unable to snd/rcv data, do not use for xmit */
446 local_id_valid : 1, /* local_id is correctly initialized */
447 valid_csum_seen : 1; /* at least one csum validated */
448 enum mptcp_data_avail data_avail;
453 u8 hmac[MPTCPOPT_HMAC_LEN];
457 u8 reset_transient:1;
461 long delegated_status;
465 struct list_head delegated_node; /* link into delegated_action, protected by local BH */
468 u32 stale_rcv_tstamp;
470 struct sock *tcp_sock; /* tcp sk backpointer */
471 struct sock *conn; /* parent mptcp_sock */
472 const struct inet_connection_sock_af_ops *icsk_af_ops;
473 void (*tcp_state_change)(struct sock *sk);
474 void (*tcp_error_report)(struct sock *sk);
479 static inline struct mptcp_subflow_context *
480 mptcp_subflow_ctx(const struct sock *sk)
482 struct inet_connection_sock *icsk = inet_csk(sk);
484 /* Use RCU on icsk_ulp_data only for sock diag code */
485 return (__force struct mptcp_subflow_context *)icsk->icsk_ulp_data;
488 static inline struct sock *
489 mptcp_subflow_tcp_sock(const struct mptcp_subflow_context *subflow)
491 return subflow->tcp_sock;
495 mptcp_subflow_ctx_reset(struct mptcp_subflow_context *subflow)
497 memset(&subflow->reset, 0, sizeof(subflow->reset));
498 subflow->request_mptcp = 1;
502 mptcp_subflow_get_map_offset(const struct mptcp_subflow_context *subflow)
504 return tcp_sk(mptcp_subflow_tcp_sock(subflow))->copied_seq -
505 subflow->ssn_offset -
506 subflow->map_subflow_seq;
510 mptcp_subflow_get_mapped_dsn(const struct mptcp_subflow_context *subflow)
512 return subflow->map_seq + mptcp_subflow_get_map_offset(subflow);
515 void mptcp_subflow_process_delegated(struct sock *ssk);
517 static inline void mptcp_subflow_delegate(struct mptcp_subflow_context *subflow, int action)
519 struct mptcp_delegated_action *delegated;
522 /* the caller held the subflow bh socket lock */
523 lockdep_assert_in_softirq();
525 /* The implied barrier pairs with mptcp_subflow_delegated_done(), and
526 * ensures the below list check sees list updates done prior to status
529 if (!test_and_set_bit(action, &subflow->delegated_status)) {
530 /* still on delegated list from previous scheduling */
531 if (!list_empty(&subflow->delegated_node))
534 delegated = this_cpu_ptr(&mptcp_delegated_actions);
535 schedule = list_empty(&delegated->head);
536 list_add_tail(&subflow->delegated_node, &delegated->head);
537 sock_hold(mptcp_subflow_tcp_sock(subflow));
539 napi_schedule(&delegated->napi);
543 static inline struct mptcp_subflow_context *
544 mptcp_subflow_delegated_next(struct mptcp_delegated_action *delegated)
546 struct mptcp_subflow_context *ret;
548 if (list_empty(&delegated->head))
551 ret = list_first_entry(&delegated->head, struct mptcp_subflow_context, delegated_node);
552 list_del_init(&ret->delegated_node);
556 static inline bool mptcp_subflow_has_delegated_action(const struct mptcp_subflow_context *subflow)
558 return !!READ_ONCE(subflow->delegated_status);
561 static inline void mptcp_subflow_delegated_done(struct mptcp_subflow_context *subflow, int action)
563 /* pairs with mptcp_subflow_delegate, ensures delegate_node is updated before
564 * touching the status bit
567 clear_bit(action, &subflow->delegated_status);
570 int mptcp_is_enabled(const struct net *net);
571 unsigned int mptcp_get_add_addr_timeout(const struct net *net);
572 int mptcp_is_checksum_enabled(const struct net *net);
573 int mptcp_allow_join_id0(const struct net *net);
574 unsigned int mptcp_stale_loss_cnt(const struct net *net);
575 void mptcp_subflow_fully_established(struct mptcp_subflow_context *subflow,
576 struct mptcp_options_received *mp_opt);
577 bool __mptcp_retransmit_pending_data(struct sock *sk);
578 void mptcp_check_and_set_pending(struct sock *sk);
579 void __mptcp_push_pending(struct sock *sk, unsigned int flags);
580 bool mptcp_subflow_data_available(struct sock *sk);
581 void __init mptcp_subflow_init(void);
582 void mptcp_subflow_shutdown(struct sock *sk, struct sock *ssk, int how);
583 void mptcp_close_ssk(struct sock *sk, struct sock *ssk,
584 struct mptcp_subflow_context *subflow);
585 void mptcp_subflow_send_ack(struct sock *ssk);
586 void mptcp_subflow_reset(struct sock *ssk);
587 void mptcp_sock_graft(struct sock *sk, struct socket *parent);
588 struct socket *__mptcp_nmpc_socket(const struct mptcp_sock *msk);
590 /* called with sk socket lock held */
591 int __mptcp_subflow_connect(struct sock *sk, const struct mptcp_addr_info *loc,
592 const struct mptcp_addr_info *remote);
593 int mptcp_subflow_create_socket(struct sock *sk, struct socket **new_sock);
594 void mptcp_info2sockaddr(const struct mptcp_addr_info *info,
595 struct sockaddr_storage *addr,
596 unsigned short family);
598 static inline bool __mptcp_subflow_active(struct mptcp_subflow_context *subflow)
600 struct sock *ssk = mptcp_subflow_tcp_sock(subflow);
602 /* can't send if JOIN hasn't completed yet (i.e. is usable for mptcp) */
603 if (subflow->request_join && !subflow->fully_established)
606 /* only send if our side has not closed yet */
607 return ((1 << ssk->sk_state) & (TCPF_ESTABLISHED | TCPF_CLOSE_WAIT));
610 void mptcp_subflow_set_active(struct mptcp_subflow_context *subflow);
612 bool mptcp_subflow_active(struct mptcp_subflow_context *subflow);
614 static inline void mptcp_subflow_tcp_fallback(struct sock *sk,
615 struct mptcp_subflow_context *ctx)
617 sk->sk_data_ready = sock_def_readable;
618 sk->sk_state_change = ctx->tcp_state_change;
619 sk->sk_write_space = sk_stream_write_space;
620 sk->sk_error_report = ctx->tcp_error_report;
622 inet_csk(sk)->icsk_af_ops = ctx->icsk_af_ops;
625 static inline bool mptcp_has_another_subflow(struct sock *ssk)
627 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(ssk), *tmp;
628 struct mptcp_sock *msk = mptcp_sk(subflow->conn);
630 mptcp_for_each_subflow(msk, tmp) {
638 void __init mptcp_proto_init(void);
639 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
640 int __init mptcp_proto_v6_init(void);
643 struct sock *mptcp_sk_clone(const struct sock *sk,
644 const struct mptcp_options_received *mp_opt,
645 struct request_sock *req);
646 void mptcp_get_options(const struct sk_buff *skb,
647 struct mptcp_options_received *mp_opt);
649 void mptcp_finish_connect(struct sock *sk);
650 void __mptcp_set_connected(struct sock *sk);
651 static inline bool mptcp_is_fully_established(struct sock *sk)
653 return inet_sk_state_load(sk) == TCP_ESTABLISHED &&
654 READ_ONCE(mptcp_sk(sk)->fully_established);
656 void mptcp_rcv_space_init(struct mptcp_sock *msk, const struct sock *ssk);
657 void mptcp_data_ready(struct sock *sk, struct sock *ssk);
658 bool mptcp_finish_join(struct sock *sk);
659 bool mptcp_schedule_work(struct sock *sk);
660 int mptcp_setsockopt(struct sock *sk, int level, int optname,
661 sockptr_t optval, unsigned int optlen);
662 int mptcp_getsockopt(struct sock *sk, int level, int optname,
663 char __user *optval, int __user *option);
665 u64 __mptcp_expand_seq(u64 old_seq, u64 cur_seq);
666 static inline u64 mptcp_expand_seq(u64 old_seq, u64 cur_seq, bool use_64bit)
671 return __mptcp_expand_seq(old_seq, cur_seq);
673 void __mptcp_check_push(struct sock *sk, struct sock *ssk);
674 void __mptcp_data_acked(struct sock *sk);
675 void __mptcp_error_report(struct sock *sk);
676 void mptcp_subflow_eof(struct sock *sk);
677 bool mptcp_update_rcv_data_fin(struct mptcp_sock *msk, u64 data_fin_seq, bool use_64bit);
678 static inline bool mptcp_data_fin_enabled(const struct mptcp_sock *msk)
680 return READ_ONCE(msk->snd_data_fin_enable) &&
681 READ_ONCE(msk->write_seq) == READ_ONCE(msk->snd_nxt);
684 static inline bool mptcp_propagate_sndbuf(struct sock *sk, struct sock *ssk)
686 if ((sk->sk_userlocks & SOCK_SNDBUF_LOCK) || ssk->sk_sndbuf <= READ_ONCE(sk->sk_sndbuf))
689 WRITE_ONCE(sk->sk_sndbuf, ssk->sk_sndbuf);
693 static inline void mptcp_write_space(struct sock *sk)
695 if (sk_stream_is_writeable(sk)) {
696 /* pairs with memory barrier in mptcp_poll */
698 if (test_and_clear_bit(MPTCP_NOSPACE, &mptcp_sk(sk)->flags))
699 sk_stream_write_space(sk);
703 void mptcp_destroy_common(struct mptcp_sock *msk);
705 #define MPTCP_TOKEN_MAX_RETRIES 4
707 void __init mptcp_token_init(void);
708 static inline void mptcp_token_init_request(struct request_sock *req)
710 mptcp_subflow_rsk(req)->token_node.pprev = NULL;
713 int mptcp_token_new_request(struct request_sock *req);
714 void mptcp_token_destroy_request(struct request_sock *req);
715 int mptcp_token_new_connect(struct sock *sk);
716 void mptcp_token_accept(struct mptcp_subflow_request_sock *r,
717 struct mptcp_sock *msk);
718 bool mptcp_token_exists(u32 token);
719 struct mptcp_sock *mptcp_token_get_sock(struct net *net, u32 token);
720 struct mptcp_sock *mptcp_token_iter_next(const struct net *net, long *s_slot,
722 void mptcp_token_destroy(struct mptcp_sock *msk);
724 void mptcp_crypto_key_sha(u64 key, u32 *token, u64 *idsn);
726 void mptcp_crypto_hmac_sha(u64 key1, u64 key2, u8 *msg, int len, void *hmac);
727 __sum16 __mptcp_make_csum(u64 data_seq, u32 subflow_seq, u16 data_len, __wsum sum);
729 void __init mptcp_pm_init(void);
730 void mptcp_pm_data_init(struct mptcp_sock *msk);
731 void mptcp_pm_data_reset(struct mptcp_sock *msk);
732 void mptcp_pm_subflow_chk_stale(const struct mptcp_sock *msk, struct sock *ssk);
733 void mptcp_pm_nl_subflow_chk_stale(const struct mptcp_sock *msk, struct sock *ssk);
734 void mptcp_pm_new_connection(struct mptcp_sock *msk, const struct sock *ssk, int server_side);
735 void mptcp_pm_fully_established(struct mptcp_sock *msk, const struct sock *ssk, gfp_t gfp);
736 bool mptcp_pm_allow_new_subflow(struct mptcp_sock *msk);
737 void mptcp_pm_connection_closed(struct mptcp_sock *msk);
738 void mptcp_pm_subflow_established(struct mptcp_sock *msk);
739 bool mptcp_pm_nl_check_work_pending(struct mptcp_sock *msk);
740 void mptcp_pm_subflow_check_next(struct mptcp_sock *msk, const struct sock *ssk,
741 const struct mptcp_subflow_context *subflow);
742 void mptcp_pm_add_addr_received(struct mptcp_sock *msk,
743 const struct mptcp_addr_info *addr);
744 void mptcp_pm_add_addr_echoed(struct mptcp_sock *msk,
745 const struct mptcp_addr_info *addr);
746 void mptcp_pm_add_addr_send_ack(struct mptcp_sock *msk);
747 void mptcp_pm_nl_addr_send_ack(struct mptcp_sock *msk);
748 void mptcp_pm_rm_addr_received(struct mptcp_sock *msk,
749 const struct mptcp_rm_list *rm_list);
750 void mptcp_pm_mp_prio_received(struct sock *sk, u8 bkup);
751 void mptcp_pm_mp_fail_received(struct sock *sk, u64 fail_seq);
752 void mptcp_pm_free_anno_list(struct mptcp_sock *msk);
753 bool mptcp_pm_sport_in_anno_list(struct mptcp_sock *msk, const struct sock *sk);
754 struct mptcp_pm_add_entry *
755 mptcp_pm_del_add_timer(struct mptcp_sock *msk,
756 const struct mptcp_addr_info *addr, bool check_id);
757 struct mptcp_pm_add_entry *
758 mptcp_lookup_anno_list_by_saddr(const struct mptcp_sock *msk,
759 const struct mptcp_addr_info *addr);
760 int mptcp_pm_get_flags_and_ifindex_by_id(struct net *net, unsigned int id,
761 u8 *flags, int *ifindex);
763 int mptcp_pm_announce_addr(struct mptcp_sock *msk,
764 const struct mptcp_addr_info *addr,
766 int mptcp_pm_remove_addr(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
767 int mptcp_pm_remove_subflow(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
769 void mptcp_event(enum mptcp_event_type type, const struct mptcp_sock *msk,
770 const struct sock *ssk, gfp_t gfp);
771 void mptcp_event_addr_announced(const struct mptcp_sock *msk, const struct mptcp_addr_info *info);
772 void mptcp_event_addr_removed(const struct mptcp_sock *msk, u8 id);
774 static inline bool mptcp_pm_should_add_signal(struct mptcp_sock *msk)
776 return READ_ONCE(msk->pm.addr_signal) &
777 (BIT(MPTCP_ADD_ADDR_SIGNAL) | BIT(MPTCP_ADD_ADDR_ECHO));
780 static inline bool mptcp_pm_should_add_signal_addr(struct mptcp_sock *msk)
782 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_SIGNAL);
785 static inline bool mptcp_pm_should_add_signal_echo(struct mptcp_sock *msk)
787 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_ECHO);
790 static inline bool mptcp_pm_should_rm_signal(struct mptcp_sock *msk)
792 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_RM_ADDR_SIGNAL);
795 static inline unsigned int mptcp_add_addr_len(int family, bool echo, bool port)
797 u8 len = TCPOLEN_MPTCP_ADD_ADDR_BASE;
799 if (family == AF_INET6)
800 len = TCPOLEN_MPTCP_ADD_ADDR6_BASE;
802 len += MPTCPOPT_THMAC_LEN;
803 /* account for 2 trailing 'nop' options */
805 len += TCPOLEN_MPTCP_PORT_LEN + TCPOLEN_MPTCP_PORT_ALIGN;
810 static inline int mptcp_rm_addr_len(const struct mptcp_rm_list *rm_list)
812 if (rm_list->nr == 0 || rm_list->nr > MPTCP_RM_IDS_MAX)
815 return TCPOLEN_MPTCP_RM_ADDR_BASE + roundup(rm_list->nr - 1, 4) + 1;
818 bool mptcp_pm_add_addr_signal(struct mptcp_sock *msk, const struct sk_buff *skb,
819 unsigned int opt_size, unsigned int remaining,
820 struct mptcp_addr_info *addr, bool *echo,
821 bool *drop_other_suboptions);
822 bool mptcp_pm_rm_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
823 struct mptcp_rm_list *rm_list);
824 int mptcp_pm_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
826 void __init mptcp_pm_nl_init(void);
827 void mptcp_pm_nl_data_init(struct mptcp_sock *msk);
828 void mptcp_pm_nl_work(struct mptcp_sock *msk);
829 void mptcp_pm_nl_rm_subflow_received(struct mptcp_sock *msk,
830 const struct mptcp_rm_list *rm_list);
831 int mptcp_pm_nl_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
832 unsigned int mptcp_pm_get_add_addr_signal_max(const struct mptcp_sock *msk);
833 unsigned int mptcp_pm_get_add_addr_accept_max(const struct mptcp_sock *msk);
834 unsigned int mptcp_pm_get_subflows_max(const struct mptcp_sock *msk);
835 unsigned int mptcp_pm_get_local_addr_max(const struct mptcp_sock *msk);
837 /* called under PM lock */
838 static inline void __mptcp_pm_close_subflow(struct mptcp_sock *msk)
840 if (--msk->pm.subflows < mptcp_pm_get_subflows_max(msk))
841 WRITE_ONCE(msk->pm.accept_subflow, true);
844 static inline void mptcp_pm_close_subflow(struct mptcp_sock *msk)
846 spin_lock_bh(&msk->pm.lock);
847 __mptcp_pm_close_subflow(msk);
848 spin_unlock_bh(&msk->pm.lock);
851 void mptcp_sockopt_sync(struct mptcp_sock *msk, struct sock *ssk);
852 void mptcp_sockopt_sync_locked(struct mptcp_sock *msk, struct sock *ssk);
854 static inline struct mptcp_ext *mptcp_get_ext(const struct sk_buff *skb)
856 return (struct mptcp_ext *)skb_ext_find(skb, SKB_EXT_MPTCP);
859 void mptcp_diag_subflow_init(struct tcp_ulp_ops *ops);
861 static inline bool __mptcp_check_fallback(const struct mptcp_sock *msk)
863 return test_bit(MPTCP_FALLBACK_DONE, &msk->flags);
866 static inline bool mptcp_check_fallback(const struct sock *sk)
868 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
869 struct mptcp_sock *msk = mptcp_sk(subflow->conn);
871 return __mptcp_check_fallback(msk);
874 static inline void __mptcp_do_fallback(struct mptcp_sock *msk)
876 if (test_bit(MPTCP_FALLBACK_DONE, &msk->flags)) {
877 pr_debug("TCP fallback already done (msk=%p)", msk);
880 set_bit(MPTCP_FALLBACK_DONE, &msk->flags);
883 static inline void mptcp_do_fallback(struct sock *sk)
885 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
886 struct mptcp_sock *msk = mptcp_sk(subflow->conn);
888 __mptcp_do_fallback(msk);
891 #define pr_fallback(a) pr_debug("%s:fallback to TCP (msk=%p)", __func__, a)
893 static inline bool subflow_simultaneous_connect(struct sock *sk)
895 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
896 struct sock *parent = subflow->conn;
898 return sk->sk_state == TCP_ESTABLISHED &&
899 !mptcp_sk(parent)->pm.server_side &&
900 !subflow->conn_finished;
903 #ifdef CONFIG_SYN_COOKIES
904 void subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
905 struct sk_buff *skb);
906 bool mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
907 struct sk_buff *skb);
908 void __init mptcp_join_cookie_init(void);
911 subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
912 struct sk_buff *skb) {}
914 mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
920 static inline void mptcp_join_cookie_init(void) {}
923 #endif /* __MPTCP_PROTOCOL_H */