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
24#include "ns3/simulator.h"
25#include "ns3/mobility-helper.h"
26#include "ns3/double.h"
27#include "ns3/uinteger.h"
28#include "ns3/string.h"
29#include "ns3/boolean.h"
30#include "ns3/yans-wifi-helper.h"
31#include "ns3/internet-stack-helper.h"
32#include "ns3/ipv4-address-helper.h"
33#include "ns3/abort.h"
34#include "ns3/mobility-model.h"
35#include "ns3/pcap-file.h"
36#include "ns3/aodv-helper.h"
37#include "ns3/config.h"
38#include "ns3/pcap-test.h"
39#include "ns3/rng-seed-manager.h"
40#include "ns3/icmpv4.h"
41#include <sstream>
42
43using namespace ns3;
44
52{
53public:
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);
59 // \bugid{606} test case, should crash if bug is not fixed
60 AddTestCase (new ChainRegressionTest ("bug-606-test", Seconds (10), 3, Seconds (1)), TestCase::QUICK);
61 // \bugid{772} UDP test case
62 AddTestCase (new Bug772ChainTest ("udp-chain-test", "ns3::UdpSocketFactory", Seconds (3), 10), TestCase::QUICK);
63 }
65
66
73ChainRegressionTest::ChainRegressionTest (const char * const prefix, Time t, uint32_t size, Time arpAliveTimeout)
74 : TestCase ("AODV chain regression test"),
75 m_nodes (0),
76 m_prefix (prefix),
77 m_time (t),
78 m_size (size),
79 m_step (120),
80 m_arpAliveTimeout (arpAliveTimeout),
81 m_seq (0)
82{
83}
84
86{
87 delete m_nodes;
88}
89
90void
92{
93 if (Simulator::Now () >= m_time)
94 {
95 return;
96 }
97
98 Ptr<Packet> p = Create<Packet> ();
99 Icmpv4Echo echo;
101 m_seq++;
102 echo.SetIdentifier (0);
103
104 Ptr<Packet> dataPacket = Create<Packet> (56);
105 echo.SetData (dataPacket);
106 p->AddHeader (echo);
107 Icmpv4Header header;
108 header.SetType (Icmpv4Header::ICMPV4_ECHO);
109 header.SetCode (0);
110 if (Node::ChecksumEnabled ())
111 {
112 header.EnableChecksum ();
113 }
114 p->AddHeader (header);
115 m_socket->Send (p, 0);
116 Simulator::Schedule (Seconds (1), &ChainRegressionTest::SendPing, this);
117}
118
119void
121{
122 RngSeedManager::SetSeed (12345);
123 RngSeedManager::SetRun (7);
124 Config::SetDefault ("ns3::ArpCache::AliveTimeout", TimeValue (m_arpAliveTimeout));
125
126 CreateNodes ();
127 CreateDevices ();
128
129 // At m_time / 3 move central node away and see what will happen
130 Ptr<Node> node = m_nodes->Get (m_size / 2);
132 Simulator::Schedule (Time (m_time / 3), &MobilityModel::SetPosition, mob, Vector (1e5, 1e5, 1e5));
133
134 Simulator::Stop (m_time);
135 Simulator::Run ();
136 Simulator::Destroy ();
137
138 CheckResults ();
139
140 delete m_nodes, m_nodes = 0;
141}
142
143void
145{
149 mobility.SetPositionAllocator ("ns3::GridPositionAllocator",
150 "MinX", DoubleValue (0.0),
151 "MinY", DoubleValue (0.0),
152 "DeltaX", DoubleValue (m_step),
153 "DeltaY", DoubleValue (0),
154 "GridWidth", UintegerValue (m_size),
155 "LayoutType", StringValue ("RowFirst"));
156 mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
157 mobility.Install (*m_nodes);
158}
159
160void
162{
163 // 1. Setup WiFi
164 int64_t streamsUsed = 0;
165 WifiMacHelper wifiMac;
166 wifiMac.SetType ("ns3::AdhocWifiMac");
167 YansWifiPhyHelper wifiPhy;
169 YansWifiChannelHelper wifiChannel = YansWifiChannelHelper::Default ();
170 Ptr<YansWifiChannel> chan = wifiChannel.Create ();
171 wifiPhy.SetChannel (chan);
172
173 // This test suite output was originally based on YansErrorRateModel
174 wifiPhy.SetErrorRateModel ("ns3::YansErrorRateModel");
176 wifi.SetStandard (WIFI_STANDARD_80211a);
177 wifi.SetRemoteStationManager ("ns3::ConstantRateWifiManager", "DataMode", StringValue ("OfdmRate6Mbps"), "RtsCtsThreshold", StringValue ("2200"));
178 NetDeviceContainer devices = wifi.Install (wifiPhy, wifiMac, *m_nodes);
179
180 // Assign fixed stream numbers to wifi and channel random variables
181 streamsUsed += wifi.AssignStreams (devices, streamsUsed);
182 // Assign 6 streams per device
183 NS_TEST_ASSERT_MSG_EQ (streamsUsed, (devices.GetN () * 2), "Stream assignment mismatch");
184 streamsUsed += wifiChannel.AssignStreams (chan, streamsUsed);
185 // Assign 0 streams per channel for this configuration
186 NS_TEST_ASSERT_MSG_EQ (streamsUsed, (devices.GetN () * 2), "Stream assignment mismatch");
187
188 // 2. Setup TCP/IP & AODV
189 AodvHelper aodv; // Use default parameters here
190 InternetStackHelper internetStack;
191 internetStack.SetRoutingHelper (aodv);
192 internetStack.Install (*m_nodes);
193 streamsUsed += internetStack.AssignStreams (*m_nodes, streamsUsed);
194 // InternetStack uses m_size more streams
195 NS_TEST_ASSERT_MSG_EQ (streamsUsed, (devices.GetN () * 4) + m_size, "Stream assignment mismatch");
196 streamsUsed += aodv.AssignStreams (*m_nodes, streamsUsed);
197 // AODV uses m_size more streams
198 NS_TEST_ASSERT_MSG_EQ (streamsUsed, ((devices.GetN () * 4) + (2 * m_size)), "Stream assignment mismatch");
199
201 address.SetBase ("10.1.1.0", "255.255.255.0");
203
204 // 3. Setup ping
205 m_socket = Socket::CreateSocket (m_nodes->Get (0), TypeId::LookupByName ("ns3::Ipv4RawSocketFactory"));
206 m_socket->SetAttribute ("Protocol", UintegerValue (1)); // icmp
207 InetSocketAddress src = InetSocketAddress (Ipv4Address::GetAny (), 0);
208 m_socket->Bind (src);
209 InetSocketAddress dst = InetSocketAddress (interfaces.GetAddress (m_size - 1), 0);
210 m_socket->Connect (dst);
211
212 SendPing ();
213
214 // 4. write PCAP
216}
217
218void
220{
221 for (uint32_t i = 0; i < m_size; ++i)
222 {
223 NS_PCAP_TEST_EXPECT_EQ (m_prefix << "-" << i << "-0.pcap");
224 }
225}
AODV regression test suite.
AODV deferred route lookup test case (see Bug 772)
Definition: bug-772.h:41
AODV chain regression test.
const uint32_t m_size
Chain size.
void CreateNodes()
Create test topology.
uint16_t m_seq
Sequence number.
void SendPing()
Send one ping.
const Time m_arpAliveTimeout
ARP alive timeout.
const double m_step
Chain step, meters.
NodeContainer * m_nodes
void CheckResults()
Compare traces with reference ones.
const Time m_time
Total simulation time.
const std::string m_prefix
PCAP file names prefix.
Ptr< Socket > m_socket
Socket.
void CreateDevices()
Create devices, install TCP/IP stack and applications.
Helper class that adds AODV routing to nodes.
Definition: aodv-helper.h:35
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
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition: double.h:41
ICMP Echo header.
Definition: icmpv4.h:108
void SetIdentifier(uint16_t id)
Set the Echo identifier.
Definition: icmpv4.cc:140
void SetData(Ptr< const Packet > data)
Set the Echo data.
Definition: icmpv4.cc:152
void SetSequenceNumber(uint16_t seq)
Set the Echo sequence number.
Definition: icmpv4.cc:146
Base class for all the ICMP packet headers.
Definition: icmpv4.h:41
void SetCode(uint8_t code)
Set ICMP code.
Definition: icmpv4.cc:115
void SetType(uint8_t type)
Set ICMP type.
Definition: icmpv4.cc:109
void EnableChecksum(void)
Enables ICMP Checksum calculation.
Definition: icmpv4.cc:57
an Inet address class
aggregate IP/TCP/UDP functionality to existing Nodes.
void Install(std::string nodeName) const
Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provid...
void SetRoutingHelper(const Ipv4RoutingHelper &routing)
int64_t AssignStreams(NodeContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model.
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
holds a vector of std::pair of Ptr<Ipv4> and interface index.
Helper class used to assign positions and mobility models to nodes.
Keep track of the current position and velocity of an object.
holds a vector of ns3::NetDevice pointers
keep track of a set of node pointers.
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
void SetAttribute(std::string name, const AttributeValue &value)
Set a single attribute, raising fatal errors if unsuccessful.
Definition: object-base.cc:256
Ptr< T > GetObject(void) const
Get a pointer to the requested aggregated Object.
Definition: object.h:470
void AddHeader(const Header &header)
Add header to this packet.
Definition: packet.cc:256
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 ...
virtual int Send(Ptr< Packet > p, uint32_t flags)=0
Send data (or dummy data) to the remote host.
virtual int Connect(const Address &address)=0
Initiate a connection to a remote host.
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
Hold variables of type string.
Definition: string.h:41
encapsulates test code
Definition: test.h:994
void AddTestCase(TestCase *testCase, TestDuration duration=QUICK)
Add an individual child TestCase to this test suite.
Definition: test.cc:299
std::string CreateTempDirFilename(std::string filename)
Construct the full path to a file in a temporary directory.
Definition: test.cc:430
void SetDataDir(std::string directory)
Set the data directory where reference trace files can be found.
Definition: test.cc:465
A suite of tests to run.
Definition: test.h:1188
@ SYSTEM
This test suite implements a System Test.
Definition: test.h:1198
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
AttributeValue implementation for Time.
Definition: nstime.h:1308
Hold an unsigned integer type.
Definition: uinteger.h:44
helps to create WifiNetDevice objects
Definition: wifi-helper.h:274
create MAC layers for a ns3::WifiNetDevice.
void SetType(std::string type, Args &&... args)
void DisablePreambleDetectionModel()
Disable the preamble detection model.
Definition: wifi-helper.cc:161
void SetErrorRateModel(std::string type, Args &&... args)
Helper function used to set the error rate model.
Definition: wifi-helper.h:440
manage and create wifi channel objects for the YANS model.
Ptr< YansWifiChannel > Create(void) const
int64_t AssignStreams(Ptr< YansWifiChannel > c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by the channel.
Make it easy to create and manage PHY objects for the YANS model.
void SetChannel(Ptr< YansWifiChannel > channel)
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:849
Time Now(void)
create an ns3::Time instance which contains the current simulation time.
Definition: simulator.cc:287
#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:141
AodvRegressionTestSuite g_aodvRegressionTestSuite
the test suite
ChainRegressionTest(const char *const prefix, Time time=Seconds(10), uint32_t size=5, Time arpAliveTimeout=Seconds(120))
Create test case.
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1244
@ WIFI_STANDARD_80211a
address
Definition: first.py:44
devices
Definition: first.py:39
interfaces
Definition: first.py:48
Every class exported by the ns3 library is enclosed in the ns3 namespace.
wifi
Definition: third.py:99
mobility
Definition: third.py:107
#define NS_PCAP_TEST_EXPECT_EQ(filename)
Test that a pair of reference/new pcap files are equal.
Definition: pcap-test.h:38
static void SetPosition(Ptr< Node > node, Vector position)
Definition: wifi-ap.cc:89