Files
TheRock/rocm-libraries/projects/rocprim/benchmark/benchmark_device_scan_by_key.hpp
T
derek.holloway 7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
Flatten subprojects into a single base monorepo
2026-09-02 16:34:47 -07:00

403 lines
17 KiB
C++

// MIT License
//
// Copyright (c) 2017-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"
#ifndef BENCHMARK_CONFIG_TUNING
#include "../common/utils_custom_type.hpp"
#endif
#include <hip/hip_runtime.h>
#include <rocprim/config.hpp>
#include <rocprim/device/config_types.hpp>
#include <rocprim/device/detail/device_config_helper.hpp>
#include <rocprim/device/device_scan_by_key.hpp>
#include <rocprim/functional.hpp>
#ifdef BENCHMARK_CONFIG_TUNING
#include <rocprim/block/block_load.hpp>
#include <rocprim/block/block_scan.hpp>
#include <rocprim/block/block_store.hpp>
#else
#include <rocprim/functional.hpp>
#include <rocprim/types.hpp>
#endif
#include <cstddef>
#include <string>
#include <type_traits>
#include <vector>
#ifdef BENCHMARK_CONFIG_TUNING
#include <memory>
#else
#include <stdint.h>
#endif
inline const char* get_block_scan_algorithm_name(rocprim::block_scan_algorithm alg)
{
switch(alg)
{
case rocprim::block_scan_algorithm::using_warp_scan:
return "block_scan_algorithm::using_warp_scan";
case rocprim::block_scan_algorithm::reduce_then_scan:
return "block_scan_algorithm::reduce_then_scan";
// Not using `default: ...` because it kills effectiveness of -Wswitch
}
return "default_algorithm";
}
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.kernel_config.block_size)
.add("ipt", config.kernel_config.items_per_thread)
.add("method", get_block_scan_algorithm_name(config.block_scan_method));
}
}
template<bool Exclusive,
typename Key,
typename Value,
typename ScanOp,
typename CompareOp,
unsigned int MaxSegmentLength,
bool Deterministic,
typename Config = rocprim::default_config>
struct device_scan_by_key_benchmark : public primbench::benchmark_interface
{
primbench::json meta() const override
{
auto algo = []
{
if constexpr(Deterministic)
{
return "device_scan_by_key_deterministic";
}
else
{
return "device_scan_by_key";
}
};
return primbench::json{}
.add("lvl", "device")
.add("algo", algo())
.add("exclusive", Exclusive)
.add("key_type", primbench::name<Key>())
.add("value_type", primbench::name<Value>())
.add("max_segment_length", MaxSegmentLength)
.add("cfg", config_name<Config>());
}
template<bool excl = Exclusive>
auto run_device_scan_by_key(void* temporary_storage,
size_t& storage_size,
const Key* keys,
const Value* input,
Value* output,
const Value initial_value,
const size_t input_size,
const ScanOp scan_op,
const CompareOp compare_op,
const hipStream_t stream,
const bool debug = false) const
{
if constexpr(excl)
{
if constexpr(!Deterministic)
{
return rocprim::exclusive_scan_by_key<Config>(temporary_storage,
storage_size,
keys,
input,
output,
initial_value,
input_size,
scan_op,
compare_op,
stream,
debug);
}
else
{
return rocprim::deterministic_exclusive_scan_by_key<Config>(temporary_storage,
storage_size,
keys,
input,
output,
initial_value,
input_size,
scan_op,
compare_op,
stream,
debug);
}
}
else
{
if constexpr(!Deterministic)
{
return rocprim::inclusive_scan_by_key<Config>(temporary_storage,
storage_size,
keys,
input,
output,
input_size,
scan_op,
compare_op,
stream,
debug);
}
else
{
return rocprim::deterministic_inclusive_scan_by_key<Config>(temporary_storage,
storage_size,
keys,
input,
output,
input_size,
scan_op,
compare_op,
stream,
debug);
}
}
}
void run(primbench::state& state) override
{
const auto& stream = state.stream;
const auto& bytes = state.size;
const auto& seed = state.seed;
auto seeds = primbench::seeds<2>(seed);
size_t items = bytes / sizeof(Value);
constexpr bool debug = false;
const std::vector<Key> keys = get_random_segments<Key>(items, MaxSegmentLength, seeds[0]);
const auto random_range = limit_random_range<Value>(0, 1000);
const std::vector<Value> input
= get_random_data<Value>(items, random_range.first, random_range.second, seeds[1]);
ScanOp scan_op{};
CompareOp compare_op{};
Value initial_value = Value(123);
common::device_ptr<Value> d_input(input);
common::device_ptr<Key> d_keys(keys);
common::device_ptr<Value> d_output(input.size());
// Allocate temporary storage memory
size_t temp_storage_size_bytes;
// Get size of d_temp_storage
HIP_CHECK((run_device_scan_by_key(nullptr,
temp_storage_size_bytes,
d_keys.get(),
d_input.get(),
d_output.get(),
initial_value,
items,
scan_op,
compare_op,
stream,
debug)));
common::device_ptr<void> d_temp_storage(temp_storage_size_bytes);
state.set_items(items);
state.add_reads<Key>(items);
state.add_reads<Value>(items);
state.run(
[&]
{
HIP_CHECK((run_device_scan_by_key(d_temp_storage.get(),
temp_storage_size_bytes,
d_keys.get(),
d_input.get(),
d_output.get(),
initial_value,
items,
scan_op,
compare_op,
stream,
debug)));
});
}
};
#ifdef BENCHMARK_CONFIG_TUNING
template<typename KeyType, typename ValueType, rocprim::block_scan_algorithm BlockScanAlgorithm>
struct device_scan_by_key_benchmark_generator
{
template<typename index_range>
struct create_block_scan_algorithm
{
template<unsigned int BlockSizeExponent>
struct create_block_size
{
template<unsigned int ItemsPerThread>
struct create_ipt
{
void operator()(
std::vector<std::unique_ptr<primbench::benchmark_interface>>& storage)
{
storage.emplace_back(std::make_unique<device_scan_by_key_benchmark<
false,
KeyType,
ValueType,
rocprim::plus<ValueType>,
rocprim::equal_to<KeyType>,
1024,
false,
rocprim::scan_by_key_config<
block_size,
ItemsPerThread,
rocprim::block_load_method::block_load_transpose,
rocprim::block_store_method::block_store_transpose,
BlockScanAlgorithm>>>());
}
};
void operator()(std::vector<std::unique_ptr<primbench::benchmark_interface>>& storage)
{
// Limit items per thread to not over-use shared memory
static constexpr unsigned int max_items_per_thread = ::rocprim::min<size_t>(
65536
/ (block_size
* (sizeof(KeyType) + sizeof(ValueType)
+ (sizeof(KeyType) == 16 && sizeof(ValueType) == 1))),
24);
static_for_each<make_index_range<unsigned int, 1, max_items_per_thread>,
create_ipt>(storage);
}
static constexpr unsigned int block_size = 1u << BlockSizeExponent;
};
static void create(std::vector<std::unique_ptr<primbench::benchmark_interface>>& storage)
{
static_for_each<index_range, create_block_size>(storage);
}
};
static void create(std::vector<std::unique_ptr<primbench::benchmark_interface>>& storage)
{
// Block sizes 64, 128, 256
create_block_scan_algorithm<make_index_range<unsigned int, 6, 8>>::create(storage);
}
};
#else // BENCHMARK_CONFIG_TUNING
#define CREATE_BY_KEY_BENCHMARK(EXCL, T, SCAN_OP, MAX_SEGMENT_LENGTH) \
executor.queue<device_scan_by_key_benchmark<EXCL, \
int, \
T, \
SCAN_OP, \
rocprim::equal_to<int>, \
MAX_SEGMENT_LENGTH, \
Deterministic>>();
#define CREATE_EXCL_INCL_BENCHMARK(EXCL, T, SCAN_OP) \
CREATE_BY_KEY_BENCHMARK(EXCL, T, SCAN_OP, 1) \
CREATE_BY_KEY_BENCHMARK(EXCL, T, SCAN_OP, 16) \
CREATE_BY_KEY_BENCHMARK(EXCL, T, SCAN_OP, 256) \
CREATE_BY_KEY_BENCHMARK(EXCL, T, SCAN_OP, 4096) \
CREATE_BY_KEY_BENCHMARK(EXCL, T, SCAN_OP, 65536)
#define CREATE_BENCHMARK(T) \
CREATE_EXCL_INCL_BENCHMARK(false, T, rocprim::plus<T>) \
CREATE_EXCL_INCL_BENCHMARK(true, T, rocprim::plus<T>)
#define BENCHMARK_TYPE_TUNING(KEY_TYPE, VALUE_TYPE) \
executor.queue<device_scan_by_key_benchmark<false, \
KEY_TYPE, \
VALUE_TYPE, \
rocprim::plus<VALUE_TYPE>, \
rocprim::equal_to<KEY_TYPE>, \
1024, \
false>>();
// All of the limited tuned types
#define BENCHMARK_TYPES_TUNING(KEY_TYPE) \
BENCHMARK_TYPE_TUNING(KEY_TYPE, rocprim::int128_t) \
BENCHMARK_TYPE_TUNING(KEY_TYPE, int64_t) \
BENCHMARK_TYPE_TUNING(KEY_TYPE, int) \
BENCHMARK_TYPE_TUNING(KEY_TYPE, short) \
BENCHMARK_TYPE_TUNING(KEY_TYPE, int8_t)
template<bool Deterministic>
void add_benchmarks(primbench::executor& executor)
{
if constexpr(!Deterministic)
{
// Tuned types
BENCHMARK_TYPES_TUNING(rocprim::int128_t)
BENCHMARK_TYPES_TUNING(int64_t)
BENCHMARK_TYPES_TUNING(int)
BENCHMARK_TYPES_TUNING(short)
BENCHMARK_TYPES_TUNING(int8_t)
BENCHMARK_TYPES_TUNING(double)
BENCHMARK_TYPES_TUNING(float)
BENCHMARK_TYPES_TUNING(rocprim::half)
}
#ifndef BENCHMARK_AUTOTUNED_TYPES_ONLY
// Not tuned types
CREATE_BENCHMARK(float)
CREATE_BENCHMARK(double)
CREATE_BENCHMARK(float2)
CREATE_BENCHMARK(double2)
CREATE_BENCHMARK(uint8_t)
CREATE_BENCHMARK(rocprim::half)
CREATE_BENCHMARK(rocprim::uint128_t)
// Not tuned custom types
using custom_f32_f32 = common::custom_type<float, float>;
using custom_f64_f64 = common::custom_type<double, double>;
CREATE_BENCHMARK(custom_f32_f32)
CREATE_BENCHMARK(custom_f64_f64)
#endif
}
#endif // BENCHMARK_CONFIG_TUNING