A Discrete-Event Network Simulator
API
bug-772.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: Pavel Boyko <boyko@iitp.ru>
19  */
20 
21 #include "bug-772.h"
22 
23 #include "ns3/simulator.h"
24 #include "ns3/random-variable-stream.h"
25 #include "ns3/rng-seed-manager.h"
26 #include "ns3/string.h"
27 #include "ns3/mobility-helper.h"
28 #include "ns3/double.h"
29 #include "ns3/uinteger.h"
30 #include "ns3/string.h"
31 #include "ns3/boolean.h"
32 #include "ns3/yans-wifi-helper.h"
33 #include "ns3/internet-stack-helper.h"
34 #include "ns3/ipv4-address-helper.h"
35 #include "ns3/abort.h"
36 #include "ns3/udp-echo-helper.h"
37 #include "ns3/mobility-model.h"
38 #include "ns3/pcap-file.h"
39 #include "ns3/aodv-helper.h"
40 #include "ns3/v4ping-helper.h"
41 #include "ns3/nqos-wifi-mac-helper.h"
42 #include "ns3/config.h"
43 #include "ns3/on-off-helper.h"
44 #include "ns3/inet-socket-address.h"
45 #include "ns3/data-rate.h"
46 #include "ns3/packet-sink-helper.h"
47 #include "ns3/pcap-test.h"
48 #include <sstream>
49 
50 using namespace ns3;
51 
52 //-----------------------------------------------------------------------------
53 // UdpChainTest
54 //-----------------------------------------------------------------------------
55 Bug772ChainTest::Bug772ChainTest (const char * const prefix, const char * const proto, Time t, uint32_t size) :
56  TestCase ("Bug 772 UDP and TCP chain regression test"),
57  m_nodes (0),
58  m_prefix (prefix),
59  m_proto (proto),
60  m_time (t),
61  m_size (size),
62  m_step (120)
63 {
64 }
65 
67 {
68  delete m_nodes;
69 }
70 
71 void
73 {
74  RngSeedManager::SetSeed (12345);
75  RngSeedManager::SetRun (7);
76 
77  CreateNodes ();
78  CreateDevices ();
79 
80  Simulator::Stop (m_time);
81  Simulator::Run ();
82  Simulator::Destroy ();
83 
84  CheckResults ();
85 
86  delete m_nodes, m_nodes = 0;
87 }
88 
89 void
91 {
92  m_nodes = new NodeContainer;
94  MobilityHelper mobility;
95  mobility.SetPositionAllocator ("ns3::GridPositionAllocator",
96  "MinX", DoubleValue (0.0),
97  "MinY", DoubleValue (0.0),
98  "DeltaX", DoubleValue (m_step),
99  "DeltaY", DoubleValue (0),
100  "GridWidth", UintegerValue (m_size),
101  "LayoutType", StringValue ("RowFirst"));
102  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
103  mobility.Install (*m_nodes);
104 }
105 
106 void
108 {
109  int64_t streamsUsed = 0;
110  // 1. Setup WiFi
111  NqosWifiMacHelper wifiMac = NqosWifiMacHelper::Default ();
112  wifiMac.SetType ("ns3::AdhocWifiMac");
113  YansWifiPhyHelper wifiPhy = YansWifiPhyHelper::Default ();
114  // This test suite output was originally based on YansErrorRateModel
115  wifiPhy.SetErrorRateModel ("ns3::YansErrorRateModel");
116  YansWifiChannelHelper wifiChannel = YansWifiChannelHelper::Default ();
117  Ptr<YansWifiChannel> chan = wifiChannel.Create ();
118  wifiPhy.SetChannel (chan);
119  WifiHelper wifi = WifiHelper::Default ();
120  wifi.SetRemoteStationManager ("ns3::ConstantRateWifiManager", "DataMode", StringValue ("OfdmRate6Mbps"), "RtsCtsThreshold", StringValue ("2200"));
121  NetDeviceContainer devices = wifi.Install (wifiPhy, wifiMac, *m_nodes);
122 
123  // Assign fixed stream numbers to wifi and channel random variables
124  streamsUsed += wifi.AssignStreams (devices, streamsUsed);
125  // Assign 6 streams per device
126  NS_TEST_ASSERT_MSG_EQ (streamsUsed, (devices.GetN () * 6), "Stream assignment mismatch");
127  streamsUsed += wifiChannel.AssignStreams (chan, streamsUsed);
128  // Assign 0 streams per channel for this configuration
129  NS_TEST_ASSERT_MSG_EQ (streamsUsed, (devices.GetN () * 6), "Stream assignment mismatch");
130 
131  // 2. Setup TCP/IP & AODV
132  AodvHelper aodv; // Use default parameters here
133  InternetStackHelper internetStack;
134  internetStack.SetRoutingHelper (aodv);
135  internetStack.Install (*m_nodes);
136  streamsUsed += internetStack.AssignStreams (*m_nodes, streamsUsed);
137  // Expect to use (3*m_size) more streams for internet stack random variables
138  NS_TEST_ASSERT_MSG_EQ (streamsUsed, ((devices.GetN () * 6) + (3*m_size)), "Stream assignment mismatch");
139  streamsUsed += aodv.AssignStreams (*m_nodes, streamsUsed);
140  // Expect to use m_size more streams for AODV
141  NS_TEST_ASSERT_MSG_EQ (streamsUsed, ((devices.GetN () * 6) + (3*m_size) + m_size), "Stream assignment mismatch");
143  address.SetBase ("10.1.1.0", "255.255.255.0");
144  Ipv4InterfaceContainer interfaces = address.Assign (devices);
145 
146  // 3. Setup UDP source and sink
147  uint16_t port = 9; // Discard port (RFC 863)
148  OnOffHelper onoff (m_proto, Address (InetSocketAddress (interfaces.GetAddress (m_size-1), port)));
149  onoff.SetConstantRate (DataRate (64000));
150  onoff.SetAttribute ("PacketSize", UintegerValue (1000));
151  ApplicationContainer app = onoff.Install (m_nodes->Get (0));
152  app.Start (Seconds (1.0));
153  app.Stop (m_time);
154  PacketSinkHelper sink (m_proto, Address (InetSocketAddress (Ipv4Address::GetAny (), port)));
155  app = sink.Install (m_nodes->Get (m_size - 1));
156  app.Start (Seconds (0.0));
157 
158  // 4. write PCAP on the first and last nodes only
159  wifiPhy.EnablePcap (CreateTempDirFilename (m_prefix), devices.Get (0));
160  wifiPhy.EnablePcap (CreateTempDirFilename (m_prefix), devices.Get (m_size-1));
161 }
162 
163 void
165 {
166  for (uint32_t i = 0; i < m_size; i += (m_size - 1) /*first and last nodes only*/)
167  {
168  NS_PCAP_TEST_EXPECT_EQ(m_prefix << "-" << i << "-0.pcap");
169  }
170 }
const std::string m_proto
Socket factory TID.
Definition: bug-772.h:58
holds a vector of ns3::Application pointers.
NodeContainer * m_nodes
Definition: bug-772.h:53
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
an Inet address class
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
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())
tuple devices
Definition: first.py:32
holds a vector of std::pair of Ptr and interface index.
Ptr< YansWifiChannel > Create(void) const
void SetRemoteStationManager(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: wifi-helper.cc:73
Hold variables of type string.
Definition: string.h:41
Ptr< NetDevice > Get(uint32_t i) const
Get the Ptr stored in this container at a given index.
Make it easy to create and manage PHY objects for the yans model.
const uint32_t m_size
Chain size.
Definition: bug-772.h:62
void CheckResults()
Compare traces with reference ones.
Definition: bug-772.cc:164
virtual void SetType(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())
aggregate IP/TCP/UDP functionality to existing Nodes.
A helper to make it easier to instantiate an ns3::PacketSinkApplication on a set of nodes...
encapsulates test code
Definition: test.h:1108
#define NS_PCAP_TEST_EXPECT_EQ(filename)
Test that a pair of reference/new pcap files are equal.
Definition: pcap-test.h:18
helps to create WifiNetDevice objects
Definition: wifi-helper.h:92
A helper to make it easier to instantiate an ns3::OnOffApplication on a set of nodes.
Definition: on-off-helper.h:42
virtual NetDeviceContainer Install(const WifiPhyHelper &phy, const WifiMacHelper &mac, NodeContainer c) const
Definition: wifi-helper.cc:102
uint16_t port
Definition: dsdv-manet.cc:44
a polymophic address class
Definition: address.h:90
void CreateNodes()
Create test topology.
Definition: bug-772.cc:90
uint32_t GetN(void) const
Get the number of Ptr stored in this container.
Class for representing data rates.
Definition: data-rate.h:88
void SetChannel(Ptr< YansWifiChannel > channel)
void Install(Ptr< Node > node) const
"Layout" a single node according to the current position allocator type.
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:158
tuple interfaces
Definition: first.py:41
const Time m_time
Total simulation time.
Definition: bug-772.h:60
holds a vector of ns3::NetDevice pointers
int64_t AssignStreams(NetDeviceContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by the Phy and Mac aspects ...
Definition: wifi-helper.cc:177
void Start(Time start)
Arrange for all of the Applications in this container to Start() at the Time given as a parameter...
create non QoS-enabled MAC layers for a ns3::WifiNetDevice.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void SetConstantRate(DataRate dataRate, uint32_t packetSize=512)
Helper function to set a constant rate source.
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...
void CreateDevices()
Create devices, install TCP/IP stack and applications.
Definition: bug-772.cc:107
manage and create wifi channel objects for the yans model.
Helper class used to assign positions and mobility models to nodes.
void Stop(Time stop)
Arrange for all of the Applications in this container to Stop() at the Time given as a parameter...
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...
Ptr< Node > Get(uint32_t i) const
Get the Ptr stored in this container at a given index.
std::string CreateTempDirFilename(std::string filename)
Definition: test.cc:313
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:866
int64_t AssignStreams(NodeContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model...
Definition: aodv-helper.cc:57
ApplicationContainer Install(NodeContainer c) const
Install an ns3::PacketSinkApplication on each node of the input container configured with all the att...
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
Helper class that adds AODV routing to nodes.
Definition: aodv-helper.h:35
tuple address
Definition: first.py:37
void EnablePcap(std::string prefix, Ptr< NetDevice > nd, bool promiscuous=false, bool explicitFilename=false)
Enable pcap output the indicated net device.
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 SetRoutingHelper(const Ipv4RoutingHelper &routing)
const std::string m_prefix
PCAP file names prefix.
Definition: bug-772.h:56
const double m_step
Chain step, meters.
Definition: bug-772.h:64
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
void DoRun()
Go.
Definition: bug-772.cc:72
Bug772ChainTest(const char *const prefix, const char *const proto, Time time, uint32_t size)
Create test case.
Definition: bug-772.cc:55