TcpProto.h

Go to the documentation of this file.

 
#ifndef _TCP_PROTO_H_
#define _TCP_PROTO_H_
 
#define TCP_CLOSED       0
#define TCP_LISTEN       1
#define TCP_SYN_SENT     2
#define TCP_SYN_RCVD     3
#define TCP_ESTABLISHED  4
#define TCP_FIN_WAIT_1   5
#define TCP_FIN_WAIT_2   6
#define TCP_CLOSING      7
#define TCP_TIME_WAIT    8
#define TCP_CLOSE_WAIT   9
#define TCP_LAST_ACK     10
 
#define TCP_FLG_FIN  0x01
#define TCP_FLG_SYN  0x02
#define TCP_FLG_RST  0x04
#define TCP_FLG_PSH  0x08
#define TCP_FLG_ACK  0x10
#define TCP_FLG_URG  0x20
 
//
// mask for all the flags
//
#define TCP_FLG_FLAG  0x3F
 
#define TCP_CONNECT_REFUSED  (-1)     
#define TCP_CONNECT_RESET    (-2)     
#define TCP_CONNECT_CLOSED   (-3)     
 
//
// Current congestion status as suggested by RFC3782.
//
#define TCP_CONGEST_RECOVER  1      
#define TCP_CONGEST_LOSS     2      
#define TCP_CONGEST_OPEN     3      
 
//
// TCP control flags
//
#define TCP_CTRL_NO_NAGLE      0x0001   
#define TCP_CTRL_NO_KEEPALIVE  0x0002   
#define TCP_CTRL_NO_WS         0x0004   
#define TCP_CTRL_RCVD_WS       0x0008   
#define TCP_CTRL_NO_TS         0x0010   
#define TCP_CTRL_RCVD_TS       0x0020   
#define TCP_CTRL_SND_TS        0x0040   
#define TCP_CTRL_SND_URG       0x0080   
#define TCP_CTRL_RCVD_URG      0x0100   
#define TCP_CTRL_SND_PSH       0x0200   
#define TCP_CTRL_FIN_SENT      0x0400   
#define TCP_CTRL_FIN_ACKED     0x0800   
#define TCP_CTRL_TIMER_ON      0x1000   
#define TCP_CTRL_RTT_ON        0x2000   
#define TCP_CTRL_ACK_NOW       0x4000   
 
//
// Timer related values
//
#define TCP_TIMER_CONNECT    0                      
#define TCP_TIMER_REXMIT     1                      
#define TCP_TIMER_PROBE      2                      
#define TCP_TIMER_KEEPALIVE  3                      
#define TCP_TIMER_FINWAIT2   4                      
#define TCP_TIMER_2MSL       5                      
#define TCP_TIMER_NUMBER     6                      
#define TCP_TICK             200                    
#define TCP_TICK_HZ          5                      
#define TCP_RTT_SHIFT        3                      
#define TCP_RTO_MIN          TCP_TICK_HZ            
#define TCP_RTO_MAX          (TCP_TICK_HZ * 60)     
#define TCP_FOLD_RTT         4                      
 
//
// Default values for some timers
//
#define TCP_MAX_LOSS            12                           
#define TCP_KEEPALIVE_IDLE_MIN  (TCP_TICK_HZ * 60 * 60 * 2)  
#define TCP_KEEPALIVE_PERIOD    (TCP_TICK_HZ * 60)
#define TCP_MAX_KEEPALIVE       8
#define TCP_FIN_WAIT2_TIME      (2 * TCP_TICK_HZ)
#define TCP_TIME_WAIT_TIME      (2 * TCP_TICK_HZ)
#define TCP_PAWS_24DAY          (24 * 24 * 60 * 60 * TCP_TICK_HZ)
#define TCP_CONNECT_TIME        (75 * TCP_TICK_HZ)
 
//
// The header space to be reserved before TCP data to accommodate:
// 60byte IP head + 60byte TCP head + link layer head
//
#define TCP_MAX_HEAD  192
 
//
// Value ranges for some control option
//
#define TCP_RCV_BUF_SIZE          (2 * 1024 * 1024)
#define TCP_RCV_BUF_SIZE_MIN      (8 * 1024)
#define TCP_SND_BUF_SIZE          (2 * 1024 * 1024)
#define TCP_SND_BUF_SIZE_MIN      (8 * 1024)
#define TCP_BACKLOG               10
#define TCP_BACKLOG_MIN           5
#define TCP_MAX_LOSS_MIN          6
#define TCP_CONNECT_TIME_MIN      (60 * TCP_TICK_HZ)
#define TCP_MAX_KEEPALIVE_MIN     4
#define TCP_KEEPALIVE_IDLE_MAX    (TCP_TICK_HZ * 60 * 60 * 4)
#define TCP_KEEPALIVE_PERIOD_MIN  (TCP_TICK_HZ * 30)
#define TCP_FIN_WAIT2_TIME_MAX    (4 * TCP_TICK_HZ)
#define TCP_TIME_WAIT_TIME_MAX    (60 * TCP_TICK_HZ)
 
#define TCP_CONNECTED(state)  ((state) > TCP_SYN_RCVD)
 
#define TCP_FIN_RCVD(State) \
  ( \
    ((State) == TCP_CLOSE_WAIT) || \
    ((State) == TCP_LAST_ACK) || \
    ((State) == TCP_CLOSING) || \
    ((State) == TCP_TIME_WAIT) \
  )
 
#define TCP_LOCAL_CLOSED(State) \
  ( \
    ((State) == TCP_FIN_WAIT_1) || \
    ((State) == TCP_FIN_WAIT_2) || \
    ((State) == TCP_CLOSING) || \
    ((State) == TCP_TIME_WAIT) || \
    ((State) == TCP_LAST_ACK) \
  )
 
//
// Get the TCP_SEG point from a net buffer's ProtoData.
//
#define TCPSEG_NETBUF(NBuf)  ((TCP_SEG *) ((NBuf)->ProtoData))
 
//
// Macros to compare sequence no
//
#define TCP_SEQ_LT(SeqA, SeqB)   ((INT32) ((SeqA) - (SeqB)) < 0)
#define TCP_SEQ_LEQ(SeqA, SeqB)  ((INT32) ((SeqA) - (SeqB)) <= 0)
#define TCP_SEQ_GT(SeqA, SeqB)   ((INT32) ((SeqB) - (SeqA)) < 0)
#define TCP_SEQ_GEQ(SeqA, SeqB)  ((INT32) ((SeqB) - (SeqA)) <= 0)
 
//
// TCP_SEQ_BETWEEN return whether b <= m <= e
//
#define TCP_SEQ_BETWEEN(b, m, e)  ((e) - (b) >= (m) - (b))
 
//
// TCP_SUB_SEQ returns Seq1 - Seq2. Make sure Seq1 >= Seq2
//
#define TCP_SUB_SEQ(Seq1, Seq2)  ((UINT32) ((Seq1) - (Seq2)))
 
//
// Check whether Flag is on
//
#define TCP_FLG_ON(Value, Flag)  ((BOOLEAN) (((Value) & (Flag)) != 0))
//
// Set and Clear operation on a Flag
//
#define TCP_SET_FLG(Value, Flag)    ((Value) |= (Flag))
#define TCP_CLEAR_FLG(Value, Flag)  ((Value) &= ~(Flag))
 
//
// Test whether two peers are equal
//
#define TCP_PEER_EQUAL(Pa, Pb, Ver) \
  (((Pa)->Port == (Pb)->Port) && TcpIsIpEqual(&((Pa)->Ip), &((Pb)->Ip), Ver))
 
//
// Test whether Pa matches Pb, or Pa is more specific
// than pb. Zero means wildcard.
//
#define TCP_PEER_MATCH(Pa, Pb, Ver) \
  ( \
    (((Pb)->Port == 0) || ((Pb)->Port == (Pa)->Port)) && \
    (TcpIsIpZero (&((Pb)->Ip), Ver) || TcpIsIpEqual (&((Pb)->Ip), &((Pa)->Ip), Ver)) \
  )
 
#define TCP_TIMER_ON(Flag, Timer)     ((Flag) & (1 << (Timer)))
#define TCP_SET_TIMER(Flag, Timer)    ((Flag) = (UINT16) ((Flag) | (1 << (Timer))))
#define TCP_CLEAR_TIMER(Flag, Timer)  ((Flag) = (UINT16) ((Flag) & (~(1 << (Timer)))))
 
#define TCP_TIME_LT(Ta, Tb)   ((INT32) ((Ta) - (Tb)) < 0)
#define TCP_TIME_LEQ(Ta, Tb)  ((INT32) ((Ta) - (Tb)) <= 0)
#define TCP_SUB_TIME(Ta, Tb)  ((UINT32) ((Ta) - (Tb)))
 
#define TCP_MAX_WIN  0xFFFFU
 
typedef struct _TCP_SEG {
  TCP_SEQNO    Seq;  
  TCP_SEQNO    End;  
  TCP_SEQNO    Ack;  
  UINT8        Flag; 
  UINT16       Urg;  
  UINT32       Wnd;  
} TCP_SEG;
 
typedef struct _TCP_PEER {
  EFI_IP_ADDRESS    Ip;   
  TCP_PORTNO        Port; 
} TCP_PEER;
 
typedef struct _TCP_CONTROL_BLOCK TCP_CB;
 
struct _TCP_CONTROL_BLOCK {
  LIST_ENTRY          List;    
  TCP_CB              *Parent; 
 
  SOCKET              *Sk;       
  TCP_PEER            LocalEnd;  
  TCP_PEER            RemoteEnd; 
 
  LIST_ENTRY          SndQue;   
  LIST_ENTRY          RcvQue;   
  UINT32              CtrlFlag; 
  INT32               Error;    
 
  //
  // RFC793 and RFC1122 defined variables
  //
  UINT8               State;      
  UINT8               DelayedAck; 
  UINT16              HeadSum;    
 
  TCP_SEQNO           Iss;       
  TCP_SEQNO           SndUna;    
  TCP_SEQNO           SndNxt;    
  TCP_SEQNO           SndPsh;    
  TCP_SEQNO           SndUp;     
  UINT32              SndWnd;    
  UINT32              SndWndMax; 
  TCP_SEQNO           SndWl1;    
  TCP_SEQNO           SndWl2;    
  UINT16              SndMss;    
  TCP_SEQNO           RcvNxt;    
  UINT32              RcvWnd;    
  TCP_SEQNO           RcvWl2;    
 
  TCP_SEQNO           RcvUp;                   
  TCP_SEQNO           Irs;                     
  UINT16              RcvMss;                  
  UINT16              EnabledTimer;            
  UINT32              Timer[TCP_TIMER_NUMBER]; 
  INT32               NextExpire;              
  UINT32              Idle;                    
  UINT32              ProbeTime;               
  BOOLEAN             ProbeTimerOn;            
 
  //
  // RFC7323 defined variables, about window scale,
  // timestamp and PAWS
  //
  UINT8               SndWndScale; 
  UINT8               RcvWndScale; 
  UINT32              TsRecent;    
  UINT32              TsRecentAge; 
 
  //
  // RFC2988 defined variables. about RTT measurement
  //
  TCP_SEQNO           RttSeq;     
  UINT32              RttMeasure; 
  UINT32              SRtt;       
  UINT32              RttVar;     
  UINT32              Rto;        
 
  //
  // RFC2581, and 3782 variables.
  // Congestion control + NewReno fast recovery.
  //
  UINT32              CWnd;         
  UINT32              Ssthresh;     
  TCP_SEQNO           Recover;      
  UINT16              DupAck;       
  UINT8               CongestState; 
  UINT8               LossTimes;    
  TCP_SEQNO           LossRecover;  
 
  //
  // RFC7323
  // Addressing Window Retraction for TCP Window Scale Option.
  //
  TCP_SEQNO           RetxmitSeqMax;     
 
  //
  // configuration parameters, for EFI_TCP4_PROTOCOL specification
  //
  UINT32              KeepAliveIdle;   
  UINT32              KeepAlivePeriod; 
  UINT8               MaxKeepAlive;    
  UINT8               KeepAliveProbes; 
  UINT16              MaxRexmit;       
  UINT32              FinWait2Timeout; 
  UINT32              TimeWaitTimeout; 
  UINT32              ConnectTimeout;  
 
  //
  // configuration for tcp provided by user
  //
  BOOLEAN             UseDefaultAddr;
  UINT8               Tos;
  UINT8               Ttl;
  EFI_IPv4_ADDRESS    SubnetMask;
 
  BOOLEAN             RemoteIpZero; 
  IP_IO_IP_INFO       *IpInfo;      
  UINT32              Tick;         
};
 
#endif