A Discrete-Event Network Simulator
API
TcpSlowStartNormalTest Class Reference

Test the normal behavior for slow start. More...

+ Inheritance diagram for TcpSlowStartNormalTest:
+ Collaboration diagram for TcpSlowStartNormalTest:

Public Member Functions

 TcpSlowStartNormalTest (uint32_t segmentSize, uint32_t packetSize, uint32_t initSsTh, uint32_t packets, const TypeId &congControl, const std::string &desc)
 Constructor. More...
 
- Public Member Functions inherited from ns3::TcpGeneralTest
 TcpGeneralTest (const std::string &desc)
 TcpGeneralTest constructor. More...
 
 ~TcpGeneralTest () override
 
- Public Member Functions inherited from ns3::TestCase
 TestCase (const TestCase &)=delete
 
virtual ~TestCase ()
 Destructor. More...
 
std::string GetName () const
 
TestCaseoperator= (const TestCase &)=delete
 

Protected Member Functions

void ConfigureEnvironment () override
 Change the configuration of the environment. More...
 
void ConfigureProperties () override
 Change the configuration of the socket properties. More...
 
void CWndTrace (uint32_t oldValue, uint32_t newValue) override
 Trace the cWnd over the slow start. More...
 
void PhyDrop (SocketWho who) override
 
void QueueDrop (SocketWho who) override
 
void Rx (const Ptr< const Packet > p, const TcpHeader &h, SocketWho who) override
 Packet received from IP layer. More...
 
void Tx (const Ptr< const Packet > p, const TcpHeader &h, SocketWho who) override
 Packet transmitted down to IP layer. More...
 
- Protected Member Functions inherited from ns3::TcpGeneralTest
virtual void AfterRTOExpired (const Ptr< const TcpSocketState > tcb[[maybe_unused]], SocketWho who[[maybe_unused]])
 Rto has expired. More...
 
virtual void BeforeRTOExpired (const Ptr< const TcpSocketState > tcb[[maybe_unused]], SocketWho who[[maybe_unused]])
 Rto has expired. More...
 
virtual void BytesInFlightTrace (uint32_t oldValue[[maybe_unused]], uint32_t newValue[[maybe_unused]])
 Bytes in flight changes. More...
 
virtual void CongStateTrace (const TcpSocketState::TcpCongState_t oldValue[[maybe_unused]], const TcpSocketState::TcpCongState_t newValue[[maybe_unused]])
 State on Ack state machine changes. More...
 
virtual Ptr< SimpleChannelCreateChannel ()
 Create and return the channel installed between the two socket. More...
 
virtual Ptr< ErrorModelCreateReceiverErrorModel ()
 Create and return the error model to install in the receiver node. More...
 
virtual Ptr< TcpSocketMsgBaseCreateReceiverSocket (Ptr< Node > node)
 Create and install the socket to install on the receiver. More...
 
virtual Ptr< ErrorModelCreateSenderErrorModel ()
 Create and return the error model to install in the sender node. More...
 
virtual Ptr< TcpSocketMsgBaseCreateSenderSocket (Ptr< Node > node)
 Create and install the socket to install on the sender. More...
 
virtual Ptr< TcpSocketMsgBaseCreateSocket (Ptr< Node > node, TypeId socketType, TypeId congControl)
 Create a socket. More...
 
virtual Ptr< TcpSocketMsgBaseCreateSocket (Ptr< Node > node, TypeId socketType, TypeId congControl, TypeId recoveryAlgorithm)
 Create a socket. More...
 
virtual void CWndInflTrace (uint32_t oldValue[[maybe_unused]], uint32_t newValue[[maybe_unused]])
 Tracks the inflated congestion window changes. More...
 
virtual void CWndTrace (uint32_t oldValue[[maybe_unused]], uint32_t newValue[[maybe_unused]])
 Tracks the congestion window changes. More...
 
virtual void DataSent (uint32_t size[[maybe_unused]], SocketWho who[[maybe_unused]])
 Notifying application for sent data. More...
 
void DoConnect ()
 Scheduled at 0.0, SENDER starts the connection to RECEIVER. More...
 
void DoRun () override
 Execute the tcp test. More...
 
void DoTeardown () override
 Teardown the TCP test. More...
 
virtual void ErrorClose (SocketWho who[[maybe_unused]])
 Socket closed with an error. More...
 
virtual void FinalChecks ()
 Performs the (eventual) final checks through test asserts. More...
 
Time GetClockGranularity (SocketWho who)
 Get the clock granularity attribute. More...
 
Time GetConnTimeout (SocketWho who)
 Get the retransmission time for the SYN segments. More...
 
uint32_t GetDelAckCount (SocketWho who)
 Get the number of delayed ack (if present) More...
 
Time GetDelAckTimeout (SocketWho who)
 Get the timeout of delayed ack (if present) More...
 
uint32_t GetDupAckCount (SocketWho who)
 Get the number of dupack received. More...
 
SequenceNumber32 GetHighestTxMark (SocketWho who)
 Get the highest tx mark of the node specified. More...
 
uint32_t GetInitialCwnd (SocketWho who)
 Get the initial congestion window. More...
 
uint32_t GetInitialSsThresh (SocketWho who)
 Get the initial slow start threshold. More...
 
Time GetMinRto (SocketWho who)
 Get the minimum RTO attribute. More...
 
uint32_t GetMtu () const
 Get the MTU of the environment. More...
 
EventId GetPersistentEvent (SocketWho who)
 Get the persistent event of the selected socket. More...
 
Time GetPersistentTimeout (SocketWho who)
 Get the persistent timeout of the selected socket. More...
 
uint32_t GetPktCount () const
 Get the number of application packets. More...
 
Time GetPktInterval () const
 Get the interval to wait for each packet sent down from application to TCP. More...
 
uint32_t GetPktSize () const
 Get the application packet size. More...
 
Time GetPropagationDelay () const
 Get the channel Propagation Delay. More...
 
Ptr< TcpSocketMsgBaseGetReceiverSocket ()
 Get the pointer to a previously created receiver socket. More...
 
uint32_t GetReTxThreshold (SocketWho who)
 Get the retransmission threshold. More...
 
Time GetRto (SocketWho who)
 Get the retransmission time. More...
 
Ptr< RttEstimatorGetRttEstimator (SocketWho who)
 Get the Rtt estimator of the socket. More...
 
uint32_t GetRWnd (SocketWho who)
 Get the rWnd of the selected socket. More...
 
Ptr< TcpRxBufferGetRxBuffer (SocketWho who)
 Get the Rx buffer from selected socket. More...
 
uint32_t GetSegSize (SocketWho who)
 Get the segment size of the node specified. More...
 
Ptr< TcpSocketMsgBaseGetSenderSocket ()
 Get the pointer to a previously created sender socket. More...
 
Time GetStartTime () const
 Get the data start time. More...
 
Ptr< TcpSocketStateGetTcb (SocketWho who)
 Get the TCB from selected socket. More...
 
TcpSocket::TcpStates_t GetTcpState (SocketWho who)
 Get the state of the TCP state machine. More...
 
Ptr< TcpTxBufferGetTxBuffer (SocketWho who)
 Get the Tx buffer from selected socket. More...
 
virtual void HighestTxSeqTrace (SequenceNumber32 oldValue[[maybe_unused]], SequenceNumber32 newValue[[maybe_unused]])
 Highest tx seq changes. More...
 
virtual void NextTxSeqTrace (SequenceNumber32 oldValue[[maybe_unused]], SequenceNumber32 newValue[[maybe_unused]])
 Next tx seq changes. More...
 
virtual void NormalClose (SocketWho who[[maybe_unused]])
 Socket closed normally. More...
 
virtual void PhyDrop (SocketWho who[[maybe_unused]])
 Link drop. More...
 
virtual void ProcessedAck (const Ptr< const TcpSocketState > tcb[[maybe_unused]], const TcpHeader &h[[maybe_unused]], SocketWho who[[maybe_unused]])
 Processed ack. More...
 
virtual void QueueDrop (SocketWho who[[maybe_unused]])
 Drop on the queue. More...
 
virtual void RateSampleUpdatedTrace (const TcpRateLinux::TcpRateSample &sample[[maybe_unused]])
 Track the rate sample value of TcpRateLinux. More...
 
virtual void RateUpdatedTrace (const TcpRateLinux::TcpRateConnection &rate[[maybe_unused]])
 Track the rate value of TcpRateLinux. More...
 
virtual void RcvAck (const Ptr< const TcpSocketState > tcb[[maybe_unused]], const TcpHeader &h[[maybe_unused]], SocketWho who[[maybe_unused]])
 Received ack. More...
 
virtual void ReceivePacket (Ptr< Socket > socket)
 Packet received. More...
 
virtual void RtoTrace (Time oldValue[[maybe_unused]], Time newValue[[maybe_unused]])
 RTO changes. More...
 
virtual void RttTrace (Time oldTime[[maybe_unused]], Time newTime[[maybe_unused]])
 Rtt changes. More...
 
void SendPacket (Ptr< Socket > socket, uint32_t pktSize, uint32_t pktCount, Time pktInterval)
 Send packets to other endpoint. More...
 
void SetAppPktCount (uint32_t pktCount)
 Set app packet count. More...
 
void SetAppPktInterval (Time pktInterval)
 Interval between app-generated packet. More...
 
void SetAppPktSize (uint32_t pktSize)
 Set app packet size. More...
 
void SetCongestionControl (TypeId congControl)
 Congestion control of the sender socket. More...
 
void SetDelAckMaxCount (SocketWho who, uint32_t count)
 Forcefully set the delayed acknowledgement count. More...
 
void SetInitialCwnd (SocketWho who, uint32_t initialCwnd)
 Forcefully set the initial cwnd. More...
 
void SetInitialSsThresh (SocketWho who, uint32_t initialSsThresh)
 Forcefully set the initial ssthresh. More...
 
void SetMTU (uint32_t mtu)
 MTU of the bottleneck link. More...
 
void SetPaceInitialWindow (SocketWho who, bool paceWindow)
 Enable or disable pacing of the initial window. More...
 
void SetPacingStatus (SocketWho who, bool pacing)
 Enable or disable pacing in the TCP socket. More...
 
void SetPropagationDelay (Time propDelay)
 Propagation delay of the bottleneck link. More...
 
void SetRcvBufSize (SocketWho who, uint32_t size)
 Forcefully set a defined size for rx buffer. More...
 
void SetRecoveryAlgorithm (TypeId recovery)
 recovery algorithm of the sender socket More...
 
void SetSegmentSize (SocketWho who, uint32_t segmentSize)
 Forcefully set the segment size. More...
 
void SetTransmitStart (Time startTime)
 Set the initial time at which the application sends the first data packet. More...
 
void SetUseEcn (SocketWho who, TcpSocketState::UseEcn_t useEcn)
 Forcefully set the ECN mode of use. More...
 
virtual void SsThreshTrace (uint32_t oldValue[[maybe_unused]], uint32_t newValue[[maybe_unused]])
 Slow start threshold changes. More...
 
virtual void UpdatedRttHistory (const SequenceNumber32 &seq[[maybe_unused]], uint32_t sz[[maybe_unused]], bool isRetransmission[[maybe_unused]], SocketWho who[[maybe_unused]])
 Updated the Rtt history. More...
 
- Protected Member Functions inherited from ns3::TestCase
 TestCase (std::string name)
 Constructor. More...
 
void AddTestCase (TestCase *testCase, TestDuration duration=QUICK)
 Add an individual child TestCase to this test suite. More...
 
TestCaseGetParent () const
 Get the parent of this TestCase. More...
 
bool IsStatusFailure () const
 Check if any tests failed. More...
 
bool IsStatusSuccess () const
 Check if all tests passed. More...
 
void SetDataDir (std::string directory)
 Set the data directory where reference trace files can be found. More...
 
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. More...
 
bool MustAssertOnFailure () const
 Check if this run should assert on failure. More...
 
bool MustContinueOnFailure () const
 Check if this run should continue on failure. More...
 
std::string CreateDataDirFilename (std::string filename)
 Construct the full path to a file in the data directory. More...
 
std::string CreateTempDirFilename (std::string filename)
 Construct the full path to a file in a temporary directory. More...
 

Protected Attributes

uint32_t m_ackedBytes
 ACKed bytes. More...
 
uint32_t m_allowedIncrease
 Allowed increase. More...
 
bool m_initial
 First cycle flag. More...
 
uint32_t m_sentBytes
 Sent bytes. More...
 
uint32_t m_totalAckedBytes
 Total ACKed bytes. More...
 
- Protected Attributes inherited from ns3::TcpGeneralTest
TypeId m_congControlTypeId
 Congestion control. More...
 
TypeId m_recoveryTypeId
 Recovery. More...
 

Private Attributes

uint32_t m_packets
 Packet counter. More...
 
uint32_t m_packetSize
 Packet size. More...
 
uint32_t m_segmentSize
 Segment size. More...
 

Additional Inherited Members

- 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...
 

Detailed Description

Test the normal behavior for slow start.

As method for checking the slow start, a callback is attached to the congestion window. With the knowledge of the number of segments, we can calculate if the value of the cWnd is right. Also, with a fixed delay for each packet, we can know if the timing is correct.

Check what is done inside CWndTrace.

See also
CWndTrace

Definition at line 45 of file tcp-slow-start-test.cc.

Constructor & Destructor Documentation

◆ TcpSlowStartNormalTest()

TcpSlowStartNormalTest::TcpSlowStartNormalTest ( uint32_t  segmentSize,
uint32_t  packetSize,
uint32_t  initSsTh,
uint32_t  packets,
const TypeId congControl,
const std::string &  desc 
)

Constructor.

Parameters
segmentSizeSegment size.
packetSizePacket size.
initSsThInitial SlowStart threshold.
packetsPacket counter.
congControlCongestion control.
descTest description.

Definition at line 87 of file tcp-slow-start-test.cc.

References ns3::TcpGeneralTest::m_congControlTypeId.

Member Function Documentation

◆ ConfigureEnvironment()

void TcpSlowStartNormalTest::ConfigureEnvironment ( )
overrideprotectedvirtual

Change the configuration of the environment.

Reimplemented from ns3::TcpGeneralTest.

Definition at line 107 of file tcp-slow-start-test.cc.

References m_packets, m_packetSize, ns3::TcpGeneralTest::SetAppPktCount(), and ns3::TcpGeneralTest::SetAppPktSize().

+ Here is the call graph for this function:

◆ ConfigureProperties()

void TcpSlowStartNormalTest::ConfigureProperties ( )
overrideprotectedvirtual

Change the configuration of the socket properties.

Reimplemented from ns3::TcpGeneralTest.

Definition at line 115 of file tcp-slow-start-test.cc.

References m_segmentSize, ns3::TcpGeneralTest::RECEIVER, ns3::TcpGeneralTest::SENDER, ns3::TcpGeneralTest::SetInitialSsThresh(), and ns3::TcpGeneralTest::SetSegmentSize().

+ Here is the call graph for this function:

◆ CWndTrace()

void TcpSlowStartNormalTest::CWndTrace ( uint32_t  oldValue,
uint32_t  newValue 
)
overrideprotected

Trace the cWnd over the slow start.

This method is called each time the cWnd changes. It should be updated only by MSS bytes at time. Since the size doubles each RTT, a timing test is also performed: the doubling should be made in 0.5s from the first (0.5s is the delay of the SimpleChannel which connect the two socket).

Parameters
oldValueold value of cWnd
newValuenew value of cWnd

Definition at line 147 of file tcp-slow-start-test.cc.

References ns3::TcpGeneralTest::GetInitialSsThresh(), ns3::TcpGeneralTest::GetSegSize(), m_allowedIncrease, m_initial, NS_LOG_INFO, NS_TEST_ASSERT_MSG_EQ, NS_TEST_ASSERT_MSG_GT_OR_EQ, NS_TEST_ASSERT_MSG_LT_OR_EQ, and ns3::TcpGeneralTest::SENDER.

+ Here is the call graph for this function:

◆ PhyDrop()

void TcpSlowStartNormalTest::PhyDrop ( SocketWho  who)
overrideprotected

Definition at line 130 of file tcp-slow-start-test.cc.

References NS_FATAL_ERROR.

◆ QueueDrop()

void TcpSlowStartNormalTest::QueueDrop ( SocketWho  who)
overrideprotected

Definition at line 124 of file tcp-slow-start-test.cc.

References NS_FATAL_ERROR.

◆ Rx()

void TcpSlowStartNormalTest::Rx ( const Ptr< const Packet p,
const TcpHeader h,
SocketWho  who 
)
overrideprotectedvirtual

Packet received from IP layer.

Parameters
ppacket
hheader
whothe socket which has received the packet (SENDER or RECEIVER)

Reimplemented from ns3::TcpGeneralTest.

Definition at line 182 of file tcp-slow-start-test.cc.

References ns3::TcpHeader::GetAckNumber(), ns3::TcpGeneralTest::GetSegSize(), ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::GetValue(), m_ackedBytes, m_allowedIncrease, m_totalAckedBytes, ns3::Now(), NS_LOG_FUNCTION, NS_LOG_INFO, and ns3::TcpGeneralTest::SENDER.

+ Here is the call graph for this function:

◆ Tx()

void TcpSlowStartNormalTest::Tx ( const Ptr< const Packet p,
const TcpHeader h,
SocketWho  who 
)
overrideprotectedvirtual

Packet transmitted down to IP layer.

Parameters
ppacket
hheader
whothe socket which has received the packet (SENDER or RECEIVER)

Reimplemented from ns3::TcpGeneralTest.

Definition at line 171 of file tcp-slow-start-test.cc.

References ns3::TcpGeneralTest::GetSegSize(), m_sentBytes, ns3::Now(), NS_LOG_FUNCTION, and ns3::TcpGeneralTest::SENDER.

+ Here is the call graph for this function:

Member Data Documentation

◆ m_ackedBytes

uint32_t TcpSlowStartNormalTest::m_ackedBytes
protected

ACKed bytes.

Definition at line 74 of file tcp-slow-start-test.cc.

Referenced by Rx().

◆ m_allowedIncrease

uint32_t TcpSlowStartNormalTest::m_allowedIncrease
protected

Allowed increase.

Definition at line 77 of file tcp-slow-start-test.cc.

Referenced by CWndTrace(), and Rx().

◆ m_initial

bool TcpSlowStartNormalTest::m_initial
protected

First cycle flag.

Definition at line 79 of file tcp-slow-start-test.cc.

Referenced by CWndTrace().

◆ m_packets

uint32_t TcpSlowStartNormalTest::m_packets
private

Packet counter.

Definition at line 84 of file tcp-slow-start-test.cc.

Referenced by ConfigureEnvironment().

◆ m_packetSize

uint32_t TcpSlowStartNormalTest::m_packetSize
private

Packet size.

Definition at line 83 of file tcp-slow-start-test.cc.

Referenced by ConfigureEnvironment().

◆ m_segmentSize

uint32_t TcpSlowStartNormalTest::m_segmentSize
private

Segment size.

Definition at line 82 of file tcp-slow-start-test.cc.

Referenced by ConfigureProperties().

◆ m_sentBytes

uint32_t TcpSlowStartNormalTest::m_sentBytes
protected

Sent bytes.

Definition at line 75 of file tcp-slow-start-test.cc.

Referenced by Tx().

◆ m_totalAckedBytes

uint32_t TcpSlowStartNormalTest::m_totalAckedBytes
protected

Total ACKed bytes.

Definition at line 76 of file tcp-slow-start-test.cc.

Referenced by Rx().


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