emlsr-manager.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Universita' degli Studi di Napoli Federico II
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Stefano Avallone <stavallo@unina.it>
 */
 
#ifndef EMLSR_MANAGER_H
#define EMLSR_MANAGER_H
 
#include "ns3/ctrl-headers.h"
#include "ns3/mac48-address.h"
#include "ns3/object.h"
#include "ns3/sta-wifi-mac.h"
#include "ns3/wifi-phy-operating-channel.h"
 
#include <map>
#include <optional>
#include <set>
 
namespace ns3
{
 
class EhtFrameExchangeManager;
class MgtEmlOmn;
class WifiMpdu;
 
class EmlsrManager : public Object
{
  public:
    static TypeId GetTypeId();
    EmlsrManager();
    ~EmlsrManager() override;
 
    void SetWifiMac(Ptr<StaWifiMac> mac);
 
    void SetTransitionTimeout(Time timeout);
 
    std::optional<Time> GetTransitionTimeout() const;
 
    void SetMediumSyncDuration(Time duration);
 
    Time GetMediumSyncDuration() const;
 
    void SetMediumSyncOfdmEdThreshold(int8_t threshold);
 
    int8_t GetMediumSyncOfdmEdThreshold() const;
 
    void SetMediumSyncMaxNTxops(std::optional<uint8_t> nTxops);
 
    std::optional<uint8_t> GetMediumSyncMaxNTxops() const;
 
    uint8_t GetMainPhyId() const;
 
    void SetEmlsrLinks(const std::set<uint8_t>& linkIds);
 
    const std::set<uint8_t>& GetEmlsrLinks() const;
 
    void SetCamStateReset(bool enable);
 
    bool GetCamStateReset() const;
 
    void SetAuxPhyTxCapable(bool capable);
 
    bool GetAuxPhyTxCapable() const;
 
    void NotifyMgtFrameReceived(Ptr<const WifiMpdu> mpdu, uint8_t linkId);
 
    void NotifyIcfReceived(uint8_t linkId);
 
    void NotifyUlTxopStart(uint8_t linkId, std::optional<Time> timeToCtsEnd);
 
    void NotifyTxopEnd(uint8_t linkId);
 
    std::optional<Time> GetElapsedMediumSyncDelayTimer(uint8_t linkId) const;
 
    void CancelMediumSyncDelayTimer(uint8_t linkId);
 
    void DecrementMediumSyncDelayNTxops(uint8_t linkId);
 
    void ResetMediumSyncDelayNTxops(uint8_t linkId);
 
    bool MediumSyncDelayNTxopsExceeded(uint8_t linkId);
 
  protected:
    void DoDispose() override;
 
    Ptr<StaWifiMac> GetStaMac() const;
 
    Ptr<EhtFrameExchangeManager> GetEhtFem(uint8_t linkId) const;
 
    virtual uint8_t GetLinkToSendEmlOmn() = 0;
 
    virtual std::optional<uint8_t> ResendNotification(Ptr<const WifiMpdu> mpdu) = 0;
 
    const WifiPhyOperatingChannel& GetChannelForMainPhy(uint8_t linkId) const;
 
    const WifiPhyOperatingChannel& GetChannelForAuxPhy(uint8_t linkId) const;
 
    void SwitchMainPhy(uint8_t linkId, bool noSwitchDelay, bool resetBackoff, bool requestAccess);
 
    static constexpr bool RESET_BACKOFF = true;       
    static constexpr bool DONT_RESET_BACKOFF = false; 
    static constexpr bool REQUEST_ACCESS = true; 
    static constexpr bool DONT_REQUEST_ACCESS =
        false; 
 
    void SwitchAuxPhy(uint8_t currLinkId, uint8_t nextLinkId);
 
    void SetCcaEdThresholdOnLinkSwitch(Ptr<WifiPhy> phy, uint8_t linkId);
 
    MgtEmlOmn GetEmlOmn();
 
    Time m_emlsrPaddingDelay;    
    Time m_emlsrTransitionDelay; 
    uint8_t m_mainPhyId; 
    uint16_t m_auxPhyMaxWidth;               
    WifiModulationClass m_auxPhyMaxModClass; 
    bool m_auxPhyTxCapable;                  
 
  private:
    void SetMainPhyId(uint8_t mainPhyId);
 
    void ComputeOperatingChannels();
 
    void SendEmlOmn();
 
    void StartMediumSyncDelayTimer(uint8_t linkId);
 
    void MediumSyncDelayTimerExpired(uint8_t linkId);
 
    virtual void DoNotifyMgtFrameReceived(Ptr<const WifiMpdu> mpdu, uint8_t linkId) = 0;
 
    virtual void DoNotifyIcfReceived(uint8_t linkId) = 0;
 
    virtual void DoNotifyUlTxopStart(uint8_t linkId) = 0;
 
    virtual void DoNotifyTxopEnd(uint8_t linkId) = 0;
 
    void TxOk(Ptr<const WifiMpdu> mpdu);
 
    void TxDropped(WifiMacDropReason reason, Ptr<const WifiMpdu> mpdu);
 
    void ChangeEmlsrMode();
 
    void ApplyMaxChannelWidthAndModClassOnAuxPhys();
 
    virtual void NotifyEmlsrModeChanged() = 0;
 
    virtual void NotifyMainPhySwitch(uint8_t currLinkId, uint8_t nextLinkId) = 0;
 
    struct MediumSyncDelayStatus
    {
        EventId timer;                        
        std::optional<uint8_t> msdNTxopsLeft; 
    };
 
    Ptr<StaWifiMac> m_staMac;                     
    std::optional<Time> m_emlsrTransitionTimeout; 
    Time m_mediumSyncDuration;                    
    int8_t m_msdOfdmEdThreshold;                  
    std::optional<uint8_t> m_msdMaxNTxops;        
 
    std::map<uint8_t, MediumSyncDelayStatus>
        m_mediumSyncDelayStatus; 
    std::map<Ptr<WifiPhy>, double> m_prevCcaEdThreshold; 
 
    std::set<uint8_t> m_emlsrLinks; 
    std::optional<std::set<uint8_t>> m_nextEmlsrLinks; 
    Time m_lastAdvPaddingDelay;                        
    Time m_lastAdvTransitionDelay;                     
    EventId m_transitionTimeoutEvent; 
    bool m_resetCamState; 
    std::map<uint8_t, WifiPhyOperatingChannel>
        m_mainPhyChannels; 
    std::map<uint8_t, WifiPhyOperatingChannel>
        m_auxPhyChannels; 
};
 
} // namespace ns3
 
#endif /* EMLSR_MANAGER_H */