emlsr-manager.cc

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Universita' degli Studi di Napoli Federico II
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Author: Stefano Avallone <stavallo@unina.it>
 */
 
#include "emlsr-manager.h"
 
#include "eht-configuration.h"
#include "eht-frame-exchange-manager.h"
 
#include "ns3/abort.h"
#include "ns3/assert.h"
#include "ns3/attribute-container.h"
#include "ns3/log.h"
#include "ns3/mgt-action-headers.h"
#include "ns3/wifi-mpdu.h"
#include "ns3/wifi-net-device.h"
#include "ns3/wifi-phy-state-helper.h"
 
#include <iterator>
#include <sstream>
 
namespace ns3
{
 
NS_LOG_COMPONENT_DEFINE("EmlsrManager");
 
NS_OBJECT_ENSURE_REGISTERED(EmlsrManager);
 
TypeId
EmlsrManager::GetTypeId()
{
    static TypeId tid =
        TypeId("ns3::EmlsrManager")
            .SetParent<Object>()
            .SetGroupName("Wifi")
            .AddAttribute("EmlsrPaddingDelay",
                          "The EMLSR Paddind Delay (not used by AP MLDs). "
                          "Possible values are 0 us, 32 us, 64 us, 128 us or 256 us.",
                          TimeValue(MicroSeconds(0)),
                          MakeTimeAccessor(&EmlsrManager::m_emlsrPaddingDelay),
                          MakeTimeChecker(MicroSeconds(0), MicroSeconds(256)))
            .AddAttribute("EmlsrTransitionDelay",
                          "The EMLSR Transition Delay (not used by AP MLDs). "
                          "Possible values are 0 us, 16 us, 32 us, 64 us, 128 us or 256 us.",
                          TimeValue(MicroSeconds(0)),
                          MakeTimeAccessor(&EmlsrManager::m_emlsrTransitionDelay),
                          MakeTimeChecker(MicroSeconds(0), MicroSeconds(256)))
            .AddAttribute(
                "MainPhyId",
                "The ID of the main PHY (position in the vector of PHYs held by "
                "WifiNetDevice). This attribute cannot be set after construction.",
                TypeId::ATTR_GET | TypeId::ATTR_CONSTRUCT, // prevent setting after construction
                UintegerValue(0),
                MakeUintegerAccessor(&EmlsrManager::SetMainPhyId, &EmlsrManager::GetMainPhyId),
                MakeUintegerChecker<uint8_t>())
            .AddAttribute("AuxPhyChannelWidth",
                          "The maximum channel width (MHz) supported by Aux PHYs.",
                          TypeId::ATTR_GET |
                              TypeId::ATTR_CONSTRUCT, // prevent setting after construction
                          UintegerValue(20),
                          MakeUintegerAccessor(&EmlsrManager::m_auxPhyMaxWidth),
                          MakeUintegerChecker<MHz_u>(20, 160))
            .AddAttribute("AuxPhyMaxModClass",
                          "The maximum modulation class supported by Aux PHYs. Use "
                          "WIFI_MOD_CLASS_OFDM for non-HT.",
                          TypeId::ATTR_GET |
                              TypeId::ATTR_CONSTRUCT, // prevent setting after construction
                          EnumValue(WIFI_MOD_CLASS_OFDM),
                          MakeEnumAccessor<WifiModulationClass>(&EmlsrManager::m_auxPhyMaxModClass),
                          MakeEnumChecker(WIFI_MOD_CLASS_HR_DSSS,
                                          "HR-DSSS",
                                          WIFI_MOD_CLASS_ERP_OFDM,
                                          "ERP-OFDM",
                                          WIFI_MOD_CLASS_OFDM,
                                          "OFDM",
                                          WIFI_MOD_CLASS_HT,
                                          "HT",
                                          WIFI_MOD_CLASS_VHT,
                                          "VHT",
                                          WIFI_MOD_CLASS_HE,
                                          "HE",
                                          WIFI_MOD_CLASS_EHT,
                                          "EHT"))
            .AddAttribute("AuxPhyTxCapable",
                          "Whether Aux PHYs are capable of transmitting PPDUs.",
                          BooleanValue(true),
                          MakeBooleanAccessor(&EmlsrManager::SetAuxPhyTxCapable,
                                              &EmlsrManager::GetAuxPhyTxCapable),
                          MakeBooleanChecker())
            .AddAttribute("InDeviceInterference",
                          "Whether in-device interference is such that a PHY cannot decode "
                          "anything and cannot decrease the backoff counter when another PHY "
                          "of the same device is transmitting.",
                          BooleanValue(false),
                          MakeBooleanAccessor(&EmlsrManager::SetInDeviceInterference,
                                              &EmlsrManager::GetInDeviceInterference),
                          MakeBooleanChecker())
            .AddAttribute("PutAuxPhyToSleep",
                          "Whether Aux PHYs should be put into sleep mode while the Main PHY "
                          "is carrying out a (DL or UL) TXOP. Specifically, for DL TXOPs, aux "
                          "PHYs are put to sleep after receiving the ICF; for UL TXOPs, aux PHYs "
                          "are put to sleep when the CTS frame is received, if RTS/CTS is used, "
                          "or when the transmission of the data frame starts, otherwise. "
                          "Aux PHYs are resumed from sleep when the TXOP ends.",
                          BooleanValue(false),
                          MakeBooleanAccessor(&EmlsrManager::m_auxPhyToSleep),
                          MakeBooleanChecker())
            .AddAttribute("UseNotifiedMacHdr",
                          "Whether to use the information about the MAC header of the MPDU "
                          "being received, if notified by the PHY.",
                          BooleanValue(true),
                          MakeBooleanAccessor(&EmlsrManager::m_useNotifiedMacHdr),
                          MakeBooleanChecker())
            .AddAttribute(
                "EmlsrLinkSet",
                "IDs of the links on which EMLSR mode will be enabled. An empty set "
                "indicates to disable EMLSR.",
                AttributeContainerValue<UintegerValue>(),
                MakeAttributeContainerAccessor<UintegerValue>(&EmlsrManager::SetEmlsrLinks),
                MakeAttributeContainerChecker<UintegerValue>(MakeUintegerChecker<uint8_t>()))
            .AddAttribute("ResetCamState",
                          "Whether to reset the state of the ChannelAccessManager associated with "
                          "the link on which the main PHY has just switched to.",
                          BooleanValue(false),
                          MakeBooleanAccessor(&EmlsrManager::SetCamStateReset,
                                              &EmlsrManager::GetCamStateReset),
                          MakeBooleanChecker())
            .AddTraceSource("MainPhySwitch",
                            "This trace source is fired when the main PHY switches channel to "
                            "operate on another link. Information associated with the main PHY "
                            "switch is provided through a struct that is inherited from struct "
                            "EmlsrMainPhySwitchTrace (use the GetName() method to get the type "
                            "of the provided object).",
                            MakeTraceSourceAccessor(&EmlsrManager::m_mainPhySwitchTrace),
                            "ns3::EmlsrManager::MainPhySwitchCallback");
    return tid;
}
 
EmlsrManager::EmlsrManager()
    : m_mainPhySwitchInfo{},
      // The STA initializes dot11MSDTimerDuration to aPPDUMaxTime defined in Table 36-70
      // (Sec. 35.3.16.8.1 of 802.11be D3.1)
      m_mediumSyncDuration(MicroSeconds(DEFAULT_MSD_DURATION_USEC)),
      // The default value of dot11MSDOFDMEDthreshold is –72 dBm and the default value of
      // dot11MSDTXOPMax is 1, respectively (Sec. 35.3.16.8.1 of 802.11be D3.1)
      m_msdOfdmEdThreshold(DEFAULT_MSD_OFDM_ED_THRESH),
      m_msdMaxNTxops(DEFAULT_MSD_MAX_N_TXOPS)
{
    NS_LOG_FUNCTION(this);
}
 
EmlsrManager::~EmlsrManager()
{
    NS_LOG_FUNCTION_NOARGS();
}
 
void
EmlsrManager::DoDispose()
{
    NS_LOG_FUNCTION(this);
    m_staMac->TraceDisconnectWithoutContext("AckedMpdu", MakeCallback(&EmlsrManager::TxOk, this));
    m_staMac->TraceDisconnectWithoutContext("DroppedMpdu",
                                            MakeCallback(&EmlsrManager::TxDropped, this));
    m_staMac = nullptr;
    m_transitionTimeoutEvent.Cancel();
    for (auto& [id, status] : m_mediumSyncDelayStatus)
    {
        status.timer.Cancel();
    }
    Object::DoDispose();
}
 
void
EmlsrManager::SetWifiMac(Ptr<StaWifiMac> mac)
{
    NS_LOG_FUNCTION(this << mac);
    NS_ASSERT(mac);
    m_staMac = mac;
 
    NS_ABORT_MSG_IF(!m_staMac->GetEhtConfiguration(), "EmlsrManager requires EHT support");
    NS_ABORT_MSG_IF(!m_staMac->GetEhtConfiguration()->m_emlsrActivated,
                    "EmlsrManager requires EMLSR to be activated");
    NS_ABORT_MSG_IF(m_staMac->GetTypeOfStation() != STA,
                    "EmlsrManager can only be installed on non-AP MLDs");
    NS_ABORT_MSG_IF(m_mainPhyId >= m_staMac->GetDevice()->GetNPhys(),
                    "Main PHY ID (" << +m_mainPhyId << ") invalid given the number of PHY objects ("
                                    << +m_staMac->GetDevice()->GetNPhys() << ")");
 
    m_staMac->TraceConnectWithoutContext("AckedMpdu", MakeCallback(&EmlsrManager::TxOk, this));
    m_staMac->TraceConnectWithoutContext("DroppedMpdu",
                                         MakeCallback(&EmlsrManager::TxDropped, this));
    m_staMac->TraceConnectWithoutContext(
        "EmlsrLinkSwitch",
        MakeCallback(&EmlsrManager::EmlsrLinkSwitchCallback, this));
    DoSetWifiMac(mac);
}
 
void
EmlsrManager::DoSetWifiMac(Ptr<StaWifiMac> mac)
{
    NS_LOG_FUNCTION(this << mac);
}
 
void
EmlsrManager::EmlsrLinkSwitchCallback(uint8_t linkId, Ptr<WifiPhy> phy, bool connected)
{
    NS_LOG_FUNCTION(this << linkId << phy << connected);
 
    // TODO the ScheduleNow calls in this function can be removed once we get rid of the
    // instantaneous main PHY switch at the end of ICF reception
 
    if (!connected)
    {
        NS_ASSERT_MSG(phy->GetPhyId() == m_mainPhyId,
                      "Main PHY only is expected to leave a link on which it is operating");
        NS_LOG_DEBUG("Record that no PHY is operating on link " << +linkId);
 
        if (phy->GetChannelSwitchDelay().IsZero())
        {
            // a PHY that was operating on a link has left the link and the channel switch delay is
            // zero; this must be an instantaneous switch of the main PHY at the end of ICF
            // reception. ScheduleNow the setting of m_noPhySince to get the "real" channel switch
            // delay, so that the actual time the main PHY started switching can be determined. Due
            // to this scheduling, all other actions must be scheduled now, too
            Simulator::ScheduleNow([=, this]() {
                NS_ASSERT(!m_noPhySince.contains(linkId));
                m_noPhySince[linkId] = Simulator::Now() - phy->GetChannelSwitchDelay();
            });
        }
        else
        {
            Simulator::ScheduleNow([=, this]() {
                NS_ASSERT(!m_noPhySince.contains(linkId));
                m_noPhySince[linkId] = Simulator::Now();
            });
        }
        return;
    }
 
    SetCcaEdThresholdOnLinkSwitch(phy, linkId);
 
    Simulator::ScheduleNow([=, this]() {
        // phy switched to operate on the link with ID equal to linkId
        auto it = m_noPhySince.find(linkId);
 
        if (it == m_noPhySince.end())
        {
            // phy switched to a link on which another PHY was operating, do nothing
            return;
        }
 
        auto duration = Simulator::Now() - it->second;
        NS_ASSERT_MSG(duration.IsPositive(), "Interval duration should not be negative");
 
        NS_LOG_DEBUG("PHY " << +phy->GetPhyId() << " switched to link " << +linkId << " after "
                            << duration.As(Time::US)
                            << " since last time a PHY was operating on this link");
        if (duration > MicroSeconds(MEDIUM_SYNC_THRESHOLD_USEC))
        {
            StartMediumSyncDelayTimer(linkId);
        }
 
        m_noPhySince.erase(it);
    });
}
 
void
EmlsrManager::SetMainPhyId(uint8_t mainPhyId)
{
    NS_LOG_FUNCTION(this << mainPhyId);
    NS_ABORT_MSG_IF(IsInitialized(), "Cannot be called once this object has been initialized");
    m_mainPhyId = mainPhyId;
}
 
uint8_t
EmlsrManager::GetMainPhyId() const
{
    return m_mainPhyId;
}
 
void
EmlsrManager::SetCamStateReset(bool enable)
{
    m_resetCamState = enable;
}
 
bool
EmlsrManager::GetCamStateReset() const
{
    return m_resetCamState;
}
 
void
EmlsrManager::SetAuxPhyTxCapable(bool capable)
{
    m_auxPhyTxCapable = capable;
}
 
bool
EmlsrManager::GetAuxPhyTxCapable() const
{
    return m_auxPhyTxCapable;
}
 
void
EmlsrManager::SetInDeviceInterference(bool enable)
{
    m_inDeviceInterference = enable;
}
 
bool
EmlsrManager::GetInDeviceInterference() const
{
    return m_inDeviceInterference;
}
 
const std::set<uint8_t>&
EmlsrManager::GetEmlsrLinks() const
{
    return m_emlsrLinks;
}
 
Ptr<StaWifiMac>
EmlsrManager::GetStaMac() const
{
    return m_staMac;
}
 
Ptr<EhtFrameExchangeManager>
EmlsrManager::GetEhtFem(uint8_t linkId) const
{
    return StaticCast<EhtFrameExchangeManager>(m_staMac->GetFrameExchangeManager(linkId));
}
 
std::optional<Time>
EmlsrManager::GetElapsedMediumSyncDelayTimer(uint8_t linkId) const
{
    if (const auto statusIt = m_mediumSyncDelayStatus.find(linkId);
        statusIt != m_mediumSyncDelayStatus.cend() && statusIt->second.timer.IsPending())
    {
        return m_mediumSyncDuration - Simulator::GetDelayLeft(statusIt->second.timer);
    }
    return std::nullopt;
}
 
void
EmlsrManager::SetTransitionTimeout(Time timeout)
{
    NS_LOG_FUNCTION(this << timeout.As(Time::US));
    m_emlsrTransitionTimeout = timeout;
}
 
std::optional<Time>
EmlsrManager::GetTransitionTimeout() const
{
    return m_emlsrTransitionTimeout;
}
 
void
EmlsrManager::SetMediumSyncDuration(Time duration)
{
    NS_LOG_FUNCTION(this << duration.As(Time::US));
    m_mediumSyncDuration = duration;
}
 
Time
EmlsrManager::GetMediumSyncDuration() const
{
    return m_mediumSyncDuration;
}
 
void
EmlsrManager::SetMediumSyncOfdmEdThreshold(int8_t threshold)
{
    NS_LOG_FUNCTION(this << threshold);
    m_msdOfdmEdThreshold = threshold;
}
 
int8_t
EmlsrManager::GetMediumSyncOfdmEdThreshold() const
{
    return m_msdOfdmEdThreshold;
}
 
void
EmlsrManager::SetMediumSyncMaxNTxops(std::optional<uint8_t> nTxops)
{
    NS_LOG_FUNCTION(this << nTxops.has_value());
    m_msdMaxNTxops = nTxops;
}
 
std::optional<uint8_t>
EmlsrManager::GetMediumSyncMaxNTxops() const
{
    return m_msdMaxNTxops;
}
 
void
EmlsrManager::SetEmlsrLinks(const std::set<uint8_t>& linkIds)
{
    std::stringstream ss;
    if (g_log.IsEnabled(ns3::LOG_FUNCTION))
    {
        std::copy(linkIds.cbegin(), linkIds.cend(), std::ostream_iterator<uint16_t>(ss, " "));
    }
    NS_LOG_FUNCTION(this << ss.str());
 
    if (linkIds != m_emlsrLinks)
    {
        m_nextEmlsrLinks = linkIds;
    }
 
    if (GetStaMac() && GetStaMac()->IsAssociated() && GetTransitionTimeout() && m_nextEmlsrLinks)
    {
        // Request to enable EMLSR mode on the given links, provided that they have been setup
        SendEmlOmn();
    }
}
 
void
EmlsrManager::NotifyMgtFrameReceived(Ptr<const WifiMpdu> mpdu, uint8_t linkId)
{
    NS_LOG_FUNCTION(this << *mpdu << linkId);
 
    const auto& hdr = mpdu->GetHeader();
 
    DoNotifyMgtFrameReceived(mpdu, linkId);
 
    if (hdr.IsAssocResp() && GetStaMac()->IsAssociated() && GetTransitionTimeout())
    {
        // we just completed ML setup with an AP MLD that supports EMLSR
        ComputeOperatingChannels();
 
        if (m_nextEmlsrLinks && !m_nextEmlsrLinks->empty())
        {
            // a non-empty set of EMLSR links have been configured, hence enable EMLSR mode
            // on those links
            SendEmlOmn();
        }
    }
 
    if (hdr.IsAction() && hdr.GetAddr2() == m_staMac->GetBssid(linkId))
    {
        // this is an action frame sent by an AP of the AP MLD we are associated with
        auto [category, action] = WifiActionHeader::Peek(mpdu->GetPacket());
        if (category == WifiActionHeader::PROTECTED_EHT &&
            action.protectedEhtAction ==
                WifiActionHeader::PROTECTED_EHT_EML_OPERATING_MODE_NOTIFICATION)
        {
            if (m_transitionTimeoutEvent.IsPending())
            {
                // no need to wait until the expiration of the transition timeout
                m_transitionTimeoutEvent.PeekEventImpl()->Invoke();
                m_transitionTimeoutEvent.Cancel();
            }
        }
    }
}
 
void
EmlsrManager::NotifyIcfReceived(uint8_t linkId)
{
    NS_LOG_FUNCTION(this << linkId);
 
    NS_ASSERT(m_staMac->IsEmlsrLink(linkId));
 
    // block transmissions and suspend medium access on all other EMLSR links
    for (auto id : m_staMac->GetLinkIds())
    {
        if (id != linkId && m_staMac->IsEmlsrLink(id))
        {
            m_staMac->BlockTxOnLink(id, WifiQueueBlockedReason::USING_OTHER_EMLSR_LINK);
        }
    }
 
    auto mainPhy = m_staMac->GetDevice()->GetPhy(m_mainPhyId);
    auto rxPhy = m_staMac->GetWifiPhy(linkId);
 
    const auto receivedByAuxPhy = (rxPhy != mainPhy);
    const auto mainPhyOnALink = (m_staMac->GetLinkForPhy(mainPhy).has_value());
    const auto mainPhyIsSwitching =
        (mainPhy->GetState()->GetLastTime({WifiPhyState::SWITCHING}) == Simulator::Now());
    // if the main PHY is not operating on a link and it is not switching, then we have postponed
    // the reconnection of the main PHY to a link because a PPDU reception was ongoing on that link
    const auto mainPhyToConnect = (!mainPhyOnALink && !mainPhyIsSwitching);
 
    const auto mainPhyToConnectToOtherLink = mainPhyToConnect && (m_mainPhySwitchInfo.to != linkId);
 
    if (mainPhyToConnect)
    {
        // If ICF was received on a link other than the one the main PHY is waiting to be connected
        // to, we need to cancel the pending reconnection and request a new main PHY switch.
        // If ICF was received on the link the main PHY is waiting to be connected to, we cancel
        // the pending reconnection and explicitly request the reconnection below
        GetStaMac()->CancelEmlsrPhyConnectEvent(mainPhy->GetPhyId());
    }
 
    // We need to request a main PHY switch if:
    // - the ICF was received by an aux PHY, AND
    // - the main PHY is not waiting to be connected to a link OR it is waiting to be connected
    //   to a link other than the link on which the ICF is received.
    if (receivedByAuxPhy && (!mainPhyToConnect || mainPhyToConnectToOtherLink))
    {
        SwitchMainPhy(linkId,
                      true, // channel switch should occur instantaneously
                      DONT_REQUEST_ACCESS,
                      EmlsrDlTxopIcfReceivedByAuxPhyTrace{});
    }
    else if (mainPhyToConnect && !mainPhyToConnectToOtherLink)
    {
        // If the main PHY is waiting to be connected to the link on which the ICF was received, we
        // have to explicitly perform the connection because the pending event was cancelled above.
        // We do this way in order to reconnect the main PHY before putting aux PHYs to sleep: if
        // the aux PHY is put to sleep while still operating on the link on which it received the
        // ICF, all the MAC events (including scheduled CTS transmission) will be cancelled.
        m_staMac->NotifySwitchingEmlsrLink(mainPhy, linkId, Time{0});
    }
 
    if (receivedByAuxPhy)
    {
        // aux PHY received the ICF but main PHY will send the response
        auto uid = rxPhy->GetPreviouslyRxPpduUid();
        mainPhy->SetPreviouslyRxPpduUid(uid);
    }
 
    // a DL TXOP started, set all aux PHYs to sleep
    if (m_auxPhyToSleep)
    {
        SetSleepStateForAllAuxPhys(true);
    }
 
    DoNotifyIcfReceived(linkId);
}
 
std::pair<bool, Time>
EmlsrManager::GetDelayUntilAccessRequest(uint8_t linkId, AcIndex aci)
{
    auto phy = m_staMac->GetWifiPhy(linkId);
    NS_ASSERT_MSG(phy, "No PHY operating on link " << +linkId);
 
    auto mainPhy = m_staMac->GetDevice()->GetPhy(m_mainPhyId);
 
    // check possible reasons to give up the TXOP that apply to both main PHY and aux PHYs
    if (const auto [startTxop, delay] = DoGetDelayUntilAccessRequest(linkId); !startTxop)
    {
        return {false, delay};
    }
 
    if (phy == mainPhy)
    {
        // no more constraints to check if medium was gained by main PHY
        return {true, Time{0}};
    }
 
    // an aux PHY is operating on the given link; call the appropriate method depending on
    // whether the aux PHY is TX capable or not
    if (!m_auxPhyTxCapable)
    {
        SwitchMainPhyIfTxopGainedByAuxPhy(linkId, aci);
        // if the aux PHY is not TX capable, we don't have to request channel access: if the main
        // PHY switches link, the UL TXOP will be started; if the main PHY does not switch, it is
        // because it is going to start an UL TXOP on another link and this link will be restarted
        // at the end of that UL TXOP when this link will be unblocked
        NS_LOG_DEBUG("Aux PHY is not capable of transmitting a PPDU");
        return {false, Time{0}};
    }
 
    return GetDelayUnlessMainPhyTakesOverUlTxop(linkId);
}
 
std::pair<bool, Time>
EmlsrManager::CheckPossiblyReceivingIcf(uint8_t linkId) const
{
    NS_LOG_FUNCTION(this << linkId);
 
    auto phy = GetStaMac()->GetWifiPhy(linkId);
 
    if (!phy || !GetStaMac()->IsEmlsrLink(linkId))
    {
        NS_LOG_DEBUG("No PHY (" << phy << ") or not an EMLSR link (" << +linkId << ")");
        return {false, Time{0}};
    }
 
    if (auto macHdr = GetEhtFem(linkId)->GetReceivedMacHdr(); macHdr && m_useNotifiedMacHdr)
    {
        NS_LOG_DEBUG("Receiving the MAC payload of a PSDU and MAC header info can be used");
        NS_ASSERT(phy->GetState()->GetLastTime({WifiPhyState::RX}) == Simulator::Now());
 
        if (const auto& hdr = macHdr->get();
            hdr.IsTrigger() &&
            (hdr.GetAddr1().IsBroadcast() || hdr.GetAddr1() == GetEhtFem(linkId)->GetAddress()))
        {
            // the PSDU being received _may_ be an ICF. Note that we cannot be sure that the PSDU
            // being received is an ICF addressed to us until we receive the entire PSDU
            NS_LOG_DEBUG("Based on MAC header, may be an ICF, postpone by "
                         << phy->GetDelayUntilIdle().As(Time::US));
            return {true, phy->GetDelayUntilIdle()};
        }
    }
    else if (auto txVector = phy->GetInfoIfRxingPhyHeader())
    {
        NS_LOG_DEBUG("Receiving PHY header");
        if (txVector->get().GetModulationClass() < WIFI_MOD_CLASS_HT)
        {
            // the PHY header of a non-HT PPDU, which may be an ICF, is being received; check
            // again after the TX duration of a non-HT PHY header
            NS_LOG_DEBUG("PHY header of a non-HT PPDU, which may be an ICF, is being received");
            return {true, EMLSR_RX_PHY_START_DELAY};
        }
    }
    else if (phy->IsStateRx())
    {
        // we have not yet received the MAC header or we cannot use its info
 
        auto ongoingRxInfo = GetEhtFem(linkId)->GetOngoingRxInfo();
        // if a PHY is in RX state, it should have info about received MAC header.
        // The exception is represented by this situation:
        // - an aux PHY is disconnected from the MAC stack because the main PHY is
        //   operating on its link
        // - the main PHY notifies the MAC header info to the FEM and then leaves the
        //   link (e.g., because it recognizes that the MPDU is not addressed to the
        //   EMLSR client). Disconnecting the main PHY from the MAC stack causes the
        //   MAC header info to be discarded by the FEM
        // - the aux PHY is re-connected to the MAC stack and is still in RX state
        //   when the main PHY gets channel access on another link (and we get here)
        if (!ongoingRxInfo.has_value())
        {
            NS_ASSERT_MSG(phy != GetStaMac()->GetDevice()->GetPhy(GetMainPhyId()),
                          "Main PHY should have MAC header info when in RX state");
            // we are in the situation described above; if the MPDU being received
            // by the aux PHY is not addressed to the EMLSR client, we can ignore it
        }
        else if (const auto& txVector = ongoingRxInfo->get().txVector;
                 txVector.GetModulationClass() < WIFI_MOD_CLASS_HT)
        {
            if (auto remTime = phy->GetTimeToMacHdrEnd(SU_STA_ID);
                m_useNotifiedMacHdr && remTime.has_value() && remTime->IsStrictlyPositive())
            {
                NS_LOG_DEBUG("Wait until the expected end of the MAC header reception: "
                             << remTime->As(Time::US));
                return {true, *remTime};
            }
 
            NS_LOG_DEBUG(
                "MAC header info will not be available. Wait until the end of PSDU reception: "
                << phy->GetDelayUntilIdle().As(Time::US));
            return {true, phy->GetDelayUntilIdle()};
        }
    }
 
    NS_LOG_DEBUG("No ICF being received, state: " << phy->GetState()->GetState());
    return {false, Time{0}};
}
 
std::optional<WifiIcfDrop>
EmlsrManager::CheckMainPhyTakesOverDlTxop(uint8_t linkId) const
{
    auto mainPhy = m_staMac->GetDevice()->GetPhy(m_mainPhyId);
 
    const auto delay = mainPhy->GetChannelSwitchDelay();
    auto lastTime = mainPhy->GetState()->GetLastTime({WifiPhyState::TX});
    auto reason = WifiIcfDrop::NOT_ENOUGH_TIME_TX;
 
    if (auto lastSwitch = mainPhy->GetState()->GetLastTime({WifiPhyState::SWITCHING});
        m_mainPhySwitchInfo.to != linkId && lastSwitch > lastTime)
    {
        lastTime = lastSwitch;
        reason = WifiIcfDrop::NOT_ENOUGH_TIME_SWITCH;
    }
    if (auto lastSleep = mainPhy->GetState()->GetLastTime({WifiPhyState::SLEEP});
        lastSleep > lastTime)
    {
        lastTime = lastSleep;
        reason = WifiIcfDrop::NOT_ENOUGH_TIME_SLEEP;
    }
    // ignore RX state for now
 
    if (lastTime > Simulator::Now() - delay)
    {
        NS_LOG_DEBUG("Not enough time for the main PHY to switch link; reason = "
                     << reason << " lastTime = " << lastTime.As(Time::US));
        return reason;
    }
    return std::nullopt;
}
 
void
EmlsrManager::NotifyUlTxopStart(uint8_t linkId)
{
    NS_LOG_FUNCTION(this << linkId);
 
    if (!m_staMac->IsEmlsrLink(linkId))
    {
        NS_LOG_DEBUG("EMLSR is not enabled on link " << +linkId);
        return;
    }
 
    // block transmissions and suspend medium access on all other EMLSR links
    for (auto id : m_staMac->GetLinkIds())
    {
        if (id != linkId && m_staMac->IsEmlsrLink(id))
        {
            m_staMac->BlockTxOnLink(id, WifiQueueBlockedReason::USING_OTHER_EMLSR_LINK);
        }
    }
 
    DoNotifyUlTxopStart(linkId);
}
 
void
EmlsrManager::NotifyRtsSent(uint8_t linkId, Ptr<const WifiPsdu> rts, const WifiTxVector& txVector)
{
    NS_LOG_FUNCTION(this << *rts << txVector);
}
 
void
EmlsrManager::NotifyProtectionCompleted(uint8_t linkId)
{
    NS_LOG_FUNCTION(this << linkId);
 
    if (m_auxPhyToSleep && m_staMac->IsEmlsrLink(linkId))
    {
        // if main PHY is switching (or has been scheduled to switch) to this link to take over the
        // UL TXOP, postpone aux PHY sleeping until after the main PHY has completed switching
        Time delay{0};
        if (auto mainPhy = m_staMac->GetDevice()->GetPhy(m_mainPhyId); mainPhy->IsStateSwitching())
        {
            delay = mainPhy->GetDelayUntilIdle();
        }
        else if (auto it = m_ulMainPhySwitch.find(linkId);
                 it != m_ulMainPhySwitch.end() && it->second.IsPending())
        {
            delay = Simulator::GetDelayLeft(it->second) + mainPhy->GetChannelSwitchDelay();
        }
 
        if (delay.IsStrictlyPositive())
        {
            Simulator::Schedule(delay + TimeStep(1),
                                &EmlsrManager::SetSleepStateForAllAuxPhys,
                                this,
                                true);
        }
        else
        {
            // put aux PHYs to sleep
            SetSleepStateForAllAuxPhys(true);
        }
    }
 
    DoNotifyProtectionCompleted(linkId);
}
 
void
EmlsrManager::NotifyTxopEnd(uint8_t linkId, bool ulTxopNotStarted, bool ongoingDlTxop)
{
    NS_LOG_FUNCTION(this << linkId << ulTxopNotStarted << ongoingDlTxop);
 
    if (!m_staMac->IsEmlsrLink(linkId))
    {
        NS_LOG_DEBUG("EMLSR is not enabled on link " << +linkId);
        return;
    }
 
    // If the main PHY has been scheduled to switch to this link, cancel the channel switch.
    // This happens, e.g., when an aux PHY sent an RTS to start an UL TXOP but it did not
    // receive a CTS response.
    if (auto it = m_ulMainPhySwitch.find(linkId); it != m_ulMainPhySwitch.end())
    {
        if (it->second.IsPending())
        {
            NS_LOG_DEBUG("Cancelling main PHY channel switch event on link " << +linkId);
            it->second.Cancel();
        }
        m_ulMainPhySwitch.erase(it);
    }
 
    // Unblock the other EMLSR links and start the MediumSyncDelay timer, provided that the TXOP
    // included the transmission of at least a frame and there is no ongoing DL TXOP on this link.
    // Indeed, the UL TXOP may have ended because the transmission of a frame failed and the
    // corresponding TX timeout (leading to this call) may have occurred after the reception on
    // this link of an ICF starting a DL TXOP. If the EMLSR Manager unblocked the other EMLSR
    // links, another TXOP could be started on another EMLSR link (possibly leading to a crash)
    // while the DL TXOP on this link is ongoing.
    if (ongoingDlTxop)
    {
        NS_LOG_DEBUG("DL TXOP ongoing");
        return;
    }
    if (ulTxopNotStarted)
    {
        NS_LOG_DEBUG("TXOP did not even start");
        return;
    }
 
    if (m_auxPhyToSleep)
    {
        // TXOP ended, resume all aux PHYs from sleep
        SetSleepStateForAllAuxPhys(false);
    }
 
    DoNotifyTxopEnd(linkId);
 
    // unblock transmissions and resume medium access on other EMLSR links
    std::set<uint8_t> linkIds;
    for (auto id : m_staMac->GetLinkIds())
    {
        if ((id != linkId) && m_staMac->IsEmlsrLink(id))
        {
            linkIds.insert(id);
        }
    }
    m_staMac->UnblockTxOnLink(linkIds, WifiQueueBlockedReason::USING_OTHER_EMLSR_LINK);
}
 
void
EmlsrManager::NotifyInDeviceInterferenceStart(uint8_t linkId, Time duration)
{
    NS_LOG_FUNCTION(this << linkId << duration.As(Time::US));
    NS_ASSERT(m_inDeviceInterference);
 
    // The STA may choose not to (re)start the MediumSyncDelay timer if the transmission duration
    // is less than or equal to aMediumSyncThreshold. (Sec. 35.3.16.8.1 802.11be D5.1)
    if (duration <= MicroSeconds(MEDIUM_SYNC_THRESHOLD_USEC))
    {
        return;
    }
 
    // iterate over all the other EMLSR links
    for (auto id : m_staMac->GetLinkIds())
    {
        if (id != linkId && m_staMac->IsEmlsrLink(id))
        {
            Simulator::Schedule(duration, &EmlsrManager::StartMediumSyncDelayTimer, this, id);
        }
    }
}
 
void
EmlsrManager::SetCcaEdThresholdOnLinkSwitch(Ptr<WifiPhy> phy, uint8_t linkId)
{
    NS_LOG_FUNCTION(this << phy << linkId);
 
    // if a MediumSyncDelay timer is running for the link on which the main PHY is going to
    // operate, set the CCA ED threshold to the MediumSyncDelay OFDM ED threshold
    if (auto statusIt = m_mediumSyncDelayStatus.find(linkId);
        statusIt != m_mediumSyncDelayStatus.cend() && statusIt->second.timer.IsPending())
    {
        NS_LOG_DEBUG("Setting CCA ED threshold of PHY " << +phy->GetPhyId() << " to "
                                                        << +m_msdOfdmEdThreshold << " on link "
                                                        << +linkId);
 
        // store the current CCA ED threshold in the m_prevCcaEdThreshold map, if not present
        m_prevCcaEdThreshold.try_emplace(phy, phy->GetCcaEdThreshold());
 
        phy->SetCcaEdThreshold(m_msdOfdmEdThreshold);
    }
    // otherwise, restore the previous value for the CCA ED threshold (if any)
    else if (auto threshIt = m_prevCcaEdThreshold.find(phy);
             threshIt != m_prevCcaEdThreshold.cend())
    {
        NS_LOG_DEBUG("Resetting CCA ED threshold of PHY "
                     << +phy->GetPhyId() << " to " << threshIt->second << " on link " << +linkId);
        phy->SetCcaEdThreshold(threshIt->second);
        m_prevCcaEdThreshold.erase(threshIt);
    }
}
 
void
EmlsrManager::SwitchMainPhy(uint8_t linkId,
                            bool noSwitchDelay,
                            bool requestAccess,
                            EmlsrMainPhySwitchTrace&& traceInfo)
{
    NS_LOG_FUNCTION(this << linkId << noSwitchDelay << requestAccess << traceInfo.GetName());
 
    auto mainPhy = m_staMac->GetDevice()->GetPhy(m_mainPhyId);
 
    NS_ASSERT_MSG(mainPhy != m_staMac->GetWifiPhy(linkId),
                  "Main PHY is already operating on link " << +linkId);
 
    // find the link on which the main PHY is operating
    auto currMainPhyLinkId = m_staMac->GetLinkForPhy(mainPhy);
    traceInfo.fromLinkId = currMainPhyLinkId;
    traceInfo.toLinkId = linkId;
    m_mainPhySwitchTrace(traceInfo);
 
    const auto newMainPhyChannel = GetChannelForMainPhy(linkId);
 
    NS_LOG_DEBUG("Main PHY (" << mainPhy << ") is about to switch to " << newMainPhyChannel
                              << " to operate on link " << +linkId);
 
    // if the main PHY is operating on a link, notify the channel access manager of the upcoming
    // channel switch
    if (currMainPhyLinkId.has_value())
    {
        m_staMac->GetChannelAccessManager(*currMainPhyLinkId)
            ->NotifySwitchingEmlsrLink(mainPhy, newMainPhyChannel, linkId);
    }
 
    // this assert also ensures that the actual channel switch is not delayed
    NS_ASSERT_MSG(!mainPhy->GetState()->IsStateTx(),
                  "We should not ask the main PHY to switch channel while transmitting");
 
    // record the aux PHY operating on the link the main PHY is switching to
    auto auxPhy = GetStaMac()->GetWifiPhy(linkId);
 
    // request the main PHY to switch channel
    const auto delay = mainPhy->GetChannelSwitchDelay();
    const auto pifs = mainPhy->GetSifs() + mainPhy->GetSlot();
    if (!noSwitchDelay && delay > std::max(m_lastAdvTransitionDelay, pifs))
    {
        NS_LOG_WARN("Channel switch delay ("
                    << delay.As(Time::US)
                    << ") should be shorter than the maximum between the Transition delay ("
                    << m_lastAdvTransitionDelay.As(Time::US) << ") and a PIFS ("
                    << pifs.As(Time::US) << ")");
    }
    if (noSwitchDelay)
    {
        mainPhy->SetAttribute("ChannelSwitchDelay", TimeValue(Seconds(0)));
    }
    mainPhy->SetOperatingChannel(newMainPhyChannel);
    // restore previous channel switch delay
    if (noSwitchDelay)
    {
        mainPhy->SetAttribute("ChannelSwitchDelay", TimeValue(delay));
    }
    // re-enable short time slot, if needed
    if (m_staMac->GetWifiRemoteStationManager(linkId)->GetShortSlotTimeEnabled())
    {
        mainPhy->SetSlot(MicroSeconds(9));
    }
 
    const auto timeToSwitchEnd = noSwitchDelay ? Seconds(0) : delay;
 
    // if the main PHY is not operating on any link (because it was switching), it is not connected
    // to a channel access manager, hence we must notify the MAC of the new link switch
    if (!currMainPhyLinkId.has_value())
    {
        m_staMac->NotifySwitchingEmlsrLink(mainPhy, linkId, timeToSwitchEnd);
    }
 
    if (requestAccess)
    {
        // schedule channel access request on the new link when switch is completed
        Simulator::Schedule(timeToSwitchEnd, [=, this]() {
            for (const auto& [acIndex, ac] : wifiAcList)
            {
                m_staMac->GetQosTxop(acIndex)->StartAccessAfterEvent(
                    linkId,
                    Txop::DIDNT_HAVE_FRAMES_TO_TRANSMIT,
                    Txop::CHECK_MEDIUM_BUSY);
            }
        });
    }
 
    m_mainPhySwitchInfo.from = currMainPhyLinkId.value_or(m_mainPhySwitchInfo.from);
    m_mainPhySwitchInfo.to = linkId;
    m_mainPhySwitchInfo.end = Simulator::Now() + timeToSwitchEnd;
 
    NotifyMainPhySwitch(currMainPhyLinkId, linkId, auxPhy, timeToSwitchEnd);
}
 
void
EmlsrManager::SwitchAuxPhy(Ptr<WifiPhy> auxPhy, uint8_t currLinkId, uint8_t nextLinkId)
{
    NS_LOG_FUNCTION(this << auxPhy << currLinkId << nextLinkId);
 
    auto newAuxPhyChannel = GetChannelForAuxPhy(nextLinkId);
 
    NS_LOG_DEBUG("Aux PHY (" << auxPhy << ") is about to switch to " << newAuxPhyChannel
                             << " to operate on link " << +nextLinkId);
 
    GetStaMac()
        ->GetChannelAccessManager(currLinkId)
        ->NotifySwitchingEmlsrLink(auxPhy, newAuxPhyChannel, nextLinkId);
 
    auxPhy->SetOperatingChannel(newAuxPhyChannel);
    // re-enable short time slot, if needed
    if (m_staMac->GetWifiRemoteStationManager(nextLinkId)->GetShortSlotTimeEnabled())
    {
        auxPhy->SetSlot(MicroSeconds(9));
    }
 
    // schedule channel access request on the new link when switch is completed
    Simulator::Schedule(auxPhy->GetChannelSwitchDelay(), [=, this]() {
        for (const auto& [acIndex, ac] : wifiAcList)
        {
            m_staMac->GetQosTxop(acIndex)->StartAccessAfterEvent(
                nextLinkId,
                Txop::DIDNT_HAVE_FRAMES_TO_TRANSMIT,
                Txop::CHECK_MEDIUM_BUSY);
        }
    });
}
 
void
EmlsrManager::StartMediumSyncDelayTimer(uint8_t linkId)
{
    NS_LOG_FUNCTION(this << linkId);
 
    if (m_mediumSyncDuration.IsZero())
    {
        NS_LOG_DEBUG("MediumSyncDuration is zero");
        return;
    }
 
    auto phy = m_staMac->GetWifiPhy(linkId);
 
    if (!phy)
    {
        NS_LOG_DEBUG("No PHY operating on link " << +linkId);
        // MSD timer will be started when a PHY will be operating on this link
        return;
    }
 
    const auto [it, inserted] = m_mediumSyncDelayStatus.try_emplace(linkId);
 
    // reset the max number of TXOP attempts
    it->second.msdNTxopsLeft = m_msdMaxNTxops;
 
    if (!it->second.timer.IsPending())
    {
        NS_LOG_DEBUG("Setting CCA ED threshold on link "
                     << +linkId << " to " << +m_msdOfdmEdThreshold << " PHY " << +phy->GetPhyId());
        m_prevCcaEdThreshold[phy] = phy->GetCcaEdThreshold();
        phy->SetCcaEdThreshold(m_msdOfdmEdThreshold);
    }
 
    // (re)start the timer
    it->second.timer.Cancel();
    NS_LOG_DEBUG("Starting MediumSyncDelay timer for " << m_mediumSyncDuration.As(Time::US)
                                                       << " on link " << +linkId);
    it->second.timer = Simulator::Schedule(m_mediumSyncDuration,
                                           &EmlsrManager::MediumSyncDelayTimerExpired,
                                           this,
                                           linkId);
}
 
void
EmlsrManager::CancelMediumSyncDelayTimer(uint8_t linkId)
{
    NS_LOG_FUNCTION(this << linkId);
 
    auto timerIt = m_mediumSyncDelayStatus.find(linkId);
 
    NS_ASSERT(timerIt != m_mediumSyncDelayStatus.cend() && timerIt->second.timer.IsPending());
 
    timerIt->second.timer.Cancel();
    MediumSyncDelayTimerExpired(linkId);
}
 
void
EmlsrManager::MediumSyncDelayTimerExpired(uint8_t linkId)
{
    NS_LOG_FUNCTION(this << linkId);
 
    auto timerIt = m_mediumSyncDelayStatus.find(linkId);
 
    NS_ASSERT(timerIt != m_mediumSyncDelayStatus.cend() && !timerIt->second.timer.IsPending());
 
    // reset the MSD OFDM ED threshold
    auto phy = m_staMac->GetWifiPhy(linkId);
 
    if (!phy)
    {
        // no PHY is operating on this link. This may happen when a MediumSyncDelay timer expires
        // on the link left "uncovered" by the main PHY that is operating on another link (and the
        // aux PHY of that link did not switch). In this case, do nothing, since the CCA ED
        // threshold on the main PHY will be restored once the main PHY switches back to its link
        return;
    }
 
    auto threshIt = m_prevCcaEdThreshold.find(phy);
    NS_ASSERT_MSG(threshIt != m_prevCcaEdThreshold.cend(),
                  "No value to restore for CCA ED threshold on PHY " << phy);
    NS_LOG_DEBUG("Resetting CCA ED threshold of PHY " << phy << " to " << threshIt->second
                                                      << " on link " << +linkId);
    phy->SetCcaEdThreshold(threshIt->second);
    m_prevCcaEdThreshold.erase(threshIt);
}
 
void
EmlsrManager::DecrementMediumSyncDelayNTxops(uint8_t linkId)
{
    NS_LOG_FUNCTION(this << linkId);
 
    const auto timerIt = m_mediumSyncDelayStatus.find(linkId);
 
    NS_ASSERT(timerIt != m_mediumSyncDelayStatus.cend() && timerIt->second.timer.IsPending());
    NS_ASSERT(timerIt->second.msdNTxopsLeft != 0);
 
    if (timerIt->second.msdNTxopsLeft)
    {
        --timerIt->second.msdNTxopsLeft.value();
    }
}
 
void
EmlsrManager::ResetMediumSyncDelayNTxops(uint8_t linkId)
{
    NS_LOG_FUNCTION(this << linkId);
 
    auto timerIt = m_mediumSyncDelayStatus.find(linkId);
 
    NS_ASSERT(timerIt != m_mediumSyncDelayStatus.cend() && timerIt->second.timer.IsPending());
    timerIt->second.msdNTxopsLeft.reset();
}
 
bool
EmlsrManager::MediumSyncDelayNTxopsExceeded(uint8_t linkId)
{
    NS_LOG_FUNCTION(this << linkId);
 
    auto timerIt = m_mediumSyncDelayStatus.find(linkId);
 
    NS_ASSERT(timerIt != m_mediumSyncDelayStatus.cend() && timerIt->second.timer.IsPending());
    return timerIt->second.msdNTxopsLeft == 0;
}
 
bool
EmlsrManager::GetExpectedAccessWithinDelay(uint8_t linkId, const Time& delay) const
{
    const auto deadline = Simulator::Now() + delay;
    for (const auto& [acIndex, ac] : wifiAcList)
    {
        if (auto edca = m_staMac->GetQosTxop(acIndex); edca->HasFramesToTransmit(linkId))
        {
            const auto backoffEnd =
                m_staMac->GetChannelAccessManager(linkId)->GetBackoffEndFor(edca);
 
            if (backoffEnd <= deadline)
            {
                NS_LOG_DEBUG("Backoff end for " << acIndex << " on link " << +linkId << ": "
                                                << backoffEnd.As(Time::US));
                return true;
            }
        }
    }
    return false;
}
 
MgtEmlOmn
EmlsrManager::GetEmlOmn()
{
    MgtEmlOmn frame;
 
    // Add the EMLSR Parameter Update field if needed
    if (m_lastAdvPaddingDelay != m_emlsrPaddingDelay ||
        m_lastAdvTransitionDelay != m_emlsrTransitionDelay)
    {
        m_lastAdvPaddingDelay = m_emlsrPaddingDelay;
        m_lastAdvTransitionDelay = m_emlsrTransitionDelay;
        frame.m_emlControl.emlsrParamUpdateCtrl = 1;
        frame.m_emlsrParamUpdate = MgtEmlOmn::EmlsrParamUpdate{};
        frame.m_emlsrParamUpdate->paddingDelay =
            CommonInfoBasicMle::EncodeEmlsrPaddingDelay(m_lastAdvPaddingDelay);
        frame.m_emlsrParamUpdate->transitionDelay =
            CommonInfoBasicMle::EncodeEmlsrTransitionDelay(m_lastAdvTransitionDelay);
    }
 
    // We must verify that the links included in the given EMLSR link set (if any) have been setup.
    auto setupLinkIds = m_staMac->GetSetupLinkIds();
 
    for (auto emlsrLinkIt = m_nextEmlsrLinks->begin(); emlsrLinkIt != m_nextEmlsrLinks->end();)
    {
        if (auto setupLinkIt = setupLinkIds.find(*emlsrLinkIt); setupLinkIt != setupLinkIds.cend())
        {
            setupLinkIds.erase(setupLinkIt);
            frame.SetLinkIdInBitmap(*emlsrLinkIt);
            emlsrLinkIt++;
        }
        else
        {
            NS_LOG_DEBUG("Link ID " << +(*emlsrLinkIt) << " has not been setup");
            emlsrLinkIt = m_nextEmlsrLinks->erase(emlsrLinkIt);
        }
    }
 
    // EMLSR Mode is enabled if and only if the set of EMLSR links is not empty
    frame.m_emlControl.emlsrMode = m_nextEmlsrLinks->empty() ? 0 : 1;
 
    return frame;
}
 
void
EmlsrManager::SendEmlOmn()
{
    NS_LOG_FUNCTION(this);
 
    NS_ABORT_MSG_IF(!m_emlsrTransitionTimeout,
                    "AP did not advertise a Transition Timeout, cannot send EML notification");
    NS_ASSERT_MSG(m_nextEmlsrLinks, "Need to set EMLSR links before calling this method");
 
    // TODO if this is a single radio non-AP MLD and not all setup links are in the EMLSR link
    // set, we have to put setup links that are not included in the given EMLSR link set (i.e.,
    // those remaining in setupLinkIds, if m_nextEmlsrLinks is not empty) in the sleep mode:
    // For the EMLSR mode enabled in a single radio non-AP MLD, the STA(s) affiliated with
    // the non-AP MLD that operates on the enabled link(s) that corresponds to the bit
    // position(s) of the EMLSR Link Bitmap subfield set to 0 shall be in doze state if a
    // non-AP STA affiliated with the non-AP MLD that operates on one of the EMLSR links is
    // in awake state. (Sec. 35.3.17 of 802.11be D3.0)
 
    auto frame = GetEmlOmn();
    auto linkId = GetLinkToSendEmlOmn();
    GetEhtFem(linkId)->SendEmlOmn(m_staMac->GetBssid(linkId), frame);
}
 
void
EmlsrManager::TxOk(Ptr<const WifiMpdu> mpdu)
{
    NS_LOG_FUNCTION(this << *mpdu);
 
    const auto& hdr = mpdu->GetHeader();
 
    if (hdr.IsAssocReq())
    {
        // store padding delay and transition delay advertised in AssocReq
        MgtAssocRequestHeader assocReq;
        mpdu->GetPacket()->PeekHeader(assocReq);
        auto& mle = assocReq.Get<MultiLinkElement>();
        NS_ASSERT_MSG(mle, "AssocReq should contain a Multi-Link Element");
        m_lastAdvPaddingDelay = mle->GetEmlsrPaddingDelay();
        m_lastAdvTransitionDelay = mle->GetEmlsrTransitionDelay();
    }
 
    if (hdr.IsMgt() && hdr.IsAction())
    {
        if (auto [category, action] = WifiActionHeader::Peek(mpdu->GetPacket());
            category == WifiActionHeader::PROTECTED_EHT &&
            action.protectedEhtAction ==
                WifiActionHeader::PROTECTED_EHT_EML_OPERATING_MODE_NOTIFICATION)
        {
            // the EML Operating Mode Notification frame that we sent has been acknowledged.
            // Start the transition timeout to wait until the request can be made effective
            NS_ASSERT_MSG(m_emlsrTransitionTimeout, "No transition timeout received from AP");
            m_transitionTimeoutEvent = Simulator::Schedule(*m_emlsrTransitionTimeout,
                                                           &EmlsrManager::ChangeEmlsrMode,
                                                           this);
        }
    }
}
 
void
EmlsrManager::TxDropped(WifiMacDropReason reason, Ptr<const WifiMpdu> mpdu)
{
    NS_LOG_FUNCTION(this << reason << *mpdu);
 
    const auto& hdr = mpdu->GetHeader();
 
    if (hdr.IsMgt() && hdr.IsAction())
    {
        auto pkt = mpdu->GetPacket()->Copy();
        if (auto [category, action] = WifiActionHeader::Remove(pkt);
            category == WifiActionHeader::PROTECTED_EHT &&
            action.protectedEhtAction ==
                WifiActionHeader::PROTECTED_EHT_EML_OPERATING_MODE_NOTIFICATION)
        {
            // the EML Operating Mode Notification frame has been dropped. Ask the subclass
            // whether the frame needs to be resent
            auto linkId = ResendNotification(mpdu);
            if (linkId)
            {
                MgtEmlOmn frame;
                pkt->RemoveHeader(frame);
                GetEhtFem(*linkId)->SendEmlOmn(m_staMac->GetBssid(*linkId), frame);
            }
            else
            {
                m_nextEmlsrLinks.reset();
            }
        }
    }
}
 
void
EmlsrManager::ChangeEmlsrMode()
{
    NS_LOG_FUNCTION(this);
 
    // After the successful transmission of the EML Operating Mode Notification frame by the
    // non-AP STA affiliated with the non-AP MLD, the non-AP MLD shall operate in the EMLSR mode
    // and the other non-AP STAs operating on the corresponding EMLSR links shall transition to
    // active mode after the transition delay indicated in the Transition Timeout subfield in the
    // EML Capabilities subfield of the Basic Multi-Link element or immediately after receiving an
    // EML Operating Mode Notification frame from one of the APs operating on the EMLSR links and
    // affiliated with the AP MLD. (Sec. 35.3.17 of 802.11be D3.0)
    NS_ASSERT_MSG(m_nextEmlsrLinks, "No set of EMLSR links stored");
    m_emlsrLinks.swap(*m_nextEmlsrLinks);
    m_nextEmlsrLinks.reset();
 
    // Make other non-AP STAs operating on the corresponding EMLSR links transition to
    // active mode or passive mode (depending on whether EMLSR mode has been enabled or disabled)
    m_staMac->NotifyEmlsrModeChanged(m_emlsrLinks);
    // Enforce the limit on the max channel width supported by aux PHYs
    ApplyMaxChannelWidthAndModClassOnAuxPhys();
 
    NotifyEmlsrModeChanged();
}
 
void
EmlsrManager::ApplyMaxChannelWidthAndModClassOnAuxPhys()
{
    NS_LOG_FUNCTION(this);
    auto currMainPhyLinkId = m_staMac->GetLinkForPhy(m_mainPhyId);
    NS_ASSERT(currMainPhyLinkId);
 
    for (const auto linkId : m_staMac->GetLinkIds())
    {
        auto auxPhy = m_staMac->GetWifiPhy(linkId);
        auto channel = GetChannelForAuxPhy(linkId);
 
        if (linkId == currMainPhyLinkId || !m_staMac->IsEmlsrLink(linkId))
        {
            continue; // main PHY link or not an EMLSR link
        }
 
        auxPhy->SetMaxModulationClassSupported(m_auxPhyMaxModClass);
 
        if (auxPhy->GetOperatingChannel() == channel)
        {
            continue;
        }
 
        NS_LOG_DEBUG("Aux PHY (" << auxPhy << ") is about to switch to " << channel
                                 << " to operate on link " << +linkId);
        // We cannot simply set the new channel, because otherwise the MAC will disable
        // the setup link. We need to inform the MAC (via the Channel Access Manager) that
        // this channel switch must not have such a consequence. We already have a method
        // for doing so, i.e., inform the MAC that the PHY is switching channel to operate
        // on the "same" link.
        auto cam = m_staMac->GetChannelAccessManager(linkId);
        cam->NotifySwitchingEmlsrLink(auxPhy, channel, linkId);
 
        // apply channel width limitation assuming an instantaneous channel switch
        const auto delay = auxPhy->GetChannelSwitchDelay();
        auxPhy->SetAttribute("ChannelSwitchDelay", TimeValue(Time{0}));
        auxPhy->SetOperatingChannel(channel);
        auxPhy->SetAttribute("ChannelSwitchDelay", TimeValue(delay));
    }
}
 
void
EmlsrManager::ComputeOperatingChannels()
{
    NS_LOG_FUNCTION(this);
 
    m_mainPhyChannels.clear();
    m_auxPhyChannels.clear();
 
    auto linkIds = m_staMac->GetSetupLinkIds();
 
    for (auto linkId : linkIds)
    {
        const auto& channel = m_staMac->GetWifiPhy(linkId)->GetOperatingChannel();
        m_mainPhyChannels.emplace(linkId, channel);
 
        auto mainPhyChWidth = channel.GetWidth();
        if (m_auxPhyMaxWidth >= mainPhyChWidth)
        {
            // same channel can be used by aux PHYs
            m_auxPhyChannels.emplace(linkId, channel);
            continue;
        }
        // aux PHYs will operate on a primary subchannel
        auto freq = channel.GetPrimaryChannelCenterFrequency(m_auxPhyMaxWidth);
        auto chIt = WifiPhyOperatingChannel::FindFirst(0,
                                                       freq,
                                                       m_auxPhyMaxWidth,
                                                       WIFI_STANDARD_UNSPECIFIED,
                                                       channel.GetPhyBand());
        NS_ASSERT_MSG(chIt != WifiPhyOperatingChannel::m_frequencyChannels.end(),
                      "Primary" << m_auxPhyMaxWidth << " channel not found");
        m_auxPhyChannels.emplace(linkId, chIt);
        // find the P20 index for the channel used by the aux PHYs
        auto p20Index = channel.GetPrimaryChannelIndex(MHz_u{20});
        while (mainPhyChWidth > m_auxPhyMaxWidth)
        {
            mainPhyChWidth /= 2;
            p20Index /= 2;
        }
        m_auxPhyChannels[linkId].SetPrimary20Index(p20Index);
    }
}
 
const WifiPhyOperatingChannel&
EmlsrManager::GetChannelForMainPhy(uint8_t linkId) const
{
    auto it = m_mainPhyChannels.find(linkId);
    NS_ASSERT_MSG(it != m_mainPhyChannels.end(),
                  "Channel for main PHY on link ID " << +linkId << " not found");
    return it->second;
}
 
const WifiPhyOperatingChannel&
EmlsrManager::GetChannelForAuxPhy(uint8_t linkId) const
{
    auto it = m_auxPhyChannels.find(linkId);
    NS_ASSERT_MSG(it != m_auxPhyChannels.end(),
                  "Channel for aux PHY on link ID " << +linkId << " not found");
    return it->second;
}
 
void
EmlsrManager::CancelAllSleepEvents()
{
    NS_LOG_FUNCTION(this);
 
    for (auto& [id, event] : m_auxPhyToSleepEvents)
    {
        event.Cancel();
    }
    m_auxPhyToSleepEvents.clear();
}
 
void
EmlsrManager::SetSleepStateForAllAuxPhys(bool sleep)
{
    NS_LOG_FUNCTION(this << sleep);
 
    CancelAllSleepEvents();
 
    for (const auto& phy : m_staMac->GetDevice()->GetPhys())
    {
        if (phy->GetPhyId() == m_mainPhyId)
        {
            continue; // do not set sleep mode/resume from sleep the main PHY
        }
 
        auto linkId = m_staMac->GetLinkForPhy(phy);
 
        if (linkId.has_value() && !m_staMac->IsEmlsrLink(*linkId))
        {
            continue; // this PHY is not operating on an EMLSR link
        }
 
        if (!sleep)
        {
            if (!phy->IsStateSleep())
            {
                continue; // nothing to do
            }
 
            NS_LOG_DEBUG("PHY " << +phy->GetPhyId() << ": Resuming from sleep");
            phy->ResumeFromSleep();
 
            // if this aux PHY is operating on a link, check if it lost medium sync
            if (linkId.has_value())
            {
                auto it = m_startSleep.find(phy->GetPhyId());
                NS_ASSERT_MSG(it != m_startSleep.cend(),
                              "No start sleep info for PHY ID " << phy->GetPhyId());
                const auto sleepDuration = Simulator::Now() - it->second;
                m_startSleep.erase(it);
 
                if (sleepDuration > MicroSeconds(MEDIUM_SYNC_THRESHOLD_USEC))
                {
                    StartMediumSyncDelayTimer(*linkId);
                }
            }
 
            continue; // resuming the PHY from sleep has been handled
        }
 
        if (phy->IsStateSleep())
        {
            continue; // nothing to do
        }
 
        // we force WifiPhy::SetSleepMode() to abort RX and switch immediately to sleep mode in
        // case the state is RX. If the state is TX or SWITCHING, WifiPhy::SetSleepMode() postpones
        // setting sleep mode to end of TX or SWITCHING. This is fine, but we schedule events here
        // to correctly record the time an aux PHY was put to sleep and to be able to cancel them
        // later if needed
        std::stringstream ss;
        auto s = std::string("PHY ") + std::to_string(phy->GetPhyId()) + ": Setting sleep mode";
        if (phy->IsStateTx() || phy->IsStateSwitching())
        {
            const auto delay = phy->GetDelayUntilIdle();
            NS_LOG_DEBUG(s << " in " << delay.As(Time::US));
            m_auxPhyToSleepEvents[phy->GetPhyId()] = Simulator::Schedule(delay, [=, this]() {
                phy->SetSleepMode(true);
                m_startSleep[phy->GetPhyId()] = Simulator::Now();
            });
        }
        else
        {
            NS_LOG_DEBUG(s);
            phy->SetSleepMode(true);
            m_startSleep[phy->GetPhyId()] = Simulator::Now();
        }
    }
}
 
} // namespace ns3