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