A Discrete-Event Network Simulator
API
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/yans-wifi-channel.h"
37#include "ns3/yans-wifi-helper.h"
38
39// This is a simple example in order to show how to configure an IEEE 802.11ac Wi-Fi network.
40//
41// It outputs the UDP or TCP goodput for every VHT MCS value, which depends on the MCS value (0 to
42// 9, where 9 is forbidden when the channel width is 20 MHz), the channel width (20, 40, 80 or 160
43// MHz) and the guard interval (long or short). The PHY bitrate is constant over all the simulation
44// run. The user can also specify the distance between the access point and the station: the larger
45// 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
61main(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
71 CommandLine cmd(__FILE__);
72 cmd.AddValue("distance",
73 "Distance in meters between the station and the access point",
74 distance);
75 cmd.AddValue("simulationTime", "Simulation time in seconds", simulationTime);
76 cmd.AddValue("udp", "UDP if set to 1, TCP otherwise", udp);
77 cmd.AddValue("useRts", "Enable/disable RTS/CTS", useRts);
78 cmd.AddValue("mcs", "if set, limit testing to a specific MCS (0-9)", mcs);
79 cmd.AddValue("minExpectedThroughput",
80 "if set, simulation fails if the lowest throughput is below this value",
81 minExpectedThroughput);
82 cmd.AddValue("maxExpectedThroughput",
83 "if set, simulation fails if the highest throughput is above this value",
84 maxExpectedThroughput);
85 cmd.Parse(argc, argv);
86
87 if (useRts)
88 {
89 Config::SetDefault("ns3::WifiRemoteStationManager::RtsCtsThreshold", StringValue("0"));
90 }
91
92 double prevThroughput[8];
93 for (uint32_t l = 0; l < 8; l++)
94 {
95 prevThroughput[l] = 0;
96 }
97 std::cout << "MCS value"
98 << "\t\t"
99 << "Channel width"
100 << "\t\t"
101 << "short GI"
102 << "\t\t"
103 << "Throughput" << '\n';
104 int minMcs = 0;
105 int maxMcs = 9;
106 if (mcs >= 0 && mcs <= 9)
107 {
108 minMcs = mcs;
109 maxMcs = mcs;
110 }
111 for (int mcs = minMcs; mcs <= maxMcs; mcs++)
112 {
113 uint8_t index = 0;
114 double previous = 0;
115 for (int channelWidth = 20; channelWidth <= 160;)
116 {
117 if (mcs == 9 && channelWidth == 20)
118 {
119 channelWidth *= 2;
120 continue;
121 }
122 for (int sgi = 0; sgi < 2; sgi++)
123 {
124 uint32_t payloadSize; // 1500 byte IP packet
125 if (udp)
126 {
127 payloadSize = 1472; // bytes
128 }
129 else
130 {
131 payloadSize = 1448; // bytes
132 Config::SetDefault("ns3::TcpSocket::SegmentSize", UintegerValue(payloadSize));
133 }
134
135 NodeContainer wifiStaNode;
136 wifiStaNode.Create(1);
138 wifiApNode.Create(1);
139
140 YansWifiChannelHelper channel = YansWifiChannelHelper::Default();
142 phy.SetChannel(channel.Create());
143
144 phy.Set("ChannelSettings",
145 StringValue("{0, " + std::to_string(channelWidth) + ", BAND_5GHZ, 0}"));
146
148 wifi.SetStandard(WIFI_STANDARD_80211ac);
150
151 std::ostringstream oss;
152 oss << "VhtMcs" << mcs;
153 wifi.SetRemoteStationManager("ns3::ConstantRateWifiManager",
154 "DataMode",
155 StringValue(oss.str()),
156 "ControlMode",
157 StringValue(oss.str()));
158 // Set guard interval
159 wifi.ConfigHtOptions("ShortGuardIntervalSupported", BooleanValue(sgi));
160
161 Ssid ssid = Ssid("ns3-80211ac");
162
163 mac.SetType("ns3::StaWifiMac", "Ssid", SsidValue(ssid));
164
165 NetDeviceContainer staDevice;
166 staDevice = wifi.Install(phy, mac, wifiStaNode);
167
168 mac.SetType("ns3::ApWifiMac",
169 "EnableBeaconJitter",
170 BooleanValue(false),
171 "Ssid",
172 SsidValue(ssid));
173
174 NetDeviceContainer apDevice;
175 apDevice = wifi.Install(phy, mac, wifiApNode);
176
177 // mobility.
179 Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator>();
180
181 positionAlloc->Add(Vector(0.0, 0.0, 0.0));
182 positionAlloc->Add(Vector(distance, 0.0, 0.0));
183 mobility.SetPositionAllocator(positionAlloc);
184
185 mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
186
187 mobility.Install(wifiApNode);
188 mobility.Install(wifiStaNode);
189
190 /* Internet stack*/
192 stack.Install(wifiApNode);
193 stack.Install(wifiStaNode);
194
196 address.SetBase("192.168.1.0", "255.255.255.0");
197 Ipv4InterfaceContainer staNodeInterface;
198 Ipv4InterfaceContainer apNodeInterface;
199
200 staNodeInterface = address.Assign(staDevice);
201 apNodeInterface = address.Assign(apDevice);
202
203 /* Setting applications */
204 ApplicationContainer serverApp;
205 if (udp)
206 {
207 // UDP flow
208 uint16_t port = 9;
209 UdpServerHelper server(port);
210 serverApp = server.Install(wifiStaNode.Get(0));
211 serverApp.Start(Seconds(0.0));
212 serverApp.Stop(Seconds(simulationTime + 1));
213
214 UdpClientHelper client(staNodeInterface.GetAddress(0), port);
215 client.SetAttribute("MaxPackets", UintegerValue(4294967295U));
216 client.SetAttribute("Interval", TimeValue(Time("0.00002"))); // packets/s
217 client.SetAttribute("PacketSize", UintegerValue(payloadSize));
218 ApplicationContainer clientApp = client.Install(wifiApNode.Get(0));
219 clientApp.Start(Seconds(1.0));
220 clientApp.Stop(Seconds(simulationTime + 1));
221 }
222 else
223 {
224 // TCP flow
225 uint16_t port = 50000;
226 Address localAddress(InetSocketAddress(Ipv4Address::GetAny(), port));
227 PacketSinkHelper packetSinkHelper("ns3::TcpSocketFactory", localAddress);
228 serverApp = packetSinkHelper.Install(wifiStaNode.Get(0));
229 serverApp.Start(Seconds(0.0));
230 serverApp.Stop(Seconds(simulationTime + 1));
231
232 OnOffHelper onoff("ns3::TcpSocketFactory", Ipv4Address::GetAny());
233 onoff.SetAttribute("OnTime",
234 StringValue("ns3::ConstantRandomVariable[Constant=1]"));
235 onoff.SetAttribute("OffTime",
236 StringValue("ns3::ConstantRandomVariable[Constant=0]"));
237 onoff.SetAttribute("PacketSize", UintegerValue(payloadSize));
238 onoff.SetAttribute("DataRate", DataRateValue(1000000000)); // bit/s
239 AddressValue remoteAddress(
240 InetSocketAddress(staNodeInterface.GetAddress(0), port));
241 onoff.SetAttribute("Remote", remoteAddress);
242 ApplicationContainer clientApp = onoff.Install(wifiApNode.Get(0));
243 clientApp.Start(Seconds(1.0));
244 clientApp.Stop(Seconds(simulationTime + 1));
245 }
246
247 Ipv4GlobalRoutingHelper::PopulateRoutingTables();
248
249 Simulator::Stop(Seconds(simulationTime + 1));
250 Simulator::Run();
251
252 uint64_t rxBytes = 0;
253 if (udp)
254 {
255 rxBytes = payloadSize * DynamicCast<UdpServer>(serverApp.Get(0))->GetReceived();
256 }
257 else
258 {
259 rxBytes = DynamicCast<PacketSink>(serverApp.Get(0))->GetTotalRx();
260 }
261 double throughput = (rxBytes * 8) / (simulationTime * 1000000.0); // Mbit/s
262
263 Simulator::Destroy();
264
265 std::cout << mcs << "\t\t\t" << channelWidth << " MHz\t\t\t" << sgi << "\t\t\t"
266 << throughput << " Mbit/s" << std::endl;
267
268 // test first element
269 if (mcs == 0 && channelWidth == 20 && sgi == 0)
270 {
271 if (throughput < minExpectedThroughput)
272 {
273 NS_LOG_ERROR("Obtained throughput " << throughput << " is not expected!");
274 exit(1);
275 }
276 }
277 // test last element
278 if (mcs == 9 && channelWidth == 160 && sgi == 1)
279 {
280 if (maxExpectedThroughput > 0 && throughput > maxExpectedThroughput)
281 {
282 NS_LOG_ERROR("Obtained throughput " << throughput << " is not expected!");
283 exit(1);
284 }
285 }
286 // test previous throughput is smaller (for the same mcs)
287 if (throughput > previous)
288 {
289 previous = throughput;
290 }
291 else
292 {
293 NS_LOG_ERROR("Obtained throughput " << throughput << " is not expected!");
294 exit(1);
295 }
296 // test previous throughput is smaller (for the same channel width and GI)
297 if (throughput > prevThroughput[index])
298 {
299 prevThroughput[index] = throughput;
300 }
301 else
302 {
303 NS_LOG_ERROR("Obtained throughput " << throughput << " is not expected!");
304 exit(1);
305 }
306 index++;
307 }
308 channelWidth *= 2;
309 }
310 }
311 return 0;
312}
a polymophic address class
Definition: address.h:92
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: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.
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
The IEEE 802.11 SSID Information Element.
Definition: ssid.h:36
AttributeValue implementation for Ssid.
Hold variables of type string.
Definition: string.h:42
AttributeValue implementation for Time.
Definition: nstime.h:1425
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
Vector3D Vector
Vector alias typedef for compatibility with mobility models.
Definition: vector.h:324
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.
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:1338
@ WIFI_STANDARD_80211ac
address
Definition: first.py:40
stack
Definition: first.py:37
void(* Time)(Time oldValue, Time newValue)
TracedValue callback signature for Time.
Definition: nstime.h:850
Every class exported by the ns3 library is enclosed in the ns3 namespace.
cmd
Definition: second.py:33
ssid
Definition: third.py:86
channel
Definition: third.py:81
mac
Definition: third.py:85
wifi
Definition: third.py:88
wifiApNode
Definition: third.py:79
mobility
Definition: third.py:96
phy
Definition: third.py:82