helper class for Satellite Superframe Allocator. More...

#include "satellite-frame-allocator.h"

Inheritance diagram for ns3::SatFrameAllocator:

Collaboration diagram for ns3::SatFrameAllocator:

Classes
struct	BandwidthComparator
	BandwidthComparator is a custom functor meant as comparison function for std::map. More...

class	CcReqCompare
	CcReqCompare class for CC type comparisons. More...

class	SatFrameAllocInfo
	SatFrameAllocInfo is used to hold a frame's allocation info in symbols. More...

class	SatFrameAllocInfoItem
	Allocation information item for requests and allocations [symbols] used internally by SatFrameAllocator. More...

class	SatFrameAllocReq
	SatFrameAllocReq is used to define frame allocation parameters when requesting allocation from SatFrameAllocator (calling method AllocateSymbols). More...

class	SatFrameAllocReqItem
	Allocation information item for the UT/RC requests [bytes]. More...

struct	UtAllocItem_t
	Allocation information for a UT. More...

Public Types
enum	CcLevel_t { CC_LEVEL_CRA , CC_LEVEL_CRA_MIN_RBDC , CC_LEVEL_CRA_RBDC , CC_LEVEL_CRA_RBDC_VBDC }
	Enum for CC levels. More...

typedef std::vector< SatFrameAllocReq * >	SatFrameAllocContainer_t
	Container to store SatFrameAllocReq item pointers. More...

typedef std::vector< SatFrameAllocReqItem >	SatFrameAllocReqItemContainer_t
	Container to store SatFrameAllocReqItem items. More...

typedef std::vector< Ptr< SatTbtpMessage > >	TbtpMsgContainer_t
	Container to store generated TBTP messages. More...

typedef std::map< Address, UtAllocInfoItem_t >	UtAllocInfoContainer_t
	Map container to store UT allocation information. More...

typedef std::pair< std::vector< uint32_t >, bool >	UtAllocInfoItem_t
	Pair used to store UT allocation information. More...

Public Member Functions
	SatFrameAllocator ()
	Default constructor (not in used) More...

	SatFrameAllocator (Ptr< SatFrameConf > frameConf, uint8_t frameId, SatSuperframeConf::ConfigType_t m_configType, Ptr< SatFrameAllocator > parent)
	Construct frame info. More...

bool	Allocate (CcLevel_t ccLevel, SatFrameAllocReq *allocReq, uint32_t waveformId)
	Allocate symbols to this frame, if criteria are fulfilled. More...

void	GenerateTimeSlots (SatFrameAllocator::TbtpMsgContainer_t &tbtpContainer, uint32_t maxSizeInBytes, UtAllocInfoContainer_t &utAllocContainer, bool rcBasedAllocationEnabled, TracedCallback< uint32_t > waveformTrace, TracedCallback< uint32_t, uint32_t > utLoadTrace, TracedCallback< uint32_t, double > loadTrace)
	Generate time slots for UT/RCs i.e. More...

bool	GetBestWaveform (double cno, uint32_t &waveFormId, double &cnoThreshold) const
	Get the best waveform supported by this allocator based on given C/N0. More...

double	GetCarrierBandwidthHz (bool checkParent=false) const

uint16_t	GetCarrierCount () const
	Get the amount of carriers used in this frame. More...

uint32_t	GetCarrierMinPayloadInBytes () const
	Get minimum payload of a carrier in bytes. More...

double	GetCcLoad (CcLevel_t ccLevel)
	Get frame load by requested CC. More...

Ptr< SatWaveform >	GetMostRobustWaveform () const
	Get the most robust waveform used by this frame allocator. More...

Ptr< SatFrameAllocator >	GetParent () const

double	GetVolumeBytes () const

void	PreAllocateSymbols (double targetLoad, bool fcaEnabled)
	Preallocate symbols for all UTs with RCs allocated to the frame. More...

void	Reset ()
	Reset frame allocator. More...

void	SelectCarriers (uint16_t &amount, uint16_t offset)
	Set the amount of carriers used in this frame. More...

Private Types
typedef std::list< RcAllocItem_t >	RcAllocContainer_t
	Container for RC allocation items. More...

typedef std::pair< Address, uint8_t >	RcAllocItem_t
	Pair used as RC allocation item. More...

typedef std::vector< SatFrameAllocInfoItem >	SatFrameAllocInfoItemContainer_t
	Container to store SatFrameAllocInfoItem items. More...

typedef std::map< Address, UtAllocItem_t >	UtAllocContainer_t
	Map container for UT allocation items. More...

Private Member Functions
void	AcceptRequests (CcLevel_t ccLevel)
	Accept UT/RC requests of the frame according to given CC level. More...

Ptr< SatTimeSlotConf >	CreateCtrlTimeSlot (uint16_t carrierId, int64_t &utSymbolsToUse, int64_t &carrierSymbolsToUse, int64_t &utSymbolsLeft, int64_t &rcSymbolsLeft, bool rcBasedAllocationEnabled)
	Create control time slot. More...

Ptr< SatTbtpMessage >	CreateNewTbtp (TbtpMsgContainer_t &tbtpContainer)
	Creates new TBTP to given container with information of the last TBTP in container. More...

Ptr< SatTimeSlotConf >	CreateTimeSlot (uint16_t carrierId, int64_t &utSymbolsToUse, int64_t &carrierSymbolsToUse, int64_t &utSymbolsLeft, int64_t &rcSymbolsLeft, double cno, bool rcBasedAllocationEnabled)
	Create time slot according to configuration type. More...

uint32_t	GetOptimalBurtsLengthInSymbols (int64_t symbolsToUse, int64_t symbolsLeft, double cno, uint32_t &waveformId)
	Get optimal burst length in symbols. More...

SatFrameAllocator::UtAllocInfoContainer_t::iterator	GetUtAllocItem (UtAllocInfoContainer_t &allocContainer, Address ut)
	Get UT allocation item from given container. More...

void	ShareSymbols (bool fcaEnabled)
	Share symbols between all UTs and RCs allocated to the frame. More...

std::vector< uint16_t >	SortCarriers ()
	Sort carriers belonging to this frame. More...

std::vector< uint32_t >	SortUtRcs (Address ut)
	Sort RCs in given UT. More...

std::vector< Address >	SortUts ()
	Sort UTs allocated to this frame. More...

void	UpdateAndStoreAllocReq (Address address, double cno, SatFrameAllocInfo &req)
	Update RC/CC requested according to carrier limit. More...

Private Attributes
bool	m_allocationDenied

double	m_availableSymbolsInFrame

SatWaveformConf::BurstLengthContainer_t	m_burstLenghts

uint16_t	m_carriersOffset

SatSuperframeConf::ConfigType_t	m_configType

Ptr< SatFrameConf >	m_frameConf

uint8_t	m_frameId

uint8_t	m_guardTimeSymbols

uint16_t	m_maxCarrierCount

double	m_maxSymbolsPerCarrier

Ptr< SatWaveform >	m_mostRobustWaveform

Ptr< SatFrameAllocator >	m_parent

double	m_preAllocatedCraSymbols

double	m_preAllocatedMinRdbcSymbols

double	m_preAllocatedRdbcSymbols

double	m_preAllocatedVdbcSymbols

RcAllocContainer_t	m_rcAllocs

double	m_totalSymbolsInFrame

UtAllocContainer_t	m_utAllocs

Ptr< SatWaveformConf >	m_waveformConf

Detailed Description

helper class for Satellite Superframe Allocator.

SatFrameAllocator class is used by SatSuperframeAllocator to maintain information of the pre-allocated symbols per Capacity Category (CC) in a frame. It also knows physical constrains of the frame.

SatFrameAllocator is created and used by SatSuperframeAllocator.

After created this class is used by adding first requests (UTs) to it by calling method Allocate with proper parameters. When needed allocations are done, symbols are shared between UTs by calling PreAllocateSymbols. Finally time slots for UT can be generated for UT according to preallocation by calling method GenerateTimeSlots. GenerateTimeSlots method can be called as several time, if same preallocation is wanted to use.

NOTE! Calling of PreAllocation or Allocate methods has no effect when PreAllocation is once called until Reset method is called.

Methods GetBestWaveform and GetCcLoad are used to check status of the frame allocator to decide if UT should be allocated to this allocator (frame) or not.

Definition at line 62 of file satellite-frame-allocator.h.

Member Typedef Documentation

◆ RcAllocContainer_t

typedef std::list<RcAllocItem_t> ns3::SatFrameAllocator::RcAllocContainer_t

private

Container for RC allocation items.

Definition at line 418 of file satellite-frame-allocator.h.

◆ RcAllocItem_t

typedef std::pair<Address, uint8_t> ns3::SatFrameAllocator::RcAllocItem_t

private

Pair used as RC allocation item.

first = UT address, second = RC index

Definition at line 408 of file satellite-frame-allocator.h.

◆ SatFrameAllocContainer_t

typedef std::vector<SatFrameAllocReq*> ns3::SatFrameAllocator::SatFrameAllocContainer_t

Container to store SatFrameAllocReq item pointers.

Definition at line 146 of file satellite-frame-allocator.h.

◆ SatFrameAllocInfoItemContainer_t

typedef std::vector<SatFrameAllocInfoItem> ns3::SatFrameAllocator::SatFrameAllocInfoItemContainer_t

private

Container to store SatFrameAllocInfoItem items.

Definition at line 336 of file satellite-frame-allocator.h.

◆ SatFrameAllocReqItemContainer_t

typedef std::vector<SatFrameAllocReqItem> ns3::SatFrameAllocator::SatFrameAllocReqItemContainer_t

Container to store SatFrameAllocReqItem items.

Definition at line 110 of file satellite-frame-allocator.h.

◆ TbtpMsgContainer_t

typedef std::vector<Ptr<SatTbtpMessage> > ns3::SatFrameAllocator::TbtpMsgContainer_t

Container to store generated TBTP messages.

Definition at line 68 of file satellite-frame-allocator.h.

◆ UtAllocContainer_t

typedef std::map<Address, UtAllocItem_t> ns3::SatFrameAllocator::UtAllocContainer_t

private

Map container for UT allocation items.

Definition at line 413 of file satellite-frame-allocator.h.

◆ UtAllocInfoContainer_t

typedef std::map<Address, UtAllocInfoItem_t> ns3::SatFrameAllocator::UtAllocInfoContainer_t

Map container to store UT allocation information.

key is UT's address and value is UtAllocInfoItem_t is vector holding information of the allocated bytes for the UT/RC.

Definition at line 85 of file satellite-frame-allocator.h.

◆ UtAllocInfoItem_t

typedef std::pair<std::vector<uint32_t>, bool> ns3::SatFrameAllocator::UtAllocInfoItem_t

Pair used to store UT allocation information.

first is vector holding information of the allocated bytes, and second is flag telling if control slot is allocated for the UT/RC.

Definition at line 77 of file satellite-frame-allocator.h.

Member Enumeration Documentation

◆ CcLevel_t

enum ns3::SatFrameAllocator::CcLevel_t

Enum for CC levels.

Enumerator
CC_LEVEL_CRA	CC level CRA.
CC_LEVEL_CRA_MIN_RBDC	CC level CRA + Minimum RBDC.
CC_LEVEL_CRA_RBDC	CC level CRA + RBDC.
CC_LEVEL_CRA_RBDC_VBDC	CC level CRA + RBDC + VBDC.

Definition at line 151 of file satellite-frame-allocator.h.

Constructor & Destructor Documentation

◆ SatFrameAllocator() [1/2]

ns3::SatFrameAllocator::SatFrameAllocator ( )

Default constructor (not in used)

Definition at line 202 of file satellite-frame-allocator.cc.

◆ SatFrameAllocator() [2/2]

ns3::SatFrameAllocator::SatFrameAllocator	(	Ptr< SatFrameConf >	frameConf,
		uint8_t	frameId,
		SatSuperframeConf::ConfigType_t	m_configType,
		Ptr< SatFrameAllocator >	parent
	)

Construct frame info.

Parameters

frameConf	Frame configuration for the frame info
frameId	Id of the frame
m_configType	Type of the configuration (0-2 supported)
parent	Parent allocator in case this one holds configuration for a split frame

Definition at line 222 of file satellite-frame-allocator.cc.

References ns3::SatSuperframeConf::CONFIG_TYPE_0, ns3::SatSuperframeConf::CONFIG_TYPE_1, ns3::SatSuperframeConf::CONFIG_TYPE_2, ns3::SatSuperframeConf::CONFIG_TYPE_3, m_burstLenghts, m_configType, m_frameConf, m_guardTimeSymbols, m_maxCarrierCount, m_maxSymbolsPerCarrier, m_mostRobustWaveform, m_totalSymbolsInFrame, m_waveformConf, Reset(), and ns3::SatWaveformConf::SHORT_BURST_LENGTH.

Here is the call graph for this function:

Member Function Documentation

◆ AcceptRequests()

void ns3::SatFrameAllocator::AcceptRequests ( CcLevel_t ccLevel )

private

Accept UT/RC requests of the frame according to given CC level.

Parameters

ccLevel CC level for the acceptance

Definition at line 1174 of file satellite-frame-allocator.cc.

References CC_LEVEL_CRA, CC_LEVEL_CRA_MIN_RBDC, CC_LEVEL_CRA_RBDC, CC_LEVEL_CRA_RBDC_VBDC, and m_utAllocs.

Referenced by ShareSymbols().

Here is the caller graph for this function:

◆ Allocate()

bool ns3::SatFrameAllocator::Allocate	(	CcLevel_t	ccLevel,
		SatFrameAllocReq *	allocReq,
		uint32_t	waveformId
	)

Allocate symbols to this frame, if criteria are fulfilled.

Parameters

ccLevel	CC level of the request
allocReq	Requested information
waveformId	Waveform id selected

Returns: true allocation done, otherwise false

Definition at line 429 of file satellite-frame-allocator.cc.

Here is the call graph for this function:

◆ CreateCtrlTimeSlot()

Ptr< SatTimeSlotConf > ns3::SatFrameAllocator::CreateCtrlTimeSlot	(	uint16_t	carrierId,
		int64_t &	utSymbolsToUse,
		int64_t &	carrierSymbolsToUse,
		int64_t &	utSymbolsLeft,
		int64_t &	rcSymbolsLeft,
		bool	rcBasedAllocationEnabled
	)

private

Create control time slot.

Parameters

carrierId	Id of the carrier into create time slot
utSymbolsToUse	Symbols possible to allocated for the UT
carrierSymbolsToUse	Symbols possible to allocate to carrier
utSymbolsLeft	Symbols left for the UT
rcSymbolsLeft	Symbols left for RC
rcBasedAllocationEnabled	If time slot generated per RC

Returns: Create time slot configuration

Definition at line 1069 of file satellite-frame-allocator.cc.

References m_frameConf, m_guardTimeSymbols, m_maxSymbolsPerCarrier, m_mostRobustWaveform, and ns3::SatTimeSlotConf::SLOT_TYPE_C.

Referenced by GenerateTimeSlots().

Here is the caller graph for this function:

◆ CreateNewTbtp()

Ptr< SatTbtpMessage > ns3::SatFrameAllocator::CreateNewTbtp ( TbtpMsgContainer_t & tbtpContainer )

private

Creates new TBTP to given container with information of the last TBTP in container.

Parameters

tbtpContainer TBTP container

Returns: Pointer to created TBTP

Definition at line 1443 of file satellite-frame-allocator.cc.

Referenced by GenerateTimeSlots().

Here is the caller graph for this function:

◆ CreateTimeSlot()

Ptr< SatTimeSlotConf > ns3::SatFrameAllocator::CreateTimeSlot	(	uint16_t	carrierId,
		int64_t &	utSymbolsToUse,
		int64_t &	carrierSymbolsToUse,
		int64_t &	utSymbolsLeft,
		int64_t &	rcSymbolsLeft,
		double	cno,
		bool	rcBasedAllocationEnabled
	)

private

Create time slot according to configuration type.

Parameters

carrierId	Id of the carrier into create time slot
utSymbolsToUse	Symbols possible to allocated for the UT
carrierSymbolsToUse	Symbols possible to allocate to carrier
utSymbolsLeft	Symbols left for the UT
rcSymbolsLeft	Symbols left for RC
cno	Estimated C/N0 of the UT.
rcBasedAllocationEnabled	If time slot generated per RC

Returns: Create time slot configuration

Definition at line 976 of file satellite-frame-allocator.cc.

References ns3::SatSuperframeConf::CONFIG_TYPE_0, ns3::SatSuperframeConf::CONFIG_TYPE_1, ns3::SatSuperframeConf::CONFIG_TYPE_2, ns3::SatSuperframeConf::CONFIG_TYPE_3, GetOptimalBurtsLengthInSymbols(), m_configType, m_frameConf, m_guardTimeSymbols, m_maxSymbolsPerCarrier, and ns3::SatTimeSlotConf::SLOT_TYPE_TRC.

Referenced by GenerateTimeSlots().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GenerateTimeSlots()

void ns3::SatFrameAllocator::GenerateTimeSlots	(	SatFrameAllocator::TbtpMsgContainer_t &	tbtpContainer,
		uint32_t	maxSizeInBytes,
		UtAllocInfoContainer_t &	utAllocContainer,
		bool	rcBasedAllocationEnabled,
		TracedCallback< uint32_t >	waveformTrace,
		TracedCallback< uint32_t, uint32_t >	utLoadTrace,
		TracedCallback< uint32_t, double >	loadTrace
	)

Generate time slots for UT/RCs i.e.

do actual allocation based on preallocation.

Parameters

tbtpContainer	TBTP message container to add/fill TBTPs.
maxSizeInBytes	Maximum size for a TBTP message.
utAllocContainer	Reference to UT allocation container to fill in info of the allocation
rcBasedAllocationEnabled	If time slot generated per RC
waveformTrace	Wave form trace callback
utLoadTrace	UT load per the frame trace callback
loadTrace	Load per the frame trace callback

Definition at line 590 of file satellite-frame-allocator.cc.

References CreateCtrlTimeSlot(), CreateNewTbtp(), CreateTimeSlot(), GetUtAllocItem(), m_frameId, m_maxSymbolsPerCarrier, ns3::SatFrameConf::m_maxTimeSlotCount, m_totalSymbolsInFrame, m_utAllocs, m_waveformConf, SortCarriers(), SortUtRcs(), and SortUts().

Here is the call graph for this function:

◆ GetBestWaveform()

bool ns3::SatFrameAllocator::GetBestWaveform	(	double	cno,
		uint32_t &	waveFormId,
		double &	cnoThreshold
	)		const

Get the best waveform supported by this allocator based on given C/N0.

Parameters

cno	C/N0 value used to find the best waveform
waveFormId	variable to store the best waveform id
cnoThreshold	variable to store the C/N0 threshold of the selected waveform

Returns: true if allocator can support given C/N0

Definition at line 388 of file satellite-frame-allocator.cc.

References ns3::SatSuperframeConf::CONFIG_TYPE_0, ns3::SatSuperframeConf::CONFIG_TYPE_1, ns3::SatSuperframeConf::CONFIG_TYPE_2, ns3::SatSuperframeConf::CONFIG_TYPE_3, m_configType, m_frameConf, m_waveformConf, and ns3::SatWaveformConf::SHORT_BURST_LENGTH.

◆ GetCarrierBandwidthHz()

double ns3::SatFrameAllocator::GetCarrierBandwidthHz ( bool checkParent = false ) const

inline

Definition at line 224 of file satellite-frame-allocator.h.

References ns3::SatEnums::EFFECTIVE_BANDWIDTH, and m_frameConf.

◆ GetCarrierCount()

uint16_t ns3::SatFrameAllocator::GetCarrierCount ( ) const

inline

Get the amount of carriers used in this frame.

Returns: The carrier count of the frame.

Definition at line 210 of file satellite-frame-allocator.h.

References m_maxCarrierCount.

◆ GetCarrierMinPayloadInBytes()

uint32_t ns3::SatFrameAllocator::GetCarrierMinPayloadInBytes ( ) const

inline

Get minimum payload of a carrier in bytes.

Returns: minimum payload of a carrier in bytes

Definition at line 190 of file satellite-frame-allocator.h.

References m_frameConf.

◆ GetCcLoad()

double ns3::SatFrameAllocator::GetCcLoad ( CcLevel_t ccLevel )

Get frame load by requested CC.

Parameters

ccLevel CC of the request

Returns: Load of the requested CC.

Definition at line 354 of file satellite-frame-allocator.cc.

References CC_LEVEL_CRA, CC_LEVEL_CRA_MIN_RBDC, CC_LEVEL_CRA_RBDC, CC_LEVEL_CRA_RBDC_VBDC, m_preAllocatedCraSymbols, m_preAllocatedMinRdbcSymbols, m_preAllocatedRdbcSymbols, m_preAllocatedVdbcSymbols, and m_totalSymbolsInFrame.

◆ GetMostRobustWaveform()

Ptr<SatWaveform> ns3::SatFrameAllocator::GetMostRobustWaveform ( ) const

inline

Get the most robust waveform used by this frame allocator.

Returns: the most robust waveform

Definition at line 200 of file satellite-frame-allocator.h.

References m_mostRobustWaveform.

◆ GetOptimalBurtsLengthInSymbols()

uint32_t ns3::SatFrameAllocator::GetOptimalBurtsLengthInSymbols	(	int64_t	symbolsToUse,
		int64_t	symbolsLeft,
		double	cno,
		uint32_t &	waveformId
	)

private

Get optimal burst length in symbols.

Parameters

symbolsToUse	Symbols can be used for time slot.
symbolsLeft	Symbols left for RC or UT.
cno	C/N0 to use for selection
waveformId	Variable to store id of the wave form of optimal length burst

Returns: Optimal burst length for the symbols to allocate.

Definition at line 1115 of file satellite-frame-allocator.cc.

References ns3::SatSuperframeConf::CONFIG_TYPE_0, m_burstLenghts, m_configType, m_frameConf, and m_waveformConf.

Referenced by CreateTimeSlot().

Here is the caller graph for this function:

◆ GetParent()

Ptr<SatFrameAllocator> ns3::SatFrameAllocator::GetParent ( ) const

inline

Definition at line 236 of file satellite-frame-allocator.h.

References m_parent.

◆ GetUtAllocItem()

SatFrameAllocator::UtAllocInfoContainer_t::iterator ns3::SatFrameAllocator::GetUtAllocItem	(	UtAllocInfoContainer_t &	allocContainer,
		Address	ut
	)

private

Get UT allocation item from given container.

If UT not available in the container new UT specific item is added to container.

Parameters

allocContainer	Container to check
ut	Address of the UT

Returns: Iterator to UT specific allocation item

Definition at line 1413 of file satellite-frame-allocator.cc.

References m_utAllocs.

Referenced by GenerateTimeSlots().

Here is the caller graph for this function:

◆ GetVolumeBytes()

double ns3::SatFrameAllocator::GetVolumeBytes ( ) const

inline

Definition at line 231 of file satellite-frame-allocator.h.

References m_maxSymbolsPerCarrier.

◆ PreAllocateSymbols()

void ns3::SatFrameAllocator::PreAllocateSymbols	(	double	targetLoad,
		bool	fcaEnabled
	)

Preallocate symbols for all UTs with RCs allocated to the frame.

Parameters

targetLoad	Target load limits upper bound of the symbols in the frame. Valid values in range 0 and 1.
fcaEnabled	FCA (free capacity allocation) enable status

Definition at line 569 of file satellite-frame-allocator.cc.

References m_allocationDenied, m_availableSymbolsInFrame, m_totalSymbolsInFrame, and ShareSymbols().

Here is the call graph for this function:

◆ Reset()

void ns3::SatFrameAllocator::Reset ( )

Reset frame allocator.

Definition at line 305 of file satellite-frame-allocator.cc.

References m_allocationDenied, m_availableSymbolsInFrame, m_maxCarrierCount, m_maxSymbolsPerCarrier, m_preAllocatedCraSymbols, m_preAllocatedMinRdbcSymbols, m_preAllocatedRdbcSymbols, m_preAllocatedVdbcSymbols, m_rcAllocs, m_totalSymbolsInFrame, and m_utAllocs.

Referenced by SatFrameAllocator().

Here is the caller graph for this function:

◆ SelectCarriers()

void ns3::SatFrameAllocator::SelectCarriers	(	uint16_t &	amount,
		uint16_t	offset
	)

Set the amount of carriers used in this frame.

Parameters

amount	number of carriers to select in this frame. This parameter may be updated to include padding to round to an even number of selected carriers.
offset	number of carriers already selected for subdivided versions of the frame.

Definition at line 323 of file satellite-frame-allocator.cc.

References m_carriersOffset, m_frameConf, m_frameId, and m_maxCarrierCount.