A Discrete-Event Network Simulator
API
simple-ht-hidden-stations.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2015 Sébastien Deronne
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  * Author: Sébastien Deronne <sebastien.deronne@gmail.com>
19  */
20 
21 #include "ns3/core-module.h"
22 #include "ns3/network-module.h"
23 #include "ns3/applications-module.h"
24 #include "ns3/wifi-module.h"
25 #include "ns3/mobility-module.h"
26 #include "ns3/ipv4-global-routing-helper.h"
27 #include "ns3/internet-module.h"
28 
29 // This example considers two hidden stations in an 802.11n network which supports MPDU aggregation.
30 // The user can specify whether RTS/CTS is used and can set the number of aggregated MPDUs.
31 //
32 // Example: ./waf --run "simple-ht-hidden-stations --enableRts=1 --nMpdus=8"
33 //
34 // Network topology:
35 //
36 // Wifi 192.168.1.0
37 //
38 // AP
39 // * * *
40 // | | |
41 // n1 n2 n3
42 //
43 // Packets in this simulation aren't marked with a QosTag so they are considered
44 // belonging to BestEffort Access Class (AC_BE).
45 
46 using namespace ns3;
47 
48 NS_LOG_COMPONENT_DEFINE ("SimplesHtHiddenStations");
49 
50 int main (int argc, char *argv[])
51 {
52  uint32_t payloadSize = 1472; //bytes
53  uint64_t simulationTime = 10; //seconds
54  uint32_t nMpdus = 1;
55  bool enableRts = 0;
56 
58  cmd.AddValue ("nMpdus", "Number of aggregated MPDUs", nMpdus);
59  cmd.AddValue ("payloadSize", "Payload size in bytes", payloadSize);
60  cmd.AddValue ("enableRts", "Enable RTS/CTS", enableRts); // 1: RTS/CTS enabled; 0: RTS/CTS disabled
61  cmd.AddValue ("simulationTime", "Simulation time in seconds", simulationTime);
62  cmd.Parse (argc, argv);
63 
64  if (!enableRts)
65  {
66  Config::SetDefault ("ns3::WifiRemoteStationManager::RtsCtsThreshold", StringValue ("999999"));
67  }
68  else
69  {
70  Config::SetDefault ("ns3::WifiRemoteStationManager::RtsCtsThreshold", StringValue ("0"));
71  }
72 
73  Config::SetDefault ("ns3::WifiRemoteStationManager::FragmentationThreshold", StringValue ("990000"));
74 
75  // Set the maximum wireless range to 5 meters in order to reproduce a hidden nodes scenario, i.e. the distance between hidden stations is larger than 5 meters
76  Config::SetDefault ("ns3::RangePropagationLossModel::MaxRange", DoubleValue (5));
77 
79  wifiStaNodes.Create (2);
81  wifiApNode.Create (1);
82 
84  channel.AddPropagationLoss ("ns3::RangePropagationLossModel"); //wireless range limited to 5 meters!
85 
88  phy.SetChannel (channel.Create ());
89 
92  wifi.SetRemoteStationManager ("ns3::ConstantRateWifiManager", "DataMode", StringValue ("HtMcs7"), "ControlMode", StringValue ("HtMcs0"));
94 
95  Ssid ssid = Ssid ("simple-mpdu-aggregation");
96  mac.SetType ("ns3::StaWifiMac",
97  "Ssid", SsidValue (ssid),
98  "ActiveProbing", BooleanValue (false));
99 
100  if (nMpdus > 1)
101  {
102  mac.SetBlockAckThresholdForAc (AC_BE, 2); //enable Block ACK when A-MPDU is enabled
103 
104  }
105  mac.SetMpduAggregatorForAc (AC_BE,"ns3::MpduStandardAggregator",
106  "MaxAmpduSize", UintegerValue (nMpdus * (payloadSize + 100))); //enable MPDU aggregation for AC_BE with a maximum aggregated size of nMpdus*(payloadSize+100) bytes,
107  //i.e. nMpdus aggregated packets in an A-MPDU
108 
110  staDevices = wifi.Install (phy, mac, wifiStaNodes);
111 
112  mac.SetType ("ns3::ApWifiMac",
113  "Ssid", SsidValue (ssid),
114  "BeaconInterval", TimeValue (MicroSeconds (102400)),
115  "BeaconGeneration", BooleanValue (true));
116 
117  if (nMpdus > 1)
118  {
119  mac.SetBlockAckThresholdForAc (AC_BE, 2); //enable Block ACK when A-MPDU is enabled
120 
121  }
122  mac.SetMpduAggregatorForAc (AC_BE,"ns3::MpduStandardAggregator",
123  "MaxAmpduSize", UintegerValue (nMpdus * (payloadSize + 100))); //enable MPDU aggregation for AC_BE with a maximum aggregated size of nMpdus*(payloadSize+100) bytes,
124  //i.e. nMpdus aggregated packets in an A-MPDU
125 
126  NetDeviceContainer apDevice;
127  apDevice = wifi.Install (phy, mac, wifiApNode);
128 
129  // Setting mobility model
131  Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator> ();
132 
133  // AP is between the two stations, each station being located at 5 meters from the AP.
134  // The distance between the two stations is thus equal to 10 meters.
135  // Since the wireless range is limited to 5 meters, the two stations are hidden from each other.
136  positionAlloc->Add (Vector (5.0, 0.0, 0.0));
137  positionAlloc->Add (Vector (0.0, 0.0, 0.0));
138  positionAlloc->Add (Vector (10.0, 0.0, 0.0));
139  mobility.SetPositionAllocator (positionAlloc);
140 
141  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
142 
143  mobility.Install (wifiApNode);
144  mobility.Install (wifiStaNodes);
145 
146  // Internet stack
148  stack.Install (wifiApNode);
149  stack.Install (wifiStaNodes);
150 
152 
153  address.SetBase ("192.168.1.0", "255.255.255.0");
154  Ipv4InterfaceContainer StaInterface;
155  StaInterface = address.Assign (staDevices);
156  Ipv4InterfaceContainer ApInterface;
157  ApInterface = address.Assign (apDevice);
158 
159  // Setting applications
160  UdpServerHelper myServer (9);
161  ApplicationContainer serverApp = myServer.Install (wifiApNode);
162  serverApp.Start (Seconds (0.0));
163  serverApp.Stop (Seconds (simulationTime + 1));
164 
165  UdpClientHelper myClient (ApInterface.GetAddress (0), 9);
166  myClient.SetAttribute ("MaxPackets", UintegerValue (4294967295u));
167  myClient.SetAttribute ("Interval", TimeValue (Time ("0.00002"))); //packets/s
168  myClient.SetAttribute ("PacketSize", UintegerValue (payloadSize));
169 
170  // Saturated UDP traffic from stations to AP
171  ApplicationContainer clientApp1 = myClient.Install (wifiStaNodes);
172  clientApp1.Start (Seconds (1.0));
173  clientApp1.Stop (Seconds (simulationTime + 1));
174 
175  phy.EnablePcap ("SimpleHtHiddenStations_Ap", apDevice.Get (0));
176  phy.EnablePcap ("SimpleHtHiddenStations_Sta1", staDevices.Get (0));
177  phy.EnablePcap ("SimpleHtHiddenStations_Sta2", staDevices.Get (1));
178 
179  Simulator::Stop (Seconds (simulationTime + 1));
180 
181  Simulator::Run ();
183 
184  uint32_t totalPacketsThrough = DynamicCast<UdpServer> (serverApp.Get (0))->GetReceived ();
185  double throughput = totalPacketsThrough * payloadSize * 8 / (simulationTime * 1000000.0);
186  std::cout << "Throughput: " << throughput << " Mbit/s" << '\n';
187 
188  return 0;
189 }
void AddPropagationLoss(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 channel
Definition: third.py:85
holds a vector of ns3::Application pointers.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
create HT-enabled MAC layers for a ns3::WifiNetDevice.
AttributeValue implementation for Boolean.
Definition: boolean.h:34
HT OFDM PHY for the 5 GHz band (clause 20)
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:74
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.
static YansWifiChannelHelper Default(void)
Create a channel helper in a default working state.
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())
Set the underlying type of the MAC and its attributes.
static void Run(void)
Run the simulation.
Definition: simulator.cc:200
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:201
void SetPcapDataLinkType(enum SupportedPcapDataLinkTypes dlt)
Set the data link type of PCAP traces to be used.
aggregate IP/TCP/UDP functionality to existing Nodes.
static YansWifiPhyHelper Default(void)
Create a phy helper in a default working state.
helps to create WifiNetDevice objects
Definition: wifi-helper.h:96
Best Effort.
Definition: qos-utils.h:39
Include Radiotap link layer information.
tuple cmd
Definition: second.py:35
virtual NetDeviceContainer Install(const WifiPhyHelper &phy, const WifiMacHelper &mac, NodeContainer c) const
Definition: wifi-helper.cc:103
static HtWifiMacHelper Default(void)
Create a mac helper in a default working state.
void SetChannel(Ptr< YansWifiChannel > channel)
void Install(Ptr< Node > node) const
"Layout" a single node according to the current position allocator type.
void SetBlockAckThresholdForAc(enum AcIndex ac, uint8_t threshold)
This method sets value of block ack threshold for a specific access class.
tuple mobility
Definition: third.py:101
tuple phy
Definition: third.py:86
Create a client application which sends UDP packets carrying a 32bit sequence number and a 64 bit tim...
AttributeValue implementation for Time.
Definition: nstime.h:957
Hold an unsigned integer type.
Definition: uinteger.h:44
void SetMpduAggregatorForAc(enum AcIndex ac, 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())
Set the class, type and attributes for the Mpdu aggregator.
holds a vector of ns3::NetDevice pointers
virtual void SetStandard(enum WifiPhyStandard standard)
Definition: wifi-helper.cc:97
Create a server application which waits for input UDP packets and uses the information carried into t...
tuple staDevices
Definition: third.py:96
tuple mac
Definition: third.py:92
void Start(Time start)
Arrange for all of the Applications in this container to Start() at the Time given as a parameter...
Parse command-line arguments.
Definition: command-line.h:201
static void Destroy(void)
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:164
tuple wifiApNode
Definition: third.py:83
void SetAttribute(std::string name, const AttributeValue &value)
Record an attribute to be set in each Application after it is is created.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
keep track of a set of node pointers.
Ptr< Application > Get(uint32_t i) const
Get the Ptr stored in this container at a given index.
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...
tuple ssid
Definition: third.py:93
manage and create wifi channel objects for the yans model.
tuple stack
Definition: first.py:34
The IEEE 802.11 SSID Information Element.
Definition: ssid.h:38
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...
void AddValue(const std::string &name, const std::string &help, T &value)
Add a program argument, assigning to POD.
Definition: command-line.h:491
static void Stop(void)
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:208
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:895
AttributeValue implementation for Ssid.
Definition: ssid.h:95
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:774
void Add(Vector v)
Add a position to the list of positions.
void Parse(int argc, char *argv[])
Parse the program arguments.
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
Time MicroSeconds(uint64_t value)
Construct a Time in the indicated unit.
Definition: nstime.h:911
tuple wifi
Definition: third.py:89
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
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 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
tuple wifiStaNodes
Definition: third.py:81
static WifiHelper Default(void)
Definition: wifi-helper.cc:66