nr-mac-scheduler-tdma.h

// Copyright (c) 2019 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
 
#pragma once
 
#include "nr-mac-scheduler-ns3.h"
 
#include <functional>
#include <memory>
 
namespace ns3
{
 
class NrMacSchedulerTdma : public NrMacSchedulerNs3
{
    friend class NrTestSchedulerAiCase;
 
  public:
    static TypeId GetTypeId();
 
    NrMacSchedulerTdma();
    ~NrMacSchedulerTdma() 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([[maybe_unused]] PointInFTPlane* spoint,
                      [[maybe_unused]] uint32_t symOfBeam) const override
    {
    }
 
    void ChangeUlBeam([[maybe_unused]] PointInFTPlane* spoint,
                      [[maybe_unused]] uint32_t symOfBeam) const override
    {
    }
 
    uint8_t GetTpc() const override;
 
    virtual std::function<bool(const NrMacSchedulerNs3::UePtrAndBufferReq& lhs,
                               const NrMacSchedulerNs3::UePtrAndBufferReq& rhs)>
    GetUeCompareDlFn() const = 0;
 
    virtual std::function<bool(const NrMacSchedulerNs3::UePtrAndBufferReq& lhs,
                               const NrMacSchedulerNs3::UePtrAndBufferReq& rhs)>
    GetUeCompareUlFn() const = 0;
 
    virtual void AssignedDlResources(const UePtrAndBufferReq& ue,
                                     const FTResources& assigned,
                                     const FTResources& totalAssigned) const = 0;
 
    virtual void AssignedUlResources(const UePtrAndBufferReq& ue,
                                     const FTResources& assigned,
                                     const FTResources& totalAssigned) const = 0;
 
    virtual void NotAssignedDlResources(const UePtrAndBufferReq& ue,
                                        const FTResources& notAssigned,
                                        const FTResources& totalAssigned) const = 0;
 
    virtual void NotAssignedUlResources(const UePtrAndBufferReq& ue,
                                        const FTResources& notAssigned,
                                        const FTResources& totalAssigned) const = 0;
 
    virtual void BeforeDlSched(const UePtrAndBufferReq& ue,
                               const FTResources& assignableInIteration) const = 0;
 
    virtual void BeforeUlSched(const UePtrAndBufferReq& ue,
                               const FTResources& assignableInIteration) const = 0;
 
    virtual void CallNotifyDlFn(const std::vector<UePtrAndBufferReq>& ueVector) const
    {
    }
 
    virtual void CallNotifyUlFn(const std::vector<UePtrAndBufferReq>& ueVector) const
    {
    }
 
  private:
    static std::vector<UePtrAndBufferReq> GetUeVectorFromActiveUeMap(const ActiveUeMap& activeUes);
 
  private:
    typedef std::function<void(const UePtrAndBufferReq&, const FTResources&)>
        BeforeSchedFn; 
    typedef std::function<void(const UePtrAndBufferReq&, const FTResources&, const FTResources&)>
        AfterSuccessfulAssignmentFn;
    typedef std::function<void(const UePtrAndBufferReq&, const FTResources&, const FTResources&)>
        AfterUnsuccessfulAssignmentFn;
    typedef std::function<std::vector<uint16_t>&(const UePtr& ue)>
        GetRBGFn;                                               
    typedef std::function<uint32_t&(const UePtr& ue)> GetTBSFn; 
    typedef std::function<std::vector<uint8_t>&(const UePtr& ue)>
        GetSymFn; 
    typedef std::function<bool(const NrMacSchedulerNs3::UePtrAndBufferReq& lhs,
                               const NrMacSchedulerNs3::UePtrAndBufferReq& rhs)>
        CompareUeFn;
    typedef std::function<CompareUeFn()> GetCompareUeFn;
    typedef std::function<void(std::vector<UePtrAndBufferReq>& ueVector)> CallNotifyFn;
 
    BeamSymbolMap AssignRBGTDMA(uint32_t symAvail,
                                const ActiveUeMap& activeUe,
                                const std::string& type,
                                const BeforeSchedFn& BeforeSchedFn,
                                const GetCompareUeFn& GetCompareFn,
                                const GetTBSFn& GetTBSFn,
                                const GetRBGFn& GetRBGFn,
                                const GetSymFn& GetSymFn,
                                const AfterSuccessfulAssignmentFn& SuccessfulAssignmentFn,
                                const AfterUnsuccessfulAssignmentFn& UnSuccessfulAssignmentFn,
                                const CallNotifyFn& callNotifyFn) const;
 
    std::shared_ptr<DciInfoElementTdma> CreateDci(
        PointInFTPlane* spoint,
        const std::shared_ptr<NrMacSchedulerUeInfo>& ueInfo,
        uint32_t tbs,
        DciInfoElementTdma::DciFormat fmt,
        uint32_t mcs,
        uint8_t rank,
        Ptr<const ComplexMatrixArray> precMats,
        uint8_t numSym) const;
};
 
} // namespace ns3