nr-mac-scheduler-ue-info.h

// Copyright (c) 2019 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
 
#pragma once
 
#include "beam-id.h"
#include "nr-amc.h"
#include "nr-mac-harq-vector.h"
#include "nr-mac-sched-sap.h"
#include "nr-mac-scheduler-lcg.h"
 
#include "ns3/matrix-array.h"
 
#include <functional>
#include <optional>
#include <unordered_map>
 
namespace ns3
{
 
class NrMacSchedulerUeInfo;
typedef std::shared_ptr<NrMacSchedulerUeInfo> UePtr;
 
class NrMacSchedulerUeInfo
{
  public:
    NrMacSchedulerUeInfo() = delete;
 
    typedef std::function<uint32_t()> GetRbPerRbgFn;
 
    NrMacSchedulerUeInfo(uint16_t rnti, BeamId beamId, const GetRbPerRbgFn& fn);
 
    virtual ~NrMacSchedulerUeInfo();
 
    static std::vector<uint16_t>& GetDlRBG(const UePtr& ue);
    static std::vector<uint16_t>& GetUlRBG(const UePtr& ue);
    static std::vector<uint8_t>& GetDlSym(const UePtr& ue);
    static std::vector<uint8_t>& GetUlSym(const UePtr& ue);
 
    enum class McsCsiSource
    {
        AVG_MCS,      
        AVG_SPEC_EFF, 
        AVG_SINR,     
        WIDEBAND_MCS  
    };
    uint8_t GetDlMcs() const;
    static uint8_t& GetDlMcs(const UePtr& ue);
    static uint8_t& GetUlMcs(const UePtr& ue);
    static uint32_t& GetDlTBS(const UePtr& ue);
 
    static uint32_t& GetUlTBS(const UePtr& ue)
    {
        return ue->m_ulTbSize;
    }
 
    static std::unordered_map<uint8_t, LCGPtr>& GetDlLCG(const UePtr& ue);
    static std::unordered_map<uint8_t, LCGPtr>& GetUlLCG(const UePtr& ue);
    static NrMacHarqVector& GetDlHarqVector(const UePtr& ue);
    static NrMacHarqVector& GetUlHarqVector(const UePtr& ue);
 
    static void PrintLcInfo(uint16_t ue,
                            uint8_t lcgId,
                            uint8_t lcId,
                            uint8_t cqi,
                            uint8_t P,
                            uint8_t minP);
 
    typedef std::function<std::unordered_map<uint8_t, LCGPtr>&(const UePtr& ue)> GetLCGFn;
    typedef std::function<NrMacHarqVector&(const UePtr& ue)> GetHarqVectorFn;
 
    virtual void ResetDlSchedInfo();
 
    virtual void ResetUlSchedInfo();
 
    virtual void UpdateDlMetric();
 
    virtual void ResetDlMetric();
 
    virtual void UpdateUlMetric();
 
    virtual void ResetUlMetric();
 
    uint32_t GetTotalDlBuffer() const;
 
    struct CqiInfo
    {
        enum CqiType
        {
            WB,          
            SB           
        } m_cqiType{WB}; 
 
        std::vector<double> m_sinr;   
        uint8_t m_wbCqi{0};           
        std::vector<uint8_t> m_sbCqi; 
        uint32_t m_timer{0};          
    };
 
    void ReleaseLC(uint8_t lcid);
 
    uint16_t m_rnti{0}; 
    BeamId m_beamId;    
 
    std::unordered_map<uint8_t, LCGPtr> m_dlLCG; 
    std::unordered_map<uint8_t, LCGPtr> m_ulLCG; 
 
    uint32_t m_dlMRBRetx{0};       
    uint32_t m_ulMRBRetx{0};       
    std::vector<uint16_t> m_dlRBG; 
    std::vector<uint16_t> m_ulRBG; 
    std::vector<uint8_t> m_dlSym;  
    std::vector<uint8_t> m_ulSym;  
 
    uint8_t m_dlMcs{0}; 
    std::optional<uint8_t>
        m_fhMaxMcsAssignable; 
    uint8_t m_ulMcs{0};       
 
    struct SbMcsInfo
    {
        uint8_t cqi;
        uint8_t mcs;
        float specEff;
        float sinr;
    };
 
    std::vector<SbMcsInfo> m_dlSbMcsInfo; 
    std::vector<uint8_t> m_rbgToSb;       
 
    uint32_t m_dlTbSize{0}; 
    uint32_t m_ulTbSize{0}; 
    uint8_t m_dlRank{1};    
    uint8_t m_ulRank{1};    
    Ptr<const ComplexMatrixArray> m_dlPrecMats{nullptr}; 
    Ptr<const ComplexMatrixArray> m_ulPrecMats{nullptr}; 
 
    CqiInfo m_dlCqi; 
    CqiInfo m_ulCqi; 
 
    NrMacHarqVector m_dlHarq; 
    NrMacHarqVector m_ulHarq; 
 
    uint32_t m_srsPeriodicity{0}; 
    uint32_t m_srsOffset{0};      
    uint8_t m_startMcsDlUe{0};    
 
    // Settings from the scheduler, that affects MCS, TBS and throughput computation
    Ptr<NrAmc> m_dlAmc;          
    Ptr<NrAmc> m_ulAmc;          
    McsCsiSource m_mcsCsiSource; 
 
  protected:
    uint32_t GetNumRbPerRbg() const;
 
  private:
    const GetRbPerRbgFn m_getNumRbPerRbg; 
};
 
} // namespace ns3