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
  15 #define MPTCP_SUPPORTED_VERSION 1
  16
  17 /* MPTCP option bits */
  18 #define OPTION_MPTCP_MPC_SYN    BIT(0)
  19 #define OPTION_MPTCP_MPC_SYNACK BIT(1)
  20 #define OPTION_MPTCP_MPC_ACK    BIT(2)
  21 #define OPTION_MPTCP_MPJ_SYN    BIT(3)
  22 #define OPTION_MPTCP_MPJ_SYNACK BIT(4)
  23 #define OPTION_MPTCP_MPJ_ACK    BIT(5)
  24 #define OPTION_MPTCP_ADD_ADDR   BIT(6)
  25 #define OPTION_MPTCP_RM_ADDR    BIT(7)
  26 #define OPTION_MPTCP_FASTCLOSE  BIT(8)
  27 #define OPTION_MPTCP_PRIO       BIT(9)
  28 #define OPTION_MPTCP_RST        BIT(10)
  29 #define OPTION_MPTCP_DSS        BIT(11)
  30 #define OPTION_MPTCP_FAIL       BIT(12)
  31
  32 #define OPTION_MPTCP_CSUMREQD   BIT(13)
  33
  34 #define OPTIONS_MPTCP_MPC       (OPTION_MPTCP_MPC_SYN | OPTION_MPTCP_MPC_SYNACK | \
  35                                  OPTION_MPTCP_MPC_ACK)
  36 #define OPTIONS_MPTCP_MPJ       (OPTION_MPTCP_MPJ_SYN | OPTION_MPTCP_MPJ_SYNACK | \
  37                                  OPTION_MPTCP_MPJ_ACK)
  38
  39 /* MPTCP option subtypes */
  40 #define MPTCPOPT_MP_CAPABLE     0
  41 #define MPTCPOPT_MP_JOIN        1
  42 #define MPTCPOPT_DSS            2
  43 #define MPTCPOPT_ADD_ADDR       3
  44 #define MPTCPOPT_RM_ADDR        4
  45 #define MPTCPOPT_MP_PRIO        5
  46 #define MPTCPOPT_MP_FAIL        6
  47 #define MPTCPOPT_MP_FASTCLOSE   7
  48 #define MPTCPOPT_RST            8
  49
  50 /* MPTCP suboption lengths */
  51 #define TCPOLEN_MPTCP_MPC_SYN           4
  52 #define TCPOLEN_MPTCP_MPC_SYNACK        12
  53 #define TCPOLEN_MPTCP_MPC_ACK           20
  54 #define TCPOLEN_MPTCP_MPC_ACK_DATA      22
  55 #define TCPOLEN_MPTCP_MPJ_SYN           12
  56 #define TCPOLEN_MPTCP_MPJ_SYNACK        16
  57 #define TCPOLEN_MPTCP_MPJ_ACK           24
  58 #define TCPOLEN_MPTCP_DSS_BASE          4
  59 #define TCPOLEN_MPTCP_DSS_ACK32         4
  60 #define TCPOLEN_MPTCP_DSS_ACK64         8
  61 #define TCPOLEN_MPTCP_DSS_MAP32         10
  62 #define TCPOLEN_MPTCP_DSS_MAP64         14
  63 #define TCPOLEN_MPTCP_DSS_CHECKSUM      2
  64 #define TCPOLEN_MPTCP_ADD_ADDR          16
  65 #define TCPOLEN_MPTCP_ADD_ADDR_PORT     18
  66 #define TCPOLEN_MPTCP_ADD_ADDR_BASE     8
  67 #define TCPOLEN_MPTCP_ADD_ADDR_BASE_PORT        10
  68 #define TCPOLEN_MPTCP_ADD_ADDR6         28
  69 #define TCPOLEN_MPTCP_ADD_ADDR6_PORT    30
  70 #define TCPOLEN_MPTCP_ADD_ADDR6_BASE    20
  71 #define TCPOLEN_MPTCP_ADD_ADDR6_BASE_PORT       22
  72 #define TCPOLEN_MPTCP_PORT_LEN          2
  73 #define TCPOLEN_MPTCP_PORT_ALIGN        2
  74 #define TCPOLEN_MPTCP_RM_ADDR_BASE      3
  75 #define TCPOLEN_MPTCP_PRIO              3
  76 #define TCPOLEN_MPTCP_PRIO_ALIGN        4
  77 #define TCPOLEN_MPTCP_FASTCLOSE         12
  78 #define TCPOLEN_MPTCP_RST               4
  79 #define TCPOLEN_MPTCP_FAIL              12
  80
  81 #define TCPOLEN_MPTCP_MPC_ACK_DATA_CSUM (TCPOLEN_MPTCP_DSS_CHECKSUM + TCPOLEN_MPTCP_MPC_ACK_DATA)
  82
  83 /* MPTCP MP_JOIN flags */
  84 #define MPTCPOPT_BACKUP         BIT(0)
  85 #define MPTCPOPT_HMAC_LEN       20
  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 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 #define MPTCP_PUSH_PENDING      6
 120 #define MPTCP_CLEAN_UNA         7
 121 #define MPTCP_ERROR_REPORT      8
 122 #define MPTCP_RETRANSMIT        9
 123 #define MPTCP_WORK_SYNC_SETSOCKOPT 10
 124 #define MPTCP_CONNECTED         11
 125
 126 static inline bool before64(__u64 seq1, __u64 seq2)
 127 {
 128         return (__s64)(seq1 - seq2) < 0;
 129 }
 130
 131 #define after64(seq2, seq1)     before64(seq1, seq2)
 132
 133 struct mptcp_options_received {
 134         u64     sndr_key;
 135         u64     rcvr_key;
 136         u64     data_ack;
 137         u64     data_seq;
 138         u32     subflow_seq;
 139         u16     data_len;
 140         __sum16 csum;
 141         u16     suboptions;
 142         u32     token;
 143         u32     nonce;
 144         u16     use_map:1,
 145                 dsn64:1,
 146                 data_fin:1,
 147                 use_ack:1,
 148                 ack64:1,
 149                 mpc_map:1,
 150                 reset_reason:4,
 151                 reset_transient:1,
 152                 echo:1,
 153                 backup:1,
 154                 deny_join_id0:1,
 155                 __unused:2;
 156         u8      join_id;
 157         u64     thmac;
 158         u8      hmac[MPTCPOPT_HMAC_LEN];
 159         struct mptcp_addr_info addr;
 160         struct mptcp_rm_list rm_list;
 161         u64     ahmac;
 162         u64     fail_seq;
 163 };
 164
 165 static inline __be32 mptcp_option(u8 subopt, u8 len, u8 nib, u8 field)
 166 {
 167         return htonl((TCPOPT_MPTCP << 24) | (len << 16) | (subopt << 12) |
 168                      ((nib & 0xF) << 8) | field);
 169 }
 170
 171 enum mptcp_pm_status {
 172         MPTCP_PM_ADD_ADDR_RECEIVED,
 173         MPTCP_PM_ADD_ADDR_SEND_ACK,
 174         MPTCP_PM_RM_ADDR_RECEIVED,
 175         MPTCP_PM_ESTABLISHED,
 176         MPTCP_PM_SUBFLOW_ESTABLISHED,
 177         MPTCP_PM_ALREADY_ESTABLISHED,   /* persistent status, set after ESTABLISHED event */
 178         MPTCP_PM_MPC_ENDPOINT_ACCOUNTED /* persistent status, set after MPC local address is
 179                                          * accounted int id_avail_bitmap
 180                                          */
 181 };
 182
 183 /* Status bits below MPTCP_PM_ALREADY_ESTABLISHED need pm worker actions */
 184 #define MPTCP_PM_WORK_MASK ((1 << MPTCP_PM_ALREADY_ESTABLISHED) - 1)
 185
 186 enum mptcp_addr_signal_status {
 187         MPTCP_ADD_ADDR_SIGNAL,
 188         MPTCP_ADD_ADDR_ECHO,
 189         MPTCP_RM_ADDR_SIGNAL,
 190 };
 191
 192 /* max value of mptcp_addr_info.id */
 193 #define MPTCP_PM_MAX_ADDR_ID            U8_MAX
 194
 195 struct mptcp_pm_data {
 196         struct mptcp_addr_info local;
 197         struct mptcp_addr_info remote;
 198         struct list_head anno_list;
 199
 200         spinlock_t      lock;           /*protects the whole PM data */
 201
 202         u8              addr_signal;
 203         bool            server_side;
 204         bool            work_pending;
 205         bool            accept_addr;
 206         bool            accept_subflow;
 207         bool            remote_deny_join_id0;
 208         u8              add_addr_signaled;
 209         u8              add_addr_accepted;
 210         u8              local_addr_used;
 211         u8              subflows;
 212         u8              status;
 213         DECLARE_BITMAP(id_avail_bitmap, MPTCP_PM_MAX_ADDR_ID + 1);
 214         struct mptcp_rm_list rm_list_tx;
 215         struct mptcp_rm_list rm_list_rx;
 216 };
 217
 218 struct mptcp_data_frag {
 219         struct list_head list;
 220         u64 data_seq;
 221         u16 data_len;
 222         u16 offset;
 223         u16 overhead;
 224         u16 already_sent;
 225         struct page *page;
 226 };
 227
 228 /* MPTCP connection sock */
 229 struct mptcp_sock {
 230         /* inet_connection_sock must be the first member */
 231         struct inet_connection_sock sk;
 232         u64             local_key;
 233         u64             remote_key;
 234         u64             write_seq;
 235         u64             snd_nxt;
 236         u64             ack_seq;
 237         u64             rcv_wnd_sent;
 238         u64             rcv_data_fin_seq;
 239         int             rmem_fwd_alloc;
 240         struct sock     *last_snd;
 241         int             snd_burst;
 242         int             old_wspace;
 243         u64             recovery_snd_nxt;       /* in recovery mode accept up to this seq;
 244                                                  * recovery related fields are under data_lock
 245                                                  * protection
 246                                                  */
 247         u64             snd_una;
 248         u64             wnd_end;
 249         unsigned long   timer_ival;
 250         u32             token;
 251         int             rmem_released;
 252         unsigned long   flags;
 253         bool            recovery;               /* closing subflow write queue reinjected */
 254         bool            can_ack;
 255         bool            fully_established;
 256         bool            rcv_data_fin;
 257         bool            snd_data_fin_enable;
 258         bool            rcv_fastclose;
 259         bool            use_64bit_ack; /* Set when we received a 64-bit DSN */
 260         bool            csum_enabled;
 261         u8              recvmsg_inq:1,
 262                         cork:1,
 263                         nodelay:1;
 264         spinlock_t      join_list_lock;
 265         struct work_struct work;
 266         struct sk_buff  *ooo_last_skb;
 267         struct rb_root  out_of_order_queue;
 268         struct sk_buff_head receive_queue;
 269         struct list_head conn_list;
 270         struct list_head rtx_queue;
 271         struct mptcp_data_frag *first_pending;
 272         struct list_head join_list;
 273         struct socket   *subflow; /* outgoing connect/listener/!mp_capable */
 274         struct sock     *first;
 275         struct mptcp_pm_data    pm;
 276         struct {
 277                 u32     space;  /* bytes copied in last measurement window */
 278                 u32     copied; /* bytes copied in this measurement window */
 279                 u64     time;   /* start time of measurement window */
 280                 u64     rtt_us; /* last maximum rtt of subflows */
 281         } rcvq_space;
 282
 283         u32 setsockopt_seq;
 284         char            ca_name[TCP_CA_NAME_MAX];
 285 };
 286
 287 #define mptcp_data_lock(sk) spin_lock_bh(&(sk)->sk_lock.slock)
 288 #define mptcp_data_unlock(sk) spin_unlock_bh(&(sk)->sk_lock.slock)
 289
 290 #define mptcp_for_each_subflow(__msk, __subflow)                        \
 291         list_for_each_entry(__subflow, &((__msk)->conn_list), node)
 292
 293 static inline void msk_owned_by_me(const struct mptcp_sock *msk)
 294 {
 295         sock_owned_by_me((const struct sock *)msk);
 296 }
 297
 298 static inline struct mptcp_sock *mptcp_sk(const struct sock *sk)
 299 {
 300         return (struct mptcp_sock *)sk;
 301 }
 302
 303 /* the msk socket don't use the backlog, also account for the bulk
 304  * free memory
 305  */
 306 static inline int __mptcp_rmem(const struct sock *sk)
 307 {
 308         return atomic_read(&sk->sk_rmem_alloc) - READ_ONCE(mptcp_sk(sk)->rmem_released);
 309 }
 310
 311 static inline int __mptcp_space(const struct sock *sk)
 312 {
 313         return tcp_win_from_space(sk, READ_ONCE(sk->sk_rcvbuf) - __mptcp_rmem(sk));
 314 }
 315
 316 static inline struct mptcp_data_frag *mptcp_send_head(const struct sock *sk)
 317 {
 318         const struct mptcp_sock *msk = mptcp_sk(sk);
 319
 320         return READ_ONCE(msk->first_pending);
 321 }
 322
 323 static inline struct mptcp_data_frag *mptcp_send_next(struct sock *sk)
 324 {
 325         struct mptcp_sock *msk = mptcp_sk(sk);
 326         struct mptcp_data_frag *cur;
 327
 328         cur = msk->first_pending;
 329         return list_is_last(&cur->list, &msk->rtx_queue) ? NULL :
 330                                                      list_next_entry(cur, list);
 331 }
 332
 333 static inline struct mptcp_data_frag *mptcp_pending_tail(const struct sock *sk)
 334 {
 335         struct mptcp_sock *msk = mptcp_sk(sk);
 336
 337         if (!msk->first_pending)
 338                 return NULL;
 339
 340         if (WARN_ON_ONCE(list_empty(&msk->rtx_queue)))
 341                 return NULL;
 342
 343         return list_last_entry(&msk->rtx_queue, struct mptcp_data_frag, list);
 344 }
 345
 346 static inline struct mptcp_data_frag *mptcp_rtx_head(const struct sock *sk)
 347 {
 348         struct mptcp_sock *msk = mptcp_sk(sk);
 349
 350         if (msk->snd_una == READ_ONCE(msk->snd_nxt))
 351                 return NULL;
 352
 353         return list_first_entry_or_null(&msk->rtx_queue, struct mptcp_data_frag, list);
 354 }
 355
 356 struct csum_pseudo_header {
 357         __be64 data_seq;
 358         __be32 subflow_seq;
 359         __be16 data_len;
 360         __sum16 csum;
 361 };
 362
 363 struct mptcp_subflow_request_sock {
 364         struct  tcp_request_sock sk;
 365         u16     mp_capable : 1,
 366                 mp_join : 1,
 367                 backup : 1,
 368                 csum_reqd : 1,
 369                 allow_join_id0 : 1;
 370         u8      local_id;
 371         u8      remote_id;
 372         u64     local_key;
 373         u64     idsn;
 374         u32     token;
 375         u32     ssn_offset;
 376         u64     thmac;
 377         u32     local_nonce;
 378         u32     remote_nonce;
 379         struct mptcp_sock       *msk;
 380         struct hlist_nulls_node token_node;
 381 };
 382
 383 static inline struct mptcp_subflow_request_sock *
 384 mptcp_subflow_rsk(const struct request_sock *rsk)
 385 {
 386         return (struct mptcp_subflow_request_sock *)rsk;
 387 }
 388
 389 enum mptcp_data_avail {
 390         MPTCP_SUBFLOW_NODATA,
 391         MPTCP_SUBFLOW_DATA_AVAIL,
 392 };
 393
 394 struct mptcp_delegated_action {
 395         struct napi_struct napi;
 396         struct list_head head;
 397 };
 398
 399 DECLARE_PER_CPU(struct mptcp_delegated_action, mptcp_delegated_actions);
 400
 401 #define MPTCP_DELEGATE_SEND             0
 402 #define MPTCP_DELEGATE_ACK              1
 403
 404 /* MPTCP subflow context */
 405 struct mptcp_subflow_context {
 406         struct  list_head node;/* conn_list of subflows */
 407
 408         char    reset_start[0];
 409
 410         unsigned long avg_pacing_rate; /* protected by msk socket lock */
 411         u64     local_key;
 412         u64     remote_key;
 413         u64     idsn;
 414         u64     map_seq;
 415         u32     snd_isn;
 416         u32     token;
 417         u32     rel_write_seq;
 418         u32     map_subflow_seq;
 419         u32     ssn_offset;
 420         u32     map_data_len;
 421         __wsum  map_data_csum;
 422         u32     map_csum_len;
 423         u32     request_mptcp : 1,  /* send MP_CAPABLE */
 424                 request_join : 1,   /* send MP_JOIN */
 425                 request_bkup : 1,
 426                 mp_capable : 1,     /* remote is MPTCP capable */
 427                 mp_join : 1,        /* remote is JOINing */
 428                 fully_established : 1,      /* path validated */
 429                 pm_notified : 1,    /* PM hook called for established status */
 430                 conn_finished : 1,
 431                 map_valid : 1,
 432                 map_csum_reqd : 1,
 433                 map_data_fin : 1,
 434                 mpc_map : 1,
 435                 backup : 1,
 436                 send_mp_prio : 1,
 437                 send_mp_fail : 1,
 438                 send_fastclose : 1,
 439                 rx_eof : 1,
 440                 can_ack : 1,        /* only after processing the remote a key */
 441                 disposable : 1,     /* ctx can be free at ulp release time */
 442                 stale : 1;          /* unable to snd/rcv data, do not use for xmit */
 443         enum mptcp_data_avail data_avail;
 444         u32     remote_nonce;
 445         u64     thmac;
 446         u32     local_nonce;
 447         u32     remote_token;
 448         u8      hmac[MPTCPOPT_HMAC_LEN];
 449         u8      local_id;
 450         u8      remote_id;
 451         u8      reset_seen:1;
 452         u8      reset_transient:1;
 453         u8      reset_reason:4;
 454         u8      stale_count;
 455
 456         long    delegated_status;
 457
 458         char    reset_end[0];
 459
 460         struct  list_head delegated_node;   /* link into delegated_action, protected by local BH */
 461
 462         u32     setsockopt_seq;
 463         u32     stale_rcv_tstamp;
 464
 465         struct  sock *tcp_sock;     /* tcp sk backpointer */
 466         struct  sock *conn;         /* parent mptcp_sock */
 467         const   struct inet_connection_sock_af_ops *icsk_af_ops;
 468         void    (*tcp_data_ready)(struct sock *sk);
 469         void    (*tcp_state_change)(struct sock *sk);
 470         void    (*tcp_write_space)(struct sock *sk);
 471         void    (*tcp_error_report)(struct sock *sk);
 472
 473         struct  rcu_head rcu;
 474 };
 475
 476 static inline struct mptcp_subflow_context *
 477 mptcp_subflow_ctx(const struct sock *sk)
 478 {
 479         struct inet_connection_sock *icsk = inet_csk(sk);
 480
 481         /* Use RCU on icsk_ulp_data only for sock diag code */
 482         return (__force struct mptcp_subflow_context *)icsk->icsk_ulp_data;
 483 }
 484
 485 static inline struct sock *
 486 mptcp_subflow_tcp_sock(const struct mptcp_subflow_context *subflow)
 487 {
 488         return subflow->tcp_sock;
 489 }
 490
 491 static inline void
 492 mptcp_subflow_ctx_reset(struct mptcp_subflow_context *subflow)
 493 {
 494         memset(subflow->reset_start, 0, subflow->reset_end - subflow->reset_start);
 495         subflow->request_mptcp = 1;
 496 }
 497
 498 static inline u64
 499 mptcp_subflow_get_map_offset(const struct mptcp_subflow_context *subflow)
 500 {
 501         return tcp_sk(mptcp_subflow_tcp_sock(subflow))->copied_seq -
 502                       subflow->ssn_offset -
 503                       subflow->map_subflow_seq;
 504 }
 505
 506 static inline u64
 507 mptcp_subflow_get_mapped_dsn(const struct mptcp_subflow_context *subflow)
 508 {
 509         return subflow->map_seq + mptcp_subflow_get_map_offset(subflow);
 510 }
 511
 512 static inline void mptcp_add_pending_subflow(struct mptcp_sock *msk,
 513                                              struct mptcp_subflow_context *subflow)
 514 {
 515         sock_hold(mptcp_subflow_tcp_sock(subflow));
 516         spin_lock_bh(&msk->join_list_lock);
 517         list_add_tail(&subflow->node, &msk->join_list);
 518         spin_unlock_bh(&msk->join_list_lock);
 519 }
 520
 521 void mptcp_subflow_process_delegated(struct sock *ssk);
 522
 523 static inline void mptcp_subflow_delegate(struct mptcp_subflow_context *subflow, int action)
 524 {
 525         struct mptcp_delegated_action *delegated;
 526         bool schedule;
 527
 528         /* the caller held the subflow bh socket lock */
 529         lockdep_assert_in_softirq();
 530
 531         /* The implied barrier pairs with mptcp_subflow_delegated_done(), and
 532          * ensures the below list check sees list updates done prior to status
 533          * bit changes
 534          */
 535         if (!test_and_set_bit(action, &subflow->delegated_status)) {
 536                 /* still on delegated list from previous scheduling */
 537                 if (!list_empty(&subflow->delegated_node))
 538                         return;
 539
 540                 delegated = this_cpu_ptr(&mptcp_delegated_actions);
 541                 schedule = list_empty(&delegated->head);
 542                 list_add_tail(&subflow->delegated_node, &delegated->head);
 543                 sock_hold(mptcp_subflow_tcp_sock(subflow));
 544                 if (schedule)
 545                         napi_schedule(&delegated->napi);
 546         }
 547 }
 548
 549 static inline struct mptcp_subflow_context *
 550 mptcp_subflow_delegated_next(struct mptcp_delegated_action *delegated)
 551 {
 552         struct mptcp_subflow_context *ret;
 553
 554         if (list_empty(&delegated->head))
 555                 return NULL;
 556
 557         ret = list_first_entry(&delegated->head, struct mptcp_subflow_context, delegated_node);
 558         list_del_init(&ret->delegated_node);
 559         return ret;
 560 }
 561
 562 static inline bool mptcp_subflow_has_delegated_action(const struct mptcp_subflow_context *subflow)
 563 {
 564         return !!READ_ONCE(subflow->delegated_status);
 565 }
 566
 567 static inline void mptcp_subflow_delegated_done(struct mptcp_subflow_context *subflow, int action)
 568 {
 569         /* pairs with mptcp_subflow_delegate, ensures delegate_node is updated before
 570          * touching the status bit
 571          */
 572         smp_wmb();
 573         clear_bit(action, &subflow->delegated_status);
 574 }
 575
 576 int mptcp_is_enabled(const struct net *net);
 577 unsigned int mptcp_get_add_addr_timeout(const struct net *net);
 578 int mptcp_is_checksum_enabled(const struct net *net);
 579 int mptcp_allow_join_id0(const struct net *net);
 580 unsigned int mptcp_stale_loss_cnt(const struct net *net);
 581 void mptcp_subflow_fully_established(struct mptcp_subflow_context *subflow,
 582                                      struct mptcp_options_received *mp_opt);
 583 bool __mptcp_retransmit_pending_data(struct sock *sk);
 584 void mptcp_check_and_set_pending(struct sock *sk);
 585 void __mptcp_push_pending(struct sock *sk, unsigned int flags);
 586 bool mptcp_subflow_data_available(struct sock *sk);
 587 void __init mptcp_subflow_init(void);
 588 void mptcp_subflow_shutdown(struct sock *sk, struct sock *ssk, int how);
 589 void mptcp_close_ssk(struct sock *sk, struct sock *ssk,
 590                      struct mptcp_subflow_context *subflow);
 591 void mptcp_subflow_send_ack(struct sock *ssk);
 592 void mptcp_subflow_reset(struct sock *ssk);
 593 void mptcp_sock_graft(struct sock *sk, struct socket *parent);
 594 struct socket *__mptcp_nmpc_socket(const struct mptcp_sock *msk);
 595
 596 /* called with sk socket lock held */
 597 int __mptcp_subflow_connect(struct sock *sk, const struct mptcp_addr_info *loc,
 598                             const struct mptcp_addr_info *remote);
 599 int mptcp_subflow_create_socket(struct sock *sk, struct socket **new_sock);
 600 void mptcp_info2sockaddr(const struct mptcp_addr_info *info,
 601                          struct sockaddr_storage *addr,
 602                          unsigned short family);
 603
 604 static inline bool __mptcp_subflow_active(struct mptcp_subflow_context *subflow)
 605 {
 606         struct sock *ssk = mptcp_subflow_tcp_sock(subflow);
 607
 608         /* can't send if JOIN hasn't completed yet (i.e. is usable for mptcp) */
 609         if (subflow->request_join && !subflow->fully_established)
 610                 return false;
 611
 612         /* only send if our side has not closed yet */
 613         return ((1 << ssk->sk_state) & (TCPF_ESTABLISHED | TCPF_CLOSE_WAIT));
 614 }
 615
 616 void mptcp_subflow_set_active(struct mptcp_subflow_context *subflow);
 617
 618 bool mptcp_subflow_active(struct mptcp_subflow_context *subflow);
 619
 620 static inline void mptcp_subflow_tcp_fallback(struct sock *sk,
 621                                               struct mptcp_subflow_context *ctx)
 622 {
 623         sk->sk_data_ready = ctx->tcp_data_ready;
 624         sk->sk_state_change = ctx->tcp_state_change;
 625         sk->sk_write_space = ctx->tcp_write_space;
 626         sk->sk_error_report = ctx->tcp_error_report;
 627
 628         inet_csk(sk)->icsk_af_ops = ctx->icsk_af_ops;
 629 }
 630
 631 static inline bool mptcp_has_another_subflow(struct sock *ssk)
 632 {
 633         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(ssk), *tmp;
 634         struct mptcp_sock *msk = mptcp_sk(subflow->conn);
 635
 636         mptcp_for_each_subflow(msk, tmp) {
 637                 if (tmp != subflow)
 638                         return true;
 639         }
 640
 641         return false;
 642 }
 643
 644 void __init mptcp_proto_init(void);
 645 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
 646 int __init mptcp_proto_v6_init(void);
 647 #endif
 648
 649 struct sock *mptcp_sk_clone(const struct sock *sk,
 650                             const struct mptcp_options_received *mp_opt,
 651                             struct request_sock *req);
 652 void mptcp_get_options(const struct sock *sk,
 653                        const struct sk_buff *skb,
 654                        struct mptcp_options_received *mp_opt);
 655
 656 void mptcp_finish_connect(struct sock *sk);
 657 void __mptcp_set_connected(struct sock *sk);
 658 static inline bool mptcp_is_fully_established(struct sock *sk)
 659 {
 660         return inet_sk_state_load(sk) == TCP_ESTABLISHED &&
 661                READ_ONCE(mptcp_sk(sk)->fully_established);
 662 }
 663 void mptcp_rcv_space_init(struct mptcp_sock *msk, const struct sock *ssk);
 664 void mptcp_data_ready(struct sock *sk, struct sock *ssk);
 665 bool mptcp_finish_join(struct sock *sk);
 666 bool mptcp_schedule_work(struct sock *sk);
 667 int mptcp_setsockopt(struct sock *sk, int level, int optname,
 668                      sockptr_t optval, unsigned int optlen);
 669 int mptcp_getsockopt(struct sock *sk, int level, int optname,
 670                      char __user *optval, int __user *option);
 671
 672 u64 __mptcp_expand_seq(u64 old_seq, u64 cur_seq);
 673 static inline u64 mptcp_expand_seq(u64 old_seq, u64 cur_seq, bool use_64bit)
 674 {
 675         if (use_64bit)
 676                 return cur_seq;
 677
 678         return __mptcp_expand_seq(old_seq, cur_seq);
 679 }
 680 void __mptcp_check_push(struct sock *sk, struct sock *ssk);
 681 void __mptcp_data_acked(struct sock *sk);
 682 void __mptcp_error_report(struct sock *sk);
 683 void mptcp_subflow_eof(struct sock *sk);
 684 bool mptcp_update_rcv_data_fin(struct mptcp_sock *msk, u64 data_fin_seq, bool use_64bit);
 685 void __mptcp_flush_join_list(struct mptcp_sock *msk);
 686 static inline bool mptcp_data_fin_enabled(const struct mptcp_sock *msk)
 687 {
 688         return READ_ONCE(msk->snd_data_fin_enable) &&
 689                READ_ONCE(msk->write_seq) == READ_ONCE(msk->snd_nxt);
 690 }
 691
 692 static inline bool mptcp_propagate_sndbuf(struct sock *sk, struct sock *ssk)
 693 {
 694         if ((sk->sk_userlocks & SOCK_SNDBUF_LOCK) || ssk->sk_sndbuf <= READ_ONCE(sk->sk_sndbuf))
 695                 return false;
 696
 697         WRITE_ONCE(sk->sk_sndbuf, ssk->sk_sndbuf);
 698         return true;
 699 }
 700
 701 static inline void mptcp_write_space(struct sock *sk)
 702 {
 703         if (sk_stream_is_writeable(sk)) {
 704                 /* pairs with memory barrier in mptcp_poll */
 705                 smp_mb();
 706                 if (test_and_clear_bit(MPTCP_NOSPACE, &mptcp_sk(sk)->flags))
 707                         sk_stream_write_space(sk);
 708         }
 709 }
 710
 711 void mptcp_destroy_common(struct mptcp_sock *msk);
 712
 713 #define MPTCP_TOKEN_MAX_RETRIES 4
 714
 715 void __init mptcp_token_init(void);
 716 static inline void mptcp_token_init_request(struct request_sock *req)
 717 {
 718         mptcp_subflow_rsk(req)->token_node.pprev = NULL;
 719 }
 720
 721 int mptcp_token_new_request(struct request_sock *req);
 722 void mptcp_token_destroy_request(struct request_sock *req);
 723 int mptcp_token_new_connect(struct sock *sk);
 724 void mptcp_token_accept(struct mptcp_subflow_request_sock *r,
 725                         struct mptcp_sock *msk);
 726 bool mptcp_token_exists(u32 token);
 727 struct mptcp_sock *mptcp_token_get_sock(struct net *net, u32 token);
 728 struct mptcp_sock *mptcp_token_iter_next(const struct net *net, long *s_slot,
 729                                          long *s_num);
 730 void mptcp_token_destroy(struct mptcp_sock *msk);
 731
 732 void mptcp_crypto_key_sha(u64 key, u32 *token, u64 *idsn);
 733
 734 void mptcp_crypto_hmac_sha(u64 key1, u64 key2, u8 *msg, int len, void *hmac);
 735
 736 void __init mptcp_pm_init(void);
 737 void mptcp_pm_data_init(struct mptcp_sock *msk);
 738 void mptcp_pm_data_reset(struct mptcp_sock *msk);
 739 void mptcp_pm_subflow_chk_stale(const struct mptcp_sock *msk, struct sock *ssk);
 740 void mptcp_pm_nl_subflow_chk_stale(const struct mptcp_sock *msk, struct sock *ssk);
 741 void mptcp_pm_new_connection(struct mptcp_sock *msk, const struct sock *ssk, int server_side);
 742 void mptcp_pm_fully_established(struct mptcp_sock *msk, const struct sock *ssk, gfp_t gfp);
 743 bool mptcp_pm_allow_new_subflow(struct mptcp_sock *msk);
 744 void mptcp_pm_connection_closed(struct mptcp_sock *msk);
 745 void mptcp_pm_subflow_established(struct mptcp_sock *msk);
 746 void mptcp_pm_subflow_closed(struct mptcp_sock *msk, u8 id);
 747 void mptcp_pm_add_addr_received(struct mptcp_sock *msk,
 748                                 const struct mptcp_addr_info *addr);
 749 void mptcp_pm_add_addr_echoed(struct mptcp_sock *msk,
 750                               struct mptcp_addr_info *addr);
 751 void mptcp_pm_add_addr_send_ack(struct mptcp_sock *msk);
 752 void mptcp_pm_nl_addr_send_ack(struct mptcp_sock *msk);
 753 void mptcp_pm_rm_addr_received(struct mptcp_sock *msk,
 754                                const struct mptcp_rm_list *rm_list);
 755 void mptcp_pm_mp_prio_received(struct sock *sk, u8 bkup);
 756 void mptcp_pm_mp_fail_received(struct sock *sk, u64 fail_seq);
 757 void mptcp_pm_free_anno_list(struct mptcp_sock *msk);
 758 bool mptcp_pm_sport_in_anno_list(struct mptcp_sock *msk, const struct sock *sk);
 759 struct mptcp_pm_add_entry *
 760 mptcp_pm_del_add_timer(struct mptcp_sock *msk,
 761                        struct mptcp_addr_info *addr, bool check_id);
 762 struct mptcp_pm_add_entry *
 763 mptcp_lookup_anno_list_by_saddr(struct mptcp_sock *msk,
 764                                 struct mptcp_addr_info *addr);
 765 int mptcp_pm_get_flags_and_ifindex_by_id(struct net *net, unsigned int id,
 766                                          u8 *flags, int *ifindex);
 767
 768 int mptcp_pm_announce_addr(struct mptcp_sock *msk,
 769                            const struct mptcp_addr_info *addr,
 770                            bool echo);
 771 int mptcp_pm_remove_addr(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
 772 int mptcp_pm_remove_subflow(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
 773
 774 void mptcp_event(enum mptcp_event_type type, const struct mptcp_sock *msk,
 775                  const struct sock *ssk, gfp_t gfp);
 776 void mptcp_event_addr_announced(const struct mptcp_sock *msk, const struct mptcp_addr_info *info);
 777 void mptcp_event_addr_removed(const struct mptcp_sock *msk, u8 id);
 778
 779 static inline bool mptcp_pm_should_add_signal(struct mptcp_sock *msk)
 780 {
 781         return READ_ONCE(msk->pm.addr_signal) &
 782                 (BIT(MPTCP_ADD_ADDR_SIGNAL) | BIT(MPTCP_ADD_ADDR_ECHO));
 783 }
 784
 785 static inline bool mptcp_pm_should_add_signal_addr(struct mptcp_sock *msk)
 786 {
 787         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_SIGNAL);
 788 }
 789
 790 static inline bool mptcp_pm_should_add_signal_echo(struct mptcp_sock *msk)
 791 {
 792         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_ECHO);
 793 }
 794
 795 static inline bool mptcp_pm_should_rm_signal(struct mptcp_sock *msk)
 796 {
 797         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_RM_ADDR_SIGNAL);
 798 }
 799
 800 static inline unsigned int mptcp_add_addr_len(int family, bool echo, bool port)
 801 {
 802         u8 len = TCPOLEN_MPTCP_ADD_ADDR_BASE;
 803
 804         if (family == AF_INET6)
 805                 len = TCPOLEN_MPTCP_ADD_ADDR6_BASE;
 806         if (!echo)
 807                 len += MPTCPOPT_THMAC_LEN;
 808         /* account for 2 trailing 'nop' options */
 809         if (port)
 810                 len += TCPOLEN_MPTCP_PORT_LEN + TCPOLEN_MPTCP_PORT_ALIGN;
 811
 812         return len;
 813 }
 814
 815 static inline int mptcp_rm_addr_len(const struct mptcp_rm_list *rm_list)
 816 {
 817         if (rm_list->nr == 0 || rm_list->nr > MPTCP_RM_IDS_MAX)
 818                 return -EINVAL;
 819
 820         return TCPOLEN_MPTCP_RM_ADDR_BASE + roundup(rm_list->nr - 1, 4) + 1;
 821 }
 822
 823 bool mptcp_pm_add_addr_signal(struct mptcp_sock *msk, struct sk_buff *skb,
 824                               unsigned int opt_size, unsigned int remaining,
 825                               struct mptcp_addr_info *addr, bool *echo,
 826                               bool *port, bool *drop_other_suboptions);
 827 bool mptcp_pm_rm_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
 828                              struct mptcp_rm_list *rm_list);
 829 int mptcp_pm_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
 830
 831 void __init mptcp_pm_nl_init(void);
 832 void mptcp_pm_nl_data_init(struct mptcp_sock *msk);
 833 void mptcp_pm_nl_work(struct mptcp_sock *msk);
 834 void mptcp_pm_nl_rm_subflow_received(struct mptcp_sock *msk,
 835                                      const struct mptcp_rm_list *rm_list);
 836 int mptcp_pm_nl_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
 837 unsigned int mptcp_pm_get_add_addr_signal_max(struct mptcp_sock *msk);
 838 unsigned int mptcp_pm_get_add_addr_accept_max(struct mptcp_sock *msk);
 839 unsigned int mptcp_pm_get_subflows_max(struct mptcp_sock *msk);
 840 unsigned int mptcp_pm_get_local_addr_max(struct mptcp_sock *msk);
 841
 842 void mptcp_sockopt_sync(struct mptcp_sock *msk, struct sock *ssk);
 843 void mptcp_sockopt_sync_all(struct mptcp_sock *msk);
 844
 845 static inline struct mptcp_ext *mptcp_get_ext(const struct sk_buff *skb)
 846 {
 847         return (struct mptcp_ext *)skb_ext_find(skb, SKB_EXT_MPTCP);
 848 }
 849
 850 void mptcp_diag_subflow_init(struct tcp_ulp_ops *ops);
 851
 852 static inline bool __mptcp_check_fallback(const struct mptcp_sock *msk)
 853 {
 854         return test_bit(MPTCP_FALLBACK_DONE, &msk->flags);
 855 }
 856
 857 static inline bool mptcp_check_fallback(const struct sock *sk)
 858 {
 859         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
 860         struct mptcp_sock *msk = mptcp_sk(subflow->conn);
 861
 862         return __mptcp_check_fallback(msk);
 863 }
 864
 865 static inline void __mptcp_do_fallback(struct mptcp_sock *msk)
 866 {
 867         if (test_bit(MPTCP_FALLBACK_DONE, &msk->flags)) {
 868                 pr_debug("TCP fallback already done (msk=%p)", msk);
 869                 return;
 870         }
 871         set_bit(MPTCP_FALLBACK_DONE, &msk->flags);
 872 }
 873
 874 static inline void mptcp_do_fallback(struct sock *sk)
 875 {
 876         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
 877         struct mptcp_sock *msk = mptcp_sk(subflow->conn);
 878
 879         __mptcp_do_fallback(msk);
 880 }
 881
 882 #define pr_fallback(a) pr_debug("%s:fallback to TCP (msk=%p)", __func__, a)
 883
 884 static inline bool subflow_simultaneous_connect(struct sock *sk)
 885 {
 886         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
 887         struct sock *parent = subflow->conn;
 888
 889         return sk->sk_state == TCP_ESTABLISHED &&
 890                !mptcp_sk(parent)->pm.server_side &&
 891                !subflow->conn_finished;
 892 }
 893
 894 #ifdef CONFIG_SYN_COOKIES
 895 void subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
 896                                        struct sk_buff *skb);
 897 bool mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
 898                                         struct sk_buff *skb);
 899 void __init mptcp_join_cookie_init(void);
 900 #else
 901 static inline void
 902 subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
 903                                   struct sk_buff *skb) {}
 904 static inline bool
 905 mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
 906                                    struct sk_buff *skb)
 907 {
 908         return false;
 909 }
 910
 911 static inline void mptcp_join_cookie_init(void) {}
 912 #endif
 913
 914 #endif /* __MPTCP_PROTOCOL_H */