xaiefal::XAieRscMgr Class Reference

Resource Manager class. More...

#include <xaiefal-rscmgr.hpp>

Public Member Functions
	XAieRscMgr ()=delete
	XAieRscMgr (XAieDevHandle *DevHd)
	~XAieRscMgr ()
AieRC	request (XAieRsc &Rsc)
AieRC	release (XAieRsc &Rsc)
AieRC	free (XAieRsc &Rsc)
AieRC	getStaticRscs (std::vector< XAieUserRscStat > &vStats)
AieRC	getAvailRscs (std::vector< XAieUserRscStat > &vStats)
AieRC	saveAllocatedRscs (const std::string &File)
AieRC	loadStaticRscs (const char *MetaData)
AieRC	reserveEcc ()
AieRC	reserveErrorHandling ()
XAie_DevInst *	dev ()

Protected Attributes
XAieDevHandle *	AieHd
std::shared_ptr< XAieRscMgrBackend >	Backend

Detailed Description

Resource Manager class.

Constructor & Destructor Documentation

XAieRscMgr() [1/2]

xaiefal::XAieRscMgr::XAieRscMgr ( )

delete

XAieRscMgr() [2/2]

xaiefal::XAieRscMgr::XAieRscMgr ( XAieDevHandle * DevHd )

inline

~XAieRscMgr()

xaiefal::XAieRscMgr::~XAieRscMgr ( )

inline

Member Function Documentation

dev()

XAie_DevInst * xaiefal::XAieRscMgr::dev ( )

inline

free()

AieRC xaiefal::XAieRscMgr::free ( XAieRsc & Rsc )

inline

This function makes a call to RscMgr Backend to free a resource

Parameters

Rsc	reference to any resource class inherited from XAieRsc

Returns

XAIE_OK for success, error code for failure

Note

Will only remove resource from runtime bitmaps, does not affect static bitmaps

getAvailRscs()

AieRC xaiefal::XAieRscMgr::getAvailRscs ( std::vector< XAieUserRscStat > & vStats )

inline

This function requests resource statistics of the available resources (will check static and runtime bitmaps).

Returns

XAIE_OK for success, error code for failure

getStaticRscs()

AieRC xaiefal::XAieRscMgr::getStaticRscs ( std::vector< XAieUserRscStat > & vStats )

inline

This function requests resource statistics of the statically allocated resources

Returns

XAIE_OK for success, error code for failure

loadStaticRscs()

AieRC xaiefal::XAieRscMgr::loadStaticRscs ( const char * MetaData )

inline

release()

AieRC xaiefal::XAieRscMgr::release ( XAieRsc & Rsc )

inline

This function makes a call to RscMgr Backend to release a resource

Parameters

Rsc	reference to any resource class inherited from XAieRsc

Returns

XAIE_OK for success, error code for failure

Note

Will remove resource from runtime and static bitmaps

request()

AieRC xaiefal::XAieRscMgr::request ( XAieRsc & Rsc )

inline

This function makes a call to RscMgr Backend to request a resource

Parameters

Rsc	reference to any resource class inherited from XAieRsc

Returns

XAIE_OK for success, error code for failure

reserveEcc()

AieRC xaiefal::XAieRscMgr::reserveEcc ( )

inline

This function makes a call to RscMgr Backend to reserve resources necessary for ECC

Returns

XAIE_OK for success, error code for failure

reserveErrorHandling()

AieRC xaiefal::XAieRscMgr::reserveErrorHandling ( )

inline

This function makes a call to RscMgr Backend to reserve resources necessary for Error Handling

Returns

XAIE_OK for success, error code for failure

saveAllocatedRscs()

AieRC xaiefal::XAieRscMgr::saveAllocatedRscs ( const std::string & File )

inline

This function saves the runtime allocated resources to the given file name.

Returns

XAIE_OK for success, error code for failure

Field Documentation

AieHd

XAieDevHandle* xaiefal::XAieRscMgr::AieHd

protected

AI engine device instance

Backend

std::shared_ptr<XAieRscMgrBackend> xaiefal::XAieRscMgr::Backend

protected

Resource manager backend

---

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

• src/rsc/xaiefal-rscmgr.hpp