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