TCP Window Scaling enabling Test. More...

Inheritance diagram for WScalingTestCase:

Collaboration diagram for WScalingTestCase:

Public Types
enum	Configuration { DISABLED , ENABLED_SENDER , ENABLED_RECEIVER , ENABLED }
	Window Scaling configuration. More...

Public Types inherited from ns3::TcpGeneralTest
enum	SocketWho { SENDER , RECEIVER }
	Used as parameter of methods, specifies on what node the caller is interested (e.g. More...

Public Types inherited from ns3::TestCase
enum	TestDuration { QUICK = 1 , EXTENSIVE = 2 , TAKES_FOREVER = 3 }
	How long the test takes to execute. More...

Public Member Functions
	WScalingTestCase (WScalingTestCase::Configuration conf, uint32_t maxRcvBufferSize, uint32_t maxSndBufferSize, std::string name)
	Constructor.

Public Member Functions inherited from ns3::TcpGeneralTest
	TcpGeneralTest (const std::string &desc)
	TcpGeneralTest constructor.

	~TcpGeneralTest () override

Public Member Functions inherited from ns3::TestCase
	TestCase (const TestCase &)=delete

virtual	~TestCase ()
	Destructor.

std::string	GetName () const

TestCase &	operator= (const TestCase &)=delete

Protected Member Functions
Ptr< TcpSocketMsgBase >	CreateReceiverSocket (Ptr< Node > node) override
	Create and install the socket to install on the receiver.

Ptr< TcpSocketMsgBase >	CreateSenderSocket (Ptr< Node > node) override
	Create and install the socket to install on the sender.

void	Tx (const Ptr< const Packet > p, const TcpHeader &h, SocketWho who) override
	Packet transmitted down to IP layer.

Protected Member Functions inherited from ns3::TcpGeneralTest
virtual void	AfterRTOExpired (const Ptr< const TcpSocketState > tcb, SocketWho who)
	Rto has expired.

virtual void	BeforeRTOExpired (const Ptr< const TcpSocketState > tcb, SocketWho who)
	Rto has expired.

virtual void	BytesInFlightTrace (uint32_t oldValue, uint32_t newValue)
	Bytes in flight changes.

virtual void	ConfigureEnvironment ()
	Change the configuration of the environment.

virtual void	ConfigureProperties ()
	Change the configuration of the socket properties.

virtual void	CongStateTrace (const TcpSocketState::TcpCongState_t oldValue, const TcpSocketState::TcpCongState_t newValue)
	State on Ack state machine changes.

virtual Ptr< SimpleChannel >	CreateChannel ()
	Create and return the channel installed between the two socket.

virtual Ptr< ErrorModel >	CreateReceiverErrorModel ()
	Create and return the error model to install in the receiver node.

virtual Ptr< TcpSocketMsgBase >	CreateReceiverSocket (Ptr< Node > node)
	Create and install the socket to install on the receiver.

virtual Ptr< ErrorModel >	CreateSenderErrorModel ()
	Create and return the error model to install in the sender node.

virtual Ptr< TcpSocketMsgBase >	CreateSenderSocket (Ptr< Node > node)
	Create and install the socket to install on the sender.

virtual Ptr< TcpSocketMsgBase >	CreateSocket (Ptr< Node > node, TypeId socketType, TypeId congControl)
	Create a socket.

virtual Ptr< TcpSocketMsgBase >	CreateSocket (Ptr< Node > node, TypeId socketType, TypeId congControl, TypeId recoveryAlgorithm)
	Create a socket.

virtual void	CWndInflTrace (uint32_t oldValue, uint32_t newValue)
	Tracks the inflated congestion window changes.

virtual void	CWndTrace (uint32_t oldValue, uint32_t newValue)
	Tracks the congestion window changes.

virtual void	DataSent (uint32_t size, SocketWho who)
	Notifying application for sent data.

void	DoConnect ()
	Scheduled at 0.0, SENDER starts the connection to RECEIVER.

void	DoRun () override
	Execute the tcp test.

void	DoTeardown () override
	Teardown the TCP test.

virtual void	ErrorClose (SocketWho who)
	Socket closed with an error.

virtual void	FinalChecks ()
	Performs the (eventual) final checks through test asserts.

Time	GetClockGranularity (SocketWho who)
	Get the clock granularity attribute.

Time	GetConnTimeout (SocketWho who)
	Get the retransmission time for the SYN segments.

uint32_t	GetDelAckCount (SocketWho who)
	Get the number of delayed ack (if present)

Time	GetDelAckTimeout (SocketWho who)
	Get the timeout of delayed ack (if present)

uint32_t	GetDupAckCount (SocketWho who)
	Get the number of dupack received.

SequenceNumber32	GetHighestTxMark (SocketWho who)
	Get the highest tx mark of the node specified.

uint32_t	GetInitialCwnd (SocketWho who)
	Get the initial congestion window.

uint32_t	GetInitialSsThresh (SocketWho who)
	Get the initial slow start threshold.

Time	GetMinRto (SocketWho who)
	Get the minimum RTO attribute.

uint32_t	GetMtu () const
	Get the MTU of the environment.

EventId	GetPersistentEvent (SocketWho who)
	Get the persistent event of the selected socket.

Time	GetPersistentTimeout (SocketWho who)
	Get the persistent timeout of the selected socket.

uint32_t	GetPktCount () const
	Get the number of application packets.

Time	GetPktInterval () const
	Get the interval to wait for each packet sent down from application to TCP.

uint32_t	GetPktSize () const
	Get the application packet size.

Time	GetPropagationDelay () const
	Get the channel Propagation Delay.

Ptr< TcpSocketMsgBase >	GetReceiverSocket ()
	Get the pointer to a previously created receiver socket.

uint32_t	GetReTxThreshold (SocketWho who)
	Get the retransmission threshold.

Time	GetRto (SocketWho who)
	Get the retransmission time.

Ptr< RttEstimator >	GetRttEstimator (SocketWho who)
	Get the Rtt estimator of the socket.

uint32_t	GetRWnd (SocketWho who)
	Get the rWnd of the selected socket.

Ptr< TcpRxBuffer >	GetRxBuffer (SocketWho who)
	Get the Rx buffer from selected socket.

uint32_t	GetSegSize (SocketWho who)
	Get the segment size of the node specified.

Ptr< TcpSocketMsgBase >	GetSenderSocket ()
	Get the pointer to a previously created sender socket.

Time	GetStartTime () const
	Get the data start time.

Ptr< TcpSocketState >	GetTcb (SocketWho who)
	Get the TCB from selected socket.

TcpSocket::TcpStates_t	GetTcpState (SocketWho who)
	Get the state of the TCP state machine.

Ptr< TcpTxBuffer >	GetTxBuffer (SocketWho who)
	Get the Tx buffer from selected socket.

virtual void	HighestTxSeqTrace (SequenceNumber32 oldValue, SequenceNumber32 newValue)
	Highest tx seq changes.

virtual void	NextTxSeqTrace (SequenceNumber32 oldValue, SequenceNumber32 newValue)
	Next tx seq changes.

virtual void	NormalClose (SocketWho who)
	Socket closed normally.

virtual void	PhyDrop (SocketWho who)
	Link drop.

virtual void	ProcessedAck (const Ptr< const TcpSocketState > tcb, const TcpHeader &h, SocketWho who)
	Processed ack.

virtual void	QueueDrop (SocketWho who)
	Drop on the queue.

virtual void	RateSampleUpdatedTrace (const TcpRateLinux::TcpRateSample &sample)
	Track the rate sample value of TcpRateLinux.

virtual void	RateUpdatedTrace (const TcpRateLinux::TcpRateConnection &rate)
	Track the rate value of TcpRateLinux.

virtual void	RcvAck (const Ptr< const TcpSocketState > tcb, const TcpHeader &h, SocketWho who)
	Received ack.

virtual void	ReceivePacket (Ptr< Socket > socket)
	Packet received.

virtual void	RtoTrace (Time oldValue, Time newValue)
	RTO changes.

virtual void	RttTrace (Time oldTime, Time newTime)
	Rtt changes.

virtual void	Rx (const Ptr< const Packet > p, const TcpHeader &h, SocketWho who)
	Packet received from IP layer.

void	SendPacket (Ptr< Socket > socket, uint32_t pktSize, uint32_t pktCount, Time pktInterval)
	Send packets to other endpoint.

void	SetAppPktCount (uint32_t pktCount)
	Set app packet count.

void	SetAppPktInterval (Time pktInterval)
	Interval between app-generated packet.

void	SetAppPktSize (uint32_t pktSize)
	Set app packet size.

void	SetCongestionControl (TypeId congControl)
	Congestion control of the sender socket.

void	SetDelAckMaxCount (SocketWho who, uint32_t count)
	Forcefully set the delayed acknowledgement count.

void	SetInitialCwnd (SocketWho who, uint32_t initialCwnd)
	Forcefully set the initial cwnd.

void	SetInitialSsThresh (SocketWho who, uint32_t initialSsThresh)
	Forcefully set the initial ssthresh.

void	SetMTU (uint32_t mtu)
	MTU of the bottleneck link.

void	SetPaceInitialWindow (SocketWho who, bool paceWindow)
	Enable or disable pacing of the initial window.

void	SetPacingStatus (SocketWho who, bool pacing)
	Enable or disable pacing in the TCP socket.

void	SetPropagationDelay (Time propDelay)
	Propagation delay of the bottleneck link.

void	SetRcvBufSize (SocketWho who, uint32_t size)
	Forcefully set a defined size for rx buffer.

void	SetRecoveryAlgorithm (TypeId recovery)
	recovery algorithm of the sender socket

void	SetSegmentSize (SocketWho who, uint32_t segmentSize)
	Forcefully set the segment size.

void	SetTransmitStart (Time startTime)
	Set the initial time at which the application sends the first data packet.

void	SetUseEcn (SocketWho who, TcpSocketState::UseEcn_t useEcn)
	Forcefully set the ECN mode of use.

virtual void	SsThreshTrace (uint32_t oldValue, uint32_t newValue)
	Slow start threshold changes.

virtual void	Tx (const Ptr< const Packet > p, const TcpHeader &h, SocketWho who)
	Packet transmitted down to IP layer.

virtual void	UpdatedRttHistory (const SequenceNumber32 &seq, uint32_t sz, bool isRetransmission, SocketWho who)
	Updated the Rtt history.

Protected Member Functions inherited from ns3::TestCase
	TestCase (std::string name)
	Constructor.

void	AddTestCase (TestCase *testCase, TestDuration duration=QUICK)
	Add an individual child TestCase to this test suite.

TestCase *	GetParent () const
	Get the parent of this TestCase.

bool	IsStatusFailure () const
	Check if any tests failed.

bool	IsStatusSuccess () const
	Check if all tests passed.

void	SetDataDir (std::string directory)
	Set the data directory where reference trace files can be found.

void	ReportTestFailure (std::string cond, std::string actual, std::string limit, std::string message, std::string file, int32_t line)
	Log the failure of this TestCase.

bool	MustAssertOnFailure () const
	Check if this run should assert on failure.

bool	MustContinueOnFailure () const
	Check if this run should continue on failure.

std::string	CreateDataDirFilename (std::string filename)
	Construct the full path to a file in the data directory.

std::string	CreateTempDirFilename (std::string filename)
	Construct the full path to a file in a temporary directory.

Protected Attributes
Configuration	m_configuration
	Test configuration.

uint32_t	m_maxRcvBufferSize
	Maximum receiver buffer size.

uint32_t	m_maxSndBufferSize
	Maximum sender buffer size.

Protected Attributes inherited from ns3::TcpGeneralTest
TypeId	m_congControlTypeId
	Congestion control.

TypeId	m_recoveryTypeId
	Recovery.

Detailed Description

TCP Window Scaling enabling Test.

Definition at line 38 of file tcp-wscaling-test.cc.

Member Enumeration Documentation

◆ Configuration

enum WScalingTestCase::Configuration

Window Scaling configuration.

Enumerator
DISABLED
ENABLED_SENDER
ENABLED_RECEIVER
ENABLED

Definition at line 44 of file tcp-wscaling-test.cc.

Constructor & Destructor Documentation

◆ WScalingTestCase()

WScalingTestCase::WScalingTestCase	(	WScalingTestCase::Configuration	conf,
		uint32_t	maxRcvBufferSize,
		uint32_t	maxSndBufferSize,
		std::string	name
	)

Constructor.

Parameters

conf	Test configuration.
maxRcvBufferSize	Maximum receiver buffer size.
maxSndBufferSize	Maximum sender buffer size.
name	Test description.

Definition at line 75 of file tcp-wscaling-test.cc.

References m_configuration, m_maxRcvBufferSize, and m_maxSndBufferSize.

Member Function Documentation

◆ CreateReceiverSocket()

Ptr< TcpSocketMsgBase > WScalingTestCase::CreateReceiverSocket ( Ptr< Node > node )

overrideprotectedvirtual

Create and install the socket to install on the receiver.

Parameters

node	receiver node pointer

Returns: the socket to be installed in the receiver

Reimplemented from ns3::TcpGeneralTest.

Definition at line 87 of file tcp-wscaling-test.cc.

References ns3::TcpGeneralTest::CreateReceiverSocket(), DISABLED, ENABLED, ENABLED_RECEIVER, ENABLED_SENDER, and m_configuration.

Here is the call graph for this function:

◆ CreateSenderSocket()

Ptr< TcpSocketMsgBase > WScalingTestCase::CreateSenderSocket ( Ptr< Node > node )

overrideprotectedvirtual

Create and install the socket to install on the sender.

Parameters

node	sender node pointer

Returns: the socket to be installed in the sender

Reimplemented from ns3::TcpGeneralTest.

Definition at line 114 of file tcp-wscaling-test.cc.

References ns3::TcpGeneralTest::CreateSenderSocket(), DISABLED, ENABLED, ENABLED_RECEIVER, ENABLED_SENDER, and m_configuration.

Here is the call graph for this function:

◆ Tx()

void WScalingTestCase::Tx	(	const Ptr< const Packet >	p,
		const TcpHeader &	h,
		SocketWho	who
	)

overrideprotectedvirtual

Packet transmitted down to IP layer.

Parameters

p	packet
h	header
who	the socket which has received the packet (SENDER or RECEIVER)

Reimplemented from ns3::TcpGeneralTest.

Definition at line 141 of file tcp-wscaling-test.cc.

References DISABLED, ENABLED, ENABLED_RECEIVER, ENABLED_SENDER, ns3::TcpHeader::GetFlags(), ns3::TcpGeneralTest::GetRxBuffer(), ns3::TcpHeader::GetWindowSize(), ns3::TcpHeader::HasOption(), m_configuration, NS_LOG_INFO, NS_TEST_ASSERT_MSG_EQ, ns3::TcpGeneralTest::RECEIVER, ns3::TcpGeneralTest::SENDER, ns3::TcpHeader::SYN, and ns3::TcpOption::WINSCALE.

Here is the call graph for this function:

Member Data Documentation

◆ m_configuration

Configuration WScalingTestCase::m_configuration

protected

Test configuration.

Definition at line 70 of file tcp-wscaling-test.cc.

Referenced by WScalingTestCase(), CreateReceiverSocket(), CreateSenderSocket(), and Tx().

◆ m_maxRcvBufferSize

uint32_t WScalingTestCase::m_maxRcvBufferSize

protected

Maximum receiver buffer size.

Definition at line 71 of file tcp-wscaling-test.cc.

Referenced by WScalingTestCase().

◆ m_maxSndBufferSize

uint32_t WScalingTestCase::m_maxSndBufferSize

protected

Maximum sender buffer size.

Definition at line 72 of file tcp-wscaling-test.cc.

Referenced by WScalingTestCase().

The documentation for this class was generated from the following file:

src/internet/test/tcp-wscaling-test.cc

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Configuration

Constructor & Destructor Documentation

◆ WScalingTestCase()

Member Function Documentation

◆ CreateReceiverSocket()

◆ CreateSenderSocket()

◆ Tx()

Member Data Documentation

◆ m_configuration

◆ m_maxRcvBufferSize

◆ m_maxSndBufferSize