A Discrete-Event Network Simulator
API
ns3::UplinkSchedulerMBQoS Class Reference

This class implements a Migration-based Quality of Service uplink scheduler(MBQoS). More...

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

+ Inheritance diagram for ns3::UplinkSchedulerMBQoS:
+ Collaboration diagram for ns3::UplinkSchedulerMBQoS:

Public Member Functions

 UplinkSchedulerMBQoS ()
 
 UplinkSchedulerMBQoS (Time time)
 
 ~UplinkSchedulerMBQoS (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 CheckDeadline (uint32_t &availableSymbols)
 Check deadline from jobs. Migrate requests if necessary. More...
 
void CheckMinimumBandwidth (uint32_t &availableSymbols)
 Check if Minimum bandwidth is guarantee. Migrate requests if necessary. More...
 
uint32_t CountSymbolsJobs (Ptr< UlJob > job)
 
uint32_t CountSymbolsQueue (std::list< Ptr< UlJob > > jobs)
 
Ptr< UlJobCreateUlJob (SSRecord *ssRecord, enum ServiceFlow::SchedulingType schedType, ReqType reqType)
 
Ptr< UlJobDequeueJob (UlJob::JobPriority priority)
 Dequeue a job from a priority queue. More...
 
Time DetermineDeadline (ServiceFlow *serviceFlow)
 Calculates deadline of a request. More...
 
void EnqueueJob (UlJob::JobPriority priority, Ptr< UlJob > job)
 Enqueue a job in a priority queue. More...
 
void GetChannelDescriptorsToUpdate (bool &, bool &, bool &, bool &)
 Determines if channel descriptors sent in the current frame are required to be updated. More...
 
uint32_t GetPendingSize (ServiceFlow *serviceFlow)
 
std::list< OfdmUlMapIeGetUplinkAllocations (void) const
 
void InitOnce (void)
 This method is called once to initialize window. More...
 
void OnSetRequestedBandwidth (ServiceFlowRecord *sfr)
 
void ProcessBandwidthRequest (const BandwidthRequestHeader &bwRequestHdr)
 
void Schedule (void)
 
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)
 
bool ServiceBandwidthRequestsBytes (ServiceFlow *serviceFlow, enum ServiceFlow::SchedulingType schedulingType, OfdmUlMapIe &ulMapIe, const WimaxPhy::ModulationType modulationType, uint32_t &symbolsToAllocation, uint32_t &availableSymbols, uint32_t allocationSizeBytes)
 
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 UplinkSchedWindowTimer (void)
 Reset the current window. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Implement the GetInstanceTypeId method defined in ObjectBase. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. 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...
 
SimpleRefCountoperator= (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
 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 erros. 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 (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< OfdmUlMapIem_uplinkAllocations
 
std::list< Ptr< UlJob > > m_uplinkJobs_high
 
std::list< Ptr< UlJob > > m_uplinkJobs_inter
 
std::list< Ptr< UlJob > > m_uplinkJobs_low
 
Time m_windowInterval
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 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 (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

This class implements a Migration-based Quality of Service uplink scheduler(MBQoS).

This uplink scheduler uses three queues, the low priority queue, the intermediate queue and the high priority queue. The scheduler serves the requests in strict priority order from the high priority queue to the low priority queue. The low priority queue stores the bandwidth requests of the BE service flow. The intermediate queue holds bandwidth requests sent by rtPS and by nrtPS connections. rtPS and nrtPS requests can migrate to the high priority queue to guarantee that their QoS requirements are met. Besides the requests migrated from the intermediate queue, the high priority queue stores periodic grants and unicast request opportunities that must be scheduled in the following frame. To guarantee the maximum delay requirement, the BS assigns a deadline to each rtPS bandwidth request in the intermediate queue. The minimum bandwidth requirement of both rtPS and nrtPS connections is guaranteed over a window of duration T . Implementation of uplink scheduler: Freitag, J.; da Fonseca, N.L.S., "Uplink Scheduling with Quality of Service in IEEE 802.16 Networks," Global Telecommunications Conference, 2007. GLOBECOM '07. IEEE , vol., no., pp.2503-2508, 26-30 Nov. 2007 URL: http://ieeexplore.ieee.org/stamp/stamp.jsp?arnumber=4411386&isnumber=4410910

Config Paths

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

  • "/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/UplinkScheduler/$ns3::UplinkSchedulerMBQoS"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/UplinkScheduler/$ns3::UplinkSchedulerMBQoS"

Attributes

  • WindowInterval: The time to wait to reset window
    • Set with class: ns3::TimeValue
    • Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +1000000000.0ns
    • Flags: construct write read

No TraceSources are defined for this type.
Size of this type is 160 bytes (on a 64-bit architecture).

Definition at line 69 of file bs-uplink-scheduler-mbqos.h.

Constructor & Destructor Documentation

ns3::UplinkSchedulerMBQoS::UplinkSchedulerMBQoS ( )

Definition at line 38 of file bs-uplink-scheduler-mbqos.cc.

ns3::UplinkSchedulerMBQoS::UplinkSchedulerMBQoS ( Time  time)

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

ns3::UplinkSchedulerMBQoS::~UplinkSchedulerMBQoS ( void  )

Definition at line 48 of file bs-uplink-scheduler-mbqos.cc.

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

+ Here is the call graph for this function:

Member Function Documentation

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

Implements ns3::UplinkScheduler.

Definition at line 149 of file bs-uplink-scheduler-mbqos.cc.

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

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

uint32_t ns3::UplinkSchedulerMBQoS::CalculateAllocationStartTime ( void  )
virtual

Implements ns3::UplinkScheduler.

Definition at line 143 of file bs-uplink-scheduler-mbqos.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::UplinkSchedulerMBQoS::CheckDeadline ( uint32_t &  availableSymbols)

Check deadline from jobs. Migrate requests if necessary.

Parameters
availableSymbolsavailable symbols in the uplink frame This method verifies for each rtPS request whether it should be migrated to the high priority queue or not. The conditions for migration are: request deadline expires in the frame following the next one, and the amount of bandwidth requested is less than or equal to the amount of available bytes in the next uplink frame.

Definition at line 650 of file bs-uplink-scheduler-mbqos.cc.

References EnqueueJob(), visualizer.higcontainer::frame, ns3::UplinkScheduler::GetBs(), ns3::UlJob::HIGH, m_uplinkJobs_inter, ns3::Simulator::Now(), NS_LOG_DEBUG, and ns3::ServiceFlow::SF_TYPE_RTPS.

Referenced by Schedule().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::UplinkSchedulerMBQoS::CheckMinimumBandwidth ( uint32_t &  availableSymbols)

Check if Minimum bandwidth is guarantee. Migrate requests if necessary.

Parameters
availableSymbolsavailable symbols in the uplink frame. This method first calculate a priority value for each request in the intermediate queue. Then, sorts the intermediate queue according to the priority values. Finally, while there is available bandwidth, the scheduler migrate the requests to the high priority queue.

Definition at line 738 of file bs-uplink-scheduler-mbqos.cc.

References CountSymbolsJobs(), EnqueueJob(), ns3::ServiceFlowRecord::GetBacklogged(), ns3::ServiceFlowRecord::GetBackloggedTemp(), ns3::UplinkScheduler::GetBs(), ns3::ServiceFlowRecord::GetBwSinceLastExpiry(), ns3::ServiceFlowRecord::GetGrantedBandwidth(), ns3::ServiceFlowRecord::GetGrantedBandwidthTemp(), ns3::ServiceFlow::GetMinReservedTrafficRate(), ns3::ServiceFlow::GetRecord(), ns3::ServiceFlowRecord::GetRequestedBandwidth(), ns3::ServiceFlow::GetSchedulingType(), ns3::ServiceFlow::GetSduSize(), ns3::SSRecord::GetServiceFlows(), ns3::UlJob::HIGH, list, m_uplinkJobs_inter, ns3::ServiceFlowRecord::SetBackloggedTemp(), ns3::ServiceFlowRecord::SetGrantedBandwidthTemp(), ns3::ServiceFlow::SF_TYPE_ALL, ns3::ServiceFlow::SF_TYPE_NRTPS, and ns3::ServiceFlow::SF_TYPE_RTPS.

Referenced by Schedule().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

uint32_t ns3::UplinkSchedulerMBQoS::CountSymbolsJobs ( Ptr< UlJob job)
uint32_t ns3::UplinkSchedulerMBQoS::CountSymbolsQueue ( std::list< Ptr< UlJob > >  jobs)
Parameters
jobsList of jobs

Sum the amount of symbols of each job of a queue

Definition at line 547 of file bs-uplink-scheduler-mbqos.cc.

References CountSymbolsJobs(), and list.

Referenced by Schedule().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Ptr< UlJob > ns3::UplinkSchedulerMBQoS::CreateUlJob ( SSRecord ssRecord,
enum ServiceFlow::SchedulingType  schedType,
ReqType  reqType 
)
Parameters
ssRecordSubscriber station record
schedTypeService flow type
reqTypeType of packet

Create and fill information of a job.

Definition at line 561 of file bs-uplink-scheduler-mbqos.cc.

References ns3::SSRecord::GetServiceFlows().

Referenced by Schedule().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Ptr< UlJob > ns3::UplinkSchedulerMBQoS::DequeueJob ( UlJob::JobPriority  priority)

Dequeue a job from a priority queue.

Parameters
priorityPriority of queue

Definition at line 629 of file bs-uplink-scheduler-mbqos.cc.

References ns3::UlJob::HIGH, ns3::UlJob::INTERMEDIATE, ns3::UlJob::LOW, m_uplinkJobs_high, m_uplinkJobs_inter, and m_uplinkJobs_low.

Time ns3::UplinkSchedulerMBQoS::DetermineDeadline ( ServiceFlow serviceFlow)

Calculates deadline of a request.

Parameters
serviceFlowService flow of connection

Definition at line 1147 of file bs-uplink-scheduler-mbqos.cc.

References ns3::ServiceFlowRecord::GetLastGrantTime(), ns3::ServiceFlow::GetMaximumLatency(), ns3::ServiceFlow::GetRecord(), and ns3::MilliSeconds().

Referenced by ProcessBandwidthRequest().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::UplinkSchedulerMBQoS::EnqueueJob ( UlJob::JobPriority  priority,
Ptr< UlJob job 
)

Enqueue a job in a priority queue.

Parameters
priorityPriority of queue
jobjob information

Definition at line 613 of file bs-uplink-scheduler-mbqos.cc.

References ns3::UlJob::HIGH, ns3::UlJob::INTERMEDIATE, ns3::UlJob::LOW, m_uplinkJobs_high, m_uplinkJobs_inter, and m_uplinkJobs_low.

Referenced by CheckDeadline(), CheckMinimumBandwidth(), ProcessBandwidthRequest(), and Schedule().

+ Here is the caller graph for this function:

void ns3::UplinkSchedulerMBQoS::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-mbqos.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:

uint32_t ns3::UplinkSchedulerMBQoS::GetPendingSize ( ServiceFlow serviceFlow)

Definition at line 1060 of file bs-uplink-scheduler-mbqos.cc.

References list, and m_uplinkJobs_inter.

Referenced by ProcessBandwidthRequest().

+ Here is the caller graph for this function:

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

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

References m_windowInterval, ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::Seconds(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

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

Reimplemented from ns3::UplinkScheduler.

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

References m_uplinkAllocations.

void ns3::UplinkSchedulerMBQoS::InitOnce ( void  )
virtual

This method is called once to initialize window.

Implements ns3::UplinkScheduler.

Definition at line 72 of file bs-uplink-scheduler-mbqos.cc.

References UplinkSchedWindowTimer().

+ Here is the call graph for this function:

void ns3::UplinkSchedulerMBQoS::OnSetRequestedBandwidth ( ServiceFlowRecord sfr)
virtual

Implements ns3::UplinkScheduler.

Definition at line 1156 of file bs-uplink-scheduler-mbqos.cc.

void ns3::UplinkSchedulerMBQoS::Schedule ( void  )
virtual

Implements ns3::UplinkScheduler.

Definition at line 218 of file bs-uplink-scheduler-mbqos.cc.

References AddUplinkAllocation(), AllocateInitialRangingInterval(), CheckDeadline(), CheckMinimumBandwidth(), CountSymbolsQueue(), CreateUlJob(), ns3::DATA, ns3::WimaxNetDevice::DIRECTION_UPLINK, EnqueueJob(), visualizer.higcontainer::frame, ns3::SSRecord::GetAreServiceFlowsAllocated(), ns3::SSRecord::GetBasicCid(), ns3::UplinkScheduler::GetBs(), ns3::SSRecord::GetHasServiceFlowBe(), ns3::SSRecord::GetHasServiceFlowNrtps(), ns3::SSRecord::GetHasServiceFlowRtps(), ns3::SSRecord::GetHasServiceFlowUgs(), ns3::SSRecord::GetIsBroadcastSS(), ns3::SSRecord::GetModulationType(), ns3::SSRecord::GetPollForRanging(), ns3::SSRecord::GetRangingStatus(), ns3::SSRecord::GetServiceFlows(), ns3::UlJob::HIGH, m_uplinkAllocations, m_uplinkJobs_high, m_uplinkJobs_inter, m_uplinkJobs_low, ns3::MilliSeconds(), ns3::Simulator::Now(), NS_FATAL_ERROR, NS_LOG_DEBUG, ns3::WimaxNetDevice::RANGING_STATUS_CONTINUE, ns3::WimaxNetDevice::RANGING_STATUS_SUCCESS, ServiceBandwidthRequests(), ServiceBandwidthRequestsBytes(), 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 ns3::UNICAST_POLLING.

+ Here is the call graph for this function:

void ns3::UplinkSchedulerMBQoS::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 883 of file bs-uplink-scheduler-mbqos.cc.

References ns3::SSRecord::GetServiceFlows().

Referenced by Schedule().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool ns3::UplinkSchedulerMBQoS::ServiceBandwidthRequestsBytes ( ServiceFlow serviceFlow,
enum ServiceFlow::SchedulingType  schedulingType,
OfdmUlMapIe ulMapIe,
const WimaxPhy::ModulationType  modulationType,
uint32_t &  symbolsToAllocation,
uint32_t &  availableSymbols,
uint32_t  allocationSizeBytes 
)
void ns3::UplinkSchedulerMBQoS::ServiceUnsolicitedGrants ( const SSRecord ssRecord,
enum ServiceFlow::SchedulingType  schedulingType,
OfdmUlMapIe ulMapIe,
const WimaxPhy::ModulationType  modulationType,
uint32_t &  symbolsToAllocation,
uint32_t &  availableSymbols 
)
virtual

Member Data Documentation

std::list<OfdmUlMapIe> ns3::UplinkSchedulerMBQoS::m_uplinkAllocations
private
std::list<Ptr<UlJob> > ns3::UplinkSchedulerMBQoS::m_uplinkJobs_high
private

Definition at line 210 of file bs-uplink-scheduler-mbqos.h.

Referenced by DequeueJob(), EnqueueJob(), and Schedule().

std::list<Ptr<UlJob> > ns3::UplinkSchedulerMBQoS::m_uplinkJobs_inter
private
std::list<Ptr<UlJob> > ns3::UplinkSchedulerMBQoS::m_uplinkJobs_low
private

Definition at line 212 of file bs-uplink-scheduler-mbqos.h.

Referenced by DequeueJob(), EnqueueJob(), and Schedule().

Time ns3::UplinkSchedulerMBQoS::m_windowInterval
private

Definition at line 215 of file bs-uplink-scheduler-mbqos.h.

Referenced by GetTypeId(), and UplinkSchedWindowTimer().


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