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)

	~UplinkSchedulerRtps (void)

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

void	AllocateInitialRangingInterval (uint32_t &symbolsToAllocation, uint32_t &availableSymbols)

uint32_t	CalculateAllocationStartTime (void)

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

std::list< OfdmUlMapIe >	GetUplinkAllocations (void) const

void	InitOnce (void)

void	OnSetRequestedBandwidth (ServiceFlowRecord *sfr)

void	ProcessBandwidthRequest (const BandwidthRequestHeader &bwRequestHdr)

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

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

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

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

void	SetupServiceFlow (SSRecord ssRecord, ServiceFlow serviceFlow)

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

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

	UplinkScheduler (Ptr< BaseStationNetDevice > bs)

virtual	~UplinkScheduler (void)

virtual Ptr< BaseStationNetDevice >	GetBs (void)

virtual Time	GetDcdTimeStamp (void) const

virtual bool	GetIsInvIrIntrvlAllocated (void) const

virtual bool	GetIsIrIntrvlAllocated (void) const

virtual uint8_t	GetNrIrOppsAllocated (void) const

virtual Time	GetTimeStampIrInterval (void)

virtual Time	GetUcdTimeStamp (void) const

virtual void	SetBs (Ptr< BaseStationNetDevice > bs)

virtual void	SetDcdTimeStamp (Time dcdTimeStamp)

virtual void	SetIsInvIrIntrvlAllocated (bool isInvIrIntrvlAllocated)

virtual void	SetIsIrIntrvlAllocated (bool isIrIntrvlAllocated)

virtual void	SetNrIrOppsAllocated (uint8_t nrIrOppsAllocated)

virtual void	SetTimeStampIrInterval (Time timeStampIrInterval)

virtual void	SetUcdTimeStamp (Time ucdTimeStamp)

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

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

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	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

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

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

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

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. More...

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

void	Unref (void) 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

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)

Static Public Member Functions inherited from ns3::UplinkScheduler
static TypeId	GetTypeId (void)

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

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

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

Private Attributes
std::list< OfdmUlMapIe >	m_uplinkAllocations

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

virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. 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.

Config Paths

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

/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/UplinkScheduler/$ns3::UplinkSchedulerRtps
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/UplinkScheduler/$ns3::UplinkSchedulerRtps

No Attributes are defined for this type.
No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

ns3::UplinkSchedulerRtps::UplinkSchedulerRtps ( )

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

References ns3::Simulator::Now(), 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:

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

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

References ns3::Simulator::Now(), 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:

ns3::UplinkSchedulerRtps::~UplinkSchedulerRtps ( void )

Definition at line 64 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

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

virtual

Implements ns3::UplinkScheduler.

Definition at line 146 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:

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

virtual

Implements ns3::UplinkScheduler.

Definition at line 603 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::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:

uint32_t ns3::UplinkSchedulerRtps::CalculateAllocationStartTime ( void )

virtual

Implements ns3::UplinkScheduler.

Definition at line 140 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:

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

virtual

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

Implements ns3::UplinkScheduler.

Definition at line 84 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:

TypeId ns3::UplinkSchedulerRtps::GetTypeId ( void )

static

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

References ns3::TypeId::SetParent().

Here is the call graph for this function:

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

virtual

Reimplemented from ns3::UplinkScheduler.

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

References m_uplinkAllocations.

void ns3::UplinkSchedulerRtps::InitOnce ( void )

virtual

Implements ns3::UplinkScheduler.

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

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

virtual

Implements ns3::UplinkScheduler.

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

References ns3::ServiceFlowRecord::SetGrantedBandwidth().

Here is the call graph for this function:

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

virtual

Implements ns3::UplinkScheduler.

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

void ns3::UplinkSchedulerRtps::Schedule ( void )

virtual

Schedule function.

Implements ns3::UplinkScheduler.

Definition at line 159 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:

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

virtual

Implements ns3::UplinkScheduler.

Definition at line 425 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:

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

virtual

Implements ns3::UplinkScheduler.

Definition at line 449 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:

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

virtual

Implements ns3::UplinkScheduler.

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

References AddUplinkAllocation(), ns3::UplinkScheduler::GetBs(), ns3::ServiceFlowRecord::GetBwSinceLastExpiry(), ns3::ServiceFlow::GetConnection(), ns3::ServiceFlowRecord::GetGrantTimeStamp(), ns3::ServiceFlow::GetRecord(), ns3::ServiceFlow::GetSchedulingType(), ns3::ServiceFlow::GetSchedulingTypeStr(), ns3::SSRecord::GetServiceFlows(), ns3::ServiceFlow::GetSfid(), ns3::OfdmUlMapIe::GetUiuc(), ns3::Simulator::Now(), NS_LOG_DEBUG, ServiceBandwidthRequests(), ns3::ServiceFlowRecord::SetBwSinceLastExpiry(), ns3::ServiceFlowRecord::SetGrantTimeStamp(), ns3::OfdmUlMapIe::SetStartTime(), ns3::OfdmUlMapIe::SetUiuc(), ns3::ServiceFlow::SF_TYPE_NRTPS, ns3::ServiceFlow::SF_TYPE_UGS, and ns3::OfdmUlBurstProfile::UIUC_REQ_REGION_FULL.

Referenced by Schedule().

Here is the call graph for this function:

Here is the caller graph for this function:

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

virtual

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 methos 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 504 of file bs-uplink-scheduler-rtps.cc.

References AddUplinkAllocation(), 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().