cbf9a9e176b24c010b6d34b591ad999be39604d8
[platform/kernel/linux-rpi.git] / net / mptcp / protocol.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Multipath TCP
3  *
4  * Copyright (c) 2017 - 2019, Intel Corporation.
5  */
6
7 #ifndef __MPTCP_PROTOCOL_H
8 #define __MPTCP_PROTOCOL_H
9
10 #include <linux/random.h>
11 #include <net/tcp.h>
12 #include <net/inet_connection_sock.h>
13 #include <uapi/linux/mptcp.h>
14 #include <net/genetlink.h>
15
16 #define MPTCP_SUPPORTED_VERSION 1
17
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)
32
33 #define OPTION_MPTCP_CSUMREQD   BIT(13)
34
35 #define OPTIONS_MPTCP_MPC       (OPTION_MPTCP_MPC_SYN | OPTION_MPTCP_MPC_SYNACK | \
36                                  OPTION_MPTCP_MPC_ACK)
37 #define OPTIONS_MPTCP_MPJ       (OPTION_MPTCP_MPJ_SYN | OPTION_MPTCP_MPJ_SYNACK | \
38                                  OPTION_MPTCP_MPJ_ACK)
39
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
50
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
81
82 #define TCPOLEN_MPTCP_MPC_ACK_DATA_CSUM (TCPOLEN_MPTCP_DSS_CHECKSUM + TCPOLEN_MPTCP_MPC_ACK_DATA)
83
84 /* MPTCP MP_JOIN flags */
85 #define MPTCPOPT_BACKUP         BIT(0)
86 #define MPTCPOPT_THMAC_LEN      8
87
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)
95
96 /* MPTCP DSS flags */
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)
103
104 /* MPTCP ADD_ADDR flags */
105 #define MPTCP_ADDR_ECHO         BIT(0)
106
107 /* MPTCP MP_PRIO flags */
108 #define MPTCP_PRIO_BKUP         BIT(0)
109
110 /* MPTCP TCPRST flags */
111 #define MPTCP_RST_TRANSIENT     BIT(0)
112
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
118
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
126
127 struct mptcp_skb_cb {
128         u64 map_seq;
129         u64 end_seq;
130         u32 offset;
131         u8  has_rxtstamp:1;
132 };
133
134 #define MPTCP_SKB_CB(__skb)     ((struct mptcp_skb_cb *)&((__skb)->cb[0]))
135
136 static inline bool before64(__u64 seq1, __u64 seq2)
137 {
138         return (__s64)(seq1 - seq2) < 0;
139 }
140
141 #define after64(seq2, seq1)     before64(seq1, seq2)
142
143 struct mptcp_options_received {
144         u64     sndr_key;
145         u64     rcvr_key;
146         u64     data_ack;
147         u64     data_seq;
148         u32     subflow_seq;
149         u16     data_len;
150         __sum16 csum;
151         u16     suboptions;
152         u32     token;
153         u32     nonce;
154         u16     use_map:1,
155                 dsn64:1,
156                 data_fin:1,
157                 use_ack:1,
158                 ack64:1,
159                 mpc_map:1,
160                 reset_reason:4,
161                 reset_transient:1,
162                 echo:1,
163                 backup:1,
164                 deny_join_id0:1,
165                 __unused:2;
166         u8      join_id;
167         u64     thmac;
168         u8      hmac[MPTCPOPT_HMAC_LEN];
169         struct mptcp_addr_info addr;
170         struct mptcp_rm_list rm_list;
171         u64     ahmac;
172         u64     fail_seq;
173 };
174
175 static inline __be32 mptcp_option(u8 subopt, u8 len, u8 nib, u8 field)
176 {
177         return htonl((TCPOPT_MPTCP << 24) | (len << 16) | (subopt << 12) |
178                      ((nib & 0xF) << 8) | field);
179 }
180
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
190                                          */
191 };
192
193 enum mptcp_pm_type {
194         MPTCP_PM_TYPE_KERNEL = 0,
195         MPTCP_PM_TYPE_USERSPACE,
196
197         __MPTCP_PM_TYPE_NR,
198         __MPTCP_PM_TYPE_MAX = __MPTCP_PM_TYPE_NR - 1,
199 };
200
201 /* Status bits below MPTCP_PM_ALREADY_ESTABLISHED need pm worker actions */
202 #define MPTCP_PM_WORK_MASK ((1 << MPTCP_PM_ALREADY_ESTABLISHED) - 1)
203
204 enum mptcp_addr_signal_status {
205         MPTCP_ADD_ADDR_SIGNAL,
206         MPTCP_ADD_ADDR_ECHO,
207         MPTCP_RM_ADDR_SIGNAL,
208 };
209
210 /* max value of mptcp_addr_info.id */
211 #define MPTCP_PM_MAX_ADDR_ID            U8_MAX
212
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;
218
219         spinlock_t      lock;           /*protects the whole PM data */
220
221         u8              addr_signal;
222         bool            server_side;
223         bool            work_pending;
224         bool            accept_addr;
225         bool            accept_subflow;
226         bool            remote_deny_join_id0;
227         u8              add_addr_signaled;
228         u8              add_addr_accepted;
229         u8              local_addr_used;
230         u8              pm_type;
231         u8              subflows;
232         u8              status;
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;
236 };
237
238 struct mptcp_pm_addr_entry {
239         struct list_head        list;
240         struct mptcp_addr_info  addr;
241         u8                      flags;
242         int                     ifindex;
243         struct socket           *lsk;
244 };
245
246 struct mptcp_data_frag {
247         struct list_head list;
248         u64 data_seq;
249         u16 data_len;
250         u16 offset;
251         u16 overhead;
252         u16 already_sent;
253         struct page *page;
254 };
255
256 /* MPTCP connection sock */
257 struct mptcp_sock {
258         /* inet_connection_sock must be the first member */
259         struct inet_connection_sock sk;
260         u64             local_key;
261         u64             remote_key;
262         u64             write_seq;
263         u64             bytes_sent;
264         u64             snd_nxt;
265         u64             bytes_received;
266         u64             ack_seq;
267         atomic64_t      rcv_wnd_sent;
268         u64             rcv_data_fin_seq;
269         u64             bytes_retrans;
270         int             rmem_fwd_alloc;
271         int             snd_burst;
272         int             old_wspace;
273         u64             recovery_snd_nxt;       /* in recovery mode accept up to this seq;
274                                                  * recovery related fields are under data_lock
275                                                  * protection
276                                                  */
277         u64             bytes_acked;
278         u64             snd_una;
279         u64             wnd_end;
280         unsigned long   timer_ival;
281         u32             token;
282         int             rmem_released;
283         unsigned long   flags;
284         unsigned long   cb_flags;
285         unsigned long   push_pending;
286         bool            recovery;               /* closing subflow write queue reinjected */
287         bool            can_ack;
288         bool            fully_established;
289         bool            rcv_data_fin;
290         bool            snd_data_fin_enable;
291         bool            rcv_fastclose;
292         bool            use_64bit_ack; /* Set when we received a 64-bit DSN */
293         bool            csum_enabled;
294         bool            allow_infinite_fallback;
295         u8              mpc_endpoint_id;
296         u8              recvmsg_inq:1,
297                         cork:1,
298                         nodelay:1,
299                         fastopening:1,
300                         in_accept_queue:1,
301                         free_first:1;
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().
313                                  */
314         struct mptcp_pm_data    pm;
315         struct {
316                 u32     space;  /* bytes copied in last measurement window */
317                 u32     copied; /* bytes copied in this measurement window */
318                 u64     time;   /* start time of measurement window */
319                 u64     rtt_us; /* last maximum rtt of subflows */
320         } rcvq_space;
321         u8              scaling_ratio;
322
323         u32             subflow_id;
324         u32             setsockopt_seq;
325         char            ca_name[TCP_CA_NAME_MAX];
326 };
327
328 #define mptcp_data_lock(sk) spin_lock_bh(&(sk)->sk_lock.slock)
329 #define mptcp_data_unlock(sk) spin_unlock_bh(&(sk)->sk_lock.slock)
330
331 #define mptcp_for_each_subflow(__msk, __subflow)                        \
332         list_for_each_entry(__subflow, &((__msk)->conn_list), node)
333 #define mptcp_for_each_subflow_safe(__msk, __subflow, __tmp)                    \
334         list_for_each_entry_safe(__subflow, __tmp, &((__msk)->conn_list), node)
335
336 static inline void msk_owned_by_me(const struct mptcp_sock *msk)
337 {
338         sock_owned_by_me((const struct sock *)msk);
339 }
340
341 #define mptcp_sk(ptr) container_of_const(ptr, struct mptcp_sock, sk.icsk_inet.sk)
342
343 /* the msk socket don't use the backlog, also account for the bulk
344  * free memory
345  */
346 static inline int __mptcp_rmem(const struct sock *sk)
347 {
348         return atomic_read(&sk->sk_rmem_alloc) - READ_ONCE(mptcp_sk(sk)->rmem_released);
349 }
350
351 static inline int mptcp_win_from_space(const struct sock *sk, int space)
352 {
353         return __tcp_win_from_space(mptcp_sk(sk)->scaling_ratio, space);
354 }
355
356 static inline int __mptcp_space(const struct sock *sk)
357 {
358         return mptcp_win_from_space(sk, READ_ONCE(sk->sk_rcvbuf) - __mptcp_rmem(sk));
359 }
360
361 static inline struct mptcp_data_frag *mptcp_send_head(const struct sock *sk)
362 {
363         const struct mptcp_sock *msk = mptcp_sk(sk);
364
365         return READ_ONCE(msk->first_pending);
366 }
367
368 static inline struct mptcp_data_frag *mptcp_send_next(struct sock *sk)
369 {
370         struct mptcp_sock *msk = mptcp_sk(sk);
371         struct mptcp_data_frag *cur;
372
373         cur = msk->first_pending;
374         return list_is_last(&cur->list, &msk->rtx_queue) ? NULL :
375                                                      list_next_entry(cur, list);
376 }
377
378 static inline struct mptcp_data_frag *mptcp_pending_tail(const struct sock *sk)
379 {
380         const struct mptcp_sock *msk = mptcp_sk(sk);
381
382         if (!msk->first_pending)
383                 return NULL;
384
385         if (WARN_ON_ONCE(list_empty(&msk->rtx_queue)))
386                 return NULL;
387
388         return list_last_entry(&msk->rtx_queue, struct mptcp_data_frag, list);
389 }
390
391 static inline struct mptcp_data_frag *mptcp_rtx_head(struct sock *sk)
392 {
393         struct mptcp_sock *msk = mptcp_sk(sk);
394
395         if (msk->snd_una == READ_ONCE(msk->snd_nxt))
396                 return NULL;
397
398         return list_first_entry_or_null(&msk->rtx_queue, struct mptcp_data_frag, list);
399 }
400
401 struct csum_pseudo_header {
402         __be64 data_seq;
403         __be32 subflow_seq;
404         __be16 data_len;
405         __sum16 csum;
406 };
407
408 struct mptcp_subflow_request_sock {
409         struct  tcp_request_sock sk;
410         u16     mp_capable : 1,
411                 mp_join : 1,
412                 backup : 1,
413                 csum_reqd : 1,
414                 allow_join_id0 : 1;
415         u8      local_id;
416         u8      remote_id;
417         u64     local_key;
418         u64     idsn;
419         u32     token;
420         u32     ssn_offset;
421         u64     thmac;
422         u32     local_nonce;
423         u32     remote_nonce;
424         struct mptcp_sock       *msk;
425         struct hlist_nulls_node token_node;
426 };
427
428 static inline struct mptcp_subflow_request_sock *
429 mptcp_subflow_rsk(const struct request_sock *rsk)
430 {
431         return (struct mptcp_subflow_request_sock *)rsk;
432 }
433
434 enum mptcp_data_avail {
435         MPTCP_SUBFLOW_NODATA,
436         MPTCP_SUBFLOW_DATA_AVAIL,
437 };
438
439 struct mptcp_delegated_action {
440         struct napi_struct napi;
441         struct list_head head;
442 };
443
444 DECLARE_PER_CPU(struct mptcp_delegated_action, mptcp_delegated_actions);
445
446 #define MPTCP_DELEGATE_SEND             0
447 #define MPTCP_DELEGATE_ACK              1
448
449 /* MPTCP subflow context */
450 struct mptcp_subflow_context {
451         struct  list_head node;/* conn_list of subflows */
452
453         struct_group(reset,
454
455         unsigned long avg_pacing_rate; /* protected by msk socket lock */
456         u64     local_key;
457         u64     remote_key;
458         u64     idsn;
459         u64     map_seq;
460         u32     snd_isn;
461         u32     token;
462         u32     rel_write_seq;
463         u32     map_subflow_seq;
464         u32     ssn_offset;
465         u32     map_data_len;
466         __wsum  map_data_csum;
467         u32     map_csum_len;
468         u32     request_mptcp : 1,  /* send MP_CAPABLE */
469                 request_join : 1,   /* send MP_JOIN */
470                 request_bkup : 1,
471                 mp_capable : 1,     /* remote is MPTCP capable */
472                 mp_join : 1,        /* remote is JOINing */
473                 fully_established : 1,      /* path validated */
474                 pm_notified : 1,    /* PM hook called for established status */
475                 conn_finished : 1,
476                 map_valid : 1,
477                 map_csum_reqd : 1,
478                 map_data_fin : 1,
479                 mpc_map : 1,
480                 backup : 1,
481                 send_mp_prio : 1,
482                 send_mp_fail : 1,
483                 send_fastclose : 1,
484                 send_infinite_map : 1,
485                 remote_key_valid : 1,        /* received the peer key from */
486                 disposable : 1,     /* ctx can be free at ulp release time */
487                 stale : 1,          /* unable to snd/rcv data, do not use for xmit */
488                 local_id_valid : 1, /* local_id is correctly initialized */
489                 valid_csum_seen : 1,        /* at least one csum validated */
490                 is_mptfo : 1,       /* subflow is doing TFO */
491                 __unused : 9;
492         enum mptcp_data_avail data_avail;
493         u32     remote_nonce;
494         u64     thmac;
495         u32     local_nonce;
496         u32     remote_token;
497         union {
498                 u8      hmac[MPTCPOPT_HMAC_LEN]; /* MPJ subflow only */
499                 u64     iasn;       /* initial ack sequence number, MPC subflows only */
500         };
501         u8      local_id;
502         u8      remote_id;
503         u8      reset_seen:1;
504         u8      reset_transient:1;
505         u8      reset_reason:4;
506         u8      stale_count;
507
508         u32     subflow_id;
509
510         long    delegated_status;
511         unsigned long   fail_tout;
512
513         );
514
515         struct  list_head delegated_node;   /* link into delegated_action, protected by local BH */
516
517         u32     setsockopt_seq;
518         u32     stale_rcv_tstamp;
519
520         struct  sock *tcp_sock;     /* tcp sk backpointer */
521         struct  sock *conn;         /* parent mptcp_sock */
522         const   struct inet_connection_sock_af_ops *icsk_af_ops;
523         void    (*tcp_state_change)(struct sock *sk);
524         void    (*tcp_error_report)(struct sock *sk);
525
526         struct  rcu_head rcu;
527 };
528
529 static inline struct mptcp_subflow_context *
530 mptcp_subflow_ctx(const struct sock *sk)
531 {
532         struct inet_connection_sock *icsk = inet_csk(sk);
533
534         /* Use RCU on icsk_ulp_data only for sock diag code */
535         return (__force struct mptcp_subflow_context *)icsk->icsk_ulp_data;
536 }
537
538 static inline struct sock *
539 mptcp_subflow_tcp_sock(const struct mptcp_subflow_context *subflow)
540 {
541         return subflow->tcp_sock;
542 }
543
544 static inline void
545 mptcp_subflow_ctx_reset(struct mptcp_subflow_context *subflow)
546 {
547         memset(&subflow->reset, 0, sizeof(subflow->reset));
548         subflow->request_mptcp = 1;
549 }
550
551 static inline u64
552 mptcp_subflow_get_map_offset(const struct mptcp_subflow_context *subflow)
553 {
554         return tcp_sk(mptcp_subflow_tcp_sock(subflow))->copied_seq -
555                       subflow->ssn_offset -
556                       subflow->map_subflow_seq;
557 }
558
559 static inline u64
560 mptcp_subflow_get_mapped_dsn(const struct mptcp_subflow_context *subflow)
561 {
562         return subflow->map_seq + mptcp_subflow_get_map_offset(subflow);
563 }
564
565 void mptcp_subflow_process_delegated(struct sock *ssk);
566
567 static inline void mptcp_subflow_delegate(struct mptcp_subflow_context *subflow, int action)
568 {
569         struct mptcp_delegated_action *delegated;
570         bool schedule;
571
572         /* the caller held the subflow bh socket lock */
573         lockdep_assert_in_softirq();
574
575         /* The implied barrier pairs with mptcp_subflow_delegated_done(), and
576          * ensures the below list check sees list updates done prior to status
577          * bit changes
578          */
579         if (!test_and_set_bit(action, &subflow->delegated_status)) {
580                 /* still on delegated list from previous scheduling */
581                 if (!list_empty(&subflow->delegated_node))
582                         return;
583
584                 delegated = this_cpu_ptr(&mptcp_delegated_actions);
585                 schedule = list_empty(&delegated->head);
586                 list_add_tail(&subflow->delegated_node, &delegated->head);
587                 sock_hold(mptcp_subflow_tcp_sock(subflow));
588                 if (schedule)
589                         napi_schedule(&delegated->napi);
590         }
591 }
592
593 static inline struct mptcp_subflow_context *
594 mptcp_subflow_delegated_next(struct mptcp_delegated_action *delegated)
595 {
596         struct mptcp_subflow_context *ret;
597
598         if (list_empty(&delegated->head))
599                 return NULL;
600
601         ret = list_first_entry(&delegated->head, struct mptcp_subflow_context, delegated_node);
602         list_del_init(&ret->delegated_node);
603         return ret;
604 }
605
606 static inline bool mptcp_subflow_has_delegated_action(const struct mptcp_subflow_context *subflow)
607 {
608         return !!READ_ONCE(subflow->delegated_status);
609 }
610
611 static inline void mptcp_subflow_delegated_done(struct mptcp_subflow_context *subflow, int action)
612 {
613         /* pairs with mptcp_subflow_delegate, ensures delegate_node is updated before
614          * touching the status bit
615          */
616         smp_wmb();
617         clear_bit(action, &subflow->delegated_status);
618 }
619
620 int mptcp_is_enabled(const struct net *net);
621 unsigned int mptcp_get_add_addr_timeout(const struct net *net);
622 int mptcp_is_checksum_enabled(const struct net *net);
623 int mptcp_allow_join_id0(const struct net *net);
624 unsigned int mptcp_stale_loss_cnt(const struct net *net);
625 int mptcp_get_pm_type(const struct net *net);
626 void mptcp_subflow_fully_established(struct mptcp_subflow_context *subflow,
627                                      const struct mptcp_options_received *mp_opt);
628 bool __mptcp_retransmit_pending_data(struct sock *sk);
629 void mptcp_check_and_set_pending(struct sock *sk);
630 void __mptcp_push_pending(struct sock *sk, unsigned int flags);
631 bool mptcp_subflow_data_available(struct sock *sk);
632 void __init mptcp_subflow_init(void);
633 void mptcp_subflow_shutdown(struct sock *sk, struct sock *ssk, int how);
634 void mptcp_close_ssk(struct sock *sk, struct sock *ssk,
635                      struct mptcp_subflow_context *subflow);
636 void __mptcp_subflow_send_ack(struct sock *ssk);
637 void mptcp_subflow_reset(struct sock *ssk);
638 void mptcp_subflow_queue_clean(struct sock *sk, struct sock *ssk);
639 void mptcp_sock_graft(struct sock *sk, struct socket *parent);
640 struct sock *__mptcp_nmpc_sk(struct mptcp_sock *msk);
641 bool __mptcp_close(struct sock *sk, long timeout);
642 void mptcp_cancel_work(struct sock *sk);
643 void __mptcp_unaccepted_force_close(struct sock *sk);
644 void mptcp_set_owner_r(struct sk_buff *skb, struct sock *sk);
645
646 bool mptcp_addresses_equal(const struct mptcp_addr_info *a,
647                            const struct mptcp_addr_info *b, bool use_port);
648 void mptcp_local_address(const struct sock_common *skc, struct mptcp_addr_info *addr);
649
650 /* called with sk socket lock held */
651 int __mptcp_subflow_connect(struct sock *sk, const struct mptcp_addr_info *loc,
652                             const struct mptcp_addr_info *remote);
653 int mptcp_subflow_create_socket(struct sock *sk, unsigned short family,
654                                 struct socket **new_sock);
655 void mptcp_info2sockaddr(const struct mptcp_addr_info *info,
656                          struct sockaddr_storage *addr,
657                          unsigned short family);
658
659 static inline bool __tcp_can_send(const struct sock *ssk)
660 {
661         /* only send if our side has not closed yet */
662         return ((1 << inet_sk_state_load(ssk)) & (TCPF_ESTABLISHED | TCPF_CLOSE_WAIT));
663 }
664
665 static inline bool __mptcp_subflow_active(struct mptcp_subflow_context *subflow)
666 {
667         /* can't send if JOIN hasn't completed yet (i.e. is usable for mptcp) */
668         if (subflow->request_join && !subflow->fully_established)
669                 return false;
670
671         return __tcp_can_send(mptcp_subflow_tcp_sock(subflow));
672 }
673
674 void mptcp_subflow_set_active(struct mptcp_subflow_context *subflow);
675
676 bool mptcp_subflow_active(struct mptcp_subflow_context *subflow);
677
678 void mptcp_subflow_drop_ctx(struct sock *ssk);
679
680 static inline void mptcp_subflow_tcp_fallback(struct sock *sk,
681                                               struct mptcp_subflow_context *ctx)
682 {
683         sk->sk_data_ready = sock_def_readable;
684         sk->sk_state_change = ctx->tcp_state_change;
685         sk->sk_write_space = sk_stream_write_space;
686         sk->sk_error_report = ctx->tcp_error_report;
687
688         inet_csk(sk)->icsk_af_ops = ctx->icsk_af_ops;
689 }
690
691 void __init mptcp_proto_init(void);
692 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
693 int __init mptcp_proto_v6_init(void);
694 #endif
695
696 struct sock *mptcp_sk_clone_init(const struct sock *sk,
697                                  const struct mptcp_options_received *mp_opt,
698                                  struct sock *ssk,
699                                  struct request_sock *req);
700 void mptcp_get_options(const struct sk_buff *skb,
701                        struct mptcp_options_received *mp_opt);
702
703 void mptcp_finish_connect(struct sock *sk);
704 void __mptcp_set_connected(struct sock *sk);
705 void mptcp_reset_timeout(struct mptcp_sock *msk, unsigned long fail_tout);
706 static inline bool mptcp_is_fully_established(struct sock *sk)
707 {
708         return inet_sk_state_load(sk) == TCP_ESTABLISHED &&
709                READ_ONCE(mptcp_sk(sk)->fully_established);
710 }
711 void mptcp_rcv_space_init(struct mptcp_sock *msk, const struct sock *ssk);
712 void mptcp_data_ready(struct sock *sk, struct sock *ssk);
713 bool mptcp_finish_join(struct sock *sk);
714 bool mptcp_schedule_work(struct sock *sk);
715 int mptcp_setsockopt(struct sock *sk, int level, int optname,
716                      sockptr_t optval, unsigned int optlen);
717 int mptcp_getsockopt(struct sock *sk, int level, int optname,
718                      char __user *optval, int __user *option);
719
720 u64 __mptcp_expand_seq(u64 old_seq, u64 cur_seq);
721 static inline u64 mptcp_expand_seq(u64 old_seq, u64 cur_seq, bool use_64bit)
722 {
723         if (use_64bit)
724                 return cur_seq;
725
726         return __mptcp_expand_seq(old_seq, cur_seq);
727 }
728 void __mptcp_check_push(struct sock *sk, struct sock *ssk);
729 void __mptcp_data_acked(struct sock *sk);
730 void __mptcp_error_report(struct sock *sk);
731 bool mptcp_update_rcv_data_fin(struct mptcp_sock *msk, u64 data_fin_seq, bool use_64bit);
732 static inline bool mptcp_data_fin_enabled(const struct mptcp_sock *msk)
733 {
734         return READ_ONCE(msk->snd_data_fin_enable) &&
735                READ_ONCE(msk->write_seq) == READ_ONCE(msk->snd_nxt);
736 }
737
738 static inline bool mptcp_propagate_sndbuf(struct sock *sk, struct sock *ssk)
739 {
740         if ((sk->sk_userlocks & SOCK_SNDBUF_LOCK) || ssk->sk_sndbuf <= READ_ONCE(sk->sk_sndbuf))
741                 return false;
742
743         WRITE_ONCE(sk->sk_sndbuf, ssk->sk_sndbuf);
744         return true;
745 }
746
747 static inline void mptcp_write_space(struct sock *sk)
748 {
749         if (sk_stream_is_writeable(sk)) {
750                 /* pairs with memory barrier in mptcp_poll */
751                 smp_mb();
752                 if (test_and_clear_bit(MPTCP_NOSPACE, &mptcp_sk(sk)->flags))
753                         sk_stream_write_space(sk);
754         }
755 }
756
757 void mptcp_destroy_common(struct mptcp_sock *msk, unsigned int flags);
758
759 #define MPTCP_TOKEN_MAX_RETRIES 4
760
761 void __init mptcp_token_init(void);
762 static inline void mptcp_token_init_request(struct request_sock *req)
763 {
764         mptcp_subflow_rsk(req)->token_node.pprev = NULL;
765 }
766
767 int mptcp_token_new_request(struct request_sock *req);
768 void mptcp_token_destroy_request(struct request_sock *req);
769 int mptcp_token_new_connect(struct sock *ssk);
770 void mptcp_token_accept(struct mptcp_subflow_request_sock *r,
771                         struct mptcp_sock *msk);
772 bool mptcp_token_exists(u32 token);
773 struct mptcp_sock *mptcp_token_get_sock(struct net *net, u32 token);
774 struct mptcp_sock *mptcp_token_iter_next(const struct net *net, long *s_slot,
775                                          long *s_num);
776 void mptcp_token_destroy(struct mptcp_sock *msk);
777
778 void mptcp_crypto_key_sha(u64 key, u32 *token, u64 *idsn);
779
780 void mptcp_crypto_hmac_sha(u64 key1, u64 key2, u8 *msg, int len, void *hmac);
781 __sum16 __mptcp_make_csum(u64 data_seq, u32 subflow_seq, u16 data_len, __wsum sum);
782
783 void __init mptcp_pm_init(void);
784 void mptcp_pm_data_init(struct mptcp_sock *msk);
785 void mptcp_pm_data_reset(struct mptcp_sock *msk);
786 int mptcp_pm_parse_addr(struct nlattr *attr, struct genl_info *info,
787                         struct mptcp_addr_info *addr);
788 int mptcp_pm_parse_entry(struct nlattr *attr, struct genl_info *info,
789                          bool require_family,
790                          struct mptcp_pm_addr_entry *entry);
791 bool mptcp_pm_addr_families_match(const struct sock *sk,
792                                   const struct mptcp_addr_info *loc,
793                                   const struct mptcp_addr_info *rem);
794 void mptcp_pm_subflow_chk_stale(const struct mptcp_sock *msk, struct sock *ssk);
795 void mptcp_pm_nl_subflow_chk_stale(const struct mptcp_sock *msk, struct sock *ssk);
796 void mptcp_pm_new_connection(struct mptcp_sock *msk, const struct sock *ssk, int server_side);
797 void mptcp_pm_fully_established(struct mptcp_sock *msk, const struct sock *ssk);
798 bool mptcp_pm_allow_new_subflow(struct mptcp_sock *msk);
799 void mptcp_pm_connection_closed(struct mptcp_sock *msk);
800 void mptcp_pm_subflow_established(struct mptcp_sock *msk);
801 bool mptcp_pm_nl_check_work_pending(struct mptcp_sock *msk);
802 void mptcp_pm_subflow_check_next(struct mptcp_sock *msk, const struct sock *ssk,
803                                  const struct mptcp_subflow_context *subflow);
804 void mptcp_pm_add_addr_received(const struct sock *ssk,
805                                 const struct mptcp_addr_info *addr);
806 void mptcp_pm_add_addr_echoed(struct mptcp_sock *msk,
807                               const struct mptcp_addr_info *addr);
808 void mptcp_pm_add_addr_send_ack(struct mptcp_sock *msk);
809 void mptcp_pm_nl_addr_send_ack(struct mptcp_sock *msk);
810 void mptcp_pm_rm_addr_received(struct mptcp_sock *msk,
811                                const struct mptcp_rm_list *rm_list);
812 void mptcp_pm_mp_prio_received(struct sock *sk, u8 bkup);
813 void mptcp_pm_mp_fail_received(struct sock *sk, u64 fail_seq);
814 int mptcp_pm_nl_mp_prio_send_ack(struct mptcp_sock *msk,
815                                  struct mptcp_addr_info *addr,
816                                  struct mptcp_addr_info *rem,
817                                  u8 bkup);
818 bool mptcp_pm_alloc_anno_list(struct mptcp_sock *msk,
819                               const struct mptcp_addr_info *addr);
820 void mptcp_pm_free_anno_list(struct mptcp_sock *msk);
821 bool mptcp_pm_sport_in_anno_list(struct mptcp_sock *msk, const struct sock *sk);
822 struct mptcp_pm_add_entry *
823 mptcp_pm_del_add_timer(struct mptcp_sock *msk,
824                        const struct mptcp_addr_info *addr, bool check_id);
825 struct mptcp_pm_add_entry *
826 mptcp_lookup_anno_list_by_saddr(const struct mptcp_sock *msk,
827                                 const struct mptcp_addr_info *addr);
828 int mptcp_pm_get_flags_and_ifindex_by_id(struct mptcp_sock *msk,
829                                          unsigned int id,
830                                          u8 *flags, int *ifindex);
831 int mptcp_pm_nl_get_flags_and_ifindex_by_id(struct mptcp_sock *msk, unsigned int id,
832                                             u8 *flags, int *ifindex);
833 int mptcp_userspace_pm_get_flags_and_ifindex_by_id(struct mptcp_sock *msk,
834                                                    unsigned int id,
835                                                    u8 *flags, int *ifindex);
836 int mptcp_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_nl_set_flags(struct net *net, struct mptcp_pm_addr_entry *addr, u8 bkup);
840 int mptcp_userspace_pm_set_flags(struct net *net, struct nlattr *token,
841                                  struct mptcp_pm_addr_entry *loc,
842                                  struct mptcp_pm_addr_entry *rem, u8 bkup);
843 int mptcp_pm_announce_addr(struct mptcp_sock *msk,
844                            const struct mptcp_addr_info *addr,
845                            bool echo);
846 int mptcp_pm_remove_addr(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
847 int mptcp_pm_remove_subflow(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
848 void mptcp_pm_remove_addrs(struct mptcp_sock *msk, struct list_head *rm_list);
849 void mptcp_pm_remove_addrs_and_subflows(struct mptcp_sock *msk,
850                                         struct list_head *rm_list);
851
852 void mptcp_free_local_addr_list(struct mptcp_sock *msk);
853 int mptcp_nl_cmd_announce(struct sk_buff *skb, struct genl_info *info);
854 int mptcp_nl_cmd_remove(struct sk_buff *skb, struct genl_info *info);
855 int mptcp_nl_cmd_sf_create(struct sk_buff *skb, struct genl_info *info);
856 int mptcp_nl_cmd_sf_destroy(struct sk_buff *skb, struct genl_info *info);
857
858 void mptcp_event(enum mptcp_event_type type, const struct mptcp_sock *msk,
859                  const struct sock *ssk, gfp_t gfp);
860 void mptcp_event_addr_announced(const struct sock *ssk, const struct mptcp_addr_info *info);
861 void mptcp_event_addr_removed(const struct mptcp_sock *msk, u8 id);
862 void mptcp_event_pm_listener(const struct sock *ssk,
863                              enum mptcp_event_type event);
864 bool mptcp_userspace_pm_active(const struct mptcp_sock *msk);
865
866 void mptcp_fastopen_gen_msk_ackseq(struct mptcp_sock *msk, struct mptcp_subflow_context *subflow,
867                                    const struct mptcp_options_received *mp_opt);
868 void mptcp_fastopen_subflow_synack_set_params(struct mptcp_subflow_context *subflow,
869                                               struct request_sock *req);
870
871 static inline bool mptcp_pm_should_add_signal(struct mptcp_sock *msk)
872 {
873         return READ_ONCE(msk->pm.addr_signal) &
874                 (BIT(MPTCP_ADD_ADDR_SIGNAL) | BIT(MPTCP_ADD_ADDR_ECHO));
875 }
876
877 static inline bool mptcp_pm_should_add_signal_addr(struct mptcp_sock *msk)
878 {
879         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_SIGNAL);
880 }
881
882 static inline bool mptcp_pm_should_add_signal_echo(struct mptcp_sock *msk)
883 {
884         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_ECHO);
885 }
886
887 static inline bool mptcp_pm_should_rm_signal(struct mptcp_sock *msk)
888 {
889         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_RM_ADDR_SIGNAL);
890 }
891
892 static inline bool mptcp_pm_is_userspace(const struct mptcp_sock *msk)
893 {
894         return READ_ONCE(msk->pm.pm_type) == MPTCP_PM_TYPE_USERSPACE;
895 }
896
897 static inline bool mptcp_pm_is_kernel(const struct mptcp_sock *msk)
898 {
899         return READ_ONCE(msk->pm.pm_type) == MPTCP_PM_TYPE_KERNEL;
900 }
901
902 static inline unsigned int mptcp_add_addr_len(int family, bool echo, bool port)
903 {
904         u8 len = TCPOLEN_MPTCP_ADD_ADDR_BASE;
905
906         if (family == AF_INET6)
907                 len = TCPOLEN_MPTCP_ADD_ADDR6_BASE;
908         if (!echo)
909                 len += MPTCPOPT_THMAC_LEN;
910         /* account for 2 trailing 'nop' options */
911         if (port)
912                 len += TCPOLEN_MPTCP_PORT_LEN + TCPOLEN_MPTCP_PORT_ALIGN;
913
914         return len;
915 }
916
917 static inline int mptcp_rm_addr_len(const struct mptcp_rm_list *rm_list)
918 {
919         if (rm_list->nr == 0 || rm_list->nr > MPTCP_RM_IDS_MAX)
920                 return -EINVAL;
921
922         return TCPOLEN_MPTCP_RM_ADDR_BASE + roundup(rm_list->nr - 1, 4) + 1;
923 }
924
925 bool mptcp_pm_add_addr_signal(struct mptcp_sock *msk, const struct sk_buff *skb,
926                               unsigned int opt_size, unsigned int remaining,
927                               struct mptcp_addr_info *addr, bool *echo,
928                               bool *drop_other_suboptions);
929 bool mptcp_pm_rm_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
930                              struct mptcp_rm_list *rm_list);
931 int mptcp_pm_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
932 int mptcp_pm_nl_get_local_id(struct mptcp_sock *msk, struct mptcp_addr_info *skc);
933 int mptcp_userspace_pm_get_local_id(struct mptcp_sock *msk, struct mptcp_addr_info *skc);
934
935 void __init mptcp_pm_nl_init(void);
936 void mptcp_pm_nl_work(struct mptcp_sock *msk);
937 void mptcp_pm_nl_rm_subflow_received(struct mptcp_sock *msk,
938                                      const struct mptcp_rm_list *rm_list);
939 unsigned int mptcp_pm_get_add_addr_signal_max(const struct mptcp_sock *msk);
940 unsigned int mptcp_pm_get_add_addr_accept_max(const struct mptcp_sock *msk);
941 unsigned int mptcp_pm_get_subflows_max(const struct mptcp_sock *msk);
942 unsigned int mptcp_pm_get_local_addr_max(const struct mptcp_sock *msk);
943
944 /* called under PM lock */
945 static inline void __mptcp_pm_close_subflow(struct mptcp_sock *msk)
946 {
947         if (--msk->pm.subflows < mptcp_pm_get_subflows_max(msk))
948                 WRITE_ONCE(msk->pm.accept_subflow, true);
949 }
950
951 static inline void mptcp_pm_close_subflow(struct mptcp_sock *msk)
952 {
953         spin_lock_bh(&msk->pm.lock);
954         __mptcp_pm_close_subflow(msk);
955         spin_unlock_bh(&msk->pm.lock);
956 }
957
958 void mptcp_sockopt_sync(struct mptcp_sock *msk, struct sock *ssk);
959 void mptcp_sockopt_sync_locked(struct mptcp_sock *msk, struct sock *ssk);
960
961 static inline struct mptcp_ext *mptcp_get_ext(const struct sk_buff *skb)
962 {
963         return (struct mptcp_ext *)skb_ext_find(skb, SKB_EXT_MPTCP);
964 }
965
966 void mptcp_diag_subflow_init(struct tcp_ulp_ops *ops);
967
968 static inline bool __mptcp_check_fallback(const struct mptcp_sock *msk)
969 {
970         return test_bit(MPTCP_FALLBACK_DONE, &msk->flags);
971 }
972
973 static inline bool mptcp_check_fallback(const struct sock *sk)
974 {
975         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
976         struct mptcp_sock *msk = mptcp_sk(subflow->conn);
977
978         return __mptcp_check_fallback(msk);
979 }
980
981 static inline void __mptcp_do_fallback(struct mptcp_sock *msk)
982 {
983         if (test_bit(MPTCP_FALLBACK_DONE, &msk->flags)) {
984                 pr_debug("TCP fallback already done (msk=%p)", msk);
985                 return;
986         }
987         set_bit(MPTCP_FALLBACK_DONE, &msk->flags);
988 }
989
990 static inline void mptcp_do_fallback(struct sock *ssk)
991 {
992         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(ssk);
993         struct sock *sk = subflow->conn;
994         struct mptcp_sock *msk;
995
996         msk = mptcp_sk(sk);
997         __mptcp_do_fallback(msk);
998         if (READ_ONCE(msk->snd_data_fin_enable) && !(ssk->sk_shutdown & SEND_SHUTDOWN)) {
999                 gfp_t saved_allocation = ssk->sk_allocation;
1000
1001                 /* we are in a atomic (BH) scope, override ssk default for data
1002                  * fin allocation
1003                  */
1004                 ssk->sk_allocation = GFP_ATOMIC;
1005                 ssk->sk_shutdown |= SEND_SHUTDOWN;
1006                 tcp_shutdown(ssk, SEND_SHUTDOWN);
1007                 ssk->sk_allocation = saved_allocation;
1008         }
1009 }
1010
1011 #define pr_fallback(a) pr_debug("%s:fallback to TCP (msk=%p)", __func__, a)
1012
1013 static inline bool mptcp_check_infinite_map(struct sk_buff *skb)
1014 {
1015         struct mptcp_ext *mpext;
1016
1017         mpext = skb ? mptcp_get_ext(skb) : NULL;
1018         if (mpext && mpext->infinite_map)
1019                 return true;
1020
1021         return false;
1022 }
1023
1024 static inline bool is_active_ssk(struct mptcp_subflow_context *subflow)
1025 {
1026         return (subflow->request_mptcp || subflow->request_join);
1027 }
1028
1029 static inline bool subflow_simultaneous_connect(struct sock *sk)
1030 {
1031         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
1032
1033         return sk->sk_state == TCP_ESTABLISHED &&
1034                is_active_ssk(subflow) &&
1035                !subflow->conn_finished;
1036 }
1037
1038 #ifdef CONFIG_SYN_COOKIES
1039 void subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
1040                                        struct sk_buff *skb);
1041 bool mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
1042                                         struct sk_buff *skb);
1043 void __init mptcp_join_cookie_init(void);
1044 #else
1045 static inline void
1046 subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
1047                                   struct sk_buff *skb) {}
1048 static inline bool
1049 mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
1050                                    struct sk_buff *skb)
1051 {
1052         return false;
1053 }
1054
1055 static inline void mptcp_join_cookie_init(void) {}
1056 #endif
1057
1058 #endif /* __MPTCP_PROTOCOL_H */