TheRock/rocm-libraries/projects/rocwmma/test/gemm/gemm_test.hpp

/*******************************************************************************
 *
 * MIT License
 *
 * Copyright (C) 2021-2025 Advanced Micro Devices, Inc. All rights reserved.
 *
 * 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 ROCWMMA_GEMM_TEST_BASE_HPP
#define ROCWMMA_GEMM_TEST_BASE_HPP

#include <gtest/gtest.h>

#include "gemm_common_test_params.hpp"
#include "gemm_kernel_base.hpp"
#include "rocwmma_options.hpp"

namespace rocwmma
{
    struct GemmTest
        : public ::testing::TestWithParam<std::tuple<typename GemmCommonTestParams::KernelT,
                                                     typename GemmCommonTestParams::ThreadBlockT,
                                                     typename GemmCommonTestParams::ProblemSizeT,
                                                     typename GemmCommonTestParams::AlphaT,
                                                     typename GemmCommonTestParams::BetaT>>
    {
        using Base
            = ::testing::TestWithParam<std::tuple<typename GemmCommonTestParams::KernelT,
                                                  typename GemmCommonTestParams::ThreadBlockT,
                                                  typename GemmCommonTestParams::ProblemSizeT,
                                                  typename GemmCommonTestParams::AlphaT,
                                                  typename GemmCommonTestParams::BetaT>>;

        void SetUp() override
        {
            // Construct ProblemParams from
            // incoming gtest parameterization
            auto param       = Base::GetParam();
            auto kernel      = std::get<0>(param);
            auto threadBlock = std::get<1>(param);
            auto problemSize = std::get<2>(param);
            auto alpha       = std::get<3>(param);
            auto beta        = std::get<4>(param);

            // Cleanup previously used resources if the resource context changes.
            // This happens in GEMM when the Input/Output types change for test batches.
            // Eg. tests change from f16 to f32
            static HipResource* sLastResourceRun = nullptr;
            if(sLastResourceRun && sLastResourceRun != kernel->getResource())
            {
                sLastResourceRun->reset();
            }
            sLastResourceRun = kernel->getResource();

            ProblemParams params = {threadBlock, problemSize, alpha, beta};

            // Walk through kernel workflow
            kernel->setup(params);
        }

        virtual void RunKernel()
        {
            // Construct ProblemParams from
            // incoming gtest parameterization
            auto param  = Base::GetParam();
            auto kernel = std::get<0>(param);

            using Options        = rocwmma::RocwmmaOptions;
            auto& loggingOptions = Options::instance();

            // Invoke first kernel to warm up device
            static bool ranWarmup = false;
            if(!ranWarmup)
            {
                kernel->exec();
                ranWarmup = true;

                // Note: Kernel should be re-initialized after
                // running warmup
                this->SetUp();
            }

            kernel->exec();
            kernel->validateResults();

            if(!loggingOptions->omitCout())
            {
                kernel->reportResults(std::cout,
                                      KernelI::sHeaderPrinted,
                                      loggingOptions->omitSkipped(),
                                      loggingOptions->omitFailed(),
                                      loggingOptions->omitPassed());
            }

            if(loggingOptions->ostream().isOpen())
            {
                kernel->reportResults(loggingOptions->ostream().fstream(),
                                      KernelI::sHeaderPrinted,
                                      loggingOptions->omitSkipped(),
                                      loggingOptions->omitFailed(),
                                      loggingOptions->omitPassed());
            }

            // Print the header only once
            if(!KernelI::sHeaderPrinted)
            {
                KernelI::sHeaderPrinted = true;
            }
        }

        virtual void RunKernelWithoutWarmup()
        {
            // Construct ProblemParams from
            // incoming gtest parameterization
            auto param  = Base::GetParam();
            auto kernel = std::get<0>(param);

            using Options        = rocwmma::RocwmmaOptions;
            auto& loggingOptions = Options::instance();

            kernel->exec();
            kernel->validateResults();

            if(!loggingOptions->omitCout())
            {
                kernel->reportResults(std::cout,
                                      KernelI::sHeaderPrinted,
                                      loggingOptions->omitSkipped(),
                                      loggingOptions->omitFailed(),
                                      loggingOptions->omitPassed());
            }

            if(loggingOptions->ostream().isOpen())
            {
                kernel->reportResults(loggingOptions->ostream().fstream(),
                                      KernelI::sHeaderPrinted,
                                      loggingOptions->omitSkipped(),
                                      loggingOptions->omitFailed(),
                                      loggingOptions->omitPassed());
            }

            // Print the header only once
            if(!KernelI::sHeaderPrinted)
            {
                KernelI::sHeaderPrinted = true;
            }
        }

        void TearDown() override
        {
            // Construct ProblemParams from
            // incoming gtest parameterization
            auto param  = Base::GetParam();
            auto kernel = std::get<0>(param);
            kernel->tearDown();
        }
    };

} // namespace rocwmma

#endif // ROCWMMA_GEMM_TEST_BASE_HPP