DynamicPluginLoader.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_DYNAMICPLUGINLOADER_H
#define NVNEURAL_DYNAMICPLUGINLOADER_H
 
#include <nvneural/CoreHelpers.h>
#include <nvneural/PluginTypes.h>
#include <nvneural/RefObject.h>
#include <string>
#include <vector>
 
namespace nvneural {
 
class DynamicPluginLoader : public refobj::RefObjectBase<refobj::Implements<IPluginLoader>>
{
public:
    NeuralResult loadLibrary(const char* pFilename, IPlugin** ppPluginOut) noexcept override;
 
    NeuralResult loadDirectory(const char* pPathname, std::uint32_t* pNumberLoadedOut) noexcept override;
 
    NeuralResult releasePlugin(IPlugin* pPlugin) noexcept override;
    NeuralResult releaseAllPlugins() noexcept override;
 
    std::size_t pluginCount() const noexcept override;
    IPlugin* getPluginByIndex(std::size_t pluginIndex) const noexcept override;
    NeuralResult getPluginPath(const IPlugin* pPlugin, const char** ppPluginPathOut) const noexcept override;
 
    void allowIncompatiblePlugins() noexcept override;
 
private:
    struct LoadedPlugin
    {
        IPlugin* pPlugin; // managed directly
        void* pLibrary; // HMODULE on Windows, void* on Linux
        std::string path;
 
        LoadedPlugin(IPlugin* pPlugin_, void* pLibrary_, const std::string& path_);
        ~LoadedPlugin(); // frees library on destruction
 
        // Disallow copy operations because we don't want to support multiply loaded libraries
        LoadedPlugin(const LoadedPlugin& copyFrom) = delete;
        LoadedPlugin& operator =(const LoadedPlugin& copyFrom) = delete;
 
        // Explicit move operations are needed to prevent double-freeing of plugin resources
        LoadedPlugin(LoadedPlugin&& moveFrom);
        LoadedPlugin& operator =(LoadedPlugin&& moveFrom);
    };
    std::vector<LoadedPlugin> m_loadedPlugins;
 
    bool m_allowIncompatiblePlugins = false;
    bool m_warnedAboutIncompatiblePlugins = false;
 
    bool isIncompatiblePlugin(const IPlugin* pPlugin) const noexcept;
 
#if defined(_WIN32) || defined(DOXYGEN)
    NeuralResult loadDynamicLibrary(const std::u16string& libraryPath) noexcept;
#endif
};
 
} // namespace nvneural
 
#endif // NVNEURAL_DYNAMICPLUGINLOADER_H