tcp-zero-window-test.cc

Go to the documentation of this file.

/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2015 Natale Patriciello <natale.patriciello@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#include "tcp-general-test.h"
#include "tcp-error-model.h"
#include "ns3/node.h"
#include "ns3/log.h"

namespace ns3 {

NS_LOG_COMPONENT_DEFINE ("TcpZeroWindowTestSuite");

class TcpZeroWindowTest : public TcpGeneralTest
{
public:
  TcpZeroWindowTest (const std::string &desc);

protected:
  //virtual void ReceivePacket (Ptr<Socket> socket);
  virtual Ptr<TcpSocketMsgBase> CreateReceiverSocket (Ptr<Node> node);

  virtual void Tx (const Ptr<const Packet> p, const TcpHeader&h, SocketWho who);
  virtual void Rx (const Ptr<const Packet> p, const TcpHeader&h, SocketWho who);
  virtual void ProcessedAck (const Ptr<const TcpSocketState> tcb,
                             const TcpHeader& h, SocketWho who);
  void NormalClose (SocketWho who);
  void FinalChecks ();

  void IncreaseBufSize ();

protected:
  EventId m_receivePktEvent;
  bool m_zeroWindowProbe;
  bool m_windowUpdated;
  bool m_senderFinished;
  bool m_receiverFinished;
};

TcpZeroWindowTest::TcpZeroWindowTest (const std::string &desc)
  : TcpGeneralTest (desc, 500, 20, Seconds (0.01), Seconds (0.05), Seconds (2.0),
                    0xffffffff, 10, 500),
  m_zeroWindowProbe (false),
  m_windowUpdated (false),
  m_senderFinished (false),
  m_receiverFinished (false)
{
}

void
TcpZeroWindowTest::IncreaseBufSize ()
{
  SetRcvBufSize (RECEIVER, 2500);
}

Ptr<TcpSocketMsgBase>
TcpZeroWindowTest::CreateReceiverSocket (Ptr<Node> node)
{
  Ptr<TcpSocketMsgBase> socket = TcpGeneralTest::CreateReceiverSocket (node);

  socket->SetAttribute ("RcvBufSize", UintegerValue (0));
  Simulator::Schedule (Seconds (10.0),
                       &TcpZeroWindowTest::IncreaseBufSize, this);

  return socket;
}

void
TcpZeroWindowTest::Tx (const Ptr<const Packet> p, const TcpHeader &h, SocketWho who)
{
  if (who == SENDER)
    {
      NS_LOG_INFO ("\tSENDER TX " << h << " size " << p->GetSize ());

      if (Simulator::Now ().GetSeconds () <= 6.0)
        {
          NS_TEST_ASSERT_MSG_EQ (p->GetSize () - h.GetSerializedSize (), 0,
                                 "Data packet sent anyway");
        }
      else if (Simulator::Now ().GetSeconds () > 6.0
               && Simulator::Now ().GetSeconds () <= 7.0)
        {
          NS_TEST_ASSERT_MSG_EQ (m_zeroWindowProbe, false, "Sent another probe");

          if (!m_zeroWindowProbe)
            {
              NS_TEST_ASSERT_MSG_EQ (p->GetSize () - h.GetSerializedSize (), 1,
                                     "Data packet sent instead of window probe");
              NS_TEST_ASSERT_MSG_EQ (h.GetSequenceNumber (), SequenceNumber32 (1),
                                     "Data packet sent instead of window probe");
              m_zeroWindowProbe = true;
            }
        }
      else if (Simulator::Now ().GetSeconds () > 7.0
               && Simulator::Now ().GetSeconds () < 10.0)
        {
          NS_FATAL_ERROR ("No packets should be sent before the window update");
        }
    }
  else if (who == RECEIVER)
    {
      NS_LOG_INFO ("\tRECEIVER TX " << h << " size " << p->GetSize ());

      if (h.GetFlags () & TcpHeader::SYN)
        {
          NS_TEST_ASSERT_MSG_EQ (h.GetWindowSize (), 0,
                                 "RECEIVER window size is not 0 in the SYN-ACK");
        }

      if (Simulator::Now ().GetSeconds () > 6.0
          && Simulator::Now ().GetSeconds () <= 7.0)
        {
          NS_TEST_ASSERT_MSG_EQ (h.GetSequenceNumber (), SequenceNumber32 (1),
                                 "Data packet sent instead of window probe");
          NS_TEST_ASSERT_MSG_EQ (h.GetWindowSize (), 0,
                                 "No zero window advertised by RECEIVER");
        }
      else if (Simulator::Now ().GetSeconds () > 7.0
               && Simulator::Now ().GetSeconds () < 10.0)
        {
          NS_FATAL_ERROR ("No packets should be sent before the window update");
        }
      else if (Simulator::Now ().GetSeconds () >= 10.0)
        {
          NS_TEST_ASSERT_MSG_EQ (h.GetWindowSize (), 2500,
                                 "Receiver window not updated");
        }
    }

  NS_TEST_ASSERT_MSG_EQ (GetCongStateFrom (GetTcb (SENDER)), TcpSocketState::CA_OPEN,
                         "Sender State is not OPEN");
  NS_TEST_ASSERT_MSG_EQ (GetCongStateFrom (GetTcb (RECEIVER)), TcpSocketState::CA_OPEN,
                         "Receiver State is not OPEN");
}

void
TcpZeroWindowTest::Rx (const Ptr<const Packet> p, const TcpHeader &h, SocketWho who)
{
  if (who == SENDER)
    {
      NS_LOG_INFO ("\tSENDER RX " << h << " size " << p->GetSize ());

      if (h.GetFlags () & TcpHeader::SYN)
        {
          NS_TEST_ASSERT_MSG_EQ (h.GetWindowSize (), 0,
                                 "RECEIVER window size is not 0 in the SYN-ACK");
        }

      if (Simulator::Now ().GetSeconds () >= 10.0)
        {
          NS_TEST_ASSERT_MSG_EQ (h.GetWindowSize (), 2500,
                                 "Receiver window not updated");
          m_windowUpdated = true;
        }
    }
  else if (who == RECEIVER)
    {
      NS_LOG_INFO ("\tRECEIVER RX " << h << " size " << p->GetSize ());
    }
}

void
TcpZeroWindowTest::NormalClose (SocketWho who)
{
  if (who == SENDER)
    {
      m_senderFinished = true;
    }
  else if (who == RECEIVER)
    {
      m_receiverFinished = true;
    }
}

void
TcpZeroWindowTest::FinalChecks ()
{
  NS_TEST_ASSERT_MSG_EQ (m_zeroWindowProbe, true,
                         "Zero window probe not sent");
  NS_TEST_ASSERT_MSG_EQ (m_windowUpdated, true,
                         "Window has not updated during the connection");
  NS_TEST_ASSERT_MSG_EQ (m_senderFinished, true,
                         "Connection not closed successfully (SENDER)");
  NS_TEST_ASSERT_MSG_EQ (m_receiverFinished, true,
                         "Connection not closed successfully (RECEIVER)");
}

void
TcpZeroWindowTest::ProcessedAck (const Ptr<const TcpSocketState> tcb,
                                 const TcpHeader& h, SocketWho who)
{
  if (who == SENDER)
    {
      if (h.GetFlags () & TcpHeader::SYN)
        {
          EventId persistentEvent = GetPersistentEvent (SENDER);
          NS_TEST_ASSERT_MSG_EQ (persistentEvent.IsRunning (), true,
                                 "Persistent event not started");
        }
    }
  else if (who == RECEIVER)
    {

    }
}

//-----------------------------------------------------------------------------

static class TcpZeroWindowTestSuite : public TestSuite
{
public:
  TcpZeroWindowTestSuite () : TestSuite ("tcp-zero-window-test", UNIT)
  {
    AddTestCase (new TcpZeroWindowTest ("zero window test"),
                 TestCase::QUICK);
  }
} g_tcpZeroWindowTestSuite;

} // namespace ns3