|
A Discrete-Event Network Simulator
|
API
|
Go to the documentation of this file.
21 #include "ns3/command-line.h"
22 #include "ns3/config.h"
23 #include "ns3/uinteger.h"
24 #include "ns3/boolean.h"
25 #include "ns3/double.h"
26 #include "ns3/string.h"
29 #include "ns3/yans-wifi-helper.h"
30 #include "ns3/spectrum-wifi-helper.h"
32 #include "ns3/mobility-helper.h"
33 #include "ns3/internet-stack-helper.h"
34 #include "ns3/ipv4-address-helper.h"
35 #include "ns3/udp-client-server-helper.h"
36 #include "ns3/packet-sink-helper.h"
37 #include "ns3/on-off-helper.h"
38 #include "ns3/ipv4-global-routing-helper.h"
39 #include "ns3/packet-sink.h"
40 #include "ns3/yans-wifi-channel.h"
41 #include "ns3/multi-model-spectrum-channel.h"
42 #include "ns3/wifi-acknowledgment.h"
43 #include "ns3/rng-seed-manager.h"
67 int main (
int argc,
char *argv[])
71 bool useExtendedBlockAck {
false};
72 double simulationTime {10};
73 double distance {1.0};
75 std::size_t nStations {1};
76 std::string dlAckSeqType {
"NO-OFDMA"};
78 uint32_t payloadSize = 700;
79 std::string phyModel {
"Yans"};
80 double minExpectedThroughput {0};
81 double maxExpectedThroughput {0};
84 cmd.AddValue (
"frequency",
"Whether working in the 2.4, 5 or 6 GHz band (other values gets rejected)", frequency);
85 cmd.AddValue (
"distance",
"Distance in meters between the station and the access point", distance);
86 cmd.AddValue (
"simulationTime",
"Simulation time in seconds", simulationTime);
87 cmd.AddValue (
"udp",
"UDP if set to 1, TCP otherwise", udp);
88 cmd.AddValue (
"useRts",
"Enable/disable RTS/CTS", useRts);
89 cmd.AddValue (
"useExtendedBlockAck",
"Enable/disable use of extended BACK", useExtendedBlockAck);
90 cmd.AddValue (
"nStations",
"Number of non-AP HE stations", nStations);
91 cmd.AddValue (
"dlAckType",
"Ack sequence type for DL OFDMA (NO-OFDMA, ACK-SU-FORMAT, MU-BAR, AGGR-MU-BAR)",
93 cmd.AddValue (
"mcs",
"if set, limit testing to a specific MCS (0-11)", mcs);
94 cmd.AddValue (
"payloadSize",
"The application payload size in bytes", payloadSize);
95 cmd.AddValue (
"phyModel",
"PHY model to use when OFDMA is disabled (Yans or Spectrum). If OFDMA is enabled then Spectrum is automatically selected", phyModel);
96 cmd.AddValue (
"minExpectedThroughput",
"if set, simulation fails if the lowest throughput is below this value", minExpectedThroughput);
97 cmd.AddValue (
"maxExpectedThroughput",
"if set, simulation fails if the highest throughput is above this value", maxExpectedThroughput);
98 cmd.Parse (argc,argv);
105 if (dlAckSeqType ==
"ACK-SU-FORMAT")
110 else if (dlAckSeqType ==
"MU-BAR")
115 else if (dlAckSeqType ==
"AGGR-MU-BAR")
120 else if (dlAckSeqType !=
"NO-OFDMA")
122 NS_ABORT_MSG (
"Invalid DL ack sequence type (must be NO-OFDMA, ACK-SU-FORMAT, MU-BAR or AGGR-MU-BAR)");
125 if (phyModel !=
"Yans" && phyModel !=
"Spectrum")
127 NS_ABORT_MSG (
"Invalid PHY model (must be Yans or Spectrum)");
129 if (dlAckSeqType !=
"NO-OFDMA")
132 phyModel =
"Spectrum";
135 double prevThroughput [12];
136 for (uint32_t l = 0; l < 12; l++)
138 prevThroughput[l] = 0;
140 std::cout <<
"MCS value" <<
"\t\t" <<
"Channel width" <<
"\t\t" <<
"GI" <<
"\t\t\t" <<
"Throughput" <<
'\n';
143 if (mcs >= 0 && mcs <= 11)
148 for (
int mcs = minMcs; mcs <= maxMcs; mcs++)
152 uint8_t maxChannelWidth = frequency == 2.4 ? 40 : 160;
153 for (
int channelWidth = 20; channelWidth <= maxChannelWidth; )
155 for (
int gi = 3200; gi >= 800; )
176 else if (frequency == 5)
180 else if (frequency == 2.4)
187 std::cout <<
"Wrong frequency value!" << std::endl;
191 std::ostringstream oss;
192 oss <<
"HeMcs" << mcs;
193 wifi.SetRemoteStationManager (
"ns3::ConstantRateWifiManager",
"DataMode",
StringValue (oss.str ()),
198 if (phyModel ==
"Spectrum")
209 phy.SetChannel (spectrumChannel);
211 mac.SetType (
"ns3::StaWifiMac",
216 if (dlAckSeqType !=
"NO-OFDMA")
218 mac.SetMultiUserScheduler (
"ns3::RrMultiUserScheduler",
222 mac.SetType (
"ns3::ApWifiMac",
235 mac.SetType (
"ns3::StaWifiMac",
240 mac.SetType (
"ns3::ApWifiMac",
249 int64_t streamNumber = 100;
250 streamNumber +=
wifi.AssignStreams (apDevice, streamNumber);
255 Config::Set (
"/NodeList/*/DeviceList/*/$ns3::WifiNetDevice/HeConfiguration/MpduBufferSize",
UintegerValue (useExtendedBlockAck ? 256 : 64));
261 positionAlloc->
Add (Vector (0.0, 0.0, 0.0));
262 positionAlloc->
Add (Vector (distance, 0.0, 0.0));
263 mobility.SetPositionAllocator (positionAlloc);
265 mobility.SetMobilityModel (
"ns3::ConstantPositionMobilityModel");
276 address.SetBase (
"192.168.1.0",
"255.255.255.0");
281 apNodeInterface =
address.Assign (apDevice);
294 for (std::size_t i = 0; i < nStations; i++)
297 client.SetAttribute (
"MaxPackets",
UintegerValue (4294967295u));
298 client.SetAttribute (
"Interval",
TimeValue (
Time (
"0.00001")));
299 client.SetAttribute (
"PacketSize",
UintegerValue (payloadSize));
308 uint16_t
port = 50000;
315 for (std::size_t i = 0; i < nStations; i++)
318 onoff.SetAttribute (
"OnTime",
StringValue (
"ns3::ConstantRandomVariable[Constant=1]"));
319 onoff.SetAttribute (
"OffTime",
StringValue (
"ns3::ConstantRandomVariable[Constant=0]"));
320 onoff.SetAttribute (
"PacketSize",
UintegerValue (payloadSize));
323 onoff.SetAttribute (
"Remote", remoteAddress);
338 double tolerance = 0.10;
339 uint64_t rxBytes = 0;
342 for (uint32_t i = 0; i < serverApp.
GetN (); i++)
344 rxBytes += payloadSize * DynamicCast<UdpServer> (serverApp.
Get (i))->GetReceived ();
349 for (uint32_t i = 0; i < serverApp.
GetN (); i++)
351 rxBytes += DynamicCast<PacketSink> (serverApp.
Get (i))->GetTotalRx ();
354 double throughput = (rxBytes * 8) / (simulationTime * 1000000.0);
358 std::cout << mcs <<
"\t\t\t" << channelWidth <<
" MHz\t\t\t" << gi <<
" ns\t\t\t" << throughput <<
" Mbit/s" << std::endl;
361 if (mcs == 0 && channelWidth == 20 && gi == 3200)
363 if (throughput * (1 + tolerance) < minExpectedThroughput)
365 NS_LOG_ERROR (
"Obtained throughput " << throughput <<
" is not expected!");
370 if (mcs == 11 && channelWidth == 160 && gi == 800)
372 if (maxExpectedThroughput > 0 && throughput > maxExpectedThroughput * (1 + tolerance))
374 NS_LOG_ERROR (
"Obtained throughput " << throughput <<
" is not expected!");
379 if (throughput * (1 + tolerance) > previous)
381 previous = throughput;
385 NS_LOG_ERROR (
"Obtained throughput " << throughput <<
" is not expected!");
389 if (throughput * (1 + tolerance) > prevThroughput [index])
391 prevThroughput [index] = throughput;
395 NS_LOG_ERROR (
"Obtained throughput " << throughput <<
" is not expected!");
holds a vector of ns3::NetDevice pointers
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
AttributeValue implementation for DataRate.
Ptr< Application > Get(uint32_t i) const
Get the Ptr<Application> stored in this container at a given index.
static YansWifiChannelHelper Default(void)
Create a channel helper in a default working state.
Create a client application which sends UDP packets carrying a 32bit sequence number and a 64 bit tim...
Make it easy to create and manage PHY objects for the YANS model.
Parse command-line arguments.
void Add(Vector v)
Add a position to the list of positions.
void Set(std::string path, const AttributeValue &value)
AttributeValue implementation for Boolean.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void Stop(Time stop)
Arrange for all of the Applications in this container to Stop() at the Time given as a parameter.
helps to create WifiNetDevice objects
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
@ WIFI_STANDARD_80211ax_2_4GHZ
@ WIFI_STANDARD_80211ax_5GHZ
AttributeValue implementation for Address.
@ DLT_IEEE802_11_RADIO
Include Radiotap link layer information.
static EventId Schedule(Time const &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Hold variables of type enum.
AttributeValue implementation for Ssid.
static void SetRun(uint64_t run)
Set the run number of simulation.
The IEEE 802.11 SSID Information Element.
Create a server application which waits for input UDP packets and uses the information carried into t...
Smart pointer class similar to boost::intrusive_ptr.
static void PopulateRoutingTables(void)
Build a routing database and initialize the routing tables of the nodes in the simulation.
static void Stop(void)
Tell the Simulator the calling event should be the last one executed.
Time NanoSeconds(uint64_t value)
Construct a Time in the indicated unit.
a polymophic address class
A helper to make it easier to instantiate an ns3::OnOffApplication on a set of nodes.
holds a vector of std::pair of Ptr<Ipv4> and interface index.
Simulation virtual time values and global simulation resolution.
@ WIFI_STANDARD_80211ax_6GHZ
static void SetSeed(uint32_t seed)
Set the seed.
static void Run(void)
Run the simulation.
Hold variables of type string.
uint32_t GetN(void) const
Get the number of Ptr<Application> stored in this container.
A helper to make it easier to instantiate an ns3::PacketSinkApplication on a set of nodes.
#define NS_LOG_ERROR(msg)
Use NS_LOG to output a message of level LOG_ERROR.
static Ipv4Address GetAny(void)
void Start(Time start)
Arrange for all of the Applications in this container to Start() at the Time given as a parameter.
Time Seconds(double value)
Construct a Time in the indicated unit.
static void Destroy(void)
Execute the events scheduled with ScheduleDestroy().
holds a vector of ns3::Application pointers.
AttributeValue implementation for Time.
keep track of a set of node pointers.
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
Hold an unsigned integer type.
manage and create wifi channel objects for the YANS model.
create MAC layers for a ns3::WifiNetDevice.
void SetDefault(std::string name, const AttributeValue &value)
aggregate IP/TCP/UDP functionality to existing Nodes.
Helper class used to assign positions and mobility models to nodes.
Make it easy to create and manage PHY objects for the spectrum model.
#define NS_ABORT_MSG(msg)
Unconditional abnormal program termination with a message.