~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/net/mptcp/protocol.h

Version: ~ [ linux-6.11.5 ] ~ [ linux-6.10.14 ] ~ [ linux-6.9.12 ] ~ [ linux-6.8.12 ] ~ [ linux-6.7.12 ] ~ [ linux-6.6.58 ] ~ [ linux-6.5.13 ] ~ [ linux-6.4.16 ] ~ [ linux-6.3.13 ] ~ [ linux-6.2.16 ] ~ [ linux-6.1.114 ] ~ [ linux-6.0.19 ] ~ [ linux-5.19.17 ] ~ [ linux-5.18.19 ] ~ [ linux-5.17.15 ] ~ [ linux-5.16.20 ] ~ [ linux-5.15.169 ] ~ [ linux-5.14.21 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.228 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.284 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.322 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.336 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.337 ] ~ [ linux-4.4.302 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.9 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  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 #include <net/rstreason.h>
 16 
 17 #define MPTCP_SUPPORTED_VERSION 1
 18 
 19 /* MPTCP option bits */
 20 #define OPTION_MPTCP_MPC_SYN    BIT(0)
 21 #define OPTION_MPTCP_MPC_SYNACK BIT(1)
 22 #define OPTION_MPTCP_MPC_ACK    BIT(2)
 23 #define OPTION_MPTCP_MPJ_SYN    BIT(3)
 24 #define OPTION_MPTCP_MPJ_SYNACK BIT(4)
 25 #define OPTION_MPTCP_MPJ_ACK    BIT(5)
 26 #define OPTION_MPTCP_ADD_ADDR   BIT(6)
 27 #define OPTION_MPTCP_RM_ADDR    BIT(7)
 28 #define OPTION_MPTCP_FASTCLOSE  BIT(8)
 29 #define OPTION_MPTCP_PRIO       BIT(9)
 30 #define OPTION_MPTCP_RST        BIT(10)
 31 #define OPTION_MPTCP_DSS        BIT(11)
 32 #define OPTION_MPTCP_FAIL       BIT(12)
 33 
 34 #define OPTION_MPTCP_CSUMREQD   BIT(13)
 35 
 36 #define OPTIONS_MPTCP_MPC       (OPTION_MPTCP_MPC_SYN | OPTION_MPTCP_MPC_SYNACK | \
 37                                  OPTION_MPTCP_MPC_ACK)
 38 #define OPTIONS_MPTCP_MPJ       (OPTION_MPTCP_MPJ_SYN | OPTION_MPTCP_MPJ_SYNACK | \
 39                                  OPTION_MPTCP_MPJ_ACK)
 40 
 41 /* MPTCP option subtypes */
 42 #define MPTCPOPT_MP_CAPABLE     0
 43 #define MPTCPOPT_MP_JOIN        1
 44 #define MPTCPOPT_DSS            2
 45 #define MPTCPOPT_ADD_ADDR       3
 46 #define MPTCPOPT_RM_ADDR        4
 47 #define MPTCPOPT_MP_PRIO        5
 48 #define MPTCPOPT_MP_FAIL        6
 49 #define MPTCPOPT_MP_FASTCLOSE   7
 50 #define MPTCPOPT_RST            8
 51 
 52 /* MPTCP suboption lengths */
 53 #define TCPOLEN_MPTCP_MPC_SYN           4
 54 #define TCPOLEN_MPTCP_MPC_SYNACK        12
 55 #define TCPOLEN_MPTCP_MPC_ACK           20
 56 #define TCPOLEN_MPTCP_MPC_ACK_DATA      22
 57 #define TCPOLEN_MPTCP_MPJ_SYN           12
 58 #define TCPOLEN_MPTCP_MPJ_SYNACK        16
 59 #define TCPOLEN_MPTCP_MPJ_ACK           24
 60 #define TCPOLEN_MPTCP_DSS_BASE          4
 61 #define TCPOLEN_MPTCP_DSS_ACK32         4
 62 #define TCPOLEN_MPTCP_DSS_ACK64         8
 63 #define TCPOLEN_MPTCP_DSS_MAP32         10
 64 #define TCPOLEN_MPTCP_DSS_MAP64         14
 65 #define TCPOLEN_MPTCP_DSS_CHECKSUM      2
 66 #define TCPOLEN_MPTCP_ADD_ADDR          16
 67 #define TCPOLEN_MPTCP_ADD_ADDR_PORT     18
 68 #define TCPOLEN_MPTCP_ADD_ADDR_BASE     8
 69 #define TCPOLEN_MPTCP_ADD_ADDR_BASE_PORT        10
 70 #define TCPOLEN_MPTCP_ADD_ADDR6         28
 71 #define TCPOLEN_MPTCP_ADD_ADDR6_PORT    30
 72 #define TCPOLEN_MPTCP_ADD_ADDR6_BASE    20
 73 #define TCPOLEN_MPTCP_ADD_ADDR6_BASE_PORT       22
 74 #define TCPOLEN_MPTCP_PORT_LEN          2
 75 #define TCPOLEN_MPTCP_PORT_ALIGN        2
 76 #define TCPOLEN_MPTCP_RM_ADDR_BASE      3
 77 #define TCPOLEN_MPTCP_PRIO              3
 78 #define TCPOLEN_MPTCP_PRIO_ALIGN        4
 79 #define TCPOLEN_MPTCP_FASTCLOSE         12
 80 #define TCPOLEN_MPTCP_RST               4
 81 #define TCPOLEN_MPTCP_FAIL              12
 82 
 83 #define TCPOLEN_MPTCP_MPC_ACK_DATA_CSUM (TCPOLEN_MPTCP_DSS_CHECKSUM + TCPOLEN_MPTCP_MPC_ACK_DATA)
 84 
 85 /* MPTCP MP_JOIN flags */
 86 #define MPTCPOPT_BACKUP         BIT(0)
 87 #define MPTCPOPT_THMAC_LEN      8
 88 
 89 /* MPTCP MP_CAPABLE flags */
 90 #define MPTCP_VERSION_MASK      (0x0F)
 91 #define MPTCP_CAP_CHECKSUM_REQD BIT(7)
 92 #define MPTCP_CAP_EXTENSIBILITY BIT(6)
 93 #define MPTCP_CAP_DENY_JOIN_ID0 BIT(5)
 94 #define MPTCP_CAP_HMAC_SHA256   BIT(0)
 95 #define MPTCP_CAP_FLAG_MASK     (0x1F)
 96 
 97 /* MPTCP DSS flags */
 98 #define MPTCP_DSS_DATA_FIN      BIT(4)
 99 #define MPTCP_DSS_DSN64         BIT(3)
100 #define MPTCP_DSS_HAS_MAP       BIT(2)
101 #define MPTCP_DSS_ACK64         BIT(1)
102 #define MPTCP_DSS_HAS_ACK       BIT(0)
103 #define MPTCP_DSS_FLAG_MASK     (0x1F)
104 
105 /* MPTCP ADD_ADDR flags */
106 #define MPTCP_ADDR_ECHO         BIT(0)
107 
108 /* MPTCP MP_PRIO flags */
109 #define MPTCP_PRIO_BKUP         BIT(0)
110 
111 /* MPTCP TCPRST flags */
112 #define MPTCP_RST_TRANSIENT     BIT(0)
113 
114 /* MPTCP socket atomic flags */
115 #define MPTCP_WORK_RTX          1
116 #define MPTCP_FALLBACK_DONE     2
117 #define MPTCP_WORK_CLOSE_SUBFLOW 3
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_SYNC_STATE        6
126 #define MPTCP_SYNC_SNDBUF       7
127 
128 struct mptcp_skb_cb {
129         u64 map_seq;
130         u64 end_seq;
131         u32 offset;
132         u8  has_rxtstamp:1;
133 };
134 
135 #define MPTCP_SKB_CB(__skb)     ((struct mptcp_skb_cb *)&((__skb)->cb[0]))
136 
137 static inline bool before64(__u64 seq1, __u64 seq2)
138 {
139         return (__s64)(seq1 - seq2) < 0;
140 }
141 
142 #define after64(seq2, seq1)     before64(seq1, seq2)
143 
144 struct mptcp_options_received {
145         u64     sndr_key;
146         u64     rcvr_key;
147         u64     data_ack;
148         u64     data_seq;
149         u32     subflow_seq;
150         u16     data_len;
151         __sum16 csum;
152         u16     suboptions;
153         u32     token;
154         u32     nonce;
155         u16     use_map:1,
156                 dsn64:1,
157                 data_fin:1,
158                 use_ack:1,
159                 ack64:1,
160                 mpc_map:1,
161                 reset_reason:4,
162                 reset_transient:1,
163                 echo:1,
164                 backup:1,
165                 deny_join_id0:1,
166                 __unused:2;
167         u8      join_id;
168         u64     thmac;
169         u8      hmac[MPTCPOPT_HMAC_LEN];
170         struct mptcp_addr_info addr;
171         struct mptcp_rm_list rm_list;
172         u64     ahmac;
173         u64     fail_seq;
174 };
175 
176 static inline __be32 mptcp_option(u8 subopt, u8 len, u8 nib, u8 field)
177 {
178         return htonl((TCPOPT_MPTCP << 24) | (len << 16) | (subopt << 12) |
179                      ((nib & 0xF) << 8) | field);
180 }
181 
182 enum mptcp_pm_status {
183         MPTCP_PM_ADD_ADDR_RECEIVED,
184         MPTCP_PM_ADD_ADDR_SEND_ACK,
185         MPTCP_PM_RM_ADDR_RECEIVED,
186         MPTCP_PM_ESTABLISHED,
187         MPTCP_PM_SUBFLOW_ESTABLISHED,
188         MPTCP_PM_ALREADY_ESTABLISHED,   /* persistent status, set after ESTABLISHED event */
189         MPTCP_PM_MPC_ENDPOINT_ACCOUNTED /* persistent status, set after MPC local address is
190                                          * accounted int id_avail_bitmap
191                                          */
192 };
193 
194 enum mptcp_pm_type {
195         MPTCP_PM_TYPE_KERNEL = 0,
196         MPTCP_PM_TYPE_USERSPACE,
197 
198         __MPTCP_PM_TYPE_NR,
199         __MPTCP_PM_TYPE_MAX = __MPTCP_PM_TYPE_NR - 1,
200 };
201 
202 /* Status bits below MPTCP_PM_ALREADY_ESTABLISHED need pm worker actions */
203 #define MPTCP_PM_WORK_MASK ((1 << MPTCP_PM_ALREADY_ESTABLISHED) - 1)
204 
205 enum mptcp_addr_signal_status {
206         MPTCP_ADD_ADDR_SIGNAL,
207         MPTCP_ADD_ADDR_ECHO,
208         MPTCP_RM_ADDR_SIGNAL,
209 };
210 
211 /* max value of mptcp_addr_info.id */
212 #define MPTCP_PM_MAX_ADDR_ID            U8_MAX
213 
214 struct mptcp_pm_data {
215         struct mptcp_addr_info local;
216         struct mptcp_addr_info remote;
217         struct list_head anno_list;
218         struct list_head userspace_pm_local_addr_list;
219 
220         spinlock_t      lock;           /*protects the whole PM data */
221 
222         u8              addr_signal;
223         bool            server_side;
224         bool            work_pending;
225         bool            accept_addr;
226         bool            accept_subflow;
227         bool            remote_deny_join_id0;
228         u8              add_addr_signaled;
229         u8              add_addr_accepted;
230         u8              local_addr_used;
231         u8              pm_type;
232         u8              subflows;
233         u8              status;
234         DECLARE_BITMAP(id_avail_bitmap, MPTCP_PM_MAX_ADDR_ID + 1);
235         struct mptcp_rm_list rm_list_tx;
236         struct mptcp_rm_list rm_list_rx;
237 };
238 
239 struct mptcp_pm_addr_entry {
240         struct list_head        list;
241         struct mptcp_addr_info  addr;
242         u8                      flags;
243         int                     ifindex;
244         struct socket           *lsk;
245 };
246 
247 struct mptcp_data_frag {
248         struct list_head list;
249         u64 data_seq;
250         u16 data_len;
251         u16 offset;
252         u16 overhead;
253         u16 already_sent;
254         struct page *page;
255 };
256 
257 /* MPTCP connection sock */
258 struct mptcp_sock {
259         /* inet_connection_sock must be the first member */
260         struct inet_connection_sock sk;
261         u64             local_key;              /* protected by the first subflow socket lock
262                                                  * lockless access read
263                                                  */
264         u64             remote_key;             /* same as above */
265         u64             write_seq;
266         u64             bytes_sent;
267         u64             snd_nxt;
268         u64             bytes_received;
269         u64             ack_seq;
270         atomic64_t      rcv_wnd_sent;
271         u64             rcv_data_fin_seq;
272         u64             bytes_retrans;
273         u64             bytes_consumed;
274         int             rmem_fwd_alloc;
275         int             snd_burst;
276         int             old_wspace;
277         u64             recovery_snd_nxt;       /* in recovery mode accept up to this seq;
278                                                  * recovery related fields are under data_lock
279                                                  * protection
280                                                  */
281         u64             bytes_acked;
282         u64             snd_una;
283         u64             wnd_end;
284         u32             last_data_sent;
285         u32             last_data_recv;
286         u32             last_ack_recv;
287         unsigned long   timer_ival;
288         u32             token;
289         int             rmem_released;
290         unsigned long   flags;
291         unsigned long   cb_flags;
292         bool            recovery;               /* closing subflow write queue reinjected */
293         bool            can_ack;
294         bool            fully_established;
295         bool            rcv_data_fin;
296         bool            snd_data_fin_enable;
297         bool            rcv_fastclose;
298         bool            use_64bit_ack; /* Set when we received a 64-bit DSN */
299         bool            csum_enabled;
300         bool            allow_infinite_fallback;
301         u8              pending_state; /* A subflow asked to set this sk_state,
302                                         * protected by the msk data lock
303                                         */
304         u8              mpc_endpoint_id;
305         u8              recvmsg_inq:1,
306                         cork:1,
307                         nodelay:1,
308                         fastopening:1,
309                         in_accept_queue:1,
310                         free_first:1,
311                         rcvspace_init:1;
312         u32             notsent_lowat;
313         int             keepalive_cnt;
314         int             keepalive_idle;
315         int             keepalive_intvl;
316         struct work_struct work;
317         struct sk_buff  *ooo_last_skb;
318         struct rb_root  out_of_order_queue;
319         struct sk_buff_head receive_queue;
320         struct list_head conn_list;
321         struct list_head rtx_queue;
322         struct mptcp_data_frag *first_pending;
323         struct list_head join_list;
324         struct sock     *first; /* The mptcp ops can safely dereference, using suitable
325                                  * ONCE annotation, the subflow outside the socket
326                                  * lock as such sock is freed after close().
327                                  */
328         struct mptcp_pm_data    pm;
329         struct mptcp_sched_ops  *sched;
330         struct {
331                 u32     space;  /* bytes copied in last measurement window */
332                 u32     copied; /* bytes copied in this measurement window */
333                 u64     time;   /* start time of measurement window */
334                 u64     rtt_us; /* last maximum rtt of subflows */
335         } rcvq_space;
336         u8              scaling_ratio;
337 
338         u32             subflow_id;
339         u32             setsockopt_seq;
340         char            ca_name[TCP_CA_NAME_MAX];
341 };
342 
343 #define mptcp_data_lock(sk) spin_lock_bh(&(sk)->sk_lock.slock)
344 #define mptcp_data_unlock(sk) spin_unlock_bh(&(sk)->sk_lock.slock)
345 
346 #define mptcp_for_each_subflow(__msk, __subflow)                        \
347         list_for_each_entry(__subflow, &((__msk)->conn_list), node)
348 #define mptcp_for_each_subflow_safe(__msk, __subflow, __tmp)                    \
349         list_for_each_entry_safe(__subflow, __tmp, &((__msk)->conn_list), node)
350 
351 extern struct genl_family mptcp_genl_family;
352 
353 static inline void msk_owned_by_me(const struct mptcp_sock *msk)
354 {
355         sock_owned_by_me((const struct sock *)msk);
356 }
357 
358 #ifdef CONFIG_DEBUG_NET
359 /* MPTCP-specific: we might (indirectly) call this helper with the wrong sk */
360 #undef tcp_sk
361 #define tcp_sk(ptr) ({                                                          \
362         typeof(ptr) _ptr = (ptr);                                               \
363         WARN_ON(_ptr->sk_protocol != IPPROTO_TCP);                              \
364         container_of_const(_ptr, struct tcp_sock, inet_conn.icsk_inet.sk);      \
365 })
366 #define mptcp_sk(ptr) ({                                                \
367         typeof(ptr) _ptr = (ptr);                                       \
368         WARN_ON(_ptr->sk_protocol != IPPROTO_MPTCP);                    \
369         container_of_const(_ptr, struct mptcp_sock, sk.icsk_inet.sk);   \
370 })
371 
372 #else /* !CONFIG_DEBUG_NET */
373 #define mptcp_sk(ptr) container_of_const(ptr, struct mptcp_sock, sk.icsk_inet.sk)
374 #endif
375 
376 /* the msk socket don't use the backlog, also account for the bulk
377  * free memory
378  */
379 static inline int __mptcp_rmem(const struct sock *sk)
380 {
381         return atomic_read(&sk->sk_rmem_alloc) - READ_ONCE(mptcp_sk(sk)->rmem_released);
382 }
383 
384 static inline int mptcp_win_from_space(const struct sock *sk, int space)
385 {
386         return __tcp_win_from_space(mptcp_sk(sk)->scaling_ratio, space);
387 }
388 
389 static inline int mptcp_space_from_win(const struct sock *sk, int win)
390 {
391         return __tcp_space_from_win(mptcp_sk(sk)->scaling_ratio, win);
392 }
393 
394 static inline int __mptcp_space(const struct sock *sk)
395 {
396         return mptcp_win_from_space(sk, READ_ONCE(sk->sk_rcvbuf) - __mptcp_rmem(sk));
397 }
398 
399 static inline struct mptcp_data_frag *mptcp_send_head(const struct sock *sk)
400 {
401         const struct mptcp_sock *msk = mptcp_sk(sk);
402 
403         return READ_ONCE(msk->first_pending);
404 }
405 
406 static inline struct mptcp_data_frag *mptcp_send_next(struct sock *sk)
407 {
408         struct mptcp_sock *msk = mptcp_sk(sk);
409         struct mptcp_data_frag *cur;
410 
411         cur = msk->first_pending;
412         return list_is_last(&cur->list, &msk->rtx_queue) ? NULL :
413                                                      list_next_entry(cur, list);
414 }
415 
416 static inline struct mptcp_data_frag *mptcp_pending_tail(const struct sock *sk)
417 {
418         const struct mptcp_sock *msk = mptcp_sk(sk);
419 
420         if (!msk->first_pending)
421                 return NULL;
422 
423         if (WARN_ON_ONCE(list_empty(&msk->rtx_queue)))
424                 return NULL;
425 
426         return list_last_entry(&msk->rtx_queue, struct mptcp_data_frag, list);
427 }
428 
429 static inline struct mptcp_data_frag *mptcp_rtx_head(struct sock *sk)
430 {
431         struct mptcp_sock *msk = mptcp_sk(sk);
432 
433         if (msk->snd_una == msk->snd_nxt)
434                 return NULL;
435 
436         return list_first_entry_or_null(&msk->rtx_queue, struct mptcp_data_frag, list);
437 }
438 
439 struct csum_pseudo_header {
440         __be64 data_seq;
441         __be32 subflow_seq;
442         __be16 data_len;
443         __sum16 csum;
444 };
445 
446 struct mptcp_subflow_request_sock {
447         struct  tcp_request_sock sk;
448         u16     mp_capable : 1,
449                 mp_join : 1,
450                 backup : 1,
451                 request_bkup : 1,
452                 csum_reqd : 1,
453                 allow_join_id0 : 1;
454         u8      local_id;
455         u8      remote_id;
456         u64     local_key;
457         u64     idsn;
458         u32     token;
459         u32     ssn_offset;
460         u64     thmac;
461         u32     local_nonce;
462         u32     remote_nonce;
463         struct mptcp_sock       *msk;
464         struct hlist_nulls_node token_node;
465 };
466 
467 static inline struct mptcp_subflow_request_sock *
468 mptcp_subflow_rsk(const struct request_sock *rsk)
469 {
470         return (struct mptcp_subflow_request_sock *)rsk;
471 }
472 
473 struct mptcp_delegated_action {
474         struct napi_struct napi;
475         struct list_head head;
476 };
477 
478 DECLARE_PER_CPU(struct mptcp_delegated_action, mptcp_delegated_actions);
479 
480 #define MPTCP_DELEGATE_SCHEDULED        0
481 #define MPTCP_DELEGATE_SEND             1
482 #define MPTCP_DELEGATE_ACK              2
483 #define MPTCP_DELEGATE_SNDBUF           3
484 
485 #define MPTCP_DELEGATE_ACTIONS_MASK     (~BIT(MPTCP_DELEGATE_SCHEDULED))
486 /* MPTCP subflow context */
487 struct mptcp_subflow_context {
488         struct  list_head node;/* conn_list of subflows */
489 
490         struct_group(reset,
491 
492         unsigned long avg_pacing_rate; /* protected by msk socket lock */
493         u64     local_key;
494         u64     remote_key;
495         u64     idsn;
496         u64     map_seq;
497         u32     snd_isn;
498         u32     token;
499         u32     rel_write_seq;
500         u32     map_subflow_seq;
501         u32     ssn_offset;
502         u32     map_data_len;
503         __wsum  map_data_csum;
504         u32     map_csum_len;
505         u32     request_mptcp : 1,  /* send MP_CAPABLE */
506                 request_join : 1,   /* send MP_JOIN */
507                 request_bkup : 1,
508                 mp_capable : 1,     /* remote is MPTCP capable */
509                 mp_join : 1,        /* remote is JOINing */
510                 fully_established : 1,      /* path validated */
511                 pm_notified : 1,    /* PM hook called for established status */
512                 conn_finished : 1,
513                 map_valid : 1,
514                 map_csum_reqd : 1,
515                 map_data_fin : 1,
516                 mpc_map : 1,
517                 backup : 1,
518                 send_mp_prio : 1,
519                 send_mp_fail : 1,
520                 send_fastclose : 1,
521                 send_infinite_map : 1,
522                 remote_key_valid : 1,        /* received the peer key from */
523                 disposable : 1,     /* ctx can be free at ulp release time */
524                 stale : 1,          /* unable to snd/rcv data, do not use for xmit */
525                 valid_csum_seen : 1,        /* at least one csum validated */
526                 is_mptfo : 1,       /* subflow is doing TFO */
527                 close_event_done : 1,       /* has done the post-closed part */
528                 __unused : 9;
529         bool    data_avail;
530         bool    scheduled;
531         bool    pm_listener;        /* a listener managed by the kernel PM? */
532         u32     remote_nonce;
533         u64     thmac;
534         u32     local_nonce;
535         u32     remote_token;
536         union {
537                 u8      hmac[MPTCPOPT_HMAC_LEN]; /* MPJ subflow only */
538                 u64     iasn;       /* initial ack sequence number, MPC subflows only */
539         };
540         s16     local_id;           /* if negative not initialized yet */
541         u8      remote_id;
542         u8      reset_seen:1;
543         u8      reset_transient:1;
544         u8      reset_reason:4;
545         u8      stale_count;
546 
547         u32     subflow_id;
548 
549         long    delegated_status;
550         unsigned long   fail_tout;
551 
552         );
553 
554         struct  list_head delegated_node;   /* link into delegated_action, protected by local BH */
555 
556         u32     setsockopt_seq;
557         u32     stale_rcv_tstamp;
558         int     cached_sndbuf;      /* sndbuf size when last synced with the msk sndbuf,
559                                      * protected by the msk socket lock
560                                      */
561 
562         struct  sock *tcp_sock;     /* tcp sk backpointer */
563         struct  sock *conn;         /* parent mptcp_sock */
564         const   struct inet_connection_sock_af_ops *icsk_af_ops;
565         void    (*tcp_state_change)(struct sock *sk);
566         void    (*tcp_error_report)(struct sock *sk);
567 
568         struct  rcu_head rcu;
569 };
570 
571 static inline struct mptcp_subflow_context *
572 mptcp_subflow_ctx(const struct sock *sk)
573 {
574         const struct inet_connection_sock *icsk = inet_csk(sk);
575 
576         /* Use RCU on icsk_ulp_data only for sock diag code */
577         return (__force struct mptcp_subflow_context *)icsk->icsk_ulp_data;
578 }
579 
580 static inline struct sock *
581 mptcp_subflow_tcp_sock(const struct mptcp_subflow_context *subflow)
582 {
583         return subflow->tcp_sock;
584 }
585 
586 static inline void
587 mptcp_subflow_ctx_reset(struct mptcp_subflow_context *subflow)
588 {
589         memset(&subflow->reset, 0, sizeof(subflow->reset));
590         subflow->request_mptcp = 1;
591         WRITE_ONCE(subflow->local_id, -1);
592 }
593 
594 /* Convert reset reasons in MPTCP to enum sk_rst_reason type */
595 static inline enum sk_rst_reason
596 sk_rst_convert_mptcp_reason(u32 reason)
597 {
598         switch (reason) {
599         case MPTCP_RST_EUNSPEC:
600                 return SK_RST_REASON_MPTCP_RST_EUNSPEC;
601         case MPTCP_RST_EMPTCP:
602                 return SK_RST_REASON_MPTCP_RST_EMPTCP;
603         case MPTCP_RST_ERESOURCE:
604                 return SK_RST_REASON_MPTCP_RST_ERESOURCE;
605         case MPTCP_RST_EPROHIBIT:
606                 return SK_RST_REASON_MPTCP_RST_EPROHIBIT;
607         case MPTCP_RST_EWQ2BIG:
608                 return SK_RST_REASON_MPTCP_RST_EWQ2BIG;
609         case MPTCP_RST_EBADPERF:
610                 return SK_RST_REASON_MPTCP_RST_EBADPERF;
611         case MPTCP_RST_EMIDDLEBOX:
612                 return SK_RST_REASON_MPTCP_RST_EMIDDLEBOX;
613         default:
614                 /* It should not happen, or else errors may occur
615                  * in MPTCP layer
616                  */
617                 return SK_RST_REASON_ERROR;
618         }
619 }
620 
621 static inline void
622 mptcp_send_active_reset_reason(struct sock *sk)
623 {
624         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
625         enum sk_rst_reason reason;
626 
627         reason = sk_rst_convert_mptcp_reason(subflow->reset_reason);
628         tcp_send_active_reset(sk, GFP_ATOMIC, reason);
629 }
630 
631 static inline u64
632 mptcp_subflow_get_map_offset(const struct mptcp_subflow_context *subflow)
633 {
634         return tcp_sk(mptcp_subflow_tcp_sock(subflow))->copied_seq -
635                       subflow->ssn_offset -
636                       subflow->map_subflow_seq;
637 }
638 
639 static inline u64
640 mptcp_subflow_get_mapped_dsn(const struct mptcp_subflow_context *subflow)
641 {
642         return subflow->map_seq + mptcp_subflow_get_map_offset(subflow);
643 }
644 
645 void mptcp_subflow_process_delegated(struct sock *ssk, long actions);
646 
647 static inline void mptcp_subflow_delegate(struct mptcp_subflow_context *subflow, int action)
648 {
649         long old, set_bits = BIT(MPTCP_DELEGATE_SCHEDULED) | BIT(action);
650         struct mptcp_delegated_action *delegated;
651         bool schedule;
652 
653         /* the caller held the subflow bh socket lock */
654         lockdep_assert_in_softirq();
655 
656         /* The implied barrier pairs with tcp_release_cb_override()
657          * mptcp_napi_poll(), and ensures the below list check sees list
658          * updates done prior to delegated status bits changes
659          */
660         old = set_mask_bits(&subflow->delegated_status, 0, set_bits);
661         if (!(old & BIT(MPTCP_DELEGATE_SCHEDULED))) {
662                 if (WARN_ON_ONCE(!list_empty(&subflow->delegated_node)))
663                         return;
664 
665                 delegated = this_cpu_ptr(&mptcp_delegated_actions);
666                 schedule = list_empty(&delegated->head);
667                 list_add_tail(&subflow->delegated_node, &delegated->head);
668                 sock_hold(mptcp_subflow_tcp_sock(subflow));
669                 if (schedule)
670                         napi_schedule(&delegated->napi);
671         }
672 }
673 
674 static inline struct mptcp_subflow_context *
675 mptcp_subflow_delegated_next(struct mptcp_delegated_action *delegated)
676 {
677         struct mptcp_subflow_context *ret;
678 
679         if (list_empty(&delegated->head))
680                 return NULL;
681 
682         ret = list_first_entry(&delegated->head, struct mptcp_subflow_context, delegated_node);
683         list_del_init(&ret->delegated_node);
684         return ret;
685 }
686 
687 int mptcp_is_enabled(const struct net *net);
688 unsigned int mptcp_get_add_addr_timeout(const struct net *net);
689 int mptcp_is_checksum_enabled(const struct net *net);
690 int mptcp_allow_join_id0(const struct net *net);
691 unsigned int mptcp_stale_loss_cnt(const struct net *net);
692 unsigned int mptcp_close_timeout(const struct sock *sk);
693 int mptcp_get_pm_type(const struct net *net);
694 const char *mptcp_get_scheduler(const struct net *net);
695 void mptcp_get_available_schedulers(char *buf, size_t maxlen);
696 void __mptcp_subflow_fully_established(struct mptcp_sock *msk,
697                                        struct mptcp_subflow_context *subflow,
698                                        const struct mptcp_options_received *mp_opt);
699 bool __mptcp_retransmit_pending_data(struct sock *sk);
700 void mptcp_check_and_set_pending(struct sock *sk);
701 void __mptcp_push_pending(struct sock *sk, unsigned int flags);
702 bool mptcp_subflow_data_available(struct sock *sk);
703 void __init mptcp_subflow_init(void);
704 void mptcp_subflow_shutdown(struct sock *sk, struct sock *ssk, int how);
705 void mptcp_close_ssk(struct sock *sk, struct sock *ssk,
706                      struct mptcp_subflow_context *subflow);
707 void __mptcp_subflow_send_ack(struct sock *ssk);
708 void mptcp_subflow_reset(struct sock *ssk);
709 void mptcp_subflow_queue_clean(struct sock *sk, struct sock *ssk);
710 void mptcp_sock_graft(struct sock *sk, struct socket *parent);
711 struct sock *__mptcp_nmpc_sk(struct mptcp_sock *msk);
712 bool __mptcp_close(struct sock *sk, long timeout);
713 void mptcp_cancel_work(struct sock *sk);
714 void __mptcp_unaccepted_force_close(struct sock *sk);
715 void mptcp_set_owner_r(struct sk_buff *skb, struct sock *sk);
716 void mptcp_set_state(struct sock *sk, int state);
717 
718 bool mptcp_addresses_equal(const struct mptcp_addr_info *a,
719                            const struct mptcp_addr_info *b, bool use_port);
720 void mptcp_local_address(const struct sock_common *skc, struct mptcp_addr_info *addr);
721 
722 /* called with sk socket lock held */
723 int __mptcp_subflow_connect(struct sock *sk, const struct mptcp_addr_info *loc,
724                             const struct mptcp_addr_info *remote);
725 int mptcp_subflow_create_socket(struct sock *sk, unsigned short family,
726                                 struct socket **new_sock);
727 void mptcp_info2sockaddr(const struct mptcp_addr_info *info,
728                          struct sockaddr_storage *addr,
729                          unsigned short family);
730 struct mptcp_sched_ops *mptcp_sched_find(const char *name);
731 int mptcp_register_scheduler(struct mptcp_sched_ops *sched);
732 void mptcp_unregister_scheduler(struct mptcp_sched_ops *sched);
733 void mptcp_sched_init(void);
734 int mptcp_init_sched(struct mptcp_sock *msk,
735                      struct mptcp_sched_ops *sched);
736 void mptcp_release_sched(struct mptcp_sock *msk);
737 void mptcp_subflow_set_scheduled(struct mptcp_subflow_context *subflow,
738                                  bool scheduled);
739 struct sock *mptcp_subflow_get_send(struct mptcp_sock *msk);
740 struct sock *mptcp_subflow_get_retrans(struct mptcp_sock *msk);
741 int mptcp_sched_get_send(struct mptcp_sock *msk);
742 int mptcp_sched_get_retrans(struct mptcp_sock *msk);
743 
744 static inline u64 mptcp_data_avail(const struct mptcp_sock *msk)
745 {
746         return READ_ONCE(msk->bytes_received) - READ_ONCE(msk->bytes_consumed);
747 }
748 
749 static inline bool mptcp_epollin_ready(const struct sock *sk)
750 {
751         /* mptcp doesn't have to deal with small skbs in the receive queue,
752          * at it can always coalesce them
753          */
754         return (mptcp_data_avail(mptcp_sk(sk)) >= sk->sk_rcvlowat) ||
755                (mem_cgroup_sockets_enabled && sk->sk_memcg &&
756                 mem_cgroup_under_socket_pressure(sk->sk_memcg)) ||
757                READ_ONCE(tcp_memory_pressure);
758 }
759 
760 int mptcp_set_rcvlowat(struct sock *sk, int val);
761 
762 static inline bool __tcp_can_send(const struct sock *ssk)
763 {
764         /* only send if our side has not closed yet */
765         return ((1 << inet_sk_state_load(ssk)) & (TCPF_ESTABLISHED | TCPF_CLOSE_WAIT));
766 }
767 
768 static inline bool __mptcp_subflow_active(struct mptcp_subflow_context *subflow)
769 {
770         /* can't send if JOIN hasn't completed yet (i.e. is usable for mptcp) */
771         if (subflow->request_join && !subflow->fully_established)
772                 return false;
773 
774         return __tcp_can_send(mptcp_subflow_tcp_sock(subflow));
775 }
776 
777 void mptcp_subflow_set_active(struct mptcp_subflow_context *subflow);
778 
779 bool mptcp_subflow_active(struct mptcp_subflow_context *subflow);
780 
781 void mptcp_subflow_drop_ctx(struct sock *ssk);
782 
783 static inline void mptcp_subflow_tcp_fallback(struct sock *sk,
784                                               struct mptcp_subflow_context *ctx)
785 {
786         sk->sk_data_ready = sock_def_readable;
787         sk->sk_state_change = ctx->tcp_state_change;
788         sk->sk_write_space = sk_stream_write_space;
789         sk->sk_error_report = ctx->tcp_error_report;
790 
791         inet_csk(sk)->icsk_af_ops = ctx->icsk_af_ops;
792 }
793 
794 void __init mptcp_proto_init(void);
795 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
796 int __init mptcp_proto_v6_init(void);
797 #endif
798 
799 struct sock *mptcp_sk_clone_init(const struct sock *sk,
800                                  const struct mptcp_options_received *mp_opt,
801                                  struct sock *ssk,
802                                  struct request_sock *req);
803 void mptcp_get_options(const struct sk_buff *skb,
804                        struct mptcp_options_received *mp_opt);
805 
806 void mptcp_finish_connect(struct sock *sk);
807 void __mptcp_sync_state(struct sock *sk, int state);
808 void mptcp_reset_tout_timer(struct mptcp_sock *msk, unsigned long fail_tout);
809 
810 static inline void mptcp_stop_tout_timer(struct sock *sk)
811 {
812         if (!inet_csk(sk)->icsk_mtup.probe_timestamp)
813                 return;
814 
815         sk_stop_timer(sk, &sk->sk_timer);
816         inet_csk(sk)->icsk_mtup.probe_timestamp = 0;
817 }
818 
819 static inline void mptcp_set_close_tout(struct sock *sk, unsigned long tout)
820 {
821         /* avoid 0 timestamp, as that means no close timeout */
822         inet_csk(sk)->icsk_mtup.probe_timestamp = tout ? : 1;
823 }
824 
825 static inline void mptcp_start_tout_timer(struct sock *sk)
826 {
827         mptcp_set_close_tout(sk, tcp_jiffies32);
828         mptcp_reset_tout_timer(mptcp_sk(sk), 0);
829 }
830 
831 static inline bool mptcp_is_fully_established(struct sock *sk)
832 {
833         return inet_sk_state_load(sk) == TCP_ESTABLISHED &&
834                READ_ONCE(mptcp_sk(sk)->fully_established);
835 }
836 
837 void mptcp_rcv_space_init(struct mptcp_sock *msk, const struct sock *ssk);
838 void mptcp_data_ready(struct sock *sk, struct sock *ssk);
839 bool mptcp_finish_join(struct sock *sk);
840 bool mptcp_schedule_work(struct sock *sk);
841 int mptcp_setsockopt(struct sock *sk, int level, int optname,
842                      sockptr_t optval, unsigned int optlen);
843 int mptcp_getsockopt(struct sock *sk, int level, int optname,
844                      char __user *optval, int __user *option);
845 
846 u64 __mptcp_expand_seq(u64 old_seq, u64 cur_seq);
847 static inline u64 mptcp_expand_seq(u64 old_seq, u64 cur_seq, bool use_64bit)
848 {
849         if (use_64bit)
850                 return cur_seq;
851 
852         return __mptcp_expand_seq(old_seq, cur_seq);
853 }
854 void __mptcp_check_push(struct sock *sk, struct sock *ssk);
855 void __mptcp_data_acked(struct sock *sk);
856 void __mptcp_error_report(struct sock *sk);
857 bool mptcp_update_rcv_data_fin(struct mptcp_sock *msk, u64 data_fin_seq, bool use_64bit);
858 static inline bool mptcp_data_fin_enabled(const struct mptcp_sock *msk)
859 {
860         return READ_ONCE(msk->snd_data_fin_enable) &&
861                READ_ONCE(msk->write_seq) == READ_ONCE(msk->snd_nxt);
862 }
863 
864 static inline u32 mptcp_notsent_lowat(const struct sock *sk)
865 {
866         struct net *net = sock_net(sk);
867         u32 val;
868 
869         val = READ_ONCE(mptcp_sk(sk)->notsent_lowat);
870         return val ?: READ_ONCE(net->ipv4.sysctl_tcp_notsent_lowat);
871 }
872 
873 static inline bool mptcp_stream_memory_free(const struct sock *sk, int wake)
874 {
875         const struct mptcp_sock *msk = mptcp_sk(sk);
876         u32 notsent_bytes;
877 
878         notsent_bytes = READ_ONCE(msk->write_seq) - READ_ONCE(msk->snd_nxt);
879         return (notsent_bytes << wake) < mptcp_notsent_lowat(sk);
880 }
881 
882 static inline bool __mptcp_stream_is_writeable(const struct sock *sk, int wake)
883 {
884         return mptcp_stream_memory_free(sk, wake) &&
885                __sk_stream_is_writeable(sk, wake);
886 }
887 
888 static inline void mptcp_write_space(struct sock *sk)
889 {
890         /* pairs with memory barrier in mptcp_poll */
891         smp_mb();
892         if (mptcp_stream_memory_free(sk, 1))
893                 sk_stream_write_space(sk);
894 }
895 
896 static inline void __mptcp_sync_sndbuf(struct sock *sk)
897 {
898         struct mptcp_subflow_context *subflow;
899         int ssk_sndbuf, new_sndbuf;
900 
901         if (sk->sk_userlocks & SOCK_SNDBUF_LOCK)
902                 return;
903 
904         new_sndbuf = READ_ONCE(sock_net(sk)->ipv4.sysctl_tcp_wmem[0]);
905         mptcp_for_each_subflow(mptcp_sk(sk), subflow) {
906                 ssk_sndbuf =  READ_ONCE(mptcp_subflow_tcp_sock(subflow)->sk_sndbuf);
907 
908                 subflow->cached_sndbuf = ssk_sndbuf;
909                 new_sndbuf += ssk_sndbuf;
910         }
911 
912         /* the msk max wmem limit is <nr_subflows> * tcp wmem[2] */
913         WRITE_ONCE(sk->sk_sndbuf, new_sndbuf);
914         mptcp_write_space(sk);
915 }
916 
917 /* The called held both the msk socket and the subflow socket locks,
918  * possibly under BH
919  */
920 static inline void __mptcp_propagate_sndbuf(struct sock *sk, struct sock *ssk)
921 {
922         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(ssk);
923 
924         if (READ_ONCE(ssk->sk_sndbuf) != subflow->cached_sndbuf)
925                 __mptcp_sync_sndbuf(sk);
926 }
927 
928 /* the caller held only the subflow socket lock, either in process or
929  * BH context. Additionally this can be called under the msk data lock,
930  * so we can't acquire such lock here: let the delegate action acquires
931  * the needed locks in suitable order.
932  */
933 static inline void mptcp_propagate_sndbuf(struct sock *sk, struct sock *ssk)
934 {
935         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(ssk);
936 
937         if (likely(READ_ONCE(ssk->sk_sndbuf) == subflow->cached_sndbuf))
938                 return;
939 
940         local_bh_disable();
941         mptcp_subflow_delegate(subflow, MPTCP_DELEGATE_SNDBUF);
942         local_bh_enable();
943 }
944 
945 void mptcp_destroy_common(struct mptcp_sock *msk, unsigned int flags);
946 
947 #define MPTCP_TOKEN_MAX_RETRIES 4
948 
949 void __init mptcp_token_init(void);
950 static inline void mptcp_token_init_request(struct request_sock *req)
951 {
952         mptcp_subflow_rsk(req)->token_node.pprev = NULL;
953 }
954 
955 int mptcp_token_new_request(struct request_sock *req);
956 void mptcp_token_destroy_request(struct request_sock *req);
957 int mptcp_token_new_connect(struct sock *ssk);
958 void mptcp_token_accept(struct mptcp_subflow_request_sock *r,
959                         struct mptcp_sock *msk);
960 bool mptcp_token_exists(u32 token);
961 struct mptcp_sock *mptcp_token_get_sock(struct net *net, u32 token);
962 struct mptcp_sock *mptcp_token_iter_next(const struct net *net, long *s_slot,
963                                          long *s_num);
964 void mptcp_token_destroy(struct mptcp_sock *msk);
965 
966 void mptcp_crypto_key_sha(u64 key, u32 *token, u64 *idsn);
967 
968 void mptcp_crypto_hmac_sha(u64 key1, u64 key2, u8 *msg, int len, void *hmac);
969 __sum16 __mptcp_make_csum(u64 data_seq, u32 subflow_seq, u16 data_len, __wsum sum);
970 
971 void __init mptcp_pm_init(void);
972 void mptcp_pm_data_init(struct mptcp_sock *msk);
973 void mptcp_pm_data_reset(struct mptcp_sock *msk);
974 int mptcp_pm_parse_addr(struct nlattr *attr, struct genl_info *info,
975                         struct mptcp_addr_info *addr);
976 int mptcp_pm_parse_entry(struct nlattr *attr, struct genl_info *info,
977                          bool require_family,
978                          struct mptcp_pm_addr_entry *entry);
979 bool mptcp_pm_addr_families_match(const struct sock *sk,
980                                   const struct mptcp_addr_info *loc,
981                                   const struct mptcp_addr_info *rem);
982 void mptcp_pm_subflow_chk_stale(const struct mptcp_sock *msk, struct sock *ssk);
983 void mptcp_pm_nl_subflow_chk_stale(const struct mptcp_sock *msk, struct sock *ssk);
984 void mptcp_pm_new_connection(struct mptcp_sock *msk, const struct sock *ssk, int server_side);
985 void mptcp_pm_fully_established(struct mptcp_sock *msk, const struct sock *ssk);
986 bool mptcp_pm_allow_new_subflow(struct mptcp_sock *msk);
987 void mptcp_pm_connection_closed(struct mptcp_sock *msk);
988 void mptcp_pm_subflow_established(struct mptcp_sock *msk);
989 bool mptcp_pm_nl_check_work_pending(struct mptcp_sock *msk);
990 void mptcp_pm_subflow_check_next(struct mptcp_sock *msk,
991                                  const struct mptcp_subflow_context *subflow);
992 void mptcp_pm_add_addr_received(const struct sock *ssk,
993                                 const struct mptcp_addr_info *addr);
994 void mptcp_pm_add_addr_echoed(struct mptcp_sock *msk,
995                               const struct mptcp_addr_info *addr);
996 void mptcp_pm_add_addr_send_ack(struct mptcp_sock *msk);
997 bool mptcp_pm_nl_is_init_remote_addr(struct mptcp_sock *msk,
998                                      const struct mptcp_addr_info *remote);
999 void mptcp_pm_nl_addr_send_ack(struct mptcp_sock *msk);
1000 void mptcp_pm_rm_addr_received(struct mptcp_sock *msk,
1001                                const struct mptcp_rm_list *rm_list);
1002 void mptcp_pm_mp_prio_received(struct sock *sk, u8 bkup);
1003 void mptcp_pm_mp_fail_received(struct sock *sk, u64 fail_seq);
1004 int mptcp_pm_nl_mp_prio_send_ack(struct mptcp_sock *msk,
1005                                  struct mptcp_addr_info *addr,
1006                                  struct mptcp_addr_info *rem,
1007                                  u8 bkup);
1008 bool mptcp_pm_alloc_anno_list(struct mptcp_sock *msk,
1009                               const struct mptcp_addr_info *addr);
1010 void mptcp_pm_free_anno_list(struct mptcp_sock *msk);
1011 bool mptcp_pm_sport_in_anno_list(struct mptcp_sock *msk, const struct sock *sk);
1012 struct mptcp_pm_add_entry *
1013 mptcp_pm_del_add_timer(struct mptcp_sock *msk,
1014                        const struct mptcp_addr_info *addr, bool check_id);
1015 struct mptcp_pm_add_entry *
1016 mptcp_lookup_anno_list_by_saddr(const struct mptcp_sock *msk,
1017                                 const struct mptcp_addr_info *addr);
1018 int mptcp_pm_get_flags_and_ifindex_by_id(struct mptcp_sock *msk,
1019                                          unsigned int id,
1020                                          u8 *flags, int *ifindex);
1021 int mptcp_pm_nl_get_flags_and_ifindex_by_id(struct mptcp_sock *msk, unsigned int id,
1022                                             u8 *flags, int *ifindex);
1023 int mptcp_userspace_pm_get_flags_and_ifindex_by_id(struct mptcp_sock *msk,
1024                                                    unsigned int id,
1025                                                    u8 *flags, int *ifindex);
1026 int mptcp_pm_set_flags(struct sk_buff *skb, struct genl_info *info);
1027 int mptcp_pm_nl_set_flags(struct sk_buff *skb, struct genl_info *info);
1028 int mptcp_userspace_pm_set_flags(struct sk_buff *skb, struct genl_info *info);
1029 int mptcp_pm_announce_addr(struct mptcp_sock *msk,
1030                            const struct mptcp_addr_info *addr,
1031                            bool echo);
1032 int mptcp_pm_remove_addr(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
1033 void mptcp_pm_remove_addrs(struct mptcp_sock *msk, struct list_head *rm_list);
1034 
1035 void mptcp_free_local_addr_list(struct mptcp_sock *msk);
1036 
1037 void mptcp_event(enum mptcp_event_type type, const struct mptcp_sock *msk,
1038                  const struct sock *ssk, gfp_t gfp);
1039 void mptcp_event_addr_announced(const struct sock *ssk, const struct mptcp_addr_info *info);
1040 void mptcp_event_addr_removed(const struct mptcp_sock *msk, u8 id);
1041 void mptcp_event_pm_listener(const struct sock *ssk,
1042                              enum mptcp_event_type event);
1043 bool mptcp_userspace_pm_active(const struct mptcp_sock *msk);
1044 
1045 void __mptcp_fastopen_gen_msk_ackseq(struct mptcp_sock *msk, struct mptcp_subflow_context *subflow,
1046                                      const struct mptcp_options_received *mp_opt);
1047 void mptcp_fastopen_subflow_synack_set_params(struct mptcp_subflow_context *subflow,
1048                                               struct request_sock *req);
1049 int mptcp_nl_fill_addr(struct sk_buff *skb,
1050                        struct mptcp_pm_addr_entry *entry);
1051 
1052 static inline bool mptcp_pm_should_add_signal(struct mptcp_sock *msk)
1053 {
1054         return READ_ONCE(msk->pm.addr_signal) &
1055                 (BIT(MPTCP_ADD_ADDR_SIGNAL) | BIT(MPTCP_ADD_ADDR_ECHO));
1056 }
1057 
1058 static inline bool mptcp_pm_should_add_signal_addr(struct mptcp_sock *msk)
1059 {
1060         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_SIGNAL);
1061 }
1062 
1063 static inline bool mptcp_pm_should_add_signal_echo(struct mptcp_sock *msk)
1064 {
1065         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_ECHO);
1066 }
1067 
1068 static inline bool mptcp_pm_should_rm_signal(struct mptcp_sock *msk)
1069 {
1070         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_RM_ADDR_SIGNAL);
1071 }
1072 
1073 static inline bool mptcp_pm_is_userspace(const struct mptcp_sock *msk)
1074 {
1075         return READ_ONCE(msk->pm.pm_type) == MPTCP_PM_TYPE_USERSPACE;
1076 }
1077 
1078 static inline bool mptcp_pm_is_kernel(const struct mptcp_sock *msk)
1079 {
1080         return READ_ONCE(msk->pm.pm_type) == MPTCP_PM_TYPE_KERNEL;
1081 }
1082 
1083 static inline unsigned int mptcp_add_addr_len(int family, bool echo, bool port)
1084 {
1085         u8 len = TCPOLEN_MPTCP_ADD_ADDR_BASE;
1086 
1087         if (family == AF_INET6)
1088                 len = TCPOLEN_MPTCP_ADD_ADDR6_BASE;
1089         if (!echo)
1090                 len += MPTCPOPT_THMAC_LEN;
1091         /* account for 2 trailing 'nop' options */
1092         if (port)
1093                 len += TCPOLEN_MPTCP_PORT_LEN + TCPOLEN_MPTCP_PORT_ALIGN;
1094 
1095         return len;
1096 }
1097 
1098 static inline int mptcp_rm_addr_len(const struct mptcp_rm_list *rm_list)
1099 {
1100         if (rm_list->nr == 0 || rm_list->nr > MPTCP_RM_IDS_MAX)
1101                 return -EINVAL;
1102 
1103         return TCPOLEN_MPTCP_RM_ADDR_BASE + roundup(rm_list->nr - 1, 4) + 1;
1104 }
1105 
1106 bool mptcp_pm_add_addr_signal(struct mptcp_sock *msk, const struct sk_buff *skb,
1107                               unsigned int opt_size, unsigned int remaining,
1108                               struct mptcp_addr_info *addr, bool *echo,
1109                               bool *drop_other_suboptions);
1110 bool mptcp_pm_rm_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
1111                              struct mptcp_rm_list *rm_list);
1112 int mptcp_pm_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
1113 int mptcp_pm_nl_get_local_id(struct mptcp_sock *msk, struct mptcp_addr_info *skc);
1114 int mptcp_userspace_pm_get_local_id(struct mptcp_sock *msk, struct mptcp_addr_info *skc);
1115 bool mptcp_pm_is_backup(struct mptcp_sock *msk, struct sock_common *skc);
1116 bool mptcp_pm_nl_is_backup(struct mptcp_sock *msk, struct mptcp_addr_info *skc);
1117 bool mptcp_userspace_pm_is_backup(struct mptcp_sock *msk, struct mptcp_addr_info *skc);
1118 int mptcp_pm_dump_addr(struct sk_buff *msg, struct netlink_callback *cb);
1119 int mptcp_pm_nl_dump_addr(struct sk_buff *msg,
1120                           struct netlink_callback *cb);
1121 int mptcp_userspace_pm_dump_addr(struct sk_buff *msg,
1122                                  struct netlink_callback *cb);
1123 int mptcp_pm_get_addr(struct sk_buff *skb, struct genl_info *info);
1124 int mptcp_pm_nl_get_addr(struct sk_buff *skb, struct genl_info *info);
1125 int mptcp_userspace_pm_get_addr(struct sk_buff *skb,
1126                                 struct genl_info *info);
1127 
1128 static inline u8 subflow_get_local_id(const struct mptcp_subflow_context *subflow)
1129 {
1130         int local_id = READ_ONCE(subflow->local_id);
1131 
1132         if (local_id < 0)
1133                 return 0;
1134         return local_id;
1135 }
1136 
1137 void __init mptcp_pm_nl_init(void);
1138 void mptcp_pm_nl_work(struct mptcp_sock *msk);
1139 unsigned int mptcp_pm_get_add_addr_signal_max(const struct mptcp_sock *msk);
1140 unsigned int mptcp_pm_get_add_addr_accept_max(const struct mptcp_sock *msk);
1141 unsigned int mptcp_pm_get_subflows_max(const struct mptcp_sock *msk);
1142 unsigned int mptcp_pm_get_local_addr_max(const struct mptcp_sock *msk);
1143 
1144 /* called under PM lock */
1145 static inline void __mptcp_pm_close_subflow(struct mptcp_sock *msk)
1146 {
1147         if (--msk->pm.subflows < mptcp_pm_get_subflows_max(msk))
1148                 WRITE_ONCE(msk->pm.accept_subflow, true);
1149 }
1150 
1151 static inline void mptcp_pm_close_subflow(struct mptcp_sock *msk)
1152 {
1153         spin_lock_bh(&msk->pm.lock);
1154         __mptcp_pm_close_subflow(msk);
1155         spin_unlock_bh(&msk->pm.lock);
1156 }
1157 
1158 void mptcp_sockopt_sync(struct mptcp_sock *msk, struct sock *ssk);
1159 void mptcp_sockopt_sync_locked(struct mptcp_sock *msk, struct sock *ssk);
1160 
1161 static inline struct mptcp_ext *mptcp_get_ext(const struct sk_buff *skb)
1162 {
1163         return (struct mptcp_ext *)skb_ext_find(skb, SKB_EXT_MPTCP);
1164 }
1165 
1166 void mptcp_diag_subflow_init(struct tcp_ulp_ops *ops);
1167 
1168 static inline bool __mptcp_check_fallback(const struct mptcp_sock *msk)
1169 {
1170         return test_bit(MPTCP_FALLBACK_DONE, &msk->flags);
1171 }
1172 
1173 static inline bool mptcp_check_fallback(const struct sock *sk)
1174 {
1175         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
1176         struct mptcp_sock *msk = mptcp_sk(subflow->conn);
1177 
1178         return __mptcp_check_fallback(msk);
1179 }
1180 
1181 static inline void __mptcp_do_fallback(struct mptcp_sock *msk)
1182 {
1183         if (__mptcp_check_fallback(msk)) {
1184                 pr_debug("TCP fallback already done (msk=%p)\n", msk);
1185                 return;
1186         }
1187         set_bit(MPTCP_FALLBACK_DONE, &msk->flags);
1188 }
1189 
1190 static inline bool __mptcp_has_initial_subflow(const struct mptcp_sock *msk)
1191 {
1192         struct sock *ssk = READ_ONCE(msk->first);
1193 
1194         return ssk && ((1 << inet_sk_state_load(ssk)) &
1195                        (TCPF_ESTABLISHED | TCPF_SYN_SENT |
1196                         TCPF_SYN_RECV | TCPF_LISTEN));
1197 }
1198 
1199 static inline void mptcp_do_fallback(struct sock *ssk)
1200 {
1201         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(ssk);
1202         struct sock *sk = subflow->conn;
1203         struct mptcp_sock *msk;
1204 
1205         msk = mptcp_sk(sk);
1206         __mptcp_do_fallback(msk);
1207         if (READ_ONCE(msk->snd_data_fin_enable) && !(ssk->sk_shutdown & SEND_SHUTDOWN)) {
1208                 gfp_t saved_allocation = ssk->sk_allocation;
1209 
1210                 /* we are in a atomic (BH) scope, override ssk default for data
1211                  * fin allocation
1212                  */
1213                 ssk->sk_allocation = GFP_ATOMIC;
1214                 ssk->sk_shutdown |= SEND_SHUTDOWN;
1215                 tcp_shutdown(ssk, SEND_SHUTDOWN);
1216                 ssk->sk_allocation = saved_allocation;
1217         }
1218 }
1219 
1220 #define pr_fallback(a) pr_debug("%s:fallback to TCP (msk=%p)\n", __func__, a)
1221 
1222 static inline bool mptcp_check_infinite_map(struct sk_buff *skb)
1223 {
1224         struct mptcp_ext *mpext;
1225 
1226         mpext = skb ? mptcp_get_ext(skb) : NULL;
1227         if (mpext && mpext->infinite_map)
1228                 return true;
1229 
1230         return false;
1231 }
1232 
1233 static inline bool is_active_ssk(struct mptcp_subflow_context *subflow)
1234 {
1235         return (subflow->request_mptcp || subflow->request_join);
1236 }
1237 
1238 static inline bool subflow_simultaneous_connect(struct sock *sk)
1239 {
1240         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
1241 
1242         return (1 << sk->sk_state) &
1243                (TCPF_ESTABLISHED | TCPF_FIN_WAIT1 | TCPF_FIN_WAIT2 | TCPF_CLOSING) &&
1244                is_active_ssk(subflow) &&
1245                !subflow->conn_finished;
1246 }
1247 
1248 #ifdef CONFIG_SYN_COOKIES
1249 void subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
1250                                        struct sk_buff *skb);
1251 bool mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
1252                                         struct sk_buff *skb);
1253 void __init mptcp_join_cookie_init(void);
1254 #else
1255 static inline void
1256 subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
1257                                   struct sk_buff *skb) {}
1258 static inline bool
1259 mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
1260                                    struct sk_buff *skb)
1261 {
1262         return false;
1263 }
1264 
1265 static inline void mptcp_join_cookie_init(void) {}
1266 #endif
1267 
1268 #endif /* __MPTCP_PROTOCOL_H */
1269 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

sflogo.php