TheRock/rocm-libraries/projects/hipdnn/frontend/include/hipdnn_frontend/detail/HipdnnBackendInterface.hpp

// Copyright © Advanced Micro Devices, Inc., or its affiliates.
// SPDX-License-Identifier:  MIT

#pragma once

#include <cstdint>
#include <memory>
#include <mutex>
#include <utility>

#include <hipdnn_backend.h>
#include <hipdnn_data_sdk/Visibility.hpp>
#include <hipdnn_data_sdk/utilities/VersionUtils.hpp>

namespace hipdnn_frontend::detail
{

class IHipdnnBackend
{
public:
    virtual ~IHipdnnBackend() = default;

    virtual hipdnnStatus_t create(hipdnnHandle_t* handle) = 0;
    virtual hipdnnStatus_t destroy(hipdnnHandle_t handle) = 0;
    virtual hipdnnStatus_t setStream(hipdnnHandle_t handle, hipStream_t streamId) = 0;
    virtual hipdnnStatus_t getStream(hipdnnHandle_t handle, hipStream_t* streamId) = 0;
    virtual hipdnnStatus_t backendCreateDescriptor(hipdnnBackendDescriptorType_t descriptorType,
                                                   hipdnnBackendDescriptor_t* descriptor)
        = 0;
    virtual hipdnnStatus_t backendDestroyDescriptor(hipdnnBackendDescriptor_t descriptor) = 0;
    virtual hipdnnStatus_t backendExecute(hipdnnHandle_t handle,
                                          hipdnnBackendDescriptor_t executionPlan,
                                          hipdnnBackendDescriptor_t variantPack)
        = 0;
    virtual hipdnnStatus_t backendFinalize(hipdnnBackendDescriptor_t descriptor) = 0;
    virtual hipdnnStatus_t backendGetAttribute(hipdnnBackendDescriptor_t descriptor,
                                               hipdnnBackendAttributeName_t attributeName,
                                               hipdnnBackendAttributeType_t attributeType,
                                               int64_t requestedElementCount,
                                               int64_t* elementCount,
                                               void* arrayOfElements)
        = 0;
    virtual hipdnnStatus_t backendSetAttribute(hipdnnBackendDescriptor_t descriptor,
                                               hipdnnBackendAttributeName_t attributeName,
                                               hipdnnBackendAttributeType_t attributeType,
                                               int64_t elementCount,
                                               const void* arrayOfElements)
        = 0;
    virtual const char* getErrorString(hipdnnStatus_t status) = 0;
    virtual void getLastErrorString(char* message, size_t maxSize) = 0;
    virtual hipdnn_data_sdk::utilities::Version version() = 0;
    virtual const char* versionString() = 0;
    virtual hipdnnStatus_t backendCreateAndDeserializeGraphExt(
        hipdnnBackendDescriptor_t* descriptor, const uint8_t* serializedGraph, size_t graphByteSize)
        = 0;
    virtual hipdnnStatus_t backendGetSerializedBinaryGraphExt(hipdnnBackendDescriptor_t descriptor,
                                                              size_t requestedByteSize,
                                                              size_t* graphByteSize,
                                                              uint8_t* serializedGraph)
        = 0;
    virtual hipdnnStatus_t backendGetSerializedJsonGraphExt(hipdnnBackendDescriptor_t descriptor,
                                                            size_t requestedByteSize,
                                                            size_t* graphByteSize,
                                                            char* serializedJsonGraph)
        = 0;
    virtual hipdnnStatus_t backendCreateAndDeserializeJsonGraphExt(
        hipdnnBackendDescriptor_t* descriptor, const char* jsonGraph, size_t jsonByteSize)
        = 0;
    virtual hipdnnStatus_t
        backendGetSerializedExecutionPlanExt(hipdnnBackendDescriptor_t descriptor,
                                             size_t requestedByteSize,
                                             size_t* planByteSize,
                                             uint8_t* serializedPlan)
        = 0;
    virtual hipdnnStatus_t
        backendCreateAndDeserializeExecutionPlanExt(hipdnnHandle_t handle,
                                                    hipdnnBackendDescriptor_t* descriptor,
                                                    const uint8_t* serializedPlan,
                                                    size_t planByteSize)
        = 0;
    virtual hipdnnStatus_t
        backendGetSerializedBinaryGraphAndPlanExt(hipdnnBackendDescriptor_t graphDescriptor,
                                                  hipdnnBackendDescriptor_t executionPlanDescriptor,
                                                  size_t requestedByteSize,
                                                  size_t* blobByteSize,
                                                  uint8_t* serializedBlob)
        = 0;
    virtual hipdnnStatus_t backendGetSerializedBinaryContentsExt(const uint8_t* serializedBlob,
                                                                 size_t blobByteSize,
                                                                 int* contentFlags)
        = 0;
    virtual void loggingCallbackExt(hipdnnSeverity_t severity, const char* msg) = 0;

    virtual hipdnnStatus_t setEnginePluginPathsExt(size_t numPaths,
                                                   const char* const* pluginPaths,
                                                   hipdnnPluginLoadingMode_ext_t mode)
        = 0;

    virtual hipdnnStatus_t setHeuristicPluginPathsExt(size_t numPaths,
                                                      const char* const* pluginPaths,
                                                      hipdnnPluginLoadingMode_ext_t mode)
        = 0;

    virtual hipdnnStatus_t getLoadedEnginePluginPathsExt(hipdnnHandle_t handle,
                                                         size_t* numPluginPaths,
                                                         char** pluginPaths,
                                                         size_t* maxStringLen)
        = 0;

    // RFC 0007 Section 16: Heuristic policy enumeration
    virtual hipdnnStatus_t getHeuristicPolicyCount(hipdnnHandle_t handle, size_t* numPolicies) = 0;

    virtual hipdnnStatus_t getHeuristicPolicyInfo(hipdnnHandle_t handle,
                                                  size_t policyIndex,
                                                  int64_t* policyId,
                                                  char* policyName,
                                                  size_t* policyNameLen,
                                                  char* pluginName,
                                                  size_t* pluginNameLen,
                                                  char* pluginVersion,
                                                  size_t* pluginVersionLen,
                                                  char* apiVersion,
                                                  size_t* apiVersionLen)
        = 0;

    virtual hipdnnStatus_t setUserLogCallbackExt(hipdnnUserLogCallback_t callback,
                                                 hipdnnSeverity_t minLevel,
                                                 hipdnnLogCallbackMode_t mode,
                                                 hipdnnUserLogCallbackHandle_t userHandle)
        = 0;
    virtual hipdnnStatus_t backendSetGlobalLogLevelExt(hipdnnSeverity_t level) = 0;
    virtual hipdnnStatus_t backendGetGlobalLogLevelExt(hipdnnSeverity_t* level) = 0;

    // HIPDNN_HIDDEN on accessor functions ensures each shared object has its own backendInstance
    HIPDNN_HIDDEN static std::shared_ptr<IHipdnnBackend> getInstance()
    {
        const std::lock_guard<std::mutex> lock(backendMutex());
        return backendInstance();
    }

    template <typename BackendFactory>
    HIPDNN_HIDDEN static std::shared_ptr<IHipdnnBackend>
        getOrCreateInstance(BackendFactory&& factory)
    {
        const std::lock_guard<std::mutex> lock(backendMutex());
        auto& instance = backendInstance();
        if(!instance)
        {
            instance = std::forward<BackendFactory>(factory)();
        }

        return instance;
    }

    HIPDNN_HIDDEN static void setInstance(std::shared_ptr<IHipdnnBackend> instance)
    {
        const std::lock_guard<std::mutex> lock(backendMutex());
        backendInstance() = std::move(instance);
    }

    HIPDNN_HIDDEN static void resetInstance()
    {
        const std::lock_guard<std::mutex> lock(backendMutex());
        backendInstance().reset();
    }

private:
    HIPDNN_HIDDEN static std::shared_ptr<IHipdnnBackend>& backendInstance()
    {
        static std::shared_ptr<IHipdnnBackend> s_instance;
        return s_instance;
    }

    HIPDNN_HIDDEN static std::mutex& backendMutex()
    {
        static std::mutex s_mtx;
        return s_mtx;
    }
};

} // namespace hipdnn_frontend::detail