30#include "ns3/boolean.h"
31#include "ns3/eht-configuration.h"
33#include "ns3/erp-ofdm-phy.h"
34#include "ns3/he-configuration.h"
35#include "ns3/ht-configuration.h"
36#include "ns3/ht-phy.h"
38#include "ns3/simulator.h"
39#include "ns3/uinteger.h"
40#include "ns3/vht-configuration.h"
53 TypeId(
"ns3::WifiRemoteStationManager")
56 .AddAttribute(
"MaxSsrc",
57 "The maximum number of retransmission attempts for any packet with size "
58 "<= RtsCtsThreshold. "
59 "This value will not have any effect on some rate control algorithms.",
62 MakeUintegerChecker<uint32_t>())
63 .AddAttribute(
"MaxSlrc",
64 "The maximum number of retransmission attempts for any packet with size "
66 "This value will not have any effect on some rate control algorithms.",
69 MakeUintegerChecker<uint32_t>())
70 .AddAttribute(
"RtsCtsThreshold",
71 "If the size of the PSDU is bigger than this value, we use an RTS/CTS "
72 "handshake before sending the data frame."
73 "This value will not have any effect on some rate control algorithms.",
76 MakeUintegerChecker<uint32_t>())
78 "FragmentationThreshold",
79 "If the size of the PSDU is bigger than this value, we fragment it such that the "
80 "size of the fragments are equal or smaller. "
81 "This value does not apply when it is carried in an A-MPDU. "
82 "This value will not have any effect on some rate control algorithms.",
86 MakeUintegerChecker<uint32_t>())
87 .AddAttribute(
"NonUnicastMode",
88 "Wifi mode used for non-unicast transmissions.",
91 MakeWifiModeChecker())
92 .AddAttribute(
"DefaultTxPowerLevel",
93 "Default power level to be used for transmissions. "
94 "This is the power level that is used by all those WifiManagers that do "
95 "not implement TX power control.",
98 MakeUintegerChecker<uint8_t>())
99 .AddAttribute(
"ErpProtectionMode",
100 "Protection mode used when non-ERP STAs are connected to an ERP AP: "
101 "Rts-Cts or Cts-To-Self",
108 .AddAttribute(
"HtProtectionMode",
109 "Protection mode used when non-HT STAs are connected to a HT AP: Rts-Cts "
117 .AddTraceSource(
"MacTxRtsFailed",
118 "The transmission of a RTS by the MAC layer has failed",
120 "ns3::Mac48Address::TracedCallback")
121 .AddTraceSource(
"MacTxDataFailed",
122 "The transmission of a data packet by the MAC layer has failed",
124 "ns3::Mac48Address::TracedCallback")
126 "MacTxFinalRtsFailed",
127 "The transmission of a RTS has exceeded the maximum number of attempts",
129 "ns3::Mac48Address::TracedCallback")
131 "MacTxFinalDataFailed",
132 "The transmission of a data packet has exceeded the maximum number of attempts",
134 "ns3::Mac48Address::TracedCallback");
139 : m_useNonErpProtection(false),
140 m_useNonHtProtection(false),
141 m_shortPreambleEnabled(false),
142 m_shortSlotTimeEnabled(false)
282 return htConfiguration->GetLdpcSupported();
295 if (htConfiguration->GetShortGuardIntervalSupported())
312 gi =
static_cast<uint16_t
>(heConfiguration->GetGuardInterval().GetNanoSeconds());
325 bool isShortPreambleSupported)
329 LookupState(address)->m_shortPreamble = isShortPreambleSupported;
334 bool isShortSlotTimeSupported)
338 LookupState(address)->m_shortSlotTime = isShortSlotTimeSupported;
347 for (
const auto& i : state->m_operationalRateSet)
357 state->m_dsssSupported =
true;
361 state->m_erpOfdmSupported =
true;
365 state->m_ofdmSupported =
true;
367 state->m_operationalRateSet.push_back(mode);
376 state->m_operationalRateSet.clear();
379 state->m_operationalRateSet.push_back(mode);
380 if (mode.IsMandatory())
395 state->m_operationalMcsSet =
WifiModeList(mcsList.begin(), mcsList.end());
412 for (
const auto& i : state->m_operationalMcsSet)
419 state->m_operationalMcsSet.push_back(mcs);
443 if (address.IsGroup())
453 if (address.IsGroup())
463 if (address.IsGroup())
501 if (address.IsGroup())
518 std::shared_ptr<WifiRemoteStationState> state;
519 if (!remoteAddress.IsGroup() &&
543 if (staMac->IsAssociated())
545 staId = staMac->GetAssociationId();
566std::optional<Mac48Address>
569 if (
auto stateIt =
m_states.find(address);
570 stateIt !=
m_states.end() && stateIt->second->m_mleCommonInfo)
572 return stateIt->second->m_mleCommonInfo->m_mldMacAddress;
578std::optional<Mac48Address>
581 auto stateIt =
m_states.find(mldAddress);
583 if (stateIt ==
m_states.end() || !stateIt->second->m_mleCommonInfo)
589 NS_ASSERT(stateIt->second->m_mleCommonInfo->m_mldMacAddress == mldAddress);
590 return stateIt->second->m_address;
598 if (!header.
IsMgt() && address.IsGroup())
630 uint16_t channelWidth = allowedWidth;
634 rxWidth < channelWidth)
636 channelWidth = rxWidth;
654 txVector.
SetBssColor(heConfiguration->GetBssColor());
661 <<
" MHz) exceeds allowed width (" << allowedWidth
707 if (address.IsGroup())
736 uint16_t ctsTxGuardInterval =
748 auto txMode = txVector.
GetMode();
756 else if (rate >= 12e6)
787 uint16_t ackTxGuardInterval =
806 uint16_t blockAckTxGuardInterval =
873 NS_LOG_DEBUG(
"WifiRemoteStationManager::GetControlAnswerMode returning " << mode);
905 if (thismode.IsMandatory() && (!found || thismode.IsHigherDataRate(mode)) &&
906 (!thismode.IsHigherDataRate(reqMode)) &&
908 thismode.GetModulationClass())))
921 if (thismode.IsMandatory() && (!found || thismode.IsHigherDataRate(mode)) &&
922 (!thismode.IsHigherCodeRate(reqMode)) &&
948 NS_LOG_DEBUG(
"WifiRemoteStationManager::GetControlAnswerMode returning " << mode);
967 NS_ASSERT(!mpdu->GetHeader().GetAddr1().IsGroup());
969 QosUtilsMapTidToAc((mpdu->GetHeader().IsQosData()) ? mpdu->GetHeader().GetQosTid() : 0);
1005 NS_LOG_FUNCTION(
this << *mpdu << ackSnr << ackMode << dataSnr << dataTxVector);
1046 NS_ASSERT(!mpdu->GetHeader().GetAddr1().IsGroup());
1049 QosUtilsMapTidToAc((mpdu->GetHeader().IsQosData()) ? mpdu->GetHeader().GetQosTid() : 0);
1070 if (address.IsGroup())
1081 uint16_t nSuccessfulMpdus,
1082 uint16_t nFailedMpdus,
1087 NS_LOG_FUNCTION(
this << address << nSuccessfulMpdus << nFailedMpdus << rxSnr << dataSnr
1090 for (uint16_t i = 0; i < nFailedMpdus; i++)
1110 if (address.IsGroup())
1121 "WifiRemoteStationManager::NeedRTS returning true to protect non-ERP stations");
1128 NS_LOG_DEBUG(
"WifiRemoteStationManager::NeedRTS returning true to protect non-HT stations");
1149 "WifiRemoteStationManager::NeedCtsToSelf returning true to protect non-ERP stations");
1158 "WifiRemoteStationManager::NeedCtsToSelf returning true to protect non-HT stations");
1169 NS_LOG_DEBUG(
"WifiRemoteStationManager::NeedCtsToSelf returning false");
1181 NS_LOG_DEBUG(
"WifiRemoteStationManager::NeedCtsToSelf returning false");
1186 NS_LOG_DEBUG(
"WifiRemoteStationManager::NeedCtsToSelf returning true");
1222 NS_ASSERT(!mpdu->GetHeader().GetAddr1().IsGroup());
1224 QosUtilsMapTidToAc((mpdu->GetHeader().IsQosData()) ? mpdu->GetHeader().GetQosTid() : 0);
1238 bool normally = retryCount < maxRetryCount;
1239 NS_LOG_DEBUG(
"WifiRemoteStationManager::NeedRetransmission count: "
1240 << retryCount <<
" result: " << std::boolalpha << normally);
1248 if (mpdu->GetHeader().GetAddr1().IsGroup())
1253 NS_LOG_DEBUG(
"WifiRemoteStationManager::NeedFragmentation result: " << std::boolalpha
1262 if (threshold < 256)
1267 NS_LOG_WARN(
"Fragmentation threshold should be larger than 256. Setting to 256.");
1276 if (threshold % 2 != 0)
1278 NS_LOG_WARN(
"Fragmentation threshold should be an even number. Setting to "
1301 (mpdu->GetPacket()->GetSize() /
1305 if ((mpdu->GetPacket()->GetSize() %
1310 NS_LOG_DEBUG(
"WifiRemoteStationManager::GetNFragments returning " << nFragments);
1318 NS_ASSERT(!mpdu->GetHeader().GetAddr1().IsGroup());
1320 if (fragmentNumber >= nFragment)
1322 NS_LOG_DEBUG(
"WifiRemoteStationManager::GetFragmentSize returning 0");
1326 if (fragmentNumber == nFragment - 1)
1329 mpdu->GetPacket()->GetSize() -
1332 NS_LOG_DEBUG(
"WifiRemoteStationManager::GetFragmentSize returning " << lastFragmentSize);
1333 return lastFragmentSize;
1340 NS_LOG_DEBUG(
"WifiRemoteStationManager::GetFragmentSize returning " << fragmentSize);
1341 return fragmentSize;
1349 NS_ASSERT(!mpdu->GetHeader().GetAddr1().IsGroup());
1353 NS_LOG_DEBUG(
"WifiRemoteStationManager::GetFragmentOffset returning " << fragmentOffset);
1354 return fragmentOffset;
1361 NS_ASSERT(!mpdu->GetHeader().GetAddr1().IsGroup());
1363 NS_LOG_DEBUG(
"WifiRemoteStationManager::IsLastFragment returning " << std::boolalpha << isLast);
1379std::optional<double>
1382 auto station =
Lookup(address);
1383 auto rssi = station->m_rssiAndUpdateTimePair.first;
1384 auto ts = station->m_rssiAndUpdateTimePair.second;
1385 if (ts.IsStrictlyPositive())
1389 return std::nullopt;
1392std::shared_ptr<WifiRemoteStationState>
1396 auto stateIt =
m_states.find(address);
1400 NS_LOG_DEBUG(
"WifiRemoteStationManager::LookupState returning existing state");
1401 return stateIt->second;
1404 auto state = std::make_shared<WifiRemoteStationState>();
1406 state->m_address = address;
1410 state->m_dsssSupported =
false;
1411 state->m_erpOfdmSupported =
false;
1412 state->m_ofdmSupported =
false;
1413 state->m_htCapabilities =
nullptr;
1414 state->m_vhtCapabilities =
nullptr;
1415 state->m_heCapabilities =
nullptr;
1416 state->m_ehtCapabilities =
nullptr;
1417 state->m_mleCommonInfo =
nullptr;
1418 state->m_emlsrEnabled =
false;
1422 state->m_aggregation =
false;
1423 state->m_qosSupported =
false;
1424 state->m_isInPsMode =
false;
1426 NS_LOG_DEBUG(
"WifiRemoteStationManager::LookupState returning new state");
1434 auto stationIt = m_stations.find(address);
1436 if (stationIt != m_stations.end())
1438 return stationIt->second;
1442 station->
m_state = LookupState(address).get();
1449WifiRemoteStationManager::SetAssociationId(
Mac48Address remoteAddress, uint16_t aid)
1452 LookupState(remoteAddress)->m_aid = aid;
1456WifiRemoteStationManager::SetQosSupport(
Mac48Address from,
bool qosSupported)
1459 LookupState(from)->m_qosSupported = qosSupported;
1463WifiRemoteStationManager::SetEmlsrEnabled(
const Mac48Address& from,
bool emlsrEnabled)
1466 LookupState(from)->m_emlsrEnabled = emlsrEnabled;
1474 auto state = LookupState(from);
1477 state->m_channelWidth = 40;
1481 state->m_channelWidth = 20;
1483 SetQosSupport(from,
true);
1488 AddSupportedMcs(from, mcs);
1491 state->m_htCapabilities = Create<const HtCapabilities>(htCapabilities);
1500 auto state = LookupState(from);
1503 state->m_channelWidth = 160;
1507 state->m_channelWidth = 80;
1509 for (uint8_t i = 1; i <= m_wifiPhy->GetMaxSupportedTxSpatialStreams(); i++)
1515 AddSupportedMcs(from, mcs);
1519 state->m_vhtCapabilities = Create<const VhtCapabilities>(vhtCapabilities);
1527 auto state = LookupState(from);
1533 state->m_channelWidth = 160;
1537 state->m_channelWidth = 80;
1545 state->m_channelWidth = 40;
1549 state->m_channelWidth = 20;
1554 state->m_guardInterval = 800;
1559 state->m_guardInterval = 3200;
1565 AddSupportedMcs(from, mcs);
1568 state->m_heCapabilities = Create<const HeCapabilities>(heCapabilities);
1569 SetQosSupport(from,
true);
1578 auto state = LookupState(from);
1581 for (uint8_t mapType = 0; mapType < EhtMcsAndNssSet::EHT_MCS_MAP_TYPE_MAX; ++mapType)
1586 AddSupportedMcs(from, mcs);
1590 state->m_ehtCapabilities = Create<const EhtCapabilities>(ehtCapabilities);
1591 SetQosSupport(from,
true);
1595WifiRemoteStationManager::AddStationMleCommonInfo(
1597 const std::shared_ptr<CommonInfoBasicMle>& mleCommonInfo)
1600 auto state = LookupState(from);
1601 state->m_mleCommonInfo = mleCommonInfo;
1604 {mleCommonInfo->m_mldMacAddress, state});
1607Ptr<const HtCapabilities>
1610 return LookupState(from)->m_htCapabilities;
1616 return LookupState(from)->m_vhtCapabilities;
1622 return LookupState(from)->m_heCapabilities;
1628 return LookupState(from)->m_ehtCapabilities;
1631std::optional<std::reference_wrapper<CommonInfoBasicMle::EmlCapabilities>>
1632WifiRemoteStationManager::GetStationEmlCapabilities(
const Mac48Address& from)
1634 if (
auto state = LookupState(from);
1635 state->m_mleCommonInfo && state->m_mleCommonInfo->m_emlCapabilities)
1637 return state->m_mleCommonInfo->m_emlCapabilities.value();
1639 return std::nullopt;
1642std::optional<std::reference_wrapper<CommonInfoBasicMle::MldCapabilities>>
1643WifiRemoteStationManager::GetStationMldCapabilities(
const Mac48Address& from)
1645 if (
auto state = LookupState(from);
1646 state->m_mleCommonInfo && state->m_mleCommonInfo->m_mldCapabilities)
1648 return state->m_mleCommonInfo->m_mldCapabilities.value();
1650 return std::nullopt;
1659 bool supported =
false;
1662 supported |= htCapabilities->GetLdpc();
1664 if (vhtCapabilities)
1666 supported |= vhtCapabilities->GetRxLdpc();
1670 supported |= heCapabilities->GetLdpcCodingInPayload();
1676WifiRemoteStationManager::GetDefaultMode()
const
1678 return m_defaultTxMode;
1682WifiRemoteStationManager::GetDefaultMcs()
const
1684 return m_defaultTxMcs;
1692 if (!GetHtSupported() || !GetHtSupported(st))
1694 return GetDefaultMode();
1699 if (GetHeSupported() && GetHeSupported(st))
1703 else if (GetVhtSupported() && GetVhtSupported(st))
1709 return *m_wifiPhy->GetPhyEntity(modClass)->begin();
1713WifiRemoteStationManager::Reset()
1717 for (
auto& state : m_stations)
1719 delete (state.second);
1722 m_bssBasicRateSet.clear();
1723 m_bssBasicMcsSet.clear();
1734 NS_FATAL_ERROR(
"It is not allowed to add a HT rate in the BSSBasicRateSet!");
1736 for (uint8_t i = 0; i < GetNBasicModes(); i++)
1738 if (GetBasicMode(i) == mode)
1743 m_bssBasicRateSet.push_back(mode);
1747WifiRemoteStationManager::GetNBasicModes()
const
1749 return static_cast<uint8_t
>(m_bssBasicRateSet.size());
1753WifiRemoteStationManager::GetBasicMode(uint8_t i)
const
1756 return m_bssBasicRateSet[i];
1760WifiRemoteStationManager::GetNNonErpBasicModes()
const
1763 for (
auto i = m_bssBasicRateSet.begin(); i != m_bssBasicRateSet.end(); i++)
1775WifiRemoteStationManager::GetNonErpBasicMode(uint8_t i)
const
1780 for (
auto j = m_bssBasicRateSet.begin(); j != m_bssBasicRateSet.end();)
1796 return m_bssBasicRateSet[index];
1803 for (uint8_t i = 0; i < GetNBasicMcs(); i++)
1805 if (GetBasicMcs(i) == mcs)
1810 m_bssBasicMcsSet.push_back(mcs);
1814WifiRemoteStationManager::GetNBasicMcs()
const
1816 return static_cast<uint8_t
>(m_bssBasicMcsSet.size());
1820WifiRemoteStationManager::GetBasicMcs(uint8_t i)
const
1823 return m_bssBasicMcsSet[i];
1827WifiRemoteStationManager::GetNonUnicastMode()
const
1829 if (m_nonUnicastMode ==
WifiMode())
1831 if (GetNBasicModes() > 0)
1833 return GetBasicMode(0);
1837 return GetDefaultMode();
1842 return m_nonUnicastMode;
1870 uint16_t nSuccessfulMpdus,
1871 uint16_t nFailedMpdus,
1874 uint16_t dataChannelWidth,
1877 NS_LOG_DEBUG(
"DoReportAmpduTxStatus received but the manager does not handle A-MPDUs!");
1890 NS_ASSERT(i < GetNMcsSupported(station));
1897 NS_ASSERT(i < GetNNonErpSupported(station));
1941 if (!htCapabilities)
1945 return htCapabilities->GetShortGuardInterval20();
1965 if (!htCapabilities)
1969 return htCapabilities->GetRxHighestSupportedAntennas();
1979WifiRemoteStationManager::GetPhy()
const
1985WifiRemoteStationManager::GetMac()
const
2030 return mleCommonInfo && mleCommonInfo->m_emlCapabilities &&
2031 mleCommonInfo->m_emlCapabilities->emlsrSupport == 1;
2064WifiRemoteStationManager::GetChannelWidthSupported(
Mac48Address address)
const
2066 return LookupState(address)->m_channelWidth;
2070WifiRemoteStationManager::GetShortGuardIntervalSupported(
Mac48Address address)
const
2074 if (!htCapabilities)
2078 return htCapabilities->GetShortGuardInterval20();
2082WifiRemoteStationManager::GetNumberOfSupportedStreams(
Mac48Address address)
const
2086 if (!htCapabilities)
2090 return htCapabilities->GetRxHighestSupportedAntennas();
2096 return static_cast<uint8_t
>(LookupState(address)->m_operationalMcsSet.size());
2100WifiRemoteStationManager::GetDsssSupported(
const Mac48Address& address)
const
2102 return (LookupState(address)->m_dsssSupported);
2106WifiRemoteStationManager::GetErpOfdmSupported(
const Mac48Address& address)
const
2108 return (LookupState(address)->m_erpOfdmSupported);
2112WifiRemoteStationManager::GetOfdmSupported(
const Mac48Address& address)
const
2114 return (LookupState(address)->m_ofdmSupported);
2120 return bool(LookupState(address)->m_htCapabilities);
2126 return bool(LookupState(address)->m_vhtCapabilities);
2132 return bool(LookupState(address)->m_heCapabilities);
2138 return (
bool)(LookupState(address)->m_ehtCapabilities);
2142WifiRemoteStationManager::GetEmlsrSupported(
const Mac48Address& address)
const
2144 auto mleCommonInfo = LookupState(address)->m_mleCommonInfo;
2145 return mleCommonInfo && mleCommonInfo->m_emlCapabilities &&
2146 mleCommonInfo->m_emlCapabilities->emlsrSupport == 1;
2150WifiRemoteStationManager::GetEmlsrEnabled(
const Mac48Address& address)
const
2152 if (
auto stateIt = m_states.find(address); stateIt != m_states.cend())
2154 return stateIt->second->m_emlsrEnabled;
2160WifiRemoteStationManager::SetDefaultTxPowerLevel(uint8_t txPower)
2162 m_defaultTxPowerLevel = txPower;
2166WifiRemoteStationManager::GetNumberOfAntennas()
const
2168 return m_wifiPhy->GetNumberOfAntennas();
2172WifiRemoteStationManager::GetMaxNumberOfTransmitStreams()
const
2174 return m_wifiPhy->GetMaxSupportedTxSpatialStreams();
2180 return (GetLdpcSupported() && GetLdpcSupported(dest));
The IEEE 802.11be EHT Capabilities.
uint8_t GetHighestSupportedRxMcs(EhtMcsAndNssSet::EhtMcsMapType mapType)
Get the highest supported RX MCS for a given EHT-MCS map type.
Hold variables of type enum.
static WifiMode GetErpOfdmRate(uint64_t rate)
Return a WifiMode for ERP-OFDM corresponding to the provided rate.
The IEEE 802.11ax HE Capabilities.
uint8_t GetHighestMcsSupported() const
Get highest MCS supported.
bool GetHeSuPpdu1xHeLtf800nsGi() const
Get 1xHE-LTF and 800ns GI in HE SU PPDU reception support.
uint8_t GetChannelWidthSet() const
Get channel width set.
The HT Capabilities Information Element.
uint8_t GetSupportedChannelWidth() const
Return the supported channel width.
bool IsSupportedMcs(uint8_t mcs) const
Return the is MCS supported flag.
static WifiMode GetHtMcs(uint8_t index)
Return the HT MCS corresponding to the provided index.
A base class which provides memory management and object aggregation.
static WifiMode GetOfdmRate(uint64_t rate, uint16_t bw=20)
Return a WifiMode for OFDM corresponding to the provided rate and the channel bandwidth (20,...
Smart pointer class similar to boost::intrusive_ptr.
static Time Now()
Return the current simulation virtual time.
a unique identifier for an interface.
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Hold an unsigned integer type.
The IEEE 802.11ac VHT Capabilities.
bool IsSupportedMcs(uint8_t mcs, uint8_t nss) const
Get the is MCS supported.
uint8_t GetSupportedChannelWidthSet() const
Get the supported channel width set.
TypeOfStation GetTypeOfStation() const
Return the type of station.
represent a single transmission mode
bool IsHigherDataRate(WifiMode mode) const
WifiModulationClass GetModulationClass() const
uint64_t GetDataRate(uint16_t channelWidth, uint16_t guardInterval, uint8_t nss) const
uint8_t GetMcsValue() const
AttributeValue implementation for WifiMode.
Ptr< VhtConfiguration > GetVhtConfiguration() const
Ptr< EhtConfiguration > GetEhtConfiguration() const
Ptr< HtConfiguration > GetHtConfiguration() const
Ptr< HeConfiguration > GetHeConfiguration() const
uint16_t GetChannelWidth() const
WifiPhyBand GetPhyBand() const
Get the configured Wi-Fi band.
Ptr< WifiNetDevice > GetDevice() const
Return the device this PHY is associated with.
uint16_t GetTxBandwidth(WifiMode mode, uint16_t maxAllowedBandWidth=std::numeric_limits< uint16_t >::max()) const
Get the bandwidth for a transmission occurring on the current operating channel and using the given W...
std::list< WifiMode > GetMcsList() const
The WifiPhy::GetMcsList() method is used (e.g., by a WifiRemoteStationManager) to determine the set o...
std::list< WifiMode > GetModeList() const
The WifiPhy::GetModeList() method is used (e.g., by a WifiRemoteStationManager) to determine the set ...
TID independent remote station statistics.
void NotifyTxSuccess(uint32_t retryCounter)
Updates average frame error rate when data or RTS was transmitted successfully.
void NotifyTxFailed()
Updates average frame error rate when final data or RTS has failed.
hold a list of per-remote-station state.
void ReportDataFailed(Ptr< const WifiMpdu > mpdu)
Should be invoked whenever the AckTimeout associated to a transmission attempt expires.
bool GetQosSupported(Mac48Address address) const
Return whether the given station is QoS capable.
WifiTxVector GetAckTxVector(Mac48Address to, const WifiTxVector &dataTxVector) const
Return a TXVECTOR for the Ack frame given the destination and the mode of the Data used by the sender...
virtual bool DoNeedFragmentation(WifiRemoteStation *station, Ptr< const Packet > packet, bool normally)
uint32_t m_fragmentationThreshold
Current threshold for fragmentation.
void SetShortSlotTimeEnabled(bool enable)
Enable or disable short slot time.
void SetPsMode(const Mac48Address &address, bool isInPsMode)
Register whether the STA is in Power Save mode or not.
void AddBasicMode(WifiMode mode)
Invoked in a STA upon association to store the set of rates which belong to the BSSBasicRateSet of th...
virtual int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model.
uint32_t GetNFragments(Ptr< const WifiMpdu > mpdu)
Return the number of fragments needed for the given packet.
uint16_t GetAssociationId(Mac48Address remoteAddress) const
Get the AID of a remote station.
WifiMode m_defaultTxMcs
The default transmission modulation-coding scheme (MCS)
ProtectionMode m_htProtectionMode
Protection mode for HT stations when non-HT stations are detected.
void AdjustTxVectorForIcf(WifiTxVector &txVector) const
Adjust the TXVECTOR for an initial Control frame to ensure that the modulation class is non-HT and th...
std::array< uint32_t, AC_BE_NQOS > m_slrc
long retry count per AC
WifiRemoteStation * Lookup(Mac48Address address) const
Return the station associated with the given address.
uint32_t GetFragmentationThreshold() const
Return the fragmentation threshold.
bool NeedRetransmission(Ptr< const WifiMpdu > mpdu)
uint8_t GetNBasicModes() const
Return the number of basic modes we support.
bool UseLdpcForDestination(Mac48Address dest) const
uint32_t m_maxSsrc
Maximum STA short retry count (SSRC)
void SetRtsCtsThreshold(uint32_t threshold)
Sets the RTS threshold.
void AddAllSupportedMcs(Mac48Address address)
Invoked in a STA or AP to store all of the MCS supported by a destination which is also supported loc...
TracedCallback< Mac48Address > m_macTxRtsFailed
The trace source fired when the transmission of a single RTS has failed.
virtual bool DoNeedRts(WifiRemoteStation *station, uint32_t size, bool normally)
void DoSetFragmentationThreshold(uint32_t threshold)
Actually sets the fragmentation threshold, it also checks the validity of the given threshold.
bool IsBrandNew(Mac48Address address) const
Return whether the station state is brand new.
virtual void DoReportFinalDataFailed(WifiRemoteStation *station)=0
This method is a pure virtual method that must be implemented by the sub-class.
virtual void DoReportRtsOk(WifiRemoteStation *station, double ctsSnr, WifiMode ctsMode, double rtsSnr)=0
This method is a pure virtual method that must be implemented by the sub-class.
bool GetShortSlotTimeEnabled() const
Return whether the device uses short slot time.
void DoDispose() override
Destructor implementation.
virtual void DoReportDataFailed(WifiRemoteStation *station)=0
This method is a pure virtual method that must be implemented by the sub-class.
bool NeedRts(const WifiMacHeader &header, uint32_t size)
uint8_t GetDefaultTxPowerLevel() const
bool IsLastFragment(Ptr< const WifiMpdu > mpdu, uint32_t fragmentNumber)
void ReportFinalDataFailed(Ptr< const WifiMpdu > mpdu)
Should be invoked after calling ReportDataFailed if NeedRetransmission returns false.
~WifiRemoteStationManager() override
void SetUseNonErpProtection(bool enable)
Enable or disable protection for non-ERP stations.
bool m_useNonHtProtection
flag if protection for non-HT stations against HT transmissions is enabled
bool GetShortPreambleSupported(Mac48Address address) const
Return whether the station supports short PHY preamble or not.
void AddAllSupportedModes(Mac48Address address)
Invoked in a STA or AP to store all of the modes supported by a destination which is also supported l...
std::optional< Mac48Address > GetAffiliatedStaAddress(const Mac48Address &mldAddress) const
Get the address of the remote station operating on this link and affiliated with the MLD having the g...
void ReportRtsOk(const WifiMacHeader &header, double ctsSnr, WifiMode ctsMode, double rtsSnr)
Should be invoked whenever we receive the CTS associated to an RTS we just sent.
void AddSupportedMcs(Mac48Address address, WifiMode mcs)
Record the MCS index supported by the station.
WifiTxVector GetBlockAckTxVector(Mac48Address to, const WifiTxVector &dataTxVector) const
Return a TXVECTOR for the BlockAck frame given the destination and the mode of the Data used by the s...
void RemoveAllSupportedMcs(Mac48Address address)
Invoked in a STA or AP to delete all of the supported MCS by a destination.
uint32_t DoGetFragmentationThreshold() const
Return the current fragmentation threshold.
WifiModeList m_bssBasicMcsSet
basic MCS set
TracedCallback< Mac48Address > m_macTxFinalRtsFailed
The trace source fired when the transmission of a RTS has exceeded the maximum number of attempts.
WifiMode GetNonUnicastMode() const
Return a mode for non-unicast packets.
bool m_shortPreambleEnabled
flag if short PHY preamble is enabled
bool GetShortSlotTimeSupported(Mac48Address address) const
Return whether the station supports short ERP slot time or not.
void SetShortPreambleEnabled(bool enable)
Enable or disable short PHY preambles.
virtual WifiTxVector DoGetDataTxVector(WifiRemoteStation *station, uint16_t allowedWidth)=0
WifiMode GetDefaultMcs() const
Return the default Modulation and Coding Scheme (MCS) index.
Ptr< WifiPhy > m_wifiPhy
This is a pointer to the WifiPhy associated with this WifiRemoteStationManager that is set on call to...
void ReportRxOk(Mac48Address address, RxSignalInfo rxSignalInfo, WifiTxVector txVector)
uint8_t m_defaultTxPowerLevel
Default transmission power level.
static TypeId GetTypeId()
Get the type ID.
WifiMode m_nonUnicastMode
Transmission mode for non-unicast Data frames.
void SetUseNonHtProtection(bool enable)
Enable or disable protection for non-HT stations.
uint16_t GetGuardInterval() const
Return the supported HE guard interval duration (in nanoseconds).
bool IsAssociated(Mac48Address address) const
Return whether the station associated.
WifiRemoteStationManager()
bool NeedFragmentation(Ptr< const WifiMpdu > mpdu)
void ReportAmpduTxStatus(Mac48Address address, uint16_t nSuccessfulMpdus, uint16_t nFailedMpdus, double rxSnr, double dataSnr, WifiTxVector dataTxVector)
Typically called per A-MPDU, either when a Block ACK was successfully received or when a BlockAckTime...
uint32_t GetFragmentOffset(Ptr< const WifiMpdu > mpdu, uint32_t fragmentNumber)
WifiRemoteStationInfo GetInfo(Mac48Address address)
uint32_t GetFragmentSize(Ptr< const WifiMpdu > mpdu, uint32_t fragmentNumber)
WifiTxVector GetCtsToSelfTxVector()
Since CTS-to-self parameters are not dependent on the station, it is implemented in wifi remote stati...
uint8_t GetNBasicMcs() const
Return the number of basic MCS index.
bool GetHtSupported() const
Return whether the device has HT capability support enabled.
void RecordWaitAssocTxOk(Mac48Address address)
Records that we are waiting for an ACK for the association response we sent.
void SetFragmentationThreshold(uint32_t threshold)
Sets a fragmentation threshold.
Ptr< WifiMac > m_wifiMac
This is a pointer to the WifiMac associated with this WifiRemoteStationManager that is set on call to...
void RecordGotAssocTxOk(Mac48Address address)
Records that we got an ACK for the association response we sent.
bool GetLdpcSupported() const
Return whether the device has LDPC support enabled.
bool GetEhtSupported() const
Return whether the device has EHT capability support enabled.
void AddSupportedMode(Mac48Address address, WifiMode mode)
Invoked in a STA or AP to store the set of modes supported by a destination which is also supported l...
std::optional< double > GetMostRecentRssi(Mac48Address address) const
std::shared_ptr< WifiRemoteStationState > LookupState(Mac48Address address) const
Return the state of the station associated with the given address.
std::array< uint32_t, AC_BE_NQOS > m_ssrc
short retry count per AC
void RecordAssocRefused(Mac48Address address)
Records that association request was refused.
bool IsInPsMode(const Mac48Address &address) const
Return whether the STA is currently in Power Save mode.
void ReportFinalRtsFailed(const WifiMacHeader &header)
Should be invoked after calling ReportRtsFailed if NeedRetransmission returns false.
uint8_t GetNumberOfAntennas() const
StationStates m_states
States of known stations.
bool NeedCtsToSelf(WifiTxVector txVector)
Return if we need to do CTS-to-self before sending a DATA.
WifiTxVector GetCtsTxVector(Mac48Address to, WifiMode rtsTxMode) const
Return a TXVECTOR for the CTS frame given the destination and the mode of the RTS used by the sender.
void SetMaxSsrc(uint32_t maxSsrc)
Sets the maximum STA short retry count (SSRC).
WifiMode GetBasicMcs(uint8_t i) const
Return the MCS at the given list index.
TracedCallback< Mac48Address > m_macTxDataFailed
The trace source fired when the transmission of a single data packet has failed.
uint16_t GetStaId(Mac48Address address, const WifiTxVector &txVector) const
If the given TXVECTOR is used for a MU transmission, return the STAID of the station with the given a...
WifiMode GetBasicMode(uint8_t i) const
Return a basic mode from the set of basic modes.
void AddSupportedPhyPreamble(Mac48Address address, bool isShortPreambleSupported)
Record whether the short PHY preamble is supported by the station.
bool GetShortGuardIntervalSupported() const
Return whether the device has SGI support enabled.
virtual void SetupPhy(const Ptr< WifiPhy > phy)
Set up PHY associated with this device since it is the object that knows the full set of transmit rat...
virtual void DoReportRtsFailed(WifiRemoteStation *station)=0
This method is a pure virtual method that must be implemented by the sub-class.
void RecordDisassociated(Mac48Address address)
Records that the STA was disassociated.
virtual WifiTxVector DoGetRtsTxVector(WifiRemoteStation *station)=0
uint16_t GetChannelWidthSupported(Mac48Address address) const
Return the channel width supported by the station.
uint32_t m_maxSlrc
Maximum STA long retry count (SLRC)
void Reset()
Reset the station, invoked in a STA upon dis-association or in an AP upon reboot.
bool GetUseNonErpProtection() const
Return whether the device supports protection of non-ERP stations.
bool IsAssocRefused(Mac48Address address) const
Return whether we refused an association request from the given station.
virtual void DoReportAmpduTxStatus(WifiRemoteStation *station, uint16_t nSuccessfulMpdus, uint16_t nFailedMpdus, double rxSnr, double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss)
Typically called per A-MPDU, either when a Block ACK was successfully received or when a BlockAckTime...
bool GetVhtSupported() const
Return whether the device has VHT capability support enabled.
ProtectionMode m_erpProtectionMode
Protection mode for ERP stations when non-ERP stations are detected.
WifiModeList m_bssBasicRateSet
This member is the list of WifiMode objects that comprise the BSSBasicRateSet parameter.
virtual void DoReportDataOk(WifiRemoteStation *station, double ackSnr, WifiMode ackMode, double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss)=0
This method is a pure virtual method that must be implemented by the sub-class.
WifiTxVector GetDataTxVector(const WifiMacHeader &header, uint16_t allowedWidth)
void ReportDataOk(Ptr< const WifiMpdu > mpdu, double ackSnr, WifiMode ackMode, double dataSnr, WifiTxVector dataTxVector)
Should be invoked whenever we receive the ACK associated to a data packet we just sent.
void ReportRtsFailed(const WifiMacHeader &header)
Should be invoked whenever the RtsTimeout associated to a transmission attempt expires.
void AddSupportedErpSlotTime(Mac48Address address, bool isShortSlotTimeSupported)
Record whether the short ERP slot time is supported by the station.
bool GetShortPreambleEnabled() const
Return whether the device uses short PHY preambles.
bool GetHeSupported() const
Return whether the device has HE capability support enabled.
WifiMode m_defaultTxMode
The default transmission mode.
virtual void DoReportRxOk(WifiRemoteStation *station, double rxSnr, WifiMode txMode)=0
This method is a pure virtual method that must be implemented by the sub-class.
virtual bool DoNeedRetransmission(WifiRemoteStation *station, Ptr< const Packet > packet, bool normally)
WifiMode GetDefaultMode() const
Return the default transmission mode.
void RecordGotAssocTxFailed(Mac48Address address)
Records that we missed an ACK for the association response we sent.
std::optional< Mac48Address > GetMldAddress(const Mac48Address &address) const
Get the address of the MLD the given station is affiliated with, if any.
virtual void DoReportFinalRtsFailed(WifiRemoteStation *station)=0
This method is a pure virtual method that must be implemented by the sub-class.
virtual void SetupMac(const Ptr< WifiMac > mac)
Set up MAC associated with this device since it is the object that knows the full set of timing param...
WifiTxVector GetRtsTxVector(Mac48Address address)
uint32_t m_rtsCtsThreshold
Threshold for RTS/CTS.
bool m_useNonErpProtection
flag if protection for non-ERP stations against ERP transmissions is enabled
WifiMode GetControlAnswerMode(WifiMode reqMode) const
Get control answer mode function.
bool m_shortSlotTimeEnabled
flag if short slot time is enabled
bool IsWaitAssocTxOk(Mac48Address address) const
Return whether we are waiting for an ACK for the association response we sent.
void SetMaxSlrc(uint32_t maxSlrc)
Sets the maximum STA long retry count (SLRC).
TracedCallback< Mac48Address > m_macTxFinalDataFailed
The trace source fired when the transmission of a data packet has exceeded the maximum number of atte...
bool GetUseNonHtProtection() const
Return whether the device supports protection of non-HT stations.
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
void SetNess(uint8_t ness)
Sets the Ness number.
void SetTxPowerLevel(uint8_t powerlevel)
Sets the selected transmission power level.
void SetLdpc(bool ldpc)
Sets if LDPC FEC coding is being used.
void SetChannelWidth(uint16_t channelWidth)
Sets the selected channelWidth (in MHz)
void SetGuardInterval(uint16_t guardInterval)
Sets the guard interval duration (in nanoseconds)
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.
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.
void SetBssColor(uint8_t color)
Set the BSS color.
void SetNTx(uint8_t nTx)
Sets the number of TX antennas.
uint16_t GetChannelWidth() const
void SetMode(WifiMode mode)
Sets the selected payload transmission mode.
void SetNss(uint8_t nss)
Sets the number of Nss.
void SetPreambleType(WifiPreamble preamble)
Sets the preamble type.
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file,...
#define NS_ASSERT_MSG(condition, message)
At runtime, in debugging builds, if this condition is not true, the program prints the message to out...
Ptr< const AttributeAccessor > MakeEnumAccessor(T1 a1)
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
#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_WARN(msg)
Use NS_LOG to output a message of level LOG_WARN.
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Time Seconds(double value)
Construct a Time in the indicated unit.
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
AcIndex QosUtilsMapTidToAc(uint8_t tid)
Maps TID (Traffic ID) to Access classes.
WifiPreamble
The type of preamble to be used by an IEEE 802.11 transmission.
WifiModulationClass
This enumeration defines the modulation classes per (Table 10-6 "Modulation classes"; IEEE 802....
AcIndex
This enumeration defines the Access Categories as an enumeration with values corresponding to the AC ...
@ WIFI_PHY_BAND_6GHZ
The 6 GHz band.
@ WIFI_PHY_BAND_2_4GHZ
The 2.4 GHz band.
@ WIFI_PHY_BAND_5GHZ
The 5 GHz band.
@ WIFI_MOD_CLASS_OFDM
OFDM (Clause 17)
@ WIFI_MOD_CLASS_HR_DSSS
HR/DSSS (Clause 16)
@ WIFI_MOD_CLASS_HT
HT (Clause 19)
@ WIFI_MOD_CLASS_EHT
EHT (Clause 36)
@ WIFI_MOD_CLASS_VHT
VHT (Clause 22)
@ WIFI_MOD_CLASS_HE
HE (Clause 27)
@ WIFI_MOD_CLASS_DSSS
DSSS (Clause 15)
@ WIFI_MOD_CLASS_ERP_OFDM
ERP-OFDM (18.4)
Every class exported by the ns3 library is enclosed in the ns3 namespace.
static const uint16_t WIFI_MAC_FCS_LENGTH
The length in octets of the IEEE 802.11 MAC FCS field.
bool IsAllowedControlAnswerModulationClass(WifiModulationClass modClassReq, WifiModulationClass modClassAnswer)
Return whether the modulation class of the selected mode for the control answer frame is allowed.
uint16_t ConvertGuardIntervalToNanoSeconds(WifiMode mode, const Ptr< WifiNetDevice > device)
Convert the guard interval to nanoseconds based on the WifiMode.
WifiPreamble GetPreambleForTransmission(WifiModulationClass modulation, bool useShortPreamble)
Return the preamble to be used for the transmission.
std::vector< WifiMode > WifiModeList
In various parts of the code, folk are interested in maintaining a list of transmission modes.
static constexpr uint16_t SU_STA_ID
STA_ID to identify a single user (SU)
Ptr< const AttributeChecker > MakeEnumChecker(int v, std::string n, Ts... args)
Make an EnumChecker pre-configured with a set of allowed values by name.
EhtMcsMapType
The different EHT-MCS map types as defined in 9.4.2.313.4 Supported EHT-MCS And NSS Set field.
RxSignalInfo structure containing info on the received signal.
double snr
SNR in linear scale.
hold per-remote-station state.
WifiRemoteStationState * m_state
Remote station state.
std::pair< double, Time > m_rssiAndUpdateTimePair
RSSI (in dBm) of the most recent packet received from the remote station along with update time.
std::shared_ptr< CommonInfoBasicMle > m_mleCommonInfo
remote station Multi-Link Element Common Info
Mac48Address m_address
Mac48Address of the remote station.
uint16_t m_channelWidth
Channel width (in MHz) supported by the remote station.
uint8_t m_ness
Number of extended spatial streams of the remote station.
bool m_aggregation
Flag if MPDU aggregation is used by the remote station.
bool m_qosSupported
Flag if QoS is supported by the station.
WifiModeList m_operationalRateSet
This member is the list of WifiMode objects that comprise the OperationalRateSet parameter for this r...
WifiModeList m_operationalMcsSet
operational MCS set
uint16_t m_guardInterval
HE Guard interval duration (in nanoseconds) supported by the remote station.
Ptr< const EhtCapabilities > m_ehtCapabilities
remote station EHT capabilities
Ptr< const VhtCapabilities > m_vhtCapabilities
remote station VHT capabilities
WifiRemoteStationInfo m_info
remote station info
bool m_emlsrEnabled
whether EMLSR mode is enabled on this link
Ptr< const HtCapabilities > m_htCapabilities
remote station HT capabilities
Ptr< const HeCapabilities > m_heCapabilities
remote station HE capabilities