TheRock/rocm-libraries/projects/rocprim/benchmark/benchmark_device_transform.hpp

// MIT License
//
// Copyright (c) 2024-2026 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 "primbench.hpp"

#include "benchmark_utils.hpp"

#include "../common/utils_device_ptr.hpp"

#include <hip/hip_runtime_api.h>

#include <rocprim/device/config_types.hpp>
#include <rocprim/device/detail/device_config_helper.hpp>
#include <rocprim/device/device_transform.hpp>
#include <rocprim/functional.hpp>

#include <cstddef>
#include <memory>
#include <string>
#include <vector>

constexpr inline const char* get_thread_load_method_name(rocprim::cache_load_modifier method)
{
    switch(method)
    {
        case rocprim::load_default: return "load_default";
        case rocprim::load_ca: return "load_ca";
        case rocprim::load_cg: return "load_cg";
        case rocprim::load_nontemporal: return "load_nontemporal";
        case rocprim::load_cv: return "load_cv";
        case rocprim::load_ldg: return "load_ldg";
        case rocprim::load_volatile: return "load_volatile";
        case rocprim::load_count: return "load_count";
    }
    return "load_default";
}

template<typename Config>
constexpr auto config_name()
{
    if constexpr(std::is_same_v<Config, rocprim::default_config>)
    {
        return std::string("default");
    }
    else
    {
        auto config = Config();
        return primbench::json{}
            .add("bs", config.block_size)
            .add("ipt", config.items_per_thread)
            .add("lt", get_thread_load_method_name(config.load_type));
    }
}

template<typename T,
         bool IsPointer,
         bool IsBinary   = false,
         typename Config = rocprim::default_config>
struct device_transform_benchmark : public primbench::benchmark_interface
{
    primbench::json meta() const override
    {
        auto algo = []
        {
            if constexpr(IsPointer)
            {
                return "device_transform_pointer";
            }
            else
            {
                return "device_transform";
            }
        };

        return primbench::json{}
            .add("lvl", "device")
            .add("algo", algo())
            .add("is_binary", IsBinary)
            .add("value_type", primbench::name<T>())
            .add("cfg", config_name<Config>());
    }

    void run(primbench::state& state) override
    {
        const auto& stream = state.stream;
        const auto& bytes  = state.size;
        const auto& seed   = state.seed;

        using output_type = T;

        size_t items = bytes / sizeof(T);

        static constexpr bool debug_synchronous = false;

        // Generate data
        const auto           random_range = limit_random_range<T>(1, 100);
        const std::vector<T> input
            = get_random_data<T>(items, random_range.first, random_range.second, seed);

        common::device_ptr<T>           d_input(input);
        common::device_ptr<output_type> d_output(items);

        if constexpr(IsBinary)
        {
            const std::vector<T> input2
                = get_random_data<T>(items, random_range.first, random_range.second, seed);
            common::device_ptr<T> d_input2(input2);

            // If it is not a unary operator, it can not make use of the pointer optimization.
            const auto launch = [&]
            {
                auto transform_op = [](T v1, T v2) { return v1 + v2; };
                return rocprim::transform<Config>(rocprim::tuple(d_input.get(), d_input2.get()),
                                                  d_output.get(),
                                                  items,
                                                  transform_op,
                                                  stream,
                                                  debug_synchronous);
            };

            state.set_items(items);
            state.add_reads<T>(2 * items);

            state.run([&] { HIP_CHECK(launch()); });
        }
        else
        {
            const auto launch = [&]
            {
                using Selector    = rocprim::detail::transform_config_selector<T, IsPointer>;
                auto transform_op = [](T v) { return v + T(5); };
                return rocprim::detail::transform_impl<IsPointer, Config, Selector>(
                    d_input.get(),
                    d_output.get(),
                    items,
                    transform_op,
                    stream,
                    debug_synchronous);
            };

            state.set_items(items);
            state.add_reads<T>(items);

            state.run([&] { HIP_CHECK(launch()); });
        }
    }
};

template<typename T, bool IsPointer, unsigned int BlockSize, rocprim::cache_load_modifier LoadType>
struct device_transform_benchmark_generator
{

    template<unsigned int ItemsPerThread>
    struct create_ipt
    {
        using generated_config = rocprim::
            transform_config<BlockSize, 1 << ItemsPerThread, ROCPRIM_GRID_SIZE_LIMIT, LoadType>;

        void operator()(std::vector<std::unique_ptr<primbench::benchmark_interface>>& storage)
        {
            storage.emplace_back(
                std::make_unique<
                    device_transform_benchmark<T, IsPointer, false, generated_config>>());
        }
    };

    static void create(std::vector<std::unique_ptr<primbench::benchmark_interface>>& storage)
    {
        static constexpr unsigned int min_items_per_thread = 0;
        static constexpr unsigned int max_items_per_thread = rocprim::Log2<16>::VALUE;
        static_for_each<make_index_range<unsigned int, min_items_per_thread, max_items_per_thread>,
                        create_ipt>(storage);
    }
};