13#include "ns3/ampdu-subframe-header.h"
14#include "ns3/ap-wifi-mac.h"
15#include "ns3/config.h"
16#include "ns3/eht-configuration.h"
17#include "ns3/eht-ppdu.h"
18#include "ns3/he-configuration.h"
19#include "ns3/ht-configuration.h"
21#include "ns3/mobility-model.h"
23#include "ns3/net-device-queue-interface.h"
24#include "ns3/obss-pd-algorithm.h"
25#include "ns3/pointer.h"
26#include "ns3/qos-txop.h"
27#include "ns3/qos-utils.h"
28#include "ns3/radiotap-header.h"
29#include "ns3/sta-wifi-mac.h"
30#include "ns3/vht-configuration.h"
31#include "ns3/wifi-mac-queue.h"
32#include "ns3/wifi-mac-trailer.h"
49 const auto shift = std::countr_zero(mask);
50 return (val << shift) & mask;
77 auto pCopy = p->Copy();
79 pCopy->RemoveTrailer(fcs);
81 <<
" " << *pCopy <<
" " << fcs << std::endl;
100 auto pCopy = p->Copy();
102 pCopy->RemoveTrailer(fcs);
104 <<
" " << fcs << std::endl;
125 auto pCopy = p->Copy();
127 pCopy->RemoveTrailer(fcs);
129 <<
" " << *pCopy <<
" " << fcs << std::endl;
148 auto pCopy = p->Copy();
150 pCopy->RemoveTrailer(fcs);
152 <<
" " << fcs << std::endl;
184 m_phys.at(linkId).Set(name, v);
198 switch (info->pcapType)
207 if (
const auto linkId = info->device->GetMac()->GetLinkForPhy(phyId))
218 if (!info->files.contains(fileIdx))
221 auto tmp = info->commonFilename;
224 auto pos = info->commonFilename.find_last_of(
'.');
226 pos = (pos == std::string::npos) ? info->commonFilename.size() : pos;
232 tmp.insert(pos,
"-" + std::to_string(fileIdx));
236 auto file = pcapHelper.
CreateFile(tmp, std::ios::out, info->pcapDlt);
237 info->files.emplace(fileIdx, file);
240 return info->files.at(fileIdx);
247 uint16_t channelFreqMhz,
257 switch (info->pcapDlt)
263 NS_FATAL_ERROR(
"PcapSniffTxEvent(): DLT_PRISM_HEADER not implemented");
272 info->device->GetPhy(phyId)->GetPrimary20Index(),
276 p->AddHeader(header);
281 NS_ABORT_MSG(
"PcapSniffTxEvent(): Unexpected data link type " << info->pcapDlt);
289 uint16_t channelFreqMhz,
300 switch (info->pcapDlt)
306 NS_FATAL_ERROR(
"PcapSniffRxEvent(): DLT_PRISM_HEADER not implemented");
315 info->device->GetPhy(phyId)->GetPrimary20Index(),
320 p->AddHeader(header);
325 NS_ABORT_MSG(
"PcapSniffRxEvent(): Unexpected data link type " << info->pcapDlt);
332 uint16_t channelFreqMhz,
341 GetRadiotapHeader(header, packet, channelFreqMhz, p20Index, txVector, aMpdu, staId);
347 uint16_t channelFreqMhz,
367 if (gi.GetNanoSeconds() == 400)
379 header.
SetRate(
static_cast<uint8_t
>(rate));
384 nss = txVector.
GetNss(staId);
400 if (channelFreqMhz < 2500)
419 if (channelWidth == 40)
424 if (gi.GetNanoSeconds() == 400)
429 const auto ness = txVector.
GetNess();
454 packet->RemoveHeader(hdr);
456 packet = packet->CreateFragment(0,
static_cast<uint32_t>(extractedLength));
475 if (gi.GetNanoSeconds() == 400)
483 if (channelWidth == 40)
485 vhtFields.bandwidth = 1;
487 else if (channelWidth == 80)
489 vhtFields.bandwidth = 4;
491 else if (channelWidth == 160)
493 vhtFields.bandwidth = 11;
497 vhtFields.mcsNss.at(0) |= (nss & 0x0f) | ((mcs << 4) & 0xf0);
573 else if (channelWidth == 40)
577 else if (channelWidth == 80)
581 else if (channelWidth == 160)
585 if (gi.GetNanoSeconds() == 1600)
589 else if (gi.GetNanoSeconds() == 3200)
613 switch (
static_cast<uint16_t
>(channelWidth))
646 std::optional<bool> isLow80MHz;
647 if (txVector.
IsDlMu() && channelWidth > 80)
649 const auto isLowP80 = p20Index < (channelWidth / 40);
651 isLow80MHz = (isLowP80 && isP80) || (!isLowP80 && !isP80);
653 const auto puncturedChannelInfo =
658 puncturedChannelInfo);
674 switch (gi.GetNanoSeconds())
677 ehtFields.data.at(0) =
732 ehtFields.data.at(1) |=
735 if (channelWidth >= 40)
737 ehtFields.data.at(2) =
741 if (channelWidth >= 80)
743 ehtFields.data.at(2) |=
749 if (channelWidth >= 160)
751 ehtFields.data.at(3) =
758 ehtFields.data.at(4) =
762 const auto isLowP80 = p20Index < (channelWidth / 40);
763 ehtFields.data.at(1) |=
776 ehtFields.userInfo.push_back(userInfo);
796 NS_ABORT_MSG(
"WifiPhyHelper::SetPcapFormat(): Unexpected format");
822 bool explicitFilename)
824 NS_LOG_FUNCTION(
this << prefix << nd << promiscuous << explicitFilename);
832 NS_LOG_INFO(
"WifiHelper::EnablePcapInternal(): Device "
833 << &device <<
" not of type ns3::WifiNetDevice");
838 "WifiPhyHelper::EnablePcapInternal(): Phy layer in WifiNetDevice must be set");
841 std::string filename;
842 if (explicitFilename)
852 for (
auto& phy : device->GetPhys())
854 phy->TraceConnectWithoutContext(
857 phy->TraceConnectWithoutContext(
867 bool explicitFilename)
875 NS_LOG_INFO(
"WifiHelper::EnableAsciiInternal(): Device "
876 << device <<
" not of type ns3::WifiNetDevice");
884 uint32_t nodeid = nd->GetNode()->GetId();
885 uint32_t deviceid = nd->GetIfIndex();
886 std::ostringstream oss;
899 std::string filename;
900 if (explicitFilename)
910 auto pos = filename.find_last_of(
'.');
912 pos = (pos == std::string::npos) ? filename.size() : pos;
914 for (uint8_t linkId = 0; linkId < device->GetNPhys(); linkId++)
916 std::string tmp = filename;
917 if (device->GetNPhys() > 1)
920 tmp.insert(pos,
"-" + std::to_string(linkId));
928 oss <<
"/NodeList/" << nodeid <<
"/DeviceList/" << deviceid
929 <<
"/$ns3::WifiNetDevice/Phys/" << +linkId <<
"/State/RxOk";
935 oss <<
"/NodeList/" << nodeid <<
"/DeviceList/" << deviceid
936 <<
"/$ns3::WifiNetDevice/Phys/" << +linkId <<
"/State/Tx";
951 oss <<
"/NodeList/" << nodeid <<
"/DeviceList/" << deviceid
952 <<
"/$ns3::WifiNetDevice/Phy/State/RxOk";
956 oss <<
"/NodeList/" << nodeid <<
"/DeviceList/" << deviceid
957 <<
"/$ns3::WifiNetDevice/Phy/State/Tx";
968 m_enableFlowControl(true)
1026 "Specified Wi-Fi standard " << standard <<
" is currently not supported");
1027 SetStandard(WIFI_STANDARDS_NAME_MAP.at(standard));
1049 for (
auto i =
first; i != last; ++i)
1053 node->AddDevice(device);
1063 device->SetHtConfiguration(htConfiguration);
1073 device->SetVhtConfiguration(vhtConfiguration);
1078 device->SetHeConfiguration(heConfiguration);
1083 device->SetEhtConfiguration(ehtConfiguration);
1085 std::vector<Ptr<WifiRemoteStationManager>> managers;
1086 std::vector<Ptr<WifiPhy>> phys = phyHelper.
Create(node, device);
1087 device->SetPhys(phys);
1090 if (stationManagers.size() == 1 && phys.size() > 1)
1092 stationManagers.resize(phys.size(), stationManagers[0]);
1095 "Number of station manager models ("
1096 << stationManagers.size() <<
") does not match the number of links ("
1097 << phys.size() <<
")");
1098 for (std::size_t i = 0; i < phys.size(); i++)
1103 device->SetRemoteStationManagers(managers);
1108 device->AggregateObject(obssPdAlgorithm);
1109 obssPdAlgorithm->ConnectWifiNetDevice(device);
1111 devices.Add(device);
1119 mac->GetAttributeFailSafe(
"QosSupported", qosSupported);
1120 if (qosSupported.
Get())
1127 wmq = qosTxop->GetWifiMacQueue();
1128 ndqi->GetTxQueue(
static_cast<std::size_t
>(ac))->ConnectQueueTraces(wmq);
1136 wmq = mac->GetTxop()->GetWifiMacQueue();
1137 ndqi->GetTxQueue(0)->ConnectQueueTraces(wmq);
1139 device->AggregateObject(ndqi);
1279 int64_t currentStream = stream;
1281 for (
auto i = c.
Begin(); i != c.
End(); ++i)
1287 for (
auto& phy : wifi->GetPhys())
1289 currentStream += phy->AssignStreams(currentStream);
1293 for (
auto& manager : wifi->GetRemoteStationManagers())
1295 currentStream += manager->AssignStreams(currentStream);
1299 auto mac = wifi->GetMac();
1301 if (!mac->GetQosSupported())
1303 mac->GetAttribute(
"Txop", ptr);
1305 currentStream += txop->AssignStreams(currentStream);
1309 mac->GetAttribute(
"VO_Txop", ptr);
1311 currentStream += vo_txop->AssignStreams(currentStream);
1313 mac->GetAttribute(
"VI_Txop", ptr);
1317 mac->GetAttribute(
"BE_Txop", ptr);
1321 mac->GetAttribute(
"BK_Txop", ptr);
1329 currentStream += apMac->AssignStreams(currentStream);
1334 currentStream += staMac->AssignStreams(currentStream);
1338 return (currentStream - stream);
Manage ASCII trace files for device models.
std::string GetFilenameFromDevice(std::string prefix, Ptr< NetDevice > device, bool useObjectNames=true)
Let the ascii trace helper figure out a reasonable filename to use for an ascii trace file associated...
Ptr< OutputStreamWrapper > CreateFileStream(std::string filename, std::ios::openmode filemode=std::ios::out)
Create and initialize an output stream object we'll use to write the traced bits.
Hold a value for an Attribute.
AttributeValue implementation for Boolean.
static uint8_t GetPuncturedInfo(const std::vector< bool > &inactiveSubchannels, uint8_t ehtPpduType, std::optional< bool > isLow80MHz)
Get the Punctured Channel Information field in the U-SIG.
std::size_t GetIndex() const
Get the RU index.
RuType GetRuType() const
Get the RU type.
bool GetPrimary80MHz() const
Get the primary 80 MHz flag.
static RuType GetRuType(MHz_u bandwidth)
Get the RU corresponding to the approximate bandwidth.
RuType
The different HE Resource Unit (RU) types.
Keep track of the current position and velocity of an object.
static Ptr< T > Find(std::string path)
Given a name path string, look to see if there's an object in the system with that associated to it.
holds a vector of ns3::NetDevice pointers
Iterator Begin() const
Get an iterator which refers to the first NetDevice in the container.
Iterator End() const
Get an iterator which indicates past-the-last NetDevice in the container.
keep track of a set of node pointers.
std::vector< Ptr< Node > >::const_iterator Iterator
Node container iterator.
Iterator End() const
Get an iterator which indicates past-the-last Node in the container.
Iterator Begin() const
Get an iterator which refers to the first Node in the container.
Ptr< Object > Create() const
Create an Object instance of the configured TypeId.
void SetTypeId(TypeId tid)
Set the TypeId of the Objects to be created by this factory.
bool IsTypeIdSet() const
Check if the ObjectFactory has been configured with a TypeId.
OBSS PD algorithm interface.
static void EnablePrinting()
Enable printing packets metadata.
Manage pcap files for device models.
std::string GetFilenameFromDevice(std::string prefix, Ptr< NetDevice > device, bool useObjectNames=true)
Let the pcap helper figure out a reasonable filename to use for a pcap file associated with a device.
Ptr< PcapFileWrapper > CreateFile(std::string filename, std::ios::openmode filemode, DataLinkType dataLinkType, uint32_t snapLen=std::numeric_limits< uint32_t >::max(), int32_t tzCorrection=0)
Create and initialize a pcap file.
DataLinkType
This enumeration holds the data link types that will be written to the pcap file.
AttributeValue implementation for Pointer.
Smart pointer class similar to boost::intrusive_ptr.
Handles the packet queue and stores DCF/EDCA access parameters (one Txop per AC).
static Time Now()
Return the current simulation virtual time.
double GetSeconds() const
Get an approximation of the time stored in this instance in the indicated unit.
Handles the packet queue and stores DCF/EDCA access parameters (one Txop per AC).
int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model.
Hold an unsigned integer type.
void SetRemoteStationManager(std::string type, Args &&... args)
Helper function used to set the station manager.
ObjectFactory m_htConfig
HT configuration.
ObjectFactory m_obssPdAlgorithm
OBSS_PD algorithm.
ObjectFactory m_ehtConfig
EHT configuration.
ObjectFactory m_vhtConfig
VHT configuration.
static void EnableLogComponents(LogLevel logLevel=LOG_LEVEL_ALL)
Helper to enable all WifiNetDevice log components with one statement.
void SetSelectQueueCallback(SelectQueueCallback f)
std::vector< ObjectFactory > m_stationManager
station manager
WifiStandard m_standard
wifi standard
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 ...
virtual void SetStandard(WifiStandard standard)
ObjectFactory m_heConfig
HE configuration.
virtual NetDeviceContainer Install(const WifiPhyHelper &phy, const WifiMacHelper &mac, NodeContainer::Iterator first, NodeContainer::Iterator last) const
void DisableFlowControl()
Disable flow control only if you know what you are doing.
SelectQueueCallback m_selectQueueCallback
select queue callback
bool m_enableFlowControl
whether to enable flow control
WifiHelper()
Create a Wifi helper in an empty state: all its parameters must be set before calling ns3::WifiHelper...
std::function< std::size_t(Ptr< QueueItem >)> SelectQueueCallback
Callback invoked to determine the MAC queue selected for a given packet.
create MAC layers for a ns3::WifiNetDevice.
virtual Ptr< WifiMac > Create(Ptr< WifiNetDevice > device, WifiStandard standard) const
Implements the IEEE 802.11 MAC trailer.
represent a single transmission mode
uint64_t GetDataRate(MHz_u channelWidth, Time guardInterval, uint8_t nss) const
uint8_t GetMcsValue() const
Hold together all Wifi-related objects.
void SetPcapCaptureType(PcapCaptureType type)
Set the PCAP capture type to be used.
static void GetRadiotapHeader(RadiotapHeader &header, Ptr< Packet > packet, uint16_t channelFreqMhz, uint8_t p20Index, const WifiTxVector &txVector, MpduInfo aMpdu, uint16_t staId)
Get the Radiotap header for a transmitted packet.
void SetPcapDataLinkType(SupportedPcapDataLinkTypes dlt)
Set the data link type of PCAP traces to be used.
void EnableAsciiInternal(Ptr< OutputStreamWrapper > stream, std::string prefix, Ptr< NetDevice > nd, bool explicitFilename) override
Enable ASCII trace output on the indicated net device.
WifiPhyHelper(uint8_t nLinks=1)
Constructor.
static void PcapSniffTxEvent(const std::shared_ptr< PcapFilesInfo > &info, uint8_t phyId, Ptr< const Packet > packet, uint16_t channelFreqMhz, WifiTxVector txVector, MpduInfo aMpdu, uint16_t staId=SU_STA_ID)
void Set(std::string name, const AttributeValue &v)
~WifiPhyHelper() override
void DisablePreambleDetectionModel()
Disable the preamble detection model on all links.
void EnablePcapInternal(std::string prefix, Ptr< NetDevice > nd, bool promiscuous, bool explicitFilename) override
Enable pcap output the indicated net device.
PcapHelper::DataLinkType m_pcapDlt
PCAP data link type.
std::vector< ObjectFactory > m_frameCaptureModel
frame capture model
std::vector< ObjectFactory > m_preambleDetectionModel
preamble detection model
PcapHelper::DataLinkType GetPcapDataLinkType() const
Get the data link type of PCAP traces to be used.
PcapCaptureType m_pcapType
PCAP capture type.
PcapCaptureType GetPcapCaptureType() const
Get the PCAP capture type to be used.
std::vector< ObjectFactory > m_phys
PHY objects.
static void PcapSniffRxEvent(const std::shared_ptr< PcapFilesInfo > &info, uint8_t phyId, Ptr< const Packet > packet, uint16_t channelFreqMhz, WifiTxVector txVector, MpduInfo aMpdu, SignalNoiseDbm signalNoise, uint16_t staId=SU_STA_ID)
void SetPreambleDetectionModel(std::string type, Args &&... args)
Helper function used to set the preamble detection model.
static Ptr< PcapFileWrapper > GetOrCreatePcapFile(const std::shared_ptr< PcapFilesInfo > &info, uint8_t phyId)
Get the PCAP file to write to from a list of PCAP files indexed by PHY ID.
SupportedPcapDataLinkTypes
An enumeration of the pcap data link types (DLTs) which this helper supports.
@ DLT_IEEE802_11
IEEE 802.11 Wireless LAN headers on packets.
@ DLT_IEEE802_11_RADIO
Include Radiotap link layer information.
@ DLT_PRISM_HEADER
Include Prism monitor mode information.
std::vector< ObjectFactory > m_errorRateModel
error rate model
virtual std::vector< Ptr< WifiPhy > > Create(Ptr< Node > node, Ptr< WifiNetDevice > device) const =0
PcapCaptureType
An enumeration of the PCAP capture types.
@ PCAP_PER_PHY
Single capture file per PHY.
@ PCAP_PER_DEVICE
Single capture file per device.
@ PCAP_PER_LINK
Single capture file per link.
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
uint8_t GetBssColor() const
Get the BSS color.
const RuAllocation & GetRuAllocation(uint8_t p20Index) const
Get RU_ALLOCATION field.
WifiMode GetMode(uint16_t staId=SU_STA_ID) const
If this TX vector is associated with an SU PPDU, return the selected payload transmission mode.
bool IsStbc() const
Check if STBC is used or not.
WifiPreamble GetPreambleType() const
HeMuUserInfo GetHeMuUserInfo(uint16_t staId) const
Get the HE MU user-specific transmission information for the given STA-ID.
HeRu::RuSpec GetRu(uint16_t staId) const
Get the RU specification for the STA-ID.
uint8_t GetEhtPpduType() const
Get the EHT_PPDU_TYPE parameter.
WifiModulationClass GetModulationClass() const
Get the modulation class specified by this TXVECTOR.
uint8_t GetNss(uint16_t staId=SU_STA_ID) const
If this TX vector is associated with an SU PPDU, return the number of spatial streams.
MHz_u GetChannelWidth() const
bool IsAggregation() const
Checks whether the PSDU contains A-MPDU.
Time GetGuardInterval() const
WifiMode GetSigBMode() const
Get MCS used for SIG-B.
const std::vector< bool > & GetInactiveSubchannels() const
Get the 20 MHz subchannels that are punctured.
void Connect(std::string path, const CallbackBase &cb)
void ConnectWithoutContext(std::string path, const CallbackBase &cb)
#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_ABORT_MSG_IF(cond, msg)
Abnormal program termination if a condition is true, with a message.
#define NS_ABORT_IF(cond)
Abnormal program termination if a condition is true.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
auto MakeBoundCallback(R(*fnPtr)(Args...), BArgs &&... bargs)
Make Callbacks with varying number of bound arguments.
Ptr< T > CreateObject(Args &&... args)
Create an object by type, with varying number of constructor parameters.
Ptr< T > CreateObjectWithAttributes(Args... args)
Allocate an Object on the heap and initialize with a set of attributes.
Ptr< T > Create(Ts &&... args)
Create class instances by constructors with varying numbers of arguments and return them by Ptr.
WifiStandard
Identifies the IEEE 802.11 specifications that a Wifi device can be configured to use.
WifiPreamble
The type of preamble to be used by an IEEE 802.11 transmission.
uint8_t SelectQueueByDSField(Ptr< QueueItem > item)
Determine the TX queue for a given packet.
@ WIFI_STANDARD_UNSPECIFIED
@ WIFI_MOD_CLASS_HT
HT (Clause 19)
@ WIFI_MOD_CLASS_VHT
VHT (Clause 22)
@ WIFI_MOD_CLASS_HE
HE (Clause 27)
@ LAST_MPDU_IN_AGGREGATE
The MPDU is the last aggregate in an A-MPDU with multiple MPDUs.
uint32_t GetRadiotapField(uint32_t mask, uint32_t val)
Helper function to place the value to set in the correct bit(s) of a radiotap subfield.
const std::unordered_map< std::string, WifiStandard > WIFI_STANDARDS_NAME_MAP
Map strings to WifiStandard enum values.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void LogComponentEnable(const std::string &name, LogLevel level)
Enable the logging output associated with that log component.
bool IsEht(WifiPreamble preamble)
Return true if a preamble corresponds to an EHT transmission.
Ptr< T1 > DynamicCast(const Ptr< T2 > &p)
Cast a Ptr.
static void AsciiPhyReceiveSinkWithoutContext(Ptr< OutputStreamWrapper > stream, Ptr< const Packet > p, double snr, WifiMode mode, WifiPreamble preamble)
ASCII trace PHY receive sink without context.
LogLevel
Logging severity classes and levels.
@ LOG_PREFIX_TIME
Prefix all trace prints with simulation time.
@ LOG_PREFIX_NODE
Prefix all trace prints with simulation node.
static void AsciiPhyReceiveSinkWithContext(Ptr< OutputStreamWrapper > stream, std::string context, Ptr< const Packet > p, double snr, WifiMode mode, WifiPreamble preamble)
ASCII trace PHY receive sink with context.
void LogComponentEnableAll(LogLevel level)
Enable the logging output for all registered log components.
static void AsciiPhyTransmitSinkWithContext(Ptr< OutputStreamWrapper > stream, std::string context, Ptr< const Packet > p, WifiMode mode, WifiPreamble preamble, uint8_t txLevel)
ASCII trace PHY transmit sink with context.
static void AsciiPhyTransmitSinkWithoutContext(Ptr< OutputStreamWrapper > stream, Ptr< const Packet > p, WifiMode mode, WifiPreamble preamble, uint8_t txLevel)
ASCII trace PHY transmit sink without context.
HeRu::RuSpec ru
RU specification.
MpduType type
type of MPDU
uint32_t mpduRefNumber
MPDU ref number.
SignalNoiseDbm structure.
dBm_u signal
signal strength