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         unsigned long   push_pending;
 276         bool            recovery;               /* closing subflow write queue reinjected */
 277         bool            can_ack;
 278         bool            fully_established;
 279         bool            rcv_data_fin;
 280         bool            snd_data_fin_enable;
 281         bool            rcv_fastclose;
 282         bool            use_64bit_ack; /* Set when we received a 64-bit DSN */
 283         bool            csum_enabled;
 284         bool            allow_infinite_fallback;
 285         u8              mpc_endpoint_id;
 286         u8              recvmsg_inq:1,
 287                         cork:1,
 288                         nodelay:1,
 289                         fastopening:1,
 290                         in_accept_queue:1;
 291         int             connect_flags;
 292         struct work_struct work;
 293         struct sk_buff  *ooo_last_skb;
 294         struct rb_root  out_of_order_queue;
 295         struct sk_buff_head receive_queue;
 296         struct list_head conn_list;
 297         struct list_head rtx_queue;
 298         struct mptcp_data_frag *first_pending;
 299         struct list_head join_list;
 300         struct socket   *subflow; /* outgoing connect/listener/!mp_capable */
 301         struct sock     *first;
 302         struct mptcp_pm_data    pm;
 303         struct {
 304                 u32     space;  /* bytes copied in last measurement window */
 305                 u32     copied; /* bytes copied in this measurement window */
 306                 u64     time;   /* start time of measurement window */
 307                 u64     rtt_us; /* last maximum rtt of subflows */
 308         } rcvq_space;
 309
 310         u32 setsockopt_seq;
 311         char            ca_name[TCP_CA_NAME_MAX];
 312         struct mptcp_sock       *dl_next;
 313 };
 314
 315 #define mptcp_data_lock(sk) spin_lock_bh(&(sk)->sk_lock.slock)
 316 #define mptcp_data_unlock(sk) spin_unlock_bh(&(sk)->sk_lock.slock)
 317
 318 #define mptcp_for_each_subflow(__msk, __subflow)                        \
 319         list_for_each_entry(__subflow, &((__msk)->conn_list), node)
 320 #define mptcp_for_each_subflow_safe(__msk, __subflow, __tmp)                    \
 321         list_for_each_entry_safe(__subflow, __tmp, &((__msk)->conn_list), node)
 322
 323 static inline void msk_owned_by_me(const struct mptcp_sock *msk)
 324 {
 325         sock_owned_by_me((const struct sock *)msk);
 326 }
 327
 328 static inline struct mptcp_sock *mptcp_sk(const struct sock *sk)
 329 {
 330         return (struct mptcp_sock *)sk;
 331 }
 332
 333 /* the msk socket don't use the backlog, also account for the bulk
 334  * free memory
 335  */
 336 static inline int __mptcp_rmem(const struct sock *sk)
 337 {
 338         return atomic_read(&sk->sk_rmem_alloc) - READ_ONCE(mptcp_sk(sk)->rmem_released);
 339 }
 340
 341 static inline int __mptcp_space(const struct sock *sk)
 342 {
 343         return tcp_win_from_space(sk, READ_ONCE(sk->sk_rcvbuf) - __mptcp_rmem(sk));
 344 }
 345
 346 static inline struct mptcp_data_frag *mptcp_send_head(const struct sock *sk)
 347 {
 348         const struct mptcp_sock *msk = mptcp_sk(sk);
 349
 350         return READ_ONCE(msk->first_pending);
 351 }
 352
 353 static inline struct mptcp_data_frag *mptcp_send_next(struct sock *sk)
 354 {
 355         struct mptcp_sock *msk = mptcp_sk(sk);
 356         struct mptcp_data_frag *cur;
 357
 358         cur = msk->first_pending;
 359         return list_is_last(&cur->list, &msk->rtx_queue) ? NULL :
 360                                                      list_next_entry(cur, list);
 361 }
 362
 363 static inline struct mptcp_data_frag *mptcp_pending_tail(const struct sock *sk)
 364 {
 365         struct mptcp_sock *msk = mptcp_sk(sk);
 366
 367         if (!msk->first_pending)
 368                 return NULL;
 369
 370         if (WARN_ON_ONCE(list_empty(&msk->rtx_queue)))
 371                 return NULL;
 372
 373         return list_last_entry(&msk->rtx_queue, struct mptcp_data_frag, list);
 374 }
 375
 376 static inline struct mptcp_data_frag *mptcp_rtx_head(const struct sock *sk)
 377 {
 378         struct mptcp_sock *msk = mptcp_sk(sk);
 379
 380         if (msk->snd_una == READ_ONCE(msk->snd_nxt))
 381                 return NULL;
 382
 383         return list_first_entry_or_null(&msk->rtx_queue, struct mptcp_data_frag, list);
 384 }
 385
 386 struct csum_pseudo_header {
 387         __be64 data_seq;
 388         __be32 subflow_seq;
 389         __be16 data_len;
 390         __sum16 csum;
 391 };
 392
 393 struct mptcp_subflow_request_sock {
 394         struct  tcp_request_sock sk;
 395         u16     mp_capable : 1,
 396                 mp_join : 1,
 397                 backup : 1,
 398                 csum_reqd : 1,
 399                 allow_join_id0 : 1;
 400         u8      local_id;
 401         u8      remote_id;
 402         u64     local_key;
 403         u64     idsn;
 404         u32     token;
 405         u32     ssn_offset;
 406         u64     thmac;
 407         u32     local_nonce;
 408         u32     remote_nonce;
 409         struct mptcp_sock       *msk;
 410         struct hlist_nulls_node token_node;
 411 };
 412
 413 static inline struct mptcp_subflow_request_sock *
 414 mptcp_subflow_rsk(const struct request_sock *rsk)
 415 {
 416         return (struct mptcp_subflow_request_sock *)rsk;
 417 }
 418
 419 enum mptcp_data_avail {
 420         MPTCP_SUBFLOW_NODATA,
 421         MPTCP_SUBFLOW_DATA_AVAIL,
 422 };
 423
 424 struct mptcp_delegated_action {
 425         struct napi_struct napi;
 426         struct list_head head;
 427 };
 428
 429 DECLARE_PER_CPU(struct mptcp_delegated_action, mptcp_delegated_actions);
 430
 431 #define MPTCP_DELEGATE_SEND             0
 432 #define MPTCP_DELEGATE_ACK              1
 433
 434 /* MPTCP subflow context */
 435 struct mptcp_subflow_context {
 436         struct  list_head node;/* conn_list of subflows */
 437
 438         struct_group(reset,
 439
 440         unsigned long avg_pacing_rate; /* protected by msk socket lock */
 441         u64     local_key;
 442         u64     remote_key;
 443         u64     idsn;
 444         u64     map_seq;
 445         u32     snd_isn;
 446         u32     token;
 447         u32     rel_write_seq;
 448         u32     map_subflow_seq;
 449         u32     ssn_offset;
 450         u32     map_data_len;
 451         __wsum  map_data_csum;
 452         u32     map_csum_len;
 453         u32     request_mptcp : 1,  /* send MP_CAPABLE */
 454                 request_join : 1,   /* send MP_JOIN */
 455                 request_bkup : 1,
 456                 mp_capable : 1,     /* remote is MPTCP capable */
 457                 mp_join : 1,        /* remote is JOINing */
 458                 fully_established : 1,      /* path validated */
 459                 pm_notified : 1,    /* PM hook called for established status */
 460                 conn_finished : 1,
 461                 map_valid : 1,
 462                 map_csum_reqd : 1,
 463                 map_data_fin : 1,
 464                 mpc_map : 1,
 465                 backup : 1,
 466                 send_mp_prio : 1,
 467                 send_mp_fail : 1,
 468                 send_fastclose : 1,
 469                 send_infinite_map : 1,
 470                 rx_eof : 1,
 471                 can_ack : 1,        /* only after processing the remote a key */
 472                 disposable : 1,     /* ctx can be free at ulp release time */
 473                 stale : 1,          /* unable to snd/rcv data, do not use for xmit */
 474                 local_id_valid : 1, /* local_id is correctly initialized */
 475                 valid_csum_seen : 1;        /* at least one csum validated */
 476         enum mptcp_data_avail data_avail;
 477         u32     remote_nonce;
 478         u64     thmac;
 479         u32     local_nonce;
 480         u32     remote_token;
 481         u8      hmac[MPTCPOPT_HMAC_LEN];
 482         u8      local_id;
 483         u8      remote_id;
 484         u8      reset_seen:1;
 485         u8      reset_transient:1;
 486         u8      reset_reason:4;
 487         u8      stale_count;
 488
 489         long    delegated_status;
 490         unsigned long   fail_tout;
 491
 492         );
 493
 494         struct  list_head delegated_node;   /* link into delegated_action, protected by local BH */
 495
 496         u32     setsockopt_seq;
 497         u32     stale_rcv_tstamp;
 498
 499         struct  sock *tcp_sock;     /* tcp sk backpointer */
 500         struct  sock *conn;         /* parent mptcp_sock */
 501         const   struct inet_connection_sock_af_ops *icsk_af_ops;
 502         void    (*tcp_state_change)(struct sock *sk);
 503         void    (*tcp_error_report)(struct sock *sk);
 504
 505         struct  rcu_head rcu;
 506 };
 507
 508 static inline struct mptcp_subflow_context *
 509 mptcp_subflow_ctx(const struct sock *sk)
 510 {
 511         struct inet_connection_sock *icsk = inet_csk(sk);
 512
 513         /* Use RCU on icsk_ulp_data only for sock diag code */
 514         return (__force struct mptcp_subflow_context *)icsk->icsk_ulp_data;
 515 }
 516
 517 static inline struct sock *
 518 mptcp_subflow_tcp_sock(const struct mptcp_subflow_context *subflow)
 519 {
 520         return subflow->tcp_sock;
 521 }
 522
 523 static inline void
 524 mptcp_subflow_ctx_reset(struct mptcp_subflow_context *subflow)
 525 {
 526         memset(&subflow->reset, 0, sizeof(subflow->reset));
 527         subflow->request_mptcp = 1;
 528 }
 529
 530 static inline u64
 531 mptcp_subflow_get_map_offset(const struct mptcp_subflow_context *subflow)
 532 {
 533         return tcp_sk(mptcp_subflow_tcp_sock(subflow))->copied_seq -
 534                       subflow->ssn_offset -
 535                       subflow->map_subflow_seq;
 536 }
 537
 538 static inline u64
 539 mptcp_subflow_get_mapped_dsn(const struct mptcp_subflow_context *subflow)
 540 {
 541         return subflow->map_seq + mptcp_subflow_get_map_offset(subflow);
 542 }
 543
 544 void mptcp_subflow_process_delegated(struct sock *ssk);
 545
 546 static inline void mptcp_subflow_delegate(struct mptcp_subflow_context *subflow, int action)
 547 {
 548         struct mptcp_delegated_action *delegated;
 549         bool schedule;
 550
 551         /* the caller held the subflow bh socket lock */
 552         lockdep_assert_in_softirq();
 553
 554         /* The implied barrier pairs with mptcp_subflow_delegated_done(), and
 555          * ensures the below list check sees list updates done prior to status
 556          * bit changes
 557          */
 558         if (!test_and_set_bit(action, &subflow->delegated_status)) {
 559                 /* still on delegated list from previous scheduling */
 560                 if (!list_empty(&subflow->delegated_node))
 561                         return;
 562
 563                 delegated = this_cpu_ptr(&mptcp_delegated_actions);
 564                 schedule = list_empty(&delegated->head);
 565                 list_add_tail(&subflow->delegated_node, &delegated->head);
 566                 sock_hold(mptcp_subflow_tcp_sock(subflow));
 567                 if (schedule)
 568                         napi_schedule(&delegated->napi);
 569         }
 570 }
 571
 572 static inline struct mptcp_subflow_context *
 573 mptcp_subflow_delegated_next(struct mptcp_delegated_action *delegated)
 574 {
 575         struct mptcp_subflow_context *ret;
 576
 577         if (list_empty(&delegated->head))
 578                 return NULL;
 579
 580         ret = list_first_entry(&delegated->head, struct mptcp_subflow_context, delegated_node);
 581         list_del_init(&ret->delegated_node);
 582         return ret;
 583 }
 584
 585 static inline bool mptcp_subflow_has_delegated_action(const struct mptcp_subflow_context *subflow)
 586 {
 587         return !!READ_ONCE(subflow->delegated_status);
 588 }
 589
 590 static inline void mptcp_subflow_delegated_done(struct mptcp_subflow_context *subflow, int action)
 591 {
 592         /* pairs with mptcp_subflow_delegate, ensures delegate_node is updated before
 593          * touching the status bit
 594          */
 595         smp_wmb();
 596         clear_bit(action, &subflow->delegated_status);
 597 }
 598
 599 int mptcp_is_enabled(const struct net *net);
 600 unsigned int mptcp_get_add_addr_timeout(const struct net *net);
 601 int mptcp_is_checksum_enabled(const struct net *net);
 602 int mptcp_allow_join_id0(const struct net *net);
 603 unsigned int mptcp_stale_loss_cnt(const struct net *net);
 604 int mptcp_get_pm_type(const struct net *net);
 605 void mptcp_copy_inaddrs(struct sock *msk, const struct sock *ssk);
 606 void mptcp_subflow_fully_established(struct mptcp_subflow_context *subflow,
 607                                      struct mptcp_options_received *mp_opt);
 608 bool __mptcp_retransmit_pending_data(struct sock *sk);
 609 void mptcp_check_and_set_pending(struct sock *sk);
 610 void __mptcp_push_pending(struct sock *sk, unsigned int flags);
 611 bool mptcp_subflow_data_available(struct sock *sk);
 612 void __init mptcp_subflow_init(void);
 613 void mptcp_subflow_shutdown(struct sock *sk, struct sock *ssk, int how);
 614 void mptcp_close_ssk(struct sock *sk, struct sock *ssk,
 615                      struct mptcp_subflow_context *subflow);
 616 void __mptcp_subflow_send_ack(struct sock *ssk);
 617 void mptcp_subflow_reset(struct sock *ssk);
 618 void mptcp_sock_graft(struct sock *sk, struct socket *parent);
 619 struct socket *__mptcp_nmpc_socket(const struct mptcp_sock *msk);
 620 bool __mptcp_close(struct sock *sk, long timeout);
 621 void mptcp_cancel_work(struct sock *sk);
 622
 623 bool mptcp_addresses_equal(const struct mptcp_addr_info *a,
 624                            const struct mptcp_addr_info *b, bool use_port);
 625
 626 /* called with sk socket lock held */
 627 int __mptcp_subflow_connect(struct sock *sk, const struct mptcp_addr_info *loc,
 628                             const struct mptcp_addr_info *remote);
 629 int mptcp_subflow_create_socket(struct sock *sk, unsigned short family,
 630                                 struct socket **new_sock);
 631 void mptcp_info2sockaddr(const struct mptcp_addr_info *info,
 632                          struct sockaddr_storage *addr,
 633                          unsigned short family);
 634
 635 static inline bool __tcp_can_send(const struct sock *ssk)
 636 {
 637         /* only send if our side has not closed yet */
 638         return ((1 << inet_sk_state_load(ssk)) & (TCPF_ESTABLISHED | TCPF_CLOSE_WAIT));
 639 }
 640
 641 static inline bool __mptcp_subflow_active(struct mptcp_subflow_context *subflow)
 642 {
 643         /* can't send if JOIN hasn't completed yet (i.e. is usable for mptcp) */
 644         if (subflow->request_join && !subflow->fully_established)
 645                 return false;
 646
 647         return __tcp_can_send(mptcp_subflow_tcp_sock(subflow));
 648 }
 649
 650 void mptcp_subflow_set_active(struct mptcp_subflow_context *subflow);
 651
 652 bool mptcp_subflow_active(struct mptcp_subflow_context *subflow);
 653
 654 void mptcp_subflow_drop_ctx(struct sock *ssk);
 655
 656 static inline void mptcp_subflow_tcp_fallback(struct sock *sk,
 657                                               struct mptcp_subflow_context *ctx)
 658 {
 659         sk->sk_data_ready = sock_def_readable;
 660         sk->sk_state_change = ctx->tcp_state_change;
 661         sk->sk_write_space = sk_stream_write_space;
 662         sk->sk_error_report = ctx->tcp_error_report;
 663
 664         inet_csk(sk)->icsk_af_ops = ctx->icsk_af_ops;
 665 }
 666
 667 void __init mptcp_proto_init(void);
 668 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
 669 int __init mptcp_proto_v6_init(void);
 670 #endif
 671
 672 struct sock *mptcp_sk_clone(const struct sock *sk,
 673                             const struct mptcp_options_received *mp_opt,
 674                             struct request_sock *req);
 675 void mptcp_get_options(const struct sk_buff *skb,
 676                        struct mptcp_options_received *mp_opt);
 677
 678 void mptcp_finish_connect(struct sock *sk);
 679 void __mptcp_set_connected(struct sock *sk);
 680 void mptcp_reset_timeout(struct mptcp_sock *msk, unsigned long fail_tout);
 681 static inline bool mptcp_is_fully_established(struct sock *sk)
 682 {
 683         return inet_sk_state_load(sk) == TCP_ESTABLISHED &&
 684                READ_ONCE(mptcp_sk(sk)->fully_established);
 685 }
 686 void mptcp_rcv_space_init(struct mptcp_sock *msk, const struct sock *ssk);
 687 void mptcp_data_ready(struct sock *sk, struct sock *ssk);
 688 bool mptcp_finish_join(struct sock *sk);
 689 bool mptcp_schedule_work(struct sock *sk);
 690 int mptcp_setsockopt(struct sock *sk, int level, int optname,
 691                      sockptr_t optval, unsigned int optlen);
 692 int mptcp_getsockopt(struct sock *sk, int level, int optname,
 693                      char __user *optval, int __user *option);
 694
 695 u64 __mptcp_expand_seq(u64 old_seq, u64 cur_seq);
 696 static inline u64 mptcp_expand_seq(u64 old_seq, u64 cur_seq, bool use_64bit)
 697 {
 698         if (use_64bit)
 699                 return cur_seq;
 700
 701         return __mptcp_expand_seq(old_seq, cur_seq);
 702 }
 703 void __mptcp_check_push(struct sock *sk, struct sock *ssk);
 704 void __mptcp_data_acked(struct sock *sk);
 705 void __mptcp_error_report(struct sock *sk);
 706 void mptcp_subflow_eof(struct sock *sk);
 707 bool mptcp_update_rcv_data_fin(struct mptcp_sock *msk, u64 data_fin_seq, bool use_64bit);
 708 static inline bool mptcp_data_fin_enabled(const struct mptcp_sock *msk)
 709 {
 710         return READ_ONCE(msk->snd_data_fin_enable) &&
 711                READ_ONCE(msk->write_seq) == READ_ONCE(msk->snd_nxt);
 712 }
 713
 714 static inline bool mptcp_propagate_sndbuf(struct sock *sk, struct sock *ssk)
 715 {
 716         if ((sk->sk_userlocks & SOCK_SNDBUF_LOCK) || ssk->sk_sndbuf <= READ_ONCE(sk->sk_sndbuf))
 717                 return false;
 718
 719         WRITE_ONCE(sk->sk_sndbuf, ssk->sk_sndbuf);
 720         return true;
 721 }
 722
 723 static inline void mptcp_write_space(struct sock *sk)
 724 {
 725         if (sk_stream_is_writeable(sk)) {
 726                 /* pairs with memory barrier in mptcp_poll */
 727                 smp_mb();
 728                 if (test_and_clear_bit(MPTCP_NOSPACE, &mptcp_sk(sk)->flags))
 729                         sk_stream_write_space(sk);
 730         }
 731 }
 732
 733 void mptcp_destroy_common(struct mptcp_sock *msk, unsigned int flags);
 734
 735 #define MPTCP_TOKEN_MAX_RETRIES 4
 736
 737 void __init mptcp_token_init(void);
 738 static inline void mptcp_token_init_request(struct request_sock *req)
 739 {
 740         mptcp_subflow_rsk(req)->token_node.pprev = NULL;
 741 }
 742
 743 int mptcp_token_new_request(struct request_sock *req);
 744 void mptcp_token_destroy_request(struct request_sock *req);
 745 int mptcp_token_new_connect(struct sock *sk);
 746 void mptcp_token_accept(struct mptcp_subflow_request_sock *r,
 747                         struct mptcp_sock *msk);
 748 bool mptcp_token_exists(u32 token);
 749 struct mptcp_sock *mptcp_token_get_sock(struct net *net, u32 token);
 750 struct mptcp_sock *mptcp_token_iter_next(const struct net *net, long *s_slot,
 751                                          long *s_num);
 752 void mptcp_token_destroy(struct mptcp_sock *msk);
 753
 754 void mptcp_crypto_key_sha(u64 key, u32 *token, u64 *idsn);
 755
 756 void mptcp_crypto_hmac_sha(u64 key1, u64 key2, u8 *msg, int len, void *hmac);
 757 __sum16 __mptcp_make_csum(u64 data_seq, u32 subflow_seq, u16 data_len, __wsum sum);
 758
 759 void __init mptcp_pm_init(void);
 760 void mptcp_pm_data_init(struct mptcp_sock *msk);
 761 void mptcp_pm_data_reset(struct mptcp_sock *msk);
 762 int mptcp_pm_parse_addr(struct nlattr *attr, struct genl_info *info,
 763                         struct mptcp_addr_info *addr);
 764 int mptcp_pm_parse_entry(struct nlattr *attr, struct genl_info *info,
 765                          bool require_family,
 766                          struct mptcp_pm_addr_entry *entry);
 767 bool mptcp_pm_addr_families_match(const struct sock *sk,
 768                                   const struct mptcp_addr_info *loc,
 769                                   const struct mptcp_addr_info *rem);
 770 void mptcp_pm_subflow_chk_stale(const struct mptcp_sock *msk, struct sock *ssk);
 771 void mptcp_pm_nl_subflow_chk_stale(const struct mptcp_sock *msk, struct sock *ssk);
 772 void mptcp_pm_new_connection(struct mptcp_sock *msk, const struct sock *ssk, int server_side);
 773 void mptcp_pm_fully_established(struct mptcp_sock *msk, const struct sock *ssk, gfp_t gfp);
 774 bool mptcp_pm_allow_new_subflow(struct mptcp_sock *msk);
 775 void mptcp_pm_connection_closed(struct mptcp_sock *msk);
 776 void mptcp_pm_subflow_established(struct mptcp_sock *msk);
 777 bool mptcp_pm_nl_check_work_pending(struct mptcp_sock *msk);
 778 void mptcp_pm_subflow_check_next(struct mptcp_sock *msk, const struct sock *ssk,
 779                                  const struct mptcp_subflow_context *subflow);
 780 void mptcp_pm_add_addr_received(const struct sock *ssk,
 781                                 const struct mptcp_addr_info *addr);
 782 void mptcp_pm_add_addr_echoed(struct mptcp_sock *msk,
 783                               const struct mptcp_addr_info *addr);
 784 void mptcp_pm_add_addr_send_ack(struct mptcp_sock *msk);
 785 void mptcp_pm_nl_addr_send_ack(struct mptcp_sock *msk);
 786 void mptcp_pm_rm_addr_received(struct mptcp_sock *msk,
 787                                const struct mptcp_rm_list *rm_list);
 788 void mptcp_pm_mp_prio_received(struct sock *sk, u8 bkup);
 789 void mptcp_pm_mp_fail_received(struct sock *sk, u64 fail_seq);
 790 int mptcp_pm_nl_mp_prio_send_ack(struct mptcp_sock *msk,
 791                                  struct mptcp_addr_info *addr,
 792                                  struct mptcp_addr_info *rem,
 793                                  u8 bkup);
 794 bool mptcp_pm_alloc_anno_list(struct mptcp_sock *msk,
 795                               const struct mptcp_pm_addr_entry *entry);
 796 void mptcp_pm_free_anno_list(struct mptcp_sock *msk);
 797 bool mptcp_pm_sport_in_anno_list(struct mptcp_sock *msk, const struct sock *sk);
 798 struct mptcp_pm_add_entry *
 799 mptcp_pm_del_add_timer(struct mptcp_sock *msk,
 800                        const struct mptcp_addr_info *addr, bool check_id);
 801 struct mptcp_pm_add_entry *
 802 mptcp_lookup_anno_list_by_saddr(const struct mptcp_sock *msk,
 803                                 const struct mptcp_addr_info *addr);
 804 int mptcp_pm_get_flags_and_ifindex_by_id(struct mptcp_sock *msk,
 805                                          unsigned int id,
 806                                          u8 *flags, int *ifindex);
 807 int mptcp_userspace_pm_get_flags_and_ifindex_by_id(struct mptcp_sock *msk,
 808                                                    unsigned int id,
 809                                                    u8 *flags, int *ifindex);
 810 int mptcp_userspace_pm_set_flags(struct net *net, struct nlattr *token,
 811                                  struct mptcp_pm_addr_entry *loc,
 812                                  struct mptcp_pm_addr_entry *rem, u8 bkup);
 813 int mptcp_pm_announce_addr(struct mptcp_sock *msk,
 814                            const struct mptcp_addr_info *addr,
 815                            bool echo);
 816 int mptcp_pm_remove_addr(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
 817 int mptcp_pm_remove_subflow(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
 818 void mptcp_pm_remove_addrs_and_subflows(struct mptcp_sock *msk,
 819                                         struct list_head *rm_list);
 820
 821 int mptcp_userspace_pm_append_new_local_addr(struct mptcp_sock *msk,
 822                                              struct mptcp_pm_addr_entry *entry);
 823 void mptcp_free_local_addr_list(struct mptcp_sock *msk);
 824 int mptcp_nl_cmd_announce(struct sk_buff *skb, struct genl_info *info);
 825 int mptcp_nl_cmd_remove(struct sk_buff *skb, struct genl_info *info);
 826 int mptcp_nl_cmd_sf_create(struct sk_buff *skb, struct genl_info *info);
 827 int mptcp_nl_cmd_sf_destroy(struct sk_buff *skb, struct genl_info *info);
 828
 829 void mptcp_event(enum mptcp_event_type type, const struct mptcp_sock *msk,
 830                  const struct sock *ssk, gfp_t gfp);
 831 void mptcp_event_addr_announced(const struct sock *ssk, const struct mptcp_addr_info *info);
 832 void mptcp_event_addr_removed(const struct mptcp_sock *msk, u8 id);
 833 bool mptcp_userspace_pm_active(const struct mptcp_sock *msk);
 834
 835 static inline bool mptcp_pm_should_add_signal(struct mptcp_sock *msk)
 836 {
 837         return READ_ONCE(msk->pm.addr_signal) &
 838                 (BIT(MPTCP_ADD_ADDR_SIGNAL) | BIT(MPTCP_ADD_ADDR_ECHO));
 839 }
 840
 841 static inline bool mptcp_pm_should_add_signal_addr(struct mptcp_sock *msk)
 842 {
 843         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_SIGNAL);
 844 }
 845
 846 static inline bool mptcp_pm_should_add_signal_echo(struct mptcp_sock *msk)
 847 {
 848         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_ECHO);
 849 }
 850
 851 static inline bool mptcp_pm_should_rm_signal(struct mptcp_sock *msk)
 852 {
 853         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_RM_ADDR_SIGNAL);
 854 }
 855
 856 static inline bool mptcp_pm_is_userspace(const struct mptcp_sock *msk)
 857 {
 858         return READ_ONCE(msk->pm.pm_type) == MPTCP_PM_TYPE_USERSPACE;
 859 }
 860
 861 static inline bool mptcp_pm_is_kernel(const struct mptcp_sock *msk)
 862 {
 863         return READ_ONCE(msk->pm.pm_type) == MPTCP_PM_TYPE_KERNEL;
 864 }
 865
 866 static inline unsigned int mptcp_add_addr_len(int family, bool echo, bool port)
 867 {
 868         u8 len = TCPOLEN_MPTCP_ADD_ADDR_BASE;
 869
 870         if (family == AF_INET6)
 871                 len = TCPOLEN_MPTCP_ADD_ADDR6_BASE;
 872         if (!echo)
 873                 len += MPTCPOPT_THMAC_LEN;
 874         /* account for 2 trailing 'nop' options */
 875         if (port)
 876                 len += TCPOLEN_MPTCP_PORT_LEN + TCPOLEN_MPTCP_PORT_ALIGN;
 877
 878         return len;
 879 }
 880
 881 static inline int mptcp_rm_addr_len(const struct mptcp_rm_list *rm_list)
 882 {
 883         if (rm_list->nr == 0 || rm_list->nr > MPTCP_RM_IDS_MAX)
 884                 return -EINVAL;
 885
 886         return TCPOLEN_MPTCP_RM_ADDR_BASE + roundup(rm_list->nr - 1, 4) + 1;
 887 }
 888
 889 bool mptcp_pm_add_addr_signal(struct mptcp_sock *msk, const struct sk_buff *skb,
 890                               unsigned int opt_size, unsigned int remaining,
 891                               struct mptcp_addr_info *addr, bool *echo,
 892                               bool *drop_other_suboptions);
 893 bool mptcp_pm_rm_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
 894                              struct mptcp_rm_list *rm_list);
 895 int mptcp_pm_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
 896 int mptcp_userspace_pm_get_local_id(struct mptcp_sock *msk, struct mptcp_addr_info *skc);
 897
 898 void __init mptcp_pm_nl_init(void);
 899 void mptcp_pm_nl_work(struct mptcp_sock *msk);
 900 void mptcp_pm_nl_rm_subflow_received(struct mptcp_sock *msk,
 901                                      const struct mptcp_rm_list *rm_list);
 902 int mptcp_pm_nl_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
 903 unsigned int mptcp_pm_get_add_addr_signal_max(const struct mptcp_sock *msk);
 904 unsigned int mptcp_pm_get_add_addr_accept_max(const struct mptcp_sock *msk);
 905 unsigned int mptcp_pm_get_subflows_max(const struct mptcp_sock *msk);
 906 unsigned int mptcp_pm_get_local_addr_max(const struct mptcp_sock *msk);
 907
 908 /* called under PM lock */
 909 static inline void __mptcp_pm_close_subflow(struct mptcp_sock *msk)
 910 {
 911         if (--msk->pm.subflows < mptcp_pm_get_subflows_max(msk))
 912                 WRITE_ONCE(msk->pm.accept_subflow, true);
 913 }
 914
 915 static inline void mptcp_pm_close_subflow(struct mptcp_sock *msk)
 916 {
 917         spin_lock_bh(&msk->pm.lock);
 918         __mptcp_pm_close_subflow(msk);
 919         spin_unlock_bh(&msk->pm.lock);
 920 }
 921
 922 void mptcp_sockopt_sync(struct mptcp_sock *msk, struct sock *ssk);
 923 void mptcp_sockopt_sync_locked(struct mptcp_sock *msk, struct sock *ssk);
 924
 925 static inline struct mptcp_ext *mptcp_get_ext(const struct sk_buff *skb)
 926 {
 927         return (struct mptcp_ext *)skb_ext_find(skb, SKB_EXT_MPTCP);
 928 }
 929
 930 void mptcp_diag_subflow_init(struct tcp_ulp_ops *ops);
 931
 932 static inline bool __mptcp_check_fallback(const struct mptcp_sock *msk)
 933 {
 934         return test_bit(MPTCP_FALLBACK_DONE, &msk->flags);
 935 }
 936
 937 static inline bool mptcp_check_fallback(const struct sock *sk)
 938 {
 939         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
 940         struct mptcp_sock *msk = mptcp_sk(subflow->conn);
 941
 942         return __mptcp_check_fallback(msk);
 943 }
 944
 945 static inline void __mptcp_do_fallback(struct mptcp_sock *msk)
 946 {
 947         if (test_bit(MPTCP_FALLBACK_DONE, &msk->flags)) {
 948                 pr_debug("TCP fallback already done (msk=%p)", msk);
 949                 return;
 950         }
 951         set_bit(MPTCP_FALLBACK_DONE, &msk->flags);
 952 }
 953
 954 static inline void mptcp_do_fallback(struct sock *ssk)
 955 {
 956         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(ssk);
 957         struct sock *sk = subflow->conn;
 958         struct mptcp_sock *msk;
 959
 960         msk = mptcp_sk(sk);
 961         __mptcp_do_fallback(msk);
 962         if (READ_ONCE(msk->snd_data_fin_enable) && !(ssk->sk_shutdown & SEND_SHUTDOWN)) {
 963                 gfp_t saved_allocation = ssk->sk_allocation;
 964
 965                 /* we are in a atomic (BH) scope, override ssk default for data
 966                  * fin allocation
 967                  */
 968                 ssk->sk_allocation = GFP_ATOMIC;
 969                 ssk->sk_shutdown |= SEND_SHUTDOWN;
 970                 tcp_shutdown(ssk, SEND_SHUTDOWN);
 971                 ssk->sk_allocation = saved_allocation;
 972         }
 973 }
 974
 975 #define pr_fallback(a) pr_debug("%s:fallback to TCP (msk=%p)", __func__, a)
 976
 977 static inline bool mptcp_check_infinite_map(struct sk_buff *skb)
 978 {
 979         struct mptcp_ext *mpext;
 980
 981         mpext = skb ? mptcp_get_ext(skb) : NULL;
 982         if (mpext && mpext->infinite_map)
 983                 return true;
 984
 985         return false;
 986 }
 987
 988 static inline bool is_active_ssk(struct mptcp_subflow_context *subflow)
 989 {
 990         return (subflow->request_mptcp || subflow->request_join);
 991 }
 992
 993 static inline bool subflow_simultaneous_connect(struct sock *sk)
 994 {
 995         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
 996
 997         return sk->sk_state == TCP_ESTABLISHED &&
 998                is_active_ssk(subflow) &&
 999                !subflow->conn_finished;
1000 }
1001
1002 #ifdef CONFIG_SYN_COOKIES
1003 void subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
1004                                        struct sk_buff *skb);
1005 bool mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
1006                                         struct sk_buff *skb);
1007 void __init mptcp_join_cookie_init(void);
1008 #else
1009 static inline void
1010 subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
1011                                   struct sk_buff *skb) {}
1012 static inline bool
1013 mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
1014                                    struct sk_buff *skb)
1015 {
1016         return false;
1017 }
1018
1019 static inline void mptcp_join_cookie_init(void) {}
1020 #endif
1021
1022 #endif /* __MPTCP_PROTOCOL_H */