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              add_addr_signal_max;
 207         u8              add_addr_accept_max;
 208         u8              local_addr_max;
 209         u8              subflows_max;
 210         u8              status;
 211         u8              rm_id;
 212 };
 213
 214 struct mptcp_data_frag {
 215         struct list_head list;
 216         u64 data_seq;
 217         u16 data_len;
 218         u16 offset;
 219         u16 overhead;
 220         u16 already_sent;
 221         struct page *page;
 222 };
 223
 224 /* MPTCP connection sock */
 225 struct mptcp_sock {
 226         /* inet_connection_sock must be the first member */
 227         struct inet_connection_sock sk;
 228         u64             local_key;
 229         u64             remote_key;
 230         u64             write_seq;
 231         u64             snd_nxt;
 232         u64             ack_seq;
 233         u64             rcv_wnd_sent;
 234         u64             rcv_data_fin_seq;
 235         int             wmem_reserved;
 236         struct sock     *last_snd;
 237         int             snd_burst;
 238         int             old_wspace;
 239         u64             snd_una;
 240         u64             wnd_end;
 241         unsigned long   timer_ival;
 242         u32             token;
 243         int             rmem_pending;
 244         int             rmem_released;
 245         unsigned long   flags;
 246         bool            can_ack;
 247         bool            fully_established;
 248         bool            rcv_data_fin;
 249         bool            snd_data_fin_enable;
 250         bool            rcv_fastclose;
 251         bool            use_64bit_ack; /* Set when we received a 64-bit DSN */
 252         spinlock_t      join_list_lock;
 253         struct sock     *ack_hint;
 254         struct work_struct work;
 255         struct sk_buff  *ooo_last_skb;
 256         struct rb_root  out_of_order_queue;
 257         struct sk_buff_head receive_queue;
 258         struct sk_buff_head skb_tx_cache;       /* this is wmem accounted */
 259         int             tx_pending_data;
 260         int             size_goal_cache;
 261         struct list_head conn_list;
 262         struct list_head rtx_queue;
 263         struct mptcp_data_frag *first_pending;
 264         struct list_head join_list;
 265         struct socket   *subflow; /* outgoing connect/listener/!mp_capable */
 266         struct sock     *first;
 267         struct mptcp_pm_data    pm;
 268         struct {
 269                 u32     space;  /* bytes copied in last measurement window */
 270                 u32     copied; /* bytes copied in this measurement window */
 271                 u64     time;   /* start time of measurement window */
 272                 u64     rtt_us; /* last maximum rtt of subflows */
 273         } rcvq_space;
 274 };
 275
 276 #define mptcp_lock_sock(___sk, cb) do {                                 \
 277         struct sock *__sk = (___sk); /* silence macro reuse warning */  \
 278         might_sleep();                                                  \
 279         spin_lock_bh(&__sk->sk_lock.slock);                             \
 280         if (__sk->sk_lock.owned)                                        \
 281                 __lock_sock(__sk);                                      \
 282         cb;                                                             \
 283         __sk->sk_lock.owned = 1;                                        \
 284         spin_unlock(&__sk->sk_lock.slock);                              \
 285         mutex_acquire(&__sk->sk_lock.dep_map, 0, 0, _RET_IP_);          \
 286         local_bh_enable();                                              \
 287 } while (0)
 288
 289 #define mptcp_data_lock(sk) spin_lock_bh(&(sk)->sk_lock.slock)
 290 #define mptcp_data_unlock(sk) spin_unlock_bh(&(sk)->sk_lock.slock)
 291
 292 #define mptcp_for_each_subflow(__msk, __subflow)                        \
 293         list_for_each_entry(__subflow, &((__msk)->conn_list), node)
 294
 295 static inline struct mptcp_sock *mptcp_sk(const struct sock *sk)
 296 {
 297         return (struct mptcp_sock *)sk;
 298 }
 299
 300 static inline int __mptcp_space(const struct sock *sk)
 301 {
 302         return tcp_space(sk) + READ_ONCE(mptcp_sk(sk)->rmem_pending);
 303 }
 304
 305 static inline struct mptcp_data_frag *mptcp_send_head(const struct sock *sk)
 306 {
 307         const struct mptcp_sock *msk = mptcp_sk(sk);
 308
 309         return READ_ONCE(msk->first_pending);
 310 }
 311
 312 static inline struct mptcp_data_frag *mptcp_send_next(struct sock *sk)
 313 {
 314         struct mptcp_sock *msk = mptcp_sk(sk);
 315         struct mptcp_data_frag *cur;
 316
 317         cur = msk->first_pending;
 318         return list_is_last(&cur->list, &msk->rtx_queue) ? NULL :
 319                                                      list_next_entry(cur, list);
 320 }
 321
 322 static inline struct mptcp_data_frag *mptcp_pending_tail(const struct sock *sk)
 323 {
 324         struct mptcp_sock *msk = mptcp_sk(sk);
 325
 326         if (!msk->first_pending)
 327                 return NULL;
 328
 329         if (WARN_ON_ONCE(list_empty(&msk->rtx_queue)))
 330                 return NULL;
 331
 332         return list_last_entry(&msk->rtx_queue, struct mptcp_data_frag, list);
 333 }
 334
 335 static inline struct mptcp_data_frag *mptcp_rtx_tail(const struct sock *sk)
 336 {
 337         struct mptcp_sock *msk = mptcp_sk(sk);
 338
 339         if (!before64(msk->snd_nxt, READ_ONCE(msk->snd_una)))
 340                 return NULL;
 341
 342         return list_last_entry(&msk->rtx_queue, struct mptcp_data_frag, list);
 343 }
 344
 345 static inline struct mptcp_data_frag *mptcp_rtx_head(const struct sock *sk)
 346 {
 347         struct mptcp_sock *msk = mptcp_sk(sk);
 348
 349         return list_first_entry_or_null(&msk->rtx_queue, struct mptcp_data_frag, list);
 350 }
 351
 352 struct mptcp_subflow_request_sock {
 353         struct  tcp_request_sock sk;
 354         u16     mp_capable : 1,
 355                 mp_join : 1,
 356                 backup : 1;
 357         u8      local_id;
 358         u8      remote_id;
 359         u64     local_key;
 360         u64     idsn;
 361         u32     token;
 362         u32     ssn_offset;
 363         u64     thmac;
 364         u32     local_nonce;
 365         u32     remote_nonce;
 366         struct mptcp_sock       *msk;
 367         struct hlist_nulls_node token_node;
 368 };
 369
 370 static inline struct mptcp_subflow_request_sock *
 371 mptcp_subflow_rsk(const struct request_sock *rsk)
 372 {
 373         return (struct mptcp_subflow_request_sock *)rsk;
 374 }
 375
 376 enum mptcp_data_avail {
 377         MPTCP_SUBFLOW_NODATA,
 378         MPTCP_SUBFLOW_DATA_AVAIL,
 379         MPTCP_SUBFLOW_OOO_DATA
 380 };
 381
 382 struct mptcp_delegated_action {
 383         struct napi_struct napi;
 384         struct list_head head;
 385 };
 386
 387 DECLARE_PER_CPU(struct mptcp_delegated_action, mptcp_delegated_actions);
 388
 389 #define MPTCP_DELEGATE_SEND             0
 390
 391 /* MPTCP subflow context */
 392 struct mptcp_subflow_context {
 393         struct  list_head node;/* conn_list of subflows */
 394         u64     local_key;
 395         u64     remote_key;
 396         u64     idsn;
 397         u64     map_seq;
 398         u32     snd_isn;
 399         u32     token;
 400         u32     rel_write_seq;
 401         u32     map_subflow_seq;
 402         u32     ssn_offset;
 403         u32     map_data_len;
 404         u32     request_mptcp : 1,  /* send MP_CAPABLE */
 405                 request_join : 1,   /* send MP_JOIN */
 406                 request_bkup : 1,
 407                 mp_capable : 1,     /* remote is MPTCP capable */
 408                 mp_join : 1,        /* remote is JOINing */
 409                 fully_established : 1,      /* path validated */
 410                 pm_notified : 1,    /* PM hook called for established status */
 411                 conn_finished : 1,
 412                 map_valid : 1,
 413                 mpc_map : 1,
 414                 backup : 1,
 415                 send_mp_prio : 1,
 416                 rx_eof : 1,
 417                 can_ack : 1,        /* only after processing the remote a key */
 418                 disposable : 1;     /* ctx can be free at ulp release time */
 419         enum mptcp_data_avail data_avail;
 420         u32     remote_nonce;
 421         u64     thmac;
 422         u32     local_nonce;
 423         u32     remote_token;
 424         u8      hmac[MPTCPOPT_HMAC_LEN];
 425         u8      local_id;
 426         u8      remote_id;
 427
 428         long    delegated_status;
 429         struct  list_head delegated_node;   /* link into delegated_action, protected by local BH */
 430
 431         struct  sock *tcp_sock;     /* tcp sk backpointer */
 432         struct  sock *conn;         /* parent mptcp_sock */
 433         const   struct inet_connection_sock_af_ops *icsk_af_ops;
 434         void    (*tcp_data_ready)(struct sock *sk);
 435         void    (*tcp_state_change)(struct sock *sk);
 436         void    (*tcp_write_space)(struct sock *sk);
 437
 438         struct  rcu_head rcu;
 439 };
 440
 441 static inline struct mptcp_subflow_context *
 442 mptcp_subflow_ctx(const struct sock *sk)
 443 {
 444         struct inet_connection_sock *icsk = inet_csk(sk);
 445
 446         /* Use RCU on icsk_ulp_data only for sock diag code */
 447         return (__force struct mptcp_subflow_context *)icsk->icsk_ulp_data;
 448 }
 449
 450 static inline struct sock *
 451 mptcp_subflow_tcp_sock(const struct mptcp_subflow_context *subflow)
 452 {
 453         return subflow->tcp_sock;
 454 }
 455
 456 static inline u64
 457 mptcp_subflow_get_map_offset(const struct mptcp_subflow_context *subflow)
 458 {
 459         return tcp_sk(mptcp_subflow_tcp_sock(subflow))->copied_seq -
 460                       subflow->ssn_offset -
 461                       subflow->map_subflow_seq;
 462 }
 463
 464 static inline u64
 465 mptcp_subflow_get_mapped_dsn(const struct mptcp_subflow_context *subflow)
 466 {
 467         return subflow->map_seq + mptcp_subflow_get_map_offset(subflow);
 468 }
 469
 470 static inline void mptcp_add_pending_subflow(struct mptcp_sock *msk,
 471                                              struct mptcp_subflow_context *subflow)
 472 {
 473         sock_hold(mptcp_subflow_tcp_sock(subflow));
 474         spin_lock_bh(&msk->join_list_lock);
 475         list_add_tail(&subflow->node, &msk->join_list);
 476         spin_unlock_bh(&msk->join_list_lock);
 477 }
 478
 479 void mptcp_subflow_process_delegated(struct sock *ssk);
 480
 481 static inline void mptcp_subflow_delegate(struct mptcp_subflow_context *subflow)
 482 {
 483         struct mptcp_delegated_action *delegated;
 484         bool schedule;
 485
 486         /* The implied barrier pairs with mptcp_subflow_delegated_done(), and
 487          * ensures the below list check sees list updates done prior to status
 488          * bit changes
 489          */
 490         if (!test_and_set_bit(MPTCP_DELEGATE_SEND, &subflow->delegated_status)) {
 491                 /* still on delegated list from previous scheduling */
 492                 if (!list_empty(&subflow->delegated_node))
 493                         return;
 494
 495                 /* the caller held the subflow bh socket lock */
 496                 lockdep_assert_in_softirq();
 497
 498                 delegated = this_cpu_ptr(&mptcp_delegated_actions);
 499                 schedule = list_empty(&delegated->head);
 500                 list_add_tail(&subflow->delegated_node, &delegated->head);
 501                 sock_hold(mptcp_subflow_tcp_sock(subflow));
 502                 if (schedule)
 503                         napi_schedule(&delegated->napi);
 504         }
 505 }
 506
 507 static inline struct mptcp_subflow_context *
 508 mptcp_subflow_delegated_next(struct mptcp_delegated_action *delegated)
 509 {
 510         struct mptcp_subflow_context *ret;
 511
 512         if (list_empty(&delegated->head))
 513                 return NULL;
 514
 515         ret = list_first_entry(&delegated->head, struct mptcp_subflow_context, delegated_node);
 516         list_del_init(&ret->delegated_node);
 517         return ret;
 518 }
 519
 520 static inline bool mptcp_subflow_has_delegated_action(const struct mptcp_subflow_context *subflow)
 521 {
 522         return test_bit(MPTCP_DELEGATE_SEND, &subflow->delegated_status);
 523 }
 524
 525 static inline void mptcp_subflow_delegated_done(struct mptcp_subflow_context *subflow)
 526 {
 527         /* pairs with mptcp_subflow_delegate, ensures delegate_node is updated before
 528          * touching the status bit
 529          */
 530         smp_wmb();
 531         clear_bit(MPTCP_DELEGATE_SEND, &subflow->delegated_status);
 532 }
 533
 534 int mptcp_is_enabled(struct net *net);
 535 unsigned int mptcp_get_add_addr_timeout(struct net *net);
 536 void mptcp_subflow_fully_established(struct mptcp_subflow_context *subflow,
 537                                      struct mptcp_options_received *mp_opt);
 538 bool mptcp_subflow_data_available(struct sock *sk);
 539 void __init mptcp_subflow_init(void);
 540 void mptcp_subflow_shutdown(struct sock *sk, struct sock *ssk, int how);
 541 void __mptcp_close_ssk(struct sock *sk, struct sock *ssk,
 542                        struct mptcp_subflow_context *subflow);
 543 void mptcp_subflow_reset(struct sock *ssk);
 544 void mptcp_sock_graft(struct sock *sk, struct socket *parent);
 545
 546 /* called with sk socket lock held */
 547 int __mptcp_subflow_connect(struct sock *sk, const struct mptcp_addr_info *loc,
 548                             const struct mptcp_addr_info *remote);
 549 int mptcp_subflow_create_socket(struct sock *sk, struct socket **new_sock);
 550
 551 static inline void mptcp_subflow_tcp_fallback(struct sock *sk,
 552                                               struct mptcp_subflow_context *ctx)
 553 {
 554         sk->sk_data_ready = ctx->tcp_data_ready;
 555         sk->sk_state_change = ctx->tcp_state_change;
 556         sk->sk_write_space = ctx->tcp_write_space;
 557
 558         inet_csk(sk)->icsk_af_ops = ctx->icsk_af_ops;
 559 }
 560
 561 void __init mptcp_proto_init(void);
 562 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
 563 int __init mptcp_proto_v6_init(void);
 564 #endif
 565
 566 struct sock *mptcp_sk_clone(const struct sock *sk,
 567                             const struct mptcp_options_received *mp_opt,
 568                             struct request_sock *req);
 569 void mptcp_get_options(const struct sk_buff *skb,
 570                        struct mptcp_options_received *mp_opt);
 571
 572 void mptcp_finish_connect(struct sock *sk);
 573 static inline bool mptcp_is_fully_established(struct sock *sk)
 574 {
 575         return inet_sk_state_load(sk) == TCP_ESTABLISHED &&
 576                READ_ONCE(mptcp_sk(sk)->fully_established);
 577 }
 578 void mptcp_rcv_space_init(struct mptcp_sock *msk, const struct sock *ssk);
 579 void mptcp_data_ready(struct sock *sk, struct sock *ssk);
 580 bool mptcp_finish_join(struct sock *sk);
 581 bool mptcp_schedule_work(struct sock *sk);
 582 void __mptcp_check_push(struct sock *sk, struct sock *ssk);
 583 void __mptcp_data_acked(struct sock *sk);
 584 void mptcp_subflow_eof(struct sock *sk);
 585 bool mptcp_update_rcv_data_fin(struct mptcp_sock *msk, u64 data_fin_seq, bool use_64bit);
 586 void __mptcp_flush_join_list(struct mptcp_sock *msk);
 587 static inline bool mptcp_data_fin_enabled(const struct mptcp_sock *msk)
 588 {
 589         return READ_ONCE(msk->snd_data_fin_enable) &&
 590                READ_ONCE(msk->write_seq) == READ_ONCE(msk->snd_nxt);
 591 }
 592
 593 static inline bool mptcp_propagate_sndbuf(struct sock *sk, struct sock *ssk)
 594 {
 595         if ((sk->sk_userlocks & SOCK_SNDBUF_LOCK) || ssk->sk_sndbuf <= READ_ONCE(sk->sk_sndbuf))
 596                 return false;
 597
 598         WRITE_ONCE(sk->sk_sndbuf, ssk->sk_sndbuf);
 599         return true;
 600 }
 601
 602 static inline void mptcp_write_space(struct sock *sk)
 603 {
 604         if (sk_stream_is_writeable(sk)) {
 605                 /* pairs with memory barrier in mptcp_poll */
 606                 smp_mb();
 607                 if (test_and_clear_bit(MPTCP_NOSPACE, &mptcp_sk(sk)->flags))
 608                         sk_stream_write_space(sk);
 609         }
 610 }
 611
 612 void mptcp_destroy_common(struct mptcp_sock *msk);
 613
 614 void __init mptcp_token_init(void);
 615 static inline void mptcp_token_init_request(struct request_sock *req)
 616 {
 617         mptcp_subflow_rsk(req)->token_node.pprev = NULL;
 618 }
 619
 620 int mptcp_token_new_request(struct request_sock *req);
 621 void mptcp_token_destroy_request(struct request_sock *req);
 622 int mptcp_token_new_connect(struct sock *sk);
 623 void mptcp_token_accept(struct mptcp_subflow_request_sock *r,
 624                         struct mptcp_sock *msk);
 625 bool mptcp_token_exists(u32 token);
 626 struct mptcp_sock *mptcp_token_get_sock(u32 token);
 627 struct mptcp_sock *mptcp_token_iter_next(const struct net *net, long *s_slot,
 628                                          long *s_num);
 629 void mptcp_token_destroy(struct mptcp_sock *msk);
 630
 631 void mptcp_crypto_key_sha(u64 key, u32 *token, u64 *idsn);
 632
 633 void mptcp_crypto_hmac_sha(u64 key1, u64 key2, u8 *msg, int len, void *hmac);
 634
 635 void __init mptcp_pm_init(void);
 636 void mptcp_pm_data_init(struct mptcp_sock *msk);
 637 void mptcp_pm_new_connection(struct mptcp_sock *msk, int server_side);
 638 void mptcp_pm_fully_established(struct mptcp_sock *msk);
 639 bool mptcp_pm_allow_new_subflow(struct mptcp_sock *msk);
 640 void mptcp_pm_connection_closed(struct mptcp_sock *msk);
 641 void mptcp_pm_subflow_established(struct mptcp_sock *msk,
 642                                   struct mptcp_subflow_context *subflow);
 643 void mptcp_pm_subflow_closed(struct mptcp_sock *msk, u8 id);
 644 void mptcp_pm_add_addr_received(struct mptcp_sock *msk,
 645                                 const struct mptcp_addr_info *addr);
 646 void mptcp_pm_add_addr_send_ack(struct mptcp_sock *msk);
 647 void mptcp_pm_rm_addr_received(struct mptcp_sock *msk, u8 rm_id);
 648 void mptcp_pm_mp_prio_received(struct sock *sk, u8 bkup);
 649 int mptcp_pm_nl_mp_prio_send_ack(struct mptcp_sock *msk,
 650                                  struct mptcp_addr_info *addr,
 651                                  u8 bkup);
 652 void mptcp_pm_free_anno_list(struct mptcp_sock *msk);
 653 struct mptcp_pm_add_entry *
 654 mptcp_pm_del_add_timer(struct mptcp_sock *msk,
 655                        struct mptcp_addr_info *addr);
 656
 657 int mptcp_pm_announce_addr(struct mptcp_sock *msk,
 658                            const struct mptcp_addr_info *addr,
 659                            bool echo, bool port);
 660 int mptcp_pm_remove_addr(struct mptcp_sock *msk, u8 local_id);
 661 int mptcp_pm_remove_subflow(struct mptcp_sock *msk, u8 local_id);
 662
 663 static inline bool mptcp_pm_should_add_signal(struct mptcp_sock *msk)
 664 {
 665         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_SIGNAL);
 666 }
 667
 668 static inline bool mptcp_pm_should_add_signal_echo(struct mptcp_sock *msk)
 669 {
 670         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_ECHO);
 671 }
 672
 673 static inline bool mptcp_pm_should_add_signal_ipv6(struct mptcp_sock *msk)
 674 {
 675         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_IPV6);
 676 }
 677
 678 static inline bool mptcp_pm_should_add_signal_port(struct mptcp_sock *msk)
 679 {
 680         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_PORT);
 681 }
 682
 683 static inline bool mptcp_pm_should_rm_signal(struct mptcp_sock *msk)
 684 {
 685         return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_RM_ADDR_SIGNAL);
 686 }
 687
 688 static inline unsigned int mptcp_add_addr_len(int family, bool echo, bool port)
 689 {
 690         u8 len = TCPOLEN_MPTCP_ADD_ADDR_BASE;
 691
 692         if (family == AF_INET6)
 693                 len = TCPOLEN_MPTCP_ADD_ADDR6_BASE;
 694         if (!echo)
 695                 len += MPTCPOPT_THMAC_LEN;
 696         if (port)
 697                 len += TCPOLEN_MPTCP_PORT_LEN;
 698
 699         return len;
 700 }
 701
 702 bool mptcp_pm_add_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
 703                               struct mptcp_addr_info *saddr, bool *echo, bool *port);
 704 bool mptcp_pm_rm_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
 705                              u8 *rm_id);
 706 int mptcp_pm_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
 707
 708 void __init mptcp_pm_nl_init(void);
 709 void mptcp_pm_nl_data_init(struct mptcp_sock *msk);
 710 void mptcp_pm_nl_fully_established(struct mptcp_sock *msk);
 711 void mptcp_pm_nl_subflow_established(struct mptcp_sock *msk);
 712 void mptcp_pm_nl_add_addr_received(struct mptcp_sock *msk);
 713 void mptcp_pm_nl_add_addr_send_ack(struct mptcp_sock *msk);
 714 void mptcp_pm_nl_rm_addr_received(struct mptcp_sock *msk);
 715 void mptcp_pm_nl_rm_subflow_received(struct mptcp_sock *msk, u8 rm_id);
 716 int mptcp_pm_nl_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
 717
 718 static inline struct mptcp_ext *mptcp_get_ext(struct sk_buff *skb)
 719 {
 720         return (struct mptcp_ext *)skb_ext_find(skb, SKB_EXT_MPTCP);
 721 }
 722
 723 void mptcp_diag_subflow_init(struct tcp_ulp_ops *ops);
 724
 725 static inline bool __mptcp_check_fallback(const struct mptcp_sock *msk)
 726 {
 727         return test_bit(MPTCP_FALLBACK_DONE, &msk->flags);
 728 }
 729
 730 static inline bool mptcp_check_fallback(const struct sock *sk)
 731 {
 732         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
 733         struct mptcp_sock *msk = mptcp_sk(subflow->conn);
 734
 735         return __mptcp_check_fallback(msk);
 736 }
 737
 738 static inline void __mptcp_do_fallback(struct mptcp_sock *msk)
 739 {
 740         if (test_bit(MPTCP_FALLBACK_DONE, &msk->flags)) {
 741                 pr_debug("TCP fallback already done (msk=%p)", msk);
 742                 return;
 743         }
 744         set_bit(MPTCP_FALLBACK_DONE, &msk->flags);
 745 }
 746
 747 static inline void mptcp_do_fallback(struct sock *sk)
 748 {
 749         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
 750         struct mptcp_sock *msk = mptcp_sk(subflow->conn);
 751
 752         __mptcp_do_fallback(msk);
 753 }
 754
 755 #define pr_fallback(a) pr_debug("%s:fallback to TCP (msk=%p)", __func__, a)
 756
 757 static inline bool subflow_simultaneous_connect(struct sock *sk)
 758 {
 759         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
 760         struct sock *parent = subflow->conn;
 761
 762         return sk->sk_state == TCP_ESTABLISHED &&
 763                !mptcp_sk(parent)->pm.server_side &&
 764                !subflow->conn_finished;
 765 }
 766
 767 #ifdef CONFIG_SYN_COOKIES
 768 void subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
 769                                        struct sk_buff *skb);
 770 bool mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
 771                                         struct sk_buff *skb);
 772 void __init mptcp_join_cookie_init(void);
 773 #else
 774 static inline void
 775 subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
 776                                   struct sk_buff *skb) {}
 777 static inline bool
 778 mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
 779                                    struct sk_buff *skb)
 780 {
 781         return false;
 782 }
 783
 784 static inline void mptcp_join_cookie_init(void) {}
 785 #endif
 786
 787 #endif /* __MPTCP_PROTOCOL_H */