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 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 * Authors: Kirill Andreev <andreev@iitp.ru>
7 */
8#include "flame-regression.h"
9
10#include "ns3/abort.h"
11#include "ns3/double.h"
12#include "ns3/internet-stack-helper.h"
13#include "ns3/ipv4-address-helper.h"
14#include "ns3/mesh-helper.h"
15#include "ns3/mobility-helper.h"
16#include "ns3/mobility-model.h"
17#include "ns3/pcap-test.h"
18#include "ns3/random-variable-stream.h"
19#include "ns3/rng-seed-manager.h"
20#include "ns3/simulator.h"
21#include "ns3/string.h"
22#include "ns3/uinteger.h"
23#include "ns3/yans-wifi-helper.h"
24
25#include <sstream>
26
27using namespace ns3;
28
29/// Unique PCAP file name prefix
30const char* const PREFIX = "flame-regression-test";
31
33 : TestCase("FLAME regression test"),
34 m_nodes(nullptr),
35 m_time(Seconds(10)),
36 m_sentPktsCounter(0)
37{
38}
39
44
45void
62
63void
65{
67 m_nodes->Create(3);
68 MobilityHelper mobility;
69 mobility.SetPositionAllocator("ns3::GridPositionAllocator",
70 "MinX",
71 DoubleValue(0.0),
72 "MinY",
73 DoubleValue(0.0),
74 "DeltaX",
75 DoubleValue(120),
76 "DeltaY",
77 DoubleValue(0),
78 "GridWidth",
80 "LayoutType",
81 StringValue("RowFirst"));
82 mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
83 mobility.Install(*m_nodes);
84}
85
86void
88{
89 int64_t streamsUsed = 0;
90 // 1. setup WiFi
91 YansWifiPhyHelper wifiPhy;
92 // This test suite output was originally based on YansErrorRateModel
93 wifiPhy.SetErrorRateModel("ns3::YansErrorRateModel");
95 Ptr<YansWifiChannel> chan = wifiChannel.Create();
96 wifiPhy.SetChannel(chan);
97 // This test predates the preamble detection model
99
100 // 2. setup mesh
102 mesh.SetStackInstaller("ns3::FlameStack");
103 mesh.SetMacType("RandomStart", TimeValue(Seconds(0.1)));
104 mesh.SetNumberOfInterfaces(1);
105 NetDeviceContainer meshDevices = mesh.Install(wifiPhy, *m_nodes);
106 // Three devices, eight streams per device
107 streamsUsed += mesh.AssignStreams(meshDevices, streamsUsed);
108 NS_TEST_ASSERT_MSG_EQ(streamsUsed,
109 (meshDevices.GetN() * 8),
110 "Stream assignment unexpected value");
111 // No further streams used in the default wifi channel configuration
112 streamsUsed += wifiChannel.AssignStreams(chan, streamsUsed);
113 NS_TEST_ASSERT_MSG_EQ(streamsUsed,
114 (meshDevices.GetN() * 8),
115 "Stream assignment unexpected value");
116 // 3. setup TCP/IP
117 InternetStackHelper internetStack;
118 internetStack.Install(*m_nodes);
119 streamsUsed += internetStack.AssignStreams(*m_nodes, streamsUsed);
120 Ipv4AddressHelper address;
121 address.SetBase("10.1.1.0", "255.255.255.0");
122 m_interfaces = address.Assign(meshDevices);
123 // 4. write PCAP if needed
125}
126
127void
148
149void
151{
152 for (int i = 0; i < 3; ++i)
153 {
154 NS_PCAP_TEST_EXPECT_EQ(PREFIX << "-" << i << "-1.pcap");
155 }
156}
157
158void
160{
161 if ((Simulator::Now() < m_time) && (m_sentPktsCounter < 300))
162 {
163 socket->Send(Create<Packet>(20));
165 Simulator::ScheduleWithContext(socket->GetNode()->GetId(),
166 Seconds(1.1),
168 this,
169 socket);
170 }
171}
172
173void
175{
176 Ptr<Packet> packet;
177 Address from;
178 while ((packet = socket->RecvFrom(from)))
179 {
180 packet->RemoveAllPacketTags();
181 packet->RemoveAllByteTags();
182
183 socket->SendTo(packet, 0, from);
184 }
185}
186
187void
189{
190 Ptr<Packet> packet;
191 Address from;
192 while ((packet = socket->RecvFrom(from)))
193 {
194 }
195}
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:90
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition double.h:31
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:33
void SetStackInstaller(std::string type, Ts &&... args)
Set the MeshStack type to use.
int64_t AssignStreams(NetDeviceContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model.
static MeshHelper Default()
Set the helper to the default values for the MAC type, remote station manager and channel policy.
void SetMacType(Ts &&... args)
Set the Mac Attributes.
NetDeviceContainer Install(const WifiPhyHelper &phyHelper, NodeContainer c) const
Install 802.11s mesh device & protocols on given node list.
void SetNumberOfInterfaces(uint32_t nInterfaces)
Set a number of interfaces in a mesh network.
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:106
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.
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:131
static void ScheduleWithContext(uint32_t context, const Time &delay, FUNC f, Ts &&... args)
Schedule an event with the given context.
Definition simulator.h:577
static Time Now()
Return the current simulation virtual time.
Definition simulator.cc:197
static void Run()
Run the simulation.
Definition simulator.cc:167
static void Stop()
Tell the Simulator the calling event should be the last one executed.
Definition simulator.cc:175
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:117
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:61
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:45
encapsulates test code
Definition test.h:1050
std::string CreateTempDirFilename(std::string filename)
Construct the full path to a file in a temporary directory.
Definition test.cc:432
AttributeValue implementation for Time.
Definition nstime.h:1395
static TypeId LookupByName(std::string name)
Get a TypeId by name.
Definition type-id.cc:872
Hold an unsigned integer type.
Definition uinteger.h:34
void DisablePreambleDetectionModel()
Disable the preamble detection model on all links.
void SetErrorRateModel(std::string type, Args &&... args)
Helper function used to set the error rate model.
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.
Ptr< T > Create(Ts &&... args)
Create class instances by constructors with varying numbers of arguments and return them by Ptr.
Definition ptr.h:436
#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:134
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition nstime.h:1308
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:684
#define NS_PCAP_TEST_EXPECT_EQ(filename)
Test that a pair of reference/new pcap files are equal.
Definition pcap-test.h:28