31#include "ns3/boolean.h"
32#include "ns3/eht-configuration.h"
34#include "ns3/erp-ofdm-phy.h"
35#include "ns3/he-configuration.h"
36#include "ns3/ht-configuration.h"
37#include "ns3/ht-phy.h"
39#include "ns3/simulator.h"
40#include "ns3/uinteger.h"
41#include "ns3/vht-configuration.h"
54 TypeId(
"ns3::WifiRemoteStationManager")
57 .AddAttribute(
"MaxSsrc",
58 "The maximum number of retransmission attempts for any packet with size "
59 "<= RtsCtsThreshold. "
60 "This value will not have any effect on some rate control algorithms.",
63 MakeUintegerChecker<uint32_t>())
64 .AddAttribute(
"MaxSlrc",
65 "The maximum number of retransmission attempts for any packet with size "
67 "This value will not have any effect on some rate control algorithms.",
70 MakeUintegerChecker<uint32_t>())
71 .AddAttribute(
"RtsCtsThreshold",
72 "If the size of the PSDU is bigger than this value, we use an RTS/CTS "
73 "handshake before sending the data frame."
74 "This value will not have any effect on some rate control algorithms.",
77 MakeUintegerChecker<uint32_t>(0, 4692480))
78 .AddAttribute(
"RtsCtsTxDurationThresh",
79 "If this threshold is a strictly positive value and the TX duration of "
80 "the PSDU is greater than or equal to this threshold, we use an RTS/CTS "
81 "handshake before sending the data frame.",
86 "FragmentationThreshold",
87 "If the size of the PSDU is bigger than this value, we fragment it such that the "
88 "size of the fragments are equal or smaller. "
89 "This value does not apply when it is carried in an A-MPDU. "
90 "This value will not have any effect on some rate control algorithms.",
94 MakeUintegerChecker<uint32_t>())
95 .AddAttribute(
"NonUnicastMode",
96 "Wifi mode used for non-unicast transmissions.",
100 .AddAttribute(
"DefaultTxPowerLevel",
101 "Default power level to be used for transmissions. "
102 "This is the power level that is used by all those WifiManagers that do "
103 "not implement TX power control.",
106 MakeUintegerChecker<uint8_t>())
107 .AddAttribute(
"ErpProtectionMode",
108 "Protection mode used when non-ERP STAs are connected to an ERP AP: "
109 "Rts-Cts or Cts-To-Self",
111 MakeEnumAccessor<WifiRemoteStationManager::ProtectionMode>(
117 .AddAttribute(
"HtProtectionMode",
118 "Protection mode used when non-HT STAs are connected to a HT AP: Rts-Cts "
121 MakeEnumAccessor<WifiRemoteStationManager::ProtectionMode>(
127 .AddTraceSource(
"MacTxRtsFailed",
128 "The transmission of a RTS by the MAC layer has failed",
130 "ns3::Mac48Address::TracedCallback")
131 .AddTraceSource(
"MacTxDataFailed",
132 "The transmission of a data packet by the MAC layer has failed",
134 "ns3::Mac48Address::TracedCallback")
136 "MacTxFinalRtsFailed",
137 "The transmission of a RTS has exceeded the maximum number of attempts",
139 "ns3::Mac48Address::TracedCallback")
141 "MacTxFinalDataFailed",
142 "The transmission of a data packet has exceeded the maximum number of attempts",
144 "ns3::Mac48Address::TracedCallback");
149 : m_useNonErpProtection(false),
150 m_useNonHtProtection(false),
151 m_shortPreambleEnabled(false),
152 m_shortSlotTimeEnabled(false)
285 return htConfiguration->GetLdpcSupported();
295 return htConfiguration->GetShortGuardIntervalSupported();
309 gi =
static_cast<uint16_t
>(heConfiguration->GetGuardInterval().GetNanoSeconds());
322 bool isShortPreambleSupported)
326 LookupState(address)->m_shortPreamble = isShortPreambleSupported;
331 bool isShortSlotTimeSupported)
335 LookupState(address)->m_shortSlotTime = isShortSlotTimeSupported;
344 for (
const auto& i : state->m_operationalRateSet)
354 state->m_dsssSupported =
true;
358 state->m_erpOfdmSupported =
true;
362 state->m_ofdmSupported =
true;
364 state->m_operationalRateSet.push_back(mode);
373 state->m_operationalRateSet.clear();
376 state->m_operationalRateSet.push_back(mode);
377 if (mode.IsMandatory())
392 state->m_operationalMcsSet =
WifiModeList(mcsList.begin(), mcsList.end());
409 for (
const auto& i : state->m_operationalMcsSet)
416 state->m_operationalMcsSet.push_back(mcs);
440 if (address.IsGroup())
450 if (address.IsGroup())
460 if (address.IsGroup())
498 if (address.IsGroup())
515 std::shared_ptr<WifiRemoteStationState> state;
516 if (!remoteAddress.IsGroup() &&
540 if (staMac->IsAssociated())
542 staId = staMac->GetAssociationId();
563std::optional<Mac48Address>
566 if (
auto stateIt =
m_states.find(address);
567 stateIt !=
m_states.end() && stateIt->second->m_mleCommonInfo)
569 return stateIt->second->m_mleCommonInfo->m_mldMacAddress;
575std::optional<Mac48Address>
578 auto stateIt =
m_states.find(mldAddress);
580 if (stateIt ==
m_states.end() || !stateIt->second->m_mleCommonInfo)
586 NS_ASSERT(stateIt->second->m_mleCommonInfo->m_mldMacAddress == mldAddress);
587 return stateIt->second->m_address;
595 if (!header.
IsMgt() && address.IsGroup())
627 uint16_t channelWidth = allowedWidth;
631 rxWidth < channelWidth)
633 channelWidth = rxWidth;
651 txVector.
SetBssColor(heConfiguration->GetBssColor());
658 <<
" MHz) exceeds allowed width (" << allowedWidth
705 if (address.IsGroup())
724 if (allowedWidth >= 40 &&
755 uint16_t ctsTxGuardInterval =
767 auto txMode = txVector.
GetMode();
775 else if (rate >= 12e6)
806 uint16_t ackTxGuardInterval =
825 uint16_t blockAckTxGuardInterval =
892 NS_LOG_DEBUG(
"WifiRemoteStationManager::GetControlAnswerMode returning " << mode);
924 if (thismode.IsMandatory() && (!found || thismode.IsHigherDataRate(mode)) &&
925 (!thismode.IsHigherDataRate(reqMode)) &&
927 thismode.GetModulationClass())))
940 if (thismode.IsMandatory() && (!found || thismode.IsHigherDataRate(mode)) &&
941 (!thismode.IsHigherCodeRate(reqMode)) &&
967 NS_LOG_DEBUG(
"WifiRemoteStationManager::GetControlAnswerMode returning " << mode);
986 NS_ASSERT(!mpdu->GetHeader().GetAddr1().IsGroup());
988 QosUtilsMapTidToAc((mpdu->GetHeader().IsQosData()) ? mpdu->GetHeader().GetQosTid() : 0);
1024 NS_LOG_FUNCTION(
this << *mpdu << ackSnr << ackMode << dataSnr << dataTxVector);
1065 NS_ASSERT(!mpdu->GetHeader().GetAddr1().IsGroup());
1068 QosUtilsMapTidToAc((mpdu->GetHeader().IsQosData()) ? mpdu->GetHeader().GetQosTid() : 0);
1089 if (address.IsGroup())
1100 uint16_t nSuccessfulMpdus,
1101 uint16_t nFailedMpdus,
1106 NS_LOG_FUNCTION(
this << address << nSuccessfulMpdus << nFailedMpdus << rxSnr << dataSnr
1109 for (uint16_t i = 0; i < nFailedMpdus; i++)
1128 if (address.IsGroup())
1139 "WifiRemoteStationManager::NeedRTS returning true to protect non-ERP stations");
1146 NS_LOG_DEBUG(
"WifiRemoteStationManager::NeedRTS returning true to protect non-HT stations");
1171 "WifiRemoteStationManager::NeedCtsToSelf returning true to protect non-ERP stations");
1180 "WifiRemoteStationManager::NeedCtsToSelf returning true to protect non-HT stations");
1191 NS_LOG_DEBUG(
"WifiRemoteStationManager::NeedCtsToSelf returning false");
1203 NS_LOG_DEBUG(
"WifiRemoteStationManager::NeedCtsToSelf returning false");
1208 NS_LOG_DEBUG(
"WifiRemoteStationManager::NeedCtsToSelf returning true");
1244 NS_ASSERT(!mpdu->GetHeader().GetAddr1().IsGroup());
1246 QosUtilsMapTidToAc((mpdu->GetHeader().IsQosData()) ? mpdu->GetHeader().GetQosTid() : 0);
1260 bool normally = retryCount < maxRetryCount;
1261 NS_LOG_DEBUG(
"WifiRemoteStationManager::NeedRetransmission count: "
1262 << retryCount <<
" result: " << std::boolalpha << normally);
1270 if (mpdu->GetHeader().GetAddr1().IsGroup())
1275 NS_LOG_DEBUG(
"WifiRemoteStationManager::NeedFragmentation result: " << std::boolalpha
1284 if (threshold < 256)
1289 NS_LOG_WARN(
"Fragmentation threshold should be larger than 256. Setting to 256.");
1298 if (threshold % 2 != 0)
1300 NS_LOG_WARN(
"Fragmentation threshold should be an even number. Setting to "
1323 (mpdu->GetPacket()->GetSize() /
1327 if ((mpdu->GetPacket()->GetSize() %
1332 NS_LOG_DEBUG(
"WifiRemoteStationManager::GetNFragments returning " << nFragments);
1340 NS_ASSERT(!mpdu->GetHeader().GetAddr1().IsGroup());
1342 if (fragmentNumber >= nFragment)
1344 NS_LOG_DEBUG(
"WifiRemoteStationManager::GetFragmentSize returning 0");
1348 if (fragmentNumber == nFragment - 1)
1351 mpdu->GetPacket()->GetSize() -
1354 NS_LOG_DEBUG(
"WifiRemoteStationManager::GetFragmentSize returning " << lastFragmentSize);
1355 return lastFragmentSize;
1362 NS_LOG_DEBUG(
"WifiRemoteStationManager::GetFragmentSize returning " << fragmentSize);
1363 return fragmentSize;
1371 NS_ASSERT(!mpdu->GetHeader().GetAddr1().IsGroup());
1375 NS_LOG_DEBUG(
"WifiRemoteStationManager::GetFragmentOffset returning " << fragmentOffset);
1376 return fragmentOffset;
1383 NS_ASSERT(!mpdu->GetHeader().GetAddr1().IsGroup());
1385 NS_LOG_DEBUG(
"WifiRemoteStationManager::IsLastFragment returning " << std::boolalpha << isLast);
1401std::optional<double>
1404 auto station =
Lookup(address);
1405 auto rssi = station->m_rssiAndUpdateTimePair.first;
1406 auto ts = station->m_rssiAndUpdateTimePair.second;
1407 if (ts.IsStrictlyPositive())
1411 return std::nullopt;
1414std::shared_ptr<WifiRemoteStationState>
1418 auto stateIt =
m_states.find(address);
1422 NS_LOG_DEBUG(
"WifiRemoteStationManager::LookupState returning existing state");
1423 return stateIt->second;
1426 auto state = std::make_shared<WifiRemoteStationState>();
1428 state->m_address = address;
1432 state->m_dsssSupported =
false;
1433 state->m_erpOfdmSupported =
false;
1434 state->m_ofdmSupported =
false;
1435 state->m_htCapabilities =
nullptr;
1436 state->m_vhtCapabilities =
nullptr;
1437 state->m_heCapabilities =
nullptr;
1438 state->m_ehtCapabilities =
nullptr;
1439 state->m_mleCommonInfo =
nullptr;
1440 state->m_emlsrEnabled =
false;
1444 state->m_aggregation =
false;
1445 state->m_qosSupported =
false;
1446 state->m_isInPsMode =
false;
1448 NS_LOG_DEBUG(
"WifiRemoteStationManager::LookupState returning new state");
1457 NS_ASSERT(address != m_wifiMac->GetAddress());
1458 auto stationIt = m_stations.find(address);
1460 if (stationIt != m_stations.end())
1462 return stationIt->second;
1466 station->
m_state = LookupState(address).get();
1473WifiRemoteStationManager::SetAssociationId(
Mac48Address remoteAddress, uint16_t aid)
1476 LookupState(remoteAddress)->m_aid = aid;
1480WifiRemoteStationManager::SetQosSupport(
Mac48Address from,
bool qosSupported)
1483 LookupState(from)->m_qosSupported = qosSupported;
1487WifiRemoteStationManager::SetEmlsrEnabled(
const Mac48Address& from,
bool emlsrEnabled)
1490 LookupState(from)->m_emlsrEnabled = emlsrEnabled;
1498 auto state = LookupState(from);
1501 state->m_channelWidth = 40;
1505 state->m_channelWidth = 20;
1507 SetQosSupport(from,
true);
1512 AddSupportedMcs(from, mcs);
1515 state->m_htCapabilities = Create<const HtCapabilities>(htCapabilities);
1524 auto state = LookupState(from);
1527 state->m_channelWidth = 160;
1531 state->m_channelWidth = 80;
1533 for (uint8_t i = 1; i <= m_wifiPhy->GetMaxSupportedTxSpatialStreams(); i++)
1539 AddSupportedMcs(from, mcs);
1543 state->m_vhtCapabilities = Create<const VhtCapabilities>(vhtCapabilities);
1551 auto state = LookupState(from);
1557 state->m_channelWidth = 160;
1561 state->m_channelWidth = 80;
1569 state->m_channelWidth = 40;
1573 state->m_channelWidth = 20;
1578 state->m_guardInterval = 800;
1583 state->m_guardInterval = 3200;
1589 AddSupportedMcs(from, mcs);
1592 state->m_heCapabilities = Create<const HeCapabilities>(heCapabilities);
1593 SetQosSupport(from,
true);
1597WifiRemoteStationManager::AddStationHe6GhzCapabilities(
1603 auto state = LookupState(from);
1604 state->m_he6GhzBandCapabilities = Create<const He6GhzBandCapabilities>(he6GhzCapabilities);
1605 SetQosSupport(from,
true);
1614 auto state = LookupState(from);
1617 for (uint8_t mapType = 0; mapType < EhtMcsAndNssSet::EHT_MCS_MAP_TYPE_MAX; ++mapType)
1622 AddSupportedMcs(from, mcs);
1626 state->m_ehtCapabilities = Create<const EhtCapabilities>(ehtCapabilities);
1627 SetQosSupport(from,
true);
1631WifiRemoteStationManager::AddStationMleCommonInfo(
1633 const std::shared_ptr<CommonInfoBasicMle>& mleCommonInfo)
1636 auto state = LookupState(from);
1637 state->m_mleCommonInfo = mleCommonInfo;
1640 {mleCommonInfo->m_mldMacAddress, state});
1643Ptr<const HtCapabilities>
1646 return LookupState(from)->m_htCapabilities;
1652 return LookupState(from)->m_vhtCapabilities;
1658 return LookupState(from)->m_heCapabilities;
1662WifiRemoteStationManager::GetStationHe6GhzCapabilities(
const Mac48Address& from)
const
1664 return LookupState(from)->m_he6GhzBandCapabilities;
1670 return LookupState(from)->m_ehtCapabilities;
1673std::optional<std::reference_wrapper<CommonInfoBasicMle::EmlCapabilities>>
1674WifiRemoteStationManager::GetStationEmlCapabilities(
const Mac48Address& from)
1676 if (
auto state = LookupState(from);
1677 state->m_mleCommonInfo && state->m_mleCommonInfo->m_emlCapabilities)
1679 return state->m_mleCommonInfo->m_emlCapabilities.value();
1681 return std::nullopt;
1684std::optional<std::reference_wrapper<CommonInfoBasicMle::MldCapabilities>>
1685WifiRemoteStationManager::GetStationMldCapabilities(
const Mac48Address& from)
1687 if (
auto state = LookupState(from);
1688 state->m_mleCommonInfo && state->m_mleCommonInfo->m_mldCapabilities)
1690 return state->m_mleCommonInfo->m_mldCapabilities.value();
1692 return std::nullopt;
1701 bool supported =
false;
1704 supported |= htCapabilities->GetLdpc();
1706 if (vhtCapabilities)
1708 supported |= vhtCapabilities->GetRxLdpc();
1712 supported |= heCapabilities->GetLdpcCodingInPayload();
1718WifiRemoteStationManager::GetDefaultMode()
const
1721 auto defaultTxMode = m_wifiPhy->GetDefaultMode();
1723 return defaultTxMode;
1727WifiRemoteStationManager::GetDefaultMcs()
const
1729 return HtPhy::GetHtMcs0();
1737 if ((!m_wifiPhy->GetDevice()->GetHtConfiguration()) ||
1738 (!GetHtSupported(st) && !GetStationHe6GhzCapabilities(st->
m_state->
m_address)))
1740 return GetDefaultMode();
1745 if (GetHeSupported() && GetHeSupported(st))
1749 else if (GetVhtSupported() && GetVhtSupported(st))
1755 return *m_wifiPhy->GetPhyEntity(modClass)->begin();
1759WifiRemoteStationManager::Reset()
1763 for (
auto& state : m_stations)
1765 delete (state.second);
1768 m_bssBasicRateSet.clear();
1769 m_bssBasicMcsSet.clear();
1780 NS_FATAL_ERROR(
"It is not allowed to add a HT rate in the BSSBasicRateSet!");
1782 for (uint8_t i = 0; i < GetNBasicModes(); i++)
1784 if (GetBasicMode(i) == mode)
1789 m_bssBasicRateSet.push_back(mode);
1793WifiRemoteStationManager::GetNBasicModes()
const
1795 return static_cast<uint8_t
>(m_bssBasicRateSet.size());
1799WifiRemoteStationManager::GetBasicMode(uint8_t i)
const
1802 return m_bssBasicRateSet[i];
1806WifiRemoteStationManager::GetNNonErpBasicModes()
const
1809 for (
auto i = m_bssBasicRateSet.begin(); i != m_bssBasicRateSet.end(); i++)
1821WifiRemoteStationManager::GetNonErpBasicMode(uint8_t i)
const
1826 for (
auto j = m_bssBasicRateSet.begin(); j != m_bssBasicRateSet.end();)
1842 return m_bssBasicRateSet[index];
1849 for (uint8_t i = 0; i < GetNBasicMcs(); i++)
1851 if (GetBasicMcs(i) == mcs)
1856 m_bssBasicMcsSet.push_back(mcs);
1860WifiRemoteStationManager::GetNBasicMcs()
const
1862 return static_cast<uint8_t
>(m_bssBasicMcsSet.size());
1866WifiRemoteStationManager::GetBasicMcs(uint8_t i)
const
1869 return m_bssBasicMcsSet[i];
1873WifiRemoteStationManager::GetNonUnicastMode()
const
1875 if (m_nonUnicastMode ==
WifiMode())
1877 if (GetNBasicModes() > 0)
1879 return GetBasicMode(0);
1883 return GetDefaultMode();
1888 return m_nonUnicastMode;
1916 uint16_t nSuccessfulMpdus,
1917 uint16_t nFailedMpdus,
1920 uint16_t dataChannelWidth,
1923 NS_LOG_DEBUG(
"DoReportAmpduTxStatus received but the manager does not handle A-MPDUs!");
1936 NS_ASSERT(i < GetNMcsSupported(station));
1943 NS_ASSERT(i < GetNNonErpSupported(station));
1987 if (!htCapabilities)
1991 return htCapabilities->GetShortGuardInterval20();
2011 if (!htCapabilities)
2015 return heCapabilities->GetHighestNssSupported();
2019 return htCapabilities->GetRxHighestSupportedAntennas();
2029WifiRemoteStationManager::GetPhy()
const
2035WifiRemoteStationManager::GetMac()
const
2080 return mleCommonInfo && mleCommonInfo->m_emlCapabilities &&
2081 mleCommonInfo->m_emlCapabilities->emlsrSupport == 1;
2114WifiRemoteStationManager::GetChannelWidthSupported(
Mac48Address address)
const
2116 return LookupState(address)->m_channelWidth;
2120WifiRemoteStationManager::GetShortGuardIntervalSupported(
Mac48Address address)
const
2124 if (!htCapabilities)
2128 return htCapabilities->GetShortGuardInterval20();
2132WifiRemoteStationManager::GetNumberOfSupportedStreams(
Mac48Address address)
const
2136 if (!htCapabilities)
2140 return htCapabilities->GetRxHighestSupportedAntennas();
2146 return static_cast<uint8_t
>(LookupState(address)->m_operationalMcsSet.size());
2150WifiRemoteStationManager::GetDsssSupported(
const Mac48Address& address)
const
2152 return (LookupState(address)->m_dsssSupported);
2156WifiRemoteStationManager::GetErpOfdmSupported(
const Mac48Address& address)
const
2158 return (LookupState(address)->m_erpOfdmSupported);
2162WifiRemoteStationManager::GetOfdmSupported(
const Mac48Address& address)
const
2164 return (LookupState(address)->m_ofdmSupported);
2170 return bool(LookupState(address)->m_htCapabilities);
2176 return bool(LookupState(address)->m_vhtCapabilities);
2182 return bool(LookupState(address)->m_heCapabilities);
2188 return (
bool)(LookupState(address)->m_ehtCapabilities);
2192WifiRemoteStationManager::GetEmlsrSupported(
const Mac48Address& address)
const
2194 auto mleCommonInfo = LookupState(address)->m_mleCommonInfo;
2195 return mleCommonInfo && mleCommonInfo->m_emlCapabilities &&
2196 mleCommonInfo->m_emlCapabilities->emlsrSupport == 1;
2200WifiRemoteStationManager::GetEmlsrEnabled(
const Mac48Address& address)
const
2202 if (
auto stateIt = m_states.find(address); stateIt != m_states.cend())
2204 return stateIt->second->m_emlsrEnabled;
2210WifiRemoteStationManager::SetDefaultTxPowerLevel(uint8_t txPower)
2212 m_defaultTxPowerLevel = txPower;
2216WifiRemoteStationManager::GetNumberOfAntennas()
const
2218 return m_wifiPhy->GetNumberOfAntennas();
2222WifiRemoteStationManager::GetMaxNumberOfTransmitStreams()
const
2224 return m_wifiPhy->GetMaxSupportedTxSpatialStreams();
2230 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.
static WifiMode GetErpOfdmRate6Mbps()
Return a WifiMode for ERP-OFDM at 6 Mbps.
The HE 6 GHz Band Capabilities (IEEE 802.11ax-2021 9.4.2.263)
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.
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.
Simulation virtual time values and global simulation resolution.
bool IsStrictlyPositive() const
Exactly equivalent to t > 0.
AttributeValue implementation for 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.
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.
Time m_rtsCtsTxDurationThresh
TX duration threshold for RTS/CTS.
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.
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 on the link this manager is associated wi...
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.
WifiTxVector GetRtsTxVector(Mac48Address address, uint16_t allowedWidth)
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 on the link this manager is associated w...
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.
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...
bool NeedRts(const WifiMacHeader &header, const WifiTxParameters &txParams)
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 stores the TX parameters (TX vector, protection mechanism, acknowledgment mechanism,...
std::optional< Time > m_txDuration
TX duration of the frame.
uint32_t GetSize(Mac48Address receiver) const
Get the size in bytes of the (A-)MPDU addressed to the given receiver.
WifiTxVector m_txVector
TXVECTOR of the frame being prepared.
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 AttributeChecker > MakeTimeChecker()
Helper to make an unbounded Time checker.
Ptr< const AttributeAccessor > MakeTimeAccessor(T1 a1)
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
Ptr< const AttributeChecker > MakeWifiModeChecker()
Ptr< const AttributeAccessor > MakeWifiModeAccessor(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.
Ptr< const AttributeChecker > MakeEnumChecker(T v, std::string n, Ts... args)
Make an EnumChecker pre-configured with a set of allowed values by name.
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)
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