tcp-rate-ops-test.cc

Go to the documentation of this file.

/*
 * Copyright (c) 2018 NITK Surathkal
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Authors: Vivek Jain <jain.vivek.anand@gmail.com>
 *          Viyom Mittal <viyommittal@gmail.com>
 *          Mohit P. Tahiliani <tahiliani@nitk.edu.in>
 */
 
#include "tcp-error-model.h"
#include "tcp-general-test.h"
 
#include "ns3/config.h"
#include "ns3/log.h"
#include "ns3/tcp-rate-ops.h"
#include "ns3/tcp-tx-buffer.h"
#include "ns3/tcp-tx-item.h"
#include "ns3/test.h"
 
using namespace ns3;
 
NS_LOG_COMPONENT_DEFINE("TcpRateOpsTestSuite");
 
class MimicCongControl;
 
/**
 * @ingroup internet-test
 * @ingroup tests
 *
 * @brief The TcpRateLinux Basic Test
 */
class TcpRateLinuxBasicTest : public TestCase
{
  public:
    /**
     * Constructor
     * @param cWnd Congestion window size
     * @param tailSeq Tail sequence number
     * @param nextTx Tx next sequence number
     * @param testCase test case type
     * @param testName test name
     */
    TcpRateLinuxBasicTest(uint32_t cWnd,
                          SequenceNumber32 tailSeq,
                          SequenceNumber32 nextTx,
                          uint32_t testCase,
                          std::string testName);
 
  private:
    void DoRun() override;
 
    /**
     * Send an application packet
     * @param skb the data to send
     */
    void SendSkb(TcpTxItem* skb);
    /**
     * Deliver an application packet
     * @param skb the data to deliver
     */
    void SkbDelivered(TcpTxItem* skb);
 
    TcpRateLinux m_rateOps;         //!< Rate information for TCP
    uint32_t m_cWnd;                //!< Congestion window size
    uint32_t m_inFlight;            //!< Number of packets in-flight
    uint32_t m_segmentSize;         //!< Segment size
    uint32_t m_delivered;           //!< Number of segments delivered
    Time m_deliveredTime;           //!< Last time of a delivery
    SequenceNumber32 m_tailSeq;     //!< Tail sequence number
    SequenceNumber32 m_nextTx;      //!< Tx next sequence number
    uint32_t m_testCase;            //!< Test case type
    std::vector<TcpTxItem*> m_skbs; //!< Application packets
};
 
TcpRateLinuxBasicTest::TcpRateLinuxBasicTest(uint32_t cWnd,
                                             SequenceNumber32 tailSeq,
                                             SequenceNumber32 nextTx,
                                             uint32_t testCase,
                                             std::string testName)
    : TestCase(testName),
      m_cWnd(cWnd),
      m_inFlight(0),
      m_segmentSize(1),
      m_delivered(0),
      m_deliveredTime(),
      m_tailSeq(tailSeq),
      m_nextTx(nextTx),
      m_testCase(testCase)
{
}
 
void
TcpRateLinuxBasicTest::DoRun()
{
    for (uint8_t i = 0; i < 100; ++i)
    {
        m_skbs.push_back(new TcpTxItem());
        Simulator::Schedule(Seconds(i * 0.01), &TcpRateLinuxBasicTest::SendSkb, this, m_skbs[i]);
    }
 
    for (uint8_t i = 0; i < 100; ++i)
    {
        Simulator::Schedule(Seconds((i + 1) * 0.1),
                            &TcpRateLinuxBasicTest::SkbDelivered,
                            this,
                            m_skbs[i]);
    }
 
    Simulator::Run();
    Simulator::Destroy();
 
    for (uint8_t i = 0; i < 100; ++i)
    {
        delete m_skbs[i];
    }
}
 
void
TcpRateLinuxBasicTest::SendSkb(TcpTxItem* skb)
{
    bool isStartOfTransmission = m_inFlight == 0;
    m_rateOps.CalculateAppLimited(m_cWnd, m_inFlight, m_segmentSize, m_tailSeq, m_nextTx, 0, 0);
    m_rateOps.SkbSent(skb, isStartOfTransmission);
    m_inFlight += skb->GetSeqSize();
 
    NS_TEST_ASSERT_MSG_EQ(skb->GetRateInformation().m_delivered,
                          m_delivered,
                          "SKB should have delivered equal to current value of total delivered");
 
    if (isStartOfTransmission)
    {
        NS_TEST_ASSERT_MSG_EQ(skb->GetRateInformation().m_deliveredTime,
                              Simulator::Now(),
                              "SKB should have updated the delivered time to current value");
    }
    else
    {
        NS_TEST_ASSERT_MSG_EQ(skb->GetRateInformation().m_deliveredTime,
                              m_deliveredTime,
                              "SKB should have updated the delivered time to current value");
    }
}
 
void
TcpRateLinuxBasicTest::SkbDelivered(TcpTxItem* skb)
{
    m_rateOps.SkbDelivered(skb);
    m_inFlight -= skb->GetSeqSize();
    m_delivered += skb->GetSeqSize();
    m_deliveredTime = Simulator::Now();
 
    NS_TEST_ASSERT_MSG_EQ(skb->GetRateInformation().m_deliveredTime,
                          Time::Max(),
                          "SKB should have delivered time as Time::Max ()");
 
    if (m_testCase == 1)
    {
        NS_TEST_ASSERT_MSG_EQ(skb->GetRateInformation().m_isAppLimited,
                              false,
                              "Socket should not be applimited");
    }
    else if (m_testCase == 2)
    {
        NS_TEST_ASSERT_MSG_EQ(skb->GetRateInformation().m_isAppLimited,
                              true,
                              "Socket should be applimited");
    }
}
 
/**
 * @ingroup internet-test
 *
 * @brief Behaves as NewReno except HasCongControl returns true
 */
class MimicCongControl : public TcpNewReno
{
  public:
    /**
     * @brief Get the type ID.
     * @return the object TypeId
     */
    static TypeId GetTypeId();
 
    MimicCongControl()
    {
    }
 
    bool HasCongControl() const override
    {
        return true;
    }
};
 
TypeId
MimicCongControl::GetTypeId()
{
    static TypeId tid = TypeId("ns3::MimicCongControl")
                            .SetParent<TcpNewReno>()
                            .AddConstructor<MimicCongControl>()
                            .SetGroupName("Internet");
    return tid;
}
 
/**
 * @ingroup internet-test
 * @ingroup tests
 *
 * @brief 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).
 */
class TcpRateLinuxWithSocketsTest : public TcpGeneralTest
{
  public:
    /**
     * @brief Constructor.
     * @param desc Description.
     * @param sackEnabled To use SACK or not
     * @param toDrop Packets to drop.
     */
    TcpRateLinuxWithSocketsTest(const std::string& desc,
                                bool sackEnabled,
                                std::vector<uint32_t>& toDrop);
 
  protected:
    /**
     * @brief Create and install the socket to install on the sender
     * @param node sender node pointer
     * @return the socket to be installed in the sender
     */
    Ptr<TcpSocketMsgBase> CreateSenderSocket(Ptr<Node> node) override;
 
    /**
     * @brief Create a receiver error model.
     * @returns The receiver error model.
     */
    Ptr<ErrorModel> CreateReceiverErrorModel() override;
 
    /**
     * @brief Receive a packet.
     * @param p The packet.
     * @param h The TCP header.
     * @param who Who the socket belongs to (sender or receiver).
     */
    void Rx(const Ptr<const Packet> p, const TcpHeader& h, SocketWho who) override;
 
    /**
     * @brief Track the bytes in flight.
     * @param oldValue previous value.
     * @param newValue actual value.
     */
    void BytesInFlightTrace(uint32_t oldValue, uint32_t newValue) override;
 
    /**
     * @brief Called when a packet is dropped.
     * @param ipH The IP header.
     * @param tcpH The TCP header.
     * @param p The packet.
     */
    void PktDropped(const Ipv4Header& ipH, const TcpHeader& tcpH, Ptr<const Packet> p);
 
    /**
     * @brief Configure the test.
     */
    void ConfigureEnvironment() override;
 
    /**
     * @brief Do the final checks.
     */
    void FinalChecks() override;
 
    /**
     * @brief Track the rate value of TcpRateLinux.
     * @param rate updated value of TcpRate.
     */
    void RateUpdatedTrace(const TcpRateLinux::TcpRateConnection& rate) override;
 
    /**
     * @brief Track the rate sample value of TcpRateLinux.
     * @param sample updated value of TcpRateSample.
     */
    void RateSampleUpdatedTrace(const TcpRateLinux::TcpRateSample& sample) override;
 
  private:
    Ptr<MimicCongControl> m_congCtl;                     //!< Dummy congestion control.
    bool m_sackEnabled;                                  //!< Sack Variable
    std::vector<uint32_t> m_toDrop;                      //!< List of SequenceNumber to drop
    uint32_t m_bytesInFlight{0};                         //!< Bytes inflight
    SequenceNumber32 m_lastAckRecv{SequenceNumber32(1)}; //!< Last ACK received.
    bool m_isDupAck;                                     //!< Whether ACK is DupAck
    TcpRateLinux::TcpRateConnection m_prevRate;          //!< Previous rate
    TcpRateLinux::TcpRateSample m_prevRateSample;        //!< Previous rate sample
};
 
TcpRateLinuxWithSocketsTest::TcpRateLinuxWithSocketsTest(const std::string& desc,
                                                         bool sackEnabled,
                                                         std::vector<uint32_t>& toDrop)
    : TcpGeneralTest(desc),
      m_sackEnabled(sackEnabled),
      m_toDrop(toDrop)
{
}
 
Ptr<TcpSocketMsgBase>
TcpRateLinuxWithSocketsTest::CreateSenderSocket(Ptr<Node> node)
{
    Ptr<TcpSocketMsgBase> s = TcpGeneralTest::CreateSenderSocket(node);
    m_congCtl = CreateObject<MimicCongControl>();
    s->SetCongestionControlAlgorithm(m_congCtl);
    return s;
}
 
void
TcpRateLinuxWithSocketsTest::ConfigureEnvironment()
{
    TcpGeneralTest::ConfigureEnvironment();
    SetAppPktCount(300);
    SetPropagationDelay(MilliSeconds(50));
    SetTransmitStart(Seconds(2));
 
    Config::SetDefault("ns3::TcpSocketBase::Sack", BooleanValue(m_sackEnabled));
}
 
Ptr<ErrorModel>
TcpRateLinuxWithSocketsTest::CreateReceiverErrorModel()
{
    Ptr<TcpSeqErrorModel> m_errorModel = CreateObject<TcpSeqErrorModel>();
    for (auto it = m_toDrop.begin(); it != m_toDrop.end(); ++it)
    {
        m_errorModel->AddSeqToKill(SequenceNumber32(*it));
    }
 
    m_errorModel->SetDropCallback(MakeCallback(&TcpRateLinuxWithSocketsTest::PktDropped, this));
 
    return m_errorModel;
}
 
void
TcpRateLinuxWithSocketsTest::PktDropped(const Ipv4Header& ipH,
                                        const TcpHeader& tcpH,
                                        Ptr<const Packet> p)
{
    NS_LOG_DEBUG("Drop seq= " << tcpH.GetSequenceNumber() << " size " << p->GetSize());
}
 
void
TcpRateLinuxWithSocketsTest::Rx(const Ptr<const Packet> p, const TcpHeader& h, SocketWho who)
{
    if (who == SENDER)
    {
        if (h.GetAckNumber() == m_lastAckRecv && m_lastAckRecv != SequenceNumber32(1) &&
            (h.GetFlags() & TcpHeader::FIN) == 0)
        {
            m_isDupAck = true;
        }
        else
        {
            m_isDupAck = false;
            m_lastAckRecv = h.GetAckNumber();
        }
    }
}
 
void
TcpRateLinuxWithSocketsTest::BytesInFlightTrace(uint32_t /* oldValue */, uint32_t newValue)
{
    m_bytesInFlight = newValue;
}
 
void
TcpRateLinuxWithSocketsTest::RateUpdatedTrace(const TcpRateLinux::TcpRateConnection& rate)
{
    NS_LOG_DEBUG("Rate updated " << rate);
    if (m_bytesInFlight == 0)
    {
        NS_TEST_ASSERT_MSG_EQ(rate.m_firstSentTime,
                              Simulator::Now(),
                              "FirstSentTime should be current time when bytes inflight is zero");
        NS_TEST_ASSERT_MSG_EQ(rate.m_deliveredTime,
                              Simulator::Now(),
                              "Delivered time should be current time when bytes inflight is zero");
    }
    NS_TEST_ASSERT_MSG_GT_OR_EQ(rate.m_delivered,
                                m_prevRate.m_delivered,
                                "Total delivered should not be lesser than previous values");
    m_prevRate = rate;
}
 
void
TcpRateLinuxWithSocketsTest::RateSampleUpdatedTrace(const TcpRateLinux::TcpRateSample& sample)
{
    NS_LOG_DEBUG("Rate sample updated " << sample);
    if (m_isDupAck)
    {
        if (!m_sackEnabled)
        {
            NS_TEST_ASSERT_MSG_EQ(m_prevRateSample,
                                  sample,
                                  "RateSample should not update due to DupAcks");
        }
        else
        {
            if (sample.m_ackedSacked == 0)
            {
                NS_TEST_ASSERT_MSG_EQ(m_prevRateSample,
                                      sample,
                                      "RateSample should not update as nothing is acked or sacked");
            }
        }
    }
    m_prevRateSample = sample;
}
 
void
TcpRateLinuxWithSocketsTest::FinalChecks()
{
}
 
/**
 * @ingroup internet-test
 * @ingroup tests
 *
 * @brief The TcpRateLinuxWithBufferTest tests rate sample functionality with arbitrary SACK
 * scenario. Check the value of delivered against a home-made guess
 */
class TcpRateLinuxWithBufferTest : public TestCase
{
  public:
    /**
     * @brief Constructor.
     * @param segmentSize Segment size to use.
     * @param desc Description.
     */
    TcpRateLinuxWithBufferTest(uint32_t segmentSize, std::string desc);
 
  private:
    void DoRun() override;
    void DoTeardown() override;
 
    /**
     * @brief Track the rate value of TcpRateLinux.
     * @param rate updated value of TcpRate.
     */
    virtual void RateUpdatedTrace(const TcpRateLinux::TcpRateConnection& rate);
 
    /**
     * @brief Track the rate sample value of TcpRateLinux.
     * @param sample updated value of TcpRateSample.
     */
    virtual void RateSampleUpdatedTrace(const TcpRateLinux::TcpRateSample& sample);
 
    /** @brief Test with acks without drop */
    void TestWithStraightAcks();
 
    /** @brief Test with arbitrary SACK scenario */
    void TestWithSackBlocks();
 
    uint32_t m_expectedDelivered{0};   //!< Amount of expected delivered data
    uint32_t m_expectedAckedSacked{0}; //!< Amount of expected acked sacked data
    uint32_t m_segmentSize;            //!< Segment size
    TcpTxBuffer m_txBuf;               //!< Tcp Tx buffer
    Ptr<TcpRateOps> m_rateOps;         //!< Rate operations
};
 
TcpRateLinuxWithBufferTest::TcpRateLinuxWithBufferTest(uint32_t segmentSize, std::string testString)
    : TestCase(testString),
      m_segmentSize(segmentSize)
{
    m_rateOps = CreateObject<TcpRateLinux>();
    m_rateOps->TraceConnectWithoutContext(
        "TcpRateUpdated",
        MakeCallback(&TcpRateLinuxWithBufferTest::RateUpdatedTrace, this));
    m_rateOps->TraceConnectWithoutContext(
        "TcpRateSampleUpdated",
        MakeCallback(&TcpRateLinuxWithBufferTest::RateSampleUpdatedTrace, this));
}
 
void
TcpRateLinuxWithBufferTest::DoRun()
{
    Simulator::Schedule(Seconds(0), &TcpRateLinuxWithBufferTest::TestWithSackBlocks, this);
    Simulator::Run();
    Simulator::Destroy();
}
 
void
TcpRateLinuxWithBufferTest::RateUpdatedTrace(const TcpRateLinux::TcpRateConnection& rate)
{
    NS_LOG_DEBUG("Rate updated " << rate);
    NS_TEST_ASSERT_MSG_EQ(rate.m_delivered,
                          m_expectedDelivered,
                          "Delivered data is not equal to expected delivered");
}
 
void
TcpRateLinuxWithBufferTest::RateSampleUpdatedTrace(const TcpRateLinux::TcpRateSample& sample)
{
    NS_LOG_DEBUG("Rate sample updated " << sample);
    NS_TEST_ASSERT_MSG_EQ(sample.m_ackedSacked,
                          m_expectedAckedSacked,
                          "AckedSacked bytes is not equal to expected AckedSacked bytes");
}
 
void
TcpRateLinuxWithBufferTest::TestWithSackBlocks()
{
    SequenceNumber32 head(1);
    m_txBuf.SetHeadSequence(head);
    SequenceNumber32 ret;
    Ptr<TcpOptionSack> sack = CreateObject<TcpOptionSack>();
    m_txBuf.SetSegmentSize(m_segmentSize);
    m_txBuf.SetDupAckThresh(3);
 
    m_txBuf.Add(Create<Packet>(10 * m_segmentSize));
 
    // Send 10 Segments
    for (uint8_t i = 0; i < 10; ++i)
    {
        bool isStartOfTransmission = m_txBuf.BytesInFlight() == 0;
        TcpTxItem* outItem =
            m_txBuf.CopyFromSequence(m_segmentSize, SequenceNumber32((i * m_segmentSize) + 1));
        m_rateOps->SkbSent(outItem, isStartOfTransmission);
    }
 
    uint32_t priorInFlight = m_txBuf.BytesInFlight();
    // ACK 2 Segments
    for (uint8_t i = 1; i <= 2; ++i)
    {
        priorInFlight = m_txBuf.BytesInFlight();
        m_expectedDelivered += m_segmentSize;
        m_txBuf.DiscardUpTo(SequenceNumber32(m_segmentSize * i + 1),
                            MakeCallback(&TcpRateOps::SkbDelivered, m_rateOps));
        m_expectedAckedSacked = m_segmentSize;
        m_rateOps->GenerateSample(m_segmentSize, 0, false, priorInFlight, Seconds(0));
    }
 
    priorInFlight = m_txBuf.BytesInFlight();
    sack->AddSackBlock(TcpOptionSack::SackBlock(SequenceNumber32(m_segmentSize * 4 + 1),
                                                SequenceNumber32(m_segmentSize * 5 + 1)));
    m_expectedDelivered += m_segmentSize;
    m_txBuf.Update(sack->GetSackList(), MakeCallback(&TcpRateOps::SkbDelivered, m_rateOps));
    m_expectedAckedSacked = m_segmentSize;
    m_rateOps->GenerateSample(m_segmentSize, 0, false, priorInFlight, Seconds(0));
 
    priorInFlight = m_txBuf.BytesInFlight();
    sack->AddSackBlock(TcpOptionSack::SackBlock(SequenceNumber32(m_segmentSize * 3 + 1),
                                                SequenceNumber32(m_segmentSize * 4 + 1)));
    m_expectedDelivered += m_segmentSize;
    m_txBuf.Update(sack->GetSackList(), MakeCallback(&TcpRateOps::SkbDelivered, m_rateOps));
    m_rateOps->GenerateSample(m_segmentSize, 0, false, priorInFlight, Seconds(0));
 
    priorInFlight = m_txBuf.BytesInFlight();
    // Actual delivered should be increased by one segment even multiple blocks are acked.
    m_expectedDelivered += m_segmentSize;
    m_txBuf.DiscardUpTo(SequenceNumber32(m_segmentSize * 5 + 1),
                        MakeCallback(&TcpRateOps::SkbDelivered, m_rateOps));
    m_rateOps->GenerateSample(m_segmentSize, 0, false, priorInFlight, Seconds(0));
 
    priorInFlight = m_txBuf.BytesInFlight();
    // ACK rest of the segments
    for (uint8_t i = 6; i <= 10; ++i)
    {
        m_expectedDelivered += m_segmentSize;
        m_txBuf.DiscardUpTo(SequenceNumber32(m_segmentSize * i + 1),
                            MakeCallback(&TcpRateOps::SkbDelivered, m_rateOps));
    }
    m_expectedAckedSacked = 5 * m_segmentSize;
    TcpRateOps::TcpRateSample rateSample =
        m_rateOps->GenerateSample(5 * m_segmentSize, 0, false, priorInFlight, Seconds(0));
}
 
void
TcpRateLinuxWithBufferTest::DoTeardown()
{
}
 
/**
 * @ingroup internet-test
 *
 * @brief the TestSuite for the TcpRateLinux test case
 */
class TcpRateOpsTestSuite : public TestSuite
{
  public:
    TcpRateOpsTestSuite()
        : TestSuite("tcp-rate-ops", Type::UNIT)
    {
        AddTestCase(new TcpRateLinuxBasicTest(1000,
                                              SequenceNumber32(20),
                                              SequenceNumber32(11),
                                              1,
                                              "Testing SkbDelivered and SkbSent"),
                    TestCase::Duration::QUICK);
        AddTestCase(
            new TcpRateLinuxBasicTest(1000,
                                      SequenceNumber32(11),
                                      SequenceNumber32(11),
                                      2,
                                      "Testing SkbDelivered and SkbSent with app limited data"),
            TestCase::Duration::QUICK);
 
        std::vector<uint32_t> toDrop;
        toDrop.push_back(4001);
        AddTestCase(
            new TcpRateLinuxWithSocketsTest("Checking Rate sample value without SACK, one drop",
                                            false,
                                            toDrop),
            TestCase::Duration::QUICK);
 
        AddTestCase(
            new TcpRateLinuxWithSocketsTest("Checking Rate sample value with SACK, one drop",
                                            true,
                                            toDrop),
            TestCase::Duration::QUICK);
        toDrop.push_back(4001);
        AddTestCase(
            new TcpRateLinuxWithSocketsTest("Checking Rate sample value without SACK, two drop",
                                            false,
                                            toDrop),
            TestCase::Duration::QUICK);
 
        AddTestCase(
            new TcpRateLinuxWithSocketsTest("Checking Rate sample value with SACK, two drop",
                                            true,
                                            toDrop),
            TestCase::Duration::QUICK);
 
        AddTestCase(
            new TcpRateLinuxWithBufferTest(1000,
                                           "Checking rate sample values with arbitrary SACK Block"),
            TestCase::Duration::QUICK);
 
        AddTestCase(
            new TcpRateLinuxWithBufferTest(500,
                                           "Checking rate sample values with arbitrary SACK Block"),
            TestCase::Duration::QUICK);
    }
};
 
static TcpRateOpsTestSuite g_TcpRateOpsTestSuite; //!< Static variable for test initialization