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