include/netinet/tcp.h

   1 /*
   2  * Copyright (c) 1982, 1986, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 4. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  *      @(#)tcp.h       8.1 (Berkeley) 6/10/93
  30  */
  31
  32 #ifndef _NETINET_TCP_H
  33 #define _NETINET_TCP_H  1
  34
  35 #include <features.h>
  36
  37 /*
  38  * User-settable options (used with setsockopt).
  39  */
  40 #define TCP_NODELAY      1      /* Don't delay send to coalesce packets  */
  41 #define TCP_MAXSEG       2      /* Set maximum segment size  */
  42 #define TCP_CORK         3      /* Control sending of partial frames  */
  43 #define TCP_KEEPIDLE     4      /* Start keeplives after this period */
  44 #define TCP_KEEPINTVL    5      /* Interval between keepalives */
  45 #define TCP_KEEPCNT      6      /* Number of keepalives before death */
  46 #define TCP_SYNCNT       7      /* Number of SYN retransmits */
  47 #define TCP_LINGER2      8      /* Life time of orphaned FIN-WAIT-2 state */
  48 #define TCP_DEFER_ACCEPT 9      /* Wake up listener only when data arrive */
  49 #define TCP_WINDOW_CLAMP 10     /* Bound advertised window */
  50 #define TCP_INFO         11     /* Information about this connection. */
  51 #define TCP_QUICKACK     12     /* Bock/reenable quick ACKs.  */
  52 #define TCP_CONGESTION   13     /* Congestion control algorithm.  */
  53
  54 #ifdef __USE_MISC
  55 # include <sys/types.h>
  56
  57 # ifdef __FAVOR_BSD
  58 typedef u_int32_t tcp_seq;
  59 /*
  60  * TCP header.
  61  * Per RFC 793, September, 1981.
  62  */
  63 struct tcphdr
  64   {
  65     u_int16_t th_sport;         /* source port */
  66     u_int16_t th_dport;         /* destination port */
  67     tcp_seq th_seq;             /* sequence number */
  68     tcp_seq th_ack;             /* acknowledgement number */
  69 #  if __BYTE_ORDER == __LITTLE_ENDIAN
  70     u_int8_t th_x2:4;           /* (unused) */
  71     u_int8_t th_off:4;          /* data offset */
  72 #  endif
  73 #  if __BYTE_ORDER == __BIG_ENDIAN
  74     u_int8_t th_off:4;          /* data offset */
  75     u_int8_t th_x2:4;           /* (unused) */
  76 #  endif
  77     u_int8_t th_flags;
  78 #  define TH_FIN        0x01
  79 #  define TH_SYN        0x02
  80 #  define TH_RST        0x04
  81 #  define TH_PUSH       0x08
  82 #  define TH_ACK        0x10
  83 #  define TH_URG        0x20
  84     u_int16_t th_win;           /* window */
  85     u_int16_t th_sum;           /* checksum */
  86     u_int16_t th_urp;           /* urgent pointer */
  87 };
  88
  89 # else /* !__FAVOR_BSD */
  90 struct tcphdr
  91   {
  92     u_int16_t source;
  93     u_int16_t dest;
  94     u_int32_t seq;
  95     u_int32_t ack_seq;
  96 #  if __BYTE_ORDER == __LITTLE_ENDIAN
  97     u_int16_t res1:4;
  98     u_int16_t doff:4;
  99     u_int16_t fin:1;
 100     u_int16_t syn:1;
 101     u_int16_t rst:1;
 102     u_int16_t psh:1;
 103     u_int16_t ack:1;
 104     u_int16_t urg:1;
 105     u_int16_t res2:2;
 106 #  elif __BYTE_ORDER == __BIG_ENDIAN
 107     u_int16_t doff:4;
 108     u_int16_t res1:4;
 109     u_int16_t res2:2;
 110     u_int16_t urg:1;
 111     u_int16_t ack:1;
 112     u_int16_t psh:1;
 113     u_int16_t rst:1;
 114     u_int16_t syn:1;
 115     u_int16_t fin:1;
 116 #  else
 117 #   error "Adjust your <bits/endian.h> defines"
 118 #  endif
 119     u_int16_t window;
 120     u_int16_t check;
 121     u_int16_t urg_ptr;
 122 };
 123 # endif /* __FAVOR_BSD */
 124
 125 enum
 126 {
 127   TCP_ESTABLISHED = 1,
 128   TCP_SYN_SENT,
 129   TCP_SYN_RECV,
 130   TCP_FIN_WAIT1,
 131   TCP_FIN_WAIT2,
 132   TCP_TIME_WAIT,
 133   TCP_CLOSE,
 134   TCP_CLOSE_WAIT,
 135   TCP_LAST_ACK,
 136   TCP_LISTEN,
 137   TCP_CLOSING   /* now a valid state */
 138 };
 139
 140 # define TCPOPT_EOL             0
 141 # define TCPOPT_NOP             1
 142 # define TCPOPT_MAXSEG          2
 143 # define TCPOLEN_MAXSEG         4
 144 # define TCPOPT_WINDOW          3
 145 # define TCPOLEN_WINDOW         3
 146 # define TCPOPT_SACK_PERMITTED  4               /* Experimental */
 147 # define TCPOLEN_SACK_PERMITTED 2
 148 # define TCPOPT_SACK            5               /* Experimental */
 149 # define TCPOPT_TIMESTAMP       8
 150 # define TCPOLEN_TIMESTAMP      10
 151 # define TCPOLEN_TSTAMP_APPA    (TCPOLEN_TIMESTAMP+2) /* appendix A */
 152
 153 # define TCPOPT_TSTAMP_HDR      \
 154     (TCPOPT_NOP<<24|TCPOPT_NOP<<16|TCPOPT_TIMESTAMP<<8|TCPOLEN_TIMESTAMP)
 155
 156 /*
 157  * Default maximum segment size for TCP.
 158  * With an IP MSS of 576, this is 536,
 159  * but 512 is probably more convenient.
 160  * This should be defined as MIN(512, IP_MSS - sizeof (struct tcpiphdr)).
 161  */
 162 # define TCP_MSS        512
 163
 164 # define TCP_MAXWIN     65535   /* largest value for (unscaled) window */
 165
 166 # define TCP_MAX_WINSHIFT       14      /* maximum window shift */
 167
 168 # define SOL_TCP                6       /* TCP level */
 169
 170
 171 # define TCPI_OPT_TIMESTAMPS    1
 172 # define TCPI_OPT_SACK          2
 173 # define TCPI_OPT_WSCALE        4
 174 # define TCPI_OPT_ECN           8
 175
 176 /* Values for tcpi_state.  */
 177 enum tcp_ca_state
 178 {
 179   TCP_CA_Open = 0,
 180   TCP_CA_Disorder = 1,
 181   TCP_CA_CWR = 2,
 182   TCP_CA_Recovery = 3,
 183   TCP_CA_Loss = 4
 184 };
 185
 186 struct tcp_info
 187 {
 188   u_int8_t      tcpi_state;
 189   u_int8_t      tcpi_ca_state;
 190   u_int8_t      tcpi_retransmits;
 191   u_int8_t      tcpi_probes;
 192   u_int8_t      tcpi_backoff;
 193   u_int8_t      tcpi_options;
 194   u_int8_t      tcpi_snd_wscale : 4, tcpi_rcv_wscale : 4;
 195
 196   u_int32_t     tcpi_rto;
 197   u_int32_t     tcpi_ato;
 198   u_int32_t     tcpi_snd_mss;
 199   u_int32_t     tcpi_rcv_mss;
 200
 201   u_int32_t     tcpi_unacked;
 202   u_int32_t     tcpi_sacked;
 203   u_int32_t     tcpi_lost;
 204   u_int32_t     tcpi_retrans;
 205   u_int32_t     tcpi_fackets;
 206
 207   /* Times. */
 208   u_int32_t     tcpi_last_data_sent;
 209   u_int32_t     tcpi_last_ack_sent;     /* Not remembered, sorry.  */
 210   u_int32_t     tcpi_last_data_recv;
 211   u_int32_t     tcpi_last_ack_recv;
 212
 213   /* Metrics. */
 214   u_int32_t     tcpi_pmtu;
 215   u_int32_t     tcpi_rcv_ssthresh;
 216   u_int32_t     tcpi_rtt;
 217   u_int32_t     tcpi_rttvar;
 218   u_int32_t     tcpi_snd_ssthresh;
 219   u_int32_t     tcpi_snd_cwnd;
 220   u_int32_t     tcpi_advmss;
 221   u_int32_t     tcpi_reordering;
 222   u_int32_t     tcpi_rcv_rtt;
 223   u_int32_t     tcpi_rcv_space;
 224   u_int32_t     tcpi_total_retrans;
 225
 226 };
 227
 228 #endif /* Misc.  */
 229
 230 #endif /* netinet/tcp.h */