A Discrete-Event Network Simulator
API
aodv-regression.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2009 IITP RAS
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  * Authors: Pavel Boyko <boyko@iitp.ru>
19  */
20 
21 #include "aodv-regression.h"
22 #include "bug-772.h"
23 #include "loopback.h"
24 
25 #include "ns3/simulator.h"
26 #include "ns3/mobility-helper.h"
27 #include "ns3/double.h"
28 #include "ns3/uinteger.h"
29 #include "ns3/string.h"
30 #include "ns3/boolean.h"
31 #include "ns3/yans-wifi-helper.h"
32 #include "ns3/internet-stack-helper.h"
33 #include "ns3/ipv4-address-helper.h"
34 #include "ns3/abort.h"
35 #include "ns3/udp-echo-helper.h"
36 #include "ns3/mobility-model.h"
37 #include "ns3/pcap-file.h"
38 #include "ns3/aodv-helper.h"
39 #include "ns3/v4ping-helper.h"
40 #include "ns3/nqos-wifi-mac-helper.h"
41 #include "ns3/config.h"
42 #include "ns3/pcap-test.h"
43 #include "ns3/rng-seed-manager.h"
44 #include <sstream>
45 
46 using namespace ns3;
47 using namespace aodv;
48 //-----------------------------------------------------------------------------
49 // Test suite
50 //-----------------------------------------------------------------------------
52 {
53 public:
54  AodvRegressionTestSuite () : TestSuite ("routing-aodv-regression", SYSTEM)
55  {
56  SetDataDir (NS_TEST_SOURCEDIR);
57  // General RREQ-RREP-RRER test case
58  AddTestCase (new ChainRegressionTest ("aodv-chain-regression-test"), TestCase::QUICK);
61  AddTestCase (new ChainRegressionTest ("bug-606-test", Seconds (10), 3, Seconds (1)), TestCase::QUICK);
64  AddTestCase (new Bug772ChainTest ("udp-chain-test", "ns3::UdpSocketFactory", Seconds (3), 10), TestCase::QUICK);
67  AddTestCase (new Bug772ChainTest ("tcp-chain-test", "ns3::TcpSocketFactory", Seconds (3), 10), TestCase::QUICK);
68  // Ping loopback test case
69  AddTestCase (new LoopbackTestCase (), TestCase::QUICK);
70  }
72 
73 
74 //-----------------------------------------------------------------------------
75 // ChainRegressionTest
76 //-----------------------------------------------------------------------------
77 ChainRegressionTest::ChainRegressionTest (const char * const prefix, Time t, uint32_t size, Time arpAliveTimeout) :
78  TestCase ("AODV chain regression test"),
79  m_nodes (0),
80  m_prefix (prefix),
81  m_time (t),
82  m_size (size),
83  m_step (120),
84  m_arpAliveTimeout (arpAliveTimeout)
85 {
86 }
87 
89 {
90  delete m_nodes;
91 }
92 
93 void
95 {
96  RngSeedManager::SetSeed (12345);
97  RngSeedManager::SetRun (7);
98  Config::SetDefault ("ns3::ArpCache::AliveTimeout", TimeValue (m_arpAliveTimeout));
99 
100  CreateNodes ();
101  CreateDevices ();
102 
103  // At m_time / 3 move central node away and see what will happen
104  Ptr<Node> node = m_nodes->Get (m_size / 2);
106  Simulator::Schedule (Time (m_time / 3), &MobilityModel::SetPosition, mob, Vector (1e5, 1e5, 1e5));
107 
108  Simulator::Stop (m_time);
109  Simulator::Run ();
110  Simulator::Destroy ();
111 
112  CheckResults ();
113 
114  delete m_nodes, m_nodes = 0;
115 }
116 
117 void
119 {
120  m_nodes = new NodeContainer;
121  m_nodes->Create (m_size);
122  MobilityHelper mobility;
123  mobility.SetPositionAllocator ("ns3::GridPositionAllocator",
124  "MinX", DoubleValue (0.0),
125  "MinY", DoubleValue (0.0),
126  "DeltaX", DoubleValue (m_step),
127  "DeltaY", DoubleValue (0),
128  "GridWidth", UintegerValue (m_size),
129  "LayoutType", StringValue ("RowFirst"));
130  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
131  mobility.Install (*m_nodes);
132 }
133 
134 void
136 {
137  // 1. Setup WiFi
138  int64_t streamsUsed = 0;
139  NqosWifiMacHelper wifiMac = NqosWifiMacHelper::Default ();
140  wifiMac.SetType ("ns3::AdhocWifiMac");
141  YansWifiPhyHelper wifiPhy = YansWifiPhyHelper::Default ();
142  YansWifiChannelHelper wifiChannel = YansWifiChannelHelper::Default ();
143  Ptr<YansWifiChannel> chan = wifiChannel.Create ();
144  wifiPhy.SetChannel (chan);
145  // This test suite output was originally based on YansErrorRateModel
146  wifiPhy.SetErrorRateModel ("ns3::YansErrorRateModel");
147  WifiHelper wifi = WifiHelper::Default ();
148  wifi.SetRemoteStationManager ("ns3::ConstantRateWifiManager", "DataMode", StringValue ("OfdmRate6Mbps"), "RtsCtsThreshold", StringValue ("2200"));
149  NetDeviceContainer devices = wifi.Install (wifiPhy, wifiMac, *m_nodes);
150 
151  // Assign fixed stream numbers to wifi and channel random variables
152  streamsUsed += wifi.AssignStreams (devices, streamsUsed);
153  // Assign 6 streams per device
154  NS_TEST_ASSERT_MSG_EQ (streamsUsed, (devices.GetN () * 6), "Stream assignment mismatch");
155  streamsUsed += wifiChannel.AssignStreams (chan, streamsUsed);
156  // Assign 0 streams per channel for this configuration
157  NS_TEST_ASSERT_MSG_EQ (streamsUsed, (devices.GetN () * 6), "Stream assignment mismatch");
158 
159  // 2. Setup TCP/IP & AODV
160  AodvHelper aodv; // Use default parameters here
161  InternetStackHelper internetStack;
162  internetStack.SetRoutingHelper (aodv);
163  internetStack.Install (*m_nodes);
164  streamsUsed += internetStack.AssignStreams (*m_nodes, streamsUsed);
165  // InternetStack uses m_size more streams
166  NS_TEST_ASSERT_MSG_EQ (streamsUsed, (devices.GetN () * 8) + m_size, "Stream assignment mismatch");
167  streamsUsed += aodv.AssignStreams (*m_nodes, streamsUsed);
168  // AODV uses m_size more streams
169  NS_TEST_ASSERT_MSG_EQ (streamsUsed, ((devices.GetN () * 8) + (2*m_size)), "Stream assignment mismatch");
170 
172  address.SetBase ("10.1.1.0", "255.255.255.0");
173  Ipv4InterfaceContainer interfaces = address.Assign (devices);
174 
175  // 3. Setup ping
176  V4PingHelper ping (interfaces.GetAddress (m_size - 1));
177  ping.SetAttribute ("Verbose", BooleanValue (false)); // don't need verbose ping in regression test
178  ApplicationContainer p = ping.Install (m_nodes->Get (0));
179  p.Start (Seconds (0));
180  p.Stop (m_time);
181 
182  // 4. write PCAP
184 }
185 
186 void
188 {
189  for (uint32_t i = 0; i < m_size; ++i)
190  {
191  NS_PCAP_TEST_EXPECT_EQ (m_prefix << "-" << i << "-0.pcap");
192  }
193 }
void CreateNodes()
Create test topology.
holds a vector of ns3::Application pointers.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
AODV chain regression test.
void SetErrorRateModel(std::string name, std::string n0="", const AttributeValue &v0=EmptyAttributeValue(), std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue())
AttributeValue implementation for Boolean.
Definition: boolean.h:34
tuple devices
Definition: first.py:32
holds a vector of std::pair of Ptr and interface index.
void CheckResults()
Compare traces with reference ones.
Ptr< YansWifiChannel > Create(void) const
void SetRemoteStationManager(std::string type, std::string n0="", const AttributeValue &v0=EmptyAttributeValue(), std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue())
Definition: wifi-helper.cc:73
Hold variables of type string.
Definition: string.h:41
Make it easy to create and manage PHY objects for the yans model.
void SetAttribute(std::string name, const AttributeValue &value)
Configure ping applications attribute.
Fast test.
Definition: test.h:1116
const Time m_arpAliveTimeout
ARP alive timeout.
A suite of tests to run.
Definition: test.h:1276
virtual void SetType(std::string type, std::string n0="", const AttributeValue &v0=EmptyAttributeValue(), std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue())
aggregate IP/TCP/UDP functionality to existing Nodes.
encapsulates test code
Definition: test.h:1108
#define NS_PCAP_TEST_EXPECT_EQ(filename)
Test that a pair of reference/new pcap files are equal.
Definition: pcap-test.h:18
ChainRegressionTest(const char *const prefix, Time time=Seconds(10), uint32_t size=5, Time arpAliveTimeout=Seconds(120))
Create test case.
helps to create WifiNetDevice objects
Definition: wifi-helper.h:92
static void SetPosition(Ptr< Node > node, Vector position)
Definition: wifi-ap.cc:86
virtual NetDeviceContainer Install(const WifiPhyHelper &phy, const WifiMacHelper &mac, NodeContainer c) const
Definition: wifi-helper.cc:102
uint32_t GetN(void) const
Get the number of Ptr stored in this container.
AODV deferred route lookup test case (see Bug 772)
Definition: bug-772.h:37
Keep track of the current position and velocity of an object.
void SetChannel(Ptr< YansWifiChannel > channel)
const uint32_t m_size
Chain size.
void Install(Ptr< Node > node) const
"Layout" a single node according to the current position allocator type.
void EnablePcapAll(std::string prefix, bool promiscuous=false)
Enable pcap output on each device (which is of the appropriate type) in the set of all nodes created ...
const double m_step
Chain step, meters.
AttributeValue implementation for Time.
Definition: nstime.h:928
Hold an unsigned integer type.
Definition: uinteger.h:44
#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:158
tuple interfaces
Definition: first.py:41
holds a vector of ns3::NetDevice pointers
int64_t AssignStreams(NetDeviceContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by the Phy and Mac aspects ...
Definition: wifi-helper.cc:177
NodeContainer * m_nodes
AodvRegressionTestSuite g_aodvRegressionTestSuite
void Start(Time start)
Arrange for all of the Applications in this container to Start() at the Time given as a parameter...
create non QoS-enabled MAC layers for a ns3::WifiNetDevice.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
keep track of a set of node pointers.
void SetMobilityModel(std::string type, std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue(), std::string n8="", const AttributeValue &v8=EmptyAttributeValue(), std::string n9="", const AttributeValue &v9=EmptyAttributeValue())
void Install(std::string nodeName) const
Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provid...
manage and create wifi channel objects for the yans model.
Helper class used to assign positions and mobility models to nodes.
void Stop(Time stop)
Arrange for all of the Applications in this container to Stop() at the Time given as a parameter...
Ipv4InterfaceContainer Assign(const NetDeviceContainer &c)
Assign IP addresses to the net devices specified in the container based on the current network prefix...
int64_t AssignStreams(NodeContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model...
Ptr< Node > Get(uint32_t i) const
Get the Ptr stored in this container at a given index.
std::string CreateTempDirFilename(std::string filename)
Definition: test.cc:313
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:866
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:683
int64_t AssignStreams(NodeContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model...
Definition: aodv-helper.cc:57
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
Helper class that adds AODV routing to nodes.
Definition: aodv-helper.h:35
tuple address
Definition: first.py:37
void CreateDevices()
Create devices, install TCP/IP stack and applications.
void SetPositionAllocator(Ptr< PositionAllocator > allocator)
Set the position allocator which will be used to allocate the initial position of every node initiali...
This class can be used to hold variables of floating point type such as 'double' or 'float'...
Definition: double.h:41
AODV ping 127.0.0.1 test case.
Definition: loopback.h:35
Ptr< T > GetObject(void) const
Get a pointer to the requested aggregated Object.
Definition: object.h:455
const std::string m_prefix
PCAP file names prefix.
Create a IPv5 ping application and associate it to a node.
Definition: v4ping-helper.h:37
void SetRoutingHelper(const Ipv4RoutingHelper &routing)
const Time m_time
Total simulation time.
int64_t AssignStreams(Ptr< YansWifiChannel > c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by the channel.
void SetBase(Ipv4Address network, Ipv4Mask mask, Ipv4Address base="0.0.0.1")
Set the base network number, network mask and base address.
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const