A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
wifi-vht-network.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2015 SEBASTIEN DERONNE
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation;
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 *
17 * Author: Sebastien Deronne <sebastien.deronne@gmail.com>
18 */
19
20#include "ns3/boolean.h"
21#include "ns3/command-line.h"
22#include "ns3/config.h"
23#include "ns3/double.h"
24#include "ns3/internet-stack-helper.h"
25#include "ns3/ipv4-address-helper.h"
26#include "ns3/ipv4-global-routing-helper.h"
27#include "ns3/log.h"
28#include "ns3/mobility-helper.h"
29#include "ns3/on-off-helper.h"
30#include "ns3/packet-sink-helper.h"
31#include "ns3/packet-sink.h"
32#include "ns3/ssid.h"
33#include "ns3/string.h"
34#include "ns3/udp-client-server-helper.h"
35#include "ns3/udp-server.h"
36#include "ns3/uinteger.h"
37#include "ns3/vht-phy.h"
38#include "ns3/yans-wifi-channel.h"
39#include "ns3/yans-wifi-helper.h"
40
41// This is a simple example in order to show how to configure an IEEE 802.11ac Wi-Fi network.
42//
43// It outputs the UDP or TCP goodput for every VHT MCS value, which depends on the MCS value (0 to
44// 9, where 9 is forbidden when the channel width is 20 MHz), the channel width (20, 40, 80 or 160
45// MHz) and the guard interval (long or short). The PHY bitrate is constant over all the simulation
46// run. The user can also specify the distance between the access point and the station: the larger
47// the distance the smaller the goodput.
48//
49// The simulation assumes a single station in an infrastructure network:
50//
51// STA AP
52// * *
53// | |
54// n1 n2
55//
56// Packets in this simulation belong to BestEffort Access Class (AC_BE).
57
58using namespace ns3;
59
60NS_LOG_COMPONENT_DEFINE("vht-wifi-network");
61
62int
63main(int argc, char* argv[])
64{
65 bool udp{true};
66 bool useRts{false};
67 Time simulationTime{"10s"};
68 double distance{1.0}; // meters
69 int mcs{-1}; // -1 indicates an unset value
70 double minExpectedThroughput{0.0};
71 double maxExpectedThroughput{0.0};
72
73 CommandLine cmd(__FILE__);
74 cmd.AddValue("distance",
75 "Distance in meters between the station and the access point",
76 distance);
77 cmd.AddValue("simulationTime", "Simulation time", simulationTime);
78 cmd.AddValue("udp", "UDP if set to 1, TCP otherwise", udp);
79 cmd.AddValue("useRts", "Enable/disable RTS/CTS", useRts);
80 cmd.AddValue("mcs", "if set, limit testing to a specific MCS (0-9)", mcs);
81 cmd.AddValue("minExpectedThroughput",
82 "if set, simulation fails if the lowest throughput is below this value",
83 minExpectedThroughput);
84 cmd.AddValue("maxExpectedThroughput",
85 "if set, simulation fails if the highest throughput is above this value",
86 maxExpectedThroughput);
87 cmd.Parse(argc, argv);
88
89 if (useRts)
90 {
91 Config::SetDefault("ns3::WifiRemoteStationManager::RtsCtsThreshold", StringValue("0"));
92 }
93
94 double prevThroughput[8] = {0};
95
96 std::cout << "MCS value"
97 << "\t\t"
98 << "Channel width"
99 << "\t\t"
100 << "short GI"
101 << "\t\t"
102 << "Throughput" << '\n';
103 int minMcs = 0;
104 int maxMcs = 9;
105 if (mcs >= 0 && mcs <= 9)
106 {
107 minMcs = mcs;
108 maxMcs = mcs;
109 }
110 for (int mcs = minMcs; mcs <= maxMcs; mcs++)
111 {
112 uint8_t index = 0;
113 double previous = 0;
114 for (int channelWidth = 20; channelWidth <= 160;)
115 {
116 if (mcs == 9 && channelWidth == 20)
117 {
118 channelWidth *= 2;
119 continue;
120 }
121 for (auto sgi : {false, true})
122 {
123 uint32_t payloadSize; // 1500 byte IP packet
124 if (udp)
125 {
126 payloadSize = 1472; // bytes
127 }
128 else
129 {
130 payloadSize = 1448; // bytes
131 Config::SetDefault("ns3::TcpSocket::SegmentSize", UintegerValue(payloadSize));
132 }
133
134 NodeContainer wifiStaNode;
135 wifiStaNode.Create(1);
137 wifiApNode.Create(1);
138
141 phy.SetChannel(channel.Create());
142
143 phy.Set("ChannelSettings",
144 StringValue("{0, " + std::to_string(channelWidth) + ", BAND_5GHZ, 0}"));
145
147 wifi.SetStandard(WIFI_STANDARD_80211ac);
149
150 std::ostringstream ossControlMode;
151 auto nonHtRefRateMbps = VhtPhy::GetNonHtReferenceRate(mcs) / 1e6;
152 ossControlMode << "OfdmRate" << nonHtRefRateMbps << "Mbps";
153
154 std::ostringstream ossDataMode;
155 ossDataMode << "VhtMcs" << mcs;
156 wifi.SetRemoteStationManager("ns3::ConstantRateWifiManager",
157 "DataMode",
158 StringValue(ossDataMode.str()),
159 "ControlMode",
160 StringValue(ossControlMode.str()));
161
162 // Set guard interval
163 wifi.ConfigHtOptions("ShortGuardIntervalSupported", BooleanValue(sgi));
164
165 Ssid ssid = Ssid("ns3-80211ac");
166
167 mac.SetType("ns3::StaWifiMac", "Ssid", SsidValue(ssid));
168
169 NetDeviceContainer staDevice;
170 staDevice = wifi.Install(phy, mac, wifiStaNode);
171
172 mac.SetType("ns3::ApWifiMac",
173 "EnableBeaconJitter",
174 BooleanValue(false),
175 "Ssid",
176 SsidValue(ssid));
177
178 NetDeviceContainer apDevice;
179 apDevice = wifi.Install(phy, mac, wifiApNode);
180
181 int64_t streamNumber = 150;
182 streamNumber += wifi.AssignStreams(apDevice, streamNumber);
183 streamNumber += wifi.AssignStreams(staDevice, streamNumber);
184
185 // mobility.
187 Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator>();
188
189 positionAlloc->Add(Vector(0.0, 0.0, 0.0));
190 positionAlloc->Add(Vector(distance, 0.0, 0.0));
191 mobility.SetPositionAllocator(positionAlloc);
192
193 mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
194
195 mobility.Install(wifiApNode);
196 mobility.Install(wifiStaNode);
197
198 /* Internet stack*/
200 stack.Install(wifiApNode);
201 stack.Install(wifiStaNode);
202 streamNumber += stack.AssignStreams(wifiApNode, streamNumber);
203 streamNumber += stack.AssignStreams(wifiStaNode, streamNumber);
204
206 address.SetBase("192.168.1.0", "255.255.255.0");
207 Ipv4InterfaceContainer staNodeInterface;
208 Ipv4InterfaceContainer apNodeInterface;
209
210 staNodeInterface = address.Assign(staDevice);
211 apNodeInterface = address.Assign(apDevice);
212
213 /* Setting applications */
214 const auto maxLoad = VhtPhy::GetDataRate(mcs, channelWidth, sgi ? 400 : 800, 1);
215 ApplicationContainer serverApp;
216 if (udp)
217 {
218 // UDP flow
219 uint16_t port = 9;
221 serverApp = server.Install(wifiStaNode.Get(0));
222 streamNumber += server.AssignStreams(wifiStaNode.Get(0), streamNumber);
223
224 serverApp.Start(Seconds(0.0));
225 serverApp.Stop(simulationTime + Seconds(1.0));
226 const auto packetInterval = payloadSize * 8.0 / maxLoad;
227
228 UdpClientHelper client(staNodeInterface.GetAddress(0), port);
229 client.SetAttribute("MaxPackets", UintegerValue(4294967295U));
230 client.SetAttribute("Interval", TimeValue(Seconds(packetInterval)));
231 client.SetAttribute("PacketSize", UintegerValue(payloadSize));
232 ApplicationContainer clientApp = client.Install(wifiApNode.Get(0));
233 streamNumber += client.AssignStreams(wifiApNode.Get(0), streamNumber);
234
235 clientApp.Start(Seconds(1.0));
236 clientApp.Stop(simulationTime + Seconds(1.0));
237 }
238 else
239 {
240 // TCP flow
241 uint16_t port = 50000;
243 PacketSinkHelper packetSinkHelper("ns3::TcpSocketFactory", localAddress);
244 serverApp = packetSinkHelper.Install(wifiStaNode.Get(0));
245 streamNumber +=
246 packetSinkHelper.AssignStreams(wifiStaNode.Get(0), streamNumber);
247
248 serverApp.Start(Seconds(0.0));
249 serverApp.Stop(simulationTime + Seconds(1.0));
250
251 OnOffHelper onoff("ns3::TcpSocketFactory", Ipv4Address::GetAny());
252 onoff.SetAttribute("OnTime",
253 StringValue("ns3::ConstantRandomVariable[Constant=1]"));
254 onoff.SetAttribute("OffTime",
255 StringValue("ns3::ConstantRandomVariable[Constant=0]"));
256 onoff.SetAttribute("PacketSize", UintegerValue(payloadSize));
257 onoff.SetAttribute("DataRate", DataRateValue(maxLoad));
259 InetSocketAddress(staNodeInterface.GetAddress(0), port));
260 onoff.SetAttribute("Remote", remoteAddress);
261 ApplicationContainer clientApp = onoff.Install(wifiApNode.Get(0));
262 streamNumber += onoff.AssignStreams(wifiApNode.Get(0), streamNumber);
263
264 clientApp.Start(Seconds(1.0));
265 clientApp.Stop(simulationTime + Seconds(1.0));
266 }
267
269
270 Simulator::Stop(simulationTime + Seconds(1.0));
272
273 auto rxBytes = 0.0;
274 if (udp)
275 {
276 rxBytes = payloadSize * DynamicCast<UdpServer>(serverApp.Get(0))->GetReceived();
277 }
278 else
279 {
280 rxBytes = DynamicCast<PacketSink>(serverApp.Get(0))->GetTotalRx();
281 }
282 auto throughput = (rxBytes * 8) / simulationTime.GetMicroSeconds(); // Mbit/s
283
285
286 std::cout << mcs << "\t\t\t" << channelWidth << " MHz\t\t\t" << std::boolalpha
287 << sgi << "\t\t\t" << throughput << " Mbit/s" << std::endl;
288
289 // test first element
290 if (mcs == minMcs && channelWidth == 20 && !sgi)
291 {
292 if (throughput < minExpectedThroughput)
293 {
294 NS_LOG_ERROR("Obtained throughput " << throughput << " is not expected!");
295 exit(1);
296 }
297 }
298 // test last element
299 if (mcs == maxMcs && channelWidth == 160 && sgi)
300 {
301 if (maxExpectedThroughput > 0 && throughput > maxExpectedThroughput)
302 {
303 NS_LOG_ERROR("Obtained throughput " << throughput << " is not expected!");
304 exit(1);
305 }
306 }
307 // test previous throughput is smaller (for the same mcs)
308 if (throughput > previous)
309 {
310 previous = throughput;
311 }
312 else
313 {
314 NS_LOG_ERROR("Obtained throughput " << throughput << " is not expected!");
315 exit(1);
316 }
317 // test previous throughput is smaller (for the same channel width and GI)
318 if (throughput > prevThroughput[index])
319 {
320 prevThroughput[index] = throughput;
321 }
322 else
323 {
324 NS_LOG_ERROR("Obtained throughput " << throughput << " is not expected!");
325 exit(1);
326 }
327 index++;
328 }
329 channelWidth *= 2;
330 }
331 }
332 return 0;
333}
a polymophic address class
Definition: address.h:101
holds a vector of ns3::Application pointers.
void Start(Time start) const
Start all of the Applications in this container at the start time given as a parameter.
Ptr< Application > Get(uint32_t i) const
Get the Ptr<Application> stored in this container at a given index.
void Stop(Time stop) const
Arrange for all of the Applications in this container to Stop() at the Time given as a parameter.
Parse command-line arguments.
Definition: command-line.h:232
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.
static Ipv4Address GetAny()
static void PopulateRoutingTables()
Build a routing database and initialize the routing tables of the nodes in the simulation.
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:37
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:77
static void Destroy()
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:142
static void Run()
Run the simulation.
Definition: simulator.cc:178
static void Stop()
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:186
The IEEE 802.11 SSID Information Element.
Definition: ssid.h:36
Hold variables of type string.
Definition: string.h:56
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
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:45
static uint64_t GetDataRate(uint8_t mcsValue, uint16_t channelWidth, uint16_t guardInterval, uint8_t nss)
Return the data rate corresponding to the supplied VHT MCS index, channel width, guard interval,...
Definition: vht-phy.cc:459
static uint64_t GetNonHtReferenceRate(uint8_t mcsValue)
Calculate the rate in bps of the non-HT Reference Rate corresponding to the supplied VHT MCS index.
Definition: vht-phy.cc:488
helps to create WifiNetDevice objects
Definition: wifi-helper.h:324
create MAC layers for a ns3::WifiNetDevice.
manage and create wifi channel objects for the YANS model.
static YansWifiChannelHelper Default()
Create a channel helper in a default working state.
Make it easy to create and manage PHY objects for the YANS model.
uint16_t port
Definition: dsdv-manet.cc:44
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:894
#define NS_LOG_ERROR(msg)
Use NS_LOG to output a message of level LOG_ERROR.
Definition: log.h:254
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1319
@ WIFI_STANDARD_80211ac
ns address
Definition: first.py:47
ns stack
Definition: first.py:44
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns cmd
Definition: second.py:40
ns wifi
Definition: third.py:95
ns ssid
Definition: third.py:93
ns mac
Definition: third.py:92
ns wifiApNode
Definition: third.py:86
ns channel
Definition: third.py:88
ns mobility
Definition: third.py:103
ns phy
Definition: third.py:89
std::ofstream throughput