A Discrete-Event Network Simulator
API
TcpRateLinuxWithSocketsTest Class Reference

The TcpRateLinux Test uses sender-receiver model to test its functionality. More...

+ Inheritance diagram for TcpRateLinuxWithSocketsTest:
+ Collaboration diagram for TcpRateLinuxWithSocketsTest:

Public Member Functions

 TcpRateLinuxWithSocketsTest (const std::string &desc, bool sackEnabled, std::vector< uint32_t > &toDrop)
 Constructor. More...
 
- Public Member Functions inherited from ns3::TcpGeneralTest
 TcpGeneralTest (const std::string &desc)
 TcpGeneralTest constructor. More...
 
 ~TcpGeneralTest ()
 
- Public Member Functions inherited from ns3::TestCase
virtual ~TestCase ()
 Destructor. More...
 
std::string GetName (void) const
 

Protected Member Functions

virtual void BytesInFlightTrace (uint32_t oldValue, uint32_t newValue)
 Track the bytes in flight. More...
 
void ConfigureEnvironment ()
 Configure the test. More...
 
virtual Ptr< ErrorModelCreateReceiverErrorModel ()
 Create a receiver error model. More...
 
virtual Ptr< TcpSocketMsgBaseCreateSenderSocket (Ptr< Node > node)
 Create and install the socket to install on the sender. More...
 
void FinalChecks ()
 Do the final checks. More...
 
void PktDropped (const Ipv4Header &ipH, const TcpHeader &tcpH, Ptr< const Packet > p)
 Called when a packet is dropped. More...
 
virtual void RateSampleUpdatedTrace (const TcpRateLinux::TcpRateSample &sample)
 Track the rate sample value of TcpRateLinux. More...
 
virtual void RateUpdatedTrace (const TcpRateLinux::TcpRateConnection &rate)
 Track the rate value of TcpRateLinux. More...
 
virtual void Rx (const Ptr< const Packet > p, const TcpHeader &h, SocketWho who)
 Receive a packet. More...
 
- Protected Member Functions inherited from ns3::TcpGeneralTest
virtual void AfterRTOExpired (const Ptr< const TcpSocketState > tcb, SocketWho who)
 Rto has expired. More...
 
virtual void BeforeRTOExpired (const Ptr< const TcpSocketState > tcb, SocketWho who)
 Rto has expired. More...
 
virtual void ConfigureProperties (void)
 Change the configuration of the socket properties. More...
 
virtual void CongStateTrace (const TcpSocketState::TcpCongState_t oldValue, const TcpSocketState::TcpCongState_t newValue)
 State on Ack state machine changes. More...
 
virtual Ptr< SimpleChannelCreateChannel ()
 Create and return the channel installed between the two socket. 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< 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, uint32_t newValue)
 Tracks the inflated congestion window changes. More...
 
virtual void CWndTrace (uint32_t oldValue, uint32_t newValue)
 Tracks the congestion window changes. More...
 
virtual void DataSent (uint32_t size, SocketWho who)
 Notifying application for sent data. More...
 
void DoConnect ()
 Scheduled at 0.0, SENDER starts the connection to RECEIVER. More...
 
virtual void DoRun (void)
 Execute the tcp test. More...
 
virtual void DoTeardown (void)
 Teardown the TCP test. More...
 
virtual void ErrorClose (SocketWho who)
 Socket closed with an error. 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, SequenceNumber32 newValue)
 Highest tx seq changes. More...
 
virtual void NextTxSeqTrace (SequenceNumber32 oldValue, SequenceNumber32 newValue)
 Next tx seq changes. More...
 
virtual void NormalClose (SocketWho who)
 Socket closed normally. More...
 
virtual void PhyDrop (SocketWho who)
 Link drop. More...
 
virtual void ProcessedAck (const Ptr< const TcpSocketState > tcb, const TcpHeader &h, SocketWho who)
 Processed ack. More...
 
virtual void QueueDrop (SocketWho who)
 Drop on the queue. More...
 
virtual void RateSampleUpdatedTrace (const TcpRateLinux::TcpRateSample &sample)
 Track the rate sample value of TcpRateLinux. More...
 
virtual void RateUpdatedTrace (const TcpRateLinux::TcpRateConnection &rate)
 Track the rate value of TcpRateLinux. More...
 
virtual void RcvAck (const Ptr< const TcpSocketState > tcb, const TcpHeader &h, SocketWho who)
 Received ack. More...
 
virtual void ReceivePacket (Ptr< Socket > socket)
 Packet received. More...
 
virtual void RtoTrace (Time oldValue, Time newValue)
 RTO changes. More...
 
virtual void RttTrace (Time oldTime, Time newTime)
 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 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 reccovery)
 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, uint32_t newValue)
 Slow start threshold changes. More...
 
virtual void Tx (const Ptr< const Packet > p, const TcpHeader &h, SocketWho who)
 Packet transmitted down to IP layer. More...
 
virtual void UpdatedRttHistory (const SequenceNumber32 &seq, uint32_t sz, bool isRetransmission, SocketWho who)
 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 TestCsse. More...
 
bool IsStatusFailure (void) const
 Check if any tests failed. More...
 
bool IsStatusSuccess (void) 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 (void) const
 Check if this run should assert on failure. More...
 
bool MustContinueOnFailure (void) 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...
 

Private Attributes

uint32_t m_bytesInFlight {0}
 Bytes inflight. More...
 
Ptr< MimicCongControlm_congCtl
 Dummy congestion control. More...
 
bool m_isDupAck
 Whether ACK is DupAck. More...
 
SequenceNumber32 m_lastAckRecv {SequenceNumber32 (1)}
 Last ACK received. More...
 
TcpRateLinux::TcpRateConnection m_prevRate
 Previous rate. More...
 
TcpRateLinux::TcpRateSample m_prevRateSample
 Previous rate sample. More...
 
bool m_sackEnabled
 Sack Variable. More...
 
std::vector< uint32_t > m_toDrop
 List of SequenceNumber to drop. 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...
 
- Protected Attributes inherited from ns3::TcpGeneralTest
TypeId m_congControlTypeId
 Congestion control. More...
 
TypeId m_recoveryTypeId
 Recovery. More...
 

Detailed Description

The TcpRateLinux Test uses sender-receiver model to test its functionality.

This test case uses the bytes inflight trace to check whether rate sample correctly sets the value of m_deliveredTime and m_firstSentTime. This is done using rate trace. Further, Using Rx trace, m_isDupAck is maintained to track duplicate acknowledgments. This, in turn, is used to see whether rate sample is updated properly (in case of SACK) or not (in case of non SACK).

Definition at line 195 of file tcp-rate-ops-test.cc.

Constructor & Destructor Documentation

◆ TcpRateLinuxWithSocketsTest()

TcpRateLinuxWithSocketsTest::TcpRateLinuxWithSocketsTest ( const std::string &  desc,
bool  sackEnabled,
std::vector< uint32_t > &  toDrop 
)

Constructor.

Parameters
descDescription.
sackEnabledTo use SACK or not
toDropPackets to drop.

Definition at line 277 of file tcp-rate-ops-test.cc.

Member Function Documentation

◆ BytesInFlightTrace()

void TcpRateLinuxWithSocketsTest::BytesInFlightTrace ( uint32_t  oldValue,
uint32_t  newValue 
)
protectedvirtual

Track the bytes in flight.

Parameters
oldValueprevious value.
newValueactual value.

Reimplemented from ns3::TcpGeneralTest.

Definition at line 346 of file tcp-rate-ops-test.cc.

References m_bytesInFlight, and NS_UNUSED.

◆ ConfigureEnvironment()

void TcpRateLinuxWithSocketsTest::ConfigureEnvironment ( void  )
protectedvirtual

◆ CreateReceiverErrorModel()

Ptr< ErrorModel > TcpRateLinuxWithSocketsTest::CreateReceiverErrorModel ( )
protectedvirtual

Create a receiver error model.

Returns
The receiver error model.

Reimplemented from ns3::TcpGeneralTest.

Definition at line 306 of file tcp-rate-ops-test.cc.

References ns3::TcpSeqErrorModel::AddSeqToKill(), m_toDrop, ns3::MakeCallback(), PktDropped(), and ns3::TcpGeneralErrorModel::SetDropCallback().

+ Here is the call graph for this function:

◆ CreateSenderSocket()

Ptr< TcpSocketMsgBase > TcpRateLinuxWithSocketsTest::CreateSenderSocket ( Ptr< Node node)
protectedvirtual

Create and install the socket to install on the sender.

Parameters
nodesender node pointer
Returns
the socket to be installed in the sender

Reimplemented from ns3::TcpGeneralTest.

Definition at line 286 of file tcp-rate-ops-test.cc.

References m_congCtl, and ns3::TcpSocketBase::SetCongestionControlAlgorithm().

+ Here is the call graph for this function:

◆ FinalChecks()

void TcpRateLinuxWithSocketsTest::FinalChecks ( void  )
protectedvirtual

Do the final checks.

Reimplemented from ns3::TcpGeneralTest.

Definition at line 387 of file tcp-rate-ops-test.cc.

◆ PktDropped()

void TcpRateLinuxWithSocketsTest::PktDropped ( const Ipv4Header ipH,
const TcpHeader tcpH,
Ptr< const Packet p 
)
protected

Called when a packet is dropped.

Parameters
ipHThe IP header.
tcpHThe TCP header.
pThe packet.

Definition at line 320 of file tcp-rate-ops-test.cc.

References ns3::TcpHeader::GetSequenceNumber(), ns3::Packet::GetSize(), and NS_LOG_DEBUG.

Referenced by CreateReceiverErrorModel().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ RateSampleUpdatedTrace()

void TcpRateLinuxWithSocketsTest::RateSampleUpdatedTrace ( const TcpRateLinux::TcpRateSample &  sample)
protectedvirtual

Track the rate sample value of TcpRateLinux.

Parameters
sampleupdated value of TcpRateSample.

Definition at line 366 of file tcp-rate-ops-test.cc.

References m_isDupAck, m_prevRateSample, m_sackEnabled, NS_LOG_DEBUG, and NS_TEST_ASSERT_MSG_EQ.

◆ RateUpdatedTrace()

void TcpRateLinuxWithSocketsTest::RateUpdatedTrace ( const TcpRateLinux::TcpRateConnection &  rate)
protectedvirtual

Track the rate value of TcpRateLinux.

Parameters
rateupdated value of TcpRate.

Definition at line 353 of file tcp-rate-ops-test.cc.

References m_bytesInFlight, m_prevRate, ns3::Now(), NS_LOG_DEBUG, NS_TEST_ASSERT_MSG_EQ, and NS_TEST_ASSERT_MSG_GT_OR_EQ.

+ Here is the call graph for this function:

◆ Rx()

void TcpRateLinuxWithSocketsTest::Rx ( const Ptr< const Packet p,
const TcpHeader h,
SocketWho  who 
)
protectedvirtual

Receive a packet.

Parameters
pThe packet.
hThe TCP header.
whoWho the socket belongs to (sender or receiver).

Reimplemented from ns3::TcpGeneralTest.

Definition at line 327 of file tcp-rate-ops-test.cc.

References ns3::TcpHeader::GetAckNumber(), ns3::TcpHeader::GetFlags(), m_isDupAck, m_lastAckRecv, and ns3::TcpGeneralTest::SENDER.

+ Here is the call graph for this function:

Member Data Documentation

◆ m_bytesInFlight

uint32_t TcpRateLinuxWithSocketsTest::m_bytesInFlight {0}
private

Bytes inflight.

Definition at line 270 of file tcp-rate-ops-test.cc.

Referenced by BytesInFlightTrace(), and RateUpdatedTrace().

◆ m_congCtl

Ptr<MimicCongControl> TcpRateLinuxWithSocketsTest::m_congCtl
private

Dummy congestion control.

Definition at line 267 of file tcp-rate-ops-test.cc.

Referenced by CreateSenderSocket().

◆ m_isDupAck

bool TcpRateLinuxWithSocketsTest::m_isDupAck
private

Whether ACK is DupAck.

Definition at line 272 of file tcp-rate-ops-test.cc.

Referenced by RateSampleUpdatedTrace(), and Rx().

◆ m_lastAckRecv

SequenceNumber32 TcpRateLinuxWithSocketsTest::m_lastAckRecv {SequenceNumber32 (1)}
private

Last ACK received.

Definition at line 271 of file tcp-rate-ops-test.cc.

Referenced by Rx().

◆ m_prevRate

TcpRateLinux::TcpRateConnection TcpRateLinuxWithSocketsTest::m_prevRate
private

Previous rate.

Definition at line 273 of file tcp-rate-ops-test.cc.

Referenced by RateUpdatedTrace().

◆ m_prevRateSample

TcpRateLinux::TcpRateSample TcpRateLinuxWithSocketsTest::m_prevRateSample
private

Previous rate sample.

Definition at line 274 of file tcp-rate-ops-test.cc.

Referenced by RateSampleUpdatedTrace().

◆ m_sackEnabled

bool TcpRateLinuxWithSocketsTest::m_sackEnabled
private

Sack Variable.

Definition at line 268 of file tcp-rate-ops-test.cc.

Referenced by ConfigureEnvironment(), and RateSampleUpdatedTrace().

◆ m_toDrop

std::vector<uint32_t> TcpRateLinuxWithSocketsTest::m_toDrop
private

List of SequenceNumber to drop.

Definition at line 269 of file tcp-rate-ops-test.cc.

Referenced by CreateReceiverErrorModel().


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