A Discrete-Event Network Simulator
API
hwmp-proactive-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 
21 #include "ns3/mesh-helper.h"
22 #include "ns3/simulator.h"
23 #include "ns3/random-variable-stream.h"
24 #include "ns3/rng-seed-manager.h"
25 #include "ns3/mobility-helper.h"
26 #include "ns3/double.h"
27 #include "ns3/uinteger.h"
28 #include "ns3/string.h"
29 #include "ns3/yans-wifi-helper.h"
30 #include "ns3/internet-stack-helper.h"
31 #include "ns3/ipv4-interface-container.h"
32 #include "ns3/ipv4-address-helper.h"
33 #include "ns3/abort.h"
34 #include "ns3/mobility-model.h"
35 #include "ns3/pcap-test.h"
36 #include <sstream>
38 
39 using namespace ns3;
40 
42 const char * const PREFIX = "hwmp-proactive-regression-test";
43 
44 
46  m_nodes (0),
47  m_time (Seconds (5)),
48  m_sentPktsCounter (0)
49 {
50 }
51 
53 {
54  delete m_nodes;
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 void
75 {
76  m_nodes = new NodeContainer;
77  m_nodes->Create (5);
79  mobility.SetPositionAllocator ("ns3::GridPositionAllocator",
80  "MinX", DoubleValue (0.0),
81  "MinY", DoubleValue (0.0),
82  "DeltaX", DoubleValue (100),
83  "DeltaY", DoubleValue (0),
84  "GridWidth", UintegerValue (5),
85  "LayoutType", StringValue ("RowFirst"));
86  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
87  mobility.Install (*m_nodes);
88 }
89 void
91 {
92  // client socket
93  m_clientSocket = Socket::CreateSocket (m_nodes->Get (4), TypeId::LookupByName ("ns3::UdpSocketFactory"));
94  m_clientSocket->Bind ();
97  Simulator::ScheduleWithContext (m_clientSocket->GetNode ()->GetId (), Seconds (2.5),
99 
100  // server socket
101  m_serverSocket = Socket::CreateSocket (m_nodes->Get (0), TypeId::LookupByName ("ns3::UdpSocketFactory"));
102  m_serverSocket->Bind (InetSocketAddress (Ipv4Address::GetAny (), 9));
103  m_serverSocket->SetRecvCallback (MakeCallback (&HwmpProactiveRegressionTest::HandleReadServer, this));
104 }
105 void
107 {
108  int64_t streamsUsed = 0;
109  // 1. setup WiFi
110  YansWifiPhyHelper wifiPhy = YansWifiPhyHelper::Default ();
111  // This test suite output was originally based on YansErrorRateModel
112  wifiPhy.SetErrorRateModel ("ns3::YansErrorRateModel");
113  YansWifiChannelHelper wifiChannel = YansWifiChannelHelper::Default ();
114  Ptr<YansWifiChannel> chan = wifiChannel.Create ();
115  wifiPhy.SetChannel (chan);
116  wifiPhy.Set ("TxGain", DoubleValue (1.0)); //this configuration should go away in future revision to the test
117  wifiPhy.Set ("RxGain", DoubleValue (1.0)); //this configuration should go away in future revision to the test
118  // 2. setup mesh
119  MeshHelper mesh = MeshHelper::Default ();
120  mesh.SetStackInstaller ("ns3::Dot11sStack", "Root", Mac48AddressValue (Mac48Address ("00:00:00:00:00:0d")));
121  mesh.SetMacType ("RandomStart", TimeValue (Seconds (0.1)));
122  mesh.SetNumberOfInterfaces (1);
123  NetDeviceContainer meshDevices = mesh.Install (wifiPhy, *m_nodes);
124  // Five devices, 9 streams per device
125  streamsUsed += mesh.AssignStreams (meshDevices, streamsUsed);
126  NS_TEST_ASSERT_MSG_EQ (streamsUsed, (meshDevices.GetN () * 9), "Stream mismatch");
127  // No streams used here, by default
128  streamsUsed += wifiChannel.AssignStreams (chan, streamsUsed);
129  NS_TEST_ASSERT_MSG_EQ (streamsUsed, (meshDevices.GetN () * 9), "Stream mismatch");
130 
131  // 3. setup TCP/IP
132  InternetStackHelper internetStack;
133  internetStack.Install (*m_nodes);
134  streamsUsed += internetStack.AssignStreams (*m_nodes, streamsUsed);
136  address.SetBase ("10.1.1.0", "255.255.255.0");
137  m_interfaces = address.Assign (meshDevices);
138  // 4. write PCAP if needed
140 }
141 
142 void
144 {
145  for (int i = 0; i < 5; ++i)
146  {
147  NS_PCAP_TEST_EXPECT_EQ (PREFIX << "-" << i << "-1.pcap");
148  }
149 }
150 
151 void
153 {
154  if ((Simulator::Now () < m_time) && (m_sentPktsCounter < 300))
155  {
156  socket->Send (Create<Packet> (100));
158  Simulator::ScheduleWithContext (socket->GetNode ()->GetId (), Seconds (0.5),
160  }
161 }
162 
163 void
165 {
166  Ptr<Packet> packet;
167  Address from;
168  while ((packet = socket->RecvFrom (from)))
169  {
170  packet->RemoveAllPacketTags ();
171  packet->RemoveAllByteTags ();
172 
173  socket->SendTo (packet, 0, from);
174  }
175 }
176 
177 void
179 {
180  Ptr<Packet> packet;
181  Address from;
182  while ((packet = socket->RecvFrom (from)))
183  {
184  }
185 }
void Set(std::string name, const AttributeValue &v)
Definition: wifi-helper.cc:132
an Inet address class
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
Ptr< YansWifiChannel > Create(void) const
Hold variables of type string.
Definition: string.h:41
Make it easy to create and manage PHY objects for the yans model.
aggregate IP/TCP/UDP functionality to existing Nodes.
encapsulates test code
Definition: test.h:1155
#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:77
a polymophic address class
Definition: address.h:90
uint32_t GetN(void) const
Get the number of Ptr stored in this container.
void SetChannel(Ptr< YansWifiChannel > channel)
void RemoveAllPacketTags(void)
Remove all packet tags.
Definition: packet.cc:842
void Install(Ptr< Node > node) const
"Layout" a single node according to the current position allocator type.
tuple mobility
Definition: third.py:101
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 ...
AttributeValue implementation for Time.
Definition: nstime.h:1055
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:168
void HandleReadServer(Ptr< Socket > socket)
Handle a packet reception.
holds a vector of ns3::NetDevice pointers
Callback< R > MakeCallback(R(T::*memPtr)(void), OBJ objPtr)
Definition: callback.h:1489
void SetRecvCallback(Callback< void, Ptr< Socket > >)
Notify application when new data is available to be read.
Definition: socket.cc:128
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:126
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.
void SetMobilityModel(std::string type, 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(), std::string n8="", const AttributeValue &v8=EmptyAttributeValue(), std::string n9="", const AttributeValue &v9=EmptyAttributeValue())
void Install(std::string nodeName) const
Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provid...
an EUI-48 address
Definition: mac48-address.h:43
manage and create wifi channel objects for the yans model.
Ptr< Socket > m_clientSocket
Client-side socket.
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:215
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:49
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:138
void HandleReadClient(Ptr< Socket > socket)
Handle a packet reception.
Ipv4InterfaceContainer m_interfaces
interfaces
Helper class used to assign positions and mobility models to nodes.
void InstallApplications()
Install application function.
uint32_t m_sentPktsCounter
sent packets counter
Ipv4InterfaceContainer Assign(const NetDeviceContainer &c)
Assign IP addresses to the net devices specified in the container based on the current network prefix...
int64_t AssignStreams(NodeContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model...
void CreateDevices()
Create devices function.
void CreateNodes()
Create nodes function.
NetDeviceContainer Install(const WifiPhyHelper &phyHelper, NodeContainer c) const
Install 802.11s mesh device & protocols on given node list.
Definition: mesh-helper.cc:82
uint32_t GetId(void) const
Definition: node.cc:107
virtual Ptr< Node > GetNode(void) const =0
Return the node this socket is associated with.
AttributeValue implementation for Mac48Address.
Ptr< Node > Get(uint32_t i) const
Get the Ptr stored in this container at a given index.
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:993
void RemoveAllByteTags(void)
Remove all byte tags stored in this packet.
Definition: packet.cc:348
const char *const PREFIX
Unique PCAP file name prefix.
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:365
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
void CheckResults()
Check results function.
Ptr< Socket > m_serverSocket
Server-side socket.
Helper to create IEEE 802.11s mesh networks.
Definition: mesh-helper.h:38
tuple address
Definition: first.py:37
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 void DoRun()
Implementation to actually run this TestCase.
virtual int Send(Ptr< Packet > p, uint32_t flags)=0
Send data (or dummy data) to the remote host.
void SetPositionAllocator(Ptr< PositionAllocator > allocator)
Set the position allocator which will be used to allocate the initial position of every node initiali...
This class can be used to hold variables of floating point type such as 'double' or 'float'...
Definition: double.h:41
void SendData(Ptr< Socket > socket)
Send data.
int64_t AssignStreams(Ptr< YansWifiChannel > c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by the channel.
void SetBase(Ipv4Address network, Ipv4Mask mask, Ipv4Address base="0.0.0.1")
Set the base network number, network mask and base address.
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const