]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/netinet/tcp.h
xnu-4903.241.1.tar.gz
[apple/xnu.git] / bsd / netinet / tcp.h
index 134a615355dde9a55db2005336b7f747cf385ec0..b64798dd270743871365342f82e6f71ea1c252e7 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2000-2014 Apple Inc. All rights reserved.
+ * Copyright (c) 2000-2016 Apple Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  *
@@ -66,6 +66,7 @@
 #include <sys/types.h>
 #include <sys/appleapiopts.h>
 #include <machine/endian.h>
+#include <machine/types.h> /* __uint32_t */
 
 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 typedef        __uint32_t tcp_seq;
@@ -101,6 +102,7 @@ struct tcphdr {
 #define        TH_ECE  0x40
 #define        TH_CWR  0x80
 #define        TH_FLAGS        (TH_FIN|TH_SYN|TH_RST|TH_ACK|TH_URG|TH_ECE|TH_CWR)
+#define        TH_ACCEPT       (TH_FIN|TH_SYN|TH_RST|TH_ACK)
 
        unsigned short  th_win;         /* window */
        unsigned short  th_sum;         /* checksum */
@@ -224,8 +226,8 @@ struct tcphdr {
 #define        TCP_CONNECTION_INFO     0x106   /* State of TCP connection */
 
 #ifdef PRIVATE
-#define        TCP_INFO                0x200   /* retrieve tcp_info structure */
-#define TCP_MEASURE_SND_BW     0x202   /* Measure sender's bandwidth for this connection */
+#define        TCP_INFO                        0x200   /* retrieve tcp_info structure */
+#define        TCP_MEASURE_SND_BW              0x202   /* Measure sender's bandwidth for this connection */
 #endif /* PRIVATE */
 
 
@@ -239,10 +241,64 @@ struct tcphdr {
  * Enable message delivery on a socket, this feature is currently unsupported and
  * is subjected to change in future.
  */
-#define        TCP_ENABLE_MSGS 0x206
+#define        TCP_ENABLE_MSGS                 0x206
 #define        TCP_ADAPTIVE_WRITE_TIMEOUT      0x207   /* Write timeout used as a multiple of RTT */
-#define        TCP_NOTIMEWAIT          0x208   /* Avoid going into time-wait */
+#define        TCP_NOTIMEWAIT                  0x208   /* Avoid going into time-wait */
 #define        TCP_DISABLE_BLACKHOLE_DETECTION 0x209   /* disable PMTU blackhole detection */
+#define        TCP_ECN_MODE                    0x210   /* fine grain control for A/B testing */
+#define        TCP_KEEPALIVE_OFFLOAD           0x211   /* offload keep alive processing to firmware */
+
+/*
+ * TCP_ECN_MODE values
+ */
+#define        ECN_MODE_DEFAULT                0x0     /* per interface or system wide default */
+#define        ECN_MODE_ENABLE                 0x1     /* force enable ECN on connection */
+#define        ECN_MODE_DISABLE                0x2     /* force disable ECN on connection */
+
+/*
+ * TCP_NOTIFY_ACKNOWLEDGEMENT
+ *
+ * Application can use this socket option to get a notification when
+ * data that is currently written to the socket is acknowledged. The input
+ * argument given to this socket option is a marker_id that will be used for
+ * returning the notification. The application can continue to write
+ * data after setting the marker. There can be multiple of these events
+ * outstanding on a socket at any time up to a max of TCP_MAX_NOTIFY_ACK.
+ *
+ * To get the completed notifications, getsockopt should be called with the
+ * TCP_NOTIFY_ACKNOWLEDGEMENT with the following tcp_notify_ack_complete
+ * structure as an out argument. At most TCP_MAX_NOTIFY_ACK ids will be
+ * returned if they have been successfully acknowledged in each call.
+ */
+
+#define TCP_MAX_NOTIFY_ACK     10
+
+typedef        u_int32_t       tcp_notify_ack_id_t;
+
+struct tcp_notify_ack_complete {
+       u_int32_t       notify_pending; /* still pending */
+       u_int32_t       notify_complete_count;
+       tcp_notify_ack_id_t notify_complete_id[TCP_MAX_NOTIFY_ACK];
+};
+
+#define        TCP_NOTIFY_ACKNOWLEDGEMENT      0x212   /* Notify when data is acknowledged */
+#define        MPTCP_SERVICE_TYPE              0x213   /* MPTCP Service type */
+#define        TCP_FASTOPEN_FORCE_HEURISTICS   0x214   /* Make sure TFO-heuristics never get disabled */
+
+#define        MPTCP_SVCTYPE_HANDOVER          0 /* Default 0 */
+#define        MPTCP_SVCTYPE_INTERACTIVE       1
+#define        MPTCP_SVCTYPE_AGGREGATE         2
+#define        MPTCP_SVCTYPE_MAX               3
+/*
+ * Specify minimum time in seconds before which an established
+ * TCP connection will not be dropped when there is no response from the
+ * peer
+ */
+#define        TCP_RXT_MINIMUM_TIMEOUT         0x215
+
+#define        TCP_RXT_MINIMUM_TIMEOUT_LIMIT   (5 * 60) /* Limit is 5 minutes */
+
+#define MPTCP_ALTERNATE_PORT           0x216
 
 /*
  * The TCP_INFO socket option is a private API and is subject to change
@@ -255,6 +311,7 @@ struct tcphdr {
 #define        TCPI_OPT_ECN            0x08
 
 #define TCPI_FLAG_LOSSRECOVERY 0x01    /* Currently in loss recovery */
+#define        TCPI_FLAG_STREAMING_ON  0x02    /* Streaming detection on */
 
 struct tcp_conn_status {
        unsigned int    probe_activated : 1;
@@ -292,10 +349,10 @@ struct tcp_info {
        u_int32_t       tcpi_snd_wnd;           /* Advertised send window. */
        u_int32_t       tcpi_snd_nxt;           /* Next egress seqno */
        u_int32_t       tcpi_rcv_nxt;           /* Next ingress seqno */
-       
+
        int32_t         tcpi_last_outif;        /* if_index of interface used to send last */
        u_int32_t       tcpi_snd_sbbytes;       /* bytes in snd buffer including data inflight */
-       
+
        u_int64_t       tcpi_txpackets __attribute__((aligned(8)));     /* total packets sent */
        u_int64_t       tcpi_txbytes __attribute__((aligned(8)));
                                                                        /* total bytes sent */  
@@ -328,17 +385,49 @@ struct tcp_info {
        u_int64_t       tcpi_wired_txbytes __attribute((aligned(8)));   /* bytes transmitted over Wired */
        struct tcp_conn_status  tcpi_connstatus; /* status of connection probes */
 
-       u_int16_t       /* Client-side information */
+       u_int16_t
                tcpi_tfo_cookie_req:1, /* Cookie requested? */
                tcpi_tfo_cookie_rcv:1, /* Cookie received? */
                tcpi_tfo_syn_loss:1,   /* Fallback to reg. TCP after SYN-loss */
                tcpi_tfo_syn_data_sent:1, /* SYN+data has been sent out */
                tcpi_tfo_syn_data_acked:1, /* SYN+data has been fully acknowledged */
-               /* And the following are for server-side information (must be set on the listener socket) */
                tcpi_tfo_syn_data_rcv:1, /* Server received SYN+data with a valid cookie */
                tcpi_tfo_cookie_req_rcv:1, /* Server received cookie-request */
                tcpi_tfo_cookie_sent:1, /* Server announced cookie */
-               tcpi_tfo_cookie_invalid:1; /* Server received an invalid cookie */
+               tcpi_tfo_cookie_invalid:1, /* Server received an invalid cookie */
+               tcpi_tfo_cookie_wrong:1, /* Our sent cookie was wrong */
+               tcpi_tfo_no_cookie_rcv:1, /* We did not receive a cookie upon our request */
+               tcpi_tfo_heuristics_disable:1, /* TFO-heuristics disabled it */
+               tcpi_tfo_send_blackhole:1, /* A sending-blackhole got detected */
+               tcpi_tfo_recv_blackhole:1, /* A receiver-blackhole got detected */
+               tcpi_tfo_onebyte_proxy:1; /* A proxy acknowledges all but one byte of the SYN */
+
+       u_int16_t       tcpi_ecn_client_setup:1,        /* Attempted ECN setup from client side */
+                       tcpi_ecn_server_setup:1,        /* Attempted ECN setup from server side */
+                       tcpi_ecn_success:1,             /* peer negotiated ECN */
+                       tcpi_ecn_lost_syn:1,            /* Lost SYN with ECN setup */
+                       tcpi_ecn_lost_synack:1,         /* Lost SYN-ACK with ECN setup */
+                       tcpi_local_peer:1,              /* Local to the host or the subnet */
+                       tcpi_if_cell:1,         /* Interface is cellular */
+                       tcpi_if_wifi:1,         /* Interface is WiFi */
+                       tcpi_if_wired:1,        /* Interface is wired - ethernet , thunderbolt etc,. */
+                       tcpi_if_wifi_infra:1,   /* Interface is wifi infrastructure */
+                       tcpi_if_wifi_awdl:1,    /* Interface is wifi AWDL */
+                       tcpi_snd_background:1,  /* Using delay based algorithm on sender side */
+                       tcpi_rcv_background:1;  /* Using delay based algorithm on receive side */
+
+       u_int32_t       tcpi_ecn_recv_ce;       /* Packets received with CE */
+       u_int32_t       tcpi_ecn_recv_cwr;      /* Packets received with CWR */
+
+       u_int32_t       tcpi_rcvoopack;         /* out-of-order packets received */
+       u_int32_t       tcpi_pawsdrop;          /* segments dropped due to PAWS */
+       u_int32_t       tcpi_sack_recovery_episode; /* SACK recovery episodes */
+       u_int32_t       tcpi_reordered_pkts;    /* packets reorderd */
+       u_int32_t       tcpi_dsack_sent;        /* Sent DSACK notification */
+       u_int32_t       tcpi_dsack_recvd;       /* Received a valid DSACK option */
+       u_int32_t       tcpi_flowhash;          /* Unique id for the connection */
+
+       u_int64_t       tcpi_txretransmitpackets __attribute__((aligned(8)));
 };
 
 struct tcp_measure_bw_burst {
@@ -365,16 +454,16 @@ struct info_tuple {
 };
 
 #define itpl_local_sa          itpl_localaddr._itpl_sa
-#define itpl_local_sin                 itpl_localaddr._itpl_sin
+#define itpl_local_sin         itpl_localaddr._itpl_sin
 #define itpl_local_sin6                itpl_localaddr._itpl_sin6
-#define itpl_remote_sa                 itpl_remoteaddr._itpl_sa
+#define itpl_remote_sa         itpl_remoteaddr._itpl_sa
 #define itpl_remote_sin                itpl_remoteaddr._itpl_sin
 #define itpl_remote_sin6       itpl_remoteaddr._itpl_sin6
 
 /*
  * TCP connection info auxiliary data (CIAUX_TCP)
  *
- * Do not add new fields to this structure, just add them to tcp_info 
+ * Do not add new fields to this structure, just add them to tcp_info
  * structure towards the end. This will preserve binary compatibility.
  */
 typedef struct conninfo_tcp {
@@ -384,6 +473,31 @@ typedef struct conninfo_tcp {
 
 #pragma pack()
 
+struct mptcp_itf_stats {
+       uint16_t        ifindex;
+       uint16_t        switches;
+       uint32_t        is_expensive:1;
+       uint64_t        mpis_txbytes __attribute__((aligned(8)));
+       uint64_t        mpis_rxbytes __attribute__((aligned(8)));
+};
+
+/* Version solely used to let libnetcore survive */
+#define        CONNINFO_MPTCP_VERSION  3
+typedef struct conninfo_multipathtcp {
+       uint32_t        mptcpci_subflow_count;
+       uint32_t        mptcpci_switch_count;
+       sae_connid_t    mptcpci_subflow_connids[4];
+
+       uint64_t        mptcpci_init_rxbytes;
+       uint64_t        mptcpci_init_txbytes;
+
+#define        MPTCP_ITFSTATS_SIZE     4
+       struct mptcp_itf_stats mptcpci_itfstats[MPTCP_ITFSTATS_SIZE];
+
+       uint32_t        mptcpci_flags;
+#define        MPTCPCI_FIRSTPARTY      0x01
+} conninfo_multipathtcp_t;
+
 #endif /* PRIVATE */
 
 struct tcp_connection_info {
@@ -410,24 +524,29 @@ struct tcp_connection_info {
         u_int32_t      tcpi_srtt;      /* average RTT in ms */
         u_int32_t      tcpi_rttvar;    /* RTT variance */
        u_int32_t
-                       /* Client-side information */
                        tcpi_tfo_cookie_req:1, /* Cookie requested? */
                        tcpi_tfo_cookie_rcv:1, /* Cookie received? */
                        tcpi_tfo_syn_loss:1,   /* Fallback to reg. TCP after SYN-loss */
                        tcpi_tfo_syn_data_sent:1, /* SYN+data has been sent out */
                        tcpi_tfo_syn_data_acked:1, /* SYN+data has been fully acknowledged */
-                       /* And the following are for server-side information (must be set on the listener socket) */
                        tcpi_tfo_syn_data_rcv:1, /* Server received SYN+data with a valid cookie */
                        tcpi_tfo_cookie_req_rcv:1, /* Server received cookie-request */
                        tcpi_tfo_cookie_sent:1, /* Server announced cookie */
                        tcpi_tfo_cookie_invalid:1, /* Server received an invalid cookie */
-                       __pad2:23;
+                       tcpi_tfo_cookie_wrong:1, /* Our sent cookie was wrong */
+                       tcpi_tfo_no_cookie_rcv:1, /* We did not receive a cookie upon our request */
+                       tcpi_tfo_heuristics_disable:1, /* TFO-heuristics disabled it */
+                       tcpi_tfo_send_blackhole:1, /* A sending-blackhole got detected */
+                       tcpi_tfo_recv_blackhole:1, /* A receiver-blackhole got detected */
+                       tcpi_tfo_onebyte_proxy:1, /* A proxy acknowledges all but one byte of the SYN */
+                       __pad2:17;
         u_int64_t      tcpi_txpackets __attribute__((aligned(8)));
         u_int64_t      tcpi_txbytes __attribute__((aligned(8)));
         u_int64_t      tcpi_txretransmitbytes __attribute__((aligned(8)));
         u_int64_t      tcpi_rxpackets __attribute__((aligned(8)));
         u_int64_t      tcpi_rxbytes __attribute__((aligned(8)));
         u_int64_t      tcpi_rxoutoforderbytes __attribute__((aligned(8)));
+        u_int64_t      tcpi_txretransmitpackets __attribute__((aligned(8)));
 };
 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */