bsd/netinet/mptcp_var.h

   1 /*
   2  * Copyright (c) 2012-2017 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29 #ifndef _NETINET_MPTCP_VAR_H_
  30 #define _NETINET_MPTCP_VAR_H_
  31
  32 #ifdef PRIVATE
  33 #include <netinet/in.h>
  34 #include <netinet/tcp.h>
  35 #endif
  36
  37 #ifdef BSD_KERNEL_PRIVATE
  38 #include <sys/queue.h>
  39 #include <sys/protosw.h>
  40 #include <kern/locks.h>
  41 #include <mach/boolean.h>
  42 #include <netinet/mp_pcb.h>
  43 #include <netinet/tcp_var.h>
  44
  45 struct mpt_itf_info {
  46         uint32_t ifindex;
  47         uint32_t has_v4_conn:1,
  48                  has_v6_conn:1,
  49                  no_mptcp_support:1;
  50 };
  51
  52 /*
  53  * MPTCP Session
  54  *
  55  * This is an extension to the multipath PCB specific for MPTCP, protected by
  56  * the per-PCB mpp_lock (also the socket's lock);
  57  */
  58 struct mptses {
  59         struct mppcb    *mpte_mppcb;            /* back ptr to multipath PCB */
  60         struct mptcb    *mpte_mptcb;            /* ptr to MPTCP PCB */
  61         TAILQ_HEAD(, mptopt) mpte_sopts;        /* list of socket options */
  62         TAILQ_HEAD(, mptsub) mpte_subflows;     /* list of subflows */
  63         uint16_t        mpte_numflows;          /* # of subflows in list */
  64         uint16_t        mpte_nummpcapflows;     /* # of MP_CAP subflows */
  65         sae_associd_t   mpte_associd;           /* MPTCP association ID */
  66         sae_connid_t    mpte_connid_last;       /* last used connection ID */
  67
  68         union {
  69                 /* Source address of initial subflow */
  70                 struct sockaddr mpte_src;
  71                 struct sockaddr_in __mpte_src_v4;
  72                 struct sockaddr_in6 __mpte_src_v6;
  73         };
  74
  75         union {
  76                 /* Destination address of initial subflow */
  77                 struct sockaddr mpte_dst;
  78                 struct sockaddr_in __mpte_dst_v4;
  79                 struct sockaddr_in6 __mpte_dst_v6;
  80         };
  81
  82         struct mptsub   *mpte_active_sub;       /* ptr to last active subf */
  83         uint8_t mpte_flags;                     /* per mptcp session flags */
  84 #define MPTE_SND_REM_ADDR       0x01            /* Send Remove_addr option */
  85 #define MPTE_SVCTYPE_CHECKED    0x02            /* Did entitlement-check for service-type */
  86 #define MPTE_FIRSTPARTY         0x04            /* First-party app used multipath_extended entitlement */
  87 #define MPTE_ACCESS_GRANTED     0x08            /* Access to cellular has been granted for this connection */
  88         uint8_t mpte_svctype;                   /* MPTCP Service type */
  89         uint8_t mpte_lost_aid;                  /* storing lost address id */
  90         uint8_t mpte_addrid_last;               /* storing address id parm */
  91
  92 #define MPTE_ITFINFO_SIZE       4
  93         uint32_t        mpte_itfinfo_size;
  94         struct mpt_itf_info     _mpte_itfinfo[MPTE_ITFINFO_SIZE];
  95         struct mpt_itf_info     *mpte_itfinfo;
  96
  97         struct mbuf             *mpte_reinjectq;
  98
  99         /* The below is used for stats */
 100         uint32_t        mpte_subflow_switches;  /* Number of subflow-switches in sending */
 101         uint32_t        mpte_used_cell:1,
 102                         mpte_used_wifi:1,
 103                         mpte_initial_cell:1,
 104                         mpte_handshake_success:1;
 105
 106         struct mptcp_itf_stats  mpte_itfstats[MPTCP_ITFSTATS_SIZE];
 107         uint64_t                mpte_init_txbytes __attribute__((aligned(8)));
 108         uint64_t                mpte_init_rxbytes __attribute__((aligned(8)));
 109 };
 110
 111 static inline struct socket *
 112 mptetoso(struct mptses *mpte)
 113 {
 114         return (mpte->mpte_mppcb->mpp_socket);
 115 }
 116
 117 static inline struct mptses *
 118 mptompte(struct mppcb *mp)
 119 {
 120         return ((struct mptses *)mp->mpp_pcbe);
 121 }
 122
 123 static inline struct mptses *
 124 mpsotompte(struct socket *so)
 125 {
 126         return (mptompte(mpsotomppcb(so)));
 127 }
 128
 129 static inline void
 130 mpp_lock_assert_held(struct mppcb *mp)
 131 {
 132 #if !MACH_ASSERT
 133 #pragma unused(mp)
 134 #endif
 135         LCK_MTX_ASSERT(&mp->mpp_lock, LCK_MTX_ASSERT_OWNED);
 136 }
 137
 138 static inline void
 139 mpp_lock_assert_notheld(struct mppcb *mp)
 140 {
 141 #if !MACH_ASSERT
 142 #pragma unused(mp)
 143 #endif
 144         LCK_MTX_ASSERT(&mp->mpp_lock, LCK_MTX_ASSERT_NOTOWNED);
 145 }
 146
 147 static inline boolean_t
 148 mpp_try_lock(struct mppcb *mp)
 149 {
 150         if (!lck_mtx_try_lock(&mp->mpp_lock))
 151                 return false;
 152
 153         VERIFY(!(mp->mpp_flags & MPP_INSIDE_OUTPUT));
 154         VERIFY(!(mp->mpp_flags & MPP_INSIDE_INPUT));
 155
 156         return true;
 157 }
 158
 159 static inline void
 160 mpp_lock(struct mppcb *mp)
 161 {
 162         lck_mtx_lock(&mp->mpp_lock);
 163         VERIFY(!(mp->mpp_flags & MPP_INSIDE_OUTPUT));
 164         VERIFY(!(mp->mpp_flags & MPP_INSIDE_INPUT));
 165 }
 166
 167 static inline void
 168 mpp_unlock(struct mppcb *mp)
 169 {
 170         VERIFY(!(mp->mpp_flags & MPP_INSIDE_OUTPUT));
 171         VERIFY(!(mp->mpp_flags & MPP_INSIDE_INPUT));
 172         lck_mtx_unlock(&mp->mpp_lock);
 173 }
 174
 175 static inline lck_mtx_t *
 176 mpp_getlock(struct mppcb *mp, int flags)
 177 {
 178         if (flags & PR_F_WILLUNLOCK) {
 179                 VERIFY(!(mp->mpp_flags & MPP_INSIDE_OUTPUT));
 180                 VERIFY(!(mp->mpp_flags & MPP_INSIDE_INPUT));
 181         }
 182
 183         return (&mp->mpp_lock);
 184 }
 185
 186 static inline void
 187 mpte_lock_assert_held(struct mptses *mpte)
 188 {
 189         mpp_lock_assert_held(mpte->mpte_mppcb);
 190 }
 191
 192 static inline void
 193 mpte_lock_assert_notheld(struct mptses *mpte)
 194 {
 195         mpp_lock_assert_notheld(mpte->mpte_mppcb);
 196 }
 197
 198 static inline boolean_t
 199 mpte_try_lock(struct mptses *mpte)
 200 {
 201         return (mpp_try_lock(mpte->mpte_mppcb));
 202 }
 203
 204 static inline void
 205 mpte_lock(struct mptses *mpte)
 206 {
 207         mpp_lock(mpte->mpte_mppcb);
 208 }
 209
 210 static inline void
 211 mpte_unlock(struct mptses *mpte)
 212 {
 213         mpp_unlock(mpte->mpte_mppcb);
 214 }
 215
 216 static inline lck_mtx_t *
 217 mpte_getlock(struct mptses *mpte, int flags)
 218 {
 219         return mpp_getlock(mpte->mpte_mppcb, flags);
 220 }
 221
 222 static inline int
 223 mptcp_subflow_cwnd_space(struct socket *so)
 224 {
 225         struct tcpcb *tp = sototcpcb(so);
 226         int cwnd = min(tp->snd_wnd, tp->snd_cwnd) - (so->so_snd.sb_cc);
 227
 228         return (min(cwnd, sbspace(&so->so_snd)));
 229 }
 230
 231
 232 /*
 233  * MPTCP socket options
 234  */
 235 struct mptopt {
 236         TAILQ_ENTRY(mptopt)     mpo_entry;      /* glue to other options */
 237         uint32_t                mpo_flags;      /* see flags below */
 238         int                     mpo_level;      /* sopt_level */
 239         int                     mpo_name;       /* sopt_name */
 240         int                     mpo_intval;     /* sopt_val */
 241 };
 242
 243 #define MPOF_ATTACHED           0x1     /* attached to MP socket */
 244 #define MPOF_SUBFLOW_OK         0x2     /* can be issued on subflow socket */
 245 #define MPOF_INTERIM            0x4     /* has not been issued on any subflow */
 246
 247 /*
 248  * MPTCP subflow
 249  *
 250  * Note that mpts_flags and mpts_evctl are modified via atomic operations.
 251  */
 252 struct mptsub {
 253         TAILQ_ENTRY(mptsub)     mpts_entry;     /* glue to peer subflows */
 254         uint32_t                mpts_refcnt;    /* reference count */
 255         uint32_t                mpts_flags;     /* see flags below */
 256         uint32_t                mpts_evctl;     /* subflow control events */
 257         sae_connid_t            mpts_connid;    /* subflow connection ID */
 258         int                     mpts_oldintval; /* sopt_val before sosetopt  */
 259         struct mptses           *mpts_mpte;     /* back ptr to MPTCP session */
 260         struct socket           *mpts_socket;   /* subflow socket */
 261         struct sockaddr         *mpts_src;      /* source address */
 262
 263         union {
 264                 /* destination address */
 265                 struct sockaddr         mpts_dst;
 266                 struct sockaddr_in      __mpts_dst_v4;
 267                 struct sockaddr_in6     __mpts_dst_v6;
 268         };
 269
 270         u_int32_t               mpts_rel_seq;   /* running count of subflow # */
 271         u_int32_t               mpts_iss;       /* Initial sequence number, taking TFO into account */
 272         u_int32_t               mpts_ifscope;   /* scoped to the interface */
 273         uint32_t                mpts_probesoon; /* send probe after probeto */
 274         uint32_t                mpts_probecnt;  /* number of probes sent */
 275         uint32_t                mpts_maxseg;    /* cached value of t_maxseg */
 276 };
 277
 278 /*
 279  * Valid values for mpts_flags.  In particular:
 280  *
 281  *    - MP_CAPABLE means that the connection is successfully established as
 282  *      MPTCP and data transfer may occur, but is not yet ready for multipath-
 283  *      related semantics until MP_READY.  I.e. if this is on the first subflow,
 284  *      it causes the MPTCP socket to transition to a connected state, except
 285  *      that additional subflows will not be established; they will be marked
 286  *      with PENDING and will be processed when the first subflow is marked
 287  *      with MP_READY.
 288  *
 289  *    - MP_READY implies that an MP_CAPABLE connection has been confirmed as
 290  *      an MPTCP connection.  See notes above.
 291  *
 292  *    - MP_DEGRADED implies that the connection has lost its MPTCP capabilities
 293  *      but data transfer on the MPTCP socket is unaffected.  Any existing
 294  *      PENDING subflows will be disconnected, and further attempts to connect
 295  *      additional subflows will be rejected.
 296  *
 297  * Note that these are per-subflow flags.  The setting and clearing of MP_READY
 298  * reflects the state of the MPTCP connection with regards to its multipath
 299  * semantics, via the MPTCPF_JOIN_READY flag.  Until that flag is set (meaning
 300  * until at least a subflow is marked with MP_READY), further connectx(2)
 301  * attempts to join will be queued.  When the flag is cleared (after it has
 302  * been set), further connectx(2) will fail (and existing queued ones will be
 303  * aborted) and the MPTCP connection loses all of its multipath semantics.
 304  *
 305  * Keep in sync with bsd/dev/dtrace/scripts/mptcp.d.
 306  */
 307 #define MPTSF_ATTACHED          0x00000001      /* attached to MPTCP PCB */
 308 #define MPTSF_CONNECTING        0x00000002      /* connection was attempted */
 309 #define MPTSF_CONNECT_PENDING   0x00000004      /* will connect when MPTCP is ready */
 310 #define MPTSF_CONNECTED         0x00000008      /* connection is established */
 311 #define MPTSF_DISCONNECTING     0x00000010      /* disconnection was attempted */
 312 #define MPTSF_DISCONNECTED      0x00000020      /* has been disconnected */
 313 #define MPTSF_MP_CAPABLE        0x00000040      /* connected as a MPTCP subflow */
 314 #define MPTSF_MP_READY          0x00000080      /* MPTCP has been confirmed */
 315 #define MPTSF_MP_DEGRADED       0x00000100      /* has lost its MPTCP capabilities */
 316 #define MPTSF_PREFERRED         0x00000200      /* primary/preferred subflow */
 317 #define MPTSF_SOPT_OLDVAL       0x00000400      /* old option value is valid */
 318 #define MPTSF_SOPT_INPROG       0x00000800      /* sosetopt in progress */
 319 #define MPTSF_FAILINGOVER       0x00001000      /* subflow not used for output */
 320 #define MPTSF_ACTIVE            0x00002000      /* subflow currently in use */
 321 #define MPTSF_MPCAP_CTRSET      0x00004000      /* mpcap counter */
 322 #define MPTSF_CLOSED            0x00008000      /* soclose_locked has been called on this subflow */
 323 #define MPTSF_TFO_REQD          0x00010000      /* TFO requested */
 324 #define MPTSF_CLOSE_REQD        0x00020000      /* A close has been requested from NECP */
 325 #define MPTSF_INITIAL_SUB       0x00040000      /* This is the initial subflow */
 326 #define MPTSF_READ_STALL        0x00080000      /* A read-stall has been detected */
 327 #define MPTSF_WRITE_STALL       0x00100000      /* A write-stall has been detected */
 328 #define MPTSF_CONFIRMED         0x00200000      /* Subflow confirmed to be MPTCP-capable */
 329
 330 #define MPTSF_BITS \
 331         "\020\1ATTACHED\2CONNECTING\3PENDING\4CONNECTED\5DISCONNECTING" \
 332         "\6DISCONNECTED\7MP_CAPABLE\10MP_READY\11MP_DEGRADED" \
 333         "\12PREFERRED\13SOPT_OLDVAL" \
 334         "\14SOPT_INPROG\15FAILINGOVER\16ACTIVE\17MPCAP_CTRSET" \
 335         "\20CLOSED\21TFO_REQD\22CLOSEREQD\23INITIALSUB\24READ_STALL" \
 336         "\25WRITE_STALL\26CONFIRMED"
 337
 338 /*
 339  * MPTCP states
 340  * Keep in sync with bsd/dev/dtrace/mptcp.d
 341  */
 342 typedef enum mptcp_state {
 343         MPTCPS_CLOSED           = 0,    /* closed */
 344         MPTCPS_LISTEN           = 1,    /* not yet implemented */
 345         MPTCPS_ESTABLISHED      = 2,    /* MPTCP connection established */
 346         MPTCPS_CLOSE_WAIT       = 3,    /* rcvd DFIN, waiting for close */
 347         MPTCPS_FIN_WAIT_1       = 4,    /* have closed, sent DFIN */
 348         MPTCPS_CLOSING          = 5,    /* closed xchd DFIN, waiting DFIN ACK */
 349         MPTCPS_LAST_ACK         = 6,    /* had DFIN and close; await DFIN ACK */
 350         MPTCPS_FIN_WAIT_2       = 7,    /* have closed, DFIN is acked */
 351         MPTCPS_TIME_WAIT        = 8,    /* in 2*MSL quiet wait after close */
 352         MPTCPS_TERMINATE        = 9,    /* terminal state */
 353 } mptcp_state_t;
 354
 355 typedef u_int64_t       mptcp_key_t;
 356 typedef u_int32_t       mptcp_token_t;
 357 typedef u_int8_t        mptcp_addr_id;
 358
 359
 360 /* Address ID list */
 361 struct mptcp_subf_auth_entry {
 362         LIST_ENTRY(mptcp_subf_auth_entry) msae_next;
 363         u_int32_t       msae_laddr_rand;        /* Local nonce */
 364         u_int32_t       msae_raddr_rand;        /* Remote nonce */
 365         mptcp_addr_id   msae_laddr_id;          /* Local addr ID */
 366         mptcp_addr_id   msae_raddr_id;          /* Remote addr ID */
 367 };
 368
 369 /*
 370  * MPTCP Protocol Control Block
 371  *
 372  * Protected by per-MPTCP mpt_lock.
 373  * Keep in sync with bsd/dev/dtrace/scripts/mptcp.d.
 374  */
 375 struct mptcb {
 376         struct mptses   *mpt_mpte;              /* back ptr to MPTCP session */
 377         mptcp_state_t   mpt_state;              /* MPTCP state */
 378         u_int32_t       mpt_flags;              /* see flags below */
 379         u_int32_t       mpt_version;            /* MPTCP proto version */
 380         int             mpt_softerror;          /* error not yet reported */
 381         /*
 382          * Authentication and metadata invariants
 383          */
 384         mptcp_key_t     mpt_localkey;           /* in network byte order */
 385         mptcp_key_t     mpt_remotekey;          /* in network byte order */
 386         mptcp_token_t   mpt_localtoken;         /* HMAC SHA1 of local key */
 387         mptcp_token_t   mpt_remotetoken;        /* HMAC SHA1 of remote key */
 388
 389         /*
 390          * Timer vars for scenarios where subflow level acks arrive, but
 391          * Data ACKs do not.
 392          */
 393         int             mpt_rxtshift;           /* num of consecutive retrans */
 394         u_int32_t       mpt_rxtstart;           /* time at which rxt started */
 395         u_int64_t       mpt_rtseq;              /* seq # being tracked */
 396         u_int32_t       mpt_timer_vals;         /* timer related values */
 397         u_int32_t       mpt_timewait;           /* timewait */
 398         /*
 399          * Sending side
 400          */
 401         u_int64_t       mpt_snduna;             /* DSN of last unacked byte */
 402         u_int64_t       mpt_sndnxt;             /* DSN of next byte to send */
 403         u_int64_t       mpt_sndmax;             /* DSN of max byte sent */
 404         u_int64_t       mpt_local_idsn;         /* First byte's DSN */
 405         u_int32_t       mpt_sndwnd;
 406         u_int64_t       mpt_sndwl1;
 407         u_int64_t       mpt_sndwl2;
 408         /*
 409          * Receiving side
 410          */
 411         u_int64_t       mpt_rcvnxt;             /* Next expected DSN */
 412         u_int64_t       mpt_remote_idsn;        /* Peer's IDSN */
 413         u_int32_t       mpt_rcvwnd;
 414         LIST_HEAD(, mptcp_subf_auth_entry) mpt_subauth_list; /* address IDs */
 415         /*
 416          * Fastclose
 417          */
 418         u_int64_t       mpt_dsn_at_csum_fail;   /* MPFail Opt DSN */
 419         u_int32_t       mpt_ssn_at_csum_fail;   /* MPFail Subflow Seq */
 420         /*
 421          * Zombie handling
 422          */
 423 #define MPT_GC_TICKS            (30)
 424 #define MPT_GC_TICKS_FAST       (10)
 425         int32_t         mpt_gc_ticks;           /* Used for zombie deletion */
 426
 427         u_int32_t       mpt_notsent_lowat;      /* TCP_NOTSENT_LOWAT support */
 428         u_int32_t       mpt_peer_version;       /* Version from peer */
 429
 430         struct tsegqe_head      mpt_segq;
 431         u_int16_t       mpt_reassqlen;          /* length of reassembly queue */
 432 };
 433
 434 /* valid values for mpt_flags (see also notes on mpts_flags above) */
 435 #define MPTCPF_CHECKSUM                 0x001   /* checksum DSS option */
 436 #define MPTCPF_FALLBACK_TO_TCP          0x002   /* Fallback to TCP */
 437 #define MPTCPF_JOIN_READY               0x004   /* Ready to start 2 or more subflows */
 438 #define MPTCPF_RECVD_MPFAIL             0x008   /* Received MP_FAIL option */
 439 #define MPTCPF_SND_64BITDSN             0x010   /* Send full 64-bit DSN */
 440 #define MPTCPF_SND_64BITACK             0x020   /* Send 64-bit ACK response */
 441 #define MPTCPF_RCVD_64BITACK            0x040   /* Received 64-bit Data ACK */
 442 #define MPTCPF_POST_FALLBACK_SYNC       0x080   /* Post fallback resend data */
 443 #define MPTCPF_FALLBACK_HEURISTIC       0x100   /* Send SYN without MP_CAPABLE due to heuristic */
 444 #define MPTCPF_HEURISTIC_TRAC           0x200   /* Tracked this connection in the heuristics as a failure */
 445 #define MPTCPF_REASS_INPROG             0x400   /* Reassembly is in progress */
 446
 447 #define MPTCPF_BITS \
 448         "\020\1CHECKSUM\2FALLBACK_TO_TCP\3JOIN_READY\4RECVD_MPFAIL" \
 449         "\5SND_64BITDSN\6SND_64BITACK\7RCVD_64BITACK\10POST_FALLBACK_SYNC" \
 450         "\11FALLBACK_HEURISTIC\12HEURISTIC_TRAC\13REASS_INPROG"
 451
 452 /* valid values for mpt_timer_vals */
 453 #define MPTT_REXMT              0x01    /* Starting Retransmit Timer */
 454 #define MPTT_TW                 0x02    /* Starting Timewait Timer */
 455 #define MPTT_FASTCLOSE          0x04    /* Starting Fastclose wait timer */
 456
 457 /* events for close FSM */
 458 #define MPCE_CLOSE              0x1
 459 #define MPCE_RECV_DATA_ACK      0x2
 460 #define MPCE_RECV_DATA_FIN      0x4
 461
 462 /* mptcb manipulation */
 463 static inline struct mptcb *tptomptp(struct tcpcb *tp)
 464 {
 465         return (tp->t_mptcb);
 466 }
 467
 468 /*
 469  * MPTCP control block and state structures are allocated along with
 470  * the MP protocol control block; the folllowing represents the layout.
 471  */
 472 struct mpp_mtp {
 473         struct mppcb            mpp;            /* Multipath PCB */
 474         struct mptses           mpp_ses;        /* MPTCP session */
 475         struct mptcb            mtcb;           /* MPTCP PCB */
 476 };
 477
 478 #ifdef SYSCTL_DECL
 479 SYSCTL_DECL(_net_inet_mptcp);
 480 #endif /* SYSCTL_DECL */
 481
 482 extern struct mppcbinfo mtcbinfo;
 483 extern struct pr_usrreqs mptcp_usrreqs;
 484
 485 /* Encryption algorithm related definitions */
 486 #define SHA1_TRUNCATED          8
 487
 488 /* MPTCP Debugging Levels */
 489 #define MPTCP_LOGLVL_NONE       0x0     /* No debug logging */
 490 #define MPTCP_LOGLVL_ERR        0x1     /* Errors in execution are logged */
 491 #define MPTCP_LOGLVL_LOG        0x2     /* Important logs */
 492 #define MPTCP_LOGLVL_VERBOSE    0x4     /* Verbose logs */
 493
 494 /* MPTCP sub-components for debug logging */
 495 #define MPTCP_NO_DBG            0x00    /* No areas are logged */
 496 #define MPTCP_STATE_DBG         0x01    /* State machine logging */
 497 #define MPTCP_SOCKET_DBG        0x02    /* Socket call logging */
 498 #define MPTCP_SENDER_DBG        0x04    /* Sender side logging */
 499 #define MPTCP_RECEIVER_DBG      0x08    /* Receiver logging */
 500 #define MPTCP_EVENTS_DBG        0x10    /* Subflow events logging */
 501
 502 /* Mask to obtain 32-bit portion of data sequence number */
 503 #define MPTCP_DATASEQ_LOW32_MASK        (0xffffffff)
 504 #define MPTCP_DATASEQ_LOW32(seq)        (seq & MPTCP_DATASEQ_LOW32_MASK)
 505
 506 /* Mask to obtain upper 32-bit portion of data sequence number */
 507 #define MPTCP_DATASEQ_HIGH32_MASK       (0xffffffff00000000)
 508 #define MPTCP_DATASEQ_HIGH32(seq)       (seq & MPTCP_DATASEQ_HIGH32_MASK)
 509
 510 /* Mask to obtain 32-bit portion of data ack */
 511 #define MPTCP_DATAACK_LOW32_MASK        (0xffffffff)
 512 #define MPTCP_DATAACK_LOW32(ack)        (ack & MPTCP_DATAACK_LOW32_MASK)
 513
 514 /* Mask to obtain upper 32-bit portion of data ack */
 515 #define MPTCP_DATAACK_HIGH32_MASK       (0xffffffff00000000)
 516 #define MPTCP_DATAACK_HIGH32(ack)       (ack & MPTCP_DATAACK_HIGH32_MASK)
 517
 518 /*
 519  * x is the 64-bit data sequence number, y the 32-bit data seq number to be
 520  * extended. z is y extended to the appropriate 64-bit value.
 521  * This algorithm is based on the fact that subflow level window sizes are
 522  * at the maximum 2**30 (in reality, they are a lot lesser). A high throughput
 523  * application sending on a large number of subflows can in theory have very
 524  * large MPTCP level send and receive windows. In which case, 64 bit DSNs
 525  * must be sent in place of 32 bit DSNs on wire. For us, with 2 subflows at
 526  * 512K each, sequence wraparound detection can be done by checking whether
 527  * the 32-bit value obtained on wire is 2**31 bytes apart from the stored
 528  * lower 32-bits of the Data Sequence Number. Bogus DSNs are dropped by
 529  * comparing against rwnd. Bogus DSNs within rwnd cannot be protected against
 530  * and are as weak as bogus TCP sequence numbers.
 531  */
 532 #define MPTCP_EXTEND_DSN(x, y, z) {                                     \
 533         if ((MPTCP_DATASEQ_LOW32(x) > y) &&                             \
 534             ((((u_int32_t)MPTCP_DATASEQ_LOW32(x)) - (u_int32_t)y) >=    \
 535             (u_int32_t)(1 << 31))) {                                    \
 536                 /*                                                      \
 537                  * y wrapped around and x and y are 2**31 bytes  apart  \
 538                  */                                                     \
 539                 z = MPTCP_DATASEQ_HIGH32(x) + 0x100000000;              \
 540                 z |= y;                                                 \
 541         } else if ((MPTCP_DATASEQ_LOW32(x) < y) &&                      \
 542             (((u_int32_t)y -                                            \
 543             ((u_int32_t)MPTCP_DATASEQ_LOW32(x))) >=                     \
 544             (u_int32_t)(1 << 31))) {                                    \
 545                 /*                                                      \
 546                  * x wrapped around and x and y are 2**31 apart         \
 547                  */                                                     \
 548                 z = MPTCP_DATASEQ_HIGH32(x) - 0x100000000;              \
 549                 z |= y;                                                 \
 550         } else {                                                        \
 551                 z = MPTCP_DATASEQ_HIGH32(x) | y;                        \
 552         }                                                               \
 553 }
 554
 555 #define mptcplog(x, y, z)       do {                                    \
 556         if ((mptcp_dbg_area & y) && (mptcp_dbg_level & z))              \
 557                 log x;                                                  \
 558 } while (0)
 559
 560 extern int mptcp_enable;        /* Multipath TCP */
 561 extern int mptcp_mpcap_retries; /* Multipath TCP retries */
 562 extern int mptcp_join_retries;  /* Multipath TCP Join retries */
 563 extern int mptcp_dss_csum;      /* Multipath DSS Option checksum */
 564 extern int mptcp_fail_thresh;   /* Multipath failover thresh of retransmits */
 565 extern int mptcp_subflow_keeptime; /* Multipath subflow TCP_KEEPALIVE opt */
 566 extern uint32_t mptcp_dbg_level;        /* Multipath TCP debugging level */
 567 extern uint32_t mptcp_dbg_area; /* Multipath TCP debugging area */
 568 extern int mptcp_developer_mode;        /* Allow aggregation mode */
 569
 570 extern int tcp_jack_rxmt;       /* Join ACK retransmission value in msecs */
 571
 572 __BEGIN_DECLS
 573 extern void mptcp_init(struct protosw *, struct domain *);
 574 extern int mptcp_ctloutput(struct socket *, struct sockopt *);
 575 extern int mptcp_sescreate(struct mppcb *);
 576 extern void mptcp_check_subflows_and_add(struct mptses *);
 577 extern int mptcp_get_statsindex(struct mptcp_itf_stats *stats,
 578                                 const struct mptsub *mpts);
 579 extern void mptcpstats_inc_switch(struct mptses *, const struct mptsub *);
 580 extern struct mptses *mptcp_drop(struct mptses *, struct mptcb *, int);
 581 extern struct mptses *mptcp_close(struct mptses *, struct mptcb *);
 582 extern int mptcp_lock(struct socket *, int, void *);
 583 extern int mptcp_unlock(struct socket *, int, void *);
 584 extern lck_mtx_t *mptcp_getlock(struct socket *, int);
 585 extern void mptcp_subflow_workloop(struct mptses *);
 586
 587 extern void mptcp_sched_create_subflows(struct mptses *);
 588
 589 extern struct mptopt *mptcp_sopt_alloc(int);
 590 extern const char *mptcp_sopt2str(int, int);
 591 extern void mptcp_sopt_free(struct mptopt *);
 592 extern void mptcp_sopt_insert(struct mptses *, struct mptopt *);
 593 extern void mptcp_sopt_remove(struct mptses *, struct mptopt *);
 594 extern struct mptopt *mptcp_sopt_find(struct mptses *, struct sockopt *);
 595
 596 extern int mptcp_subflow_add(struct mptses *, struct sockaddr *,
 597     struct sockaddr *, uint32_t, sae_connid_t *);
 598 extern void mptcpstats_update(struct mptcp_itf_stats *stats, struct mptsub *mpts);
 599 extern void mptcp_subflow_del(struct mptses *, struct mptsub *);
 600
 601 #define MPTCP_SUBOUT_PROBING    0x01
 602 extern int mptcp_subflow_output(struct mptses *mpte, struct mptsub *mpts, int flags);
 603 extern void mptcp_clean_reinjectq(struct mptses *mpte);
 604 extern void mptcp_subflow_shutdown(struct mptses *, struct mptsub *);
 605 extern void mptcp_subflow_disconnect(struct mptses *, struct mptsub *);
 606 extern int mptcp_subflow_sosetopt(struct mptses *, struct mptsub *,
 607     struct mptopt *);
 608 extern int mptcp_subflow_sogetopt(struct mptses *, struct socket *,
 609     struct mptopt *);
 610
 611 extern void mptcp_input(struct mptses *, struct mbuf *);
 612 extern int mptcp_output(struct mptses *);
 613 extern void mptcp_close_fsm(struct mptcb *, uint32_t);
 614
 615 extern void mptcp_hmac_sha1(mptcp_key_t, mptcp_key_t, u_int32_t, u_int32_t,
 616     u_char*);
 617 extern void mptcp_get_hmac(mptcp_addr_id, struct mptcb *, u_char *);
 618 extern void mptcp_get_rands(mptcp_addr_id, struct mptcb *, u_int32_t *,
 619     u_int32_t *);
 620 extern void mptcp_set_raddr_rand(mptcp_addr_id, struct mptcb *, mptcp_addr_id,
 621     u_int32_t);
 622 extern int mptcp_init_remote_parms(struct mptcb *);
 623 extern boolean_t mptcp_ok_to_keepalive(struct mptcb *);
 624 extern void mptcp_insert_dsn(struct mppcb *, struct mbuf *);
 625 extern void mptcp_output_getm_dsnmap32(struct socket *so, int off,
 626                                        uint32_t *dsn, uint32_t *relseq,
 627                                        uint16_t *data_len, uint16_t *dss_csum);
 628 extern void mptcp_output_getm_dsnmap64(struct socket *so, int off,
 629                                        uint64_t *dsn, uint32_t *relseq,
 630                                        uint16_t *data_len, uint16_t *dss_csum);
 631 extern void mptcp_act_on_txfail(struct socket *);
 632 extern struct mptsub *mptcp_get_subflow(struct mptses *, struct mptsub *,
 633     struct mptsub **);
 634 extern int mptcp_get_map_for_dsn(struct socket *, u_int64_t, u_int32_t *);
 635 extern int32_t mptcp_adj_sendlen(struct socket *so, int32_t off);
 636 extern void mptcp_sbrcv_grow(struct mptcb *mp_tp);
 637 extern int32_t mptcp_sbspace(struct mptcb *);
 638 extern void mptcp_notify_mpready(struct socket *);
 639 extern void mptcp_notify_mpfail(struct socket *);
 640 extern void mptcp_notify_close(struct socket *);
 641 extern boolean_t mptcp_no_rto_spike(struct socket*);
 642 extern int mptcp_set_notsent_lowat(struct mptses *mpte, int optval);
 643 extern u_int32_t mptcp_get_notsent_lowat(struct mptses *mpte);
 644 extern int mptcp_notsent_lowat_check(struct socket *so);
 645 extern void mptcp_ask_symptoms(struct mptses *mpte);
 646 extern void mptcp_control_register(void);
 647 extern int mptcp_is_wifi_unusable(void);
 648 extern void mptcp_session_necp_cb(void *, int, struct necp_client_flow *);
 649 extern void mptcp_set_restrictions(struct socket *mp_so);
 650 extern int mptcp_freeq(struct mptcb *);
 651 extern void mptcp_set_cellicon(struct mptses *mpte);
 652 extern void mptcp_unset_cellicon(void);
 653 extern void mptcp_reset_rexmit_state(struct tcpcb *tp);
 654 extern void mptcp_reset_keepalive(struct tcpcb *tp);
 655 extern int mptcp_validate_csum(struct tcpcb *tp, struct mbuf *m, uint64_t dsn,
 656                                uint32_t sseq, uint16_t dlen, uint16_t csum,
 657                                uint16_t dfin);
 658 __END_DECLS
 659
 660 #endif /* BSD_KERNEL_PRIVATE */
 661 #ifdef PRIVATE
 662
 663 typedef struct mptcp_flow {
 664         size_t                  flow_len;
 665         size_t                  flow_tcpci_offset;
 666         uint32_t                flow_flags;
 667         sae_connid_t            flow_cid;
 668         struct sockaddr_storage flow_src;
 669         struct sockaddr_storage flow_dst;
 670         uint32_t                flow_relseq;    /* last subflow rel seq# */
 671         int32_t                 flow_soerror;   /* subflow level error */
 672         uint32_t                flow_probecnt;  /* number of probes sent */
 673         conninfo_tcp_t          flow_ci;        /* must be the last field */
 674 } mptcp_flow_t;
 675
 676 typedef struct conninfo_mptcp {
 677         size_t          mptcpci_len;
 678         size_t          mptcpci_flow_offset;    /* offsetof first flow */
 679         size_t          mptcpci_nflows;         /* number of subflows */
 680         uint32_t        mptcpci_state;          /* MPTCP level state */
 681         uint32_t        mptcpci_mpte_flags;     /* Session flags */
 682         uint32_t        mptcpci_flags;          /* MPTCB flags */
 683         uint32_t        mptcpci_ltoken;         /* local token */
 684         uint32_t        mptcpci_rtoken;         /* remote token */
 685         uint32_t        mptcpci_notsent_lowat;  /* NOTSENT_LOWAT */
 686
 687         /* Send side */
 688         uint64_t        mptcpci_snduna;         /* DSN of last unacked byte */
 689         uint64_t        mptcpci_sndnxt;         /* DSN of next byte to send */
 690         uint64_t        mptcpci_sndmax;         /* DSN of max byte sent */
 691         uint64_t        mptcpci_lidsn;          /* Local IDSN */
 692         uint32_t        mptcpci_sndwnd;         /* Send window snapshot */
 693
 694         /* Receive side */
 695         uint64_t        mptcpci_rcvnxt;         /* Next expected DSN */
 696         uint64_t        mptcpci_rcvatmark;      /* Session level rcvnxt */
 697         uint64_t        mptcpci_ridsn;          /* Peer's IDSN */
 698         uint32_t        mptcpci_rcvwnd;         /* Receive window */
 699
 700         uint8_t         mptcpci_mpte_addrid;    /* last addr id */
 701
 702         mptcp_flow_t    mptcpci_flows[1];
 703 } conninfo_mptcp_t;
 704
 705 /* Use SymptomsD notifications of wifi and cell status in subflow selection */
 706 #define MPTCP_KERN_CTL_NAME    "com.apple.network.advisory"
 707 typedef struct symptoms_advisory {
 708         union {
 709                 uint32_t        sa_nwk_status_int;
 710                 struct {
 711                         union {
 712 #define SYMPTOMS_ADVISORY_NOCOMMENT     0x0000
 713 #define SYMPTOMS_ADVISORY_USEAPP        0xFFFF /* Very ugly workaround to avoid breaking backwards compatibility - ToDo: Fix it in +1 */
 714                                 uint16_t        sa_nwk_status;
 715                                 struct {
 716 #define SYMPTOMS_ADVISORY_WIFI_BAD     0x01
 717 #define SYMPTOMS_ADVISORY_WIFI_OK      0x02
 718                                         uint8_t sa_wifi_status;
 719 #define SYMPTOMS_ADVISORY_CELL_BAD     0x01
 720 #define SYMPTOMS_ADVISORY_CELL_OK      0x02
 721                                         uint8_t sa_cell_status;
 722                                 };
 723                         };
 724                         uint16_t        sa_unused;
 725                 };
 726         };
 727 } symptoms_advisory_t;
 728
 729 struct mptcp_symptoms_ask_uuid {
 730         uint32_t        cmd;
 731 #define MPTCP_SYMPTOMS_ASK_UUID         1
 732         uuid_t          uuid;
 733         uint32_t        priority;
 734 #define MPTCP_SYMPTOMS_UNKNOWN          0
 735 #define MPTCP_SYMPTOMS_BACKGROUND       1
 736 #define MPTCP_SYMPTOMS_FOREGROUND       2
 737 };
 738
 739 struct kev_mptcp_data {
 740         int value;
 741 };
 742
 743 #endif /* PRIVATE */
 744 #endif /* _NETINET_MPTCP_VAR_H_ */