xaiefal::XAieRscMgrGeneric Class Reference

Resource Manager Backend Generic Class. More...

#include <xaiefal-rscmgr-generic.hpp>

Inheritance diagram for xaiefal::XAieRscMgrGeneric:

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

Additional Inherited Members
Protected Attributes inherited from xaiefal::XAieRscMgrBackend
XAieDevHandle *	AieHd

Detailed Description

Resource Manager Backend Generic Class.

Constructor & Destructor Documentation

XAieRscMgrGeneric() [1/2]

xaiefal::XAieRscMgrGeneric::XAieRscMgrGeneric ( )

delete

XAieRscMgrGeneric() [2/2]

xaiefal::XAieRscMgrGeneric::XAieRscMgrGeneric ( XAieDevHandle * DevHd )

inline

~XAieRscMgrGeneric()

xaiefal::XAieRscMgrGeneric::~XAieRscMgrGeneric ( )

inline

Member Function Documentation

free()

AieRC xaiefal::XAieRscMgrGeneric::free ( XAieUserRsc & RscFree )

inlinevirtual

This function frees a resource from just the runtime bitmap.

Parameters

reference

to resource

Returns

XAIE_OK for success, error code for failure

Reimplemented from xaiefal::XAieRscMgrBackend.

getRscStats()

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

inlinevirtual

This function requests resource statistics for static or available resources

Returns

XAIE_OK for success, error code for failure

Reimplemented from xaiefal::XAieRscMgrBackend.

loadRscBitmaps()

AieRC xaiefal::XAieRscMgrGeneric::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 from xaiefal::XAieRscMgrBackend.

release()

AieRC xaiefal::XAieRscMgrGeneric::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 from xaiefal::XAieRscMgrBackend.

request()

AieRC xaiefal::XAieRscMgrGeneric::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

Check Static and runtime bitmaps find resource available in both

Reimplemented from xaiefal::XAieRscMgrBackend.

requestAllocated()

AieRC xaiefal::XAieRscMgrGeneric::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 from xaiefal::XAieRscMgrBackend.

requestBc()

AieRC xaiefal::XAieRscMgrGeneric::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 from xaiefal::XAieRscMgrBackend.

requestContiguous()

AieRC xaiefal::XAieRscMgrGeneric::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 from xaiefal::XAieRscMgrBackend.

writeRscBitmaps()

AieRC xaiefal::XAieRscMgrGeneric::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 from xaiefal::XAieRscMgrBackend.

---

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

• src/rsc/xaiefal-rscmgr-generic.hpp