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 /* MPTCP MP_JOIN flags */
72 #define MPTCPOPT_BACKUP BIT(0)
73 #define MPTCPOPT_HMAC_LEN 20
74 #define MPTCPOPT_THMAC_LEN 8
76 /* MPTCP MP_CAPABLE flags */
77 #define MPTCP_VERSION_MASK (0x0F)
78 #define MPTCP_CAP_CHECKSUM_REQD BIT(7)
79 #define MPTCP_CAP_EXTENSIBILITY BIT(6)
80 #define MPTCP_CAP_HMAC_SHA256 BIT(0)
81 #define MPTCP_CAP_FLAG_MASK (0x3F)
84 #define MPTCP_DSS_DATA_FIN BIT(4)
85 #define MPTCP_DSS_DSN64 BIT(3)
86 #define MPTCP_DSS_HAS_MAP BIT(2)
87 #define MPTCP_DSS_ACK64 BIT(1)
88 #define MPTCP_DSS_HAS_ACK BIT(0)
89 #define MPTCP_DSS_FLAG_MASK (0x1F)
91 /* MPTCP ADD_ADDR flags */
92 #define MPTCP_ADDR_ECHO BIT(0)
94 /* MPTCP MP_PRIO flags */
95 #define MPTCP_PRIO_BKUP BIT(0)
97 /* MPTCP TCPRST flags */
98 #define MPTCP_RST_TRANSIENT BIT(0)
100 /* MPTCP socket flags */
101 #define MPTCP_DATA_READY 0
102 #define MPTCP_NOSPACE 1
103 #define MPTCP_WORK_RTX 2
104 #define MPTCP_WORK_EOF 3
105 #define MPTCP_FALLBACK_DONE 4
106 #define MPTCP_WORK_CLOSE_SUBFLOW 5
107 #define MPTCP_PUSH_PENDING 6
108 #define MPTCP_CLEAN_UNA 7
109 #define MPTCP_ERROR_REPORT 8
110 #define MPTCP_RETRANSMIT 9
111 #define MPTCP_WORK_SYNC_SETSOCKOPT 10
112 #define MPTCP_CONNECTED 11
114 static inline bool before64(__u64 seq1, __u64 seq2)
116 return (__s64)(seq1 - seq2) < 0;
119 #define after64(seq2, seq1) before64(seq1, seq2)
121 struct mptcp_options_received {
141 u8 hmac[MPTCPOPT_HMAC_LEN];
150 struct mptcp_addr_info addr;
151 struct mptcp_rm_list rm_list;
154 u8 reset_transient:1;
157 static inline __be32 mptcp_option(u8 subopt, u8 len, u8 nib, u8 field)
159 return htonl((TCPOPT_MPTCP << 24) | (len << 16) | (subopt << 12) |
160 ((nib & 0xF) << 8) | field);
163 enum mptcp_pm_status {
164 MPTCP_PM_ADD_ADDR_RECEIVED,
165 MPTCP_PM_ADD_ADDR_SEND_ACK,
166 MPTCP_PM_RM_ADDR_RECEIVED,
167 MPTCP_PM_ESTABLISHED,
168 MPTCP_PM_ALREADY_ESTABLISHED, /* persistent status, set after ESTABLISHED event */
169 MPTCP_PM_SUBFLOW_ESTABLISHED,
172 enum mptcp_addr_signal_status {
173 MPTCP_ADD_ADDR_SIGNAL,
177 MPTCP_RM_ADDR_SIGNAL,
180 struct mptcp_pm_data {
181 struct mptcp_addr_info local;
182 struct mptcp_addr_info remote;
183 struct list_head anno_list;
185 spinlock_t lock; /*protects the whole PM data */
192 u8 add_addr_signaled;
193 u8 add_addr_accepted;
197 struct mptcp_rm_list rm_list_tx;
198 struct mptcp_rm_list rm_list_rx;
201 struct mptcp_data_frag {
202 struct list_head list;
211 /* MPTCP connection sock */
213 /* inet_connection_sock must be the first member */
214 struct inet_connection_sock sk;
221 u64 rcv_data_fin_seq;
223 struct sock *last_snd;
228 unsigned long timer_ival;
233 bool fully_established;
235 bool snd_data_fin_enable;
237 bool use_64bit_ack; /* Set when we received a 64-bit DSN */
238 spinlock_t join_list_lock;
239 struct work_struct work;
240 struct sk_buff *ooo_last_skb;
241 struct rb_root out_of_order_queue;
242 struct sk_buff_head receive_queue;
243 struct sk_buff_head skb_tx_cache; /* this is wmem accounted */
246 struct list_head conn_list;
247 struct list_head rtx_queue;
248 struct mptcp_data_frag *first_pending;
249 struct list_head join_list;
250 struct socket *subflow; /* outgoing connect/listener/!mp_capable */
252 struct mptcp_pm_data pm;
254 u32 space; /* bytes copied in last measurement window */
255 u32 copied; /* bytes copied in this measurement window */
256 u64 time; /* start time of measurement window */
257 u64 rtt_us; /* last maximum rtt of subflows */
261 char ca_name[TCP_CA_NAME_MAX];
264 #define mptcp_lock_sock(___sk, cb) do { \
265 struct sock *__sk = (___sk); /* silence macro reuse warning */ \
267 spin_lock_bh(&__sk->sk_lock.slock); \
268 if (__sk->sk_lock.owned) \
271 __sk->sk_lock.owned = 1; \
272 spin_unlock(&__sk->sk_lock.slock); \
273 mutex_acquire(&__sk->sk_lock.dep_map, 0, 0, _RET_IP_); \
277 #define mptcp_data_lock(sk) spin_lock_bh(&(sk)->sk_lock.slock)
278 #define mptcp_data_unlock(sk) spin_unlock_bh(&(sk)->sk_lock.slock)
280 #define mptcp_for_each_subflow(__msk, __subflow) \
281 list_for_each_entry(__subflow, &((__msk)->conn_list), node)
283 static inline void msk_owned_by_me(const struct mptcp_sock *msk)
285 sock_owned_by_me((const struct sock *)msk);
288 static inline struct mptcp_sock *mptcp_sk(const struct sock *sk)
290 return (struct mptcp_sock *)sk;
293 /* the msk socket don't use the backlog, also account for the bulk
296 static inline int __mptcp_rmem(const struct sock *sk)
298 return atomic_read(&sk->sk_rmem_alloc) - READ_ONCE(mptcp_sk(sk)->rmem_released);
301 static inline int __mptcp_space(const struct sock *sk)
303 return tcp_win_from_space(sk, READ_ONCE(sk->sk_rcvbuf) - __mptcp_rmem(sk));
306 static inline struct mptcp_data_frag *mptcp_send_head(const struct sock *sk)
308 const struct mptcp_sock *msk = mptcp_sk(sk);
310 return READ_ONCE(msk->first_pending);
313 static inline struct mptcp_data_frag *mptcp_send_next(struct sock *sk)
315 struct mptcp_sock *msk = mptcp_sk(sk);
316 struct mptcp_data_frag *cur;
318 cur = msk->first_pending;
319 return list_is_last(&cur->list, &msk->rtx_queue) ? NULL :
320 list_next_entry(cur, list);
323 static inline struct mptcp_data_frag *mptcp_pending_tail(const struct sock *sk)
325 struct mptcp_sock *msk = mptcp_sk(sk);
327 if (!msk->first_pending)
330 if (WARN_ON_ONCE(list_empty(&msk->rtx_queue)))
333 return list_last_entry(&msk->rtx_queue, struct mptcp_data_frag, list);
336 static inline struct mptcp_data_frag *mptcp_rtx_head(const struct sock *sk)
338 struct mptcp_sock *msk = mptcp_sk(sk);
340 if (msk->snd_una == READ_ONCE(msk->snd_nxt))
343 return list_first_entry_or_null(&msk->rtx_queue, struct mptcp_data_frag, list);
346 struct mptcp_subflow_request_sock {
347 struct tcp_request_sock sk;
360 struct mptcp_sock *msk;
361 struct hlist_nulls_node token_node;
364 static inline struct mptcp_subflow_request_sock *
365 mptcp_subflow_rsk(const struct request_sock *rsk)
367 return (struct mptcp_subflow_request_sock *)rsk;
370 enum mptcp_data_avail {
371 MPTCP_SUBFLOW_NODATA,
372 MPTCP_SUBFLOW_DATA_AVAIL,
375 struct mptcp_delegated_action {
376 struct napi_struct napi;
377 struct list_head head;
380 DECLARE_PER_CPU(struct mptcp_delegated_action, mptcp_delegated_actions);
382 #define MPTCP_DELEGATE_SEND 0
384 /* MPTCP subflow context */
385 struct mptcp_subflow_context {
386 struct list_head node;/* conn_list of subflows */
397 u32 request_mptcp : 1, /* send MP_CAPABLE */
398 request_join : 1, /* send MP_JOIN */
400 mp_capable : 1, /* remote is MPTCP capable */
401 mp_join : 1, /* remote is JOINing */
402 fully_established : 1, /* path validated */
403 pm_notified : 1, /* PM hook called for established status */
410 can_ack : 1, /* only after processing the remote a key */
411 disposable : 1; /* ctx can be free at ulp release time */
412 enum mptcp_data_avail data_avail;
417 u8 hmac[MPTCPOPT_HMAC_LEN];
421 u8 reset_transient:1;
424 long delegated_status;
425 struct list_head delegated_node; /* link into delegated_action, protected by local BH */
429 struct sock *tcp_sock; /* tcp sk backpointer */
430 struct sock *conn; /* parent mptcp_sock */
431 const struct inet_connection_sock_af_ops *icsk_af_ops;
432 void (*tcp_data_ready)(struct sock *sk);
433 void (*tcp_state_change)(struct sock *sk);
434 void (*tcp_write_space)(struct sock *sk);
435 void (*tcp_error_report)(struct sock *sk);
440 static inline struct mptcp_subflow_context *
441 mptcp_subflow_ctx(const struct sock *sk)
443 struct inet_connection_sock *icsk = inet_csk(sk);
445 /* Use RCU on icsk_ulp_data only for sock diag code */
446 return (__force struct mptcp_subflow_context *)icsk->icsk_ulp_data;
449 static inline struct sock *
450 mptcp_subflow_tcp_sock(const struct mptcp_subflow_context *subflow)
452 return subflow->tcp_sock;
456 mptcp_subflow_get_map_offset(const struct mptcp_subflow_context *subflow)
458 return tcp_sk(mptcp_subflow_tcp_sock(subflow))->copied_seq -
459 subflow->ssn_offset -
460 subflow->map_subflow_seq;
464 mptcp_subflow_get_mapped_dsn(const struct mptcp_subflow_context *subflow)
466 return subflow->map_seq + mptcp_subflow_get_map_offset(subflow);
469 static inline void mptcp_add_pending_subflow(struct mptcp_sock *msk,
470 struct mptcp_subflow_context *subflow)
472 sock_hold(mptcp_subflow_tcp_sock(subflow));
473 spin_lock_bh(&msk->join_list_lock);
474 list_add_tail(&subflow->node, &msk->join_list);
475 spin_unlock_bh(&msk->join_list_lock);
478 void mptcp_subflow_process_delegated(struct sock *ssk);
480 static inline void mptcp_subflow_delegate(struct mptcp_subflow_context *subflow)
482 struct mptcp_delegated_action *delegated;
485 /* The implied barrier pairs with mptcp_subflow_delegated_done(), and
486 * ensures the below list check sees list updates done prior to status
489 if (!test_and_set_bit(MPTCP_DELEGATE_SEND, &subflow->delegated_status)) {
490 /* still on delegated list from previous scheduling */
491 if (!list_empty(&subflow->delegated_node))
494 /* the caller held the subflow bh socket lock */
495 lockdep_assert_in_softirq();
497 delegated = this_cpu_ptr(&mptcp_delegated_actions);
498 schedule = list_empty(&delegated->head);
499 list_add_tail(&subflow->delegated_node, &delegated->head);
500 sock_hold(mptcp_subflow_tcp_sock(subflow));
502 napi_schedule(&delegated->napi);
506 static inline struct mptcp_subflow_context *
507 mptcp_subflow_delegated_next(struct mptcp_delegated_action *delegated)
509 struct mptcp_subflow_context *ret;
511 if (list_empty(&delegated->head))
514 ret = list_first_entry(&delegated->head, struct mptcp_subflow_context, delegated_node);
515 list_del_init(&ret->delegated_node);
519 static inline bool mptcp_subflow_has_delegated_action(const struct mptcp_subflow_context *subflow)
521 return test_bit(MPTCP_DELEGATE_SEND, &subflow->delegated_status);
524 static inline void mptcp_subflow_delegated_done(struct mptcp_subflow_context *subflow)
526 /* pairs with mptcp_subflow_delegate, ensures delegate_node is updated before
527 * touching the status bit
530 clear_bit(MPTCP_DELEGATE_SEND, &subflow->delegated_status);
533 int mptcp_is_enabled(struct net *net);
534 unsigned int mptcp_get_add_addr_timeout(struct net *net);
535 void mptcp_subflow_fully_established(struct mptcp_subflow_context *subflow,
536 struct mptcp_options_received *mp_opt);
537 bool mptcp_subflow_data_available(struct sock *sk);
538 void __init mptcp_subflow_init(void);
539 void mptcp_subflow_shutdown(struct sock *sk, struct sock *ssk, int how);
540 void mptcp_close_ssk(struct sock *sk, struct sock *ssk,
541 struct mptcp_subflow_context *subflow);
542 void mptcp_subflow_reset(struct sock *ssk);
543 void mptcp_sock_graft(struct sock *sk, struct socket *parent);
544 struct socket *__mptcp_nmpc_socket(const struct mptcp_sock *msk);
546 /* called with sk socket lock held */
547 int __mptcp_subflow_connect(struct sock *sk, const struct mptcp_addr_info *loc,
548 const struct mptcp_addr_info *remote,
549 u8 flags, int ifindex);
550 int mptcp_subflow_create_socket(struct sock *sk, struct socket **new_sock);
551 void mptcp_info2sockaddr(const struct mptcp_addr_info *info,
552 struct sockaddr_storage *addr,
553 unsigned short family);
555 static inline bool mptcp_subflow_active(struct mptcp_subflow_context *subflow)
557 struct sock *ssk = mptcp_subflow_tcp_sock(subflow);
559 /* can't send if JOIN hasn't completed yet (i.e. is usable for mptcp) */
560 if (subflow->request_join && !subflow->fully_established)
563 /* only send if our side has not closed yet */
564 return ((1 << ssk->sk_state) & (TCPF_ESTABLISHED | TCPF_CLOSE_WAIT));
567 static inline void mptcp_subflow_tcp_fallback(struct sock *sk,
568 struct mptcp_subflow_context *ctx)
570 sk->sk_data_ready = ctx->tcp_data_ready;
571 sk->sk_state_change = ctx->tcp_state_change;
572 sk->sk_write_space = ctx->tcp_write_space;
573 sk->sk_error_report = ctx->tcp_error_report;
575 inet_csk(sk)->icsk_af_ops = ctx->icsk_af_ops;
578 void __init mptcp_proto_init(void);
579 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
580 int __init mptcp_proto_v6_init(void);
583 struct sock *mptcp_sk_clone(const struct sock *sk,
584 const struct mptcp_options_received *mp_opt,
585 struct request_sock *req);
586 void mptcp_get_options(const struct sock *sk,
587 const struct sk_buff *skb,
588 struct mptcp_options_received *mp_opt);
590 void mptcp_finish_connect(struct sock *sk);
591 void __mptcp_set_connected(struct sock *sk);
592 static inline bool mptcp_is_fully_established(struct sock *sk)
594 return inet_sk_state_load(sk) == TCP_ESTABLISHED &&
595 READ_ONCE(mptcp_sk(sk)->fully_established);
597 void mptcp_rcv_space_init(struct mptcp_sock *msk, const struct sock *ssk);
598 void mptcp_data_ready(struct sock *sk, struct sock *ssk);
599 bool mptcp_finish_join(struct sock *sk);
600 bool mptcp_schedule_work(struct sock *sk);
601 int mptcp_setsockopt(struct sock *sk, int level, int optname,
602 sockptr_t optval, unsigned int optlen);
603 int mptcp_getsockopt(struct sock *sk, int level, int optname,
604 char __user *optval, int __user *option);
606 u64 __mptcp_expand_seq(u64 old_seq, u64 cur_seq);
607 static inline u64 mptcp_expand_seq(u64 old_seq, u64 cur_seq, bool use_64bit)
612 return __mptcp_expand_seq(old_seq, cur_seq);
614 void __mptcp_check_push(struct sock *sk, struct sock *ssk);
615 void __mptcp_data_acked(struct sock *sk);
616 void __mptcp_error_report(struct sock *sk);
617 void mptcp_subflow_eof(struct sock *sk);
618 bool mptcp_update_rcv_data_fin(struct mptcp_sock *msk, u64 data_fin_seq, bool use_64bit);
619 void __mptcp_flush_join_list(struct mptcp_sock *msk);
620 static inline bool mptcp_data_fin_enabled(const struct mptcp_sock *msk)
622 return READ_ONCE(msk->snd_data_fin_enable) &&
623 READ_ONCE(msk->write_seq) == READ_ONCE(msk->snd_nxt);
626 static inline bool mptcp_propagate_sndbuf(struct sock *sk, struct sock *ssk)
628 if ((sk->sk_userlocks & SOCK_SNDBUF_LOCK) || ssk->sk_sndbuf <= READ_ONCE(sk->sk_sndbuf))
631 WRITE_ONCE(sk->sk_sndbuf, ssk->sk_sndbuf);
635 static inline void mptcp_write_space(struct sock *sk)
637 if (sk_stream_is_writeable(sk)) {
638 /* pairs with memory barrier in mptcp_poll */
640 if (test_and_clear_bit(MPTCP_NOSPACE, &mptcp_sk(sk)->flags))
641 sk_stream_write_space(sk);
645 void mptcp_destroy_common(struct mptcp_sock *msk);
647 void __init mptcp_token_init(void);
648 static inline void mptcp_token_init_request(struct request_sock *req)
650 mptcp_subflow_rsk(req)->token_node.pprev = NULL;
653 int mptcp_token_new_request(struct request_sock *req);
654 void mptcp_token_destroy_request(struct request_sock *req);
655 int mptcp_token_new_connect(struct sock *sk);
656 void mptcp_token_accept(struct mptcp_subflow_request_sock *r,
657 struct mptcp_sock *msk);
658 bool mptcp_token_exists(u32 token);
659 struct mptcp_sock *mptcp_token_get_sock(u32 token);
660 struct mptcp_sock *mptcp_token_iter_next(const struct net *net, long *s_slot,
662 void mptcp_token_destroy(struct mptcp_sock *msk);
664 void mptcp_crypto_key_sha(u64 key, u32 *token, u64 *idsn);
666 void mptcp_crypto_hmac_sha(u64 key1, u64 key2, u8 *msg, int len, void *hmac);
668 void __init mptcp_pm_init(void);
669 void mptcp_pm_data_init(struct mptcp_sock *msk);
670 void mptcp_pm_new_connection(struct mptcp_sock *msk, const struct sock *ssk, int server_side);
671 void mptcp_pm_fully_established(struct mptcp_sock *msk, const struct sock *ssk, gfp_t gfp);
672 bool mptcp_pm_allow_new_subflow(struct mptcp_sock *msk);
673 void mptcp_pm_connection_closed(struct mptcp_sock *msk);
674 void mptcp_pm_subflow_established(struct mptcp_sock *msk);
675 void mptcp_pm_subflow_closed(struct mptcp_sock *msk, u8 id);
676 void mptcp_pm_add_addr_received(struct mptcp_sock *msk,
677 const struct mptcp_addr_info *addr);
678 void mptcp_pm_add_addr_echoed(struct mptcp_sock *msk,
679 struct mptcp_addr_info *addr);
680 void mptcp_pm_add_addr_send_ack(struct mptcp_sock *msk);
681 void mptcp_pm_nl_addr_send_ack(struct mptcp_sock *msk);
682 void mptcp_pm_rm_addr_received(struct mptcp_sock *msk,
683 const struct mptcp_rm_list *rm_list);
684 void mptcp_pm_mp_prio_received(struct sock *sk, u8 bkup);
685 int mptcp_pm_nl_mp_prio_send_ack(struct mptcp_sock *msk,
686 struct mptcp_addr_info *addr,
688 void mptcp_pm_free_anno_list(struct mptcp_sock *msk);
689 bool mptcp_pm_sport_in_anno_list(struct mptcp_sock *msk, const struct sock *sk);
690 struct mptcp_pm_add_entry *
691 mptcp_pm_del_add_timer(struct mptcp_sock *msk,
692 struct mptcp_addr_info *addr, bool check_id);
693 struct mptcp_pm_add_entry *
694 mptcp_lookup_anno_list_by_saddr(struct mptcp_sock *msk,
695 struct mptcp_addr_info *addr);
697 int mptcp_pm_announce_addr(struct mptcp_sock *msk,
698 const struct mptcp_addr_info *addr,
700 int mptcp_pm_remove_addr(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
701 int mptcp_pm_remove_subflow(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
703 void mptcp_event(enum mptcp_event_type type, const struct mptcp_sock *msk,
704 const struct sock *ssk, gfp_t gfp);
705 void mptcp_event_addr_announced(const struct mptcp_sock *msk, const struct mptcp_addr_info *info);
706 void mptcp_event_addr_removed(const struct mptcp_sock *msk, u8 id);
708 static inline bool mptcp_pm_should_add_signal(struct mptcp_sock *msk)
710 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_SIGNAL);
713 static inline bool mptcp_pm_should_add_signal_echo(struct mptcp_sock *msk)
715 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_ECHO);
718 static inline bool mptcp_pm_should_add_signal_ipv6(struct mptcp_sock *msk)
720 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_IPV6);
723 static inline bool mptcp_pm_should_add_signal_port(struct mptcp_sock *msk)
725 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_PORT);
728 static inline bool mptcp_pm_should_rm_signal(struct mptcp_sock *msk)
730 return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_RM_ADDR_SIGNAL);
733 static inline unsigned int mptcp_add_addr_len(int family, bool echo, bool port)
735 u8 len = TCPOLEN_MPTCP_ADD_ADDR_BASE;
737 if (family == AF_INET6)
738 len = TCPOLEN_MPTCP_ADD_ADDR6_BASE;
740 len += MPTCPOPT_THMAC_LEN;
741 /* account for 2 trailing 'nop' options */
743 len += TCPOLEN_MPTCP_PORT_LEN + TCPOLEN_MPTCP_PORT_ALIGN;
748 static inline int mptcp_rm_addr_len(const struct mptcp_rm_list *rm_list)
750 if (rm_list->nr == 0 || rm_list->nr > MPTCP_RM_IDS_MAX)
753 return TCPOLEN_MPTCP_RM_ADDR_BASE + roundup(rm_list->nr - 1, 4) + 1;
756 bool mptcp_pm_add_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
757 struct mptcp_addr_info *saddr, bool *echo, bool *port);
758 bool mptcp_pm_rm_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
759 struct mptcp_rm_list *rm_list);
760 int mptcp_pm_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
762 void __init mptcp_pm_nl_init(void);
763 void mptcp_pm_nl_data_init(struct mptcp_sock *msk);
764 void mptcp_pm_nl_work(struct mptcp_sock *msk);
765 void mptcp_pm_nl_rm_subflow_received(struct mptcp_sock *msk,
766 const struct mptcp_rm_list *rm_list);
767 int mptcp_pm_nl_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
768 unsigned int mptcp_pm_get_add_addr_signal_max(struct mptcp_sock *msk);
769 unsigned int mptcp_pm_get_add_addr_accept_max(struct mptcp_sock *msk);
770 unsigned int mptcp_pm_get_subflows_max(struct mptcp_sock *msk);
771 unsigned int mptcp_pm_get_local_addr_max(struct mptcp_sock *msk);
773 int mptcp_setsockopt(struct sock *sk, int level, int optname,
774 sockptr_t optval, unsigned int optlen);
776 void mptcp_sockopt_sync(struct mptcp_sock *msk, struct sock *ssk);
777 void mptcp_sockopt_sync_all(struct mptcp_sock *msk);
779 static inline struct mptcp_ext *mptcp_get_ext(const struct sk_buff *skb)
781 return (struct mptcp_ext *)skb_ext_find(skb, SKB_EXT_MPTCP);
784 void mptcp_diag_subflow_init(struct tcp_ulp_ops *ops);
786 static inline bool __mptcp_check_fallback(const struct mptcp_sock *msk)
788 return test_bit(MPTCP_FALLBACK_DONE, &msk->flags);
791 static inline bool mptcp_check_fallback(const struct sock *sk)
793 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
794 struct mptcp_sock *msk = mptcp_sk(subflow->conn);
796 return __mptcp_check_fallback(msk);
799 static inline void __mptcp_do_fallback(struct mptcp_sock *msk)
801 if (test_bit(MPTCP_FALLBACK_DONE, &msk->flags)) {
802 pr_debug("TCP fallback already done (msk=%p)", msk);
805 set_bit(MPTCP_FALLBACK_DONE, &msk->flags);
808 static inline void mptcp_do_fallback(struct sock *sk)
810 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
811 struct mptcp_sock *msk = mptcp_sk(subflow->conn);
813 __mptcp_do_fallback(msk);
816 #define pr_fallback(a) pr_debug("%s:fallback to TCP (msk=%p)", __func__, a)
818 static inline bool subflow_simultaneous_connect(struct sock *sk)
820 struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
821 struct sock *parent = subflow->conn;
823 return sk->sk_state == TCP_ESTABLISHED &&
824 !mptcp_sk(parent)->pm.server_side &&
825 !subflow->conn_finished;
828 #ifdef CONFIG_SYN_COOKIES
829 void subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
830 struct sk_buff *skb);
831 bool mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
832 struct sk_buff *skb);
833 void __init mptcp_join_cookie_init(void);
836 subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
837 struct sk_buff *skb) {}
839 mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
845 static inline void mptcp_join_cookie_init(void) {}
848 #endif /* __MPTCP_PROTOCOL_H */