A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
TcpAdvertisedWindowTest Class Reference

Test the new formula for calculating TCP's advertised window size. More...

+ Inheritance diagram for TcpAdvertisedWindowTest:
+ Collaboration diagram for TcpAdvertisedWindowTest:

Public Member Functions

 TcpAdvertisedWindowTest (const std::string &desc, uint32_t size, uint32_t packets, double lossRatio)
 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
 
TestCaseoperator= (const TestCase &)=delete
 

Protected Member Functions

void ConfigureEnvironment () override
 Change the configuration of the environment.
 
Ptr< ErrorModelCreateReceiverErrorModel () override
 Create and return the error model to install in the receiver node.
 
Ptr< TcpSocketMsgBaseCreateReceiverSocket (Ptr< Node > node) override
 Create and install the socket to install on the receiver.
 
- 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 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< SimpleChannelCreateChannel ()
 Create and return the channel installed between the two socket.
 
virtual Ptr< ErrorModelCreateSenderErrorModel ()
 Create and return the error model to install in the sender node.
 
virtual Ptr< TcpSocketMsgBaseCreateSenderSocket (Ptr< Node > node)
 Create and install the socket to install on the sender.
 
virtual Ptr< TcpSocketMsgBaseCreateSocket (Ptr< Node > node, TypeId socketType, TypeId congControl)
 Create a socket.
 
virtual Ptr< TcpSocketMsgBaseCreateSocket (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< TcpSocketMsgBaseGetReceiverSocket ()
 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< RttEstimatorGetRttEstimator (SocketWho who)
 Get the Rtt estimator of the socket.
 
uint32_t GetRWnd (SocketWho who)
 Get the rWnd of the selected socket.
 
Ptr< TcpRxBufferGetRxBuffer (SocketWho who)
 Get the Rx buffer from selected socket.
 
uint32_t GetSegSize (SocketWho who)
 Get the segment size of the node specified.
 
Ptr< TcpSocketMsgBaseGetSenderSocket ()
 Get the pointer to a previously created sender socket.
 
Time GetStartTime () const
 Get the data start time.
 
Ptr< TcpSocketStateGetTcb (SocketWho who)
 Get the TCB from selected socket.
 
TcpSocket::TcpStates_t GetTcpState (SocketWho who)
 Get the state of the TCP state machine.
 
Ptr< TcpTxBufferGetTxBuffer (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, Duration duration=Duration::QUICK)
 Add an individual child TestCase to this test suite.
 
TestCaseGetParent () 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.
 

Private Member Functions

void InvalidAwndCb (uint16_t oldAwnd, uint16_t newAwnd)
 Callback called for the update of the awnd.
 

Private Attributes

double m_lossRatio
 Loss ratio.
 
uint32_t m_pktCount
 Pkt count.
 
uint32_t m_pktSize
 Packet size.
 

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 class  Duration { QUICK = 1 , EXTENSIVE = 2 , TAKES_FOREVER = 3 }
 How long the test takes to execute. More...
 
- Static Public Attributes inherited from ns3::TestCase
static constexpr auto QUICK = Duration::QUICK
 Deprecated test duration simple enums.
 
static constexpr auto EXTENSIVE = Duration::EXTENSIVE
 
static constexpr auto TAKES_FOREVER = Duration::TAKES_FOREVER
 
- Protected Attributes inherited from ns3::TcpGeneralTest
TypeId m_congControlTypeId
 Congestion control.
 
TypeId m_recoveryTypeId
 Recovery.
 

Detailed Description

Test the new formula for calculating TCP's advertised window size.

In TcpSocketBase, the advertised window is now calculated as

m_tcb->m_rxBuffer->MaxRxSequence () - m_tcb->m_rxBuffer->NextRxSequence ()

instead of the previous

m_tcb->m_rxBuffer->MaxBufferSize ()

This change was introduced with regard to situations in which the receiving application does not read from the socket as fast as possible (see bug 2559 for details). This test ensures that no regression is introduced for other, "normal" cases.

TcpGeneralTest ensures via ReceivePacket () that incoming packets are quickly consumed by the application layer, simulating a fast-reading application. We can only reasonably compare the old and the new AWND computation in this case.

Definition at line 277 of file tcp-advertised-window-test.cc.

Constructor & Destructor Documentation

◆ TcpAdvertisedWindowTest()

TcpAdvertisedWindowTest::TcpAdvertisedWindowTest ( const std::string & desc,
uint32_t size,
uint32_t packets,
double lossRatio )

Constructor.

Parameters
descdescription
sizesegment size
packetsnumber of packets to send
lossRatioerror ratio

Definition at line 309 of file tcp-advertised-window-test.cc.

Member Function Documentation

◆ ConfigureEnvironment()

void TcpAdvertisedWindowTest::ConfigureEnvironment ( )
overrideprotectedvirtual

Change the configuration of the environment.

Reimplemented from ns3::TcpGeneralTest.

Definition at line 321 of file tcp-advertised-window-test.cc.

References ns3::TcpGeneralTest::ConfigureEnvironment(), m_pktCount, m_pktSize, ns3::MilliSeconds(), ns3::Seconds(), ns3::TcpGeneralTest::SetAppPktCount(), ns3::TcpGeneralTest::SetAppPktSize(), ns3::TcpGeneralTest::SetPropagationDelay(), and ns3::TcpGeneralTest::SetTransmitStart().

+ Here is the call graph for this function:

◆ CreateReceiverErrorModel()

Ptr< ErrorModel > TcpAdvertisedWindowTest::CreateReceiverErrorModel ( )
overrideprotectedvirtual

Create and return the error model to install in the receiver node.

Returns
receiver error model

Reimplemented from ns3::TcpGeneralTest.

Definition at line 345 of file tcp-advertised-window-test.cc.

References ns3::CreateObject(), and m_lossRatio.

+ Here is the call graph for this function:

◆ CreateReceiverSocket()

Ptr< TcpSocketMsgBase > TcpAdvertisedWindowTest::CreateReceiverSocket ( Ptr< Node > node)
overrideprotectedvirtual

Create and install the socket to install on the receiver.

Parameters
nodereceiver node pointer
Returns
the socket to be installed in the receiver

Reimplemented from ns3::TcpGeneralTest.

Definition at line 331 of file tcp-advertised-window-test.cc.

References ns3::TcpGeneralTest::CreateSocket(), ns3::DynamicCast(), TcpSocketAdvertisedWindowProxy::GetTypeId(), InvalidAwndCb(), ns3::TcpGeneralTest::m_congControlTypeId, ns3::MakeCallback(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ InvalidAwndCb()

void TcpAdvertisedWindowTest::InvalidAwndCb ( uint16_t oldAwnd,
uint16_t newAwnd )
private

Callback called for the update of the awnd.

Parameters
oldAwndOld advertised window
newAwndnew value

Definition at line 351 of file tcp-advertised-window-test.cc.

References NS_TEST_ASSERT_MSG_EQ.

Referenced by CreateReceiverSocket().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_lossRatio

double TcpAdvertisedWindowTest::m_lossRatio
private

Loss ratio.

Definition at line 306 of file tcp-advertised-window-test.cc.

Referenced by CreateReceiverErrorModel().

◆ m_pktCount

uint32_t TcpAdvertisedWindowTest::m_pktCount
private

Pkt count.

Definition at line 305 of file tcp-advertised-window-test.cc.

Referenced by ConfigureEnvironment().

◆ m_pktSize

uint32_t TcpAdvertisedWindowTest::m_pktSize
private

Packet size.

Definition at line 304 of file tcp-advertised-window-test.cc.

Referenced by ConfigureEnvironment().


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