A Discrete-Event Network Simulator
API
hwmp-target-flags-regression.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2009 IITP RAS
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Authors: Kirill Andreev <andreev@iitp.ru>
18  */
19 
21 
22 #include "ns3/abort.h"
23 #include "ns3/double.h"
24 #include "ns3/internet-stack-helper.h"
25 #include "ns3/ipv4-address-helper.h"
26 #include "ns3/mesh-helper.h"
27 #include "ns3/mobility-helper.h"
28 #include "ns3/mobility-model.h"
29 #include "ns3/pcap-test.h"
30 #include "ns3/random-variable-stream.h"
31 #include "ns3/rng-seed-manager.h"
32 #include "ns3/simulator.h"
33 #include "ns3/string.h"
34 #include "ns3/udp-echo-helper.h"
35 #include "ns3/uinteger.h"
36 #include "ns3/yans-wifi-helper.h"
37 
38 #include <sstream>
39 
40 using namespace ns3;
41 
43 const char* const PREFIX = "hwmp-target-flags-regression-test";
44 
46  : TestCase("HWMP target flags regression test"),
47  m_nodes(nullptr),
48  m_time(Seconds(5)),
49  m_sentPktsCounterA(0),
50  m_sentPktsCounterB(0),
51  m_sentPktsCounterC(0)
52 {
53 }
54 
56 {
57  delete m_nodes;
58 }
59 
60 void
62 {
63  RngSeedManager::SetSeed(1);
64  RngSeedManager::SetRun(1);
65  CreateNodes();
66  CreateDevices();
68 
69  Simulator::Stop(m_time);
70  Simulator::Run();
71  Simulator::Destroy();
72 
73  CheckResults();
74 
75  delete m_nodes, m_nodes = nullptr;
76 }
77 
78 void
80 {
81  m_nodes = new NodeContainer;
82  m_nodes->Create(4);
84  mobility.SetPositionAllocator("ns3::GridPositionAllocator",
85  "MinX",
86  DoubleValue(0.0),
87  "MinY",
88  DoubleValue(0.0),
89  "DeltaX",
90  DoubleValue(100),
91  "DeltaY",
92  DoubleValue(0),
93  "GridWidth",
94  UintegerValue(4),
95  "LayoutType",
96  StringValue("RowFirst"));
97  mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
98  mobility.Install(*m_nodes);
99 }
100 
101 void
103 {
104  // server socket A
106  Socket::CreateSocket(m_nodes->Get(0), TypeId::LookupByName("ns3::UdpSocketFactory"));
107  m_serverSocketA->Bind(InetSocketAddress(Ipv4Address::GetAny(), 9));
109 
110  // server socket B
112  Socket::CreateSocket(m_nodes->Get(3), TypeId::LookupByName("ns3::UdpSocketFactory"));
113  m_serverSocketB->Bind(InetSocketAddress(Ipv4Address::GetAny(), 10));
115 
116  // client socket A
118  Socket::CreateSocket(m_nodes->Get(1), TypeId::LookupByName("ns3::UdpSocketFactory"));
122  Simulator::ScheduleWithContext(m_clientSocketA->GetNode()->GetId(),
123  Seconds(2.2),
125  this,
127 
128  // client socket B
130  Socket::CreateSocket(m_nodes->Get(2), TypeId::LookupByName("ns3::UdpSocketFactory"));
134  Simulator::ScheduleWithContext(m_clientSocketB->GetNode()->GetId(),
135  Seconds(2.0),
137  this,
139 
140  // client socket C
142  Socket::CreateSocket(m_nodes->Get(0), TypeId::LookupByName("ns3::UdpSocketFactory"));
146  Simulator::ScheduleWithContext(m_clientSocketB->GetNode()->GetId(),
147  Seconds(2.4),
149  this,
151 }
152 
153 void
155 {
156  int64_t streamsUsed = 0;
157  // 1. setup WiFi
158  YansWifiPhyHelper wifiPhy;
159  // This test suite output was originally based on YansErrorRateModel
160  wifiPhy.SetErrorRateModel("ns3::YansErrorRateModel");
161  YansWifiChannelHelper wifiChannel = YansWifiChannelHelper::Default();
162  Ptr<YansWifiChannel> chan = wifiChannel.Create();
163  wifiPhy.SetChannel(chan);
164  // This scenario setup predates the preamble detection model
166 
167  // 2. setup mesh
168  MeshHelper mesh = MeshHelper::Default();
169  mesh.SetStackInstaller("ns3::Dot11sStack");
170  mesh.SetMacType("RandomStart", TimeValue(Seconds(0.1)));
171  mesh.SetNumberOfInterfaces(1);
172  NetDeviceContainer meshDevices = mesh.Install(wifiPhy, *m_nodes);
173  // Four devices, ten streams per mac
174  streamsUsed += mesh.AssignStreams(meshDevices, streamsUsed);
175  NS_TEST_ASSERT_MSG_EQ(streamsUsed, (meshDevices.GetN() * 10), "Stream assignment mismatch");
176  streamsUsed += wifiChannel.AssignStreams(chan, streamsUsed);
177  NS_TEST_ASSERT_MSG_EQ(streamsUsed, (meshDevices.GetN() * 10), "Stream assignment mismatch");
178 
179  // 3. setup TCP/IP
180  InternetStackHelper internetStack;
181  internetStack.Install(*m_nodes);
182  streamsUsed += internetStack.AssignStreams(*m_nodes, streamsUsed);
184  address.SetBase("10.1.1.0", "255.255.255.0");
185  m_interfaces = address.Assign(meshDevices);
186  // 4. write PCAP if needed
188 }
189 
190 void
192 {
193  for (int i = 0; i < 4; ++i)
194  {
195  NS_PCAP_TEST_EXPECT_EQ(PREFIX << "-" << i << "-1.pcap");
196  }
197 }
198 
199 void
201 {
202  if ((Simulator::Now() < m_time) && (m_sentPktsCounterA < 300))
203  {
204  socket->Send(Create<Packet>(100));
206  Simulator::ScheduleWithContext(socket->GetNode()->GetId(),
207  Seconds(1.0),
209  this,
210  socket);
211  }
212 }
213 
214 void
216 {
217  if ((Simulator::Now() < m_time) && (m_sentPktsCounterA < 300))
218  {
219  socket->Send(Create<Packet>(100));
221  Simulator::ScheduleWithContext(socket->GetNode()->GetId(),
222  Seconds(1.0),
224  this,
225  socket);
226  }
227 }
228 
229 void
231 {
232  if ((Simulator::Now() < m_time) && (m_sentPktsCounterA < 300))
233  {
234  socket->Send(Create<Packet>(100));
236  Simulator::ScheduleWithContext(socket->GetNode()->GetId(),
237  Seconds(1.0),
239  this,
240  socket);
241  }
242 }
243 
244 void
246 {
247  Ptr<Packet> packet;
248  Address from;
249  while ((packet = socket->RecvFrom(from)))
250  {
251  packet->RemoveAllPacketTags();
252  packet->RemoveAllByteTags();
253 
254  socket->SendTo(packet, 0, from);
255  }
256 }
257 
258 void
260 {
261  Ptr<Packet> packet;
262  Address from;
263  while ((packet = socket->RecvFrom(from)))
264  {
265  }
266 }
void SendDataA(Ptr< Socket > socket)
Send data A.
void HandleReadClient(Ptr< Socket > socket)
Handle a packet reception.
void DoRun() override
Implementation to actually run this TestCase.
Ptr< Socket > m_serverSocketA
Server-side socket.
void CreateDevices()
Create devices function.
void SendDataC(Ptr< Socket > socket)
Send data C.
uint32_t m_sentPktsCounterA
sent packets counter A
void CheckResults()
Check results function.
Ptr< Socket > m_serverSocketB
Server-side socket.
void SendDataB(Ptr< Socket > socket)
Send data B.
uint32_t m_sentPktsCounterC
sent packets counter C
Ptr< Socket > m_clientSocketA
Client-side socket.
void HandleReadServer(Ptr< Socket > socket)
Handle a packet reception.
void InstallApplications()
Install application function.
Ipv4InterfaceContainer m_interfaces
interfaces
void CreateNodes()
Create nodes function.
uint32_t m_sentPktsCounterB
sent packets counter B
Ptr< Socket > m_clientSocketB
Client-side socket.
a polymophic address class
Definition: address.h:101
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition: double.h:42
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...
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.
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
Helper to create IEEE 802.11s mesh networks.
Definition: mesh-helper.h:44
void SetStackInstaller(std::string type, Ts &&... args)
Set the MeshStack type to use.
Definition: mesh-helper.h:210
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:178
void SetMacType(Ts &&... args)
Set the Mac Attributes.
Definition: mesh-helper.h:195
NetDeviceContainer Install(const WifiPhyHelper &phyHelper, NodeContainer c) const
Install 802.11s mesh device & protocols on given node list.
Definition: mesh-helper.cc:63
void SetNumberOfInterfaces(uint32_t nInterfaces)
Set a number of interfaces in a mesh network.
Definition: mesh-helper.cc:57
Helper class used to assign positions and mobility models to nodes.
holds a vector of ns3::NetDevice pointers
uint32_t GetN() const
Get the number of Ptr<NetDevice> stored in this container.
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.
uint32_t GetId() const
Definition: node.cc:117
void RemoveAllByteTags()
Remove all byte tags stored in this packet.
Definition: packet.cc:393
void RemoveAllPacketTags()
Remove all packet tags.
Definition: packet.cc:990
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 ...
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
virtual int Send(Ptr< Packet > p, uint32_t flags)=0
Send data (or dummy data) to the remote host.
void SetRecvCallback(Callback< void, Ptr< Socket >> receivedData)
Notify application when new data is available to be read.
Definition: socket.cc:128
virtual int Connect(const Address &address)=0
Initiate a connection to a remote host.
virtual Ptr< Node > GetNode() const =0
Return the node this socket is associated with.
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
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 SendTo(Ptr< Packet > p, uint32_t flags, const Address &toAddress)=0
Send data to a specified peer.
Hold variables of type string.
Definition: string.h:56
encapsulates test code
Definition: test.h:1060
std::string CreateTempDirFilename(std::string filename)
Construct the full path to a file in a temporary directory.
Definition: test.cc:438
Hold an unsigned integer type.
Definition: uinteger.h:45
void DisablePreambleDetectionModel()
Disable the preamble detection model on all links.
Definition: wifi-helper.cc:178
void SetErrorRateModel(std::string type, Args &&... args)
Helper function used to set the error rate model.
Definition: wifi-helper.h:550
manage and create wifi channel objects for the YANS model.
int64_t AssignStreams(Ptr< YansWifiChannel > c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by the channel.
Ptr< YansWifiChannel > Create() const
Make it easy to create and manage PHY objects for the YANS model.
void SetChannel(Ptr< YansWifiChannel > channel)
Time Now()
create an ns3::Time instance which contains the current simulation time.
Definition: simulator.cc:305
#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:144
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1326
const char *const PREFIX
Unique PCAP file name prefix.
address
Definition: first.py:47
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Callback< R, Args... > MakeCallback(R(T::*memPtr)(Args...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
Definition: callback.h:704
mobility
Definition: third.py:105
#define NS_PCAP_TEST_EXPECT_EQ(filename)
Test that a pair of reference/new pcap files are equal.
Definition: pcap-test.h:39
double m_time
Definition: qkd_etsi_014.cc:62