DynamicBackend Class Reference

#include <DynamicBackend.hpp>

Public Types
using	HandleCloser = std::function< void(const void *)>
using	HandlePtr = std::unique_ptr< void, HandleCloser >

Public Member Functions
	DynamicBackend (const void *sharedObjectHandle)
BackendId	GetBackendId ()
	Public dynamic backend functions. More...
BackendVersion	GetBackendVersion ()
IBackendInternalUniquePtr	GetBackend ()
BackendRegistry::FactoryFunction	GetFactoryFunction ()

Detailed Description

Definition at line 20 of file DynamicBackend.hpp.

Member Typedef Documentation

HandleCloser

using HandleCloser = std::function<void(const void*)>

Definition at line 23 of file DynamicBackend.hpp.

HandlePtr

using HandlePtr = std::unique_ptr<void, HandleCloser>

Definition at line 24 of file DynamicBackend.hpp.

Constructor & Destructor Documentation

DynamicBackend()

DynamicBackend ( const void *  sharedObjectHandle )

explicit

Definition at line 12 of file DynamicBackend.cpp.

    : m_BackendIdFunction(nullptr)
    , m_BackendVersionFunction(nullptr)
    , m_BackendFactoryFunction(nullptr)
    , m_Handle(const_cast<void*>(sharedObjectHandle), &DynamicBackendUtils::CloseHandle)
{
    if (m_Handle == nullptr)
    {
        throw InvalidArgumentException("Cannot create a DynamicBackend object from an invalid shared object handle");
    }
 
    // These calls will throw in case of error
    m_BackendIdFunction      = SetFunctionPointer<IdFunctionType>("GetBackendId");
    m_BackendVersionFunction = SetFunctionPointer<VersionFunctionType>("GetVersion");
    m_BackendFactoryFunction = SetFunctionPointer<FactoryFunctionType>("BackendFactory");
 
    // Check that the backend is compatible with the current Backend API
    BackendId backendId = GetBackendId();
    BackendVersion backendVersion = GetBackendVersion();
    if (!DynamicBackendUtils::IsBackendCompatible(backendVersion))
    {
        // This exception message could not be formatted simply using fmt::format
        std::stringstream message;
        message << "The dynamic backend " << backendId << " (version " << backendVersion <<
        ") is not compatible with the current Backend API (version " << IBackendInternal::GetApiVersion() << ")";
 
        throw RuntimeException(message.str());
    }
}

References IBackendInternal::GetApiVersion(), DynamicBackend::GetBackendId(), DynamicBackend::GetBackendVersion(), and DynamicBackendUtils::IsBackendCompatible().

Member Function Documentation

GetBackend()

IBackendInternalUniquePtr GetBackend

(

)

Definition at line 72 of file DynamicBackend.cpp.

{
    // This call throws in case of error
    return CreateBackend();
}

GetBackendId()

BackendId GetBackendId

(

)

Public dynamic backend functions.

Definition at line 42 of file DynamicBackend.cpp.

{
    if (m_BackendIdFunction == nullptr)
    {
        throw RuntimeException("GetBackendId error: invalid function pointer");
    }
 
    const char* backendId = m_BackendIdFunction();
    if (backendId == nullptr)
    {
        throw RuntimeException("GetBackendId error: invalid backend id");
    }
 
    return BackendId(backendId);
}

Referenced by DynamicBackend::DynamicBackend().

GetBackendVersion()

BackendVersion GetBackendVersion

(

)

Definition at line 58 of file DynamicBackend.cpp.

{
    if (m_BackendVersionFunction == nullptr)
    {
        throw RuntimeException("GetBackendVersion error: invalid function pointer");
    }
 
    uint32_t major = 0;
    uint32_t minor = 0;
    m_BackendVersionFunction(&major, &minor);
 
    return BackendVersion{ major, minor };
}

Referenced by DynamicBackend::DynamicBackend().

GetFactoryFunction()

BackendRegistry::FactoryFunction GetFactoryFunction

(

)

Definition at line 78 of file DynamicBackend.cpp.

{
    if (m_BackendFactoryFunction == nullptr)
    {
        throw RuntimeException("GetFactoryFunction error: invalid function pointer");
    }
 
    return [this]() -> IBackendInternalUniquePtr
    {
        // This call throws in case of error
        return CreateBackend();
    };
}

---

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

• include/armnn/backends/DynamicBackend.hpp
• src/backends/backendsCommon/DynamicBackend.cpp