TheRock/rocm-libraries/projects/miopen/test/gtest/miopendriver_common.hpp

/*******************************************************************************
 *
 * MIT License
 *
 * Copyright (c) 2024 Advanced Micro Devices, Inc.
 *
 * 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.
 *
 *******************************************************************************/
#pragma once

#include <gmock/gmock.h>
#include <gtest/gtest.h>
#include <gtest/gtest_common.hpp>

#include <miopen/process.hpp>
#include <miopen/filesystem.hpp>

#ifdef __linux__
#include <dlfcn.h>
#else
#include <windows.h>
#endif

using ::testing::HasSubstr;
using ::testing::Not;

namespace miopendriver::basearg {
namespace conv {
static const std::string Float    = "conv";
static const std::string Half     = "convfp16";
static const std::string BFloat16 = "convbfp16";
} // namespace conv

namespace pool {
static const std::string Float    = "pool";
static const std::string Half     = "poolfp16";
static const std::string BFloat16 = "poolbfp16";
} // namespace pool

namespace gemm {
static const std::string Float = "gemm";
static const std::string Half  = "gemmfp16";
} // namespace gemm

namespace bn {
static const std::string Float = "bnorm";
static const std::string Half  = "bnormfp16";
} // namespace bn
} // namespace miopendriver::basearg

// Note: Assuming that the MIOpenDriver executable will be beside the testing output location.
static inline miopen::fs::path MIOpenDriverExePath()
{
#ifdef __linux__
    static const std::string MIOpenDriverExeName = "MIOpenDriver";
    miopen::fs::path path                        = miopen::fs::canonical("/proc/self/exe");

    if(!path.empty())
    {
        path = path.parent_path();
        path /= MIOpenDriverExeName;
    }
    return path;
#else
    static const std::string MIOpenDriverExeName = "MIOpenDriver.exe";

    // Use dynamic buffer to support long paths (up to 32767 characters)
    std::wstring modulePath(32767, L'\0');
    DWORD len =
        GetModuleFileNameW(nullptr, modulePath.data(), static_cast<DWORD>(modulePath.size()));
    if(len == 0)
        return {};

    modulePath.resize(len);

    // miopen::fs::path is std::filesystem::path which supports long paths
    miopen::fs::path path(modulePath);
    path = path.parent_path();
    return path / MIOpenDriverExeName;
#endif
}

static inline void
RunMIOpenDriverTestCommand(const std::vector<std::string>& params,
                           const miopen::ProcessEnvironmentMap& additionalEnvironmentVariables = {})
{
    for(const auto& testArguments : params)
    {
        int commandResult = 0;
        miopen::Process p{MIOpenDriverExePath().string()};
        std::stringstream ss;

        EXPECT_NO_THROW(commandResult = p(testArguments, "", &ss, additionalEnvironmentVariables));
        EXPECT_EQ(commandResult, 0)
            << "MIOpenDriver exited with non-zero value when running with arguments: "
            << testArguments;
        EXPECT_THAT(ss.str(), Not(HasSubstr("FAILED")));
    }
}

template <typename disabled_mask, typename enabled_mask>
static inline bool ShouldRunMIOpenDriverTest()
{
#if MIOPEN_BUILD_DRIVER
    return IsTestSupportedForDevMask<disabled_mask, enabled_mask>();
#else
    return false;
#endif
}