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/uinteger.h"
36#include "ns3/vht-phy.h"
37#include "ns3/yans-wifi-channel.h"
38#include "ns3/yans-wifi-helper.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
43// 9, where 9 is forbidden when the channel width is 20 MHz), the channel width (20, 40, 80 or 160
44// MHz) and the guard interval (long or short). The PHY bitrate is constant over all the simulation
45// run. The user can also specify the distance between the access point and the station: the larger
46// the distance the smaller the goodput.
47//
48// The simulation assumes a single station in an infrastructure network:
49//
50// STA AP
51// * *
52// | |
53// n1 n2
54//
55// Packets in this simulation belong to BestEffort Access Class (AC_BE).
56
57using namespace ns3;
58
59NS_LOG_COMPONENT_DEFINE("vht-wifi-network");
60
61int
62main(int argc, char* argv[])
63{
64 bool udp = true;
65 bool useRts = false;
66 double simulationTime = 10; // seconds
67 double distance = 1.0; // meters
68 int mcs = -1; // -1 indicates an unset value
69 double minExpectedThroughput = 0;
70 double maxExpectedThroughput = 0;
71
72 CommandLine cmd(__FILE__);
73 cmd.AddValue("distance",
74 "Distance in meters between the station and the access point",
75 distance);
76 cmd.AddValue("simulationTime", "Simulation time in seconds", simulationTime);
77 cmd.AddValue("udp", "UDP if set to 1, TCP otherwise", udp);
78 cmd.AddValue("useRts", "Enable/disable RTS/CTS", useRts);
79 cmd.AddValue("mcs", "if set, limit testing to a specific MCS (0-9)", mcs);
80 cmd.AddValue("minExpectedThroughput",
81 "if set, simulation fails if the lowest throughput is below this value",
82 minExpectedThroughput);
83 cmd.AddValue("maxExpectedThroughput",
84 "if set, simulation fails if the highest throughput is above this value",
85 maxExpectedThroughput);
86 cmd.Parse(argc, argv);
87
88 if (useRts)
89 {
90 Config::SetDefault("ns3::WifiRemoteStationManager::RtsCtsThreshold", StringValue("0"));
91 }
92
93 double prevThroughput[8];
94 for (uint32_t l = 0; l < 8; l++)
95 {
96 prevThroughput[l] = 0;
97 }
98 std::cout << "MCS value"
99 << "\t\t"
100 << "Channel width"
101 << "\t\t"
102 << "short GI"
103 << "\t\t"
104 << "Throughput" << '\n';
105 int minMcs = 0;
106 int maxMcs = 9;
107 if (mcs >= 0 && mcs <= 9)
108 {
109 minMcs = mcs;
110 maxMcs = mcs;
111 }
112 for (int mcs = minMcs; mcs <= maxMcs; mcs++)
113 {
114 uint8_t index = 0;
115 double previous = 0;
116 for (int channelWidth = 20; channelWidth <= 160;)
117 {
118 if (mcs == 9 && channelWidth == 20)
119 {
120 channelWidth *= 2;
121 continue;
122 }
123 for (int sgi = 0; sgi < 2; sgi++)
124 {
125 uint32_t payloadSize; // 1500 byte IP packet
126 if (udp)
127 {
128 payloadSize = 1472; // bytes
129 }
130 else
131 {
132 payloadSize = 1448; // bytes
133 Config::SetDefault("ns3::TcpSocket::SegmentSize", UintegerValue(payloadSize));
134 }
135
136 NodeContainer wifiStaNode;
137 wifiStaNode.Create(1);
139 wifiApNode.Create(1);
140
143 phy.SetChannel(channel.Create());
144
145 phy.Set("ChannelSettings",
146 StringValue("{0, " + std::to_string(channelWidth) + ", BAND_5GHZ, 0}"));
147
149 wifi.SetStandard(WIFI_STANDARD_80211ac);
151
152 std::ostringstream ossControlMode;
153 auto nonHtRefRateMbps = VhtPhy::GetNonHtReferenceRate(mcs) / 1e6;
154 ossControlMode << "OfdmRate" << nonHtRefRateMbps << "Mbps";
155
156 std::ostringstream ossDataMode;
157 ossDataMode << "VhtMcs" << mcs;
158 wifi.SetRemoteStationManager("ns3::ConstantRateWifiManager",
159 "DataMode",
160 StringValue(ossDataMode.str()),
161 "ControlMode",
162 StringValue(ossControlMode.str()));
163
164 // Set guard interval
165 wifi.ConfigHtOptions("ShortGuardIntervalSupported", BooleanValue(sgi));
166
167 Ssid ssid = Ssid("ns3-80211ac");
168
169 mac.SetType("ns3::StaWifiMac", "Ssid", SsidValue(ssid));
170
171 NetDeviceContainer staDevice;
172 staDevice = wifi.Install(phy, mac, wifiStaNode);
173
174 mac.SetType("ns3::ApWifiMac",
175 "EnableBeaconJitter",
176 BooleanValue(false),
177 "Ssid",
178 SsidValue(ssid));
179
180 NetDeviceContainer apDevice;
181 apDevice = wifi.Install(phy, mac, wifiApNode);
182
183 // mobility.
185 Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator>();
186
187 positionAlloc->Add(Vector(0.0, 0.0, 0.0));
188 positionAlloc->Add(Vector(distance, 0.0, 0.0));
189 mobility.SetPositionAllocator(positionAlloc);
190
191 mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
192
193 mobility.Install(wifiApNode);
194 mobility.Install(wifiStaNode);
195
196 /* Internet stack*/
198 stack.Install(wifiApNode);
199 stack.Install(wifiStaNode);
200
202 address.SetBase("192.168.1.0", "255.255.255.0");
203 Ipv4InterfaceContainer staNodeInterface;
204 Ipv4InterfaceContainer apNodeInterface;
205
206 staNodeInterface = address.Assign(staDevice);
207 apNodeInterface = address.Assign(apDevice);
208
209 /* Setting applications */
210 ApplicationContainer serverApp;
211 if (udp)
212 {
213 // UDP flow
214 uint16_t port = 9;
215 UdpServerHelper server(port);
216 serverApp = server.Install(wifiStaNode.Get(0));
217 serverApp.Start(Seconds(0.0));
218 serverApp.Stop(Seconds(simulationTime + 1));
219
220 UdpClientHelper client(staNodeInterface.GetAddress(0), port);
221 client.SetAttribute("MaxPackets", UintegerValue(4294967295U));
222 client.SetAttribute("Interval", TimeValue(Time("0.00002"))); // packets/s
223 client.SetAttribute("PacketSize", UintegerValue(payloadSize));
224 ApplicationContainer clientApp = client.Install(wifiApNode.Get(0));
225 clientApp.Start(Seconds(1.0));
226 clientApp.Stop(Seconds(simulationTime + 1));
227 }
228 else
229 {
230 // TCP flow
231 uint16_t port = 50000;
233 PacketSinkHelper packetSinkHelper("ns3::TcpSocketFactory", localAddress);
234 serverApp = packetSinkHelper.Install(wifiStaNode.Get(0));
235 serverApp.Start(Seconds(0.0));
236 serverApp.Stop(Seconds(simulationTime + 1));
237
238 OnOffHelper onoff("ns3::TcpSocketFactory", Ipv4Address::GetAny());
239 onoff.SetAttribute("OnTime",
240 StringValue("ns3::ConstantRandomVariable[Constant=1]"));
241 onoff.SetAttribute("OffTime",
242 StringValue("ns3::ConstantRandomVariable[Constant=0]"));
243 onoff.SetAttribute("PacketSize", UintegerValue(payloadSize));
244 onoff.SetAttribute("DataRate", DataRateValue(1000000000)); // bit/s
245 AddressValue remoteAddress(
246 InetSocketAddress(staNodeInterface.GetAddress(0), port));
247 onoff.SetAttribute("Remote", remoteAddress);
248 ApplicationContainer clientApp = onoff.Install(wifiApNode.Get(0));
249 clientApp.Start(Seconds(1.0));
250 clientApp.Stop(Seconds(simulationTime + 1));
251 }
252
254
255 Simulator::Stop(Seconds(simulationTime + 1));
257
258 uint64_t rxBytes = 0;
259 if (udp)
260 {
261 rxBytes = payloadSize * DynamicCast<UdpServer>(serverApp.Get(0))->GetReceived();
262 }
263 else
264 {
265 rxBytes = DynamicCast<PacketSink>(serverApp.Get(0))->GetTotalRx();
266 }
267 double throughput = (rxBytes * 8) / (simulationTime * 1000000.0); // Mbit/s
268
270
271 std::cout << mcs << "\t\t\t" << channelWidth << " MHz\t\t\t" << sgi << "\t\t\t"
272 << throughput << " Mbit/s" << std::endl;
273
274 // test first element
275 if (mcs == 0 && channelWidth == 20 && sgi == 0)
276 {
277 if (throughput < minExpectedThroughput)
278 {
279 NS_LOG_ERROR("Obtained throughput " << throughput << " is not expected!");
280 exit(1);
281 }
282 }
283 // test last element
284 if (mcs == 9 && channelWidth == 160 && sgi == 1)
285 {
286 if (maxExpectedThroughput > 0 && throughput > maxExpectedThroughput)
287 {
288 NS_LOG_ERROR("Obtained throughput " << throughput << " is not expected!");
289 exit(1);
290 }
291 }
292 // test previous throughput is smaller (for the same mcs)
293 if (throughput > previous)
294 {
295 previous = throughput;
296 }
297 else
298 {
299 NS_LOG_ERROR("Obtained throughput " << throughput << " is not expected!");
300 exit(1);
301 }
302 // test previous throughput is smaller (for the same channel width and GI)
303 if (throughput > prevThroughput[index])
304 {
305 prevThroughput[index] = throughput;
306 }
307 else
308 {
309 NS_LOG_ERROR("Obtained throughput " << throughput << " is not expected!");
310 exit(1);
311 }
312 index++;
313 }
314 channelWidth *= 2;
315 }
316 }
317 return 0;
318}
a polymophic address class
Definition: address.h:100
AttributeValue implementation for Address.
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.
AttributeValue implementation for Boolean.
Definition: boolean.h:37
Parse command-line arguments.
Definition: command-line.h:232
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.
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:44
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:78
static void Destroy()
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:140
static void Run()
Run the simulation.
Definition: simulator.cc:176
static void Stop()
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:184
The IEEE 802.11 SSID Information Element.
Definition: ssid.h:36
AttributeValue implementation for Ssid.
Hold variables of type string.
Definition: string.h:56
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
AttributeValue implementation for Time.
Definition: nstime.h:1423
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 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:487
helps to create WifiNetDevice objects
Definition: wifi-helper.h:325
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:45
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:891
#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:1336
@ WIFI_STANDARD_80211ac
ns address
Definition: first.py:40
ns stack
Definition: first.py:37
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns cmd
Definition: second.py:33
ns wifi
Definition: third.py:88
ns ssid
Definition: third.py:86
ns mac
Definition: third.py:85
ns wifiApNode
Definition: third.py:79
ns channel
Definition: third.py:81
ns mobility
Definition: third.py:96
ns phy
Definition: third.py:82