A Discrete-Event Network Simulator
API
wifi-ht-network.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2009 MIRKO BANCHI
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 * Authors: Mirko Banchi <mk.banchi@gmail.com>
18 * Sebastien Deronne <sebastien.deronne@gmail.com>
19 */
20
21#include "ns3/boolean.h"
22#include "ns3/command-line.h"
23#include "ns3/config.h"
24#include "ns3/double.h"
25#include "ns3/enum.h"
26#include "ns3/ht-phy.h"
27#include "ns3/internet-stack-helper.h"
28#include "ns3/ipv4-address-helper.h"
29#include "ns3/ipv4-global-routing-helper.h"
30#include "ns3/log.h"
31#include "ns3/mobility-helper.h"
32#include "ns3/on-off-helper.h"
33#include "ns3/packet-sink-helper.h"
34#include "ns3/packet-sink.h"
35#include "ns3/ssid.h"
36#include "ns3/string.h"
37#include "ns3/tuple.h"
38#include "ns3/udp-client-server-helper.h"
39#include "ns3/uinteger.h"
40#include "ns3/yans-wifi-channel.h"
41#include "ns3/yans-wifi-helper.h"
42
43// This is a simple example in order to show how to configure an IEEE 802.11n Wi-Fi network.
44//
45// It outputs the UDP or TCP goodput for every HT MCS value, which depends on the MCS value (0 to
46// 7), the channel width (20 or 40 MHz) and the guard interval (long or short). The PHY bitrate is
47// constant over all the simulation run. The user can also specify the distance between the access
48// point and the station: the larger the distance the smaller the goodput.
49//
50// The simulation assumes a single station in an infrastructure network:
51//
52// STA AP
53// * *
54// | |
55// n1 n2
56//
57// Packets in this simulation belong to BestEffort Access Class (AC_BE).
58
59using namespace ns3;
60
61NS_LOG_COMPONENT_DEFINE("ht-wifi-network");
62
63int
64main(int argc, char* argv[])
65{
66 bool udp = true;
67 bool useRts = false;
68 double simulationTime = 10; // seconds
69 double distance = 1.0; // meters
70 double frequency = 5.0; // whether 2.4 or 5.0 GHz
71 int mcs = -1; // -1 indicates an unset value
72 double minExpectedThroughput = 0;
73 double maxExpectedThroughput = 0;
74
75 CommandLine cmd(__FILE__);
76 cmd.AddValue("frequency",
77 "Whether working in the 2.4 or 5.0 GHz band (other values gets rejected)",
78 frequency);
79 cmd.AddValue("distance",
80 "Distance in meters between the station and the access point",
81 distance);
82 cmd.AddValue("simulationTime", "Simulation time in seconds", simulationTime);
83 cmd.AddValue("udp", "UDP if set to 1, TCP otherwise", udp);
84 cmd.AddValue("useRts", "Enable/disable RTS/CTS", useRts);
85 cmd.AddValue("mcs", "if set, limit testing to a specific MCS (0-7)", mcs);
86 cmd.AddValue("minExpectedThroughput",
87 "if set, simulation fails if the lowest throughput is below this value",
88 minExpectedThroughput);
89 cmd.AddValue("maxExpectedThroughput",
90 "if set, simulation fails if the highest throughput is above this value",
91 maxExpectedThroughput);
92 cmd.Parse(argc, argv);
93
94 if (useRts)
95 {
96 Config::SetDefault("ns3::WifiRemoteStationManager::RtsCtsThreshold", StringValue("0"));
97 }
98
99 double prevThroughput[8];
100 for (uint32_t l = 0; l < 8; l++)
101 {
102 prevThroughput[l] = 0;
103 }
104 std::cout << "MCS value"
105 << "\t\t"
106 << "Channel width"
107 << "\t\t"
108 << "short GI"
109 << "\t\t"
110 << "Throughput" << '\n';
111 int minMcs = 0;
112 int maxMcs = 7;
113 if (mcs >= 0 && mcs <= 7)
114 {
115 minMcs = mcs;
116 maxMcs = mcs;
117 }
118 for (int mcs = minMcs; mcs <= maxMcs; mcs++)
119 {
120 uint8_t index = 0;
121 double previous = 0;
122 for (int channelWidth = 20; channelWidth <= 40;)
123 {
124 for (int sgi = 0; sgi < 2; sgi++)
125 {
126 uint32_t payloadSize; // 1500 byte IP packet
127 if (udp)
128 {
129 payloadSize = 1472; // bytes
130 }
131 else
132 {
133 payloadSize = 1448; // bytes
134 Config::SetDefault("ns3::TcpSocket::SegmentSize", UintegerValue(payloadSize));
135 }
136
137 NodeContainer wifiStaNode;
138 wifiStaNode.Create(1);
140 wifiApNode.Create(1);
141
142 YansWifiChannelHelper channel = YansWifiChannelHelper::Default();
144 phy.SetChannel(channel.Create());
145
148 std::ostringstream ossControlMode;
149
150 if (frequency == 5.0)
151 {
152 ossControlMode << "OfdmRate";
153 wifi.SetStandard(WIFI_STANDARD_80211n);
154 }
155 else if (frequency == 2.4)
156 {
157 wifi.SetStandard(WIFI_STANDARD_80211n);
158 ossControlMode << "ErpOfdmRate";
159 Config::SetDefault("ns3::LogDistancePropagationLossModel::ReferenceLoss",
160 DoubleValue(40.046));
161 }
162 else
163 {
164 std::cout << "Wrong frequency value!" << std::endl;
165 return 0;
166 }
167
168 auto nonHtRefRateMbps = HtPhy::GetNonHtReferenceRate(mcs) / 1e6;
169 ossControlMode << nonHtRefRateMbps << "Mbps";
170
171 std::ostringstream ossDataMode;
172 ossDataMode << "HtMcs" << mcs;
173 wifi.SetRemoteStationManager("ns3::ConstantRateWifiManager",
174 "DataMode",
175 StringValue(ossDataMode.str()),
176 "ControlMode",
177 StringValue(ossControlMode.str()));
178 // Set guard interval
179 wifi.ConfigHtOptions("ShortGuardIntervalSupported", BooleanValue(sgi));
180
181 Ssid ssid = Ssid("ns3-80211n");
183 WifiPhyBand band = (frequency == 5.0 ? WIFI_PHY_BAND_5GHZ : WIFI_PHY_BAND_2_4GHZ);
184 channelValue.Set(WifiPhy::ChannelTuple{0, channelWidth, band, 0});
185
186 mac.SetType("ns3::StaWifiMac", "Ssid", SsidValue(ssid));
187 phy.Set("ChannelSettings", channelValue);
188
189 NetDeviceContainer staDevice;
190 staDevice = wifi.Install(phy, mac, wifiStaNode);
191
192 mac.SetType("ns3::ApWifiMac",
193 "EnableBeaconJitter",
194 BooleanValue(false),
195 "Ssid",
196 SsidValue(ssid));
197
198 NetDeviceContainer apDevice;
199 apDevice = wifi.Install(phy, mac, wifiApNode);
200
201 // mobility.
203 Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator>();
204
205 positionAlloc->Add(Vector(0.0, 0.0, 0.0));
206 positionAlloc->Add(Vector(distance, 0.0, 0.0));
207 mobility.SetPositionAllocator(positionAlloc);
208
209 mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
210
211 mobility.Install(wifiApNode);
212 mobility.Install(wifiStaNode);
213
214 /* Internet stack*/
216 stack.Install(wifiApNode);
217 stack.Install(wifiStaNode);
218
220 address.SetBase("192.168.1.0", "255.255.255.0");
221 Ipv4InterfaceContainer staNodeInterface;
222 Ipv4InterfaceContainer apNodeInterface;
223
224 staNodeInterface = address.Assign(staDevice);
225 apNodeInterface = address.Assign(apDevice);
226
227 /* Setting applications */
228 ApplicationContainer serverApp;
229 if (udp)
230 {
231 // UDP flow
232 uint16_t port = 9;
233 UdpServerHelper server(port);
234 serverApp = server.Install(wifiStaNode.Get(0));
235 serverApp.Start(Seconds(0.0));
236 serverApp.Stop(Seconds(simulationTime + 1));
237
238 UdpClientHelper client(staNodeInterface.GetAddress(0), port);
239 client.SetAttribute("MaxPackets", UintegerValue(4294967295U));
240 client.SetAttribute("Interval", TimeValue(Time("0.00001"))); // packets/s
241 client.SetAttribute("PacketSize", UintegerValue(payloadSize));
242 ApplicationContainer clientApp = client.Install(wifiApNode.Get(0));
243 clientApp.Start(Seconds(1.0));
244 clientApp.Stop(Seconds(simulationTime + 1));
245 }
246 else
247 {
248 // TCP flow
249 uint16_t port = 50000;
250 Address localAddress(InetSocketAddress(Ipv4Address::GetAny(), port));
251 PacketSinkHelper packetSinkHelper("ns3::TcpSocketFactory", localAddress);
252 serverApp = packetSinkHelper.Install(wifiStaNode.Get(0));
253 serverApp.Start(Seconds(0.0));
254 serverApp.Stop(Seconds(simulationTime + 1));
255
256 OnOffHelper onoff("ns3::TcpSocketFactory", Ipv4Address::GetAny());
257 onoff.SetAttribute("OnTime",
258 StringValue("ns3::ConstantRandomVariable[Constant=1]"));
259 onoff.SetAttribute("OffTime",
260 StringValue("ns3::ConstantRandomVariable[Constant=0]"));
261 onoff.SetAttribute("PacketSize", UintegerValue(payloadSize));
262 onoff.SetAttribute("DataRate", DataRateValue(200000000)); // bit/s
263 AddressValue remoteAddress(
264 InetSocketAddress(staNodeInterface.GetAddress(0), port));
265 onoff.SetAttribute("Remote", remoteAddress);
266 ApplicationContainer clientApp = onoff.Install(wifiApNode.Get(0));
267 clientApp.Start(Seconds(1.0));
268 clientApp.Stop(Seconds(simulationTime + 1));
269 }
270
271 Ipv4GlobalRoutingHelper::PopulateRoutingTables();
272
273 Simulator::Stop(Seconds(simulationTime + 1));
274 Simulator::Run();
275
276 uint64_t rxBytes = 0;
277 if (udp)
278 {
279 rxBytes = payloadSize * DynamicCast<UdpServer>(serverApp.Get(0))->GetReceived();
280 }
281 else
282 {
283 rxBytes = DynamicCast<PacketSink>(serverApp.Get(0))->GetTotalRx();
284 }
285 double throughput = (rxBytes * 8) / (simulationTime * 1000000.0); // Mbit/s
286
287 Simulator::Destroy();
288
289 std::cout << mcs << "\t\t\t" << channelWidth << " MHz\t\t\t" << sgi << "\t\t\t"
290 << throughput << " Mbit/s" << std::endl;
291
292 // test first element
293 if (mcs == 0 && channelWidth == 20 && sgi == 0)
294 {
295 if (throughput < minExpectedThroughput)
296 {
297 NS_FATAL_ERROR("Obtained throughput " << throughput << " is not expected!");
298 }
299 }
300 // test last element
301 if (mcs == 7 && channelWidth == 40 && sgi == 1)
302 {
303 if (maxExpectedThroughput > 0 && throughput > maxExpectedThroughput)
304 {
305 NS_FATAL_ERROR("Obtained throughput " << throughput << " is not expected!");
306 }
307 }
308 // test previous throughput is smaller (for the same mcs)
309 if (throughput > previous)
310 {
311 previous = throughput;
312 }
313 else
314 {
315 NS_FATAL_ERROR("Obtained throughput " << throughput << " is not expected!");
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_FATAL_ERROR("Obtained throughput " << throughput << " is not expected!");
325 }
326 index++;
327 }
328 channelWidth *= 2;
329 }
330 }
331 return 0;
332}
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.
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition: double.h:42
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:56
AttributeValue implementation for Time.
Definition: nstime.h:1423
Hold objects of type std::tuple<Args...>.
Definition: tuple.h:69
void Set(const result_type &value)
Set the stored values.
Definition: tuple.h:318
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:324
create MAC layers for a ns3::WifiNetDevice.
std::tuple< uint8_t, uint16_t, int, uint8_t > ChannelTuple
Tuple identifying an operating channel.
Definition: wifi-phy.h:870
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_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
Definition: fatal-error.h:179
#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
WifiPhyBand
Identifies the PHY band.
Definition: wifi-phy-band.h:33
@ WIFI_STANDARD_80211n
@ WIFI_PHY_BAND_2_4GHZ
The 2.4 GHz band.
Definition: wifi-phy-band.h:35
@ WIFI_PHY_BAND_5GHZ
The 5 GHz band.
Definition: wifi-phy-band.h:37
address
Definition: first.py:40
stack
Definition: first.py:37
void(* Time)(Time oldValue, Time newValue)
TracedValue callback signature for Time.
Definition: nstime.h:848
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