15#include "ns3/assert.h"
16#include "ns3/attribute-container.h"
18#include "ns3/mgt-action-headers.h"
19#include "ns3/wifi-mpdu.h"
20#include "ns3/wifi-net-device.h"
21#include "ns3/wifi-phy-state-helper.h"
37 TypeId(
"ns3::EmlsrManager")
40 .AddAttribute(
"EmlsrPaddingDelay",
41 "The EMLSR Paddind Delay (not used by AP MLDs). "
42 "Possible values are 0 us, 32 us, 64 us, 128 us or 256 us.",
46 .AddAttribute(
"EmlsrTransitionDelay",
47 "The EMLSR Transition Delay (not used by AP MLDs). "
48 "Possible values are 0 us, 16 us, 32 us, 64 us, 128 us or 256 us.",
54 "The ID of the main PHY (position in the vector of PHYs held by "
55 "WifiNetDevice). This attribute cannot be set after construction.",
60 .AddAttribute(
"AuxPhyChannelWidth",
61 "The maximum channel width (MHz) supported by Aux PHYs. Note that the "
62 "maximum channel width is capped to the maximum channel width supported "
63 "by the configured maximum modulation class supported.",
69 .AddAttribute(
"AuxPhyMaxModClass",
70 "The maximum modulation class supported by Aux PHYs. Use "
71 "WIFI_MOD_CLASS_OFDM for non-HT.",
90 .AddAttribute(
"AuxPhyTxCapable",
91 "Whether Aux PHYs are capable of transmitting PPDUs.",
96 .AddAttribute(
"InDeviceInterference",
97 "Whether in-device interference is such that a PHY cannot decode "
98 "anything and cannot decrease the backoff counter when another PHY "
99 "of the same device is transmitting.",
104 .AddAttribute(
"PutAuxPhyToSleep",
105 "Whether Aux PHYs should be put into sleep mode while the Main PHY "
106 "is carrying out a (DL or UL) TXOP. Specifically, for DL TXOPs, aux "
107 "PHYs are put to sleep after receiving the ICF; for UL TXOPs, aux PHYs "
108 "are put to sleep when the CTS frame is received, if RTS/CTS is used, "
109 "or when the transmission of the data frame starts, otherwise. "
110 "Aux PHYs are resumed from sleep when the TXOP ends.",
114 .AddAttribute(
"UseNotifiedMacHdr",
115 "Whether to use the information about the MAC header of the MPDU "
116 "being received, if notified by the PHY.",
122 "IDs of the links on which EMLSR mode will be enabled. An empty set "
123 "indicates to disable EMLSR.",
127 .AddAttribute(
"ResetCamState",
128 "Whether to reset the state of the ChannelAccessManager associated with "
129 "the link on which the main PHY has just switched to.",
134 .AddTraceSource(
"MainPhySwitch",
135 "This trace source is fired when the main PHY switches channel to "
136 "operate on another link. Information associated with the main PHY "
137 "switch is provided through a struct that is inherited from struct "
138 "EmlsrMainPhySwitchTrace (use the GetName() method to get the type "
139 "of the provided object).",
141 "ns3::EmlsrManager::MainPhySwitchCallback");
146 : m_mainPhySwitchInfo{},
168 m_staMac->TraceDisconnectWithoutContext(
"DroppedMpdu",
174 status.timer.Cancel();
189 "EmlsrManager can only be installed on non-AP MLDs");
192 m_staMac->TraceConnectWithoutContext(
"DroppedMpdu",
194 m_staMac->TraceConnectWithoutContext(
214 NS_LOG_DEBUG(
"Record that no PHY is operating on link " << +linkId);
229 NS_ASSERT_MSG(duration.IsPositive(),
"Interval duration should not be negative");
231 NS_LOG_DEBUG(
"PHY " << +phy->GetPhyId() <<
" switched to link " << +linkId <<
" after "
233 <<
" since last time a PHY was operating on this link");
292const std::set<uint8_t>&
367std::optional<uint8_t>
376 std::stringstream ss;
379 std::copy(linkIds.cbegin(), linkIds.cend(), std::ostream_iterator<uint16_t>(ss,
" "));
382 NS_ABORT_MSG_IF(linkIds.size() == 1,
"Cannot enable EMLSR mode on a single link");
401 const auto& hdr = mpdu->GetHeader();
418 if (hdr.IsAction() && hdr.GetAddr2() ==
m_staMac->GetBssid(linkId))
423 action.protectedEhtAction ==
444 for (
auto id :
m_staMac->GetLinkIds())
446 if (
id != linkId &&
m_staMac->IsEmlsrLink(
id))
453 auto rxPhy =
m_staMac->GetWifiPhy(linkId);
455 const auto receivedByAuxPhy = (rxPhy != mainPhy);
456 const auto mainPhyOnALink = (
m_staMac->GetLinkForPhy(mainPhy).has_value());
457 const auto mainPhyIsSwitching =
461 const auto mainPhyToConnect = (!mainPhyOnALink && !mainPhyIsSwitching);
465 if (mainPhyToConnect)
471 GetStaMac()->CancelEmlsrPhyConnectEvent(mainPhy->GetPhyId());
478 if (receivedByAuxPhy && (!mainPhyToConnect || mainPhyToConnectToOtherLink))
486 else if (mainPhyToConnect && !mainPhyToConnectToOtherLink)
493 m_staMac->NotifySwitchingEmlsrLink(mainPhy, linkId,
Time{0});
496 if (receivedByAuxPhy)
499 auto uid = rxPhy->GetPreviouslyRxPpduUid();
500 mainPhy->SetPreviouslyRxPpduUid(uid);
515 auto phy =
m_staMac->GetWifiPhy(linkId);
523 return {
false, delay};
529 return {
true,
Time{0}};
541 NS_LOG_DEBUG(
"Aux PHY is not capable of transmitting a PPDU");
542 return {
false,
Time{0}};
553 auto phy =
GetStaMac()->GetWifiPhy(linkId);
555 if (!phy || !
GetStaMac()->IsEmlsrLink(linkId))
557 NS_LOG_DEBUG(
"No PHY (" << phy <<
") or not an EMLSR link (" << +linkId <<
")");
558 return {
false,
Time{0}};
563 NS_LOG_DEBUG(
"Receiving the MAC payload of a PSDU and MAC header info can be used");
566 if (
const auto& hdr = macHdr->get();
568 (hdr.GetAddr1().IsBroadcast() || hdr.GetAddr1() ==
GetEhtFem(linkId)->GetAddress()))
572 NS_LOG_DEBUG(
"Based on MAC header, may be an ICF, postpone by "
573 << phy->GetDelayUntilIdle().As(
Time::US));
574 return {
true, phy->GetDelayUntilIdle()};
577 else if (
auto txVector = phy->GetInfoIfRxingPhyHeader())
584 NS_LOG_DEBUG(
"PHY header of a non-HT PPDU, which may be an ICF, is being received");
588 else if (phy->IsStateRx())
592 auto ongoingRxInfo =
GetEhtFem(linkId)->GetOngoingRxInfo();
603 if (!ongoingRxInfo.has_value())
606 "Main PHY should have MAC header info when in RX state");
610 else if (
const auto& txVector = ongoingRxInfo->get().txVector;
613 if (
auto remTime = phy->GetTimeToMacHdrEnd(
SU_STA_ID);
616 NS_LOG_DEBUG(
"Wait until the expected end of the MAC header reception: "
618 return {
true, *remTime};
622 "MAC header info will not be available. Wait until the end of PSDU reception: "
623 << phy->GetDelayUntilIdle().As(
Time::US));
624 return {
true, phy->GetDelayUntilIdle()};
628 NS_LOG_DEBUG(
"No ICF being received, state: " << phy->GetState()->GetState());
629 return {
false,
Time{0}};
639 NS_LOG_DEBUG(
"EMLSR is not enabled on link " << +linkId);
644 for (
auto id :
m_staMac->GetLinkIds())
646 if (
id != linkId &&
m_staMac->IsEmlsrLink(
id))
668 if (
auto mainPhy =
m_staMac->GetDevice()->GetPhy(
m_mainPhyId); mainPhy->IsStateSwitching())
692 NS_LOG_DEBUG(
"EMLSR is not enabled on link " << +linkId);
701 if (it->second.IsPending())
703 NS_LOG_DEBUG(
"Cancelling main PHY channel switch event on link " << +linkId);
721 if (ulTxopNotStarted)
736 std::set<uint8_t> linkIds;
737 for (
auto id :
m_staMac->GetLinkIds())
739 if ((
id != linkId) &&
m_staMac->IsEmlsrLink(
id))
761 for (
auto id :
m_staMac->GetLinkIds())
763 if (
id != linkId &&
m_staMac->IsEmlsrLink(
id))
781 <<
" on link " << +linkId);
792 NS_LOG_DEBUG(
"Resetting CCA ED threshold of PHY " << phy <<
" to " << threshIt->second
793 <<
" on link " << +linkId);
794 phy->SetCcaEdThreshold(threshIt->second);
806 NS_LOG_FUNCTION(
this << linkId << noSwitchDelay << resetBackoff << requestAccess
807 << traceInfo.GetName());
812 "Main PHY is already operating on link " << +linkId);
815 auto currMainPhyLinkId =
m_staMac->GetLinkForPhy(mainPhy);
816 traceInfo.fromLinkId = currMainPhyLinkId;
817 traceInfo.toLinkId = linkId;
822 NS_LOG_DEBUG(
"Main PHY (" << mainPhy <<
") is about to switch to " << newMainPhyChannel
823 <<
" to operate on link " << +linkId);
827 if (currMainPhyLinkId.has_value())
829 m_staMac->GetChannelAccessManager(*currMainPhyLinkId)
830 ->NotifySwitchingEmlsrLink(mainPhy, newMainPhyChannel, linkId);
835 "We should not ask the main PHY to switch channel while transmitting");
838 auto auxPhy =
GetStaMac()->GetWifiPhy(linkId);
841 const auto delay = mainPhy->GetChannelSwitchDelay();
842 const auto pifs = mainPhy->GetSifs() + mainPhy->GetSlot();
844 "Channel switch delay ("
846 <<
") should be shorter than the maximum between the Transition delay ("
853 mainPhy->SetOperatingChannel(newMainPhyChannel);
857 mainPhy->SetAttribute(
"ChannelSwitchDelay",
TimeValue(delay));
860 if (
m_staMac->GetWifiRemoteStationManager(linkId)->GetShortSlotTimeEnabled())
865 const auto timeToSwitchEnd = noSwitchDelay ?
Seconds(0) : delay;
869 if (!currMainPhyLinkId.has_value())
871 m_staMac->NotifySwitchingEmlsrLink(mainPhy, linkId, timeToSwitchEnd);
874 if (resetBackoff && currMainPhyLinkId.has_value())
877 m_staMac->GetChannelAccessManager(*currMainPhyLinkId)->ResetAllBackoffs();
886 m_staMac->GetQosTxop(acIndex)->StartAccessAfterEvent(
909 NS_LOG_DEBUG(
"Aux PHY (" << auxPhy <<
") is about to switch to " << newAuxPhyChannel
910 <<
" to operate on link " << +nextLinkId);
913 ->GetChannelAccessManager(currLinkId)
914 ->NotifySwitchingEmlsrLink(auxPhy, newAuxPhyChannel, nextLinkId);
916 auxPhy->SetOperatingChannel(newAuxPhyChannel);
918 if (
m_staMac->GetWifiRemoteStationManager(nextLinkId)->GetShortSlotTimeEnabled())
925 for (const auto& [acIndex, ac] : wifiAcList)
927 m_staMac->GetQosTxop(acIndex)->StartAccessAfterEvent(
929 Txop::DIDNT_HAVE_FRAMES_TO_TRANSMIT,
930 Txop::CHECK_MEDIUM_BUSY);
934 SetCcaEdThresholdOnLinkSwitch(auxPhy, nextLinkId);
938EmlsrManager::StartMediumSyncDelayTimer(uint8_t linkId)
942 if (m_mediumSyncDuration.IsZero())
948 auto phy = m_staMac->GetWifiPhy(linkId);
957 const auto [it, inserted] = m_mediumSyncDelayStatus.try_emplace(linkId);
960 it->second.msdNTxopsLeft = m_msdMaxNTxops;
962 if (!it->second.timer.IsPending())
965 << +linkId <<
" to " << +m_msdOfdmEdThreshold <<
" PHY " << phy);
966 m_prevCcaEdThreshold[phy] = phy->GetCcaEdThreshold();
967 phy->SetCcaEdThreshold(m_msdOfdmEdThreshold);
971 it->second.timer.Cancel();
972 NS_LOG_DEBUG(
"Starting MediumSyncDelay timer for " << m_mediumSyncDuration.As(Time::US)
973 <<
" on link " << +linkId);
974 it->second.timer = Simulator::Schedule(m_mediumSyncDuration,
975 &EmlsrManager::MediumSyncDelayTimerExpired,
981EmlsrManager::CancelMediumSyncDelayTimer(uint8_t linkId)
985 auto timerIt = m_mediumSyncDelayStatus.find(linkId);
987 NS_ASSERT(timerIt != m_mediumSyncDelayStatus.cend() && timerIt->second.timer.IsPending());
989 timerIt->second.timer.Cancel();
990 MediumSyncDelayTimerExpired(linkId);
994EmlsrManager::MediumSyncDelayTimerExpired(uint8_t linkId)
998 auto timerIt = m_mediumSyncDelayStatus.find(linkId);
1000 NS_ASSERT(timerIt != m_mediumSyncDelayStatus.cend() && !timerIt->second.timer.IsPending());
1003 auto phy = m_staMac->GetWifiPhy(linkId);
1014 auto threshIt = m_prevCcaEdThreshold.find(phy);
1016 "No value to restore for CCA ED threshold on PHY " << phy);
1017 NS_LOG_DEBUG(
"Resetting CCA ED threshold of PHY " << phy <<
" to " << threshIt->second
1018 <<
" on link " << +linkId);
1019 phy->SetCcaEdThreshold(threshIt->second);
1020 m_prevCcaEdThreshold.erase(threshIt);
1024EmlsrManager::DecrementMediumSyncDelayNTxops(uint8_t linkId)
1028 const auto timerIt = m_mediumSyncDelayStatus.find(linkId);
1030 NS_ASSERT(timerIt != m_mediumSyncDelayStatus.cend() && timerIt->second.timer.IsPending());
1031 NS_ASSERT(timerIt->second.msdNTxopsLeft != 0);
1033 if (timerIt->second.msdNTxopsLeft)
1035 --timerIt->second.msdNTxopsLeft.value();
1040EmlsrManager::ResetMediumSyncDelayNTxops(uint8_t linkId)
1044 auto timerIt = m_mediumSyncDelayStatus.find(linkId);
1046 NS_ASSERT(timerIt != m_mediumSyncDelayStatus.cend() && timerIt->second.timer.IsPending());
1047 timerIt->second.msdNTxopsLeft.reset();
1051EmlsrManager::MediumSyncDelayNTxopsExceeded(uint8_t linkId)
1055 auto timerIt = m_mediumSyncDelayStatus.find(linkId);
1057 NS_ASSERT(timerIt != m_mediumSyncDelayStatus.cend() && timerIt->second.timer.IsPending());
1058 return timerIt->second.msdNTxopsLeft == 0;
1062EmlsrManager::GetExpectedAccessWithinDelay(uint8_t linkId,
const Time& delay)
const
1064 const auto deadline = Simulator::Now() + delay;
1067 if (
auto edca = m_staMac->GetQosTxop(acIndex); edca->HasFramesToTransmit(linkId))
1069 const auto backoffEnd =
1070 m_staMac->GetChannelAccessManager(linkId)->GetBackoffEndFor(edca);
1072 if (backoffEnd <= deadline)
1074 NS_LOG_DEBUG(
"Backoff end for " << acIndex <<
" on link " << +linkId <<
": "
1075 << backoffEnd.As(Time::US));
1084EmlsrManager::GetEmlOmn()
1089 if (m_lastAdvPaddingDelay != m_emlsrPaddingDelay ||
1090 m_lastAdvTransitionDelay != m_emlsrTransitionDelay)
1092 m_lastAdvPaddingDelay = m_emlsrPaddingDelay;
1093 m_lastAdvTransitionDelay = m_emlsrTransitionDelay;
1097 CommonInfoBasicMle::EncodeEmlsrPaddingDelay(m_lastAdvPaddingDelay);
1099 CommonInfoBasicMle::EncodeEmlsrTransitionDelay(m_lastAdvTransitionDelay);
1103 auto setupLinkIds = m_staMac->GetSetupLinkIds();
1105 for (
auto emlsrLinkIt = m_nextEmlsrLinks->begin(); emlsrLinkIt != m_nextEmlsrLinks->end();)
1107 if (
auto setupLinkIt = setupLinkIds.find(*emlsrLinkIt); setupLinkIt != setupLinkIds.cend())
1109 setupLinkIds.erase(setupLinkIt);
1115 NS_LOG_DEBUG(
"Link ID " << +(*emlsrLinkIt) <<
" has not been setup");
1116 emlsrLinkIt = m_nextEmlsrLinks->erase(emlsrLinkIt);
1127EmlsrManager::SendEmlOmn()
1132 "AP did not advertise a Transition Timeout, cannot send EML notification");
1133 NS_ASSERT_MSG(m_nextEmlsrLinks,
"Need to set EMLSR links before calling this method");
1144 auto frame = GetEmlOmn();
1145 auto linkId = GetLinkToSendEmlOmn();
1146 GetEhtFem(linkId)->SendEmlOmn(m_staMac->GetBssid(linkId), frame);
1154 const auto& hdr = mpdu->GetHeader();
1156 if (hdr.IsAssocReq())
1160 mpdu->GetPacket()->PeekHeader(assocReq);
1162 NS_ASSERT_MSG(mle,
"AssocReq should contain a Multi-Link Element");
1163 m_lastAdvPaddingDelay = mle->GetEmlsrPaddingDelay();
1164 m_lastAdvTransitionDelay = mle->GetEmlsrTransitionDelay();
1167 if (hdr.IsMgt() && hdr.IsAction())
1169 if (
auto [category, action] = WifiActionHeader::Peek(mpdu->GetPacket());
1170 category == WifiActionHeader::PROTECTED_EHT &&
1171 action.protectedEhtAction ==
1172 WifiActionHeader::PROTECTED_EHT_EML_OPERATING_MODE_NOTIFICATION)
1176 NS_ASSERT_MSG(m_emlsrTransitionTimeout,
"No transition timeout received from AP");
1177 m_transitionTimeoutEvent = Simulator::Schedule(*m_emlsrTransitionTimeout,
1178 &EmlsrManager::ChangeEmlsrMode,
1189 const auto& hdr = mpdu->GetHeader();
1191 if (hdr.IsMgt() && hdr.IsAction())
1193 auto pkt = mpdu->GetPacket()->Copy();
1194 if (
auto [category, action] = WifiActionHeader::Remove(pkt);
1195 category == WifiActionHeader::PROTECTED_EHT &&
1196 action.protectedEhtAction ==
1197 WifiActionHeader::PROTECTED_EHT_EML_OPERATING_MODE_NOTIFICATION)
1201 auto linkId = ResendNotification(mpdu);
1205 pkt->RemoveHeader(frame);
1206 GetEhtFem(*linkId)->SendEmlOmn(m_staMac->GetBssid(*linkId), frame);
1210 m_nextEmlsrLinks.reset();
1217EmlsrManager::ChangeEmlsrMode()
1228 NS_ASSERT_MSG(m_nextEmlsrLinks,
"No set of EMLSR links stored");
1229 m_emlsrLinks.swap(*m_nextEmlsrLinks);
1230 m_nextEmlsrLinks.reset();
1234 m_staMac->NotifyEmlsrModeChanged(m_emlsrLinks);
1236 ApplyMaxChannelWidthAndModClassOnAuxPhys();
1238 NotifyEmlsrModeChanged();
1242EmlsrManager::ApplyMaxChannelWidthAndModClassOnAuxPhys()
1245 auto currMainPhyLinkId = m_staMac->GetLinkForPhy(m_mainPhyId);
1248 for (
const auto linkId : m_staMac->GetLinkIds())
1250 auto auxPhy = m_staMac->GetWifiPhy(linkId);
1251 auto channel = GetChannelForAuxPhy(linkId);
1253 if (linkId == currMainPhyLinkId || !m_staMac->IsEmlsrLink(linkId) ||
1254 auxPhy->GetOperatingChannel() == channel)
1259 auxPhy->SetMaxModulationClassSupported(m_auxPhyMaxModClass);
1261 NS_LOG_DEBUG(
"Aux PHY (" << auxPhy <<
") is about to switch to " << channel
1262 <<
" to operate on link " << +linkId);
1268 auto cam = m_staMac->GetChannelAccessManager(linkId);
1269 cam->NotifySwitchingEmlsrLink(auxPhy, channel, linkId);
1272 const auto delay = auxPhy->GetChannelSwitchDelay();
1273 auxPhy->SetAttribute(
"ChannelSwitchDelay",
TimeValue(
Time{0}));
1274 auxPhy->SetOperatingChannel(channel);
1275 auxPhy->SetAttribute(
"ChannelSwitchDelay",
TimeValue(delay));
1282 cam->ResetAllBackoffs();
1285 m_staMac->GetQosTxop(acIndex)->StartAccessAfterEvent(
1287 Txop::DIDNT_HAVE_FRAMES_TO_TRANSMIT,
1288 Txop::CHECK_MEDIUM_BUSY);
1294EmlsrManager::ComputeOperatingChannels()
1298 m_mainPhyChannels.clear();
1299 m_auxPhyChannels.clear();
1301 auto linkIds = m_staMac->GetSetupLinkIds();
1303 for (
auto linkId : linkIds)
1305 const auto& channel = m_staMac->GetWifiPhy(linkId)->GetOperatingChannel();
1306 m_mainPhyChannels.emplace(linkId, channel);
1308 auto mainPhyChWidth = channel.GetWidth();
1309 auto auxPhyMaxWidth =
1311 if (auxPhyMaxWidth >= mainPhyChWidth)
1314 m_auxPhyChannels.emplace(linkId, channel);
1318 auto freq = channel.GetPrimaryChannelCenterFrequency(auxPhyMaxWidth);
1319 auto chIt = WifiPhyOperatingChannel::FindFirst(0,
1323 channel.GetPhyBand());
1324 NS_ASSERT_MSG(chIt != WifiPhyOperatingChannel::m_frequencyChannels.end(),
1325 "Primary" << auxPhyMaxWidth <<
" channel not found");
1326 m_auxPhyChannels.emplace(linkId, chIt);
1328 auto p20Index = channel.GetPrimaryChannelIndex(
MHz_u{20});
1329 while (mainPhyChWidth > auxPhyMaxWidth)
1331 mainPhyChWidth /= 2;
1334 m_auxPhyChannels[linkId].SetPrimary20Index(p20Index);
1339EmlsrManager::GetChannelForMainPhy(uint8_t linkId)
const
1341 auto it = m_mainPhyChannels.find(linkId);
1343 "Channel for main PHY on link ID " << +linkId <<
" not found");
1348EmlsrManager::GetChannelForAuxPhy(uint8_t linkId)
const
1350 auto it = m_auxPhyChannels.find(linkId);
1352 "Channel for aux PHY on link ID " << +linkId <<
" not found");
1357EmlsrManager::CancelAllSleepEvents()
1361 for (
auto& [
id, event] : m_auxPhyToSleepEvents)
1365 m_auxPhyToSleepEvents.clear();
1369EmlsrManager::SetSleepStateForAllAuxPhys(
bool sleep)
1373 CancelAllSleepEvents();
1375 for (
const auto& phy : m_staMac->GetDevice()->GetPhys())
1377 if (phy->GetPhyId() == m_mainPhyId)
1382 auto linkId = m_staMac->GetLinkForPhy(phy);
1384 if (linkId.has_value() && !m_staMac->IsEmlsrLink(*linkId))
1391 if (!phy->IsStateSleep())
1396 NS_LOG_DEBUG(
"PHY " << +phy->GetPhyId() <<
": Resuming from sleep");
1397 phy->ResumeFromSleep();
1400 if (linkId.has_value())
1402 auto it = m_startSleep.find(phy->GetPhyId());
1404 "No start sleep info for PHY ID " << phy->GetPhyId());
1405 const auto sleepDuration = Simulator::Now() - it->second;
1406 m_startSleep.erase(it);
1408 if (sleepDuration >
MicroSeconds(MEDIUM_SYNC_THRESHOLD_USEC))
1410 StartMediumSyncDelayTimer(*linkId);
1417 if (phy->IsStateSleep())
1427 std::stringstream ss;
1428 auto s = std::string(
"PHY ") + std::to_string(phy->GetPhyId()) +
": Setting sleep mode";
1429 if (phy->IsStateTx() || phy->IsStateSwitching())
1431 const auto delay = phy->GetDelayUntilIdle();
1433 m_auxPhyToSleepEvents[phy->GetPhyId()] = Simulator::Schedule(delay, [=,
this]() {
1434 phy->SetSleepMode(
true);
1435 m_startSleep[phy->GetPhyId()] = Simulator::Now();
1441 phy->SetSleepMode(
true);
1442 m_startSleep[phy->GetPhyId()] = Simulator::Now();
A container for one type of attribute.
void SendEmlOmn()
Send an EML Operating Mode Notification frame.
Time GetMediumSyncDuration() const
void ComputeOperatingChannels()
Compute the operating channels that the main PHY and the aux PHY(s) must switch to in order to operat...
void NotifyProtectionCompleted(uint8_t linkId)
Notify that protection (if required) is completed and data frame exchange can start on the given link...
void SetTransitionTimeout(Time timeout)
Set the Transition Timeout advertised by the associated AP with EMLSR activated.
bool m_useNotifiedMacHdr
whether to use the information about the MAC header of the MPDU being received (if notified by the PH...
static constexpr uint16_t MEDIUM_SYNC_THRESHOLD_USEC
The aMediumSyncThreshold defined by Sec. 35.3.16.18.1 of 802.11be D4.0.
bool m_auxPhyTxCapable
whether Aux PHYs are capable of transmitting PPDUs
std::optional< Time > GetTransitionTimeout() const
std::pair< bool, Time > GetDelayUntilAccessRequest(uint8_t linkId, AcIndex aci)
Notify that an UL TXOP is gained on the given link by the given AC.
virtual std::pair< bool, Time > DoGetDelayUntilAccessRequest(uint8_t linkId)=0
Subclasses have to provide an implementation for this method, that is called by the base class when t...
Ptr< EhtFrameExchangeManager > GetEhtFem(uint8_t linkId) const
void TxDropped(WifiMacDropReason reason, Ptr< const WifiMpdu > mpdu)
Notify that the given MPDU has been discarded for the given reason.
void NotifyUlTxopStart(uint8_t linkId)
Notify the start of an UL TXOP on the given link.
void TxOk(Ptr< const WifiMpdu > mpdu)
Notify the acknowledgment of the given MPDU.
void NotifyTxopEnd(uint8_t linkId, bool ulTxopNotStarted=false, bool ongoingDlTxop=false)
Notify the end of a TXOP on the given link.
std::map< uint8_t, EventId > m_ulMainPhySwitch
link ID-indexed map of timers started when an aux PHY gains an UL TXOP and schedules a channel switch...
bool m_inDeviceInterference
whether in-device interference is such that a PHY cannot decode anything and cannot decrease the back...
bool GetCamStateReset() const
void SetEmlsrLinks(const std::set< uint8_t > &linkIds)
Take actions to enable EMLSR mode on the given set of links, if non-empty, or disable EMLSR mode,...
void SetMediumSyncOfdmEdThreshold(int8_t threshold)
Set the Medium Synchronization OFDM ED threshold (dBm) to use while the MediumSyncDelay timer is runn...
uint8_t m_mainPhyId
ID of main PHY (position in the vector of PHYs held by WifiNetDevice)
int8_t GetMediumSyncOfdmEdThreshold() const
void NotifyIcfReceived(uint8_t linkId)
Notify the reception of an initial Control frame on the given link.
std::map< uint8_t, MediumSyncDelayStatus > m_mediumSyncDelayStatus
the status of MediumSyncDelay timers (link ID-indexed)
bool m_auxPhyToSleep
whether Aux PHYs should be put into sleep mode while the Main PHY is carrying out a (DL or UL) TXOP
virtual std::pair< bool, Time > GetDelayUnlessMainPhyTakesOverUlTxop(uint8_t linkId)=0
Subclasses have to provide an implementation for this method, that is called by the base class when t...
virtual void SwitchMainPhyIfTxopGainedByAuxPhy(uint8_t linkId, AcIndex aci)=0
Subclasses have to provide an implementation for this method, that is called by the base class when t...
void NotifyMgtFrameReceived(Ptr< const WifiMpdu > mpdu, uint8_t linkId)
Notify the reception of a management frame addressed to us.
virtual void DoNotifyUlTxopStart(uint8_t linkId)=0
Notify the subclass of the start of an UL TXOP on the given link.
Ptr< StaWifiMac > m_staMac
the MAC of the managed non-AP MLD
virtual void DoNotifyMgtFrameReceived(Ptr< const WifiMpdu > mpdu, uint8_t linkId)=0
Notify the subclass of the reception of a management frame addressed to us.
Time m_emlsrPaddingDelay
EMLSR Padding delay.
bool GetInDeviceInterference() const
virtual void NotifyMainPhySwitch(std::optional< uint8_t > currLinkId, uint8_t nextLinkId, Ptr< WifiPhy > auxPhy, Time duration)=0
Notify subclass that the main PHY is switching channel to operate on another link.
MHz_u m_auxPhyMaxWidth
max channel width supported by aux PHYs
virtual void NotifyInDeviceInterferenceStart(uint8_t linkId, Time duration)
Notify that an STA affiliated with the EMLSR client is causing in-device interference for the given a...
void SetMediumSyncMaxNTxops(std::optional< uint8_t > nTxops)
Set the maximum number of TXOPs a non-AP STA is allowed to attempt to initiate while the MediumSyncDe...
Time m_emlsrTransitionDelay
EMLSR Transition delay.
void SetWifiMac(Ptr< StaWifiMac > mac)
Set the wifi MAC.
bool GetAuxPhyTxCapable() const
const std::set< uint8_t > & GetEmlsrLinks() const
MainPhySwitchTracedCallback m_mainPhySwitchTrace
main PHY switch trace source
virtual void EmlsrLinkSwitchCallback(uint8_t linkId, Ptr< WifiPhy > phy)
Callback connected to the EmlsrLinkSwitch trace source of StaWifiMac.
Time m_mediumSyncDuration
duration of the MediumSyncDelay timer
std::optional< Time > m_emlsrTransitionTimeout
Transition timeout advertised by APs with EMLSR activated.
void SwitchAuxPhy(Ptr< WifiPhy > auxPhy, uint8_t currLinkId, uint8_t nextLinkId)
Switch channel on the Aux PHY operating on the given current link so that it operates on the given ne...
std::map< Ptr< WifiPhy >, dBm_u > m_prevCcaEdThreshold
the CCA sensitivity threshold to restore once the MediumSyncDelay timer expires or the PHY moves to a...
std::optional< Time > GetElapsedMediumSyncDelayTimer(uint8_t linkId) const
Check whether the MediumSyncDelay timer is running for the STA operating on the given link.
virtual void DoNotifyTxopEnd(uint8_t linkId)=0
Notify the subclass of the end of a TXOP on the given link.
virtual void DoSetWifiMac(Ptr< StaWifiMac > mac)
Allow subclasses to take actions when the MAC is set.
std::map< uint8_t, Time > m_noPhySince
link ID-indexed map of the time since no PHY is operating on the link
void SetAuxPhyTxCapable(bool capable)
Set the member variable indicating whether Aux PHYs are capable of transmitting PPDUs.
std::optional< std::set< uint8_t > > m_nextEmlsrLinks
ID of the links that will become the EMLSR links when the pending notification frame is acknowledged.
void SetCcaEdThresholdOnLinkSwitch(Ptr< WifiPhy > phy, uint8_t linkId)
Set the CCA ED threshold (if needed) on the given PHY that is switching channel to operate on the giv...
void SetMainPhyId(uint8_t mainPhyId)
Set the ID of main PHY (position in the vector of PHYs held by WifiNetDevice).
const WifiPhyOperatingChannel & GetChannelForMainPhy(uint8_t linkId) const
void SetMediumSyncDuration(Time duration)
Set the duration of the MediumSyncDelay timer.
void SwitchMainPhy(uint8_t linkId, bool noSwitchDelay, bool resetBackoff, bool requestAccess, EmlsrMainPhySwitchTrace &&traceInfo)
Switch channel on the Main PHY so that it operates on the given link.
static constexpr bool RESET_BACKOFF
reset backoff on main PHY switch
Time m_lastAdvTransitionDelay
last advertised transition delay
MainPhySwitchInfo m_mainPhySwitchInfo
main PHY switch info
static constexpr bool DONT_REQUEST_ACCESS
do not request channel access when PHY switch ends
void DoDispose() override
Destructor implementation.
void StartMediumSyncDelayTimer(uint8_t linkId)
Start the MediumSyncDelay timer and take the appropriate actions.
int8_t m_msdOfdmEdThreshold
MediumSyncDelay OFDM ED threshold.
std::optional< uint8_t > m_msdMaxNTxops
MediumSyncDelay max number of TXOPs.
Ptr< StaWifiMac > GetStaMac() const
WifiModulationClass m_auxPhyMaxModClass
max modulation class supported by aux PHYs
uint8_t GetMainPhyId() const
std::optional< uint8_t > GetMediumSyncMaxNTxops() const
void SetCamStateReset(bool enable)
Set the member variable indicating whether the state of the CAM should be reset when the main PHY swi...
virtual void NotifyRtsSent(uint8_t linkId, Ptr< const WifiPsdu > rts, const WifiTxVector &txVector)
Notify that RTS transmission is starting on the given link.
EventId m_transitionTimeoutEvent
Timer started after the successful transmission of an EML Operating Mode Notification frame.
virtual void DoNotifyIcfReceived(uint8_t linkId)=0
Notify the subclass of the reception of an initial Control frame on the given link.
void SetInDeviceInterference(bool enable)
Set the member variable indicating whether in-device interference is such that a PHY cannot decode an...
const WifiPhyOperatingChannel & GetChannelForAuxPhy(uint8_t linkId) const
bool m_resetCamState
whether to reset the state of CAM when main PHY switches channel
static TypeId GetTypeId()
Get the type ID.
std::pair< bool, Time > CheckPossiblyReceivingIcf(uint8_t linkId) const
Check whether a PPDU that may be an ICF is being received on the given link.
std::set< uint8_t > m_emlsrLinks
ID of the EMLSR links (empty if EMLSR mode is disabled)
void SetSleepStateForAllAuxPhys(bool sleep)
Set sleep state or awake state for all aux PHYs.
Hold variables of type enum.
void Cancel()
This method is syntactic sugar for the ns3::Simulator::Cancel method.
bool IsPending() const
This method is syntactic sugar for !IsExpired().
EventImpl * PeekEventImpl() const
void Invoke()
Called by the simulation engine to notify the event that it is time to execute.
Implement the header for Action frames of type EML Operating Mode Notification.
void SetLinkIdInBitmap(uint8_t linkId)
Set the bit position in the link bitmap corresponding to the given link.
EmlControl m_emlControl
EML Control field.
std::optional< EmlsrParamUpdate > m_emlsrParamUpdate
EMLSR Parameter Update field.
A base class which provides memory management and object aggregation.
virtual void DoDispose()
Destructor implementation.
bool IsInitialized() const
Check if the object has been initialized.
Smart pointer class similar to boost::intrusive_ptr.
static EventId Schedule(const Time &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
static Time Now()
Return the current simulation virtual time.
static Time GetDelayLeft(const EventId &id)
Get the remaining time until this event will execute.
Simulation virtual time values and global simulation resolution.
TimeWithUnit As(const Unit unit=Time::AUTO) const
Attach a unit to a Time, to facilitate output in a specific unit.
static constexpr bool DIDNT_HAVE_FRAMES_TO_TRANSMIT
no packet available for transmission was in the queue
static constexpr bool CHECK_MEDIUM_BUSY
generation of backoff (also) depends on the busy/idle state of the medium
a unique identifier for an interface.
@ ATTR_GET
The attribute can be read.
@ ATTR_CONSTRUCT
The attribute can be written at construction-time.
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Hold an unsigned integer type.
Class that keeps track of all information about the current PHY operating channel.
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
#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< AttributeChecker > MakeAttributeContainerChecker()
Make uninitialized AttributeContainerChecker using explicit types.
Ptr< const AttributeAccessor > MakeAttributeContainerAccessor(T1 a1)
Make AttributeContainerAccessor using explicit types.
#define NS_ABORT_MSG_IF(cond, msg)
Abnormal program termination if a condition is true, with a message.
#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_NOARGS()
Output the name of the function.
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Time MicroSeconds(uint64_t value)
Construct a Time in the indicated unit.
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.
WifiMacDropReason
The reason why an MPDU was dropped.
AcIndex
This enumeration defines the Access Categories as an enumeration with values corresponding to the AC ...
@ WIFI_STANDARD_UNSPECIFIED
@ 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_ERP_OFDM
ERP-OFDM (18.4)
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Ptr< const AttributeChecker > MakeBooleanChecker()
Ptr< const AttributeChecker > MakeUintegerChecker()
static constexpr uint8_t DEFAULT_MSD_MAX_N_TXOPS
default MediumSyncDelay max number of TXOP attempts
@ SWITCHING
The PHY layer is switching to other channel.
Ptr< const AttributeAccessor > MakeTimeAccessor(T1 a1)
Callback< R, Args... > MakeCallback(R(T::*memPtr)(Args...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
Ptr< const AttributeChecker > MakeEnumChecker(T v, std::string n, Ts... args)
Make an EnumChecker pre-configured with a set of allowed values by name.
MHz_u GetMaximumChannelWidth(WifiModulationClass modulation)
Get the maximum channel width allowed for the given modulation class.
const std::map< AcIndex, WifiAc > wifiAcList
Map containing the four ACs in increasing order of priority (according to Table 10-1 "UP-to-AC Mappin...
static constexpr int8_t DEFAULT_MSD_OFDM_ED_THRESH
default MediumSyncDelay timer OFDM ED threshold
@ LOG_FUNCTION
Function tracing for non-trivial function calls.
Ptr< T1 > StaticCast(const Ptr< T2 > &p)
Cast a Ptr.
Ptr< const AttributeAccessor > MakeBooleanAccessor(T1 a1)
static constexpr uint16_t SU_STA_ID
STA_ID to identify a single user (SU)
const Time EMLSR_RX_PHY_START_DELAY
aRxPHYStartDelay value to use when waiting for a new frame in the context of EMLSR operations (Sec.
static constexpr uint16_t DEFAULT_MSD_DURATION_USEC
default MediumSyncDelay timer duration (max PPDU TX time rounded to a multiple of 32 us)
Ptr< const AttributeAccessor > MakeEnumAccessor(T1 a1)
Ptr< const AttributeChecker > MakeTimeChecker()
Helper to make an unbounded Time checker.
Struct to trace that main PHY switched to start a DL TXOP after that an aux PHY received an ICF.
Base struct for EMLSR Main PHY switch traces.
Time end
end of channel switching
uint8_t from
ID of the link which the main PHY is/has been leaving.
uint8_t to
ID of the link which the main PHY is moving to.
uint8_t emlsrMode
EMLSR Mode.
uint8_t emlsrParamUpdateCtrl
EMLSR Parameter Update Control.
EMLSR Parameter Update field.