diff --git a/src/traffic-control/test/tc-flow-control-test-suite.cc b/src/traffic-control/test/tc-flow-control-test-suite.cc index 33054d9bf..19a59f1a9 100644 --- a/src/traffic-control/test/tc-flow-control-test-suite.cc +++ b/src/traffic-control/test/tc-flow-control-test-suite.cc @@ -19,6 +19,9 @@ * */ +#include +#include + #include "ns3/test.h" #include "ns3/uinteger.h" #include "ns3/pointer.h" @@ -104,7 +107,7 @@ public: * * \param tt the test type */ - TcFlowControlTestCase (QueueSizeUnit tt); + TcFlowControlTestCase (QueueSizeUnit tt, uint32_t deviceQueueLength, uint32_t totalTxPackets); virtual ~TcFlowControlTestCase (); private: virtual void DoRun (void); @@ -120,27 +123,29 @@ private: * \param nPackets the expected number of packets stored in the device queue * \param msg the message to print if a different number of packets are stored */ - void CheckPacketsInDeviceQueue (Ptr dev, uint16_t nPackets, const char* msg); + void CheckPacketsInDeviceQueue (Ptr dev, uint16_t nPackets, const std::string msg); /** * Check if the device queue is in the expected status (stopped or not) * \param dev the device * \param value the expected status of the queue (true means stopped) * \param msg the message to print if the status of the device queue is different */ - void CheckDeviceQueueStopped (Ptr dev, bool value, const char* msg); + void CheckDeviceQueueStopped (Ptr dev, bool value, const std::string msg); /** * Check if the queue disc stores the expected number of packets * \param dev the device the queue disc is installed on * \param nPackets the expected number of packets stored in the queue disc * \param msg the message to print if a different number of packets are stored */ - void CheckPacketsInQueueDisc (Ptr dev, uint16_t nPackets, const char* msg); + void CheckPacketsInQueueDisc (Ptr dev, uint16_t nPackets, const std::string msg); QueueSizeUnit m_type; //!< the test type + uint32_t m_deviceQueueLength; + uint32_t m_totalTxPackets; }; -TcFlowControlTestCase::TcFlowControlTestCase (QueueSizeUnit tt) +TcFlowControlTestCase::TcFlowControlTestCase (QueueSizeUnit tt, uint32_t deviceQueueLength, uint32_t totalTxPackets) : TestCase ("Test the operation of the flow control mechanism"), - m_type (tt) + m_type (tt), m_deviceQueueLength(deviceQueueLength), m_totalTxPackets(totalTxPackets) { } @@ -159,7 +164,7 @@ TcFlowControlTestCase::SendPackets (Ptr n, uint16_t nPackets) } void -TcFlowControlTestCase::CheckPacketsInDeviceQueue (Ptr dev, uint16_t nPackets, const char* msg) +TcFlowControlTestCase::CheckPacketsInDeviceQueue (Ptr dev, uint16_t nPackets, const std::string msg) { PointerValue ptr; dev->GetAttributeFailSafe ("TxQueue", ptr); @@ -168,7 +173,7 @@ TcFlowControlTestCase::CheckPacketsInDeviceQueue (Ptr dev, uint16_t n } void -TcFlowControlTestCase::CheckDeviceQueueStopped (Ptr dev, bool value, const char* msg) +TcFlowControlTestCase::CheckDeviceQueueStopped (Ptr dev, bool value, const std::string msg) { Ptr ndqi = dev->GetObject (); NS_ASSERT_MSG (ndqi, "A device queue interface has not been aggregated to the device"); @@ -176,7 +181,7 @@ TcFlowControlTestCase::CheckDeviceQueueStopped (Ptr dev, bool value, } void -TcFlowControlTestCase::CheckPacketsInQueueDisc (Ptr dev, uint16_t nPackets, const char* msg) +TcFlowControlTestCase::CheckPacketsInQueueDisc (Ptr dev, uint16_t nPackets, const std::string msg) { Ptr tc = dev->GetNode ()->GetObject (); Ptr qdisc = tc->GetRootQueueDiscOnDevice (dev); @@ -199,7 +204,9 @@ TcFlowControlTestCase::DoRun (void) simple.SetDeviceAttribute ("DataRate", DataRateValue (DataRate ("1Mb/s"))); simple.SetQueue ("ns3::DropTailQueue", "MaxSize", - StringValue (m_type == QueueSizeUnit::PACKETS ? "5p" : "5000B")); + StringValue (m_type == QueueSizeUnit::PACKETS + ? std::to_string (m_deviceQueueLength) + "p" + : std::to_string (m_deviceQueueLength) + "B")); Ptr txDev; txDev = simple.Install (n.Get (0), DynamicCast (rxDevC.Get (0)->GetChannel ())).Get (0); @@ -210,7 +217,7 @@ TcFlowControlTestCase::DoRun (void) // transmit 10 packets at time 0 Simulator::Schedule (Time (Seconds (0)), &TcFlowControlTestCase::SendPackets, - this, n.Get (0), 10); + this, n.Get (0), m_totalTxPackets); if (m_type == QueueSizeUnit::PACKETS) { @@ -218,67 +225,61 @@ TcFlowControlTestCase::DoRun (void) * When the device queue is in packet mode, all the packets enqueued in the * queue disc are correctly transmitted, even if the device queue is stopped * when the last packet is received from the upper layers + * + * We have the following invariants: + * - totalPackets = txPackets + deviceQueuePackets + qdiscPackets + * - deviceQueuePackets = MIN(totalPackets - txPackets, deviceQueueLen) + * - qdiscPackets = MAX(totalPackets - txPackets - deviceQueuePackets, 0) + * + * The transmission of each packet takes 1000B/1Mbps = 8ms + * + * We check the values of deviceQueuePackets and qdiscPackets 1ms after each + * packet is transmitted (i.e. at 1ms, 9ms, 17ms, ...), as well as verifying + * that the device queue is stopped or not, as appropriate. */ - // The transmission of each packet takes 1000B/1Mbps = 8ms - // After 1ms, we have 5 packets in the device queue (stopped) and 4 in the queue disc - Simulator::Schedule (Time (MilliSeconds (1)), &TcFlowControlTestCase::CheckPacketsInDeviceQueue, - this, txDev, 5, "There must be 5 packets in the device queue after 1ms"); - Simulator::Schedule (Time (MilliSeconds (1)), &TcFlowControlTestCase::CheckDeviceQueueStopped, - this, txDev, true, "The device queue must be stopped after 1ms"); - Simulator::Schedule (Time (MilliSeconds (1)), &TcFlowControlTestCase::CheckPacketsInQueueDisc, - this, txDev, 4, "There must be 4 packets in the queue disc after 1ms"); + uint32_t checkTimeMs = 0; + uint32_t deviceQueuePackets = 0; + uint32_t qdiscPackets = 0; - // After 9ms, we have 5 packets in the device queue (stopped) and 3 in the queue disc - Simulator::Schedule (Time (MilliSeconds (9)), &TcFlowControlTestCase::CheckPacketsInDeviceQueue, - this, txDev, 5, "There must be 5 packets in the device queue after 9ms"); - Simulator::Schedule (Time (MilliSeconds (9)), &TcFlowControlTestCase::CheckDeviceQueueStopped, - this, txDev, true, "The device queue must be stopped after 9ms"); - Simulator::Schedule (Time (MilliSeconds (9)), &TcFlowControlTestCase::CheckPacketsInQueueDisc, - this, txDev, 3, "There must be 3 packets in the queue disc after 9ms"); + uint32_t txPackets = 0; + for (txPackets = 1; txPackets <= m_totalTxPackets; txPackets++) + { + checkTimeMs = 8 * (txPackets - 1) + 1; // Check 1ms after each packet is sent + deviceQueuePackets = std::min (m_totalTxPackets - txPackets, m_deviceQueueLength); + qdiscPackets = std::max (m_totalTxPackets - txPackets - deviceQueuePackets, (uint32_t)0); + if (deviceQueuePackets == m_deviceQueueLength) + { + Simulator::Schedule ( + Time (MilliSeconds (checkTimeMs)), + &TcFlowControlTestCase::CheckDeviceQueueStopped, this, txDev, true, + "The device queue must be stopped after " + std::to_string (checkTimeMs) + "ms"); + } + else + { + Simulator::Schedule (Time (MilliSeconds (checkTimeMs)), + &TcFlowControlTestCase::CheckDeviceQueueStopped, this, txDev, + false, + "The device queue must not be stopped after " + + std::to_string (checkTimeMs) + "ms"); + } - // After 17ms, we have 5 packets in the device queue (stopped) and 2 in the queue disc - Simulator::Schedule (Time (MilliSeconds (17)), &TcFlowControlTestCase::CheckPacketsInDeviceQueue, - this, txDev, 5, "There must be 5 packets in the device queue after 17ms"); - Simulator::Schedule (Time (MilliSeconds (17)), &TcFlowControlTestCase::CheckDeviceQueueStopped, - this, txDev, true, "The device queue must be stopped after 17ms"); - Simulator::Schedule (Time (MilliSeconds (17)), &TcFlowControlTestCase::CheckPacketsInQueueDisc, - this, txDev, 2, "There must be 2 packets in the queue disc after 17ms"); + Simulator::Schedule ( + Time (MilliSeconds (checkTimeMs)), &TcFlowControlTestCase::CheckPacketsInDeviceQueue, + this, txDev, deviceQueuePackets, + "There must be " + std::to_string (m_deviceQueueLength) + " packets in the device after " + + std::to_string (checkTimeMs) + "ms"); - // After 25ms, we have 5 packets in the device queue (stopped) and 1 in the queue disc - Simulator::Schedule (Time (MilliSeconds (25)), &TcFlowControlTestCase::CheckPacketsInDeviceQueue, - this, txDev, 5, "There must be 5 packets in the device queue after 25ms"); - Simulator::Schedule (Time (MilliSeconds (25)), &TcFlowControlTestCase::CheckDeviceQueueStopped, - this, txDev, true, "The device queue must be stopped after 25ms"); - Simulator::Schedule (Time (MilliSeconds (25)), &TcFlowControlTestCase::CheckPacketsInQueueDisc, - this, txDev, 1, "There must be 1 packet in the queue disc after 25ms"); - - // After 33ms, we have 5 packets in the device queue (stopped) and the queue disc is empty - Simulator::Schedule (Time (MilliSeconds (33)), &TcFlowControlTestCase::CheckPacketsInDeviceQueue, - this, txDev, 5, "There must be 5 packets in the device queue after 33ms"); - Simulator::Schedule (Time (MilliSeconds (33)), &TcFlowControlTestCase::CheckDeviceQueueStopped, - this, txDev, true, "The device queue must be stopped after 33ms"); - Simulator::Schedule (Time (MilliSeconds (33)), &TcFlowControlTestCase::CheckPacketsInQueueDisc, - this, txDev, 0, "The queue disc must be empty after 33ms"); - - // After 41ms, we have 4 packets in the device queue (not stopped) and the queue disc is empty - Simulator::Schedule (Time (MilliSeconds (41)), &TcFlowControlTestCase::CheckPacketsInDeviceQueue, - this, txDev, 4, "There must be 4 packets in the device queue after 41ms"); - Simulator::Schedule (Time (MilliSeconds (41)), &TcFlowControlTestCase::CheckDeviceQueueStopped, - this, txDev, false, "The device queue must not be stopped after 41ms"); - Simulator::Schedule (Time (MilliSeconds (41)), &TcFlowControlTestCase::CheckPacketsInQueueDisc, - this, txDev, 0, "The queue disc must be empty after 41ms"); - - // After 81ms, all packets must have been transmitted (the device queue and the queue disc are empty) - Simulator::Schedule (Time (MilliSeconds (81)), &TcFlowControlTestCase::CheckPacketsInDeviceQueue, - this, txDev, 0, "The device queue must be empty after 81ms"); - Simulator::Schedule (Time (MilliSeconds (81)), &TcFlowControlTestCase::CheckDeviceQueueStopped, - this, txDev, false, "The device queue must not be stopped after 81ms"); - Simulator::Schedule (Time (MilliSeconds (81)), &TcFlowControlTestCase::CheckPacketsInQueueDisc, - this, txDev, 0, "The queue disc must be empty after 81ms"); + Simulator::Schedule ( + Time (MilliSeconds (checkTimeMs)), &TcFlowControlTestCase::CheckPacketsInQueueDisc, + this, txDev, qdiscPackets, + "There must be " + std::to_string (qdiscPackets) + + " packets in the queue disc after " + std::to_string (checkTimeMs) + "ms"); + } } else { + // TODO: Make this test parametric as well, and add new test cases /* * When the device queue is in byte mode, all the packets enqueued in the * queue disc are correctly transmitted, even if the device queue is stopped @@ -375,7 +376,18 @@ public: TcFlowControlTestSuite () : TestSuite ("tc-flow-control", UNIT) { - AddTestCase (new TcFlowControlTestCase (QueueSizeUnit::PACKETS), TestCase::QUICK); - AddTestCase (new TcFlowControlTestCase (QueueSizeUnit::BYTES), TestCase::QUICK); + AddTestCase (new TcFlowControlTestCase (QueueSizeUnit::PACKETS, 1, 10), TestCase::QUICK); + AddTestCase (new TcFlowControlTestCase (QueueSizeUnit::PACKETS, 5, 10), TestCase::QUICK); + AddTestCase (new TcFlowControlTestCase (QueueSizeUnit::PACKETS, 9, 10), TestCase::QUICK); + AddTestCase (new TcFlowControlTestCase (QueueSizeUnit::PACKETS, 10, 10), TestCase::QUICK); + AddTestCase (new TcFlowControlTestCase (QueueSizeUnit::PACKETS, 11, 10), TestCase::QUICK); + AddTestCase (new TcFlowControlTestCase (QueueSizeUnit::PACKETS, 15, 10), TestCase::QUICK); + AddTestCase (new TcFlowControlTestCase (QueueSizeUnit::PACKETS, 1, 1), TestCase::QUICK); + AddTestCase (new TcFlowControlTestCase (QueueSizeUnit::PACKETS, 2, 1), TestCase::QUICK); + AddTestCase (new TcFlowControlTestCase (QueueSizeUnit::PACKETS, 5, 1), TestCase::QUICK); + + // TODO: Right now, this test only works for 5000B and 10 packets (it's hard coded). Should + // also be made parametric. + AddTestCase (new TcFlowControlTestCase (QueueSizeUnit::BYTES, 5000, 10), TestCase::QUICK); } } g_tcFlowControlTestSuite; ///< the test suite