A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
flame-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#include "flame-regression.h"
20
21#include "ns3/abort.h"
22#include "ns3/double.h"
23#include "ns3/internet-stack-helper.h"
24#include "ns3/ipv4-address-helper.h"
25#include "ns3/mesh-helper.h"
26#include "ns3/mobility-helper.h"
27#include "ns3/mobility-model.h"
28#include "ns3/pcap-test.h"
29#include "ns3/random-variable-stream.h"
30#include "ns3/rng-seed-manager.h"
31#include "ns3/simulator.h"
32#include "ns3/string.h"
33#include "ns3/uinteger.h"
34#include "ns3/yans-wifi-helper.h"
35
36#include <sstream>
37
38using namespace ns3;
39
41const char* const PREFIX = "flame-regression-test";
42
44 : TestCase("FLAME regression test"),
45 m_nodes(nullptr),
46 m_time(Seconds(10)),
47 m_sentPktsCounter(0)
48{
49}
50
52{
53 delete m_nodes;
54}
55
56void
58{
64
68
70
71 delete m_nodes, m_nodes = nullptr;
72}
73
74void
76{
78 m_nodes->Create(3);
79 MobilityHelper mobility;
80 mobility.SetPositionAllocator("ns3::GridPositionAllocator",
81 "MinX",
82 DoubleValue(0.0),
83 "MinY",
84 DoubleValue(0.0),
85 "DeltaX",
86 DoubleValue(120),
87 "DeltaY",
88 DoubleValue(0),
89 "GridWidth",
91 "LayoutType",
92 StringValue("RowFirst"));
93 mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
94 mobility.Install(*m_nodes);
95}
96
97void
99{
100 int64_t streamsUsed = 0;
101 // 1. setup WiFi
102 YansWifiPhyHelper wifiPhy;
103 // This test suite output was originally based on YansErrorRateModel
104 wifiPhy.SetErrorRateModel("ns3::YansErrorRateModel");
106 Ptr<YansWifiChannel> chan = wifiChannel.Create();
107 wifiPhy.SetChannel(chan);
108 // This test predates the preamble detection model
110
111 // 2. setup mesh
113 mesh.SetStackInstaller("ns3::FlameStack");
114 mesh.SetMacType("RandomStart", TimeValue(Seconds(0.1)));
115 mesh.SetNumberOfInterfaces(1);
116 NetDeviceContainer meshDevices = mesh.Install(wifiPhy, *m_nodes);
117 // Three devices, eight streams per device
118 streamsUsed += mesh.AssignStreams(meshDevices, streamsUsed);
119 NS_TEST_ASSERT_MSG_EQ(streamsUsed,
120 (meshDevices.GetN() * 8),
121 "Stream assignment unexpected value");
122 // No further streams used in the default wifi channel configuration
123 streamsUsed += wifiChannel.AssignStreams(chan, streamsUsed);
124 NS_TEST_ASSERT_MSG_EQ(streamsUsed,
125 (meshDevices.GetN() * 8),
126 "Stream assignment unexpected value");
127 // 3. setup TCP/IP
128 InternetStackHelper internetStack;
129 internetStack.Install(*m_nodes);
130 streamsUsed += internetStack.AssignStreams(*m_nodes, streamsUsed);
131 Ipv4AddressHelper address;
132 address.SetBase("10.1.1.0", "255.255.255.0");
133 m_interfaces = address.Assign(meshDevices);
134 // 4. write PCAP if needed
136}
137
138void
140{
141 // client socket
143 Socket::CreateSocket(m_nodes->Get(2), TypeId::LookupByName("ns3::UdpSocketFactory"));
148 Seconds(1.0),
150 this,
152
153 // server socket
155 Socket::CreateSocket(m_nodes->Get(0), TypeId::LookupByName("ns3::UdpSocketFactory"));
158}
159
160void
162{
163 for (int i = 0; i < 3; ++i)
164 {
165 NS_PCAP_TEST_EXPECT_EQ(PREFIX << "-" << i << "-1.pcap");
166 }
167}
168
169void
171{
172 if ((Simulator::Now() < m_time) && (m_sentPktsCounter < 300))
173 {
174 socket->Send(Create<Packet>(20));
176 Simulator::ScheduleWithContext(socket->GetNode()->GetId(),
177 Seconds(1.1),
179 this,
180 socket);
181 }
182}
183
184void
186{
187 Ptr<Packet> packet;
188 Address from;
189 while ((packet = socket->RecvFrom(from)))
190 {
191 packet->RemoveAllPacketTags();
192 packet->RemoveAllByteTags();
193
194 socket->SendTo(packet, 0, from);
195 }
196}
197
198void
200{
201 Ptr<Packet> packet;
202 Address from;
203 while ((packet = socket->RecvFrom(from)))
204 {
205 }
206}
Time m_time
Simulation time.
~FlameRegressionTest() override
void CheckResults()
Check results function.
void InstallApplications()
Install application function.
void CreateNodes()
Create nodes function.
Ptr< Socket > m_clientSocket
Client-side socket.
NodeContainer * m_nodes
void SendData(Ptr< Socket > socket)
Send data.
Ptr< Socket > m_serverSocket
Server-side socket.
void HandleReadClient(Ptr< Socket > socket)
Handle a packet reception.
void HandleReadServer(Ptr< Socket > socket)
Handle a packet reception.
Ipv4InterfaceContainer m_interfaces
Needed to install applications.
void CreateDevices()
Create devices function.
void DoRun() override
Implementation to actually run this TestCase.
uint32_t m_sentPktsCounter
sent packets counter
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.
static Ipv4Address GetAny()
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
static MeshHelper Default()
Set the helper to the default values for the MAC type, remote station manager and channel policy.
Definition: mesh-helper.cc:98
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 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
static void SetRun(uint64_t run)
Set the run number of simulation.
static void SetSeed(uint32_t seed)
Set the seed.
static void Destroy()
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:142
static void ScheduleWithContext(uint32_t context, const Time &delay, FUNC f, Ts &&... args)
Schedule an event with the given context.
Definition: simulator.h:588
static Time Now()
Return the current simulation virtual time.
Definition: simulator.cc:208
static void Run()
Run the simulation.
Definition: simulator.cc:178
static void Stop()
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:186
virtual int Connect(const Address &address)=0
Initiate a connection to a remote host.
void SetRecvCallback(Callback< void, Ptr< Socket > > receivedData)
Notify application when new data is available to be read.
Definition: socket.cc:128
static Ptr< Socket > CreateSocket(Ptr< Node > node, TypeId tid)
This method wraps the creation of sockets that is performed on a given node by a SocketFactory specif...
Definition: socket.cc:72
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
virtual Ptr< Node > GetNode() const =0
Return the node this socket is associated with.
Hold variables of type string.
Definition: string.h:56
encapsulates test code
Definition: test.h:1061
std::string CreateTempDirFilename(std::string filename)
Construct the full path to a file in a temporary directory.
Definition: test.cc:438
AttributeValue implementation for Time.
Definition: nstime.h:1413
static TypeId LookupByName(std::string name)
Get a TypeId by name.
Definition: type-id.cc:836
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.
static YansWifiChannelHelper Default()
Create a channel helper in a default working state.
Ptr< YansWifiChannel > Create() const
Make it easy to create and manage PHY objects for the YANS model.
void SetChannel(Ptr< YansWifiChannel > channel)
const char *const PREFIX
Unique PCAP file name prefix.
#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:145
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1326
const char *const PREFIX
Unique PCAP file name prefix.
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
#define NS_PCAP_TEST_EXPECT_EQ(filename)
Test that a pair of reference/new pcap files are equal.
Definition: pcap-test.h:39