This class implements a simple uplink scheduler for rtPS flows. More...

#include "bs-uplink-scheduler-rtps.h"

Inheritance diagram for ns3::UplinkSchedulerRtps:

Collaboration diagram for ns3::UplinkSchedulerRtps:

Public Member Functions
	UplinkSchedulerRtps ()

	UplinkSchedulerRtps (Ptr< BaseStationNetDevice > bs)
	Constructor. More...

	~UplinkSchedulerRtps () override

void	AddUplinkAllocation (OfdmUlMapIe &ulMapIe, const uint32_t &allocationSize, uint32_t &symbolsToAllocation, uint32_t &availableSymbols) override
	Add Uplink Allocation function. More...

void	AllocateInitialRangingInterval (uint32_t &symbolsToAllocation, uint32_t &availableSymbols) override
	Allocate Initial Ranging Interval function. More...

uint32_t	CalculateAllocationStartTime () override
	Calculate allocation start time function. More...

void	GetChannelDescriptorsToUpdate (bool &updateDcd, bool &updateUcd, bool &sendDcd, bool &sendUcd) override
	Determines if channel descriptors sent in the current frame are required to be updated. More...

std::list< OfdmUlMapIe >	GetUplinkAllocations () const override
	Get uplink allocations. More...

void	InitOnce () override
	Init once function. More...

void	OnSetRequestedBandwidth (ServiceFlowRecord *sfr) override
	Set requested bandwidth function. More...

void	ProcessBandwidthRequest (const BandwidthRequestHeader &bwRequestHdr) override
	Process bandwidth request function. More...

void	Schedule () override
	Schedule function. More...

void	ServiceBandwidthRequests (const SSRecord *ssRecord, ServiceFlow::SchedulingType schedulingType, OfdmUlMapIe &ulMapIe, const WimaxPhy::ModulationType modulationType, uint32_t &symbolsToAllocation, uint32_t &availableSymbols) override
	Service Bandwidth Requests function. More...

bool	ServiceBandwidthRequests (ServiceFlow *serviceFlow, ServiceFlow::SchedulingType schedulingType, OfdmUlMapIe &ulMapIe, const WimaxPhy::ModulationType modulationType, uint32_t &symbolsToAllocation, uint32_t &availableSymbols) override
	Service bandwidth requests function. More...

void	ServiceUnsolicitedGrants (const SSRecord *ssRecord, ServiceFlow::SchedulingType schedulingType, OfdmUlMapIe &ulMapIe, const WimaxPhy::ModulationType modulationType, uint32_t &symbolsToAllocation, uint32_t &availableSymbols) override
	Service Unsolicited Grants function. More...

void	SetupServiceFlow (SSRecord ssRecord, ServiceFlow serviceFlow) override
	Setup service flow function. More...

void	ULSchedulerRTPSConnection (uint32_t &symbolsToAllocation, uint32_t &availableSymbols)
	Uplink Scheduler for rtPS connections. More...

Public Member Functions inherited from ns3::UplinkScheduler
	UplinkScheduler ()

	UplinkScheduler (Ptr< BaseStationNetDevice > bs)
	Constructor. More...

	~UplinkScheduler () override

virtual Ptr< BaseStationNetDevice >	GetBs ()

virtual Time	GetDcdTimeStamp () const

virtual bool	GetIsInvIrIntrvlAllocated () const

virtual bool	GetIsIrIntrvlAllocated () const

virtual uint8_t	GetNrIrOppsAllocated () const

virtual Time	GetTimeStampIrInterval ()

virtual Time	GetUcdTimeStamp () const

virtual void	SetBs (Ptr< BaseStationNetDevice > bs)
	Set base station device. More...

virtual void	SetDcdTimeStamp (Time dcdTimeStamp)
	Set DCD timestamp. More...

virtual void	SetIsInvIrIntrvlAllocated (bool isInvIrIntrvlAllocated)
	Set if the Inv IR interval is allocated. More...

virtual void	SetIsIrIntrvlAllocated (bool isIrIntrvlAllocated)
	Set if the IR interval is allocated. More...

virtual void	SetNrIrOppsAllocated (uint8_t nrIrOppsAllocated)
	Set the number of IR opps allocated. More...

virtual void	SetTimeStampIrInterval (Time timeStampIrInterval)
	Set timestamp IR interval. More...

virtual void	SetUcdTimeStamp (Time ucdTimeStamp)
	Set UCD timestamp. More...

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor. More...

	~Object () override
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose ()
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one. More...

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object. More...

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object. More...

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object. More...

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized () const
	Check if the object has been initialized. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

uint32_t	GetReferenceCount () const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o[[maybe_unused]])
	Assignment operator. More...

void	Ref () const
	Increment the reference count. More...

void	Unref () const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID. More...

Static Public Member Functions inherited from ns3::UplinkScheduler
static TypeId	GetTypeId ()
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID. More...

Private Attributes
std::list< OfdmUlMapIe >	m_uplinkAllocations
	uplink allocations More...

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	DoDispose ()
	Destructor implementation. More...

virtual void	DoInitialize ()
	Initialize() implementation. More...

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

This class implements a simple uplink scheduler for rtPS flows.

The UL-rtPS-Scheduler work in this way: At the beginning of the UL sub-frame some symbols are allocated to the rangingInterval Messages, DSA Messages, UGS grants and UGS/rtPS/nrtPS/BE poll. Then, the remaining available symbols are allocated to the all rtPS flows according to their requestedBandwidth. The bandwidth saturation control has been implemented to redistribute the resource if the sum of requestedBandwidth exceed the available bandwidth. At the end, if there are some free symbols, their are allocated to nrtPS and BE Connections.

Definition at line 55 of file bs-uplink-scheduler-rtps.h.

Constructor & Destructor Documentation

◆ UplinkSchedulerRtps() [1/2]

ns3::UplinkSchedulerRtps::UplinkSchedulerRtps ( )

Definition at line 44 of file bs-uplink-scheduler-rtps.cc.

References ns3::Simulator::Now(), ns3::Seconds(), ns3::UplinkScheduler::SetBs(), ns3::UplinkScheduler::SetDcdTimeStamp(), ns3::UplinkScheduler::SetIsInvIrIntrvlAllocated(), ns3::UplinkScheduler::SetIsIrIntrvlAllocated(), ns3::UplinkScheduler::SetNrIrOppsAllocated(), ns3::UplinkScheduler::SetTimeStampIrInterval(), and ns3::UplinkScheduler::SetUcdTimeStamp().

Here is the call graph for this function:

◆ UplinkSchedulerRtps() [2/2]

ns3::UplinkSchedulerRtps::UplinkSchedulerRtps ( Ptr< BaseStationNetDevice > bs )

Constructor.

Parameters

bs	base station device

Definition at line 55 of file bs-uplink-scheduler-rtps.cc.

References ns3::Simulator::Now(), ns3::Seconds(), ns3::UplinkScheduler::SetBs(), ns3::UplinkScheduler::SetDcdTimeStamp(), ns3::UplinkScheduler::SetIsInvIrIntrvlAllocated(), ns3::UplinkScheduler::SetIsIrIntrvlAllocated(), ns3::UplinkScheduler::SetNrIrOppsAllocated(), ns3::UplinkScheduler::SetTimeStampIrInterval(), and ns3::UplinkScheduler::SetUcdTimeStamp().

Here is the call graph for this function:

◆ ~UplinkSchedulerRtps()

ns3::UplinkSchedulerRtps::~UplinkSchedulerRtps ( )

override

Definition at line 66 of file bs-uplink-scheduler-rtps.cc.

References m_uplinkAllocations, and ns3::UplinkScheduler::SetBs().

Here is the call graph for this function:

Member Function Documentation

◆ AddUplinkAllocation()

void ns3::UplinkSchedulerRtps::AddUplinkAllocation	(	OfdmUlMapIe &	ulMapIe,
		const uint32_t &	allocationSize,
		uint32_t &	symbolsToAllocation,
		uint32_t &	availableSymbols
	)

overridevirtual

Add Uplink Allocation function.

Parameters

ulMapIe	the UL map IE
allocationSize	the allocation size
symbolsToAllocation	the symbols to allocation
availableSymbols	the available symbols

Implements ns3::UplinkScheduler.

Definition at line 154 of file bs-uplink-scheduler-rtps.cc.

References m_uplinkAllocations, ns3::OfdmUlMapIe::SetDuration(), and ns3::OfdmUlMapIe::SetStartTime().

Referenced by AllocateInitialRangingInterval(), Schedule(), ServiceBandwidthRequests(), ServiceUnsolicitedGrants(), and ULSchedulerRTPSConnection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AllocateInitialRangingInterval()

void ns3::UplinkSchedulerRtps::AllocateInitialRangingInterval	(	uint32_t &	symbolsToAllocation,
		uint32_t &	availableSymbols
	)

overridevirtual

Allocate Initial Ranging Interval function.

Parameters

symbolsToAllocation	symbols to allocation for UpLink Subframe
availableSymbols	available symbols for rtPS flows

Implements ns3::UplinkScheduler.

Definition at line 638 of file bs-uplink-scheduler-rtps.cc.

References AddUplinkAllocation(), CalculateAllocationStartTime(), ns3::UplinkScheduler::GetBs(), ns3::UplinkScheduler::GetNrIrOppsAllocated(), ns3::UplinkScheduler::GetTimeStampIrInterval(), ns3::Simulator::Now(), NS_LOG_DEBUG, ns3::Seconds(), ns3::OfdmUlMapIe::SetCid(), ns3::UplinkScheduler::SetIsIrIntrvlAllocated(), ns3::UplinkScheduler::SetNrIrOppsAllocated(), ns3::OfdmUlMapIe::SetStartTime(), ns3::UplinkScheduler::SetTimeStampIrInterval(), ns3::OfdmUlMapIe::SetUiuc(), and ns3::OfdmUlBurstProfile::UIUC_INITIAL_RANGING.

Referenced by Schedule().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CalculateAllocationStartTime()

uint32_t ns3::UplinkSchedulerRtps::CalculateAllocationStartTime ( )

overridevirtual

Calculate allocation start time function.

Returns: the allocation start time value

Implements ns3::UplinkScheduler.

Definition at line 148 of file bs-uplink-scheduler-rtps.cc.

References ns3::UplinkScheduler::GetBs().

Referenced by AllocateInitialRangingInterval().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetChannelDescriptorsToUpdate()

void ns3::UplinkSchedulerRtps::GetChannelDescriptorsToUpdate	(	bool &	updateDcd,
		bool &	updateUcd,
		bool &	sendDcd,
		bool &	sendUcd
	)

overridevirtual

Determines if channel descriptors sent in the current frame are required to be updated.

Parameters

updateDcd	if true update DCD
updateUcd	if true update UCD
sendDcd	if true send DCD
sendUcd	if true send UCD

Implements ns3::UplinkScheduler.

Definition at line 89 of file bs-uplink-scheduler-rtps.cc.

References ns3::UplinkScheduler::GetBs(), ns3::UplinkScheduler::GetDcdTimeStamp(), ns3::UplinkScheduler::GetUcdTimeStamp(), ns3::Simulator::Now(), ns3::UplinkScheduler::SetDcdTimeStamp(), and ns3::UplinkScheduler::SetUcdTimeStamp().

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::UplinkSchedulerRtps::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 73 of file bs-uplink-scheduler-rtps.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ GetUplinkAllocations()

std::list< OfdmUlMapIe > ns3::UplinkSchedulerRtps::GetUplinkAllocations ( ) const

overridevirtual

Get uplink allocations.

Returns: std::list<OfdmUlMapIe>

Reimplemented from ns3::UplinkScheduler.

Definition at line 83 of file bs-uplink-scheduler-rtps.cc.

References m_uplinkAllocations.

◆ InitOnce()

void ns3::UplinkSchedulerRtps::InitOnce ( )

overridevirtual

Init once function.

Implements ns3::UplinkScheduler.

Definition at line 737 of file bs-uplink-scheduler-rtps.cc.

◆ OnSetRequestedBandwidth()

void ns3::UplinkSchedulerRtps::OnSetRequestedBandwidth ( ServiceFlowRecord * sfr )

overridevirtual

Set requested bandwidth function.

Parameters

sfr	the service flow record

Implements ns3::UplinkScheduler.

Definition at line 747 of file bs-uplink-scheduler-rtps.cc.

References ns3::ServiceFlowRecord::SetGrantedBandwidth().

Here is the call graph for this function:

◆ ProcessBandwidthRequest()

void ns3::UplinkSchedulerRtps::ProcessBandwidthRequest ( const BandwidthRequestHeader & bwRequestHdr )

overridevirtual

Process bandwidth request function.

Parameters

bwRequestHdr the bandwidth request header

Implements ns3::UplinkScheduler.

Definition at line 742 of file bs-uplink-scheduler-rtps.cc.

◆ Schedule()

void ns3::UplinkSchedulerRtps::Schedule ( )

overridevirtual

Schedule function.

Implements ns3::UplinkScheduler.

Definition at line 167 of file bs-uplink-scheduler-rtps.cc.

References AddUplinkAllocation(), AllocateInitialRangingInterval(), ns3::WimaxNetDevice::DIRECTION_UPLINK, ns3::SSRecord::GetAreServiceFlowsAllocated(), ns3::SSRecord::GetBasicCid(), ns3::UplinkScheduler::GetBs(), ns3::SSRecord::GetIsBroadcastSS(), ns3::SSRecord::GetModulationType(), ns3::SSRecord::GetPollForRanging(), ns3::SSRecord::GetRangingStatus(), ns3::Cid::InitialRanging(), m_uplinkAllocations, NS_LOG_INFO, ns3::WimaxNetDevice::RANGING_STATUS_CONTINUE, ns3::WimaxNetDevice::RANGING_STATUS_SUCCESS, ServiceBandwidthRequests(), ServiceUnsolicitedGrants(), ns3::OfdmUlMapIe::SetCid(), ns3::OfdmUlMapIe::SetDuration(), ns3::UplinkScheduler::SetIsInvIrIntrvlAllocated(), ns3::UplinkScheduler::SetIsIrIntrvlAllocated(), ns3::OfdmUlMapIe::SetStartTime(), ns3::OfdmUlMapIe::SetUiuc(), ns3::ServiceFlow::SF_TYPE_BE, ns3::ServiceFlow::SF_TYPE_NRTPS, ns3::ServiceFlow::SF_TYPE_RTPS, ns3::ServiceFlow::SF_TYPE_UGS, ns3::OfdmUlBurstProfile::UIUC_END_OF_MAP, ns3::OfdmUlBurstProfile::UIUC_INITIAL_RANGING, and ULSchedulerRTPSConnection().

Here is the call graph for this function:

◆ ServiceBandwidthRequests() [1/2]

void ns3::UplinkSchedulerRtps::ServiceBandwidthRequests	(	const SSRecord *	ssRecord,
		ServiceFlow::SchedulingType	schedulingType,
		OfdmUlMapIe &	ulMapIe,
		const WimaxPhy::ModulationType	modulationType,
		uint32_t &	symbolsToAllocation,
		uint32_t &	availableSymbols
	)

overridevirtual

Service Bandwidth Requests function.

Parameters

ssRecord	Subscriber station record
schedulingType	the scheduling type
ulMapIe	the UL map IE
modulationType	the modulation type
symbolsToAllocation	the symbols to allocation
availableSymbols	the available symbols

Implements ns3::UplinkScheduler.

Definition at line 448 of file bs-uplink-scheduler-rtps.cc.

References ns3::SSRecord::GetServiceFlows().

Referenced by Schedule(), and ServiceUnsolicitedGrants().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ServiceBandwidthRequests() [2/2]

bool ns3::UplinkSchedulerRtps::ServiceBandwidthRequests	(	ServiceFlow *	serviceFlow,
		ServiceFlow::SchedulingType	schedulingType,
		OfdmUlMapIe &	ulMapIe,
		const WimaxPhy::ModulationType	modulationType,
		uint32_t &	symbolsToAllocation,
		uint32_t &	availableSymbols
	)

overridevirtual

Service bandwidth requests function.

Parameters

serviceFlow	the service flow
schedulingType	the scheduling type
ulMapIe	the UL map IE
modulationType	the modulation type
symbolsToAllocation	the symbols to allocation
availableSymbols	the available symbols

Returns: true if successful

Implements ns3::UplinkScheduler.

Definition at line 472 of file bs-uplink-scheduler-rtps.cc.

References AddUplinkAllocation(), ns3::UplinkScheduler::GetBs(), ns3::ServiceFlow::GetConnection(), ns3::ServiceFlowRecord::GetGrantedBandwidth(), ns3::ServiceFlow::GetRecord(), ns3::ServiceFlowRecord::GetRequestedBandwidth(), ns3::ServiceFlow::GetSchedulingTypeStr(), ns3::ServiceFlow::GetSduSize(), ns3::ServiceFlow::GetSfid(), NS_LOG_DEBUG, ns3::ServiceFlowRecord::SetBwSinceLastExpiry(), ns3::ServiceFlow::SF_TYPE_NRTPS, and ns3::ServiceFlowRecord::UpdateGrantedBandwidth().

Here is the call graph for this function:

◆ ServiceUnsolicitedGrants()

void ns3::UplinkSchedulerRtps::ServiceUnsolicitedGrants	(	const SSRecord *	ssRecord,
		ServiceFlow::SchedulingType	schedulingType,
		OfdmUlMapIe &	ulMapIe,
		const WimaxPhy::ModulationType	modulationType,
		uint32_t &	symbolsToAllocation,
		uint32_t &	availableSymbols
	)

overridevirtual

Service Unsolicited Grants function.

Parameters

ssRecord	Subscriber station record
schedulingType	the scheduling type
ulMapIe	the UL map IE
modulationType	the modulation type
symbolsToAllocation	the symbols to allocation
availableSymbols	the available symbols

Implements ns3::UplinkScheduler.

Definition at line 361 of file bs-uplink-scheduler-rtps.cc.

Referenced by Schedule().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetupServiceFlow()

void ns3::UplinkSchedulerRtps::SetupServiceFlow	(	SSRecord *	ssRecord,
		ServiceFlow *	serviceFlow
	)

overridevirtual

Setup service flow function.

Parameters

ssRecord	Subscriber station record
serviceFlow	the service flow

Implements ns3::UplinkScheduler.

Definition at line 679 of file bs-uplink-scheduler-rtps.cc.

Here is the call graph for this function:

◆ ULSchedulerRTPSConnection()

void ns3::UplinkSchedulerRtps::ULSchedulerRTPSConnection	(	uint32_t &	symbolsToAllocation,
		uint32_t &	availableSymbols
	)

Uplink Scheduler for rtPS connections.

Parameters

symbolsToAllocation	symbols to allocation for UpLink Subframe
availableSymbols	available symbols for rtPS flows

This method represent the UL Scheduler for rtPS connections. The scheduler is designed to serve all rtPS connections that have at least one packet to transmit, every UL Subframe. The method selects all rtPS connection that have al least one packet to transmit. To each rtPS connections are allocated, at the beginning, the bandwidth to transmit a quota of data equal to (RequestedBandwidth - GrantedBandwidth). If the sum of all pre-allocated bandwidth exceed the available symbols for rtPS connections, the Channel Saturation Control function is called to redistribute the available bandwidth.

Definition at line 529 of file bs-uplink-scheduler-rtps.cc.

References AddUplinkAllocation(), two-ray-to-three-gpp-ch-calibration::delta, ns3::WimaxNetDevice::DIRECTION_UPLINK, ns3::SSRecord::GetAreServiceFlowsAllocated(), ns3::SSRecord::GetBasicCid(), ns3::UplinkScheduler::GetBs(), ns3::ServiceFlowRecord::GetGrantedBandwidth(), ns3::SSRecord::GetIsBroadcastSS(), ns3::SSRecord::GetModulationType(), ns3::SSRecord::GetPollForRanging(), ns3::SSRecord::GetRangingStatus(), ns3::ServiceFlowRecord::GetRequestedBandwidth(), ns3::SSRecord::GetServiceFlows(), NS_LOG_INFO, ns3::WimaxNetDevice::RANGING_STATUS_CONTINUE, ns3::OfdmUlMapIe::SetCid(), ns3::ServiceFlowRecord::SetGrantedBandwidth(), ns3::ServiceFlowRecord::SetRequestedBandwidth(), ns3::OfdmUlMapIe::SetUiuc(), ns3::ServiceFlow::SF_TYPE_RTPS, and ns3::ServiceFlowRecord::UpdateGrantedBandwidth().