TheRock/rocm-systems/projects/hip-tests/catch/performance/api/stream/hipStreamWriteValue.cc

/*
 * Copyright (c) Advanced Micro Devices, Inc., or its affiliates.
 *
 * SPDX-License-Identifier: MIT
 */

#include <hip_test_common.hh>
#include <performance_common.hh>

/**
 * @addtogroup stream stream
 * @{
 * @ingroup PerformanceTestStream
 */

#if HT_NVIDIA
static int IsStreamWriteValueSupported(int device_id) {
  int write_value_supported = 0;

  cuDeviceGetAttribute(&write_value_supported, CU_DEVICE_ATTRIBUTE_CAN_USE_64_BIT_STREAM_MEM_OPS,
                       device_id);
  return write_value_supported;
}
#endif

class StreamWriteValue32Benchmark : public Benchmark<StreamWriteValue32Benchmark> {
 public:
  void operator()(const size_t array_size) {
    const StreamGuard stream_guard{Streams::created};
    const hipStream_t stream = stream_guard.stream();
    uint32_t* value_ptr;
    uint32_t value{0};
    HIP_CHECK(hipMalloc(&value_ptr, sizeof(uint32_t) * array_size));
    HIP_CHECK(hipMemset(value_ptr, value, sizeof(uint32_t) * array_size));

    TIMED_SECTION(kTimerTypeCpu) { HIP_CHECK(hipStreamWriteValue32(stream, value_ptr, value, 0)); }
    HIP_CHECK(hipFree(value_ptr));
  }
};

class StreamWriteValue64Benchmark : public Benchmark<StreamWriteValue64Benchmark> {
 public:
  void operator()(const size_t array_size) {
    const StreamGuard stream_guard{Streams::created};
    const hipStream_t stream = stream_guard.stream();
    uint64_t* value_ptr;
    uint64_t value{0};
    HIP_CHECK(hipMalloc(&value_ptr, sizeof(uint64_t) * array_size));
    HIP_CHECK(hipMemset(value_ptr, value, sizeof(uint64_t) * array_size));

    TIMED_SECTION(kTimerTypeCpu) { HIP_CHECK(hipStreamWriteValue64(stream, value_ptr, value, 0)); }
    HIP_CHECK(hipFree(value_ptr));
  }
};

template <typename WriteValueBenchmark> static void RunBenchmark(const size_t array_size) {
  WriteValueBenchmark benchmark;
  benchmark.AddSectionName(std::to_string(array_size));
  benchmark.Run(array_size);
}

/**
 * Test Description
 * ------------------------
 *  - Executes `hipStreamWriteValue32`:
 *    -# Allocation size:
 *      - 4 KB
 *      - 4 MB
 *      - 16 MB
 * Test source
 * ------------------------
 * - performance/api/stream/hipStreamWriteValue.cc
 * Test requirements
 * ------------------------
 *  - HIP_VERSION >= 5.2
 */
HIP_TEST_CASE(Performance_hipStreamWriteValue32) {
#if HT_AMD
  size_t array_size = GENERATE(4_KB, 4_MB, 16_MB);
  RunBenchmark<StreamWriteValue32Benchmark>(array_size);
#endif
}

/**
 * Test Description
 * ------------------------
 *  - Executes `hipStreamWriteValue64`:
 *    -# Allocation size:
 *      - 4 KB
 *      - 4 MB
 *      - 16 MB
 * Test source
 * ------------------------
 * - performance/api/stream/hipStreamWriteValue.cc
 * Test requirements
 * ------------------------
 *  - HIP_VERSION >= 5.2
 */
HIP_TEST_CASE(Performance_hipStreamWriteValue64) {
#if HT_NVIDIA
  if (!IsStreamWriteValueSupported(0)) {
    HIP_SKIP_TEST(
        "GPU 0 doesn't support hipStreamWriteValue64() function. "
        "Hence skipping the testing with Pass result.");
  }
#endif
  size_t array_size = GENERATE(4_KB, 4_MB, 16_MB);
  RunBenchmark<StreamWriteValue64Benchmark>(array_size);
}

/**
 * End doxygen group PerformanceTest.
 * @}
 */