A Discrete-Event Network Simulator
API
hwmp-reactive-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: Kirill Andreev <andreev@iitp.ru>
19  */
20 
21 #include "ns3/mesh-helper.h"
22 #include "ns3/simulator.h"
23 #include "ns3/random-variable-stream.h"
24 #include "ns3/rng-seed-manager.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/yans-wifi-helper.h"
30 #include "ns3/internet-stack-helper.h"
31 #include "ns3/ipv4-address-helper.h"
32 #include "ns3/abort.h"
33 #include "ns3/mobility-model.h"
34 #include "ns3/pcap-test.h"
35 #include <sstream>
36 
38 
40 const char * const PREFIX = "hwmp-reactive-regression-test";
41 
42 HwmpReactiveRegressionTest::HwmpReactiveRegressionTest () : TestCase ("HWMP on-demand regression test"),
43  m_nodes (0),
44  m_time (Seconds (10)),
45  m_sentPktsCounter (0)
46 {
47 }
49 {
50  delete m_nodes;
51 }
52 void
54 {
55  RngSeedManager::SetSeed (12345);
56  // This test is somewhat sensitive to seed selection, since the nodes
57  // are on the fringe of reception range from one another (to create
58  // a multi-hop topology). Some seeds may yield no data transfer because
59  // ARP resolution across the mesh may fail too many times
60  RngSeedManager::SetRun (1);
61  CreateNodes ();
62  CreateDevices ();
64 
65  Simulator::Stop (m_time);
66  Simulator::Run ();
67  Simulator::Destroy ();
68 
69  CheckResults ();
70  delete m_nodes, m_nodes = 0;
71 }
72 void
74 {
75  m_nodes = new NodeContainer;
76  m_nodes->Create (6);
78  Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator>();
79  positionAlloc->Add (Vector ( 0, 0, 0));
80  positionAlloc->Add (Vector ( 0, 150, 0));
81  positionAlloc->Add (Vector ( 0, 300, 0));
82  positionAlloc->Add (Vector ( 0, 450, 0));
83  positionAlloc->Add (Vector ( 0, 600, 0));
84  positionAlloc->Add (Vector ( 0, 750, 0));
85  mobility.SetPositionAllocator (positionAlloc);
86  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
87  mobility.Install (*m_nodes);
88  Simulator::Schedule (Seconds (5.0), &HwmpReactiveRegressionTest::ResetPosition, this);
89 }
90 void
92 {
93  // client socket
94  m_clientSocket = Socket::CreateSocket (m_nodes->Get (5), TypeId::LookupByName ("ns3::UdpSocketFactory"));
95  m_clientSocket->Bind ();
98  Simulator::ScheduleWithContext (m_clientSocket->GetNode ()->GetId (), Seconds (2.0),
100 
101  // server socket
102  m_serverSocket = Socket::CreateSocket (m_nodes->Get (0), TypeId::LookupByName ("ns3::UdpSocketFactory"));
103  m_serverSocket->Bind (InetSocketAddress (Ipv4Address::GetAny (), 9));
105 }
106 void
108 {
109  int64_t streamsUsed = 0;
110  // 1. setup WiFi
111  YansWifiPhyHelper wifiPhy = YansWifiPhyHelper::Default ();
112  // This test suite output was originally based on YansErrorRateModel
113  wifiPhy.SetErrorRateModel ("ns3::YansErrorRateModel");
114  YansWifiChannelHelper wifiChannel = YansWifiChannelHelper::Default ();
115  Ptr<YansWifiChannel> chan = wifiChannel.Create ();
116  wifiPhy.SetChannel (chan);
117 
118  // 2. setup mesh
119  MeshHelper mesh = MeshHelper::Default ();
120  mesh.SetStackInstaller ("ns3::Dot11sStack");
121  mesh.SetMacType ("RandomStart", TimeValue (Seconds (0.1)));
122  mesh.SetNumberOfInterfaces (1);
123  NetDeviceContainer meshDevices = mesh.Install (wifiPhy, *m_nodes);
124  // Six devices, 4 streams per device
125  streamsUsed += mesh.AssignStreams (meshDevices, streamsUsed);
126  NS_TEST_EXPECT_MSG_EQ (streamsUsed, (meshDevices.GetN () * 9), "Stream assignment mismatch");
127  streamsUsed += wifiChannel.AssignStreams (chan, streamsUsed);
128  NS_TEST_EXPECT_MSG_EQ (streamsUsed, (meshDevices.GetN () * 9), "Stream assignment mismatch");
129 
130  // 3. setup TCP/IP
131  InternetStackHelper internetStack;
132  internetStack.Install (*m_nodes);
133  streamsUsed += internetStack.AssignStreams (*m_nodes, streamsUsed);
135  address.SetBase ("10.1.1.0", "255.255.255.0");
136  m_interfaces = address.Assign (meshDevices);
137  // 4. write PCAP if needed
139 }
140 
141 void
143 {
144  for (int i = 0; i < 6; ++i)
145  {
146  NS_PCAP_TEST_EXPECT_EQ (PREFIX << "-" << i << "-1.pcap");
147  }
148 }
149 
150 void
152 {
153  Ptr<Object> object = m_nodes->Get (3);
154  Ptr<MobilityModel> model = object->GetObject<MobilityModel> ();
155  if (model == 0)
156  {
157  return;
158  }
159  model->SetPosition (Vector (9000, 0, 0));
160 }
161 
162 void
164 {
165  if ((Simulator::Now () < m_time) && (m_sentPktsCounter < 300))
166  {
167  socket->Send (Create<Packet> (20));
169  Simulator::ScheduleWithContext (socket->GetNode ()->GetId (), Seconds (0.5),
170  &HwmpReactiveRegressionTest::SendData, this, socket);
171  }
172 }
173 
174 void
176 {
177  Ptr<Packet> packet;
178  Address from;
179  while ((packet = socket->RecvFrom (from)))
180  {
181  packet->RemoveAllPacketTags ();
182  packet->RemoveAllByteTags ();
183 
184  socket->SendTo (packet, 0, from);
185  }
186 }
187 
188 void
190 {
191  Ptr<Packet> packet;
192  Address from;
193  while ((packet = socket->RecvFrom (from)))
194  {
195  }
196 }
void CreateDevices()
Create devices function.
void ResetPosition()
Reset position function.
an Inet address class
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
uint32_t GetId(void) const
Definition: node.cc:107
void SendData(Ptr< Socket > socket)
Send data.
Make it easy to create and manage PHY objects for the YANS model.
void CreateNodes()
Create nodes function.
aggregate IP/TCP/UDP functionality to existing Nodes.
#define NS_TEST_EXPECT_MSG_EQ(actual, limit, msg)
Test that an actual and expected (limit) value are equal and report if not.
Definition: test.h:283
encapsulates test code
Definition: test.h:1153
#define NS_PCAP_TEST_EXPECT_EQ(filename)
Test that a pair of reference/new pcap files are equal.
Definition: pcap-test.h:38
void SetNumberOfInterfaces(uint32_t nInterfaces)
Set a number of interfaces in a mesh network.
Definition: mesh-helper.cc:79
a polymophic address class
Definition: address.h:90
Ptr< YansWifiChannel > Create(void) const
mobility
Definition: third.py:108
Keep track of the current position and velocity of an object.
void SetChannel(Ptr< YansWifiChannel > channel)
void RemoveAllPacketTags(void)
Remove all packet tags.
Definition: packet.cc:891
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 ...
AttributeValue implementation for Time.
Definition: nstime.h:1132
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
void HandleReadClient(Ptr< Socket > socket)
Handle a packet reception.
holds a vector of ns3::NetDevice pointers
Callback< R > MakeCallback(R(T::*memPtr)(void), OBJ objPtr)
Definition: callback.h:1610
Ptr< Socket > m_serverSocket
Server-side socket.
void SetRecvCallback(Callback< void, Ptr< Socket > >)
Notify application when new data is available to be read.
Definition: socket.cc:128
void SetMacType(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: mesh-helper.cc:132
virtual int Connect(const Address &address)=0
Initiate a connection to a remote host.
Ptr< T > GetObject(void) const
Get a pointer to the requested aggregated Object.
Definition: object.h:464
const char *const PREFIX
Unique PCAP file name prefix.
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
keep track of a set of node pointers.
address
Definition: first.py:44
void HandleReadServer(Ptr< Socket > socket)
Handle a packet reception.
virtual void DoRun()
Implementation to actually run this TestCase.
manage and create wifi channel objects for the YANS model.
Ptr< Socket > m_clientSocket
Client-side socket.
int64_t AssignStreams(NetDeviceContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model...
Definition: mesh-helper.cc:268
void SetStackInstaller(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: mesh-helper.cc:51
void InstallApplications()
Install application function.
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())
Definition: wifi-helper.cc:149
void SetPosition(const Vector &position)
void Install(std::string nodeName) const
Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provid...
Helper class used to assign positions and mobility models to nodes.
NetDeviceContainer Install(const WifiPhyHelper &phyHelper, NodeContainer c) const
Install 802.11s mesh device & protocols on given node list.
Definition: mesh-helper.cc:84
int64_t AssignStreams(NodeContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model...
virtual Ptr< Node > GetNode(void) const =0
Return the node this socket is associated with.
std::string CreateTempDirFilename(std::string filename)
Construct the full path to a file in a temporary directory.
Definition: test.cc:430
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1070
uint32_t GetN(void) const
Get the number of Ptr<NetDevice> stored in this container.
void RemoveAllByteTags(void)
Remove all byte tags stored in this packet.
Definition: packet.cc:371
void Add(Vector v)
Add a position to the list of positions.
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
Ipv4InterfaceContainer m_interfaces
interfaces
virtual int SendTo(Ptr< Packet > p, uint32_t flags, const Address &toAddress)=0
Send data to a specified peer.
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
Time Now(void)
create an ns3::Time instance which contains the current simulation time.
Definition: simulator.cc:309
uint32_t m_sentPktsCounter
sent packets counter
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
Helper to create IEEE 802.11s mesh networks.
Definition: mesh-helper.h:43
virtual Ptr< Packet > RecvFrom(uint32_t maxSize, uint32_t flags, Address &fromAddress)=0
Read a single packet from the socket and retrieve the sender address.
virtual int Send(Ptr< Packet > p, uint32_t flags)=0
Send data (or dummy data) to the remote host.
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 CheckResults()
Check results function.