A Discrete-Event Network Simulator
API
wifi-vht-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 belong to BestEffort Access Class (AC_BE).
55
56using namespace ns3;
57
58NS_LOG_COMPONENT_DEFINE ("vht-wifi-network");
59
60int main (int argc, char *argv[])
61{
62 bool udp = true;
63 bool useRts = false;
64 double simulationTime = 10; //seconds
65 double distance = 1.0; //meters
66 int mcs = -1; // -1 indicates an unset value
67 double minExpectedThroughput = 0;
68 double maxExpectedThroughput = 0;
69
70 CommandLine cmd (__FILE__);
71 cmd.AddValue ("distance", "Distance in meters between the station and the access point", distance);
72 cmd.AddValue ("simulationTime", "Simulation time in seconds", simulationTime);
73 cmd.AddValue ("udp", "UDP if set to 1, TCP otherwise", udp);
74 cmd.AddValue ("useRts", "Enable/disable RTS/CTS", useRts);
75 cmd.AddValue ("mcs", "if set, limit testing to a specific MCS (0-9)", mcs);
76 cmd.AddValue ("minExpectedThroughput", "if set, simulation fails if the lowest throughput is below this value", minExpectedThroughput);
77 cmd.AddValue ("maxExpectedThroughput", "if set, simulation fails if the highest throughput is above this value", maxExpectedThroughput);
78 cmd.Parse (argc,argv);
79
80 if (useRts)
81 {
82 Config::SetDefault ("ns3::WifiRemoteStationManager::RtsCtsThreshold", StringValue ("0"));
83 }
84
85 double prevThroughput [8];
86 for (uint32_t l = 0; l < 8; l++)
87 {
88 prevThroughput[l] = 0;
89 }
90 std::cout << "MCS value" << "\t\t" << "Channel width" << "\t\t" << "short GI" << "\t\t" << "Throughput" << '\n';
91 int minMcs = 0;
92 int maxMcs = 9;
93 if (mcs >= 0 && mcs <= 9)
94 {
95 minMcs = mcs;
96 maxMcs = mcs;
97 }
98 for (int mcs = minMcs; mcs <= maxMcs; mcs++)
99 {
100 uint8_t index = 0;
101 double previous = 0;
102 for (int channelWidth = 20; channelWidth <= 160; )
103 {
104 if (mcs == 9 && channelWidth == 20)
105 {
106 channelWidth *= 2;
107 continue;
108 }
109 for (int sgi = 0; sgi < 2; sgi++)
110 {
111 uint32_t payloadSize; //1500 byte IP packet
112 if (udp)
113 {
114 payloadSize = 1472; //bytes
115 }
116 else
117 {
118 payloadSize = 1448; //bytes
119 Config::SetDefault ("ns3::TcpSocket::SegmentSize", UintegerValue (payloadSize));
120 }
121
122 NodeContainer wifiStaNode;
123 wifiStaNode.Create (1);
125 wifiApNode.Create (1);
126
127 YansWifiChannelHelper channel = YansWifiChannelHelper::Default ();
129 phy.SetChannel (channel.Create ());
130
131 phy.Set ("ChannelSettings", StringValue ("{0, " + std::to_string (channelWidth)
132 + ", BAND_5GHZ, 0}"));
133
135 wifi.SetStandard (WIFI_STANDARD_80211ac);
137
138 std::ostringstream oss;
139 oss << "VhtMcs" << mcs;
140 wifi.SetRemoteStationManager ("ns3::ConstantRateWifiManager","DataMode", StringValue (oss.str ()),
141 "ControlMode", StringValue (oss.str ()));
142
143 Ssid ssid = Ssid ("ns3-80211ac");
144
145 mac.SetType ("ns3::StaWifiMac",
146 "Ssid", SsidValue (ssid));
147
148 NetDeviceContainer staDevice;
149 staDevice = wifi.Install (phy, mac, wifiStaNode);
150
151 mac.SetType ("ns3::ApWifiMac",
152 "EnableBeaconJitter", BooleanValue (false),
153 "Ssid", SsidValue (ssid));
154
155 NetDeviceContainer apDevice;
156 apDevice = wifi.Install (phy, mac, wifiApNode);
157
158 // Set guard interval
159 Config::Set ("/NodeList/*/DeviceList/*/$ns3::WifiNetDevice/HtConfiguration/ShortGuardIntervalSupported", BooleanValue (sgi));
160
161 // mobility.
163 Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator> ();
164
165 positionAlloc->Add (Vector (0.0, 0.0, 0.0));
166 positionAlloc->Add (Vector (distance, 0.0, 0.0));
167 mobility.SetPositionAllocator (positionAlloc);
168
169 mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
170
171 mobility.Install (wifiApNode);
172 mobility.Install (wifiStaNode);
173
174 /* Internet stack*/
176 stack.Install (wifiApNode);
177 stack.Install (wifiStaNode);
178
180 address.SetBase ("192.168.1.0", "255.255.255.0");
181 Ipv4InterfaceContainer staNodeInterface;
182 Ipv4InterfaceContainer apNodeInterface;
183
184 staNodeInterface = address.Assign (staDevice);
185 apNodeInterface = address.Assign (apDevice);
186
187 /* Setting applications */
188 ApplicationContainer serverApp;
189 if (udp)
190 {
191 //UDP flow
192 uint16_t port = 9;
193 UdpServerHelper server (port);
194 serverApp = server.Install (wifiStaNode.Get (0));
195 serverApp.Start (Seconds (0.0));
196 serverApp.Stop (Seconds (simulationTime + 1));
197
198 UdpClientHelper client (staNodeInterface.GetAddress (0), port);
199 client.SetAttribute ("MaxPackets", UintegerValue (4294967295u));
200 client.SetAttribute ("Interval", TimeValue (Time ("0.00002"))); //packets/s
201 client.SetAttribute ("PacketSize", UintegerValue (payloadSize));
202 ApplicationContainer clientApp = client.Install (wifiApNode.Get (0));
203 clientApp.Start (Seconds (1.0));
204 clientApp.Stop (Seconds (simulationTime + 1));
205 }
206 else
207 {
208 //TCP flow
209 uint16_t port = 50000;
210 Address localAddress (InetSocketAddress (Ipv4Address::GetAny (), port));
211 PacketSinkHelper packetSinkHelper ("ns3::TcpSocketFactory", localAddress);
212 serverApp = packetSinkHelper.Install (wifiStaNode.Get (0));
213 serverApp.Start (Seconds (0.0));
214 serverApp.Stop (Seconds (simulationTime + 1));
215
216 OnOffHelper onoff ("ns3::TcpSocketFactory", Ipv4Address::GetAny ());
217 onoff.SetAttribute ("OnTime", StringValue ("ns3::ConstantRandomVariable[Constant=1]"));
218 onoff.SetAttribute ("OffTime", StringValue ("ns3::ConstantRandomVariable[Constant=0]"));
219 onoff.SetAttribute ("PacketSize", UintegerValue (payloadSize));
220 onoff.SetAttribute ("DataRate", DataRateValue (1000000000)); //bit/s
221 AddressValue remoteAddress (InetSocketAddress (staNodeInterface.GetAddress (0), port));
222 onoff.SetAttribute ("Remote", remoteAddress);
223 ApplicationContainer clientApp = onoff.Install (wifiApNode.Get (0));
224 clientApp.Start (Seconds (1.0));
225 clientApp.Stop (Seconds (simulationTime + 1));
226 }
227
228 Ipv4GlobalRoutingHelper::PopulateRoutingTables ();
229
230 Simulator::Stop (Seconds (simulationTime + 1));
231 Simulator::Run ();
232
233 uint64_t rxBytes = 0;
234 if (udp)
235 {
236 rxBytes = payloadSize * DynamicCast<UdpServer> (serverApp.Get (0))->GetReceived ();
237 }
238 else
239 {
240 rxBytes = DynamicCast<PacketSink> (serverApp.Get (0))->GetTotalRx ();
241 }
242 double throughput = (rxBytes * 8) / (simulationTime * 1000000.0); //Mbit/s
243
244 Simulator::Destroy ();
245
246 std::cout << mcs << "\t\t\t" << channelWidth << " MHz\t\t\t" << sgi << "\t\t\t" << throughput << " Mbit/s" << std::endl;
247
248 //test first element
249 if (mcs == 0 && channelWidth == 20 && sgi == 0)
250 {
251 if (throughput < minExpectedThroughput)
252 {
253 NS_LOG_ERROR ("Obtained throughput " << throughput << " is not expected!");
254 exit (1);
255 }
256 }
257 //test last element
258 if (mcs == 9 && channelWidth == 160 && sgi == 1)
259 {
260 if (maxExpectedThroughput > 0 && throughput > maxExpectedThroughput)
261 {
262 NS_LOG_ERROR ("Obtained throughput " << throughput << " is not expected!");
263 exit (1);
264 }
265 }
266 //test previous throughput is smaller (for the same mcs)
267 if (throughput > previous)
268 {
269 previous = throughput;
270 }
271 else
272 {
273 NS_LOG_ERROR ("Obtained throughput " << throughput << " is not expected!");
274 exit (1);
275 }
276 //test previous throughput is smaller (for the same channel width and GI)
277 if (throughput > prevThroughput [index])
278 {
279 prevThroughput [index] = throughput;
280 }
281 else
282 {
283 NS_LOG_ERROR ("Obtained throughput " << throughput << " is not expected!");
284 exit (1);
285 }
286 index++;
287 }
288 channelWidth *= 2;
289 }
290 }
291 return 0;
292}
a polymophic address class
Definition: address.h:91
AttributeValue implementation for Address.
holds a vector of ns3::Application pointers.
Ptr< Application > Get(uint32_t i) const
Get the Ptr<Application> stored in this container at a given index.
void Start(Time start)
Arrange for all of the Applications in this container to Start() at the Time given as a parameter.
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 Boolean.
Definition: boolean.h:37
Parse command-line arguments.
Definition: command-line.h:229
AttributeValue implementation for DataRate.
an Inet address class
aggregate IP/TCP/UDP functionality to existing Nodes.
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
holds a vector of std::pair of Ptr<Ipv4> and interface index.
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
Helper class used to assign positions and mobility models to nodes.
holds a vector of ns3::NetDevice pointers
keep track of a set of node pointers.
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
A helper to make it easier to instantiate an ns3::OnOffApplication on a set of nodes.
Definition: on-off-helper.h:43
A helper to make it easier to instantiate an ns3::PacketSinkApplication on a set of nodes.
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:74
The IEEE 802.11 SSID Information Element.
Definition: ssid.h:36
AttributeValue implementation for Ssid.
Hold variables of type string.
Definition: string.h:41
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
AttributeValue implementation for Time.
Definition: nstime.h:1308
Create a client application which sends UDP packets carrying a 32bit sequence number and a 64 bit tim...
Create a server application which waits for input UDP packets and uses the information carried into t...
Hold an unsigned integer type.
Definition: uinteger.h:44
Vector3D Vector
Vector alias typedef for compatibility with mobility models.
Definition: vector.h:324
helps to create WifiNetDevice objects
Definition: wifi-helper.h:323
create MAC layers for a ns3::WifiNetDevice.
manage and create wifi channel objects for the YANS model.
Make it easy to create and manage PHY objects for the YANS model.
uint16_t port
Definition: dsdv-manet.cc:45
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:849
void Set(std::string path, const AttributeValue &value)
Definition: config.cc:839
#define NS_LOG_ERROR(msg)
Use NS_LOG to output a message of level LOG_ERROR.
Definition: log.h:257
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1244
@ WIFI_STANDARD_80211ac
address
Definition: first.py:44
stack
Definition: first.py:41
Every class exported by the ns3 library is enclosed in the ns3 namespace.
cmd
Definition: second.py:35
ssid
Definition: third.py:97
channel
Definition: third.py:92
mac
Definition: third.py:96
wifi
Definition: third.py:99
wifiApNode
Definition: third.py:90
mobility
Definition: third.py:107
phy
Definition: third.py:93