A Discrete-Event Network Simulator
API
hwmp-target-flags-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/udp-echo-helper.h"
34 #include "ns3/mobility-model.h"
35 #include "ns3/pcap-test.h"
36 #include <sstream>
38 
39 using namespace ns3;
40 
42 const char * const PREFIX = "hwmp-target-flags-regression-test";
43 
44 
45 HwmpDoRfRegressionTest::HwmpDoRfRegressionTest () : TestCase ("HWMP target flags regression test"),
46  m_nodes (0),
47  m_time (Seconds (5)),
48  m_sentPktsCounterA (0),
49  m_sentPktsCounterB (0),
50  m_sentPktsCounterC (0)
51 {
52 }
53 
55 {
56  delete m_nodes;
57 }
58 
59 void
61 {
62  RngSeedManager::SetSeed (12345);
63  RngSeedManager::SetRun (7);
64  CreateNodes ();
65  CreateDevices ();
67 
68  Simulator::Stop (m_time);
69  Simulator::Run ();
70  Simulator::Destroy ();
71 
72  CheckResults ();
73 
74  delete m_nodes, m_nodes = 0;
75 }
76 
77 void
79 {
80  m_nodes = new NodeContainer;
81  m_nodes->Create (4);
83  mobility.SetPositionAllocator ("ns3::GridPositionAllocator",
84  "MinX", DoubleValue (0.0),
85  "MinY", DoubleValue (0.0),
86  "DeltaX", DoubleValue (100),
87  "DeltaY", DoubleValue (0),
88  "GridWidth", UintegerValue (4),
89  "LayoutType", StringValue ("RowFirst"));
90  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
91  mobility.Install (*m_nodes);
92 }
93 
94 void
96 {
97  // server socket A
98  m_serverSocketA = Socket::CreateSocket (m_nodes->Get (0), TypeId::LookupByName ("ns3::UdpSocketFactory"));
99  m_serverSocketA->Bind (InetSocketAddress (Ipv4Address::GetAny (), 9));
101 
102  // server socket B
103  m_serverSocketB = Socket::CreateSocket (m_nodes->Get (3), TypeId::LookupByName ("ns3::UdpSocketFactory"));
104  m_serverSocketB->Bind (InetSocketAddress (Ipv4Address::GetAny (), 10));
106 
107  // client socket A
108  m_clientSocketA = Socket::CreateSocket (m_nodes->Get (1), TypeId::LookupByName ("ns3::UdpSocketFactory"));
109  m_clientSocketA->Bind ();
112  Simulator::ScheduleWithContext (m_clientSocketA->GetNode ()->GetId (), Seconds (2.2),
114 
115  // client socket B
116  m_clientSocketB = Socket::CreateSocket (m_nodes->Get (2), TypeId::LookupByName ("ns3::UdpSocketFactory"));
117  m_clientSocketB->Bind ();
120  Simulator::ScheduleWithContext (m_clientSocketB->GetNode ()->GetId (), Seconds (2.0),
122 
123  // client socket C
124  m_clientSocketB = Socket::CreateSocket (m_nodes->Get (0), TypeId::LookupByName ("ns3::UdpSocketFactory"));
125  m_clientSocketB->Bind ();
128  Simulator::ScheduleWithContext (m_clientSocketB->GetNode ()->GetId (), Seconds (2.4),
130 }
131 
132 void
134 {
135  int64_t streamsUsed = 0;
136  // 1. setup WiFi
137  YansWifiPhyHelper wifiPhy = YansWifiPhyHelper::Default ();
138  // This test suite output was originally based on YansErrorRateModel
139  wifiPhy.SetErrorRateModel ("ns3::YansErrorRateModel");
140  YansWifiChannelHelper wifiChannel = YansWifiChannelHelper::Default ();
141  Ptr<YansWifiChannel> chan = wifiChannel.Create ();
142  wifiPhy.SetChannel (chan);
143 
144  // 2. setup mesh
145  MeshHelper mesh = MeshHelper::Default ();
146  mesh.SetStackInstaller ("ns3::Dot11sStack");
147  mesh.SetMacType ("RandomStart", TimeValue (Seconds (0.1)));
148  mesh.SetNumberOfInterfaces (1);
149  NetDeviceContainer meshDevices = mesh.Install (wifiPhy, *m_nodes);
150  // Four devices, nine streams per mac
151  streamsUsed += mesh.AssignStreams (meshDevices, streamsUsed);
152  NS_TEST_ASSERT_MSG_EQ (streamsUsed, (meshDevices.GetN () * 9), "Stream assignment mismatch");
153  streamsUsed += wifiChannel.AssignStreams (chan, streamsUsed);
154  NS_TEST_ASSERT_MSG_EQ (streamsUsed, (meshDevices.GetN () * 9), "Stream assignment mismatch");
155 
156  // 3. setup TCP/IP
157  InternetStackHelper internetStack;
158  internetStack.Install (*m_nodes);
159  streamsUsed += internetStack.AssignStreams (*m_nodes, streamsUsed);
161  address.SetBase ("10.1.1.0", "255.255.255.0");
162  m_interfaces = address.Assign (meshDevices);
163  // 4. write PCAP if needed
165 }
166 
167 void
169 {
170  for (int i = 0; i < 4; ++i)
171  {
172  NS_PCAP_TEST_EXPECT_EQ (PREFIX << "-" << i << "-1.pcap");
173  }
174 }
175 
176 void
178 {
179  if ((Simulator::Now () < m_time) && (m_sentPktsCounterA < 300))
180  {
181  socket->Send (Create<Packet> (100));
183  Simulator::ScheduleWithContext (socket->GetNode ()->GetId (), Seconds (1.0),
184  &HwmpDoRfRegressionTest::SendDataA, this, socket);
185  }
186 }
187 
188 void
190 {
191  if ((Simulator::Now () < m_time) && (m_sentPktsCounterA < 300))
192  {
193  socket->Send (Create<Packet> (100));
195  Simulator::ScheduleWithContext (socket->GetNode ()->GetId (), Seconds (1.0),
196  &HwmpDoRfRegressionTest::SendDataB, this, socket);
197  }
198 }
199 
200 void
202 {
203  if ((Simulator::Now () < m_time) && (m_sentPktsCounterA < 300))
204  {
205  socket->Send (Create<Packet> (100));
207  Simulator::ScheduleWithContext (socket->GetNode ()->GetId (), Seconds (1.0),
208  &HwmpDoRfRegressionTest::SendDataC, this, socket);
209  }
210 }
211 
212 void
214 {
215  Ptr<Packet> packet;
216  Address from;
217  while ((packet = socket->RecvFrom (from)))
218  {
219  packet->RemoveAllPacketTags ();
220  packet->RemoveAllByteTags ();
221 
222  socket->SendTo (packet, 0, from);
223  }
224 }
225 
226 void
228 {
229  Ptr<Packet> packet;
230  Address from;
231  while ((packet = socket->RecvFrom (from)))
232  {
233  }
234 }
uint32_t m_sentPktsCounterA
sent packets counter A
Ptr< Socket > m_serverSocketB
Server-side socket.
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
Hold variables of type string.
Definition: string.h:41
Make it easy to create and manage PHY objects for the yans model.
void CreateDevices()
Create devices function.
aggregate IP/TCP/UDP functionality to existing Nodes.
uint32_t m_sentPktsCounterC
sent packets counter C
const char *const PREFIX
Unique PCAP file name prefix.
void SendDataB(Ptr< Socket > socket)
Send data B.
encapsulates test code
Definition: test.h:1153
uint32_t m_sentPktsCounterB
sent packets counter B
#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
void SetChannel(Ptr< YansWifiChannel > channel)
void InstallApplications()
Install application function.
void RemoveAllPacketTags(void)
Remove all packet tags.
Definition: packet.cc:891
void HandleReadServer(Ptr< Socket > socket)
Handle a packet reception.
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:1126
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
void HandleReadClient(Ptr< Socket > socket)
Handle a packet reception.
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:166
void CreateNodes()
Create nodes function.
holds a vector of ns3::NetDevice pointers
virtual void DoRun()
Implementation to actually run this TestCase.
Callback< R > MakeCallback(R(T::*memPtr)(void), OBJ objPtr)
Definition: callback.h:1610
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< Socket > m_clientSocketB
Client-side socket.
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
keep track of a set of node pointers.
address
Definition: first.py:44
Ptr< Socket > m_clientSocketA
Client-side socket.
manage and create wifi channel objects for the yans model.
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 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 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:1064
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
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
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
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.
Ipv4InterfaceContainer m_interfaces
interfaces
This class can be used to hold variables of floating point type such as &#39;double&#39; or &#39;float&#39;...
Definition: double.h:41
Ptr< Socket > m_serverSocketA
Server-side socket.
void SendDataC(Ptr< Socket > socket)
Send data C.
void CheckResults()
Check results function.
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 SendDataA(Ptr< Socket > socket)
Send data A.