A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::FdTbfqFfMacScheduler Class Reference

Implements the SCHED SAP and CSCHED SAP for a Frequency Domain Token Bank Fair Queue scheduler. More...

#include <fdtbfq-ff-mac-scheduler.h>

+ Inheritance diagram for ns3::FdTbfqFfMacScheduler:
+ Collaboration diagram for ns3::FdTbfqFfMacScheduler:

Public Member Functions

 FdTbfqFfMacScheduler ()
 Constructor.
virtual ~FdTbfqFfMacScheduler ()
virtual void DoDispose (void)
virtual FfMacCschedSapProviderGetFfMacCschedSapProvider ()
virtual FfMacSchedSapProviderGetFfMacSchedSapProvider ()
virtual void SetFfMacCschedSapUser (FfMacCschedSapUser *s)
virtual void SetFfMacSchedSapUser (FfMacSchedSapUser *s)
void TransmissionModeConfigurationUpdate (uint16_t rnti, uint8_t txMode)
- Public Member Functions inherited from ns3::FfMacScheduler
 FfMacScheduler ()
virtual ~FfMacScheduler ()
- Public Member Functions inherited from ns3::Object
 Object ()
virtual ~Object ()
void AggregateObject (Ptr< Object > other)
void Dispose (void)
AggregateIterator GetAggregateIterator (void) const
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 SimpleRefCount (const SimpleRefCount &o)
uint32_t GetReferenceCount (void) const
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions

static TypeId GetTypeId (void)

Private Member Functions

void DoCschedCellConfigReq (const struct FfMacCschedSapProvider::CschedCellConfigReqParameters &params)
void DoCschedLcConfigReq (const struct FfMacCschedSapProvider::CschedLcConfigReqParameters &params)
void DoCschedLcReleaseReq (const struct FfMacCschedSapProvider::CschedLcReleaseReqParameters &params)
void DoCschedUeConfigReq (const struct FfMacCschedSapProvider::CschedUeConfigReqParameters &params)
void DoCschedUeReleaseReq (const struct FfMacCschedSapProvider::CschedUeReleaseReqParameters &params)
void DoSchedDlCqiInfoReq (const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
void DoSchedDlMacBufferReq (const struct FfMacSchedSapProvider::SchedDlMacBufferReqParameters &params)
void DoSchedDlPagingBufferReq (const struct FfMacSchedSapProvider::SchedDlPagingBufferReqParameters &params)
void DoSchedDlRachInfoReq (const struct FfMacSchedSapProvider::SchedDlRachInfoReqParameters &params)
void DoSchedDlRlcBufferReq (const struct FfMacSchedSapProvider::SchedDlRlcBufferReqParameters &params)
void DoSchedDlTriggerReq (const struct FfMacSchedSapProvider::SchedDlTriggerReqParameters &params)
void DoSchedUlCqiInfoReq (const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)
void DoSchedUlMacCtrlInfoReq (const struct FfMacSchedSapProvider::SchedUlMacCtrlInfoReqParameters &params)
void DoSchedUlNoiseInterferenceReq (const struct FfMacSchedSapProvider::SchedUlNoiseInterferenceReqParameters &params)
void DoSchedUlSrInfoReq (const struct FfMacSchedSapProvider::SchedUlSrInfoReqParameters &params)
void DoSchedUlTriggerReq (const struct FfMacSchedSapProvider::SchedUlTriggerReqParameters &params)
double EstimateUlSinr (uint16_t rnti, uint16_t rb)
int GetRbgSize (int dlbandwidth)
int LcActivePerFlow (uint16_t rnti)
void RefreshDlCqiMaps (void)
void RefreshUlCqiMaps (void)
void UpdateDlRlcBufferInfo (uint16_t rnti, uint8_t lcid, uint16_t size)
void UpdateUlRlcBufferInfo (uint16_t rnti, uint16_t size)

Private Attributes

uint64_t bankSize
std::map< uint16_t,
SbMeasResult_s
m_a30CqiRxed
std::map< uint16_t, uint32_t > m_a30CqiTimers
std::map< uint16_t,
std::vector< uint16_t > > 
m_allocationMaps
Ptr< LteAmcm_amc
std::map< uint16_t, uint32_t > m_ceBsrRxed
uint32_t m_cqiTimersThreshold
uint32_t m_creditableThreshold
uint32_t m_creditLimit
FfMacCschedSapProvider::CschedCellConfigReqParameters m_cschedCellConfig
FfMacCschedSapProviderm_cschedSapProvider
FfMacCschedSapUserm_cschedSapUser
int m_debtLimit
std::map< uint16_t,
fdtbfqsFlowPerf_t
m_flowStatsDl
std::map< uint16_t,
fdtbfqsFlowPerf_t
m_flowStatsUl
uint16_t m_nextRntiUl
std::map< uint16_t, uint8_t > m_p10CqiRxed
std::map< uint16_t, uint32_t > m_p10CqiTimers
std::map< LteFlowId_t,
FfMacSchedSapProvider::SchedDlRlcBufferReqParameters
m_rlcBufferReq
FfMacSchedSapProviderm_schedSapProvider
FfMacSchedSapUserm_schedSapUser
double m_timeWindow
uint32_t m_tokenPoolSize
std::map< uint16_t,
std::vector< double > > 
m_ueCqi
std::map< uint16_t, uint32_t > m_ueCqiTimers
std::map< uint16_t, uint8_t > m_uesTxMode

Friends

class FdTbfqSchedulerMemberCschedSapProvider
class FdTbfqSchedulerMemberSchedSapProvider

Additional Inherited Members

- Public Types inherited from ns3::FfMacScheduler
enum  UlCqiFilter_t { SRS_UL_CQI, PUSCH_UL_CQI, ALL_UL_CQI }
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
virtual void DoStart (void)
virtual void NotifyNewAggregate (void)
- Protected Attributes inherited from ns3::FfMacScheduler
UlCqiFilter_t m_ulCqiFilter

Detailed Description

Implements the SCHED SAP and CSCHED SAP for a Frequency Domain Token Bank Fair Queue scheduler.

This class implements the interface defined by the FfMacScheduler abstract class

Config Paths

ns3::FdTbfqFfMacScheduler is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/FfMacScheduler/$ns3::FdTbfqFfMacScheduler
  • /NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/FfMacScheduler/$ns3::FdTbfqFfMacScheduler

Attributes

  • CqiTimerThreshold: The number of TTIs a CQI is valid (default 1000 - 1 sec.)
  • DebtLimit: Flow debt limit (default -625000 bytes)
    • Set with class: ns3::IntegerValue
    • Underlying type: int32_t -2147483648:2147483647
    • Initial value: -625000
    • Flags: construct write read
  • CreditLimit: Flow credit limit (default 625000 bytes)
  • TokenPoolSize: The maximum value of flow token pool (default 1 bytes)
  • CreditableThreshold: Threshold of flow credit (default 0 bytes)

Attributes defined in parent class ns3::FfMacScheduler

  • UlCqiFilter: The filter to apply on UL CQIs received
    • Set with class: ns3::EnumValue
    • Underlying type: SRS_UL_CQI|PUSCH_UL_CQI|ALL_UL_CQI
    • Initial value: ALL_UL_CQI
    • Flags: construct write read

No TraceSources are defined for this type.

Definition at line 61 of file fdtbfq-ff-mac-scheduler.h.

Constructor & Destructor Documentation

ns3::FdTbfqFfMacScheduler::FdTbfqFfMacScheduler ( )

Constructor.

Creates the MAC Scheduler interface implementation

Definition at line 214 of file fdtbfq-ff-mac-scheduler.cc.

References FdTbfqSchedulerMemberCschedSapProvider, FdTbfqSchedulerMemberSchedSapProvider, m_amc, m_cschedSapProvider, and m_schedSapProvider.

ns3::FdTbfqFfMacScheduler::~FdTbfqFfMacScheduler ( )
virtual

Destructor

Definition at line 226 of file fdtbfq-ff-mac-scheduler.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::FdTbfqFfMacScheduler::DoCschedCellConfigReq ( const struct FfMacCschedSapProvider::CschedCellConfigReqParameters params)
private
void ns3::FdTbfqFfMacScheduler::DoCschedLcReleaseReq ( const struct FfMacCschedSapProvider::CschedLcReleaseReqParameters params)
private

Definition at line 377 of file fdtbfq-ff-mac-scheduler.cc.

References NS_FATAL_ERROR.

Referenced by ns3::FdTbfqSchedulerMemberCschedSapProvider::CschedLcReleaseReq().

+ Here is the caller graph for this function:

void ns3::FdTbfqFfMacScheduler::DoCschedUeReleaseReq ( const struct FfMacCschedSapProvider::CschedUeReleaseReqParameters params)
private

Definition at line 384 of file fdtbfq-ff-mac-scheduler.cc.

References NS_FATAL_ERROR.

Referenced by ns3::FdTbfqSchedulerMemberCschedSapProvider::CschedUeReleaseReq().

+ Here is the caller graph for this function:

void ns3::FdTbfqFfMacScheduler::DoDispose ( void  )
virtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::FfMacScheduler.

Definition at line 232 of file fdtbfq-ff-mac-scheduler.cc.

References m_cschedSapProvider, m_schedSapProvider, and NS_LOG_FUNCTION.

void ns3::FdTbfqFfMacScheduler::DoSchedDlMacBufferReq ( const struct FfMacSchedSapProvider::SchedDlMacBufferReqParameters params)
private

Definition at line 423 of file fdtbfq-ff-mac-scheduler.cc.

References NS_FATAL_ERROR.

Referenced by ns3::FdTbfqSchedulerMemberSchedSapProvider::SchedDlMacBufferReq().

+ Here is the caller graph for this function:

void ns3::FdTbfqFfMacScheduler::DoSchedDlPagingBufferReq ( const struct FfMacSchedSapProvider::SchedDlPagingBufferReqParameters params)
private

Definition at line 416 of file fdtbfq-ff-mac-scheduler.cc.

References NS_FATAL_ERROR.

Referenced by ns3::FdTbfqSchedulerMemberSchedSapProvider::SchedDlPagingBufferReq().

+ Here is the caller graph for this function:

void ns3::FdTbfqFfMacScheduler::DoSchedDlRachInfoReq ( const struct FfMacSchedSapProvider::SchedDlRachInfoReqParameters params)
private

Definition at line 894 of file fdtbfq-ff-mac-scheduler.cc.

References NS_FATAL_ERROR.

Referenced by ns3::FdTbfqSchedulerMemberSchedSapProvider::SchedDlRachInfoReq().

+ Here is the caller graph for this function:

void ns3::FdTbfqFfMacScheduler::DoSchedUlMacCtrlInfoReq ( const struct FfMacSchedSapProvider::SchedUlMacCtrlInfoReqParameters params)
private
void ns3::FdTbfqFfMacScheduler::DoSchedUlNoiseInterferenceReq ( const struct FfMacSchedSapProvider::SchedUlNoiseInterferenceReqParameters params)
private

Definition at line 1150 of file fdtbfq-ff-mac-scheduler.cc.

References NS_FATAL_ERROR.

Referenced by ns3::FdTbfqSchedulerMemberSchedSapProvider::SchedUlNoiseInterferenceReq().

+ Here is the caller graph for this function:

void ns3::FdTbfqFfMacScheduler::DoSchedUlSrInfoReq ( const struct FfMacSchedSapProvider::SchedUlSrInfoReqParameters params)
private

Definition at line 1157 of file fdtbfq-ff-mac-scheduler.cc.

References NS_FATAL_ERROR.

Referenced by ns3::FdTbfqSchedulerMemberSchedSapProvider::SchedUlSrInfoReq().

+ Here is the caller graph for this function:

void ns3::FdTbfqFfMacScheduler::DoSchedUlTriggerReq ( const struct FfMacSchedSapProvider::SchedUlTriggerReqParameters params)
private
double ns3::FdTbfqFfMacScheduler::EstimateUlSinr ( uint16_t  rnti,
uint16_t  rb 
)
private

Definition at line 962 of file fdtbfq-ff-mac-scheduler.cc.

References m_cschedCellConfig, m_ueCqi, ns3::FfMacCschedSapProvider::CschedCellConfigReqParameters::m_ulBandwidth, and NO_SINR.

Referenced by DoSchedUlTriggerReq().

+ Here is the caller graph for this function:

FfMacCschedSapProvider * ns3::FdTbfqFfMacScheduler::GetFfMacCschedSapProvider ( )
virtual
Returns
the Provider part of the FfMacCschedSap provided by the Scheduler

Implements ns3::FfMacScheduler.

Definition at line 289 of file fdtbfq-ff-mac-scheduler.cc.

References m_cschedSapProvider.

FfMacSchedSapProvider * ns3::FdTbfqFfMacScheduler::GetFfMacSchedSapProvider ( )
virtual
Returns
the Provider part of the FfMacSchedSap provided by the Scheduler

Implements ns3::FfMacScheduler.

Definition at line 295 of file fdtbfq-ff-mac-scheduler.cc.

References m_schedSapProvider.

int ns3::FdTbfqFfMacScheduler::GetRbgSize ( int  dlbandwidth)
private

Definition at line 430 of file fdtbfq-ff-mac-scheduler.cc.

References ns3::FdTbfqType0AllocationRbg.

Referenced by DoSchedDlTriggerReq().

+ Here is the caller graph for this function:

TypeId ns3::FdTbfqFfMacScheduler::GetTypeId ( void  )
static

Reimplemented from ns3::FfMacScheduler.

Definition at line 240 of file fdtbfq-ff-mac-scheduler.cc.

References m_cqiTimersThreshold, m_creditableThreshold, m_creditLimit, m_debtLimit, m_tokenPoolSize, and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

int ns3::FdTbfqFfMacScheduler::LcActivePerFlow ( uint16_t  rnti)
private

Definition at line 445 of file fdtbfq-ff-mac-scheduler.cc.

References m_rlcBufferReq.

Referenced by DoSchedDlTriggerReq().

+ Here is the caller graph for this function:

void ns3::FdTbfqFfMacScheduler::RefreshDlCqiMaps ( void  )
private

Definition at line 1346 of file fdtbfq-ff-mac-scheduler.cc.

References m_a30CqiRxed, m_a30CqiTimers, m_p10CqiRxed, m_p10CqiTimers, NS_ASSERT_MSG, and NS_LOG_INFO.

Referenced by DoSchedDlTriggerReq().

+ Here is the caller graph for this function:

void ns3::FdTbfqFfMacScheduler::RefreshUlCqiMaps ( void  )
private

Definition at line 1399 of file fdtbfq-ff-mac-scheduler.cc.

References m_ueCqi, m_ueCqiTimers, NS_ASSERT_MSG, and NS_LOG_INFO.

Referenced by DoSchedUlTriggerReq().

+ Here is the caller graph for this function:

void ns3::FdTbfqFfMacScheduler::SetFfMacCschedSapUser ( FfMacCschedSapUser s)
virtual

set the user part of the FfMacCschedSap that this Scheduler will interact with. Normally this part of the SAP is exported by the MAC.

Parameters
s

Implements ns3::FfMacScheduler.

Definition at line 277 of file fdtbfq-ff-mac-scheduler.cc.

References m_cschedSapUser.

void ns3::FdTbfqFfMacScheduler::SetFfMacSchedSapUser ( FfMacSchedSapUser s)
virtual

set the user part of the FfMacSchedSap that this Scheduler will interact with. Normally this part of the SAP is exported by the MAC.

Parameters
s

Implements ns3::FfMacScheduler.

Definition at line 283 of file fdtbfq-ff-mac-scheduler.cc.

References m_schedSapUser.

void ns3::FdTbfqFfMacScheduler::TransmissionModeConfigurationUpdate ( uint16_t  rnti,
uint8_t  txMode 
)
void ns3::FdTbfqFfMacScheduler::UpdateDlRlcBufferInfo ( uint16_t  rnti,
uint8_t  lcid,
uint16_t  size 
)
private

Definition at line 1429 of file fdtbfq-ff-mac-scheduler.cc.

References m_rlcBufferReq, and NS_LOG_ERROR.

Referenced by DoSchedDlTriggerReq().

+ Here is the caller graph for this function:

void ns3::FdTbfqFfMacScheduler::UpdateUlRlcBufferInfo ( uint16_t  rnti,
uint16_t  size 
)
private

Definition at line 1479 of file fdtbfq-ff-mac-scheduler.cc.

References m_ceBsrRxed, and NS_LOG_ERROR.

Referenced by DoSchedUlTriggerReq().

+ Here is the caller graph for this function:

Friends And Related Function Documentation

Definition at line 86 of file fdtbfq-ff-mac-scheduler.h.

Referenced by FdTbfqFfMacScheduler().

Definition at line 87 of file fdtbfq-ff-mac-scheduler.h.

Referenced by FdTbfqFfMacScheduler().

Member Data Documentation

uint64_t ns3::FdTbfqFfMacScheduler::bankSize
private

Definition at line 222 of file fdtbfq-ff-mac-scheduler.h.

Referenced by DoSchedDlTriggerReq().

std::map<uint16_t,SbMeasResult_s> ns3::FdTbfqFfMacScheduler::m_a30CqiRxed
private
std::map<uint16_t,uint32_t> ns3::FdTbfqFfMacScheduler::m_a30CqiTimers
private

Definition at line 181 of file fdtbfq-ff-mac-scheduler.h.

Referenced by DoSchedDlCqiInfoReq(), and RefreshDlCqiMaps().

std::map<uint16_t, std::vector <uint16_t> > ns3::FdTbfqFfMacScheduler::m_allocationMaps
private

Definition at line 187 of file fdtbfq-ff-mac-scheduler.h.

Referenced by DoSchedUlCqiInfoReq(), and DoSchedUlTriggerReq().

Ptr<LteAmc> ns3::FdTbfqFfMacScheduler::m_amc
private
std::map<uint16_t,uint32_t> ns3::FdTbfqFfMacScheduler::m_ceBsrRxed
private
uint32_t ns3::FdTbfqFfMacScheduler::m_cqiTimersThreshold
private

Definition at line 218 of file fdtbfq-ff-mac-scheduler.h.

Referenced by DoSchedDlCqiInfoReq(), DoSchedUlCqiInfoReq(), and GetTypeId().

uint32_t ns3::FdTbfqFfMacScheduler::m_creditableThreshold
private

Definition at line 230 of file fdtbfq-ff-mac-scheduler.h.

Referenced by DoCschedLcConfigReq(), and GetTypeId().

uint32_t ns3::FdTbfqFfMacScheduler::m_creditLimit
private

Definition at line 226 of file fdtbfq-ff-mac-scheduler.h.

Referenced by DoCschedLcConfigReq(), and GetTypeId().

FfMacCschedSapProvider* ns3::FdTbfqFfMacScheduler::m_cschedSapProvider
private
FfMacCschedSapUser* ns3::FdTbfqFfMacScheduler::m_cschedSapUser
private
int ns3::FdTbfqFfMacScheduler::m_debtLimit
private

Definition at line 224 of file fdtbfq-ff-mac-scheduler.h.

Referenced by DoCschedLcConfigReq(), and GetTypeId().

std::map<uint16_t, fdtbfqsFlowPerf_t> ns3::FdTbfqFfMacScheduler::m_flowStatsDl
private

Definition at line 157 of file fdtbfq-ff-mac-scheduler.h.

Referenced by DoCschedLcConfigReq(), and DoSchedDlTriggerReq().

std::map<uint16_t, fdtbfqsFlowPerf_t> ns3::FdTbfqFfMacScheduler::m_flowStatsUl
private

Definition at line 162 of file fdtbfq-ff-mac-scheduler.h.

Referenced by DoCschedLcConfigReq().

uint16_t ns3::FdTbfqFfMacScheduler::m_nextRntiUl
private

Definition at line 216 of file fdtbfq-ff-mac-scheduler.h.

Referenced by DoSchedUlTriggerReq().

std::map<uint16_t,uint8_t> ns3::FdTbfqFfMacScheduler::m_p10CqiRxed
private

Definition at line 168 of file fdtbfq-ff-mac-scheduler.h.

Referenced by DoSchedDlCqiInfoReq(), and RefreshDlCqiMaps().

std::map<uint16_t,uint32_t> ns3::FdTbfqFfMacScheduler::m_p10CqiTimers
private

Definition at line 172 of file fdtbfq-ff-mac-scheduler.h.

Referenced by DoSchedDlCqiInfoReq(), and RefreshDlCqiMaps().

std::map<LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters> ns3::FdTbfqFfMacScheduler::m_rlcBufferReq
private
FfMacSchedSapProvider* ns3::FdTbfqFfMacScheduler::m_schedSapProvider
private
FfMacSchedSapUser* ns3::FdTbfqFfMacScheduler::m_schedSapUser
private
double ns3::FdTbfqFfMacScheduler::m_timeWindow
private

Definition at line 214 of file fdtbfq-ff-mac-scheduler.h.

uint32_t ns3::FdTbfqFfMacScheduler::m_tokenPoolSize
private

Definition at line 228 of file fdtbfq-ff-mac-scheduler.h.

Referenced by DoCschedLcConfigReq(), and GetTypeId().

std::map<uint16_t, std::vector <double> > ns3::FdTbfqFfMacScheduler::m_ueCqi
private
std::map<uint16_t, uint32_t> ns3::FdTbfqFfMacScheduler::m_ueCqiTimers
private

Definition at line 196 of file fdtbfq-ff-mac-scheduler.h.

Referenced by DoSchedUlCqiInfoReq(), and RefreshUlCqiMaps().

std::map<uint16_t,uint8_t> ns3::FdTbfqFfMacScheduler::m_uesTxMode
private

Definition at line 220 of file fdtbfq-ff-mac-scheduler.h.

Referenced by DoCschedUeConfigReq(), and DoSchedDlTriggerReq().


The documentation for this class was generated from the following files: