rocm-systems/projects/hip-tests/catch/unit/device/hipDeviceSetGetSharedMemConfig.cc

/*
Copyright (c) 2022 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.
*/

#include <array>

#include <hip_test_common.hh>
#include <threaded_zig_zag_test.hh>

/**
 * @addtogroup hipDeviceSetSharedMemConfig hipDeviceSetSharedMemConfig
 * @{
 * @ingroup DeviceTest
 * `hipDeviceSetSharedMemConfig(hipSharedMemConfig config)` -
 * The bank width of shared memory on current device is set.
 */

namespace {
constexpr std::array<hipSharedMemConfig, 3> kMemConfigs{
    hipSharedMemBankSizeDefault, hipSharedMemBankSizeFourByte, hipSharedMemBankSizeEightByte};
}  // anonymous namespace

/**
 * Test Description
 * ------------------------
 *  - Checks that all shared memory configs can be set.
 * Test source
 * ------------------------
 *  - unit/device/hipDeviceSetGetSharedMemConfig.cc
 * Test requirements
 * ------------------------
 *  - HIP_VERSION >= 5.2
 */
TEST_CASE("Unit_hipDeviceSetSharedMemConfig_Positive_Basic") {
  const auto device = GENERATE(range(0, HipTest::getDeviceCount()));
  const auto mem_config = GENERATE(from_range(std::begin(kMemConfigs), std::end(kMemConfigs)));
  HIP_CHECK(hipSetDevice(device));
  INFO("Current device is " << device);

  HIP_CHECK(hipDeviceSetSharedMemConfig(mem_config));
}

/**
 * Test Description
 * ------------------------
 *  - Validates handling of invalid arguments:
 *    -# When shared memory config has ordinal enum number -1:
 *      - AMD expected output: return `hipErrorNotSupported`
 *      - NVIDIA expected output: return `hipErrorInvalidValue`
 * Test source
 * ------------------------
 *  - unit/device/hipDeviceSetGetSharedMemConfig.cc
 * Test requirements
 * ------------------------
 *  - HIP_VERSION >= 5.2
 */
TEST_CASE("Unit_hipDeviceSetSharedMemConfig_Negative_Parameters") {
  HIP_CHECK_ERROR(hipDeviceSetSharedMemConfig(static_cast<hipSharedMemConfig>(-1)),
                  hipErrorInvalidValue);
}

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

/**
 * @addtogroup hipDeviceGetSharedMemConfig hipDeviceGetSharedMemConfig
 * @{
 * @ingroup DeviceTest
 * `hipDeviceGetSharedMemConfig(hipSharedMemConfig* pConfig)` -
 * Returns bank width of shared memory for current device.
 */

/**
 * Test Description
 * ------------------------
 *  - Checks that the returned shared memory configuration is the default one.
 * Test source
 * ------------------------
 *  - unit/device/hipDeviceSetGetSharedMemConfig.cc
 * Test requirements
 * ------------------------
 *  - HIP_VERSION >= 5.2
 */
TEST_CASE("Unit_hipDeviceGetSharedMemConfig_Positive_Default") {
  const auto device = GENERATE(range(0, HipTest::getDeviceCount()));
  HIP_CHECK(hipSetDevice(device));
  INFO("Current device is " << device);

  hipSharedMemConfig mem_config;
  HIP_CHECK(hipDeviceGetSharedMemConfig(&mem_config));
  REQUIRE(mem_config == hipSharedMemBankSizeFourByte);
}

/**
 * Test Description
 * ------------------------
 *  - Checks that the returned shared memory configuration is equal
 *    to the one that is set previously.
 * Test source
 * ------------------------
 *  - unit/device/hipDeviceSetGetSharedMemConfig.cc
 * Test requirements
 * ------------------------
 *  - HIP_VERSION >= 5.2
 */
TEST_CASE("Unit_hipDeviceGetSharedMemConfig_Positive_Basic") {
  const auto device = GENERATE(range(0, HipTest::getDeviceCount()));
  const auto mem_config = GENERATE(from_range(std::begin(kMemConfigs), std::end(kMemConfigs)));
  HIP_CHECK(hipSetDevice(device));
  INFO("Current device is " << device);

  HIP_CHECK(hipDeviceSetSharedMemConfig(mem_config));

  hipSharedMemConfig returned_mem_config;
  HIP_CHECK(hipDeviceGetSharedMemConfig(&returned_mem_config));

  int major = -1, minor = -1;
  HIP_CHECK(hipDeviceComputeCapability(&major, &minor, device));
  REQUIRE(major > 0);
  if (major == 3 /*Kepler*/) {
    REQUIRE(returned_mem_config == mem_config);
  } else {
    REQUIRE(returned_mem_config == hipSharedMemBankSizeFourByte);
  }
}

/**
 * Test Description
 * ------------------------
 *  - Checks that the returned shared memory configuration from
 *    the main thread is equal to the one that is set in a separate
 *    thread previously.
 * Test source
 * ------------------------
 *  - unit/device/hipDeviceSetGetSharedMemConfig.cc
 * Test requirements
 * ------------------------
 *  - HIP_VERSION >= 5.2
 */
TEST_CASE("Unit_hipDeviceGetSharedMemConfig_Positive_Threaded") {
  class HipDeviceGetSharedMemConfigTest
      : public ThreadedZigZagTest<HipDeviceGetSharedMemConfigTest> {
   public:
    HipDeviceGetSharedMemConfigTest(const hipSharedMemConfig mem_config)
        : mem_config_{mem_config} {}

    void TestPart2() { HIP_CHECK_THREAD(hipDeviceSetSharedMemConfig(mem_config_)); }

    void TestPart3() {
      hipSharedMemConfig returned_mem_config;
      HIP_CHECK(hipDeviceGetSharedMemConfig(&returned_mem_config));

      int major = -1, minor = -1;
      HIP_CHECK(hipDeviceComputeCapability(&major, &minor, 0));
      REQUIRE(major > 0);
      if (major == 3 /*Kepler*/) {
        REQUIRE(returned_mem_config == mem_config_);
      } else {
        REQUIRE(returned_mem_config == hipSharedMemBankSizeFourByte);
      }
    }

   private:
    const hipSharedMemConfig mem_config_;
  };

  const auto mem_config = GENERATE(from_range(std::begin(kMemConfigs), std::end(kMemConfigs)));

  HipDeviceGetSharedMemConfigTest test(mem_config);
  test.run();
}

/**
 * Test Description
 * ------------------------
 *  - Verifies handling of invalid arguments:
 *    -# When pointer to the output shared memory configuration is `nullptr`:
 *      - Expected output: return `hipErrorInvalidValue`
 * Test source
 * ------------------------
 *  - unit/device/hipDeviceSetGetSharedMemConfig.cc
 * Test requirements
 * ------------------------
 *  - HIP_VERSION >= 5.2
 */
TEST_CASE("Unit_hipDeviceGetSharedMemConfig_Negative_Parameters") {
  HIP_CHECK_ERROR(hipDeviceGetSharedMemConfig(nullptr), hipErrorInvalidValue);
}