A Discrete-Event Network Simulator
API
flame-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 #include "ns3/mesh-helper.h"
21 #include "ns3/simulator.h"
22 #include "ns3/random-variable-stream.h"
23 #include "ns3/rng-seed-manager.h"
24 #include "ns3/mobility-helper.h"
25 #include "ns3/double.h"
26 #include "ns3/uinteger.h"
27 #include "ns3/string.h"
28 #include "ns3/yans-wifi-helper.h"
29 #include "ns3/internet-stack-helper.h"
30 #include "ns3/ipv4-address-helper.h"
31 #include "ns3/abort.h"
32 #include "ns3/pcap-test.h"
33 #include "ns3/mobility-model.h"
34 #include <sstream>
35 
36 #include "flame-regression.h"
37 
38 using namespace ns3;
39 
41 const char * const PREFIX = "flame-regression-test";
42 
43 
44 FlameRegressionTest::FlameRegressionTest () : TestCase ("FLAME regression test"),
45  m_nodes (0),
46  m_time (Seconds (10)),
47  m_sentPktsCounter (0)
48 {
49 }
50 
52 {
53  delete m_nodes;
54 }
55 
56 void
58 {
59  RngSeedManager::SetSeed (12345);
60  RngSeedManager::SetRun (7);
61  CreateNodes ();
62  CreateDevices ();
64 
65  Simulator::Stop (m_time);
66  Simulator::Run ();
67  Simulator::Destroy ();
68 
69  CheckResults ();
70 
71  delete m_nodes, m_nodes = 0;
72 }
73 
74 void
76 {
77  m_nodes = new NodeContainer;
78  m_nodes->Create (3);
80  mobility.SetPositionAllocator ("ns3::GridPositionAllocator",
81  "MinX", DoubleValue (0.0),
82  "MinY", DoubleValue (0.0),
83  "DeltaX", DoubleValue (150),
84  "DeltaY", DoubleValue (0),
85  "GridWidth", UintegerValue (3),
86  "LayoutType", StringValue ("RowFirst"));
87  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
88  mobility.Install (*m_nodes);
89 }
90 
91 void
93 {
94  int64_t streamsUsed = 0;
95  // 1. setup WiFi
96  YansWifiPhyHelper wifiPhy;
97  // This test suite output was originally based on YansErrorRateModel
98  wifiPhy.SetErrorRateModel ("ns3::YansErrorRateModel");
99  YansWifiChannelHelper wifiChannel = YansWifiChannelHelper::Default ();
100  Ptr<YansWifiChannel> chan = wifiChannel.Create ();
101  wifiPhy.SetChannel (chan);
102 
103  // 2. setup mesh
104  MeshHelper mesh = MeshHelper::Default ();
105  mesh.SetStackInstaller ("ns3::FlameStack");
106  mesh.SetMacType ("RandomStart", TimeValue (Seconds (0.1)));
107  mesh.SetNumberOfInterfaces (1);
108  NetDeviceContainer meshDevices = mesh.Install (wifiPhy, *m_nodes);
109  // Three devices, seven streams per device
110  streamsUsed += mesh.AssignStreams (meshDevices, streamsUsed);
111  NS_TEST_ASSERT_MSG_EQ (streamsUsed, (meshDevices.GetN () * 7), "Stream assignment unexpected value");
112  // No further streams used in the default wifi channel configuration
113  streamsUsed += wifiChannel.AssignStreams (chan, streamsUsed);
114  NS_TEST_ASSERT_MSG_EQ (streamsUsed, (meshDevices.GetN () * 7), "Stream assignment unexpected value");
115  // 3. setup TCP/IP
116  InternetStackHelper internetStack;
117  internetStack.Install (*m_nodes);
118  streamsUsed += internetStack.AssignStreams (*m_nodes, streamsUsed);
120  address.SetBase ("10.1.1.0", "255.255.255.0");
121  m_interfaces = address.Assign (meshDevices);
122  // 4. write PCAP if needed
124 
125 }
126 void
128 {
129  // client socket
130  m_clientSocket = Socket::CreateSocket (m_nodes->Get (2), TypeId::LookupByName ("ns3::UdpSocketFactory"));
131  m_clientSocket->Bind ();
134  Simulator::ScheduleWithContext (m_clientSocket->GetNode ()->GetId (), Seconds (1.0),
136 
137  // server socket
138  m_serverSocket = Socket::CreateSocket (m_nodes->Get (0), TypeId::LookupByName ("ns3::UdpSocketFactory"));
139  m_serverSocket->Bind (InetSocketAddress (Ipv4Address::GetAny (), 9));
141 }
142 
143 void
145 {
146  for (int i = 0; i < 3; ++i)
147  {
148  NS_PCAP_TEST_EXPECT_EQ (PREFIX << "-" << i << "-1.pcap");
149  }
150 }
151 
152 void
154 {
155  if ((Simulator::Now () < m_time) && (m_sentPktsCounter < 300))
156  {
157  socket->Send (Create<Packet> (20));
159  Simulator::ScheduleWithContext (socket->GetNode ()->GetId (), Seconds (1.1),
160  &FlameRegressionTest::SendData, this, socket);
161  }
162 }
163 
164 void
166 {
167  Ptr<Packet> packet;
168  Address from;
169  while ((packet = socket->RecvFrom (from)))
170  {
171  packet->RemoveAllPacketTags ();
172  packet->RemoveAllByteTags ();
173 
174  socket->SendTo (packet, 0, from);
175  }
176 }
177 
178 void
180 {
181  Ptr<Packet> packet;
182  Address from;
183  while ((packet = socket->RecvFrom (from)))
184  {
185  }
186 }
an Inet address class
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
Ptr< Socket > m_serverSocket
Server-side socket.
uint32_t GetId(void) const
Definition: node.cc:109
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.
void HandleReadClient(Ptr< Socket > socket)
Handle a packet reception.
void HandleReadServer(Ptr< Socket > socket)
Handle a packet reception.
Ptr< Socket > m_clientSocket
Client-side socket.
aggregate IP/TCP/UDP functionality to existing Nodes.
Time m_time
Simulation time.
uint32_t m_sentPktsCounter
sent packets counter
void SendData(Ptr< Socket > socket)
Send data.
encapsulates test code
Definition: test.h:1153
#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
void CreateNodes()
Create nodes function.
mobility
Definition: third.py:108
void SetChannel(Ptr< YansWifiChannel > channel)
virtual void DoRun()
Implementation to actually run this TestCase.
void RemoveAllPacketTags(void)
Remove all packet tags.
Definition: packet.cc:984
void CheckResults()
Check results function.
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 ~FlameRegressionTest()
void InstallApplications()
Install application function.
AttributeValue implementation for Time.
Definition: nstime.h:1342
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
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
holds a vector of ns3::NetDevice pointers
const char *const PREFIX
Unique PCAP file name prefix.
void SetRecvCallback(Callback< void, Ptr< Socket > >)
Notify application when new data is available to be read.
Definition: socket.cc:128
Ipv4InterfaceContainer m_interfaces
Needed to install applications.
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.
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
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:275
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
NodeContainer * m_nodes
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:1278
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:287
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.
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
Callback< R, Ts... > MakeCallback(R(T::*memPtr)(Ts...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
Definition: callback.h:1642
int64_t AssignStreams(Ptr< YansWifiChannel > c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by the channel.