LteScheduler.h Source File¶

Simu5G: LteScheduler.h Source File
Simu5G
//
//                  Simu5G
//
// Copyright (C) 2012-2021 Giovanni Nardini, Giovanni Stea, Antonio Virdis et al. (University of Pisa)
// Copyright (C) 2022-2026 Giovanni Nardini, Giovanni Stea et al. (University of Pisa)
//
// This file is part of a software released under the license included in file
// "license.pdf". Please read LICENSE and README files before using it.
// The above files and the present reference are part of the software itself,
// and cannot be removed from it.
//
 
#ifndef _LTE_LTESCHEDULER_H_
#define _LTE_LTESCHEDULER_H_
 
#include "simu5g/common/LteCommon.h"
#include "simu5g/stack/mac/LteMacEnb.h"
 
namespace simu5g {
 
using namespace omnetpp;
class LteSchedulerEnb;
template<typename T, typename S>
struct SortedDesc
{
    T x_;
    S score_;
    bool operator<(const SortedDesc& y) const
    {
        if (score_ < y.score_)
            return true;
        if (score_ == y.score_)
            return uniform(getEnvir()->getRNG(0), 0, 1) < 0.5;
        return false;
    }
 
  public:
    SortedDesc()
    {
    }
 
    SortedDesc(const T x, const S score) : x_(x), score_(score)
    {
    }
 
};
class LteScheduler
{
  protected:
    opp_component_ptr<LteMacEnb> mac_;
    opp_component_ptr<Binder> binder_;
    LteSchedulerEnb *eNbScheduler_ = nullptr;
    Direction direction_;
    ActiveSet *activeConnectionSet_ = nullptr;
    ActiveSet activeConnectionTempSet_;
    ActiveSet carrierActiveConnectionSet_;
    GHz carrierFrequency_;
    BandLimitVector bandLimit_;
    BandLimitVector slotRacBandLimit_;
    BandLimitVector slotRtxBandLimit_;
    BandLimitVector slotReqGrantBandLimit_;
    typedef std::list<MacCid> CidList;
    unsigned int numerologyIndex_;
    unsigned int maxSchedulingPeriodCounter_;
    unsigned int currentSchedulingPeriodCounter_;
 
  public:
    LteScheduler(Binder *binder) : binder_(binder)
    {
    }
    virtual ~LteScheduler()
    {
    }
    virtual void setEnbScheduler(LteSchedulerEnb *eNbScheduler);
    virtual void setCarrierFrequency(GHz carrierFrequency);
 
    /*
     * Initializes band limit for this scheduler
     */
    virtual void initializeBandLimit();
 
    /*
     * Set the period counter
     */
    virtual void initializeSchedulerPeriodCounter(NumerologyIndex maxNumerologyIndex);
 
    /*
     * Handle the period counter
     */
    virtual unsigned int decreaseSchedulerPeriodCounter();
    GHz getCarrierFrequency() { return carrierFrequency_; };
    void setNumerologyIndex(unsigned int numerologyIndex) { numerologyIndex_ = numerologyIndex; }
 
    // Scheduling functions ********************************************************************
 
    virtual void schedule();
 
    virtual void prepareSchedule()
    {
    }
 
    virtual void commitSchedule()
    {
    }
 
    // *****************************************************************************************
    virtual unsigned int requestGrant(MacCid cid, unsigned int bytes, bool& terminate, bool& active, bool& eligible, std::vector<BandLimit> *bandLim = nullptr);
    virtual unsigned int requestGrantBackground(MacCid bgCid, unsigned int bytes, bool& terminate, bool& active, bool& eligible, std::vector<BandLimit> *bandLim = nullptr);
    virtual bool scheduleRetransmissions();
    virtual bool scheduleRacRequests();
 
    virtual void notifyActiveConnection(MacCid activeCid)
    {
    }
 
    virtual void updateSchedulingInfo()
    {
    }
 
  protected:
 
    /*
     * Prepare the set of active connections on this carrier
     * Used by scheduling modules
     */
    virtual void buildCarrierActiveConnectionSet();
 
};
 
} //namespace
 
#endif // _LTE_LTESCHEDULER_H_