9#include "ns3/attribute-container.h"
10#include "ns3/boolean.h"
11#include "ns3/command-line.h"
12#include "ns3/config.h"
13#include "ns3/double.h"
14#include "ns3/eht-phy.h"
16#include "ns3/internet-stack-helper.h"
17#include "ns3/ipv4-address-helper.h"
19#include "ns3/mobility-helper.h"
20#include "ns3/multi-model-spectrum-channel.h"
21#include "ns3/neighbor-cache-helper.h"
22#include "ns3/on-off-helper.h"
23#include "ns3/packet-sink-helper.h"
24#include "ns3/packet-sink.h"
25#include "ns3/spectrum-wifi-helper.h"
27#include "ns3/string.h"
28#include "ns3/udp-client-server-helper.h"
29#include "ns3/udp-server.h"
30#include "ns3/uinteger.h"
31#include "ns3/wifi-acknowledgment.h"
32#include "ns3/wifi-static-setup-helper.h"
71 std::vector<uint64_t> rxBytes(serverApp.
GetN(), 0);
106 auto newRxBytes =
GetRxBytes(udp, serverApp, payloadSize);
109 std::cout <<
"[" << (now - tputInterval).As(
Time::S) <<
" - " << now.
As(
Time::S)
110 <<
"] Per-STA Throughput (Mbit/s):";
112 for (std::size_t i = 0; i < newRxBytes.size(); i++)
114 std::cout <<
"\t\t(" << i <<
") "
117 std::cout << std::endl;
119 rxBytes.swap(newRxBytes);
135main(
int argc,
char* argv[])
140 bool use80Plus80{
false};
141 uint16_t mpduBufferSize{512};
142 std::string emlsrMgrTypeId{
"ns3::DefaultEmlsrManager"};
143 std::string emlsrLinks;
144 uint16_t paddingDelayUsec{32};
145 uint16_t transitionDelayUsec{128};
146 Time channelSwitchDelay{
"100us"};
147 bool switchAuxPhy{
true};
148 uint16_t auxPhyChWidth{20};
149 bool auxPhyTxCapable{
true};
150 Time simulationTime{
"10s"};
151 bool staticSetup{
true};
152 auto clientAppStartTime =
Seconds(1);
155 double frequency2{0};
159 std::size_t nStations{1};
160 std::string dlAckSeqType{
"NO-OFDMA"};
161 bool enableUlOfdma{
false};
162 bool enableBsrp{
false};
164 std::vector<uint64_t> mcsValues;
165 int channelWidth{-1};
166 int guardInterval{-1};
169 Time tputInterval{0};
170 double minExpectedThroughput{0.0};
171 double maxExpectedThroughput{0.0};
172 Time accessReqInterval{0};
175 cmd.AddValue(
"staticSetup",
176 "Whether devices are configured using the static setup helper",
180 "Whether the first link operates in the 2.4, 5 or 6 GHz band (other values gets rejected)",
184 "Whether the second link operates in the 2.4, 5 or 6 GHz band (0 means the device has one "
185 "link, otherwise the band must be different than first link and third link)",
189 "Whether the third link operates in the 2.4, 5 or 6 GHz band (0 means the device has up to "
190 "two links, otherwise the band must be different than first link and second link)",
192 cmd.AddValue(
"emlsrMgrTypeId",
"The ns-3 TypeId of the EMLSR manager to use", emlsrMgrTypeId);
193 cmd.AddValue(
"emlsrLinks",
194 "The comma separated list of IDs of EMLSR links (for MLDs only)",
196 cmd.AddValue(
"emlsrPaddingDelay",
197 "The EMLSR padding delay in microseconds (0, 32, 64, 128 or 256)",
199 cmd.AddValue(
"emlsrTransitionDelay",
200 "The EMLSR transition delay in microseconds (0, 16, 32, 64, 128 or 256)",
201 transitionDelayUsec);
202 cmd.AddValue(
"emlsrAuxSwitch",
203 "Whether Aux PHY should switch channel to operate on the link on which "
204 "the Main PHY was operating before moving to the link of the Aux PHY. ",
206 cmd.AddValue(
"emlsrAuxChWidth",
207 "The maximum channel width (MHz) supported by Aux PHYs.",
209 cmd.AddValue(
"emlsrAuxTxCapable",
210 "Whether Aux PHYs are capable of transmitting.",
212 cmd.AddValue(
"channelSwitchDelay",
"The PHY channel switch delay", channelSwitchDelay);
213 cmd.AddValue(
"distance",
214 "Distance in meters between the station and the access point",
216 cmd.AddValue(
"simulationTime",
"Simulation time", simulationTime);
217 cmd.AddValue(
"udp",
"UDP if set to 1, TCP otherwise", udp);
218 cmd.AddValue(
"downlink",
219 "Generate downlink flows if set to 1, uplink flows otherwise",
221 cmd.AddValue(
"useRts",
"Enable/disable RTS/CTS", useRts);
222 cmd.AddValue(
"use80Plus80",
"Enable/disable use of 80+80 MHz", use80Plus80);
223 cmd.AddValue(
"mpduBufferSize",
224 "Size (in number of MPDUs) of the BlockAck buffer",
226 cmd.AddValue(
"nStations",
"Number of non-AP EHT stations", nStations);
227 cmd.AddValue(
"dlAckType",
228 "Ack sequence type for DL OFDMA (NO-OFDMA, ACK-SU-FORMAT, MU-BAR, AGGR-MU-BAR)",
230 cmd.AddValue(
"enableUlOfdma",
231 "Enable UL OFDMA (useful if DL OFDMA is enabled and TCP is used)",
233 cmd.AddValue(
"enableBsrp",
234 "Enable BSRP (useful if DL and UL OFDMA are enabled and TCP is used)",
237 "muSchedAccessReqInterval",
238 "Duration of the interval between two requests for channel access made by the MU scheduler",
242 "list of comma separated MCS values to test; if unset, all MCS values (0-13) are tested",
244 cmd.AddValue(
"channelWidth",
245 "if set, limit testing to a specific channel width expressed in MHz (20, 40, 80, "
248 cmd.AddValue(
"guardInterval",
249 "if set, limit testing to a specific guard interval duration expressed in "
250 "nanoseconds (800, 1600 or 3200 ns)",
252 cmd.AddValue(
"payloadSize",
"The application payload size in bytes", payloadSize);
253 cmd.AddValue(
"tputInterval",
"duration of intervals for throughput measurement", tputInterval);
254 cmd.AddValue(
"minExpectedThroughput",
255 "if set, simulation fails if the lowest throughput is below this value",
256 minExpectedThroughput);
257 cmd.AddValue(
"maxExpectedThroughput",
258 "if set, simulation fails if the highest throughput is above this value",
259 maxExpectedThroughput);
260 cmd.Parse(argc, argv);
268 if (dlAckSeqType ==
"ACK-SU-FORMAT")
273 else if (dlAckSeqType ==
"MU-BAR")
278 else if (dlAckSeqType ==
"AGGR-MU-BAR")
283 else if (dlAckSeqType !=
"NO-OFDMA")
285 NS_ABORT_MSG(
"Invalid DL ack sequence type (must be NO-OFDMA, ACK-SU-FORMAT, MU-BAR or "
289 double prevThroughput[15] = {0};
291 std::cout <<
"MCS value"
297 <<
"Throughput" <<
'\n';
303 for (uint8_t mcs = minMcs; mcs <= maxMcs; ++mcs)
305 mcsValues.push_back(mcs);
313 attr.DeserializeFromString(mcsStr, checker);
314 mcsValues = attr.Get();
315 std::sort(mcsValues.begin(), mcsValues.end());
318 int minChannelWidth = 20;
319 int maxChannelWidth =
320 ((frequency != 2.4) && (frequency2 != 2.4) && (frequency3 != 2.4))
321 ? (((frequency == 6) && (frequency2 == 0) && (frequency3 == 0)) ? 320 : 160)
323 if ((channelWidth != -1) &&
324 ((channelWidth < minChannelWidth) || (channelWidth > maxChannelWidth)))
326 NS_FATAL_ERROR(
"Invalid channel width: " << channelWidth <<
" MHz");
328 if (channelWidth >= minChannelWidth && channelWidth <= maxChannelWidth)
330 minChannelWidth = channelWidth;
331 maxChannelWidth = channelWidth;
333 int minGi = enableUlOfdma ? 1600 : 800;
335 if (guardInterval >= minGi && guardInterval <= maxGi)
337 minGi = guardInterval;
338 maxGi = guardInterval;
341 for (
const auto mcs : mcsValues)
345 for (
int width = minChannelWidth;
width <= maxChannelWidth;
width *= 2)
347 const auto is80Plus80 = (use80Plus80 && (
width == 160));
348 const std::string widthStr = is80Plus80 ?
"80+80" : std::to_string(width);
349 const auto segmentWidthStr = is80Plus80 ?
"80" : widthStr;
350 for (
int gi = maxGi; gi >= minGi; gi /= 2)
368 std::array<std::string, 3> channelStr;
369 std::array<FrequencyRange, 3> freqRanges;
371 std::string dataModeStr =
"EhtMcs" + std::to_string(mcs);
372 std::string ctrlRateStr;
375 if (frequency2 == frequency || frequency3 == frequency ||
376 (frequency3 != 0 && frequency3 == frequency2))
381 for (
auto freq : {frequency, frequency2, frequency3})
383 if (nLinks > 0 && freq == 0)
387 channelStr[nLinks] =
"{0, " + segmentWidthStr +
", ";
390 channelStr[nLinks] +=
"BAND_6GHZ, 0}";
394 wifi.SetRemoteStationManager(nLinks,
395 "ns3::ConstantRateWifiManager",
403 channelStr[nLinks] +=
"BAND_5GHZ, 0}";
405 ctrlRateStr =
"OfdmRate" + std::to_string(nonHtRefRateMbps) +
"Mbps";
406 wifi.SetRemoteStationManager(nLinks,
407 "ns3::ConstantRateWifiManager",
413 else if (freq == 2.4)
415 channelStr[nLinks] +=
"BAND_2_4GHZ, 0}";
419 ctrlRateStr =
"ErpOfdmRate" + std::to_string(nonHtRefRateMbps) +
"Mbps";
420 wifi.SetRemoteStationManager(nLinks,
421 "ns3::ConstantRateWifiManager",
434 channelStr[nLinks] += std::string(
";") + channelStr[nLinks];
440 if (nLinks > 1 && !emlsrLinks.empty())
449 phy.Set(
"ChannelSwitchDelay",
TimeValue(channelSwitchDelay));
451 mac.SetType(
"ns3::StaWifiMac",
"Ssid",
SsidValue(ssid));
452 mac.SetEmlsrManager(emlsrMgrTypeId,
457 "EmlsrTransitionDelay",
463 "AuxPhyChannelWidth",
465 for (uint8_t linkId = 0; linkId < nLinks; linkId++)
467 phy.Set(linkId,
"ChannelSettings",
StringValue(channelStr[linkId]));
471 spectrumChannel->AddPropagationLossModel(lossModel);
472 phy.AddChannel(spectrumChannel, freqRanges[linkId]);
476 if (dlAckSeqType !=
"NO-OFDMA")
478 mac.SetMultiUserScheduler(
"ns3::RrMultiUserScheduler",
486 mac.SetType(
"ns3::ApWifiMac",
487 "EnableBeaconJitter",
493 apDevice =
wifi.Install(phy, mac, wifiApNode);
495 int64_t streamNumber = 100;
501 "/NodeList/*/DeviceList/*/$ns3::WifiNetDevice/HeConfiguration/GuardInterval",
503 Config::Set(
"/NodeList/*/DeviceList/*/$ns3::WifiNetDevice/Mac/MpduBufferSize",
510 positionAlloc->Add(Vector(0.0, 0.0, 0.0));
511 positionAlloc->Add(Vector(distance, 0.0, 0.0));
512 mobility.SetPositionAllocator(positionAlloc);
514 mobility.SetMobilityModel(
"ns3::ConstantPositionMobilityModel");
532 stack.Install(wifiApNode);
533 stack.Install(wifiStaNodes);
534 streamNumber +=
stack.AssignStreams(wifiApNode, streamNumber);
535 streamNumber +=
stack.AssignStreams(wifiStaNodes, streamNumber);
538 address.SetBase(
"192.168.1.0",
"255.255.255.0");
542 staNodeInterfaces =
address.Assign(staDevices);
543 apNodeInterface =
address.Assign(apDevice);
554 auto serverNodes = downlink ? std::ref(wifiStaNodes) :
std::ref(
wifiApNode);
557 for (std::size_t i = 0; i < nStations; i++)
560 : apNodeInterface.
Get(0));
564 const auto maxLoad = nLinks *
575 serverApp =
server.Install(serverNodes.get());
576 streamNumber +=
server.AssignStreams(serverNodes.get(), streamNumber);
579 serverApp.
Stop(simulationTime + clientAppStartTime);
580 const auto packetInterval = payloadSize * 8.0 / maxLoad;
582 for (std::size_t i = 0; i < nStations; i++)
589 streamNumber +=
client.AssignStreams(clientNodes.
Get(i), streamNumber);
591 clientApp.
Start(clientAppStartTime);
592 clientApp.
Stop(simulationTime + clientAppStartTime);
598 uint16_t
port = 50000;
602 streamNumber +=
packetSinkHelper.AssignStreams(serverNodes.get(), streamNumber);
605 serverApp.
Stop(simulationTime + clientAppStartTime);
607 for (std::size_t i = 0; i < nStations; i++)
610 onoff.SetAttribute(
"OnTime",
611 StringValue(
"ns3::ConstantRandomVariable[Constant=1]"));
612 onoff.SetAttribute(
"OffTime",
613 StringValue(
"ns3::ConstantRandomVariable[Constant=0]"));
618 onoff.SetAttribute(
"Remote", remoteAddress);
620 streamNumber +=
onoff.AssignStreams(clientNodes.
Get(i), streamNumber);
622 clientApp.
Start(clientAppStartTime);
623 clientApp.
Stop(simulationTime + clientAppStartTime);
628 std::vector<uint64_t> cumulRxBytes(nStations, 0);
630 if (tputInterval.IsStrictlyPositive())
639 simulationTime + clientAppStartTime);
649 auto tolerance = 0.10;
650 cumulRxBytes =
GetRxBytes(udp, serverApp, payloadSize);
651 auto rxBytes = std::accumulate(cumulRxBytes.cbegin(), cumulRxBytes.cend(), 0.0);
652 auto throughput = (rxBytes * 8) / simulationTime.GetMicroSeconds();
656 std::cout << +mcs <<
"\t\t\t" << widthStr <<
" MHz\t\t"
657 << (widthStr.size() > 3 ?
"" :
"\t") << gi <<
" ns\t\t\t" <<
throughput
658 <<
" Mbit/s" << std::endl;
661 if (mcs == minMcs && width == 20 && gi == 3200)
663 if (
throughput * (1 + tolerance) < minExpectedThroughput)
670 if (mcs == maxMcs && width == maxChannelWidth && gi == 800)
672 if (maxExpectedThroughput > 0 &&
673 throughput > maxExpectedThroughput * (1 + tolerance))
690 if (
throughput * (1 + tolerance) > prevThroughput[index])
a polymophic address class
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.
uint32_t GetN() const
Get the number of Ptr<Application> stored in this container.
A container for one type of attribute.
AttributeValue implementation for Boolean.
Parse command-line arguments.
AttributeValue implementation for DataRate.
This class can be used to hold variables of floating point type such as 'double' or 'float'.
static uint64_t GetDataRate(uint8_t mcsValue, MHz_u channelWidth, Time guardInterval, uint8_t nss)
Return the data rate corresponding to the supplied EHT MCS index, channel width, guard interval,...
static uint64_t GetNonHtReferenceRate(uint8_t mcsValue)
Calculate the rate in bps of the non-HT Reference Rate corresponding to the supplied HE MCS index.
Hold variables of type enum.
aggregate IP/TCP/UDP functionality to existing Nodes.
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
static Ipv4Address GetAny()
holds a vector of std::pair of Ptr<Ipv4> and interface index.
std::pair< Ptr< Ipv4 >, uint32_t > Get(uint32_t i) const
Get the std::pair of an Ptr<Ipv4> and interface stored at the location specified by the index.
Helper class used to assign positions and mobility models to nodes.
A helper class to populate neighbor cache.
void PopulateNeighborCache()
Populate neighbor ARP and NDISC caches for all devices.
holds a vector of ns3::NetDevice pointers
Ptr< NetDevice > Get(uint32_t i) const
Get the Ptr<NetDevice> stored in this container at a given index.
keep track of a set of node pointers.
void Add(const NodeContainer &nc)
Append the contents of another NodeContainer to the end of this container.
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.
A helper to make it easier to instantiate an ns3::PacketSinkApplication on a set of nodes.
Smart pointer class similar to boost::intrusive_ptr.
static EventId Schedule(const Time &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
static void Destroy()
Execute the events scheduled with ScheduleDestroy().
static Time Now()
Return the current simulation virtual time.
static void Run()
Run the simulation.
static void Stop()
Tell the Simulator the calling event should be the last one executed.
Make it easy to create and manage PHY objects for the spectrum model.
The IEEE 802.11 SSID Information Element.
AttributeValue implementation for Ssid.
Hold variables of type string.
Simulation virtual time values and global simulation resolution.
TimeWithUnit As(const Unit unit=Time::AUTO) const
Attach a unit to a Time, to facilitate output in a specific unit.
int64_t GetMicroSeconds() const
Get an approximation of the time stored in this instance in the indicated unit.
AttributeValue implementation for Time.
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.
helps to create WifiNetDevice objects
static int64_t AssignStreams(NetDeviceContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by the PHY and MAC aspects ...
create MAC layers for a ns3::WifiNetDevice.
@ DLT_IEEE802_11_RADIO
Include Radiotap link layer information.
static void SetStaticAssociation(Ptr< WifiNetDevice > bssDev, const NetDeviceContainer &clientDevs)
Bypass static capabilities exchange for input devices.
static void SetStaticBlockAck(Ptr< WifiNetDevice > apDev, const NetDeviceContainer &clientDevs, const std::set< tid_t > &tids, std::optional< Mac48Address > gcrGroupAddr=std::nullopt)
Bypass ADDBA Request-Response exchange sequence between AP and STAs for given TIDs.
static void SetStaticEmlsr(Ptr< WifiNetDevice > apDev, const NetDeviceContainer &clientDevs)
Bypass EML Operating Mode Notification exchange sequence between AP MLD and input non-AP devices.
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file,...
Ptr< AttributeChecker > MakeAttributeContainerChecker()
Make uninitialized AttributeContainerChecker using explicit types.
Ptr< const AttributeChecker > MakeUintegerChecker()
void SetDefault(std::string name, const AttributeValue &value)
void Set(std::string path, const AttributeValue &value)
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
#define NS_ABORT_MSG(msg)
Unconditional abnormal program termination with a message.
#define NS_LOG_ERROR(msg)
Use NS_LOG to output a message of level LOG_ERROR.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Ptr< T > CreateObject(Args &&... args)
Create an object by type, with varying number of constructor parameters.
Time MicroSeconds(uint64_t value)
Construct a Time in the indicated unit.
Time NanoSeconds(uint64_t value)
Construct a Time in the indicated unit.
Time Seconds(double value)
Construct a Time in the indicated unit.
Time MilliSeconds(uint64_t value)
Construct a Time in the indicated unit.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
constexpr FrequencyRange WIFI_SPECTRUM_6_GHZ
Identifier for the frequency range covering the wifi spectrum in the 6 GHz band.
double MHz_u
MHz weak type.
Ptr< T1 > DynamicCast(const Ptr< T2 > &p)
Cast a Ptr.
constexpr FrequencyRange WIFI_SPECTRUM_5_GHZ
Identifier for the frequency range covering the wifi spectrum in the 5 GHz band.
constexpr FrequencyRange WIFI_SPECTRUM_2_4_GHZ
Identifier for the frequency range covering the wifi spectrum in the 2.4 GHz band.
double meter_u
meter weak type
void PrintIntermediateTput(std::vector< uint64_t > &rxBytes, bool udp, const ApplicationContainer &serverApp, uint32_t payloadSize, Time tputInterval, Time simulationTime)
Print average throughput over an intermediate time interval.
std::vector< uint64_t > GetRxBytes(bool udp, const ApplicationContainer &serverApp, uint32_t payloadSize)