A Discrete-Event Network Simulator
API
nsctcp-loss-test-suite.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2010 University of Washington
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  */
18 
19 
20 #include "ns3/log.h"
21 #include "ns3/abort.h"
22 #include "ns3/test.h"
23 #include "ns3/pcap-file.h"
24 #include "ns3/config.h"
25 #include "ns3/string.h"
26 #include "ns3/uinteger.h"
27 #include "ns3/data-rate.h"
28 #include "ns3/inet-socket-address.h"
29 #include "ns3/point-to-point-helper.h"
30 #include "ns3/internet-stack-helper.h"
31 #include "ns3/ipv4-global-routing-helper.h"
32 #include "ns3/ipv4-address-helper.h"
33 #include "ns3/packet-sink-helper.h"
34 #include "ns3/tcp-socket-factory.h"
35 #include "ns3/node-container.h"
36 #include "ns3/simulator.h"
37 #include "ns3/error-model.h"
38 #include "ns3/pointer.h"
39 #include "../ns3tcp/ns3tcp-socket-writer.h"
40 
41 using namespace ns3;
42 
43 NS_LOG_COMPONENT_DEFINE ("NscTcpLossTest");
44 
45 // ===========================================================================
46 // Tests of TCP implementation loss behavior
47 // ===========================================================================
48 //
49 
51 {
52 public:
54  virtual ~NscTcpLossTestCase1 () {}
55 
56 private:
57  virtual void DoRun (void);
59 
60  void SinkRx (std::string path, Ptr<const Packet> p, const Address &address);
61 
64 };
65 
67  : TestCase ("Check that nsc TCP survives loss of first two SYNs"),
68  m_writeResults (false)
69 {
70 }
71 
72 void
74 {
75  m_responses.Add (p->GetSize ());
76 }
77 
78 void
80 {
81  uint16_t sinkPort = 50000;
82  double sinkStopTime = 40; // sec; will trigger Socket::Close
83  double writerStopTime = 30; // sec; will trigger Socket::Close
84  double simStopTime = 60; // sec
85  Time sinkStopTimeObj = Seconds (sinkStopTime);
86  Time writerStopTimeObj = Seconds (writerStopTime);
87  Time simStopTimeObj= Seconds (simStopTime);
88 
89  Ptr<Node> n0 = CreateObject<Node> ();
90  Ptr<Node> n1 = CreateObject<Node> ();
91 
93  pointToPoint.SetDeviceAttribute ("DataRate", StringValue ("5Mbps"));
94  pointToPoint.SetChannelAttribute ("Delay", StringValue ("200ms"));
95 
97  devices = pointToPoint.Install (n0, n1);
98 
99  InternetStackHelper internet;
100  internet.SetTcp ("ns3::NscTcpL4Protocol", "Library", StringValue ("liblinux2.6.26.so"));
101  internet.InstallAll ();
102 
104  address.SetBase ("10.1.1.0", "255.255.255.252");
105  Ipv4InterfaceContainer ifContainer = address.Assign (devices);
106 
107  Ptr<SocketWriter> socketWriter = CreateObject<SocketWriter> ();
108  Address sinkAddress (InetSocketAddress (ifContainer.GetAddress (1), sinkPort));
109  socketWriter->Setup (n0, sinkAddress);
110  n0->AddApplication (socketWriter);
111  socketWriter->SetStartTime (Seconds (0.));
112  socketWriter->SetStopTime (writerStopTimeObj);
113 
114  PacketSinkHelper sink ("ns3::TcpSocketFactory",
115  InetSocketAddress (Ipv4Address::GetAny (), sinkPort));
116  ApplicationContainer apps = sink.Install (n1);
117  // Start the sink application at time zero, and stop it at sinkStopTime
118  apps.Start (Seconds (0.0));
119  apps.Stop (sinkStopTimeObj);
120 
121  Config::Connect ("/NodeList/*/ApplicationList/*/$ns3::PacketSink/Rx",
123 
124  Simulator::Schedule (Seconds (2), &SocketWriter::Connect, socketWriter);
125  Simulator::Schedule (Seconds (10), &SocketWriter::Write, socketWriter, 500);
126  m_inputs.Add (500);
127  Simulator::Schedule (writerStopTimeObj, &SocketWriter::Close, socketWriter);
128 
129  std::list<uint32_t> sampleList;
130  // Lose first two SYNs
131  sampleList.push_back (0);
132  sampleList.push_back (1);
133  // This time, we'll explicitly create the error model we want
134  Ptr<ReceiveListErrorModel> pem = CreateObject<ReceiveListErrorModel> ();
135  pem->SetList (sampleList);
136  devices.Get (1)->SetAttribute ("ReceiveErrorModel", PointerValue (pem));
137 
138  if (m_writeResults)
139  {
140  pointToPoint.EnablePcapAll ("nsc-tcp-loss-test-case-1");
141  pointToPoint.EnableAsciiAll ("nsc-tcp-loss-test-case-1");
142  }
143 
144  Simulator::Stop (simStopTimeObj);
145  Simulator::Run ();
146  Simulator::Destroy ();
147 
148  // Compare inputs and outputs
149  NS_TEST_ASSERT_MSG_EQ (m_inputs.GetN (), m_responses.GetN (), "Incorrect number of expected receive events");
150  for (uint32_t i = 0; i < m_responses.GetN (); i++)
151  {
152  uint32_t in = m_inputs.Get (i);
153  uint32_t out = m_responses.Get (i);
154  NS_TEST_ASSERT_MSG_EQ (in, out, "Mismatch: expected " << in << " bytes, got " << out << " bytes");
155  }
156 }
157 
159 {
160 public:
162  virtual ~NscTcpLossTestCase2 () {}
163 
164 private:
165  virtual void DoRun (void);
167 
168  void SinkRx (std::string path, Ptr<const Packet> p, const Address &address);
169 
172 };
173 
175  : TestCase ("Check that nsc TCP survives loss of first data packet"),
176  m_writeResults (false)
177 {
178 }
179 
180 void
182 {
183  m_responses.Add (p->GetSize ());
184 }
185 
186 void
188 {
189  uint16_t sinkPort = 50000;
190  double sinkStopTime = 40; // sec; will trigger Socket::Close
191  double writerStopTime = 12; // sec; will trigger Socket::Close
192  double simStopTime = 60; // sec
193  Time sinkStopTimeObj = Seconds (sinkStopTime);
194  Time writerStopTimeObj = Seconds (writerStopTime);
195  Time simStopTimeObj= Seconds (simStopTime);
196 
197  Ptr<Node> n0 = CreateObject<Node> ();
198  Ptr<Node> n1 = CreateObject<Node> ();
199 
201  pointToPoint.SetDeviceAttribute ("DataRate", StringValue ("5Mbps"));
202  pointToPoint.SetChannelAttribute ("Delay", StringValue ("200ms"));
203 
205  devices = pointToPoint.Install (n0, n1);
206 
207  InternetStackHelper internet;
208  internet.SetTcp ("ns3::NscTcpL4Protocol", "Library", StringValue ("liblinux2.6.26.so"));
209  internet.InstallAll ();
210 
212  address.SetBase ("10.1.1.0", "255.255.255.252");
213  Ipv4InterfaceContainer ifContainer = address.Assign (devices);
214 
215  Ptr<SocketWriter> socketWriter = CreateObject<SocketWriter> ();
216  Address sinkAddress (InetSocketAddress (ifContainer.GetAddress (1), sinkPort));
217  socketWriter->Setup (n0, sinkAddress);
218  n0->AddApplication (socketWriter);
219  socketWriter->SetStartTime (Seconds (0.));
220  socketWriter->SetStopTime (writerStopTimeObj);
221 
222  PacketSinkHelper sink ("ns3::TcpSocketFactory",
223  InetSocketAddress (Ipv4Address::GetAny (), sinkPort));
224  ApplicationContainer apps = sink.Install (n1);
225  // Start the sink application at time zero, and stop it at sinkStopTime
226  apps.Start (Seconds (0.0));
227  apps.Stop (sinkStopTimeObj);
228 
229  Config::Connect ("/NodeList/*/ApplicationList/*/$ns3::PacketSink/Rx",
231 
232  Simulator::Schedule (Seconds (2), &SocketWriter::Connect, socketWriter);
233  Simulator::Schedule (Seconds (10), &SocketWriter::Write, socketWriter, 500);
234  m_inputs.Add (500);
235  Simulator::Schedule (writerStopTimeObj, &SocketWriter::Close, socketWriter);
236 
237  std::list<uint32_t> sampleList;
238  // Lose first data segment
239  sampleList.push_back (2);
240  // This time, we'll explicitly create the error model we want
241  Ptr<ReceiveListErrorModel> pem = CreateObject<ReceiveListErrorModel> ();
242  pem->SetList (sampleList);
243  devices.Get (1)->SetAttribute ("ReceiveErrorModel", PointerValue (pem));
244 
245  if (m_writeResults)
246  {
247  pointToPoint.EnablePcapAll ("nsc-tcp-loss-test-case-2");
248  pointToPoint.EnableAsciiAll ("nsc-tcp-loss-test-case-2");
249  }
250 
251  Simulator::Stop (simStopTimeObj);
252  Simulator::Run ();
253  Simulator::Destroy ();
254 
255  // Compare inputs and outputs
256  NS_TEST_ASSERT_MSG_EQ (m_inputs.GetN (), m_responses.GetN (), "Incorrect number of expected receive events");
257  for (uint32_t i = 0; i < m_responses.GetN (); i++)
258  {
259  uint32_t in = m_inputs.Get (i);
260  uint32_t out = m_responses.Get (i);
261  NS_TEST_ASSERT_MSG_EQ (in, out, "Mismatch: expected " << in << " bytes, got " << out << " bytes");
262  }
263 }
264 
266 {
267 public:
269 };
270 
272  : TestSuite ("nsc-tcp-loss", SYSTEM)
273 {
274  AddTestCase (new NscTcpLossTestCase1, TestCase::QUICK);
275  AddTestCase (new NscTcpLossTestCase2, TestCase::QUICK);
276 }
277 
void InstallAll(void) const
Aggregate IPv4, IPv6, UDP, and TCP stacks to all nodes in the simulation.
Ptr< PacketSink > sink
Definition: wifi-tcp.cc:56
holds a vector of ns3::Application pointers.
uint32_t AddApplication(Ptr< Application > application)
Associate an Application to this Node.
Definition: node.cc:157
void SetStopTime(Time stop)
Specify application stop time.
Definition: application.cc:75
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
an Inet address class
TestVectors< uint32_t > m_responses
virtual void DoRun(void)
Implementation to actually run this TestCase.
holds a vector of std::pair of Ptr<Ipv4> and interface index.
uint32_t GetSize(void) const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:852
Hold variables of type string.
Definition: string.h:41
A suite of tests to run.
Definition: test.h:1343
virtual void DoRun(void)
Implementation to actually run this TestCase.
TestVectors< uint32_t > m_inputs
void SinkRx(std::string path, Ptr< const Packet > p, const Address &address)
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
aggregate IP/TCP/UDP functionality to existing Nodes.
T Get(std::size_t i) const
Get the i&#39;th test vector.
Definition: test.h:1483
A helper to make it easier to instantiate an ns3::PacketSinkApplication on a set of nodes...
Build a set of PointToPointNetDevice objects.
encapsulates test code
Definition: test.h:1153
a polymophic address class
Definition: address.h:90
std::size_t GetN(void) const
Get the total number of test vectors.
Definition: test.h:1476
void Setup(Ptr< Node > node, Address peer)
TestVectors< uint32_t > m_inputs
void AddTestCase(TestCase *testCase, TestDuration duration=QUICK)
Add an individual child TestCase to this test suite.
Definition: test.cc:299
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
#define NS_TEST_ASSERT_MSG_EQ(actual, limit, msg)
Test that an actual and expected (limit) value are equal and report and abort if not.
Definition: test.h:166
pointToPoint
Definition: first.py:35
holds a vector of ns3::NetDevice pointers
TestVectors< uint32_t > m_responses
Callback< R > MakeCallback(R(T::*memPtr)(void), OBJ objPtr)
Definition: callback.h:1610
void Start(Time start)
Arrange for all of the Applications in this container to Start() at the Time given as a parameter...
void Connect(std::string path, const CallbackBase &cb)
Definition: config.cc:873
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Hold objects of type Ptr<T>.
Definition: pointer.h:36
address
Definition: first.py:44
void SetTcp(std::string tid)
set the Tcp stack which will not need any other parameter.
void SetList(const std::list< uint32_t > &packetlist)
Definition: error-model.cc:520
void SinkRx(std::string path, Ptr< const Packet > p, const Address &address)
void Stop(Time stop)
Arrange for all of the Applications in this container to Stop() at the Time given as a parameter...
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1070
std::size_t Add(T vector)
Definition: test.h:1467
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
devices
Definition: first.py:39
static void SinkRx(std::string path, Ptr< const Packet > p, const Address &address)
static NscTcpLossTestSuite nscTcpLossTestSuite
void SetStartTime(Time start)
Specify application start time.
Definition: application.cc:69