A Discrete-Event Network Simulator
API
vht-wifi-network.cc
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2015 SEBASTIEN 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: Sebastien Deronne <sebastien.deronne@gmail.com>
19  */
20 
21 #include "ns3/command-line.h"
22 #include "ns3/config.h"
23 #include "ns3/uinteger.h"
24 #include "ns3/boolean.h"
25 #include "ns3/double.h"
26 #include "ns3/string.h"
27 #include "ns3/log.h"
28 #include "ns3/yans-wifi-helper.h"
29 #include "ns3/ssid.h"
30 #include "ns3/mobility-helper.h"
31 #include "ns3/internet-stack-helper.h"
32 #include "ns3/ipv4-address-helper.h"
33 #include "ns3/udp-client-server-helper.h"
34 #include "ns3/packet-sink-helper.h"
35 #include "ns3/on-off-helper.h"
36 #include "ns3/ipv4-global-routing-helper.h"
37 #include "ns3/packet-sink.h"
38 #include "ns3/yans-wifi-channel.h"
39 
40 // This is a simple example in order to show how to configure an IEEE 802.11ac Wi-Fi network.
41 //
42 // It outputs the UDP or TCP goodput for every VHT MCS value, which depends on the MCS value (0 to 9, where 9 is
43 // forbidden when the channel width is 20 MHz), the channel width (20, 40, 80 or 160 MHz) and the guard interval (long
44 // or short). The PHY bitrate is constant over all the simulation run. The user can also specify the distance between
45 // the access point and the station: the larger the distance the smaller the goodput.
46 //
47 // The simulation assumes a single station in an infrastructure network:
48 //
49 // STA AP
50 // * *
51 // | |
52 // n1 n2
53 //
54 //Packets in this simulation aren't marked with a QosTag so they are considered
55 //belonging to BestEffort Access Class (AC_BE).
56 
57 using namespace ns3;
58 
59 NS_LOG_COMPONENT_DEFINE ("vht-wifi-network");
60 
61 int main (int argc, char *argv[])
62 {
63  bool udp = true;
64  bool useRts = false;
65  double simulationTime = 10; //seconds
66  double distance = 1.0; //meters
67  int mcs = -1; // -1 indicates an unset value
68  double minExpectedThroughput = 0;
69  double maxExpectedThroughput = 0;
70 
72  cmd.AddValue ("distance", "Distance in meters between the station and the access point", distance);
73  cmd.AddValue ("simulationTime", "Simulation time in seconds", simulationTime);
74  cmd.AddValue ("udp", "UDP if set to 1, TCP otherwise", udp);
75  cmd.AddValue ("useRts", "Enable/disable RTS/CTS", useRts);
76  cmd.AddValue ("mcs", "if set, limit testing to a specific MCS (0-9)", mcs);
77  cmd.AddValue ("minExpectedThroughput", "if set, simulation fails if the lowest throughput is below this value", minExpectedThroughput);
78  cmd.AddValue ("maxExpectedThroughput", "if set, simulation fails if the highest throughput is above this value", maxExpectedThroughput);
79  cmd.Parse (argc,argv);
80 
81  if (useRts)
82  {
83  Config::SetDefault ("ns3::WifiRemoteStationManager::RtsCtsThreshold", StringValue ("0"));
84  }
85 
86  double prevThroughput [8];
87  for (uint32_t l = 0; l < 8; l++)
88  {
89  prevThroughput[l] = 0;
90  }
91  std::cout << "MCS value" << "\t\t" << "Channel width" << "\t\t" << "short GI" << "\t\t" << "Throughput" << '\n';
92  int minMcs = 0;
93  int maxMcs = 9;
94  if (mcs >= 0 && mcs <= 9)
95  {
96  minMcs = mcs;
97  maxMcs = mcs;
98  }
99  for (int mcs = minMcs; mcs <= maxMcs; mcs++)
100  {
101  uint8_t index = 0;
102  double previous = 0;
103  for (int channelWidth = 20; channelWidth <= 160; )
104  {
105  if (mcs == 9 && channelWidth == 20)
106  {
107  channelWidth *= 2;
108  continue;
109  }
110  for (int sgi = 0; sgi < 2; sgi++)
111  {
112  uint32_t payloadSize; //1500 byte IP packet
113  if (udp)
114  {
115  payloadSize = 1472; //bytes
116  }
117  else
118  {
119  payloadSize = 1448; //bytes
120  Config::SetDefault ("ns3::TcpSocket::SegmentSize", UintegerValue (payloadSize));
121  }
122 
123  NodeContainer wifiStaNode;
124  wifiStaNode.Create (1);
126  wifiApNode.Create (1);
127 
130  phy.SetChannel (channel.Create ());
131 
132  // Set guard interval
133  phy.Set ("ShortGuardEnabled", BooleanValue (sgi));
134 
136  wifi.SetStandard (WIFI_PHY_STANDARD_80211ac);
138 
139  std::ostringstream oss;
140  oss << "VhtMcs" << mcs;
141  wifi.SetRemoteStationManager ("ns3::ConstantRateWifiManager","DataMode", StringValue (oss.str ()),
142  "ControlMode", StringValue (oss.str ()));
143 
144  Ssid ssid = Ssid ("ns3-80211ac");
145 
146  mac.SetType ("ns3::StaWifiMac",
147  "Ssid", SsidValue (ssid));
148 
149  NetDeviceContainer staDevice;
150  staDevice = wifi.Install (phy, mac, wifiStaNode);
151 
152  mac.SetType ("ns3::ApWifiMac",
153  "EnableBeaconJitter", BooleanValue (false),
154  "Ssid", SsidValue (ssid));
155 
156  NetDeviceContainer apDevice;
157  apDevice = wifi.Install (phy, mac, wifiApNode);
158 
159  // Set channel width
160  Config::Set ("/NodeList/*/DeviceList/*/$ns3::WifiNetDevice/Phy/ChannelWidth", UintegerValue (channelWidth));
161 
162  // mobility.
164  Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator> ();
165 
166  positionAlloc->Add (Vector (0.0, 0.0, 0.0));
167  positionAlloc->Add (Vector (distance, 0.0, 0.0));
168  mobility.SetPositionAllocator (positionAlloc);
169 
170  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
171 
172  mobility.Install (wifiApNode);
173  mobility.Install (wifiStaNode);
174 
175  /* Internet stack*/
177  stack.Install (wifiApNode);
178  stack.Install (wifiStaNode);
179 
181  address.SetBase ("192.168.1.0", "255.255.255.0");
182  Ipv4InterfaceContainer staNodeInterface;
183  Ipv4InterfaceContainer apNodeInterface;
184 
185  staNodeInterface = address.Assign (staDevice);
186  apNodeInterface = address.Assign (apDevice);
187 
188  /* Setting applications */
189  ApplicationContainer serverApp;
190  if (udp)
191  {
192  //UDP flow
193  uint16_t port = 9;
194  UdpServerHelper server (port);
195  serverApp = server.Install (wifiStaNode.Get (0));
196  serverApp.Start (Seconds (0.0));
197  serverApp.Stop (Seconds (simulationTime + 1));
198 
199  UdpClientHelper client (staNodeInterface.GetAddress (0), port);
200  client.SetAttribute ("MaxPackets", UintegerValue (4294967295u));
201  client.SetAttribute ("Interval", TimeValue (Time ("0.00001"))); //packets/s
202  client.SetAttribute ("PacketSize", UintegerValue (payloadSize));
203  ApplicationContainer clientApp = client.Install (wifiApNode.Get (0));
204  clientApp.Start (Seconds (1.0));
205  clientApp.Stop (Seconds (simulationTime + 1));
206  }
207  else
208  {
209  //TCP flow
210  uint16_t port = 50000;
211  Address localAddress (InetSocketAddress (Ipv4Address::GetAny (), port));
212  PacketSinkHelper packetSinkHelper ("ns3::TcpSocketFactory", localAddress);
213  serverApp = packetSinkHelper.Install (wifiStaNode.Get (0));
214  serverApp.Start (Seconds (0.0));
215  serverApp.Stop (Seconds (simulationTime + 1));
216 
217  OnOffHelper onoff ("ns3::TcpSocketFactory", Ipv4Address::GetAny ());
218  onoff.SetAttribute ("OnTime", StringValue ("ns3::ConstantRandomVariable[Constant=1]"));
219  onoff.SetAttribute ("OffTime", StringValue ("ns3::ConstantRandomVariable[Constant=0]"));
220  onoff.SetAttribute ("PacketSize", UintegerValue (payloadSize));
221  onoff.SetAttribute ("DataRate", DataRateValue (1000000000)); //bit/s
222  AddressValue remoteAddress (InetSocketAddress (staNodeInterface.GetAddress (0), port));
223  onoff.SetAttribute ("Remote", remoteAddress);
224  ApplicationContainer clientApp = onoff.Install (wifiApNode.Get (0));
225  clientApp.Start (Seconds (1.0));
226  clientApp.Stop (Seconds (simulationTime + 1));
227  }
228 
230 
231  Simulator::Stop (Seconds (simulationTime + 1));
232  Simulator::Run ();
233 
234  uint64_t rxBytes = 0;
235  if (udp)
236  {
237  rxBytes = payloadSize * DynamicCast<UdpServer> (serverApp.Get (0))->GetReceived ();
238  }
239  else
240  {
241  rxBytes = DynamicCast<PacketSink> (serverApp.Get (0))->GetTotalRx ();
242  }
243  double throughput = (rxBytes * 8) / (simulationTime * 1000000.0); //Mbit/s
244 
246 
247  std::cout << mcs << "\t\t\t" << channelWidth << " MHz\t\t\t" << sgi << "\t\t\t" << throughput << " Mbit/s" << std::endl;
248 
249  //test first element
250  if (mcs == 0 && channelWidth == 20 && sgi == 0)
251  {
252  if (throughput < minExpectedThroughput)
253  {
254  NS_LOG_ERROR ("Obtained throughput " << throughput << " is not expected!");
255  exit (1);
256  }
257  }
258  //test last element
259  if (mcs == 9 && channelWidth == 160 && sgi == 1)
260  {
261  if (maxExpectedThroughput > 0 && throughput > maxExpectedThroughput)
262  {
263  NS_LOG_ERROR ("Obtained throughput " << throughput << " is not expected!");
264  exit (1);
265  }
266  }
267  //test previous throughput is smaller (for the same mcs)
268  if (throughput > previous)
269  {
270  previous = throughput;
271  }
272  else
273  {
274  NS_LOG_ERROR ("Obtained throughput " << throughput << " is not expected!");
275  exit (1);
276  }
277  //test previous throughput is smaller (for the same channel width and GI)
278  if (throughput > prevThroughput [index])
279  {
280  prevThroughput [index] = throughput;
281  }
282  else
283  {
284  NS_LOG_ERROR ("Obtained throughput " << throughput << " is not expected!");
285  exit (1);
286  }
287  index++;
288  }
289  channelWidth *= 2;
290  }
291  }
292  return 0;
293 }
holds a vector of ns3::Application pointers.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
an Inet address class
static Ipv4Address GetAny(void)
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
AttributeValue implementation for Boolean.
Definition: boolean.h:36
holds a vector of std::pair of Ptr<Ipv4> and interface index.
static void PopulateRoutingTables(void)
Build a routing database and initialize the routing tables of the nodes in the simulation.
Hold variables of type string.
Definition: string.h:41
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.
void Set(std::string path, const AttributeValue &value)
Definition: config.cc:777
static void Run(void)
Run the simulation.
Definition: simulator.cc:226
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
aggregate IP/TCP/UDP functionality to existing Nodes.
A helper to make it easier to instantiate an ns3::PacketSinkApplication on a set of nodes...
cmd
Definition: second.py:35
static YansWifiPhyHelper Default(void)
Create a phy helper in a default working state.
STL namespace.
helps to create WifiNetDevice objects
Definition: wifi-helper.h:230
A helper to make it easier to instantiate an ns3::OnOffApplication on a set of nodes.
Definition: on-off-helper.h:42
stack
Definition: first.py:34
uint16_t port
Definition: dsdv-manet.cc:45
a polymophic address class
Definition: address.h:90
channel
Definition: third.py:85
mobility
Definition: third.py:101
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:1076
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
Hold an unsigned integer type.
Definition: uinteger.h:44
ssid
Definition: third.py:93
holds a vector of ns3::NetDevice pointers
mac
Definition: third.py:92
Create a server application which waits for input UDP packets and uses the information carried into t...
wifiApNode
Definition: third.py:83
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:213
static void Destroy(void)
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:190
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.
address
Definition: first.py:37
manage and create wifi channel objects for the yans model.
create MAC layers for a ns3::WifiNetDevice.
The IEEE 802.11 SSID Information Element.
Definition: ssid.h:35
wifi
Definition: third.py:89
Helper class used to assign positions and mobility models to nodes.
AttributeValue implementation for Address.
Definition: address.h:278
void Stop(Time stop)
Arrange for all of the Applications in this container to Stop() at the Time given as a parameter...
AttributeValue implementation for DataRate.
Definition: data-rate.h:242
static void Stop(void)
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:234
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1014
AttributeValue implementation for Ssid.
Definition: ssid.h:110
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:782
void Add(Vector v)
Add a position to the list of positions.
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
#define NS_LOG_ERROR(msg)
Use NS_LOG to output a message of level LOG_ERROR.
Definition: log.h:254
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
Ptr< Application > Get(uint32_t i) const
Get the Ptr<Application> stored in this container at a given index.