A Discrete-Event Network Simulator
API
hwmp-simplest-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/uinteger.h"
35 #include "ns3/yans-wifi-helper.h"
36 
37 #include <sstream>
38 
39 using namespace ns3;
40 
42 const char* const PREFIX = "hwmp-simplest-regression-test";
43 
45  : TestCase("Simplest HWMP regression test"),
46  m_nodes(nullptr),
47  m_time(Seconds(15)),
48  m_sentPktsCounter(0)
49 {
50 }
51 
53 {
54  delete m_nodes;
55 }
56 
57 void
59 {
60  RngSeedManager::SetSeed(1);
61  RngSeedManager::SetRun(1);
62  CreateNodes();
63  CreateDevices();
65 
66  Simulator::Stop(m_time);
67  Simulator::Run();
68  Simulator::Destroy();
69 
70  CheckResults();
71 
72  delete m_nodes, m_nodes = nullptr;
73 }
74 
75 void
77 {
78  m_nodes = new NodeContainer;
79  m_nodes->Create(2);
81  mobility.SetPositionAllocator("ns3::GridPositionAllocator",
82  "MinX",
83  DoubleValue(0.0),
84  "MinY",
85  DoubleValue(0.0),
86  "DeltaX",
87  DoubleValue(1 /*meter*/),
88  "DeltaY",
89  DoubleValue(0),
90  "GridWidth",
91  UintegerValue(2),
92  "LayoutType",
93  StringValue("RowFirst"));
94  mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
95  mobility.Install(*m_nodes);
96  Simulator::Schedule(Seconds(10.0), &HwmpSimplestRegressionTest::ResetPosition, this);
97 }
98 
99 void
101 {
102  Ptr<Object> object = m_nodes->Get(1);
103  Ptr<MobilityModel> model = object->GetObject<MobilityModel>();
104  if (!model)
105  {
106  return;
107  }
108  model->SetPosition(Vector(9000, 0, 0));
109 }
110 
111 void
113 {
114  // client socket
116  Socket::CreateSocket(m_nodes->Get(1), TypeId::LookupByName("ns3::UdpSocketFactory"));
117  m_clientSocket->Bind();
121  Simulator::ScheduleWithContext(m_clientSocket->GetNode()->GetId(),
122  Seconds(2.0),
124  this,
126 
127  // server socket
129  Socket::CreateSocket(m_nodes->Get(0), TypeId::LookupByName("ns3::UdpSocketFactory"));
130  m_serverSocket->Bind(InetSocketAddress(Ipv4Address::GetAny(), 9));
133 }
134 
135 void
137 {
138  int64_t streamsUsed = 0;
139  // 1. setup WiFi
140  YansWifiPhyHelper wifiPhy;
141  YansWifiChannelHelper wifiChannel = YansWifiChannelHelper::Default();
142  Ptr<YansWifiChannel> chan = wifiChannel.Create();
143  wifiPhy.SetChannel(chan);
144 
145  // 2. setup mesh
146  MeshHelper mesh = MeshHelper::Default();
147  mesh.SetStackInstaller("ns3::Dot11sStack");
148  mesh.SetMacType("RandomStart", TimeValue(Seconds(0.1)));
149  mesh.SetNumberOfInterfaces(1);
150  NetDeviceContainer meshDevices = mesh.Install(wifiPhy, *m_nodes);
151  // Two devices, ten streams per mesh device
152  streamsUsed += mesh.AssignStreams(meshDevices, streamsUsed);
153  NS_TEST_ASSERT_MSG_EQ(streamsUsed, (meshDevices.GetN() * 10), "Stream assignment mismatch");
154  streamsUsed += wifiChannel.AssignStreams(chan, streamsUsed);
155  NS_TEST_ASSERT_MSG_EQ(streamsUsed, (meshDevices.GetN() * 10), "Stream assignment mismatch");
156 
157  // 3. setup TCP/IP
158  InternetStackHelper internetStack;
159  internetStack.Install(*m_nodes);
160  streamsUsed += internetStack.AssignStreams(*m_nodes, streamsUsed);
162  address.SetBase("10.1.1.0", "255.255.255.0");
163  m_interfaces = address.Assign(meshDevices);
164  // 4. write PCAP if needed
166 }
167 
168 void
170 {
171  for (int i = 0; i < 2; ++i)
172  {
173  NS_PCAP_TEST_EXPECT_EQ(PREFIX << "-" << i << "-1.pcap");
174  }
175 }
176 
177 void
179 {
180  if ((Simulator::Now() < m_time) && (m_sentPktsCounter < 300))
181  {
182  socket->Send(Create<Packet>(100));
184  Simulator::ScheduleWithContext(socket->GetNode()->GetId(),
185  Seconds(0.05),
187  this,
188  socket);
189  }
190 }
191 
192 void
194 {
195  Ptr<Packet> packet;
196  Address from;
197  while ((packet = socket->RecvFrom(from)))
198  {
199  packet->RemoveAllPacketTags();
200  packet->RemoveAllByteTags();
201 
202  socket->SendTo(packet, 0, from);
203  }
204 }
205 
206 void
208 {
209  Ptr<Packet> packet;
210  Address from;
211  while ((packet = socket->RecvFrom(from)))
212  {
213  }
214 }
void HandleReadClient(Ptr< Socket > socket)
Handle a packet reception.
void DoRun() override
Implementation to actually run this TestCase.
Ipv4InterfaceContainer m_interfaces
interfaces
void CheckResults()
Check results function.
void HandleReadServer(Ptr< Socket > socket)
Handle a packet reception.
void CreateDevices()
Create devices function.
Ptr< Socket > m_serverSocket
Server-side socket.
void CreateNodes()
Create nodes function.
void InstallApplications()
Install application function.
void SendData(Ptr< Socket > socket)
Send data.
uint32_t m_sentPktsCounter
sent packets counter
Ptr< Socket > m_clientSocket
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.
Keep track of the current position and velocity of an object.
void SetPosition(const Vector &position)
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
Ptr< T > GetObject() const
Get a pointer to the requested aggregated Object.
Definition: object.h:471
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 ...
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
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