NetworkPkg/TcpDxe/TcpProto.h

   1 /** @file
   2   TCP protocol header file.
   3
   4   Copyright (c) 2009 - 2017, Intel Corporation. All rights reserved.<BR>
   5
   6   SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #ifndef _TCP_PROTO_H_
  11 #define _TCP_PROTO_H_
  12
  13 ///
  14 /// Tcp states don't change their order. It is used as an
  15 /// index to mTcpOutFlag and other macros.
  16 ///
  17 #define TCP_CLOSED       0
  18 #define TCP_LISTEN       1
  19 #define TCP_SYN_SENT     2
  20 #define TCP_SYN_RCVD     3
  21 #define TCP_ESTABLISHED  4
  22 #define TCP_FIN_WAIT_1   5
  23 #define TCP_FIN_WAIT_2   6
  24 #define TCP_CLOSING      7
  25 #define TCP_TIME_WAIT    8
  26 #define TCP_CLOSE_WAIT   9
  27 #define TCP_LAST_ACK     10
  28
  29 ///
  30 /// Flags in the TCP header
  31 ///
  32 #define TCP_FLG_FIN  0x01
  33 #define TCP_FLG_SYN  0x02
  34 #define TCP_FLG_RST  0x04
  35 #define TCP_FLG_PSH  0x08
  36 #define TCP_FLG_ACK  0x10
  37 #define TCP_FLG_URG  0x20
  38
  39 //
  40 // mask for all the flags
  41 //
  42 #define TCP_FLG_FLAG  0x3F
  43
  44 #define TCP_CONNECT_REFUSED  (-1)     ///< TCP error status
  45 #define TCP_CONNECT_RESET    (-2)     ///< TCP error status
  46 #define TCP_CONNECT_CLOSED   (-3)     ///< TCP error status
  47
  48 //
  49 // Current congestion status as suggested by RFC3782.
  50 //
  51 #define TCP_CONGEST_RECOVER  1      ///< During the NewReno fast recovery.
  52 #define TCP_CONGEST_LOSS     2      ///< Retxmit because of retxmit time out.
  53 #define TCP_CONGEST_OPEN     3      ///< TCP is opening its congestion window.
  54
  55 //
  56 // TCP control flags
  57 //
  58 #define TCP_CTRL_NO_NAGLE      0x0001   ///< Disable Nagle algorithm
  59 #define TCP_CTRL_NO_KEEPALIVE  0x0002   ///< Disable keepalive timer.
  60 #define TCP_CTRL_NO_WS         0x0004   ///< Disable window scale option.
  61 #define TCP_CTRL_RCVD_WS       0x0008   ///< Received a wnd scale option in syn.
  62 #define TCP_CTRL_NO_TS         0x0010   ///< Disable Timestamp option.
  63 #define TCP_CTRL_RCVD_TS       0x0020   ///< Received a Timestamp option in syn.
  64 #define TCP_CTRL_SND_TS        0x0040   ///< Send Timestamp option to remote.
  65 #define TCP_CTRL_SND_URG       0x0080   ///< In urgent send mode.
  66 #define TCP_CTRL_RCVD_URG      0x0100   ///< In urgent receive mode.
  67 #define TCP_CTRL_SND_PSH       0x0200   ///< In PUSH send mode.
  68 #define TCP_CTRL_FIN_SENT      0x0400   ///< FIN is sent.
  69 #define TCP_CTRL_FIN_ACKED     0x0800   ///< FIN is ACKed.
  70 #define TCP_CTRL_TIMER_ON      0x1000   ///< At least one of the timer is on.
  71 #define TCP_CTRL_RTT_ON        0x2000   ///< The RTT measurement is on.
  72 #define TCP_CTRL_ACK_NOW       0x4000   ///< Send the ACK now, don't delay.
  73
  74 //
  75 // Timer related values
  76 //
  77 #define TCP_TIMER_CONNECT    0                      ///< Connection establishment timer.
  78 #define TCP_TIMER_REXMIT     1                      ///< Retransmit timer.
  79 #define TCP_TIMER_PROBE      2                      ///< Window probe timer.
  80 #define TCP_TIMER_KEEPALIVE  3                      ///< Keepalive timer.
  81 #define TCP_TIMER_FINWAIT2   4                      ///< FIN_WAIT_2 timer.
  82 #define TCP_TIMER_2MSL       5                      ///< TIME_WAIT timer.
  83 #define TCP_TIMER_NUMBER     6                      ///< The total number of the TCP timer.
  84 #define TCP_TICK             200                    ///< Every TCP tick is 200ms.
  85 #define TCP_TICK_HZ          5                      ///< The frequence of TCP tick.
  86 #define TCP_RTT_SHIFT        3                      ///< SRTT & RTTVAR scaled by 8.
  87 #define TCP_RTO_MIN          TCP_TICK_HZ            ///< The minimum value of RTO.
  88 #define TCP_RTO_MAX          (TCP_TICK_HZ * 60)     ///< The maximum value of RTO.
  89 #define TCP_FOLD_RTT         4                      ///< Timeout threshold to fold RTT.
  90
  91 //
  92 // Default values for some timers
  93 //
  94 #define TCP_MAX_LOSS            12                           ///< Default max times to retxmit.
  95 #define TCP_KEEPALIVE_IDLE_MIN  (TCP_TICK_HZ * 60 * 60 * 2)  ///< First keepalive.
  96 #define TCP_KEEPALIVE_PERIOD    (TCP_TICK_HZ * 60)
  97 #define TCP_MAX_KEEPALIVE       8
  98 #define TCP_FIN_WAIT2_TIME      (2 * TCP_TICK_HZ)
  99 #define TCP_TIME_WAIT_TIME      (2 * TCP_TICK_HZ)
 100 #define TCP_PAWS_24DAY          (24 * 24 * 60 * 60 * TCP_TICK_HZ)
 101 #define TCP_CONNECT_TIME        (75 * TCP_TICK_HZ)
 102
 103 //
 104 // The header space to be reserved before TCP data to accommodate:
 105 // 60byte IP head + 60byte TCP head + link layer head
 106 //
 107 #define TCP_MAX_HEAD  192
 108
 109 //
 110 // Value ranges for some control option
 111 //
 112 #define TCP_RCV_BUF_SIZE          (2 * 1024 * 1024)
 113 #define TCP_RCV_BUF_SIZE_MIN      (8 * 1024)
 114 #define TCP_SND_BUF_SIZE          (2 * 1024 * 1024)
 115 #define TCP_SND_BUF_SIZE_MIN      (8 * 1024)
 116 #define TCP_BACKLOG               10
 117 #define TCP_BACKLOG_MIN           5
 118 #define TCP_MAX_LOSS_MIN          6
 119 #define TCP_CONNECT_TIME_MIN      (60 * TCP_TICK_HZ)
 120 #define TCP_MAX_KEEPALIVE_MIN     4
 121 #define TCP_KEEPALIVE_IDLE_MAX    (TCP_TICK_HZ * 60 * 60 * 4)
 122 #define TCP_KEEPALIVE_PERIOD_MIN  (TCP_TICK_HZ * 30)
 123 #define TCP_FIN_WAIT2_TIME_MAX    (4 * TCP_TICK_HZ)
 124 #define TCP_TIME_WAIT_TIME_MAX    (60 * TCP_TICK_HZ)
 125
 126 ///
 127 /// TCP_CONNECTED: both ends have synchronized their ISN.
 128 ///
 129 #define TCP_CONNECTED(state)  ((state) > TCP_SYN_RCVD)
 130
 131 #define TCP_FIN_RCVD(State) \
 132   ( \
 133     ((State) == TCP_CLOSE_WAIT) || \
 134     ((State) == TCP_LAST_ACK) || \
 135     ((State) == TCP_CLOSING) || \
 136     ((State) == TCP_TIME_WAIT) \
 137   )
 138
 139 #define TCP_LOCAL_CLOSED(State) \
 140   ( \
 141     ((State) == TCP_FIN_WAIT_1) || \
 142     ((State) == TCP_FIN_WAIT_2) || \
 143     ((State) == TCP_CLOSING) || \
 144     ((State) == TCP_TIME_WAIT) || \
 145     ((State) == TCP_LAST_ACK) \
 146   )
 147
 148 //
 149 // Get the TCP_SEG point from a net buffer's ProtoData.
 150 //
 151 #define TCPSEG_NETBUF(NBuf)  ((TCP_SEG *) ((NBuf)->ProtoData))
 152
 153 //
 154 // Macros to compare sequence no
 155 //
 156 #define TCP_SEQ_LT(SeqA, SeqB)   ((INT32) ((SeqA) - (SeqB)) < 0)
 157 #define TCP_SEQ_LEQ(SeqA, SeqB)  ((INT32) ((SeqA) - (SeqB)) <= 0)
 158 #define TCP_SEQ_GT(SeqA, SeqB)   ((INT32) ((SeqB) - (SeqA)) < 0)
 159 #define TCP_SEQ_GEQ(SeqA, SeqB)  ((INT32) ((SeqB) - (SeqA)) <= 0)
 160
 161 //
 162 // TCP_SEQ_BETWEEN return whether b <= m <= e
 163 //
 164 #define TCP_SEQ_BETWEEN(b, m, e)  ((e) - (b) >= (m) - (b))
 165
 166 //
 167 // TCP_SUB_SEQ returns Seq1 - Seq2. Make sure Seq1 >= Seq2
 168 //
 169 #define TCP_SUB_SEQ(Seq1, Seq2)  ((UINT32) ((Seq1) - (Seq2)))
 170
 171 //
 172 // Check whether Flag is on
 173 //
 174 #define TCP_FLG_ON(Value, Flag)  ((BOOLEAN) (((Value) & (Flag)) != 0))
 175 //
 176 // Set and Clear operation on a Flag
 177 //
 178 #define TCP_SET_FLG(Value, Flag)    ((Value) |= (Flag))
 179 #define TCP_CLEAR_FLG(Value, Flag)  ((Value) &= ~(Flag))
 180
 181 //
 182 // Test whether two peers are equal
 183 //
 184 #define TCP_PEER_EQUAL(Pa, Pb, Ver) \
 185   (((Pa)->Port == (Pb)->Port) && TcpIsIpEqual(&((Pa)->Ip), &((Pb)->Ip), Ver))
 186
 187 //
 188 // Test whether Pa matches Pb, or Pa is more specific
 189 // than pb. Zero means wildcard.
 190 //
 191 #define TCP_PEER_MATCH(Pa, Pb, Ver) \
 192   ( \
 193     (((Pb)->Port == 0) || ((Pb)->Port == (Pa)->Port)) && \
 194     (TcpIsIpZero (&((Pb)->Ip), Ver) || TcpIsIpEqual (&((Pb)->Ip), &((Pa)->Ip), Ver)) \
 195   )
 196
 197 #define TCP_TIMER_ON(Flag, Timer)     ((Flag) & (1 << (Timer)))
 198 #define TCP_SET_TIMER(Flag, Timer)    ((Flag) = (UINT16) ((Flag) | (1 << (Timer))))
 199 #define TCP_CLEAR_TIMER(Flag, Timer)  ((Flag) = (UINT16) ((Flag) & (~(1 << (Timer)))))
 200
 201 #define TCP_TIME_LT(Ta, Tb)   ((INT32) ((Ta) - (Tb)) < 0)
 202 #define TCP_TIME_LEQ(Ta, Tb)  ((INT32) ((Ta) - (Tb)) <= 0)
 203 #define TCP_SUB_TIME(Ta, Tb)  ((UINT32) ((Ta) - (Tb)))
 204
 205 #define TCP_MAX_WIN  0xFFFFU
 206
 207 ///
 208 /// TCP segmentation data.
 209 ///
 210 typedef struct _TCP_SEG {
 211   TCP_SEQNO    Seq;  ///< Starting sequence number.
 212   TCP_SEQNO    End;  ///< The sequence of the last byte + 1, include SYN/FIN. End-Seq = SEG.LEN.
 213   TCP_SEQNO    Ack;  ///< ACK field in the segment.
 214   UINT8        Flag; ///< TCP header flags.
 215   UINT16       Urg;  ///< Valid if URG flag is set.
 216   UINT32       Wnd;  ///< TCP window size field.
 217 } TCP_SEG;
 218
 219 ///
 220 /// Network endpoint, IP plus Port structure.
 221 ///
 222 typedef struct _TCP_PEER {
 223   EFI_IP_ADDRESS    Ip;   ///< IP address, in network byte order.
 224   TCP_PORTNO        Port; ///< Port number, in network byte order.
 225 } TCP_PEER;
 226
 227 typedef struct _TCP_CONTROL_BLOCK TCP_CB;
 228
 229 ///
 230 /// TCP control block: it includes various states.
 231 ///
 232 struct _TCP_CONTROL_BLOCK {
 233   LIST_ENTRY          List;    ///< Back and forward link entry
 234   TCP_CB              *Parent; ///< The parent TCP_CB structure
 235
 236   SOCKET              *Sk;       ///< The socket it controlled.
 237   TCP_PEER            LocalEnd;  ///< Local endpoint.
 238   TCP_PEER            RemoteEnd; ///< Remote endpoint.
 239
 240   LIST_ENTRY          SndQue;   ///< Retxmission queue.
 241   LIST_ENTRY          RcvQue;   ///< Reassemble queue.
 242   UINT32              CtrlFlag; ///< Control flags, such as NO_NAGLE.
 243   INT32               Error;    ///< Soft error status, such as TCP_CONNECT_RESET.
 244
 245   //
 246   // RFC793 and RFC1122 defined variables
 247   //
 248   UINT8               State;      ///< TCP state, such as SYN_SENT, LISTEN.
 249   UINT8               DelayedAck; ///< Number of delayed ACKs.
 250   UINT16              HeadSum;    ///< Checksum of the fixed parts of pesudo
 251                                   ///< header: Src IP, Dst IP, 0, Protocol,
 252                                   ///< do not include the TCP length.
 253
 254   TCP_SEQNO           Iss;       ///< Initial Sending Sequence.
 255   TCP_SEQNO           SndUna;    ///< First unacknowledged data.
 256   TCP_SEQNO           SndNxt;    ///< Next data sequence to send.
 257   TCP_SEQNO           SndPsh;    ///< Send PUSH point.
 258   TCP_SEQNO           SndUp;     ///< Send urgent point.
 259   UINT32              SndWnd;    ///< Window advertised by the remote peer.
 260   UINT32              SndWndMax; ///< Max send window advertised by the peer.
 261   TCP_SEQNO           SndWl1;    ///< Seq number used for last window update.
 262   TCP_SEQNO           SndWl2;    ///< Ack no of last window update.
 263   UINT16              SndMss;    ///< Max send segment size.
 264   TCP_SEQNO           RcvNxt;    ///< Next sequence no to receive.
 265   UINT32              RcvWnd;    ///< Window advertised by the local peer.
 266   TCP_SEQNO           RcvWl2;    ///< The RcvNxt (or ACK) of last window update.
 267                                  ///< It is necessary because of delayed ACK.
 268
 269   TCP_SEQNO           RcvUp;                   ///< Urgent point;
 270   TCP_SEQNO           Irs;                     ///< Initial Receiving Sequence.
 271   UINT16              RcvMss;                  ///< Max receive segment size.
 272   UINT16              EnabledTimer;            ///< Which timer is currently enabled.
 273   UINT32              Timer[TCP_TIMER_NUMBER]; ///< When the timer will expire.
 274   INT32               NextExpire;              ///< Countdown offset for the nearest timer.
 275   UINT32              Idle;                    ///< How long the connection is in idle.
 276   UINT32              ProbeTime;               ///< The time out value for current window prober.
 277   BOOLEAN             ProbeTimerOn;            ///< If TRUE, the probe time is on.
 278
 279   //
 280   // RFC1323 defined variables, about window scale,
 281   // timestamp and PAWS
 282   //
 283   UINT8               SndWndScale; ///< Wndscale received from the peer.
 284   UINT8               RcvWndScale; ///< Wndscale used to scale local buffer.
 285   UINT32              TsRecent;    ///< TsRecent to echo to the remote peer.
 286   UINT32              TsRecentAge; ///< When this TsRecent is updated.
 287
 288   //
 289   // RFC2988 defined variables. about RTT measurement
 290   //
 291   TCP_SEQNO           RttSeq;     ///< The seq of measured segment now.
 292   UINT32              RttMeasure; ///< Currently measured RTT in heartbeats.
 293   UINT32              SRtt;       ///< Smoothed RTT, scaled by 8.
 294   UINT32              RttVar;     ///< RTT variance, scaled by 8.
 295   UINT32              Rto;        ///< Current RTO, not scaled.
 296
 297   //
 298   // RFC2581, and 3782 variables.
 299   // Congestion control + NewReno fast recovery.
 300   //
 301   UINT32              CWnd;         ///< Sender's congestion window.
 302   UINT32              Ssthresh;     ///< Slow start threshold.
 303   TCP_SEQNO           Recover;      ///< Recover point for NewReno.
 304   UINT16              DupAck;       ///< Number of duplicate ACKs.
 305   UINT8               CongestState; ///< The current congestion state(RFC3782).
 306   UINT8               LossTimes;    ///< Number of retxmit timeouts in a row.
 307   TCP_SEQNO           LossRecover;  ///< Recover point for retxmit.
 308
 309   //
 310   // RFC7323
 311   // Addressing Window Retraction for TCP Window Scale Option.
 312   //
 313   TCP_SEQNO           RetxmitSeqMax;     ///< Max Seq number in previous retransmission.
 314
 315   //
 316   // configuration parameters, for EFI_TCP4_PROTOCOL specification
 317   //
 318   UINT32              KeepAliveIdle;   ///< Idle time before sending first probe.
 319   UINT32              KeepAlivePeriod; ///< Interval for subsequent keep alive probe.
 320   UINT8               MaxKeepAlive;    ///< Maximum keep alive probe times.
 321   UINT8               KeepAliveProbes; ///< The number of keep alive probe.
 322   UINT16              MaxRexmit;       ///< The maximum number of retxmit before abort.
 323   UINT32              FinWait2Timeout; ///< The FIN_WAIT_2 timeout.
 324   UINT32              TimeWaitTimeout; ///< The TIME_WAIT timeout.
 325   UINT32              ConnectTimeout;  ///< The connect establishment timeout.
 326
 327   //
 328   // configuration for tcp provided by user
 329   //
 330   BOOLEAN             UseDefaultAddr;
 331   UINT8               Tos;
 332   UINT8               Ttl;
 333   EFI_IPv4_ADDRESS    SubnetMask;
 334
 335   BOOLEAN             RemoteIpZero; ///< RemoteEnd.Ip is ZERO when configured.
 336   IP_IO_IP_INFO       *IpInfo;      ///< Pointer reference to Ip used to send pkt
 337   UINT32              Tick;         ///< 1 tick = 200ms
 338 };
 339
 340 #endif