TheRock/rocm-libraries/projects/hipdnn/backend/tests/TestSharedLibrary.cpp

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

#include <gtest/gtest.h>

#include <hipdnn_data_sdk/utilities/PlatformUtils.hpp>
#include <hipdnn_plugin_sdk/PluginApiDataTypes.h>

#include "HipdnnException.hpp"
#include "PlatformUtils.hpp"
#include "TestPluginConstants.hpp"
#include "descriptors/TestMacros.hpp"
#include "plugin/SharedLibrary.hpp"

using namespace hipdnn_backend;

namespace
{

// NOLINTBEGIN(bugprone-throwing-static-initialization) test constants
const auto TEST_PLUGIN_DIR = std::filesystem::path(plugin_constants::getTestPluginDefaultDir());

const auto LIBRARY_PATH = ".." / TEST_PLUGIN_DIR / TEST_PLUGIN1_NAME;
const auto LIBRARY_PATH_LIB_EXT
    = ".." / TEST_PLUGIN_DIR / hipdnn_data_sdk::utilities::getLibraryName(TEST_PLUGIN1_NAME);

const auto WRONG_LIBRARY_PATH = std::filesystem::path("./wrong_path");
const auto SYMBOL_NAME = std::string("hipdnnPluginGetName");
const auto WRONG_SYMBOL_NAME = std::string("wrong_symbol_name");

const auto FULL_LIBRARY_PATH
    = (hipdnn_backend::platform_utilities::getCurrentModuleDirectory().parent_path()
       / TEST_PLUGIN_DIR / hipdnn_data_sdk::utilities::getLibraryName(TEST_PLUGIN1_NAME));
// NOLINTEND(bugprone-throwing-static-initialization)

}

TEST(TestSharedLibrary, LoadLibrary)
{
    plugin::SharedLibrary library;
    library.load(LIBRARY_PATH);
    library.unload();
}

TEST(TestSharedLibrary, LoadLibraryWithLibExt)
{
    plugin::SharedLibrary library;
    library.load(LIBRARY_PATH_LIB_EXT);
    library.unload();
}

TEST(TestSharedLibrary, LoadLibraryCtor)
{
    const plugin::SharedLibrary library(LIBRARY_PATH);
}

TEST(TestSharedLibrary, LoadLibraryWrongPath)
{
    plugin::SharedLibrary library;
    ASSERT_THROW_HIPDNN_STATUS(library.load(WRONG_LIBRARY_PATH), HIPDNN_STATUS_PLUGIN_ERROR);
    library.unload();
}

TEST(TestSharedLibrary, LoadLibraryCtorWrongPath)
{
    ASSERT_THROW_HIPDNN_STATUS(plugin::SharedLibrary(WRONG_LIBRARY_PATH),
                               HIPDNN_STATUS_PLUGIN_ERROR);
}

TEST(TestSharedLibrary, GetSymbol)
{
    const plugin::SharedLibrary library(LIBRARY_PATH);

    ASSERT_NO_THROW(library.getSymbol(SYMBOL_NAME));
}

TEST(TestSharedLibrary, GetSymbolUninitialized)
{
    const plugin::SharedLibrary library;
    ASSERT_THROW_HIPDNN_STATUS(library.getSymbol(SYMBOL_NAME), HIPDNN_STATUS_INTERNAL_ERROR);
}

TEST(TestSharedLibrary, GetSymbolWrongName)
{
    const plugin::SharedLibrary library(LIBRARY_PATH);

    ASSERT_THROW_HIPDNN_STATUS(library.getSymbol(WRONG_SYMBOL_NAME), HIPDNN_STATUS_PLUGIN_ERROR);
}

TEST(TestSharedLibrary, CallFunction)
{
    const plugin::SharedLibrary library(LIBRARY_PATH);

    // Get the function pointer
    using FuncType = hipdnnPluginStatus_t (*)(const char**);
    auto funcGetName = library.getSymbol<FuncType>(SYMBOL_NAME);

    // Call the function to get the plugin name
    const char* name = nullptr;
    auto status = funcGetName(&name);
    ASSERT_EQ(status, HIPDNN_PLUGIN_STATUS_SUCCESS);
    ASSERT_NE(name, nullptr);
    ASSERT_STREQ(name, "Plugin1");
}

TEST(TestSharedLibrary, GetCurrentModuleDirectoryFromExecutable)
{
    std::filesystem::path path;
    ASSERT_NO_THROW(path = platform_utilities::getCurrentModuleDirectory());

    EXPECT_FALSE(path.empty());
    EXPECT_TRUE(path.is_absolute());
    EXPECT_TRUE(std::filesystem::is_directory(path));

    // Only tests that it works from a statically linked binary
    EXPECT_TRUE(std::filesystem::exists(
        path / hipdnn_data_sdk::utilities::getExecutableName("hipdnn_backend_tests")));
}

class TestSharedLibraryPaths : public ::testing::TestWithParam<std::string>
{
};

TEST_P(TestSharedLibraryPaths, LoadWithValidPathFormats)
{
    const auto& pathParam = GetParam();
    plugin::SharedLibrary library;
    ASSERT_NO_THROW(library.load(pathParam));
}

INSTANTIATE_TEST_SUITE_P(PathVariations,
                         TestSharedLibraryPaths,
                         ::testing::Values(
                             // Path without extension
                             std::string(LIBRARY_PATH.string()),
                             // Path with full filename
                             std::string(FULL_LIBRARY_PATH.string()),
                             // Absolute path
                             std::filesystem::absolute(FULL_LIBRARY_PATH).string()));