ClassRegistry.h

Go to the documentation of this file.

/*
* SPDX-FileCopyrightText: Copyright (c) 2020-2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
* SPDX-License-Identifier: MIT
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
 
 
#ifndef NVNEURAL_CLASSREGISTRY_H
#define NVNEURAL_CLASSREGISTRY_H
 
#include <nvneural/CoreTypes.h>
#include <nvneural/CoreHelpers.h>
#include <nvneural/RefObject.h>
#include <functional>
#include <map>
#include <string>
#include <vector>
 
#include "LayerDescHostContainer.h"
#include "ActivationDescHostContainer.h"
#include "PrototypeDescHostContainer.h"
 
namespace nvneural {
    class INetwork;
    class IPlugin;
    class IPluginLoader;
 
    struct OpaqueClassRegistration;
 
    using OpaqueClassRegistrationHandle = OpaqueClassRegistration*;
 
    class ClassRegistry : public refobj::RefObjectBase<refobj::Implements<IClassRegistry>>
    {
    public:
        using CreationFunction = IRefObject*(*)();
 
        ClassRegistry();
        ~ClassRegistry();
 
        NeuralResult importPlugin(IPlugin* pPlugin) override final;
        NeuralResult importPluginLoader(IPluginLoader* pPluginLoader) override final;
 
        NeuralResult createObject(IRefObject** ppOut, const char* pObjectClass) const noexcept override final;
 
        std::size_t exportedActivationsCount() const noexcept override final;
        const ActivationDesc* exportedActivationByIndex(std::size_t index) const noexcept override final;
        std::size_t exportedLayersCount() const noexcept override final;
        const LayerDesc* exportedLayerByIndex(std::size_t index) const noexcept override final;
        std::size_t exportedFusingRulesCount() const noexcept override final;
        const FusingRule* exportedFusingRuleByIndex(std::size_t index) const noexcept override final;
        std::size_t exportedPrototypesCount() const noexcept override final;
        const PrototypeDesc* exportedPrototypeByIndex(std::size_t index) const noexcept override final;
        PrototypeRuntimeValidatorFunction exportedPrototypeRuntimeValidatorByIndex(std::size_t index) const noexcept override final;
 
        bool isPrototypeRuntimeCompatible(const char* pPrototypeObjectClass, const INetwork* pNetwork) const override final;
 
        template<typename TObject>
        static OpaqueClassRegistrationHandle registerObjectClass(const char* pObjectClass)
        {
            return registerObjectClassInternal(pObjectClass, []() -> IRefObject* { return static_cast<IRefObject*>(static_cast<void*>(new TObject)); });
        }
 
        template<typename TObject>
        static OpaqueClassRegistrationHandle registerLayer(const LayerDesc& layerDesc)
        {
            // Keep note that this layerDesc is in terms of the plugin's LayerDesc.
            registerLayerDesc(&layerDesc);
            return registerObjectClass<TObject>(layerDesc.pObjectClass);
        }
 
        template<typename TObject>
        static OpaqueClassRegistrationHandle registerActivation(const ActivationDesc& activationDesc)
        {
            // Keep note that this activationDesc is in terms of the plugin's activationDesc.
            registerActivationDesc(&activationDesc);
            return registerObjectClass<TObject>(activationDesc.pObjectClass);
        }
 
        template<typename TObject>
        static OpaqueClassRegistrationHandle registerPrototype(const PrototypeDesc& prototypeDesc, PrototypeRuntimeValidatorFunction runtimeValidator)
        {
            registerPrototypeDesc(&prototypeDesc, runtimeValidator);
            return registerObjectClass<TObject>(prototypeDesc.pObjectClass);
        }
 
        static OpaqueClassRegistrationHandle registerFusingRule(std::uint32_t syntaxVersion, const char* pFusingRule);
 
        static OpaqueClassRegistrationHandle registerActivationDesc(const ActivationDesc* pActivationDesc);
 
        static OpaqueClassRegistrationHandle registerLayerDesc(const LayerDesc* pLayerDesc);
 
        static OpaqueClassRegistrationHandle registerPrototypeDesc(const PrototypeDesc* pPrototypeDesc, PrototypeRuntimeValidatorFunction runtimeValidator);
 
        static OpaqueClassRegistrationHandle registerObjectClassInternal(const char* pObjectClass, CreationFunction classFactory);
 
    private:
        void loadStaticRegistrations();
 
        bool registerImportedActivationDesc(const ActivationDesc* pImportedActivationDesc);
        bool registerImportedLayerDesc(const LayerDesc* pImportedLayerDesc);
        bool registerImportedPrototypeDesc(const PrototypeDesc* pImportPrototypeDesc);
 
        std::vector<RefPtr<IPlugin>> m_loadedPlugins;
 
        std::vector<ActivationDescHostContainer> m_exportedActivationHostContainers;
        std::vector<LayerDescHostContainer> m_exportedLayerHostContainers;
        std::vector<PrototypeDescHostContainer> m_exportedPrototypeHostContainers;
 
        std::vector<const ActivationDesc*> m_exportedActivations;
        std::vector<const LayerDesc*> m_exportedLayers;
        std::vector<const FusingRule*> m_exportedFusingRules;
        std::vector<const PrototypeDesc*> m_exportedPrototypes;
 
        std::map<std::string, CreationFunction> m_objectTypes;
        std::map<std::string, PrototypeRuntimeValidatorFunction> m_exportedPrototypeRuntimeValidators;
    };
}
 
#endif // NVNEURAL_CLASSREGISTRY_H