TheRock/rocm-libraries/projects/hiptensor/test/02_elementwise/elementwise_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.
 *
 *******************************************************************************/

#pragma once

#include <sstream>

#include <hiptensor/hiptensor_types.h>

#include "common.hpp"
#include "elementwise_resource.hpp"
#include "elementwise_test_params.hpp"

#include <gtest/gtest.h>

namespace hiptensor
{
    static void logMessage(int32_t logLevel, const char* funcName = "", const char* msg = "");

    using PermutationTestParams_t = std::tuple<typename PermutationTestParams::DataTypesT,
                                               typename PermutationTestParams::LogLevelT,
                                               typename PermutationTestParams::LengthsT,
                                               typename PermutationTestParams::PermutedDimsT,
                                               typename PermutationTestParams::AlphaT,
                                               typename PermutationTestParams::OperatorT,
                                               typename PermutationTestParams::MemoryLayoutT>;
    class PermutationTest : public ::testing::TestWithParam<PermutationTestParams_t>
    {
    protected: // Types
        using Base = ::testing::TestWithParam<PermutationTestParams_t>;

        // Shared access to Permutation storage
        using DataStorage = ElementwiseResource;

        friend void logMessage(int32_t, const char*, const char*);

    public:
        PermutationTest();
        virtual ~PermutationTest() = default;

    protected: // Functions
        PermutationTest(PermutationTest&&)            = delete;
        PermutationTest(PermutationTest const&)       = delete;
        PermutationTest& operator=(PermutationTest&)  = delete;
        PermutationTest& operator=(PermutationTest&&) = delete;

        bool checkDevice(hiptensorDataType_t datatype) const;
        bool checkSizes() const;
        void reset();

        std::ostream& printHeader(std::ostream& stream) const;
        std::ostream& printKernel(std::ostream& stream) const;

        ElementwiseResource* getResource() const;

        void SetUp() final;
        void TearDown() final;

        void Warmup() {}
        void RunKernel();

        void reportResults(std::ostream&       stream,
                           hiptensorDataType_t DDataType,
                           bool                omitHeader,
                           bool                omitSkipped,
                           bool                omitFailed,
                           bool                omitPassed) const;

    protected:
        // Execution flow control
        uint32_t mRepeats;
        bool     mRunFlag          = true;
        bool     mValidationResult = false;
        bool     mPrintElements    = false;
        double   mMaxRelativeError;

        static bool mHeaderPrinted;

        // Output buffer
        static std::stringstream sAPILogBuff;

        // Performance
        float64_t mElapsedTimeMs, mTotalGFlops, mMeasuredTFlopsPerSec, mTotalGBytes, mGBytesPerSec;
    };

} // namespace hiptensor