A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
wifi-backward-compatibility.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2017
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/enum.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/packet-sink-helper.h"
30#include "ns3/ssid.h"
31#include "ns3/tuple.h"
32#include "ns3/udp-client-server-helper.h"
33#include "ns3/uinteger.h"
34#include "ns3/yans-wifi-channel.h"
35#include "ns3/yans-wifi-helper.h"
36
37// This is an example to show how to configure an IEEE 802.11 Wi-Fi
38// network where the AP and the station use different 802.11 standards.
39//
40// It outputs the throughput for a given configuration: user can specify
41// the 802.11 versions for the AP and the station as well as their rate
42// adaptation algorithms. It also allows to decide whether the station,
43// the AP or both has/have traffic to send.
44//
45// Example for an IEEE 802.11ac station sending traffic to an 802.11a AP using Ideal rate adaptation
46// algorithm:
47// ./ns3 run "wifi-backward-compatibility --apVersion=80211a --staVersion=80211ac --staRaa=Ideal"
48
49using namespace ns3;
50
51NS_LOG_COMPONENT_DEFINE("wifi-backward-compatibility");
52
59std::pair<WifiStandard, WifiPhyBand>
61{
64 if (version == "80211a")
65 {
66 standard = WIFI_STANDARD_80211a;
67 band = WIFI_PHY_BAND_5GHZ;
68 }
69 else if (version == "80211b")
70 {
71 standard = WIFI_STANDARD_80211b;
73 }
74 else if (version == "80211g")
75 {
76 standard = WIFI_STANDARD_80211g;
78 }
79 else if (version == "80211p")
80 {
81 standard = WIFI_STANDARD_80211p;
82 band = WIFI_PHY_BAND_5GHZ;
83 }
84 else if (version == "80211n_2_4GHZ")
85 {
86 standard = WIFI_STANDARD_80211n;
88 }
89 else if (version == "80211n_5GHZ")
90 {
91 standard = WIFI_STANDARD_80211n;
92 band = WIFI_PHY_BAND_5GHZ;
93 }
94 else if (version == "80211ac")
95 {
96 standard = WIFI_STANDARD_80211ac;
97 band = WIFI_PHY_BAND_5GHZ;
98 }
99 else if (version == "80211ax_2_4GHZ")
100 {
101 standard = WIFI_STANDARD_80211ax;
103 }
104 else if (version == "80211ax_5GHZ")
105 {
106 standard = WIFI_STANDARD_80211ax;
107 band = WIFI_PHY_BAND_5GHZ;
108 }
109 return {standard, band};
110}
111
112int
113main(int argc, char* argv[])
114{
115 uint32_t payloadSize = 1472; // bytes
116 double simulationTime = 10; // seconds
117 std::string apVersion = "80211a";
118 std::string staVersion = "80211n_5GHZ";
119 std::string apRaa = "Minstrel";
120 std::string staRaa = "MinstrelHt";
121 bool apHasTraffic = false;
122 bool staHasTraffic = true;
123
124 CommandLine cmd(__FILE__);
125 cmd.AddValue("simulationTime", "Simulation time in seconds", simulationTime);
126 cmd.AddValue("apVersion",
127 "The standard version used by the AP: 80211a, 80211b, 80211g, 80211p, "
128 "80211n_2_4GHZ, 80211n_5GHZ, 80211ac, 80211ax_2_4GHZ or 80211ax_5GHZ",
129 apVersion);
130 cmd.AddValue("staVersion",
131 "The standard version used by the station: 80211a, 80211b, 80211g, 80211_10MHZ, "
132 "80211_5MHZ, 80211n_2_4GHZ, 80211n_5GHZ, 80211ac, 80211ax_2_4GHZ or 80211ax_5GHZ",
133 staVersion);
134 cmd.AddValue("apRaa", "Rate adaptation algorithm used by the AP", apRaa);
135 cmd.AddValue("staRaa", "Rate adaptation algorithm used by the station", staRaa);
136 cmd.AddValue("apHasTraffic", "Enable/disable traffic on the AP", apHasTraffic);
137 cmd.AddValue("staHasTraffic", "Enable/disable traffic on the station", staHasTraffic);
138 cmd.Parse(argc, argv);
139
140 NodeContainer wifiStaNode;
141 wifiStaNode.Create(1);
143 wifiApNode.Create(1);
144
147 phy.SetChannel(channel.Create());
148
151 Ssid ssid = Ssid("ns3");
153
154 const auto& [staStandard, staBand] = ConvertStringToStandardAndBand(staVersion);
155 wifi.SetStandard(staStandard);
156 wifi.SetRemoteStationManager("ns3::" + staRaa + "WifiManager");
157
158 mac.SetType("ns3::StaWifiMac", "QosSupported", BooleanValue(true), "Ssid", SsidValue(ssid));
159
160 // Workaround needed as long as we do not fully support channel bonding
161 uint16_t width = (staVersion == "80211ac" ? 20 : 0);
162 channelValue.Set(WifiPhy::ChannelTuple{0, width, staBand, 0});
163 phy.Set("ChannelSettings", channelValue);
164
165 NetDeviceContainer staDevice;
166 staDevice = wifi.Install(phy, mac, wifiStaNode);
167
168 const auto& [apStandard, apBand] = ConvertStringToStandardAndBand(apVersion);
169 wifi.SetStandard(apStandard);
170 wifi.SetRemoteStationManager("ns3::" + apRaa + "WifiManager");
171
172 mac.SetType("ns3::ApWifiMac", "QosSupported", BooleanValue(true), "Ssid", SsidValue(ssid));
173
174 // Workaround needed as long as we do not fully support channel bonding
175 width = (apVersion == "80211ac" ? 20 : 0);
176 channelValue.Set(WifiPhy::ChannelTuple{0, width, apBand, 0});
177 phy.Set("ChannelSettings", channelValue);
178
179 NetDeviceContainer apDevice;
180 apDevice = wifi.Install(phy, mac, wifiApNode);
181
183 Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator>();
184 positionAlloc->Add(Vector(0.0, 0.0, 0.0));
185 positionAlloc->Add(Vector(5.0, 0.0, 0.0));
186 mobility.SetPositionAllocator(positionAlloc);
187 mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
188 mobility.Install(wifiApNode);
189 mobility.Install(wifiStaNode);
190
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 UdpServerHelper apServer(9);
204 ApplicationContainer apServerApp = apServer.Install(wifiApNode.Get(0));
205 apServerApp.Start(Seconds(0.0));
206 apServerApp.Stop(Seconds(simulationTime + 1));
207
208 UdpServerHelper staServer(5001);
209 ApplicationContainer staServerApp = staServer.Install(wifiStaNode.Get(0));
210 staServerApp.Start(Seconds(0.0));
211 staServerApp.Stop(Seconds(simulationTime + 1));
212
213 if (apHasTraffic)
214 {
215 UdpClientHelper apClient(staNodeInterface.GetAddress(0), 5001);
216 apClient.SetAttribute("MaxPackets", UintegerValue(4294967295U));
217 apClient.SetAttribute("Interval", TimeValue(Time("0.00001"))); // packets/s
218 apClient.SetAttribute("PacketSize", UintegerValue(payloadSize)); // bytes
219 ApplicationContainer apClientApp = apClient.Install(wifiApNode.Get(0));
220 apClientApp.Start(Seconds(1.0));
221 apClientApp.Stop(Seconds(simulationTime + 1));
222 }
223
224 if (staHasTraffic)
225 {
226 UdpClientHelper staClient(apNodeInterface.GetAddress(0), 9);
227 staClient.SetAttribute("MaxPackets", UintegerValue(4294967295U));
228 staClient.SetAttribute("Interval", TimeValue(Time("0.00001"))); // packets/s
229 staClient.SetAttribute("PacketSize", UintegerValue(payloadSize)); // bytes
230 ApplicationContainer staClientApp = staClient.Install(wifiStaNode.Get(0));
231 staClientApp.Start(Seconds(1.0));
232 staClientApp.Stop(Seconds(simulationTime + 1));
233 }
234
236
237 Simulator::Stop(Seconds(simulationTime + 1));
239
240 uint64_t rxBytes;
241 double throughput;
242 bool error = false;
243 if (apHasTraffic)
244 {
245 rxBytes = payloadSize * DynamicCast<UdpServer>(staServerApp.Get(0))->GetReceived();
246 throughput = (rxBytes * 8) / (simulationTime * 1000000.0); // Mbit/s
247 std::cout << "AP Throughput: " << throughput << " Mbit/s" << std::endl;
248 if (throughput == 0)
249 {
250 error = true;
251 }
252 }
253 if (staHasTraffic)
254 {
255 rxBytes = payloadSize * DynamicCast<UdpServer>(apServerApp.Get(0))->GetReceived();
256 throughput = (rxBytes * 8) / (simulationTime * 1000000.0); // Mbit/s
257 std::cout << "STA Throughput: " << throughput << " Mbit/s" << std::endl;
258 if (throughput == 0)
259 {
260 error = true;
261 }
262 }
263
265
266 if (error)
267 {
268 NS_LOG_ERROR("No traffic received!");
269 exit(1);
270 }
271
272 return 0;
273}
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
aggregate IP/TCP/UDP functionality to existing Nodes.
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
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.
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.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
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
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:872
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.
#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
WifiStandard
Identifies the IEEE 802.11 specifications that a Wifi device can be configured to use.
WifiPhyBand
Identifies the PHY band.
Definition: wifi-phy-band.h:33
@ WIFI_STANDARD_80211a
@ WIFI_STANDARD_80211p
@ WIFI_STANDARD_80211n
@ WIFI_STANDARD_80211g
@ WIFI_STANDARD_80211ax
@ WIFI_STANDARD_80211ac
@ WIFI_STANDARD_80211b
@ 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
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
std::pair< WifiStandard, WifiPhyBand > ConvertStringToStandardAndBand(std::string version)
Convert a string (e.g., "80211a") to a pair {WifiStandard, WifiPhyBand}.