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
  30 /* MPTCP option subtypes */
  31 #define MPTCPOPT_MP_CAPABLE     0
  32 #define MPTCPOPT_MP_JOIN        1
  33 #define MPTCPOPT_DSS            2
  34 #define MPTCPOPT_ADD_ADDR       3
  35 #define MPTCPOPT_RM_ADDR        4
  36 #define MPTCPOPT_MP_PRIO        5
  37 #define MPTCPOPT_MP_FAIL        6
  38 #define MPTCPOPT_MP_FASTCLOSE   7
  39 #define MPTCPOPT_RST            8
  40
  41 /* MPTCP suboption lengths */
  42 #define TCPOLEN_MPTCP_MPC_SYN           4
  43 #define TCPOLEN_MPTCP_MPC_SYNACK        12
  44 #define TCPOLEN_MPTCP_MPC_ACK           20
  45 #define TCPOLEN_MPTCP_MPC_ACK_DATA      22
  46 #define TCPOLEN_MPTCP_MPJ_SYN           12
  47 #define TCPOLEN_MPTCP_MPJ_SYNACK        16
  48 #define TCPOLEN_MPTCP_MPJ_ACK           24
  49 #define TCPOLEN_MPTCP_DSS_BASE          4
  50 #define TCPOLEN_MPTCP_DSS_ACK32         4
  51 #define TCPOLEN_MPTCP_DSS_ACK64         8
  52 #define TCPOLEN_MPTCP_DSS_MAP32         10
  53 #define TCPOLEN_MPTCP_DSS_MAP64         14
  54 #define TCPOLEN_MPTCP_DSS_CHECKSUM      2
  55 #define TCPOLEN_MPTCP_ADD_ADDR          16
  56 #define TCPOLEN_MPTCP_ADD_ADDR_PORT     18
  57 #define TCPOLEN_MPTCP_ADD_ADDR_BASE     8
  58 #define TCPOLEN_MPTCP_ADD_ADDR_BASE_PORT        10
  59 #define TCPOLEN_MPTCP_ADD_ADDR6         28
  60 #define TCPOLEN_MPTCP_ADD_ADDR6_PORT    30
  61 #define TCPOLEN_MPTCP_ADD_ADDR6_BASE    20
  62 #define TCPOLEN_MPTCP_ADD_ADDR6_BASE_PORT       22
  63 #define TCPOLEN_MPTCP_PORT_LEN          2
  64 #define TCPOLEN_MPTCP_PORT_ALIGN        2
  65 #define TCPOLEN_MPTCP_RM_ADDR_BASE      3
  66 #define TCPOLEN_MPTCP_PRIO              3
  67 #define TCPOLEN_MPTCP_PRIO_ALIGN        4
  68 #define TCPOLEN_MPTCP_FASTCLOSE         12
  69 #define TCPOLEN_MPTCP_RST               4
  70
  71 /* MPTCP MP_JOIN flags */
  72 #define MPTCPOPT_BACKUP         BIT(0)
  73 #define MPTCPOPT_HMAC_LEN       20
  74 #define MPTCPOPT_THMAC_LEN      8
  75
  76 /* MPTCP MP_CAPABLE flags */
  77 #define MPTCP_VERSION_MASK      (0x0F)
  78 #define MPTCP_CAP_CHECKSUM_REQD BIT(7)
  79 #define MPTCP_CAP_EXTENSIBILITY BIT(6)
  80 #define MPTCP_CAP_HMAC_SHA256   BIT(0)
  81 #define MPTCP_CAP_FLAG_MASK     (0x3F)
  82
  83 /* MPTCP DSS flags */
  84 #define MPTCP_DSS_DATA_FIN      BIT(4)
  85 #define MPTCP_DSS_DSN64         BIT(3)
  86 #define MPTCP_DSS_HAS_MAP       BIT(2)
  87 #define MPTCP_DSS_ACK64         BIT(1)
  88 #define MPTCP_DSS_HAS_ACK       BIT(0)
  89 #define MPTCP_DSS_FLAG_MASK     (0x1F)
  90
  91 /* MPTCP ADD_ADDR flags */
  92 #define MPTCP_ADDR_ECHO         BIT(0)
  93
  94 /* MPTCP MP_PRIO flags */
  95 #define MPTCP_PRIO_BKUP         BIT(0)
  96
  97 /* MPTCP TCPRST flags */
  98 #define MPTCP_RST_TRANSIENT     BIT(0)
  99
 100 /* MPTCP socket flags */
 101 #define MPTCP_DATA_READY        0
 102 #define MPTCP_NOSPACE           1
 103 #define MPTCP_WORK_RTX          2
 104 #define MPTCP_WORK_EOF          3
 105 #define MPTCP_FALLBACK_DONE     4
 106 #define MPTCP_WORK_CLOSE_SUBFLOW 5
 107 #define MPTCP_PUSH_PENDING      6
 108 #define MPTCP_CLEAN_UNA         7
 109 #define MPTCP_ERROR_REPORT      8
 110 #define MPTCP_RETRANSMIT        9
 111
 112 static inline bool before64(__u64 seq1, __u64 seq2)
 113 {
 114         return (__s64)(seq1 - seq2) < 0;
 115 }
 116
 117 #define after64(seq2, seq1)     before64(seq1, seq2)
 118
 119 struct mptcp_options_received {
 120         u64     sndr_key;
 121         u64     rcvr_key;
 122         u64     data_ack;
 123         u64     data_seq;
 124         u32     subflow_seq;
 125         u16     data_len;
 126         u16     mp_capable : 1,
 127                 mp_join : 1,
 128                 fastclose : 1,
 129                 reset : 1,
 130                 dss : 1,
 131                 add_addr : 1,
 132                 rm_addr : 1,
 133                 mp_prio : 1,
 134                 echo : 1,
 135                 backup : 1;
 136         u32     token;
 137         u32     nonce;
 138         u64     thmac;
 139         u8      hmac[MPTCPOPT_HMAC_LEN];
 140         u8      join_id;
 141         u8      use_map:1,
 142                 dsn64:1,
 143                 data_fin:1,
 144                 use_ack:1,
 145                 ack64:1,
 146                 mpc_map:1,
 147                 __unused:2;
 148         struct mptcp_addr_info addr;
 149         struct mptcp_rm_list rm_list;
 150         u64     ahmac;
 151         u8      reset_reason:4;
 152         u8      reset_transient:1;
 153 };
 154
 155 static inline __be32 mptcp_option(u8 subopt, u8 len, u8 nib, u8 field)
 156 {
 157         return htonl((TCPOPT_MPTCP << 24) | (len << 16) | (subopt << 12) |
 158                      ((nib & 0xF) << 8) | field);
 159 }
 160
 161 enum mptcp_pm_status {
 162         MPTCP_PM_ADD_ADDR_RECEIVED,
 163         MPTCP_PM_ADD_ADDR_SEND_ACK,
 164         MPTCP_PM_RM_ADDR_RECEIVED,
 165         MPTCP_PM_ESTABLISHED,
 166         MPTCP_PM_ALREADY_ESTABLISHED,   /* persistent status, set after ESTABLISHED event */
 167         MPTCP_PM_SUBFLOW_ESTABLISHED,
 168 };
 169
 170 enum mptcp_addr_signal_status {
 171         MPTCP_ADD_ADDR_SIGNAL,
 172         MPTCP_ADD_ADDR_ECHO,
 173         MPTCP_ADD_ADDR_IPV6,
 174         MPTCP_ADD_ADDR_PORT,
 175         MPTCP_RM_ADDR_SIGNAL,
 176 };
 177
 178 struct mptcp_pm_data {
 179         struct mptcp_addr_info local;
 180         struct mptcp_addr_info remote;
 181         struct list_head anno_list;
 182
 183         spinlock_t      lock;           /*protects the whole PM data */
 184
 185         u8              addr_signal;
 186         bool            server_side;
 187         bool            work_pending;
 188         bool            accept_addr;
 189         bool            accept_subflow;
 190         u8              add_addr_signaled;
 191         u8              add_addr_accepted;
 192         u8              local_addr_used;
 193         u8              subflows;
 194         u8              status;
 195         struct mptcp_rm_list rm_list_tx;
 196         struct mptcp_rm_list rm_list_rx;
 197 };
 198
 199 struct mptcp_data_frag {
 200         struct list_head list;
 201         u64 data_seq;
 202         u16 data_len;
 203         u16 offset;
 204         u16 overhead;
 205         u16 already_sent;
 206         struct page *page;
 207 };
 208
 209 /* MPTCP connection sock */
 210 struct mptcp_sock {
 211         /* inet_connection_sock must be the first member */
 212         struct inet_connection_sock sk;
 213         u64             local_key;
 214         u64             remote_key;
 215         u64             write_seq;
 216         u64             snd_nxt;
 217         u64             ack_seq;
 218         u64             rcv_wnd_sent;
 219         u64             rcv_data_fin_seq;
 220         int             wmem_reserved;
 221         struct sock     *last_snd;
 222         int             snd_burst;
 223         int             old_wspace;
 224         u64             snd_una;
 225         u64             wnd_end;
 226         unsigned long   timer_ival;
 227         u32             token;
 228         int             rmem_released;
 229         unsigned long   flags;
 230         bool            can_ack;
 231         bool            fully_established;
 232         bool            rcv_data_fin;
 233         bool            snd_data_fin_enable;
 234         bool            rcv_fastclose;
 235         bool            use_64bit_ack; /* Set when we received a 64-bit DSN */
 236         spinlock_t      join_list_lock;
 237         struct sock     *ack_hint;
 238         struct work_struct work;
 239         struct sk_buff  *ooo_last_skb;
 240         struct rb_root  out_of_order_queue;
 241         struct sk_buff_head receive_queue;
 242         struct sk_buff_head skb_tx_cache;       /* this is wmem accounted */
 243         int             tx_pending_data;
 244         int             size_goal_cache;
 245         struct list_head conn_list;
 246         struct list_head rtx_queue;
 247         struct mptcp_data_frag *first_pending;
 248         struct list_head join_list;
 249         struct socket   *subflow; /* outgoing connect/listener/!mp_capable */
 250         struct sock     *first;
 251         struct mptcp_pm_data    pm;
 252         struct {
 253                 u32     space;  /* bytes copied in last measurement window */
 254                 u32     copied; /* bytes copied in this measurement window */
 255                 u64     time;   /* start time of measurement window */
 256                 u64     rtt_us; /* last maximum rtt of subflows */
 257         } rcvq_space;
 258 };
 259
 260 #define mptcp_lock_sock(___sk, cb) do {                                 \
 261         struct sock *__sk = (___sk); /* silence macro reuse warning */  \
 262         might_sleep();                                                  \
 263         spin_lock_bh(&__sk->sk_lock.slock);                             \
 264         if (__sk->sk_lock.owned)                                        \
 265                 __lock_sock(__sk);                                      \
 266         cb;                                                             \
 267         __sk->sk_lock.owned = 1;                                        \
 268         spin_unlock(&__sk->sk_lock.slock);                              \
 269         mutex_acquire(&__sk->sk_lock.dep_map, 0, 0, _RET_IP_);          \
 270         local_bh_enable();                                              \
 271 } while (0)
 272
 273 #define mptcp_data_lock(sk) spin_lock_bh(&(sk)->sk_lock.slock)
 274 #define mptcp_data_unlock(sk) spin_unlock_bh(&(sk)->sk_lock.slock)
 275
 276 #define mptcp_for_each_subflow(__msk, __subflow)                        \
 277         list_for_each_entry(__subflow, &((__msk)->conn_list), node)
 278
 279 static inline void msk_owned_by_me(const struct mptcp_sock *msk)
 280 {
 281         sock_owned_by_me((const struct sock *)msk);
 282 }
 283
 284 static inline struct mptcp_sock *mptcp_sk(const struct sock *sk)
 285 {
 286         return (struct mptcp_sock *)sk;
 287 }
 288
 289 static inline int __mptcp_space(const struct sock *sk)
 290 {
 291         return tcp_space(sk) + READ_ONCE(mptcp_sk(sk)->rmem_released);
 292 }
 293
 294 static inline struct mptcp_data_frag *mptcp_send_head(const struct sock *sk)
 295 {
 296         const struct mptcp_sock *msk = mptcp_sk(sk);
 297
 298         return READ_ONCE(msk->first_pending);
 299 }
 300
 301 static inline struct mptcp_data_frag *mptcp_send_next(struct sock *sk)
 302 {
 303         struct mptcp_sock *msk = mptcp_sk(sk);
 304         struct mptcp_data_frag *cur;
 305
 306         cur = msk->first_pending;
 307         return list_is_last(&cur->list, &msk->rtx_queue) ? NULL :
 308                                                      list_next_entry(cur, list);
 309 }
 310
 311 static inline struct mptcp_data_frag *mptcp_pending_tail(const struct sock *sk)
 312 {
 313         struct mptcp_sock *msk = mptcp_sk(sk);
 314
 315         if (!msk->first_pending)
 316                 return NULL;
 317
 318         if (WARN_ON_ONCE(list_empty(&msk->rtx_queue)))
 319                 return NULL;
 320
 321         return list_last_entry(&msk->rtx_queue, struct mptcp_data_frag, list);
 322 }
 323
 324 static inline struct mptcp_data_frag *mptcp_rtx_head(const struct sock *sk)
 325 {
 326         struct mptcp_sock *msk = mptcp_sk(sk);
 327
 328         if (msk->snd_una == READ_ONCE(msk->snd_nxt))
 329                 return NULL;
 330
 331         return list_first_entry_or_null(&msk->rtx_queue, struct mptcp_data_frag, list);
 332 }
 333
 334 struct mptcp_subflow_request_sock {
 335         struct  tcp_request_sock sk;
 336         u16     mp_capable : 1,
 337                 mp_join : 1,
 338                 backup : 1;
 339         u8      local_id;
 340         u8      remote_id;
 341         u64     local_key;
 342         u64     idsn;
 343         u32     token;
 344         u32     ssn_offset;
 345         u64     thmac;
 346         u32     local_nonce;
 347         u32     remote_nonce;
 348         struct mptcp_sock       *msk;
 349         struct hlist_nulls_node token_node;
 350 };
 351
 352 static inline struct mptcp_subflow_request_sock *
 353 mptcp_subflow_rsk(const struct request_sock *rsk)
 354 {
 355         return (struct mptcp_subflow_request_sock *)rsk;
 356 }
 357
 358 enum mptcp_data_avail {
 359         MPTCP_SUBFLOW_NODATA,
 360         MPTCP_SUBFLOW_DATA_AVAIL,
 361         MPTCP_SUBFLOW_OOO_DATA
 362 };
 363
 364 struct mptcp_delegated_action {
 365         struct napi_struct napi;
 366         struct list_head head;
 367 };
 368
 369 DECLARE_PER_CPU(struct mptcp_delegated_action, mptcp_delegated_actions);
 370
 371 #define MPTCP_DELEGATE_SEND             0
 372
 373 /* MPTCP subflow context */
 374 struct mptcp_subflow_context {
 375         struct  list_head node;/* conn_list of subflows */
 376         u64     local_key;
 377         u64     remote_key;
 378         u64     idsn;
 379         u64     map_seq;
 380         u32     snd_isn;
 381         u32     token;
 382         u32     rel_write_seq;
 383         u32     map_subflow_seq;
 384         u32     ssn_offset;
 385         u32     map_data_len;
 386         u32     request_mptcp : 1,  /* send MP_CAPABLE */
 387                 request_join : 1,   /* send MP_JOIN */
 388                 request_bkup : 1,
 389                 mp_capable : 1,     /* remote is MPTCP capable */
 390                 mp_join : 1,        /* remote is JOINing */
 391                 fully_established : 1,      /* path validated */
 392                 pm_notified : 1,    /* PM hook called for established status */
 393                 conn_finished : 1,
 394                 map_valid : 1,
 395                 mpc_map : 1,
 396                 backup : 1,
 397                 send_mp_prio : 1,
 398                 rx_eof : 1,
 399                 can_ack : 1,        /* only after processing the remote a key */
 400                 disposable : 1;     /* ctx can be free at ulp release time */
 401         enum mptcp_data_avail data_avail;
 402         u32     remote_nonce;
 403         u64     thmac;
 404         u32     local_nonce;
 405         u32     remote_token;
 406         u8      hmac[MPTCPOPT_HMAC_LEN];
 407         u8      local_id;
 408         u8      remote_id;
 409         u8      reset_seen:1;
 410         u8      reset_transient:1;
 411         u8      reset_reason:4;
 412
 413         long    delegated_status;
 414         struct  list_head delegated_node;   /* link into delegated_action, protected by local BH */
 415
 416         struct  sock *tcp_sock;     /* tcp sk backpointer */
 417         struct  sock *conn;         /* parent mptcp_sock */
 418         const   struct inet_connection_sock_af_ops *icsk_af_ops;
 419         void    (*tcp_data_ready)(struct sock *sk);
 420         void    (*tcp_state_change)(struct sock *sk);
 421         void    (*tcp_write_space)(struct sock *sk);
 422         void    (*tcp_error_report)(struct sock *sk);
 423
 424         struct  rcu_head rcu;
 425 };
 426
 427 static inline struct mptcp_subflow_context *
 428 mptcp_subflow_ctx(const struct sock *sk)
 429 {
 430         struct inet_connection_sock *icsk = inet_csk(sk);
 431
 432         /* Use RCU on icsk_ulp_data only for sock diag code */
 433         return (__force struct mptcp_subflow_context *)icsk->icsk_ulp_data;
 434 }
 435
 436 static inline struct sock *
 437 mptcp_subflow_tcp_sock(const struct mptcp_subflow_context *subflow)
 438 {
 439         return subflow->tcp_sock;
 440 }
 441
 442 static inline u64
 443 mptcp_subflow_get_map_offset(const struct mptcp_subflow_context *subflow)
 444 {
 445         return tcp_sk(mptcp_subflow_tcp_sock(subflow))->copied_seq -
 446                       subflow->ssn_offset -
 447                       subflow->map_subflow_seq;
 448 }
 449
 450 static inline u64
 451 mptcp_subflow_get_mapped_dsn(const struct mptcp_subflow_context *subflow)
 452 {
 453         return subflow->map_seq + mptcp_subflow_get_map_offset(subflow);
 454 }
 455
 456 static inline void mptcp_add_pending_subflow(struct mptcp_sock *msk,
 457                                              struct mptcp_subflow_context *subflow)
 458 {
 459         sock_hold(mptcp_subflow_tcp_sock(subflow));
 460         spin_lock_bh(&msk->join_list_lock);
 461         list_add_tail(&subflow->node, &msk->join_list);
 462         spin_unlock_bh(&msk->join_list_lock);
 463 }
 464
 465 void mptcp_subflow_process_delegated(struct sock *ssk);
 466
 467 static inline void mptcp_subflow_delegate(struct mptcp_subflow_context *subflow)
 468 {
 469         struct mptcp_delegated_action *delegated;
 470         bool schedule;
 471
 472         /* The implied barrier pairs with mptcp_subflow_delegated_done(), and
 473          * ensures the below list check sees list updates done prior to status
 474          * bit changes
 475          */
 476         if (!test_and_set_bit(MPTCP_DELEGATE_SEND, &subflow->delegated_status)) {
 477                 /* still on delegated list from previous scheduling */
 478                 if (!list_empty(&subflow->delegated_node))
 479                         return;
 480
 481                 /* the caller held the subflow bh socket lock */
 482                 lockdep_assert_in_softirq();
 483
 484                 delegated = this_cpu_ptr(&mptcp_delegated_actions);
 485                 schedule = list_empty(&delegated->head);
 486                 list_add_tail(&subflow->delegated_node, &delegated->head);
 487                 sock_hold(mptcp_subflow_tcp_sock(subflow));
 488                 if (schedule)
 489                         napi_schedule(&delegated->napi);
 490         }
 491 }
 492
 493 static inline struct mptcp_subflow_context *
 494 mptcp_subflow_delegated_next(struct mptcp_delegated_action *delegated)
 495 {
 496         struct mptcp_subflow_context *ret;
 497
 498         if (list_empty(&delegated->head))
 499                 return NULL;
 500
 501         ret = list_first_entry(&delegated->head, struct mptcp_subflow_context, delegated_node);
 502         list_del_init(&ret->delegated_node);
 503         return ret;
 504 }
 505
 506 static inline bool mptcp_subflow_has_delegated_action(const struct mptcp_subflow_context *subflow)
 507 {
 508         return test_bit(MPTCP_DELEGATE_SEND, &subflow->delegated_status);
 509 }
 510
 511 static inline void mptcp_subflow_delegated_done(struct mptcp_subflow_context *subflow)
 512 {
 513         /* pairs with mptcp_subflow_delegate, ensures delegate_node is updated before
 514          * touching the status bit
 515          */
 516         smp_wmb();
 517         clear_bit(MPTCP_DELEGATE_SEND, &subflow->delegated_status);
 518 }
 519
 520 int mptcp_is_enabled(struct net *net);
 521 unsigned int mptcp_get_add_addr_timeout(struct net *net);
 522 void mptcp_subflow_fully_established(struct mptcp_subflow_context *subflow,
 523                                      struct mptcp_options_received *mp_opt);
 524 bool mptcp_subflow_data_available(struct sock *sk);
 525 void __init mptcp_subflow_init(void);
 526 void mptcp_subflow_shutdown(struct sock *sk, struct sock *ssk, int how);
 527 void mptcp_close_ssk(struct sock *sk, struct sock *ssk,
 528                      struct mptcp_subflow_context *subflow);
 529 void mptcp_subflow_reset(struct sock *ssk);
 530 void mptcp_sock_graft(struct sock *sk, struct socket *parent);
 531 struct socket *__mptcp_nmpc_socket(const struct mptcp_sock *msk);
 532
 533 /* called with sk socket lock held */
 534 int __mptcp_subflow_connect(struct sock *sk, const struct mptcp_addr_info *loc,
 535                             const struct mptcp_addr_info *remote,
 536                             u8 flags, int ifindex);
 537 int mptcp_subflow_create_socket(struct sock *sk, struct socket **new_sock);
 538 void mptcp_info2sockaddr(const struct mptcp_addr_info *info,
 539                          struct sockaddr_storage *addr,
 540                          unsigned short family);
 541
 542 static inline void mptcp_subflow_tcp_fallback(struct sock *sk,
 543                                               struct mptcp_subflow_context *ctx)
 544 {
 545         sk->sk_data_ready = ctx->tcp_data_ready;
 546         sk->sk_state_change = ctx->tcp_state_change;
 547         sk->sk_write_space = ctx->tcp_write_space;
 548         sk->sk_error_report = ctx->tcp_error_report;
 549
 550         inet_csk(sk)->icsk_af_ops = ctx->icsk_af_ops;
 551 }
 552
 553 void __init mptcp_proto_init(void);
 554 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
 555 int __init mptcp_proto_v6_init(void);
 556 #endif
 557
 558 struct sock *mptcp_sk_clone(const struct sock *sk,
 559                             const struct mptcp_options_received *mp_opt,
 560                             struct request_sock *req);
 561 void mptcp_get_options(const struct sk_buff *skb,
 562                        struct mptcp_options_received *mp_opt);
 563
 564 void mptcp_finish_connect(struct sock *sk);
 565 static inline bool mptcp_is_fully_established(struct sock *sk)
 566 {
 567         return inet_sk_state_load(sk) == TCP_ESTABLISHED &&
 568                READ_ONCE(mptcp_sk(sk)->fully_established);
 569 }
 570 void mptcp_rcv_space_init(struct mptcp_sock *msk, const struct sock *ssk);
 571 void mptcp_data_ready(struct sock *sk, struct sock *ssk);
 572 bool mptcp_finish_join(struct sock *sk);
 573 bool mptcp_schedule_work(struct sock *sk);
 574 int mptcp_setsockopt(struct sock *sk, int level, int optname,
 575                      sockptr_t optval, unsigned int optlen);
 576 int mptcp_getsockopt(struct sock *sk, int level, int optname,
 577                      char __user *optval, int __user *option);
 578
 579 void __mptcp_check_push(struct sock *sk, struct sock *ssk);
 580 void __mptcp_data_acked(struct sock *sk);
 581 void __mptcp_error_report(struct sock *sk);
 582 void mptcp_subflow_eof(struct sock *sk);
 583 bool mptcp_update_rcv_data_fin(struct mptcp_sock *msk, u64 data_fin_seq, bool use_64bit);
 584 void __mptcp_flush_join_list(struct mptcp_sock *msk);
 585 static inline bool mptcp_data_fin_enabled(const struct mptcp_sock *msk)
 586 {
 587         return READ_ONCE(msk->snd_data_fin_enable) &&
 588                READ_ONCE(msk->write_seq) == READ_ONCE(msk->snd_nxt);
 589 }
 590
 591 static inline bool mptcp_propagate_sndbuf(struct sock *sk, struct sock *ssk)
 592 {
 593         if ((sk->sk_userlocks & SOCK_SNDBUF_LOCK) || ssk->sk_sndbuf <= READ_ONCE(sk->sk_sndbuf))
 594                 return false;
 595
 596         WRITE_ONCE(sk->sk_sndbuf, ssk->sk_sndbuf);
 597         return true;
 598 }
 599
 600 static inline void mptcp_write_space(struct sock *sk)
 601 {
 602         if (sk_stream_is_writeable(sk)) {
 603                 /* pairs with memory barrier in mptcp_poll */
 604                 smp_mb();
 605                 if (test_and_clear_bit(MPTCP_NOSPACE, &mptcp_sk(sk)->flags))
 606                         sk_stream_write_space(sk);
 607         }
 608 }
 609
 610 void mptcp_destroy_common(struct mptcp_sock *msk);
 611
 612 void __init mptcp_token_init(void);
 613 static inline void mptcp_token_init_request(struct request_sock *req)
 614 {
 615         mptcp_subflow_rsk(req)->token_node.pprev = NULL;
 616 }
 617
 618 int mptcp_token_new_request(struct request_sock *req);
 619 void mptcp_token_destroy_request(struct request_sock *req);
 620 int mptcp_token_new_connect(struct sock *sk);
 621 void mptcp_token_accept(struct mptcp_subflow_request_sock *r,
 622                         struct mptcp_sock *msk);
 623 bool mptcp_token_exists(u32 token);
 624 struct mptcp_sock *mptcp_token_get_sock(u32 token);
 625 struct mptcp_sock *mptcp_token_iter_next(const struct net *net, long *s_slot,
 626                                          long *s_num);
 627 void mptcp_token_destroy(struct mptcp_sock *msk);
 628
 629 void mptcp_crypto_key_sha(u64 key, u32 *token, u64 *idsn);
 630
 631 void mptcp_crypto_hmac_sha(u64 key1, u64 key2, u8 *msg, int len, void *hmac);
 632
 633 void __init mptcp_pm_init(void);
 634 void mptcp_pm_data_init(struct mptcp_sock *msk);
 635 void mptcp_pm_new_connection(struct mptcp_sock *msk, const struct sock *ssk, int server_side);
 636 void mptcp_pm_fully_established(struct mptcp_sock *msk, const struct sock *ssk, gfp_t gfp);
 637 bool mptcp_pm_allow_new_subflow(struct mptcp_sock *msk);
 638 void mptcp_pm_connection_closed(struct mptcp_sock *msk);
 639 void mptcp_pm_subflow_established(struct mptcp_sock *msk);
 640 void mptcp_pm_subflow_closed(struct mptcp_sock *msk, u8 id);
 641 void mptcp_pm_add_addr_received(struct mptcp_sock *msk,
 642                                 const struct mptcp_addr_info *addr);
 643 void mptcp_pm_add_addr_echoed(struct mptcp_sock *msk,
 644                               struct mptcp_addr_info *addr);
 645 void mptcp_pm_add_addr_send_ack(struct mptcp_sock *msk);
 646 void mptcp_pm_nl_addr_send_ack(struct mptcp_sock *msk);
 647 void mptcp_pm_rm_addr_received(struct mptcp_sock *msk,
 648                                const struct mptcp_rm_list *rm_list);
 649 void mptcp_pm_mp_prio_received(struct sock *sk, u8 bkup);
 650 int mptcp_pm_nl_mp_prio_send_ack(struct mptcp_sock *msk,
 651                                  struct mptcp_addr_info *addr,
 652                                  u8 bkup);
 653 void mptcp_pm_free_anno_list(struct mptcp_sock *msk);
 654 bool mptcp_pm_sport_in_anno_list(struct mptcp_sock *msk, const struct sock *sk);
 655 struct mptcp_pm_add_entry *
 656 mptcp_pm_del_add_timer(struct mptcp_sock *msk,
 657                        struct mptcp_addr_info *addr);
 658 struct mptcp_pm_add_entry *
 659 mptcp_lookup_anno_list_by_saddr(struct mptcp_sock *msk,
 660                                 struct mptcp_addr_info *addr);
 661
 662 int mptcp_pm_announce_addr(struct mptcp_sock *msk,
 663                            const struct mptcp_addr_info *addr,
 664                            bool echo);
 665 int mptcp_pm_remove_addr(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
 666 int mptcp_pm_remove_subflow(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
 667
 668 void mptcp_event(enum mptcp_event_type type, const struct mptcp_sock *msk,
 669                  const struct sock *ssk, gfp_t gfp);
 670 void mptcp_event_addr_announced(const struct mptcp_sock *msk, const struct mptcp_addr_info *info);
 671 void mptcp_event_addr_removed(const struct mptcp_sock *msk, u8 id);
 672
 673 static inline bool mptcp_pm_should_add_signal(struct mptcp_sock *msk)
 674 {
 675         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_SIGNAL);
 676 }
 677
 678 static inline bool mptcp_pm_should_add_signal_echo(struct mptcp_sock *msk)
 679 {
 680         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_ECHO);
 681 }
 682
 683 static inline bool mptcp_pm_should_add_signal_ipv6(struct mptcp_sock *msk)
 684 {
 685         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_IPV6);
 686 }
 687
 688 static inline bool mptcp_pm_should_add_signal_port(struct mptcp_sock *msk)
 689 {
 690         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_PORT);
 691 }
 692
 693 static inline bool mptcp_pm_should_rm_signal(struct mptcp_sock *msk)
 694 {
 695         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_RM_ADDR_SIGNAL);
 696 }
 697
 698 static inline unsigned int mptcp_add_addr_len(int family, bool echo, bool port)
 699 {
 700         u8 len = TCPOLEN_MPTCP_ADD_ADDR_BASE;
 701
 702         if (family == AF_INET6)
 703                 len = TCPOLEN_MPTCP_ADD_ADDR6_BASE;
 704         if (!echo)
 705                 len += MPTCPOPT_THMAC_LEN;
 706         /* account for 2 trailing 'nop' options */
 707         if (port)
 708                 len += TCPOLEN_MPTCP_PORT_LEN + TCPOLEN_MPTCP_PORT_ALIGN;
 709
 710         return len;
 711 }
 712
 713 static inline int mptcp_rm_addr_len(const struct mptcp_rm_list *rm_list)
 714 {
 715         if (rm_list->nr == 0 || rm_list->nr > MPTCP_RM_IDS_MAX)
 716                 return -EINVAL;
 717
 718         return TCPOLEN_MPTCP_RM_ADDR_BASE + roundup(rm_list->nr - 1, 4) + 1;
 719 }
 720
 721 bool mptcp_pm_add_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
 722                               struct mptcp_addr_info *saddr, bool *echo, bool *port);
 723 bool mptcp_pm_rm_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
 724                              struct mptcp_rm_list *rm_list);
 725 int mptcp_pm_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
 726
 727 void __init mptcp_pm_nl_init(void);
 728 void mptcp_pm_nl_data_init(struct mptcp_sock *msk);
 729 void mptcp_pm_nl_work(struct mptcp_sock *msk);
 730 void mptcp_pm_nl_rm_subflow_received(struct mptcp_sock *msk,
 731                                      const struct mptcp_rm_list *rm_list);
 732 int mptcp_pm_nl_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
 733 unsigned int mptcp_pm_get_add_addr_signal_max(struct mptcp_sock *msk);
 734 unsigned int mptcp_pm_get_add_addr_accept_max(struct mptcp_sock *msk);
 735 unsigned int mptcp_pm_get_subflows_max(struct mptcp_sock *msk);
 736 unsigned int mptcp_pm_get_local_addr_max(struct mptcp_sock *msk);
 737
 738 static inline struct mptcp_ext *mptcp_get_ext(const struct sk_buff *skb)
 739 {
 740         return (struct mptcp_ext *)skb_ext_find(skb, SKB_EXT_MPTCP);
 741 }
 742
 743 void mptcp_diag_subflow_init(struct tcp_ulp_ops *ops);
 744
 745 static inline bool __mptcp_check_fallback(const struct mptcp_sock *msk)
 746 {
 747         return test_bit(MPTCP_FALLBACK_DONE, &msk->flags);
 748 }
 749
 750 static inline bool mptcp_check_fallback(const struct sock *sk)
 751 {
 752         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
 753         struct mptcp_sock *msk = mptcp_sk(subflow->conn);
 754
 755         return __mptcp_check_fallback(msk);
 756 }
 757
 758 static inline void __mptcp_do_fallback(struct mptcp_sock *msk)
 759 {
 760         if (test_bit(MPTCP_FALLBACK_DONE, &msk->flags)) {
 761                 pr_debug("TCP fallback already done (msk=%p)", msk);
 762                 return;
 763         }
 764         set_bit(MPTCP_FALLBACK_DONE, &msk->flags);
 765 }
 766
 767 static inline void mptcp_do_fallback(struct sock *sk)
 768 {
 769         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
 770         struct mptcp_sock *msk = mptcp_sk(subflow->conn);
 771
 772         __mptcp_do_fallback(msk);
 773 }
 774
 775 #define pr_fallback(a) pr_debug("%s:fallback to TCP (msk=%p)", __func__, a)
 776
 777 static inline bool subflow_simultaneous_connect(struct sock *sk)
 778 {
 779         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
 780         struct sock *parent = subflow->conn;
 781
 782         return sk->sk_state == TCP_ESTABLISHED &&
 783                !mptcp_sk(parent)->pm.server_side &&
 784                !subflow->conn_finished;
 785 }
 786
 787 #ifdef CONFIG_SYN_COOKIES
 788 void subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
 789                                        struct sk_buff *skb);
 790 bool mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
 791                                         struct sk_buff *skb);
 792 void __init mptcp_join_cookie_init(void);
 793 #else
 794 static inline void
 795 subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
 796                                   struct sk_buff *skb) {}
 797 static inline bool
 798 mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
 799                                    struct sk_buff *skb)
 800 {
 801         return false;
 802 }
 803
 804 static inline void mptcp_join_cookie_init(void) {}
 805 #endif
 806
 807 #endif /* __MPTCP_PROTOCOL_H */