bsd/netinet/tcp.h

   1 /*
   2  * Copyright (c) 2000-2018 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  * Copyright (c) 1982, 1986, 1993
  30  *      The Regents of the University of California.  All rights reserved.
  31  *
  32  * Redistribution and use in source and binary forms, with or without
  33  * modification, are permitted provided that the following conditions
  34  * are met:
  35  * 1. Redistributions of source code must retain the above copyright
  36  *    notice, this list of conditions and the following disclaimer.
  37  * 2. Redistributions in binary form must reproduce the above copyright
  38  *    notice, this list of conditions and the following disclaimer in the
  39  *    documentation and/or other materials provided with the distribution.
  40  * 3. All advertising materials mentioning features or use of this software
  41  *    must display the following acknowledgement:
  42  *      This product includes software developed by the University of
  43  *      California, Berkeley and its contributors.
  44  * 4. Neither the name of the University nor the names of its contributors
  45  *    may be used to endorse or promote products derived from this software
  46  *    without specific prior written permission.
  47  *
  48  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  49  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  50  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  51  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  52  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  53  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  54  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  55  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  57  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  58  * SUCH DAMAGE.
  59  *
  60  *      @(#)tcp.h       8.1 (Berkeley) 6/10/93
  61  * $FreeBSD: src/sys/netinet/tcp.h,v 1.13.2.3 2001/03/01 22:08:42 jlemon Exp $
  62  */
  63
  64 #ifndef _NETINET_TCP_H_
  65 #define _NETINET_TCP_H_
  66 #ifndef DRIVERKIT
  67 #include <sys/appleapiopts.h>
  68 #endif /* DRIVERKIT */
  69
  70 #include <machine/endian.h>
  71 #include <machine/types.h> /* __uint32_t */
  72
  73 #ifndef DRIVERKIT
  74 #include <sys/types.h>
  75 #else
  76 #include <sys/_types.h>
  77 #endif /* DRIVERKIT */
  78
  79 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
  80 typedef __uint32_t tcp_seq;
  81 typedef __uint32_t tcp_cc;              /* connection count per rfc1644 */
  82
  83 #define tcp6_seq        tcp_seq /* for KAME src sync over BSD*'s */
  84 #define tcp6hdr         tcphdr  /* for KAME src sync over BSD*'s */
  85
  86 /*
  87  * TCP header.
  88  * Per RFC 793, September, 1981.
  89  */
  90 struct tcphdr {
  91         unsigned short  th_sport;       /* source port */
  92         unsigned short  th_dport;       /* destination port */
  93         tcp_seq th_seq;                 /* sequence number */
  94         tcp_seq th_ack;                 /* acknowledgement number */
  95 #if __DARWIN_BYTE_ORDER == __DARWIN_LITTLE_ENDIAN
  96         unsigned int    th_x2:4,        /* (unused) */
  97             th_off:4;                   /* data offset */
  98 #endif
  99 #if __DARWIN_BYTE_ORDER == __DARWIN_BIG_ENDIAN
 100         unsigned int    th_off:4,       /* data offset */
 101             th_x2:4;                    /* (unused) */
 102 #endif
 103         unsigned char   th_flags;
 104 #define TH_FIN  0x01
 105 #define TH_SYN  0x02
 106 #define TH_RST  0x04
 107 #define TH_PUSH 0x08
 108 #define TH_ACK  0x10
 109 #define TH_URG  0x20
 110 #define TH_ECE  0x40
 111 #define TH_CWR  0x80
 112 #define TH_FLAGS        (TH_FIN|TH_SYN|TH_RST|TH_ACK|TH_URG|TH_ECE|TH_CWR)
 113 #define TH_ACCEPT       (TH_FIN|TH_SYN|TH_RST|TH_ACK)
 114
 115         unsigned short  th_win;         /* window */
 116         unsigned short  th_sum;         /* checksum */
 117         unsigned short  th_urp;         /* urgent pointer */
 118 };
 119
 120 #define TCPOPT_EOL              0
 121 #define TCPOPT_NOP              1
 122 #define TCPOPT_MAXSEG           2
 123 #define TCPOLEN_MAXSEG          4
 124 #define TCPOPT_WINDOW           3
 125 #define TCPOLEN_WINDOW          3
 126 #define TCPOPT_SACK_PERMITTED   4               /* Experimental */
 127 #define TCPOLEN_SACK_PERMITTED  2
 128 #define TCPOPT_SACK             5               /* Experimental */
 129 #define TCPOLEN_SACK            8               /* len of sack block */
 130 #define TCPOPT_TIMESTAMP        8
 131 #define TCPOLEN_TIMESTAMP       10
 132 #define TCPOLEN_TSTAMP_APPA             (TCPOLEN_TIMESTAMP+2) /* appendix A */
 133 #define TCPOPT_TSTAMP_HDR               \
 134     (TCPOPT_NOP<<24|TCPOPT_NOP<<16|TCPOPT_TIMESTAMP<<8|TCPOLEN_TIMESTAMP)
 135
 136 #define MAX_TCPOPTLEN           40      /* Absolute maximum TCP options len */
 137
 138 #define TCPOPT_CC               11              /* CC options: RFC-1644 */
 139 #define TCPOPT_CCNEW            12
 140 #define TCPOPT_CCECHO           13
 141 #define    TCPOLEN_CC                   6
 142 #define    TCPOLEN_CC_APPA              (TCPOLEN_CC+2)
 143 #define    TCPOPT_CC_HDR(ccopt)         \
 144     (TCPOPT_NOP<<24|TCPOPT_NOP<<16|(ccopt)<<8|TCPOLEN_CC)
 145 #define TCPOPT_SIGNATURE                19      /* Keyed MD5: RFC 2385 */
 146 #define    TCPOLEN_SIGNATURE            18
 147 #if MPTCP
 148 #define TCPOPT_MULTIPATH                30
 149 #endif
 150
 151 #define TCPOPT_FASTOPEN                 34
 152 #define TCPOLEN_FASTOPEN_REQ            2
 153
 154 /* Option definitions */
 155 #define TCPOPT_SACK_PERMIT_HDR  \
 156 (TCPOPT_NOP<<24|TCPOPT_NOP<<16|TCPOPT_SACK_PERMITTED<<8|TCPOLEN_SACK_PERMITTED)
 157 #define TCPOPT_SACK_HDR         (TCPOPT_NOP<<24|TCPOPT_NOP<<16|TCPOPT_SACK<<8)
 158 /* Miscellaneous constants */
 159 #define MAX_SACK_BLKS   6       /* Max # SACK blocks stored at sender side */
 160
 161 /*
 162  * A SACK option that specifies n blocks will have a length of (8*n + 2)
 163  * bytes, so the 40 bytes available for TCP options can specify a
 164  * maximum of 4 blocks.
 165  */
 166
 167 #define TCP_MAX_SACK    4       /* MAX # SACKs sent in any segment */
 168
 169
 170 /*
 171  * Default maximum segment size for TCP.
 172  * With an IP MTU of 576, this is 536,
 173  * but 512 is probably more convenient.
 174  * This should be defined as MIN(512, IP_MSS - sizeof (struct tcpiphdr)).
 175  */
 176 #define TCP_MSS 512
 177
 178 /*
 179  * TCP_MINMSS is defined to be 216 which is fine for the smallest
 180  * link MTU (256 bytes, SLIP interface) in the Internet.
 181  * However it is very unlikely to come across such low MTU interfaces
 182  * these days (anno dato 2004).
 183  * Probably it can be set to 512 without ill effects. But we play safe.
 184  * See tcp_subr.c tcp_minmss SYSCTL declaration for more comments.
 185  * Setting this to "0" disables the minmss check.
 186  */
 187 #define TCP_MINMSS 216
 188
 189 /*
 190  * Default maximum segment size for TCP6.
 191  * With an IP6 MSS of 1280, this is 1220,
 192  * but 1024 is probably more convenient. (xxx kazu in doubt)
 193  * This should be defined as MIN(1024, IP6_MSS - sizeof (struct tcpip6hdr))
 194  */
 195 #define TCP6_MSS        1024
 196
 197 #define TCP_MAXWIN      65535   /* largest value for (unscaled) window */
 198 #define TTCP_CLIENT_SND_WND     4096    /* dflt send window for T/TCP client */
 199
 200 #define TCP_MAX_WINSHIFT        14      /* maximum window shift */
 201
 202 #define TCP_MAXHLEN     (0xf<<2)        /* max length of header in bytes */
 203 #define TCP_MAXOLEN     (TCP_MAXHLEN - sizeof(struct tcphdr))
 204 /* max space left for options */
 205 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
 206
 207 /*
 208  * User-settable options (used with setsockopt).
 209  */
 210 #define TCP_NODELAY             0x01    /* don't delay send to coalesce packets */
 211 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 212 #define TCP_MAXSEG              0x02    /* set maximum segment size */
 213 #define TCP_NOPUSH              0x04    /* don't push last block of write */
 214 #define TCP_NOOPT               0x08    /* don't use TCP options */
 215 #define TCP_KEEPALIVE           0x10    /* idle time used when SO_KEEPALIVE is enabled */
 216 #define TCP_CONNECTIONTIMEOUT   0x20    /* connection timeout */
 217 #define PERSIST_TIMEOUT         0x40    /* time after which a connection in
 218                                          *  persist timeout will terminate.
 219                                          *  see draft-ananth-tcpm-persist-02.txt
 220                                          */
 221 #define TCP_RXT_CONNDROPTIME    0x80    /* time after which tcp retransmissions will be
 222                                          * stopped and the connection will be dropped
 223                                          */
 224 #define TCP_RXT_FINDROP         0x100   /* when this option is set, drop a connection
 225                                          * after retransmitting the FIN 3 times. It will
 226                                          * prevent holding too many mbufs in socket
 227                                          * buffer queues.
 228                                          */
 229 #define TCP_KEEPINTVL           0x101   /* interval between keepalives */
 230 #define TCP_KEEPCNT             0x102   /* number of keepalives before close */
 231 #define TCP_SENDMOREACKS        0x103   /* always ack every other packet */
 232 #define TCP_ENABLE_ECN          0x104   /* Enable ECN on a connection */
 233 #define TCP_FASTOPEN            0x105   /* Enable/Disable TCP Fastopen on this socket */
 234 #define TCP_CONNECTION_INFO     0x106   /* State of TCP connection */
 235
 236 #ifdef PRIVATE
 237 #define TCP_INFO                        0x200   /* retrieve tcp_info structure */
 238 #define TCP_MEASURE_SND_BW              0x202   /* Measure sender's bandwidth for this connection */
 239 #endif /* PRIVATE */
 240
 241
 242 #define TCP_NOTSENT_LOWAT       0x201   /* Low water mark for TCP unsent data */
 243
 244 #ifdef PRIVATE
 245 #define TCP_MEASURE_BW_BURST    0x203   /* Burst size to use for bandwidth measurement */
 246 #define TCP_PEER_PID            0x204   /* Lookup pid of the process we're connected to */
 247 #define TCP_ADAPTIVE_READ_TIMEOUT       0x205   /* Read timeout used as a multiple of RTT */
 248 #define TCP_OPTION_UNUSED_0             0x206   /* UNUSED */
 249 #define TCP_ADAPTIVE_WRITE_TIMEOUT      0x207   /* Write timeout used as a multiple of RTT */
 250 #define TCP_NOTIMEWAIT                  0x208   /* Avoid going into time-wait */
 251 #define TCP_DISABLE_BLACKHOLE_DETECTION 0x209   /* disable PMTU blackhole detection */
 252 #define TCP_ECN_MODE                    0x210   /* fine grain control for A/B testing */
 253 #define TCP_KEEPALIVE_OFFLOAD           0x211   /* offload keep alive processing to firmware */
 254
 255 /*
 256  * TCP_ECN_MODE values
 257  */
 258 #define ECN_MODE_DEFAULT                0x0     /* per interface or system wide default */
 259 #define ECN_MODE_ENABLE                 0x1     /* force enable ECN on connection */
 260 #define ECN_MODE_DISABLE                0x2     /* force disable ECN on connection */
 261
 262 /*
 263  * TCP_NOTIFY_ACKNOWLEDGEMENT
 264  *
 265  * Application can use this socket option to get a notification when
 266  * data that is currently written to the socket is acknowledged. The input
 267  * argument given to this socket option is a marker_id that will be used for
 268  * returning the notification. The application can continue to write
 269  * data after setting the marker. There can be multiple of these events
 270  * outstanding on a socket at any time up to a max of TCP_MAX_NOTIFY_ACK.
 271  *
 272  * To get the completed notifications, getsockopt should be called with the
 273  * TCP_NOTIFY_ACKNOWLEDGEMENT with the following tcp_notify_ack_complete
 274  * structure as an out argument. At most TCP_MAX_NOTIFY_ACK ids will be
 275  * returned if they have been successfully acknowledged in each call.
 276  */
 277
 278 #define TCP_MAX_NOTIFY_ACK      10
 279
 280 typedef u_int32_t       tcp_notify_ack_id_t;
 281
 282 struct tcp_notify_ack_complete {
 283         u_int32_t       notify_pending; /* still pending */
 284         u_int32_t       notify_complete_count;
 285         tcp_notify_ack_id_t notify_complete_id[TCP_MAX_NOTIFY_ACK];
 286 };
 287
 288 #define TCP_NOTIFY_ACKNOWLEDGEMENT      0x212   /* Notify when data is acknowledged */
 289 #define MPTCP_SERVICE_TYPE              0x213   /* MPTCP Service type */
 290 #define TCP_FASTOPEN_FORCE_HEURISTICS   0x214   /* Make sure TFO-heuristics never get disabled */
 291
 292 #define MPTCP_SVCTYPE_HANDOVER          0 /* Default 0 */
 293 #define MPTCP_SVCTYPE_INTERACTIVE       1
 294 #define MPTCP_SVCTYPE_AGGREGATE         2
 295 #define MPTCP_SVCTYPE_TARGET_BASED      3
 296 #define MPTCP_SVCTYPE_PURE_HANDOVER     4
 297 #define MPTCP_SVCTYPE_MAX               5
 298
 299 /*
 300  * Specify minimum time in seconds before which an established
 301  * TCP connection will not be dropped when there is no response from the
 302  * peer
 303  */
 304 #define TCP_RXT_MINIMUM_TIMEOUT         0x215
 305
 306 #define TCP_RXT_MINIMUM_TIMEOUT_LIMIT   (5 * 60) /* Limit is 5 minutes */
 307
 308 #define MPTCP_ALTERNATE_PORT            0x216
 309 #define MPTCP_FORCE_ENABLE              0x217
 310 #define TCP_FASTOPEN_FORCE_ENABLE       0x218
 311 #define MPTCP_EXPECTED_PROGRESS_TARGET  0x219
 312
 313 /*
 314  * The TCP_INFO socket option is a private API and is subject to change
 315  */
 316 #pragma pack(4)
 317
 318 #define TCPI_OPT_TIMESTAMPS     0x01
 319 #define TCPI_OPT_SACK           0x02
 320 #define TCPI_OPT_WSCALE         0x04
 321 #define TCPI_OPT_ECN            0x08
 322
 323 #define TCPI_FLAG_LOSSRECOVERY  0x01    /* Currently in loss recovery */
 324 #define TCPI_FLAG_STREAMING_ON  0x02    /* Streaming detection on */
 325
 326 struct tcp_conn_status {
 327         union {
 328                 struct {
 329                         unsigned int    probe_activated : 1;
 330                         unsigned int    write_probe_failed : 1;
 331                         unsigned int    read_probe_failed : 1;
 332                         unsigned int    conn_probe_failed : 1;
 333                 };
 334                 uint32_t        pad_field;
 335         };
 336 };
 337
 338 /*
 339  * Add new fields to this structure at the end only. This will preserve
 340  * binary compatibility.
 341  */
 342 struct tcp_info {
 343         u_int8_t        tcpi_state;                     /* TCP FSM state. */
 344         u_int8_t        tcpi_options;           /* Options enabled on conn. */
 345         u_int8_t        tcpi_snd_wscale;        /* RFC1323 send shift value. */
 346         u_int8_t        tcpi_rcv_wscale;        /* RFC1323 recv shift value. */
 347
 348         u_int32_t       tcpi_flags;                     /* extra flags (TCPI_FLAG_xxx) */
 349
 350         u_int32_t       tcpi_rto;                       /* Retransmission timeout in milliseconds */
 351         u_int32_t       tcpi_snd_mss;           /* Max segment size for send. */
 352         u_int32_t       tcpi_rcv_mss;           /* Max segment size for receive. */
 353
 354         u_int32_t       tcpi_rttcur;            /* Most recent value of RTT */
 355         u_int32_t       tcpi_srtt;                      /* Smoothed RTT */
 356         u_int32_t       tcpi_rttvar;            /* RTT variance */
 357         u_int32_t       tcpi_rttbest;           /* Best RTT we've seen */
 358
 359         u_int32_t       tcpi_snd_ssthresh;      /* Slow start threshold. */
 360         u_int32_t       tcpi_snd_cwnd;          /* Send congestion window. */
 361
 362         u_int32_t       tcpi_rcv_space;         /* Advertised recv window. */
 363
 364         u_int32_t       tcpi_snd_wnd;           /* Advertised send window. */
 365         u_int32_t       tcpi_snd_nxt;           /* Next egress seqno */
 366         u_int32_t       tcpi_rcv_nxt;           /* Next ingress seqno */
 367
 368         int32_t         tcpi_last_outif;        /* if_index of interface used to send last */
 369         u_int32_t       tcpi_snd_sbbytes;       /* bytes in snd buffer including data inflight */
 370
 371         u_int64_t       tcpi_txpackets __attribute__((aligned(8)));     /* total packets sent */
 372         u_int64_t       tcpi_txbytes __attribute__((aligned(8)));
 373         /* total bytes sent */
 374         u_int64_t       tcpi_txretransmitbytes __attribute__((aligned(8)));
 375         /* total bytes retransmitted */
 376         u_int64_t       tcpi_txunacked __attribute__((aligned(8)));
 377         /* current number of bytes not acknowledged */
 378         u_int64_t       tcpi_rxpackets __attribute__((aligned(8)));     /* total packets received */
 379         u_int64_t       tcpi_rxbytes __attribute__((aligned(8)));
 380         /* total bytes received */
 381         u_int64_t       tcpi_rxduplicatebytes __attribute__((aligned(8)));
 382         /* total duplicate bytes received */
 383         u_int64_t       tcpi_rxoutoforderbytes __attribute__((aligned(8)));
 384         /* total out of order bytes received */
 385         u_int64_t       tcpi_snd_bw __attribute__((aligned(8)));        /* measured send bandwidth in bits/sec */
 386         u_int8_t        tcpi_synrexmits;        /* Number of syn retransmits before connect */
 387         u_int8_t        tcpi_unused1;
 388         u_int16_t       tcpi_unused2;
 389         u_int64_t       tcpi_cell_rxpackets __attribute((aligned(8)));  /* packets received over cellular */
 390         u_int64_t       tcpi_cell_rxbytes __attribute((aligned(8)));    /* bytes received over cellular */
 391         u_int64_t       tcpi_cell_txpackets __attribute((aligned(8)));  /* packets transmitted over cellular */
 392         u_int64_t       tcpi_cell_txbytes __attribute((aligned(8)));    /* bytes transmitted over cellular */
 393         u_int64_t       tcpi_wifi_rxpackets __attribute((aligned(8)));  /* packets received over Wi-Fi */
 394         u_int64_t       tcpi_wifi_rxbytes __attribute((aligned(8)));    /* bytes received over Wi-Fi */
 395         u_int64_t       tcpi_wifi_txpackets __attribute((aligned(8)));  /* packets transmitted over Wi-Fi */
 396         u_int64_t       tcpi_wifi_txbytes __attribute((aligned(8)));    /* bytes transmitted over Wi-Fi */
 397         u_int64_t       tcpi_wired_rxpackets __attribute((aligned(8))); /* packets received over Wired */
 398         u_int64_t       tcpi_wired_rxbytes __attribute((aligned(8)));   /* bytes received over Wired */
 399         u_int64_t       tcpi_wired_txpackets __attribute((aligned(8))); /* packets transmitted over Wired */
 400         u_int64_t       tcpi_wired_txbytes __attribute((aligned(8)));   /* bytes transmitted over Wired */
 401         struct tcp_conn_status  tcpi_connstatus; /* status of connection probes */
 402
 403         u_int16_t
 404             tcpi_tfo_cookie_req:1,     /* Cookie requested? */
 405             tcpi_tfo_cookie_rcv:1,     /* Cookie received? */
 406             tcpi_tfo_syn_loss:1,       /* Fallback to reg. TCP after SYN-loss */
 407             tcpi_tfo_syn_data_sent:1,     /* SYN+data has been sent out */
 408             tcpi_tfo_syn_data_acked:1,     /* SYN+data has been fully acknowledged */
 409             tcpi_tfo_syn_data_rcv:1,     /* Server received SYN+data with a valid cookie */
 410             tcpi_tfo_cookie_req_rcv:1,     /* Server received cookie-request */
 411             tcpi_tfo_cookie_sent:1,     /* Server announced cookie */
 412             tcpi_tfo_cookie_invalid:1,     /* Server received an invalid cookie */
 413             tcpi_tfo_cookie_wrong:1,     /* Our sent cookie was wrong */
 414             tcpi_tfo_no_cookie_rcv:1,     /* We did not receive a cookie upon our request */
 415             tcpi_tfo_heuristics_disable:1,     /* TFO-heuristics disabled it */
 416             tcpi_tfo_send_blackhole:1,     /* A sending-blackhole got detected */
 417             tcpi_tfo_recv_blackhole:1,     /* A receiver-blackhole got detected */
 418             tcpi_tfo_onebyte_proxy:1;     /* A proxy acknowledges all but one byte of the SYN */
 419
 420         u_int16_t       tcpi_ecn_client_setup:1,        /* Attempted ECN setup from client side */
 421             tcpi_ecn_server_setup:1,                    /* Attempted ECN setup from server side */
 422             tcpi_ecn_success:1,                         /* peer negotiated ECN */
 423             tcpi_ecn_lost_syn:1,                        /* Lost SYN with ECN setup */
 424             tcpi_ecn_lost_synack:1,                     /* Lost SYN-ACK with ECN setup */
 425             tcpi_local_peer:1,                          /* Local to the host or the subnet */
 426             tcpi_if_cell:1,                     /* Interface is cellular */
 427             tcpi_if_wifi:1,                     /* Interface is WiFi */
 428             tcpi_if_wired:1,                    /* Interface is wired - ethernet , thunderbolt etc,. */
 429             tcpi_if_wifi_infra:1,               /* Interface is wifi infrastructure */
 430             tcpi_if_wifi_awdl:1,                /* Interface is wifi AWDL */
 431             tcpi_snd_background:1,              /* Using delay based algorithm on sender side */
 432             tcpi_rcv_background:1;              /* Using delay based algorithm on receive side */
 433
 434         u_int32_t       tcpi_ecn_recv_ce;       /* Packets received with CE */
 435         u_int32_t       tcpi_ecn_recv_cwr;      /* Packets received with CWR */
 436
 437         u_int32_t       tcpi_rcvoopack;         /* out-of-order packets received */
 438         u_int32_t       tcpi_pawsdrop;          /* segments dropped due to PAWS */
 439         u_int32_t       tcpi_sack_recovery_episode; /* SACK recovery episodes */
 440         u_int32_t       tcpi_reordered_pkts;    /* packets reorderd */
 441         u_int32_t       tcpi_dsack_sent;        /* Sent DSACK notification */
 442         u_int32_t       tcpi_dsack_recvd;       /* Received a valid DSACK option */
 443         u_int32_t       tcpi_flowhash;          /* Unique id for the connection */
 444
 445         u_int64_t       tcpi_txretransmitpackets __attribute__((aligned(8)));
 446 };
 447
 448 struct tcp_measure_bw_burst {
 449         u_int32_t       min_burst_size; /* Minimum number of packets to use */
 450         u_int32_t       max_burst_size; /* Maximum number of packets to use */
 451 };
 452
 453 /*
 454  * Note that IPv6 link local addresses should have the appropriate scope ID
 455  */
 456
 457 struct info_tuple {
 458         u_int8_t        itpl_proto;
 459         union {
 460                 struct sockaddr         _itpl_sa;
 461                 struct sockaddr_in      _itpl_sin;
 462                 struct sockaddr_in6     _itpl_sin6;
 463         } itpl_localaddr;
 464         union {
 465                 struct sockaddr         _itpl_sa;
 466                 struct sockaddr_in      _itpl_sin;
 467                 struct sockaddr_in6     _itpl_sin6;
 468         } itpl_remoteaddr;
 469 };
 470
 471 #define itpl_local_sa           itpl_localaddr._itpl_sa
 472 #define itpl_local_sin          itpl_localaddr._itpl_sin
 473 #define itpl_local_sin6         itpl_localaddr._itpl_sin6
 474 #define itpl_remote_sa          itpl_remoteaddr._itpl_sa
 475 #define itpl_remote_sin         itpl_remoteaddr._itpl_sin
 476 #define itpl_remote_sin6        itpl_remoteaddr._itpl_sin6
 477
 478 /*
 479  * TCP connection info auxiliary data (CIAUX_TCP)
 480  *
 481  * Do not add new fields to this structure, just add them to tcp_info
 482  * structure towards the end. This will preserve binary compatibility.
 483  */
 484 typedef struct conninfo_tcp {
 485         pid_t                   tcpci_peer_pid; /* loopback peer PID if > 0 */
 486         struct tcp_info         tcpci_tcp_info; /* TCP info */
 487 } conninfo_tcp_t;
 488
 489 #pragma pack()
 490
 491 struct mptcp_itf_stats {
 492         u_short  ifindex;
 493         uint16_t switches;
 494         uint32_t is_expensive:1;
 495         uint64_t mpis_txbytes __attribute__((aligned(8)));
 496         uint64_t mpis_rxbytes __attribute__((aligned(8)));
 497         uint64_t mpis_wifi_txbytes __attribute__((aligned(8)));
 498         uint64_t mpis_wifi_rxbytes __attribute__((aligned(8)));
 499         uint64_t mpis_wired_txbytes __attribute__((aligned(8)));
 500         uint64_t mpis_wired_rxbytes __attribute__((aligned(8)));
 501         uint64_t mpis_cell_txbytes __attribute__((aligned(8)));
 502         uint64_t mpis_cell_rxbytes __attribute__((aligned(8)));
 503 };
 504
 505 /* Version solely used to let libnetcore survive */
 506 #define CONNINFO_MPTCP_VERSION  3
 507 typedef struct conninfo_multipathtcp {
 508         uint32_t        mptcpci_subflow_count;
 509         uint32_t        mptcpci_switch_count;
 510         sae_connid_t    mptcpci_subflow_connids[4];
 511
 512         uint64_t        mptcpci_init_rxbytes;
 513         uint64_t        mptcpci_init_txbytes;
 514
 515 #define MPTCP_ITFSTATS_SIZE     4
 516         struct mptcp_itf_stats mptcpci_itfstats[MPTCP_ITFSTATS_SIZE];
 517
 518         uint32_t        mptcpci_flags;
 519 #define MPTCPCI_FIRSTPARTY      0x01
 520 } conninfo_multipathtcp_t;
 521
 522 #endif /* PRIVATE */
 523
 524 struct tcp_connection_info {
 525         u_int8_t        tcpi_state;     /* connection state */
 526         u_int8_t        tcpi_snd_wscale; /* Window scale for send window */
 527         u_int8_t        tcpi_rcv_wscale; /* Window scale for receive window */
 528         u_int8_t        __pad1;
 529         u_int32_t       tcpi_options;   /* TCP options supported */
 530 #define TCPCI_OPT_TIMESTAMPS    0x00000001 /* Timestamps enabled */
 531 #define TCPCI_OPT_SACK          0x00000002 /* SACK enabled */
 532 #define TCPCI_OPT_WSCALE        0x00000004 /* Window scaling enabled */
 533 #define TCPCI_OPT_ECN           0x00000008 /* ECN enabled */
 534         u_int32_t       tcpi_flags;     /* flags */
 535 #define TCPCI_FLAG_LOSSRECOVERY 0x00000001
 536 #define TCPCI_FLAG_REORDERING_DETECTED  0x00000002
 537         u_int32_t       tcpi_rto;       /* retransmit timeout in ms */
 538         u_int32_t       tcpi_maxseg;    /* maximum segment size supported */
 539         u_int32_t       tcpi_snd_ssthresh; /* slow start threshold in bytes */
 540         u_int32_t       tcpi_snd_cwnd;  /* send congestion window in bytes */
 541         u_int32_t       tcpi_snd_wnd;   /* send widnow in bytes */
 542         u_int32_t       tcpi_snd_sbbytes; /* bytes in send socket buffer, including in-flight data */
 543         u_int32_t       tcpi_rcv_wnd;   /* receive window in bytes*/
 544         u_int32_t       tcpi_rttcur;    /* most recent RTT in ms */
 545         u_int32_t       tcpi_srtt;      /* average RTT in ms */
 546         u_int32_t       tcpi_rttvar;    /* RTT variance */
 547         u_int32_t
 548             tcpi_tfo_cookie_req:1,             /* Cookie requested? */
 549             tcpi_tfo_cookie_rcv:1,             /* Cookie received? */
 550             tcpi_tfo_syn_loss:1,               /* Fallback to reg. TCP after SYN-loss */
 551             tcpi_tfo_syn_data_sent:1,             /* SYN+data has been sent out */
 552             tcpi_tfo_syn_data_acked:1,             /* SYN+data has been fully acknowledged */
 553             tcpi_tfo_syn_data_rcv:1,             /* Server received SYN+data with a valid cookie */
 554             tcpi_tfo_cookie_req_rcv:1,             /* Server received cookie-request */
 555             tcpi_tfo_cookie_sent:1,             /* Server announced cookie */
 556             tcpi_tfo_cookie_invalid:1,             /* Server received an invalid cookie */
 557             tcpi_tfo_cookie_wrong:1,             /* Our sent cookie was wrong */
 558             tcpi_tfo_no_cookie_rcv:1,             /* We did not receive a cookie upon our request */
 559             tcpi_tfo_heuristics_disable:1,             /* TFO-heuristics disabled it */
 560             tcpi_tfo_send_blackhole:1,             /* A sending-blackhole got detected */
 561             tcpi_tfo_recv_blackhole:1,             /* A receiver-blackhole got detected */
 562             tcpi_tfo_onebyte_proxy:1,             /* A proxy acknowledges all but one byte of the SYN */
 563             __pad2:17;
 564         u_int64_t       tcpi_txpackets __attribute__((aligned(8)));
 565         u_int64_t       tcpi_txbytes __attribute__((aligned(8)));
 566         u_int64_t       tcpi_txretransmitbytes __attribute__((aligned(8)));
 567         u_int64_t       tcpi_rxpackets __attribute__((aligned(8)));
 568         u_int64_t       tcpi_rxbytes __attribute__((aligned(8)));
 569         u_int64_t       tcpi_rxoutoforderbytes __attribute__((aligned(8)));
 570         u_int64_t       tcpi_txretransmitpackets __attribute__((aligned(8)));
 571 };
 572 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
 573
 574 #endif