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/internet-stack-helper.h"
27#include "ns3/ipv4-address-helper.h"
28#include "ns3/ipv4-global-routing-helper.h"
29#include "ns3/log.h"
30#include "ns3/mobility-helper.h"
31#include "ns3/on-off-helper.h"
32#include "ns3/packet-sink-helper.h"
33#include "ns3/packet-sink.h"
34#include "ns3/ssid.h"
35#include "ns3/string.h"
36#include "ns3/tuple.h"
37#include "ns3/udp-client-server-helper.h"
38#include "ns3/uinteger.h"
39#include "ns3/yans-wifi-channel.h"
40#include "ns3/yans-wifi-helper.h"
41
42// This is a simple example in order to show how to configure an IEEE 802.11n Wi-Fi network.
43//
44// It outputs the UDP or TCP goodput for every HT MCS value, which depends on the MCS value (0 to
45// 7), the channel width (20 or 40 MHz) and the guard interval (long or short). The PHY bitrate is
46// constant over all the simulation run. The user can also specify the distance between the access
47// point and the station: the larger 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("ht-wifi-network");
61
62int
63main(int argc, char* argv[])
64{
65 bool udp = true;
66 bool useRts = false;
67 double simulationTime = 10; // seconds
68 double distance = 1.0; // meters
69 double frequency = 5.0; // whether 2.4 or 5.0 GHz
70 int mcs = -1; // -1 indicates an unset value
71 double minExpectedThroughput = 0;
72 double maxExpectedThroughput = 0;
73
74 CommandLine cmd(__FILE__);
75 cmd.AddValue("frequency",
76 "Whether working in the 2.4 or 5.0 GHz band (other values gets rejected)",
77 frequency);
78 cmd.AddValue("distance",
79 "Distance in meters between the station and the access point",
80 distance);
81 cmd.AddValue("simulationTime", "Simulation time in seconds", simulationTime);
82 cmd.AddValue("udp", "UDP if set to 1, TCP otherwise", udp);
83 cmd.AddValue("useRts", "Enable/disable RTS/CTS", useRts);
84 cmd.AddValue("mcs", "if set, limit testing to a specific MCS (0-7)", mcs);
85 cmd.AddValue("minExpectedThroughput",
86 "if set, simulation fails if the lowest throughput is below this value",
87 minExpectedThroughput);
88 cmd.AddValue("maxExpectedThroughput",
89 "if set, simulation fails if the highest throughput is above this value",
90 maxExpectedThroughput);
91 cmd.Parse(argc, argv);
92
93 if (useRts)
94 {
95 Config::SetDefault("ns3::WifiRemoteStationManager::RtsCtsThreshold", StringValue("0"));
96 }
97
98 double prevThroughput[8];
99 for (uint32_t l = 0; l < 8; l++)
100 {
101 prevThroughput[l] = 0;
102 }
103 std::cout << "MCS value"
104 << "\t\t"
105 << "Channel width"
106 << "\t\t"
107 << "short GI"
108 << "\t\t"
109 << "Throughput" << '\n';
110 int minMcs = 0;
111 int maxMcs = 7;
112 if (mcs >= 0 && mcs <= 7)
113 {
114 minMcs = mcs;
115 maxMcs = mcs;
116 }
117 for (int mcs = minMcs; mcs <= maxMcs; mcs++)
118 {
119 uint8_t index = 0;
120 double previous = 0;
121 for (int channelWidth = 20; channelWidth <= 40;)
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
141 YansWifiChannelHelper channel = YansWifiChannelHelper::Default();
143 phy.SetChannel(channel.Create());
144
147
148 if (frequency == 5.0)
149 {
150 wifi.SetStandard(WIFI_STANDARD_80211n);
151 }
152 else if (frequency == 2.4)
153 {
154 wifi.SetStandard(WIFI_STANDARD_80211n);
155 Config::SetDefault("ns3::LogDistancePropagationLossModel::ReferenceLoss",
156 DoubleValue(40.046));
157 }
158 else
159 {
160 std::cout << "Wrong frequency value!" << std::endl;
161 return 0;
162 }
163
164 std::ostringstream oss;
165 oss << "HtMcs" << mcs;
166 wifi.SetRemoteStationManager("ns3::ConstantRateWifiManager",
167 "DataMode",
168 StringValue(oss.str()),
169 "ControlMode",
170 StringValue(oss.str()));
171 // Set guard interval
172 wifi.ConfigHtOptions("ShortGuardIntervalSupported", BooleanValue(sgi));
173
174 Ssid ssid = Ssid("ns3-80211n");
176 WifiPhyBand band = (frequency == 5.0 ? WIFI_PHY_BAND_5GHZ : WIFI_PHY_BAND_2_4GHZ);
177 channelValue.Set(WifiPhy::ChannelTuple{0, channelWidth, band, 0});
178
179 mac.SetType("ns3::StaWifiMac", "Ssid", SsidValue(ssid));
180 phy.Set("ChannelSettings", channelValue);
181
182 NetDeviceContainer staDevice;
183 staDevice = wifi.Install(phy, mac, wifiStaNode);
184
185 mac.SetType("ns3::ApWifiMac",
186 "EnableBeaconJitter",
187 BooleanValue(false),
188 "Ssid",
189 SsidValue(ssid));
190
191 NetDeviceContainer apDevice;
192 apDevice = wifi.Install(phy, mac, wifiApNode);
193
194 // mobility.
196 Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator>();
197
198 positionAlloc->Add(Vector(0.0, 0.0, 0.0));
199 positionAlloc->Add(Vector(distance, 0.0, 0.0));
200 mobility.SetPositionAllocator(positionAlloc);
201
202 mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
203
204 mobility.Install(wifiApNode);
205 mobility.Install(wifiStaNode);
206
207 /* Internet stack*/
209 stack.Install(wifiApNode);
210 stack.Install(wifiStaNode);
211
213 address.SetBase("192.168.1.0", "255.255.255.0");
214 Ipv4InterfaceContainer staNodeInterface;
215 Ipv4InterfaceContainer apNodeInterface;
216
217 staNodeInterface = address.Assign(staDevice);
218 apNodeInterface = address.Assign(apDevice);
219
220 /* Setting applications */
221 ApplicationContainer serverApp;
222 if (udp)
223 {
224 // UDP flow
225 uint16_t port = 9;
226 UdpServerHelper server(port);
227 serverApp = server.Install(wifiStaNode.Get(0));
228 serverApp.Start(Seconds(0.0));
229 serverApp.Stop(Seconds(simulationTime + 1));
230
231 UdpClientHelper client(staNodeInterface.GetAddress(0), port);
232 client.SetAttribute("MaxPackets", UintegerValue(4294967295U));
233 client.SetAttribute("Interval", TimeValue(Time("0.00001"))); // packets/s
234 client.SetAttribute("PacketSize", UintegerValue(payloadSize));
235 ApplicationContainer clientApp = client.Install(wifiApNode.Get(0));
236 clientApp.Start(Seconds(1.0));
237 clientApp.Stop(Seconds(simulationTime + 1));
238 }
239 else
240 {
241 // TCP flow
242 uint16_t port = 50000;
243 Address localAddress(InetSocketAddress(Ipv4Address::GetAny(), port));
244 PacketSinkHelper packetSinkHelper("ns3::TcpSocketFactory", localAddress);
245 serverApp = packetSinkHelper.Install(wifiStaNode.Get(0));
246 serverApp.Start(Seconds(0.0));
247 serverApp.Stop(Seconds(simulationTime + 1));
248
249 OnOffHelper onoff("ns3::TcpSocketFactory", Ipv4Address::GetAny());
250 onoff.SetAttribute("OnTime",
251 StringValue("ns3::ConstantRandomVariable[Constant=1]"));
252 onoff.SetAttribute("OffTime",
253 StringValue("ns3::ConstantRandomVariable[Constant=0]"));
254 onoff.SetAttribute("PacketSize", UintegerValue(payloadSize));
255 onoff.SetAttribute("DataRate", DataRateValue(200000000)); // bit/s
256 AddressValue remoteAddress(
257 InetSocketAddress(staNodeInterface.GetAddress(0), port));
258 onoff.SetAttribute("Remote", remoteAddress);
259 ApplicationContainer clientApp = onoff.Install(wifiApNode.Get(0));
260 clientApp.Start(Seconds(1.0));
261 clientApp.Stop(Seconds(simulationTime + 1));
262 }
263
264 Ipv4GlobalRoutingHelper::PopulateRoutingTables();
265
266 Simulator::Stop(Seconds(simulationTime + 1));
267 Simulator::Run();
268
269 uint64_t rxBytes = 0;
270 if (udp)
271 {
272 rxBytes = payloadSize * DynamicCast<UdpServer>(serverApp.Get(0))->GetReceived();
273 }
274 else
275 {
276 rxBytes = DynamicCast<PacketSink>(serverApp.Get(0))->GetTotalRx();
277 }
278 double throughput = (rxBytes * 8) / (simulationTime * 1000000.0); // Mbit/s
279
280 Simulator::Destroy();
281
282 std::cout << mcs << "\t\t\t" << channelWidth << " MHz\t\t\t" << sgi << "\t\t\t"
283 << throughput << " Mbit/s" << std::endl;
284
285 // test first element
286 if (mcs == 0 && channelWidth == 20 && sgi == 0)
287 {
288 if (throughput < minExpectedThroughput)
289 {
290 NS_FATAL_ERROR("Obtained throughput " << throughput << " is not expected!");
291 }
292 }
293 // test last element
294 if (mcs == 7 && channelWidth == 40 && sgi == 1)
295 {
296 if (maxExpectedThroughput > 0 && throughput > maxExpectedThroughput)
297 {
298 NS_FATAL_ERROR("Obtained throughput " << throughput << " is not expected!");
299 }
300 }
301 // test previous throughput is smaller (for the same mcs)
302 if (throughput > previous)
303 {
304 previous = throughput;
305 }
306 else
307 {
308 NS_FATAL_ERROR("Obtained throughput " << throughput << " is not expected!");
309 }
310 // test previous throughput is smaller (for the same channel width and GI)
311 if (throughput > prevThroughput[index])
312 {
313 prevThroughput[index] = throughput;
314 }
315 else
316 {
317 NS_FATAL_ERROR("Obtained throughput " << throughput << " is not expected!");
318 }
319 index++;
320 }
321 channelWidth *= 2;
322 }
323 }
324 return 0;
325}
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.
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:42
AttributeValue implementation for Time.
Definition: nstime.h:1425
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:325
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:869
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:160
#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
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: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