Resource Manager Backend Base class. More...

#include <xaiefal-rscmgr-backend-base.hpp>

Inheritance diagram for xaiefal::XAieRscMgrBackend:

Public Member Functions
	XAieRscMgrBackend ()=delete
	XAieRscMgrBackend (XAieDevHandle *DevHd)
virtual AieRC	request (XAieUserRsc &RscReq)
AieRC	request (std::vector< XAieUserRsc > &RscReq)
virtual AieRC	requestAllocated (XAieUserRsc &RscReq)
AieRC	requestAllocated (std::vector< XAieUserRsc > &RscReq)
virtual AieRC	requestContiguous (std::vector< XAieUserRsc > &RscReq)
virtual AieRC	requestBc (std::vector< XAieUserRsc > &RscReq, bool isBcAll)
virtual AieRC	release (XAieUserRsc &RscRel)
AieRC	release (std::vector< XAieUserRsc > &RscRel)
virtual AieRC	free (XAieUserRsc &RscFree)
AieRC	free (std::vector< XAieUserRsc > &RscFree)
virtual AieRC	getRscStats (std::vector< XAieUserRscStat > &vStats, XAieRscBitmapType BType)
virtual AieRC	writeRscBitmaps (std::ofstream &Fs, uint64_t &NumRscs)
virtual AieRC	loadRscBitmaps (const char *MetaData, uint64_t NumBitmaps)
XAie_DevInst *	dev ()

Protected Attributes
XAieDevHandle *	AieHd

Detailed Description

Resource Manager Backend Base class.

Constructor & Destructor Documentation

◆ XAieRscMgrBackend() [1/2]

xaiefal::XAieRscMgrBackend::XAieRscMgrBackend ( )

delete

◆ XAieRscMgrBackend() [2/2]

xaiefal::XAieRscMgrBackend::XAieRscMgrBackend ( XAieDevHandle * DevHd )

inline

Member Function Documentation

◆ dev()

XAie_DevInst * xaiefal::XAieRscMgrBackend::dev ( )

inline

◆ free() [1/2]

AieRC xaiefal::XAieRscMgrBackend::free ( std::vector< XAieUserRsc > & RscFree )

inline

This function frees the list of resources from runtime bitmap

Parameters

reference to list of resources

Returns: XAIE_OK for success, error code for failure

◆ free() [2/2]

virtual AieRC xaiefal::XAieRscMgrBackend::free ( XAieUserRsc & RscFree )

inlinevirtual

This function frees the resource from runtime bitmap

Parameters

reference to resource

Returns: XAIE_OK for success, error code for failure

Reimplemented in xaiefal::XAieRscMgrGeneric.

◆ getRscStats()

virtual AieRC xaiefal::XAieRscMgrBackend::getRscStats	(	std::vector< XAieUserRscStat > &	vStats,
		XAieRscBitmapType	BType )

inlinevirtual

This function requests resource statistics of the statically allocated resources

Parameters

reference	to list of stats requests
Bitmap	type request is for

Returns: XAIE_OK for success, error code for failure

Reimplemented in xaiefal::XAieRscMgrGeneric.

◆ loadRscBitmaps()

virtual AieRC xaiefal::XAieRscMgrBackend::loadRscBitmaps	(	const char *	MetaData,
		uint64_t	NumBitmaps )

inlinevirtual

This function reads the resources metadata and loads it into the static resource bitmaps.

Parameters

MetaData	metadata to load static resource bitmaps
NumBitmaps	number of resource bitmaps in the metadata

Returns: XAIE_OK for success, error code for failure

Reimplemented in xaiefal::XAieRscMgrGeneric.

◆ release() [1/2]

AieRC xaiefal::XAieRscMgrBackend::release ( std::vector< XAieUserRsc > & RscRel )

inline

This function releases the list of resources from runtime and static bitmaps

Parameters

reference to list of resources

Returns: XAIE_OK for success, error code for failure

◆ release() [2/2]

virtual AieRC xaiefal::XAieRscMgrBackend::release ( XAieUserRsc & RscRel )

inlinevirtual

This function releases the resource from runtime and static bitmaps.

Parameters

reference to resource

Returns: XAIE_OK for success, error code for failure

Reimplemented in xaiefal::XAieRscMgrGeneric.

◆ request() [1/2]

AieRC xaiefal::XAieRscMgrBackend::request ( std::vector< XAieUserRsc > & RscReq )

inline

This function checks for resource availibility and will reserve the list resources if available

Parameters

reference to list of resource

Returns: XAIE_OK for success, error code for failure

◆ request() [2/2]

virtual AieRC xaiefal::XAieRscMgrBackend::request ( XAieUserRsc & RscReq )

inlinevirtual

This function checks for resource availibility and will reserve the resources if available

Parameters

reference to a resource

Returns: XAIE_OK for success, error code for failure

Reimplemented in xaiefal::XAieRscMgrGeneric.

◆ requestAllocated() [1/2]

AieRC xaiefal::XAieRscMgrBackend::requestAllocated ( std::vector< XAieUserRsc > & RscReq )

inline

This function checks for resource availibility of a list of specific resources and will reserve the resources if available.

Parameters

reference to list of resource

Returns: XAIE_OK for success, error code for failure

◆ requestAllocated() [2/2]

virtual AieRC xaiefal::XAieRscMgrBackend::requestAllocated ( XAieUserRsc & RscReq )

inlinevirtual

This function checks for resource availibility of a specific resource and will reserve the resources if available.

Parameters

reference to a specific resource

Returns: XAIE_OK for success, error code for failure

Reimplemented in xaiefal::XAieRscMgrGeneric.

◆ requestBc()

virtual AieRC xaiefal::XAieRscMgrBackend::requestBc	(	std::vector< XAieUserRsc > &	RscReq,
		bool	isBcAll )

inlinevirtual

This function checks for resource availibility of a broadcast resource and will reserve the resources if available.

Parameters

reference to list of resource

Returns: XAIE_OK for success, error code for failure

Reimplemented in xaiefal::XAieRscMgrGeneric.

◆ requestContiguous()

virtual AieRC xaiefal::XAieRscMgrBackend::requestContiguous ( std::vector< XAieUserRsc > & RscReq )

inlinevirtual

This function checks for resource availibility and will reserve the amount of resources needed contiguously

Parameters

reference to list of resource

Returns: XAIE_OK for success, error code for failure

Reimplemented in xaiefal::XAieRscMgrGeneric.

◆ writeRscBitmaps()

virtual AieRC xaiefal::XAieRscMgrBackend::writeRscBitmaps	(	std::ofstream &	Fs,
		uint64_t &	NumRscs )

inlinevirtual

This function writes the runtime resource bitmaps to the given ofstream object. NumRscs is updated with number bitmaps written.

Parameters

Fs	ofstream to write bitmaps too
NumRscs	is updated with number of bitmaps written

Returns: XAIE_OK for success, error code for failure

Reimplemented in xaiefal::XAieRscMgrGeneric.

Field Documentation

◆ AieHd

XAieDevHandle* xaiefal::XAieRscMgrBackend::AieHd

protected

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

src/rsc/xaiefal-rscmgr-backend-base.hpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ XAieRscMgrBackend() [1/2]

◆ XAieRscMgrBackend() [2/2]

Member Function Documentation

◆ dev()

◆ free() [1/2]

◆ free() [2/2]

◆ getRscStats()

◆ loadRscBitmaps()

◆ release() [1/2]

◆ release() [2/2]

◆ request() [1/2]

◆ request() [2/2]

◆ requestAllocated() [1/2]

◆ requestAllocated() [2/2]

◆ requestBc()

◆ requestContiguous()

◆ writeRscBitmaps()

Field Documentation

◆ AieHd