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 #include "ns3/simulator.h"
23 #include "ns3/random-variable-stream.h"
24 #include "ns3/rng-seed-manager.h"
25 #include "ns3/string.h"
26 #include "ns3/mobility-helper.h"
27 #include "ns3/double.h"
28 #include "ns3/uinteger.h"
29 #include "ns3/boolean.h"
30 #include "ns3/yans-wifi-helper.h"
31 #include "ns3/internet-stack-helper.h"
32 #include "ns3/ipv4-address-helper.h"
33 #include "ns3/abort.h"
34 #include "ns3/mobility-model.h"
35 #include "ns3/pcap-file.h"
36 #include "ns3/aodv-helper.h"
37 #include "ns3/v4ping-helper.h"
38 #include "ns3/config.h"
39 #include "ns3/inet-socket-address.h"
40 #include "ns3/data-rate.h"
41 #include "ns3/pcap-test.h"
42 #include <sstream>
43 
44 using namespace ns3;
45 
46 //-----------------------------------------------------------------------------
47 // UdpChainTest
48 //-----------------------------------------------------------------------------
49 Bug772ChainTest::Bug772ChainTest (const char * const prefix, const char * const proto, Time t, uint32_t size)
50  : TestCase ("Bug 772 UDP and TCP chain regression test"),
51  m_nodes (0),
52  m_prefix (prefix),
53  m_proto (proto),
54  m_time (t),
55  m_size (size),
56  m_step (120),
57  m_port (9),
58  m_receivedPackets (0)
59 {
60 }
61 
62 Bug772ChainTest::~Bug772ChainTest ()
63 {
64  delete m_nodes;
65 }
66 
67 void
68 Bug772ChainTest::SendData (Ptr<Socket> socket)
69 {
70  if (Simulator::Now () < m_time)
71  {
72  socket->Send (Create<Packet> (1000));
73  Simulator::ScheduleWithContext (socket->GetNode ()->GetId (), Seconds (0.25),
74  &Bug772ChainTest::SendData, this, socket);
75  }
76 }
77 
78 void
79 Bug772ChainTest::HandleRead (Ptr<Socket> socket)
80 {
81  m_receivedPackets++;
82 }
83 
84 void
85 Bug772ChainTest::DoRun ()
86 {
87  RngSeedManager::SetSeed (12345);
88  RngSeedManager::SetRun (7);
89 
90  // Default of 3 will cause packet loss
91  Config::SetDefault ("ns3::ArpCache::PendingQueueSize", UintegerValue (10));
92 
93  CreateNodes ();
94  CreateDevices ();
95 
96  Simulator::Stop (m_time + Seconds (1)); // Allow buffered packets to clear
97  Simulator::Run ();
98  Simulator::Destroy ();
99 
100  CheckResults ();
101 
102  delete m_nodes, m_nodes = 0;
103 }
104 
105 void
106 Bug772ChainTest::CreateNodes ()
107 {
108  m_nodes = new NodeContainer;
109  m_nodes->Create (m_size);
110  MobilityHelper mobility;
111  mobility.SetPositionAllocator ("ns3::GridPositionAllocator",
112  "MinX", DoubleValue (0.0),
113  "MinY", DoubleValue (0.0),
114  "DeltaX", DoubleValue (m_step),
115  "DeltaY", DoubleValue (0),
116  "GridWidth", UintegerValue (m_size),
117  "LayoutType", StringValue ("RowFirst"));
118  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
119  mobility.Install (*m_nodes);
120 }
121 
122 void
123 Bug772ChainTest::CreateDevices ()
124 {
125  int64_t streamsUsed = 0;
126  // 1. Setup WiFi
127  WifiMacHelper wifiMac;
128  wifiMac.SetType ("ns3::AdhocWifiMac");
129  YansWifiPhyHelper wifiPhy;
130  wifiPhy.DisablePreambleDetectionModel ();
131  // This test suite output was originally based on YansErrorRateModel
132  wifiPhy.SetErrorRateModel ("ns3::YansErrorRateModel");
133  YansWifiChannelHelper wifiChannel = YansWifiChannelHelper::Default ();
134  Ptr<YansWifiChannel> chan = wifiChannel.Create ();
135  wifiPhy.SetChannel (chan);
136  wifiPhy.Set ("TxGain", DoubleValue (1.0)); //this configuration should go away in future revision to the test
137  wifiPhy.Set ("RxGain", DoubleValue (1.0)); //this configuration should go away in future revision to the test
138  WifiHelper wifi;
139  wifi.SetRemoteStationManager ("ns3::ConstantRateWifiManager", "DataMode", StringValue ("OfdmRate6Mbps"), "RtsCtsThreshold", StringValue ("2200"), "MaxSlrc", UintegerValue (7));
140  NetDeviceContainer devices = wifi.Install (wifiPhy, wifiMac, *m_nodes);
141 
142  // Assign fixed stream numbers to wifi and channel random variables
143  streamsUsed += wifi.AssignStreams (devices, streamsUsed);
144  // Assign 6 streams per device
145  NS_TEST_ASSERT_MSG_EQ (streamsUsed, (devices.GetN () * 6), "Stream assignment mismatch");
146  streamsUsed += wifiChannel.AssignStreams (chan, streamsUsed);
147  // Assign 0 streams per channel for this configuration
148  NS_TEST_ASSERT_MSG_EQ (streamsUsed, (devices.GetN () * 6), "Stream assignment mismatch");
149 
150  // 2. Setup TCP/IP & AODV
151  AodvHelper aodv; // Use default parameters here
152  InternetStackHelper internetStack;
153  internetStack.SetRoutingHelper (aodv);
154  internetStack.Install (*m_nodes);
155  streamsUsed += internetStack.AssignStreams (*m_nodes, streamsUsed);
156  // Expect to use (3*m_size) more streams for internet stack random variables
157  NS_TEST_ASSERT_MSG_EQ (streamsUsed, ((devices.GetN () * 6) + (3 * m_size)), "Stream assignment mismatch");
158  streamsUsed += aodv.AssignStreams (*m_nodes, streamsUsed);
159  // Expect to use m_size more streams for AODV
160  NS_TEST_ASSERT_MSG_EQ (streamsUsed, ((devices.GetN () * 6) + (3 * m_size) + m_size), "Stream assignment mismatch");
161  Ipv4AddressHelper address;
162  address.SetBase ("10.1.1.0", "255.255.255.0");
163  Ipv4InterfaceContainer interfaces = address.Assign (devices);
164 
165  // 3. Setup UDP source and sink
166  m_sendSocket = Socket::CreateSocket (m_nodes->Get (0), TypeId::LookupByName (m_proto));
167  m_sendSocket->Bind ();
168  m_sendSocket->Connect (InetSocketAddress (interfaces.GetAddress (m_size - 1), m_port));
169  m_sendSocket->SetAllowBroadcast (true);
170  Simulator::ScheduleWithContext (m_sendSocket->GetNode ()->GetId (), Seconds (1.0),
171  &Bug772ChainTest::SendData, this, m_sendSocket);
172 
173  m_recvSocket = Socket::CreateSocket (m_nodes->Get (m_size - 1), TypeId::LookupByName (m_proto));
174  m_recvSocket->Bind (InetSocketAddress (Ipv4Address::GetAny (), m_port));
175  m_recvSocket->Listen ();
176  m_recvSocket->ShutdownSend ();
177  m_recvSocket->SetRecvCallback (MakeCallback (&Bug772ChainTest::HandleRead, this));
178 
179 }
180 
181 void
182 Bug772ChainTest::CheckResults ()
183 {
184  // We should have sent 8 packets (every 0.25 seconds from time 1 to time 3)
185  // Check that the received packet count is 8
186  NS_TEST_EXPECT_MSG_EQ (m_receivedPackets, 8, "Did not receive expected 8 packets");
187 }
ns3::NetDeviceContainer
holds a vector of ns3::NetDevice pointers
Definition: net-device-container.h:42
ns3::InetSocketAddress
an Inet address class
Definition: inet-socket-address.h:41
ns3::YansWifiPhyHelper
Make it easy to create and manage PHY objects for the YANS model.
Definition: yans-wifi-helper.h:161
ns3::Socket::SetAllowBroadcast
virtual bool SetAllowBroadcast(bool allowBroadcast)=0
Configure whether broadcast datagram transmissions are allowed.
Bug772ChainTest::m_port
const uint16_t m_port
port number
Definition: bug-772.h:69
Bug772ChainTest::CreateDevices
void CreateDevices()
Create devices, install TCP/IP stack and applications.
Definition: bug-772.cc:123
ns3::Socket::Bind
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
Bug772ChainTest::m_sendSocket
Ptr< Socket > m_sendSocket
Transmitting socket.
Definition: bug-772.h:88
ns3::YansWifiChannelHelper::AssignStreams
int64_t AssignStreams(Ptr< YansWifiChannel > c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by the channel.
Definition: yans-wifi-helper.cc:121
ns3::Node::GetId
uint32_t GetId(void) const
Definition: node.cc:109
bug-772.h
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::AodvHelper
Helper class that adds AODV routing to nodes.
Definition: aodv-helper.h:35
ns3::WifiHelper
helps to create WifiNetDevice objects
Definition: wifi-helper.h:327
ns3::Ipv4AddressHelper
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
Definition: ipv4-address-helper.h:48
Bug772ChainTest::m_proto
const std::string m_proto
Socket factory TID.
Definition: bug-772.h:61
ns3::Socket::GetNode
virtual Ptr< Node > GetNode(void) const =0
Return the node this socket is associated with.
Bug772ChainTest::m_nodes
NodeContainer * m_nodes
Definition: bug-772.h:56
ns3::WifiPhyHelper::SetErrorRateModel
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:146
ns3::YansWifiPhyHelper::SetChannel
void SetChannel(Ptr< YansWifiChannel > channel)
Definition: yans-wifi-helper.cc:134
first.devices
devices
Definition: first.py:39
ns3::DoubleValue
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition: double.h:41
ns3::NodeContainer::Create
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
Definition: node-container.cc:98
Bug772ChainTest::m_size
const uint32_t m_size
Chain size.
Definition: bug-772.h:65
ns3::TestCase
encapsulates test code
Definition: test.h:1154
third.wifi
wifi
Definition: third.py:96
ns3::WifiPhyHelper::DisablePreambleDetectionModel
void DisablePreambleDetectionModel()
Disable the preamble detection model.
Definition: wifi-helper.cc:215
ns3::Ptr< Socket >
Bug772ChainTest::m_step
const double m_step
Chain step, meters.
Definition: bug-772.h:67
ns3::Socket::Send
virtual int Send(Ptr< Packet > p, uint32_t flags)=0
Send data (or dummy data) to the remote host.
ns3::Socket::SetRecvCallback
void SetRecvCallback(Callback< void, Ptr< Socket > > receivedData)
Notify application when new data is available to be read.
Definition: socket.cc:128
ns3::YansWifiChannelHelper::Create
Ptr< YansWifiChannel > Create(void) const
Definition: yans-wifi-helper.cc:98
Bug772ChainTest::Bug772ChainTest
Bug772ChainTest(const char *const prefix, const char *const proto, Time time, uint32_t size)
Create test case.
Definition: bug-772.cc:49
Bug772ChainTest::m_receivedPackets
uint32_t m_receivedPackets
Received packet count.
Definition: bug-772.h:91
ns3::Now
Time Now(void)
create an ns3::Time instance which contains the current simulation time.
Definition: simulator.cc:287
Bug772ChainTest::HandleRead
void HandleRead(Ptr< Socket > socket)
Receive data function.
Definition: bug-772.cc:79
Bug772ChainTest::DoRun
void DoRun()
Go.
Definition: bug-772.cc:85
ns3::InternetStackHelper::Install
void Install(std::string nodeName) const
Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provid...
Definition: internet-stack-helper.cc:366
Bug772ChainTest::SendData
void SendData(Ptr< Socket > socket)
Send data.
Definition: bug-772.cc:68
ns3::Ipv4InterfaceContainer
holds a vector of std::pair of Ptr<Ipv4> and interface index.
Definition: ipv4-interface-container.h:55
ns3::NodeContainer::Get
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
Definition: node-container.cc:93
first.address
address
Definition: first.py:44
NS_TEST_EXPECT_MSG_EQ
#define NS_TEST_EXPECT_MSG_EQ(actual, limit, msg)
Test that an actual and expected (limit) value are equal and report if not.
Definition: test.h:283
ns3::Time
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:104
Bug772ChainTest::CheckResults
void CheckResults()
Compare traces with reference ones.
Definition: bug-772.cc:182
ns3::Socket::ShutdownSend
virtual int ShutdownSend(void)=0
ns3::InternetStackHelper::AssignStreams
int64_t AssignStreams(NodeContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model.
Definition: internet-stack-helper.cc:210
ns3::MakeCallback
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
ns3::StringValue
Hold variables of type string.
Definition: string.h:41
first.interfaces
interfaces
Definition: first.py:48
ns3::Socket::Listen
virtual int Listen(void)=0
Listen for incoming connections.
NS_TEST_ASSERT_MSG_EQ
#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
ns3::Socket::Connect
virtual int Connect(const Address &address)=0
Initiate a connection to a remote host.
Bug772ChainTest::~Bug772ChainTest
~Bug772ChainTest()
Definition: bug-772.cc:62
ns3::Seconds
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1289
ns3::InternetStackHelper::SetRoutingHelper
void SetRoutingHelper(const Ipv4RoutingHelper &routing)
Definition: internet-stack-helper.cc:175
ns3::NodeContainer
keep track of a set of node pointers.
Definition: node-container.h:39
ns3::WifiMacHelper::SetType
void SetType(std::string type, Args &&... args)
Definition: wifi-mac-helper.h:130
ns3::UintegerValue
Hold an unsigned integer type.
Definition: uinteger.h:44
ns3::YansWifiChannelHelper
manage and create wifi channel objects for the YANS model.
Definition: yans-wifi-helper.h:37
ns3::WifiMacHelper
create MAC layers for a ns3::WifiNetDevice.
Definition: wifi-mac-helper.h:48
ns3::Config::SetDefault
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:849
ns3::AodvHelper::AssignStreams
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
Bug772ChainTest::CreateNodes
void CreateNodes()
Create test topology.
Definition: bug-772.cc:106
ns3::InternetStackHelper
aggregate IP/TCP/UDP functionality to existing Nodes.
Definition: internet-stack-helper.h:88
ns3::WifiPhyHelper::Set
void Set(std::string name, const AttributeValue &v)
Definition: wifi-helper.cc:140
ns3::MobilityHelper
Helper class used to assign positions and mobility models to nodes.
Definition: mobility-helper.h:43
Bug772ChainTest::m_recvSocket
Ptr< Socket > m_recvSocket
Receiving socket.
Definition: bug-772.h:86
third.mobility
mobility
Definition: third.py:108
Bug772ChainTest::m_time
const Time m_time
Total simulation time.
Definition: bug-772.h:63