nr-mac-scheduler-ofdma.h

// Copyright (c) 2019 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
 
#pragma once
 
#include "nr-mac-scheduler-ofdma-symbol-per-beam.h"
#include "nr-mac-scheduler-tdma.h"
 
#include "ns3/traced-value.h"
 
#include <set>
#include <unordered_set>
 
namespace ns3
{
class NrMacSchedulerOfdmaSymbolPerBeam;
class NrSchedOfdmaSymbolPerBeamTestCase;
 
class NrMacSchedulerOfdma : public NrMacSchedulerTdma
{
  public:
    static TypeId GetTypeId();
 
    NrMacSchedulerOfdma();
 
    ~NrMacSchedulerOfdma() override
    {
    }
 
  protected:
    BeamSymbolMap AssignDLRBG(uint32_t symAvail, const ActiveUeMap& activeDl) const override;
    BeamSymbolMap AssignULRBG(uint32_t symAvail, const ActiveUeMap& activeUl) const override;
 
    std::shared_ptr<DciInfoElementTdma> CreateDlDci(
        PointInFTPlane* spoint,
        const std::shared_ptr<NrMacSchedulerUeInfo>& ueInfo,
        uint32_t maxSym) const override;
    std::shared_ptr<DciInfoElementTdma> CreateUlDci(
        PointInFTPlane* spoint,
        const std::shared_ptr<NrMacSchedulerUeInfo>& ueInfo,
        uint32_t maxSym) const override;
 
    void ChangeDlBeam(PointInFTPlane* spoint, uint32_t symOfBeam) const override;
 
    void ChangeUlBeam(PointInFTPlane* spoint, uint32_t symOfBeam) const override;
 
    NrMacSchedulerOfdma::BeamSymbolMap GetSymPerBeam(uint32_t symAvail,
                                                     const ActiveUeMap& activeDl) const;
 
    uint8_t GetTpc() const override;
 
    enum class SymPerBeamType
    {
        LOAD_BASED, 
        ROUND_ROBIN, 
        PROPORTIONAL_FAIR 
    };
 
  private:
    std::vector<bool> CreateRbgBitmaskFromAllocatedRbgs(
        const std::vector<uint16_t>& allocatedRbgs) const;
 
    bool AdvanceToNextUeToSchedule(std::vector<UePtrAndBufferReq>::iterator& schedInfoIt,
                                   const std::vector<UePtrAndBufferReq>::iterator end,
                                   uint32_t resourcesAssignable) const;
    bool ShouldScheduleUeBasedOnFronthaul(
        const std::vector<UePtrAndBufferReq>::iterator& schedInfoIt,
        uint32_t resourcesAssignable) const;
 
    void DeallocateResourcesDueToFronthaulConstraint(const std::vector<UePtrAndBufferReq>& ueVector,
                                                     const uint32_t& beamSym,
                                                     FTResources& assignedResources,
                                                     std::vector<bool>& availableRbgs) const;
    static void AllocateCurrentResourceToUe(std::shared_ptr<NrMacSchedulerUeInfo> currentUe,
                                            const uint32_t& currentRbg,
                                            const uint32_t beamSym,
                                            FTResources& assignedResources,
                                            std::vector<bool>& availableRbgs);
    static void DeallocateCurrentResourceFromUe(std::shared_ptr<NrMacSchedulerUeInfo> currentUe,
                                                const uint32_t& currentRbg,
                                                const uint32_t beamSym,
                                                FTResources& assignedResources,
                                                std::vector<bool>& availableRbgs);
    bool AttemptAllocationOfCurrentResourceToUe(
        std::vector<UePtrAndBufferReq>::iterator schedInfoIt,
        std::set<uint32_t>& remainingRbgSet,
        const uint32_t beamSym,
        FTResources& assignedResources,
        std::vector<bool>& availableRbgs) const;
 
    void SetSymPerBeamType(SymPerBeamType type);
    TracedValue<uint32_t>
        m_tracedValueSymPerBeam; 
 
    SymPerBeamType m_symPerBeamType; 
    Ptr<NrMacSchedulerOfdmaSymbolPerBeam> m_symPerBeam; 
    friend class NrSchedOfdmaSymbolPerBeamTestCase;
};
} // namespace ns3