4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP protocol header file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync http://opensource.org/licenses/bsd-license.php.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#ifndef _TCP_PROTO_H_
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define _TCP_PROTO_H_
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Tcp states don't change their order. It is used as an
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// index to mTcpOutFlag and other macros.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CLOSED 0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_LISTEN 1
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_SYN_SENT 2
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_SYN_RCVD 3
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_ESTABLISHED 4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_FIN_WAIT_1 5
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_FIN_WAIT_2 6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CLOSING 7
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_TIME_WAIT 8
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CLOSE_WAIT 9
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_LAST_ACK 10
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Flags in the TCP header
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_FLG_FIN 0x01
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_FLG_SYN 0x02
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_FLG_RST 0x04
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_FLG_PSH 0x08
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_FLG_ACK 0x10
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_FLG_URG 0x20
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // mask for all the flags
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_FLG_FLAG 0x3F
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CONNECT_REFUSED (-1) ///< TCP error status
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CONNECT_RESET (-2) ///< TCP error status
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CONNECT_CLOSED (-3) ///< TCP error status
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Current congestion status as suggested by RFC3782.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CONGEST_RECOVER 1 ///< During the NewReno fast recovery.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CONGEST_LOSS 2 ///< Retxmit because of retxmit time out.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CONGEST_OPEN 3 ///< TCP is opening its congestion window.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// TCP control flags
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CTRL_NO_NAGLE 0x0001 ///< Disable Nagle algorithm
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CTRL_NO_KEEPALIVE 0x0002 ///< Disable keepalive timer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CTRL_NO_WS 0x0004 ///< Disable window scale option.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CTRL_RCVD_WS 0x0008 ///< Received a wnd scale option in syn.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CTRL_NO_TS 0x0010 ///< Disable Timestamp option.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CTRL_RCVD_TS 0x0020 ///< Received a Timestamp option in syn.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CTRL_SND_TS 0x0040 ///< Send Timestamp option to remote.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CTRL_SND_URG 0x0080 ///< In urgent send mode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CTRL_RCVD_URG 0x0100 ///< In urgent receive mode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CTRL_SND_PSH 0x0200 ///< In PUSH send mode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CTRL_FIN_SENT 0x0400 ///< FIN is sent.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CTRL_FIN_ACKED 0x0800 ///< FIN is ACKed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CTRL_TIMER_ON 0x1000 ///< At least one of the timer is on.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CTRL_RTT_ON 0x2000 ///< The RTT measurement is on.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CTRL_ACK_NOW 0x4000 ///< Send the ACK now, don't delay.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Timer related values
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_TIMER_CONNECT 0 ///< Connection establishment timer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_TIMER_REXMIT 1 ///< Retransmit timer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_TIMER_PROBE 2 ///< Window probe timer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_TIMER_KEEPALIVE 3 ///< Keepalive timer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_TIMER_FINWAIT2 4 ///< FIN_WAIT_2 timer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_TIMER_2MSL 5 ///< TIME_WAIT timer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_TIMER_NUMBER 6 ///< The total number of the TCP timer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_TICK 200 ///< Every TCP tick is 200ms.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_TICK_HZ 5 ///< The frequence of TCP tick.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_RTT_SHIFT 3 ///< SRTT & RTTVAR scaled by 8.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_RTO_MIN TCP_TICK_HZ ///< The minium value of RTO.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_RTO_MAX (TCP_TICK_HZ * 60) ///< The maxium value of RTO.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_FOLD_RTT 4 ///< Timeout threshod to fold RTT.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Default values for some timers
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_MAX_LOSS 12 ///< Default max times to retxmit.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_KEEPALIVE_IDLE_MIN (TCP_TICK_HZ * 60 * 60 * 2) ///< First keepalive.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_KEEPALIVE_PERIOD (TCP_TICK_HZ * 60)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_MAX_KEEPALIVE 8
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_FIN_WAIT2_TIME (2 * TCP_TICK_HZ)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_TIME_WAIT_TIME (2 * TCP_TICK_HZ)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_PAWS_24DAY (24 * 24 * 60 * 60 * TCP_TICK_HZ)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CONNECT_TIME (75 * TCP_TICK_HZ)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The header space to be reserved before TCP data to accomodate :
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// 60byte IP head + 60byte TCP head + link layer head
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_MAX_HEAD 192
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Value ranges for some control option
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_RCV_BUF_SIZE (2 * 1024 * 1024)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_RCV_BUF_SIZE_MIN (8 * 1024)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_SND_BUF_SIZE (2 * 1024 * 1024)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_SND_BUF_SIZE_MIN (8 * 1024)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_BACKLOG 10
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_BACKLOG_MIN 5
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_MAX_LOSS_MIN 6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CONNECT_TIME_MIN (60 * TCP_TICK_HZ)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_MAX_KEEPALIVE_MIN 4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_KEEPALIVE_IDLE_MAX (TCP_TICK_HZ * 60 * 60 * 4)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_KEEPALIVE_PERIOD_MIN (TCP_TICK_HZ * 30)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_FIN_WAIT2_TIME_MAX (4 * TCP_TICK_HZ)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_TIME_WAIT_TIME_MAX (60 * TCP_TICK_HZ)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// TCP_CONNECTED: both ends have synchronized their ISN.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CONNECTED(state) ((state) > TCP_SYN_RCVD)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_FIN_RCVD(State) \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ( \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ((State) == TCP_CLOSE_WAIT) || \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ((State) == TCP_LAST_ACK) || \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ((State) == TCP_CLOSING) || \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ((State) == TCP_TIME_WAIT) \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_LOCAL_CLOSED(State) \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ( \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ((State) == TCP_FIN_WAIT_1) || \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ((State) == TCP_FIN_WAIT_2) || \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ((State) == TCP_CLOSING) || \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ((State) == TCP_TIME_WAIT) || \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ((State) == TCP_LAST_ACK) \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Get the TCP_SEG point from a net buffer's ProtoData.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCPSEG_NETBUF(NBuf) ((TCP_SEG *) ((NBuf)->ProtoData))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Macros to compare sequence no
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_SEQ_LT(SeqA, SeqB) ((INT32) ((SeqA) - (SeqB)) < 0)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_SEQ_LEQ(SeqA, SeqB) ((INT32) ((SeqA) - (SeqB)) <= 0)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_SEQ_GT(SeqA, SeqB) ((INT32) ((SeqB) - (SeqA)) < 0)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_SEQ_GEQ(SeqA, SeqB) ((INT32) ((SeqB) - (SeqA)) <= 0)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// TCP_SEQ_BETWEEN return whether b <= m <= e
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_SEQ_BETWEEN(b, m, e) ((e) - (b) >= (m) - (b))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// TCP_SUB_SEQ returns Seq1 - Seq2. Make sure Seq1 >= Seq2
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_SUB_SEQ(Seq1, Seq2) ((UINT32) ((Seq1) - (Seq2)))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Check whether Flag is on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_FLG_ON(Value, Flag) ((BOOLEAN) (((Value) & (Flag)) != 0))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Set and Clear operation on a Flag
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_SET_FLG(Value, Flag) ((Value) |= (Flag))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CLEAR_FLG(Value, Flag) ((Value) &= ~(Flag))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Test whether two peers are equal
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_PEER_EQUAL(Pa, Pb, Ver) \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (((Pa)->Port == (Pb)->Port) && TcpIsIpEqual(&((Pa)->Ip), &((Pb)->Ip), Ver))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Test whether Pa matches Pb, or Pa is more specific
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// than pb. Zero means wildcard.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_PEER_MATCH(Pa, Pb, Ver) \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ( \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (((Pb)->Port == 0) || ((Pb)->Port == (Pa)->Port)) && \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (TcpIsIpZero (&((Pb)->Ip), Ver) || TcpIsIpEqual (&((Pb)->Ip), &((Pa)->Ip), Ver)) \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_TIMER_ON(Flag, Timer) ((Flag) & (1 << (Timer)))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_SET_TIMER(Flag, Timer) ((Flag) = (UINT16) ((Flag) | (1 << (Timer))))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_CLEAR_TIMER(Flag, Timer) ((Flag) = (UINT16) ((Flag) & (~(1 << (Timer)))))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_TIME_LT(Ta, Tb) ((INT32) ((Ta) - (Tb)) < 0)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_TIME_LEQ(Ta, Tb) ((INT32) ((Ta) - (Tb)) <= 0)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_SUB_TIME(Ta, Tb) ((UINT32) ((Ta) - (Tb)))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define TCP_MAX_WIN 0xFFFFU
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// TCP segmentation data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _TCP_SEG {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_SEQNO Seq; ///< Starting sequence number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_SEQNO End; ///< The sequence of the last byte + 1, include SYN/FIN. End-Seq = SEG.LEN.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_SEQNO Ack; ///< ACK field in the segment.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 Flag; ///< TCP header flags.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 Urg; ///< Valid if URG flag is set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Wnd; ///< TCP window size field.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} TCP_SEG;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Network endpoint, IP plus Port structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _TCP_PEER {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP_ADDRESS Ip; ///< IP address, in network byte order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_PORTNO Port; ///< Port number, in network byte order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} TCP_PEER;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _TCP_CONTROL_BLOCK TCP_CB;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// TCP control block: it includes various states.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncstruct _TCP_CONTROL_BLOCK {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LIST_ENTRY List; ///< Back and forward link entry
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_CB *Parent; ///< The parent TCP_CB structure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SOCKET *Sk; ///< The socket it controled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_PEER LocalEnd; ///< Local endpoint.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_PEER RemoteEnd;///< Remote endpoint.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LIST_ENTRY SndQue; ///< Retxmission queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LIST_ENTRY RcvQue; ///< Reassemble queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 CtrlFlag; ///< Control flags, such as NO_NAGLE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync INT32 Error; ///< Soft error status, such as TCP_CONNECT_RESET.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // RFC793 and RFC1122 defined variables
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 State; ///< TCP state, such as SYN_SENT, LISTEN.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 DelayedAck; ///< Number of delayed ACKs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 HeadSum; ///< Checksum of the fixed parts of pesudo
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///< header: Src IP, Dst IP, 0, Protocol,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///< do not include the TCP length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_SEQNO Iss; ///< Initial Sending Sequence.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_SEQNO SndUna; ///< First unacknowledged data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_SEQNO SndNxt; ///< Next data sequence to send.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_SEQNO SndPsh; ///< Send PUSH point.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_SEQNO SndUp; ///< Send urgent point.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 SndWnd; ///< Window advertised by the remote peer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 SndWndMax; ///< Max send window advertised by the peer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_SEQNO SndWl1; ///< Seq number used for last window update.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_SEQNO SndWl2; ///< Ack no of last window update.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 SndMss; ///< Max send segment size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_SEQNO RcvNxt; ///< Next sequence no to receive.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 RcvWnd; ///< Window advertised by the local peer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_SEQNO RcvWl2; ///< The RcvNxt (or ACK) of last window update.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///< It is necessary because of delayed ACK.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_SEQNO RcvUp; ///< Urgent point;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_SEQNO Irs; ///< Initial Receiving Sequence.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 RcvMss; ///< Max receive segment size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 EnabledTimer; ///< Which timer is currently enabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Timer[TCP_TIMER_NUMBER]; ///< When the timer will expire.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync INT32 NextExpire; ///< Countdown offset for the nearest timer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Idle; ///< How long the connection is in idle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 ProbeTime; ///< The time out value for current window prober.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BOOLEAN ProbeTimerOn;///< If TRUE, the probe time is on.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // RFC1323 defined variables, about window scale,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // timestamp and PAWS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 SndWndScale; ///< Wndscale received from the peer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 RcvWndScale; ///< Wndscale used to scale local buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 TsRecent; ///< TsRecent to echo to the remote peer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 TsRecentAge; ///< When this TsRecent is updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // RFC2988 defined variables. about RTT measurement
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_SEQNO RttSeq; ///< The seq of measured segment now.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 RttMeasure; ///< Currently measured RTT in heartbeats.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 SRtt; ///< Smoothed RTT, scaled by 8.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 RttVar; ///< RTT variance, scaled by 8.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Rto; ///< Current RTO, not scaled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // RFC2581, and 3782 variables.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Congestion control + NewReno fast recovery.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 CWnd; ///< Sender's congestion window.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Ssthresh; ///< Slow start threshold.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_SEQNO Recover; ///< Recover point for NewReno.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 DupAck; ///< Number of duplicate ACKs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 CongestState; ///< The current congestion state(RFC3782).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 LossTimes; ///< Number of retxmit timeouts in a row.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_SEQNO LossRecover; ///< Recover point for retxmit.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // configuration parameters, for EFI_TCP4_PROTOCOL specification
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 KeepAliveIdle; ///< Idle time before sending first probe.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 KeepAlivePeriod; ///< Interval for subsequent keep alive probe.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 MaxKeepAlive; ///< Maxium keep alive probe times.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 KeepAliveProbes; ///< The number of keep alive probe.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 MaxRexmit; ///< The maxium number of retxmit before abort.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 FinWait2Timeout; ///< The FIN_WAIT_2 timeout.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 TimeWaitTimeout; ///< The TIME_WAIT timeout.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 ConnectTimeout; ///< The connect establishment timeout.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // configuration for tcp provided by user
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BOOLEAN UseDefaultAddr;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 Tos;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 Ttl;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPv4_ADDRESS SubnetMask;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IP_IO_IP_INFO *IpInfo; ///< Pointer reference to Ip used to send pkt
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Tick; ///< 1 tick = 200ms
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync};
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#endif