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

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

/*
 * Test to compare
 * 1.pciBusID from hipDeviceGetPCIBusId and hipDeviceGetAttribute **
 * 2.{pciDomainID, pciBusID, pciDeviceID} values hipDeviceGetPCIBusId vs lspci **
 */

#include <hip_test_common.hh>

/**
 * @addtogroup hipDeviceGetPCIBusId hipDeviceGetPCIBusId
 * @{
 * @ingroup DriverTest
 * `hipDeviceGetPCIBusId(char* pciBusId, int len, int device)` -
 * Returns a PCI Bus Id string for the device, overloaded to take int device ID.
 */

#define MAX_DEVICE_LENGTH 20

namespace hipDeviceGetPCIBusIdTests {

void getPciBusId(int deviceCount, char** hipDeviceList) {
  for (int i = 0; i < deviceCount; i++) {
    HIP_CHECK(hipDeviceGetPCIBusId(hipDeviceList[i], MAX_DEVICE_LENGTH, i));
  }
}
}  // namespace hipDeviceGetPCIBusIdTests

/**
 * Test Description
 * ------------------------
 *  - Check that PCI bus ID is the same as the one returned from attributes.
 *  - Perform for each device.
 * Test source
 * ------------------------
 *  - unit/device/hipDeviceGetByPCIBusId.cc
 * Test requirements
 * ------------------------
 *  - HIP_VERSION >= 5.2
 */
HIP_TEST_CASE(Unit_hipDeviceGetPCIBusId_Check_PciBusID_WithAttr) {
  int deviceCount = 0;
  HIP_CHECK(hipGetDeviceCount(&deviceCount));
  REQUIRE_FALSE(deviceCount == 0);
  printf("No.of gpus in the system: %d\n", deviceCount);
  // Allocate an array of pointer to characters
  char** hipDeviceList = new char*[deviceCount];
  REQUIRE_FALSE(hipDeviceList == nullptr);
  for (int i = 0; i < deviceCount; i++) {
    hipDeviceList[i] = new char[MAX_DEVICE_LENGTH];
    REQUIRE_FALSE(hipDeviceList[i] == nullptr);
  }
  hipDeviceGetPCIBusIdTests::getPciBusId(deviceCount, hipDeviceList);

  for (int i = 0; i < deviceCount; i++) {
    int pciBusID = -1;
    int pciDeviceID = -1;
    int pciDomainID = -1;
    int tempPciBusId = -1;
    sscanf(hipDeviceList[i], "%04x:%02x:%02x", &pciDomainID, &pciBusID, &pciDeviceID);
    HIP_CHECK(hipDeviceGetAttribute(&tempPciBusId, hipDeviceAttributePciBusId, i));
    REQUIRE_FALSE(pciBusID != tempPciBusId);
  }
  // Deallocate
  for (int i = 0; i < deviceCount; i++) {
    delete[] hipDeviceList[i];
  }
  delete[] hipDeviceList;
  printf(
      "pciBusID output of both hipDeviceGetPCIBusId and"
      " hipDeviceGetAttribute matched for all gpus\n");
}

/**
 * Test Description
 * ------------------------
 *  - Checks that an error is returned when the output buffer has length
 *    that is smaller than the full PCI bus ID.
 *      - Expected output: do not return `hipSuccess`
 * Test source
 * ------------------------
 *  - unit/device/hipDeviceGetPCIBusId.cc
 * Test requirements
 * ------------------------
 *  - HIP_VERSION >= 5.2
 */
HIP_TEST_CASE(Unit_hipDeviceGetPCIBusId_Negative_PartialFill) {
  std::array<char, MAX_DEVICE_LENGTH> busID;

  const int device = GENERATE(range(0, HipTest::getDeviceCount()));

  HIP_CHECK(hipDeviceGetPCIBusId(busID.data(), busID.size(), device));

  auto start = std::begin(busID);
  auto end = std::end(busID);
  const auto len = std::distance(start, std::find(start, end, 0));

  // fill up only half of the length
  const auto fillLen = len / 2;
  constexpr char fillValue = 1;
  std::fill(start, end, fillValue);

  REQUIRE_FALSE(hipDeviceGetPCIBusId(busID.data(), fillLen, device) == hipSuccess);

  const auto strEnd = start + fillLen - 1;
  REQUIRE(std::all_of(start, strEnd, [](char& c) { return c != 0; }));
  REQUIRE(*strEnd == 0);
  REQUIRE(std::all_of(strEnd + 1, end, [](char& c) { return c == fillValue; }));
}

/**
 * Test Description
 * ------------------------
 *  - Validates handling of invalid arguments:
 *    -# When output pointer to the PCI bus ID is `nullptr`
 *      - Expected output: do not return `hipSuccess`
 *    -# When the length of the output buffer is 0
 *      - Expected output: do not return `hipSuccess`
 *    -# When the length of the output buffer is less than 0
 *      - Expected output: do not return `hipSuccess`
 *    -# When the device ordinal is negative (-1)
 *      - Expected output: do not return `hipSuccess`
 *    -# When the device ordinal is out of bounds
 *      - Expected output: do not return `hipSuccess`
 * Test source
 * ------------------------
 *  - unit/device/hipDeviceGetPCIBusId.cc
 * Test requirements
 * ------------------------
 *  - HIP_VERSION >= 5.2
 */
HIP_TEST_CASE(Unit_hipDeviceGetPCIBusId_NegTst) {
  char pciBusId[MAX_DEVICE_LENGTH];
  int device;
  HIP_CHECK(hipGetDevice(&device));

  // pciBusId is nullptr
  SECTION("pciBusId is nullptr") {
    REQUIRE_FALSE(hipDeviceGetPCIBusId(nullptr, MAX_DEVICE_LENGTH, device) == hipSuccess);
  }

  // len = 0
  SECTION("len is 0") { REQUIRE_FALSE(hipDeviceGetPCIBusId(pciBusId, 0, device) == hipSuccess); }

  // len < 0
  SECTION("len is less than 0") {
    REQUIRE_FALSE(hipDeviceGetPCIBusId(pciBusId, -1, device) == hipSuccess);
  }

  // device = -1
  SECTION("device is -1") {
    REQUIRE_FALSE(hipDeviceGetPCIBusId(pciBusId, MAX_DEVICE_LENGTH, -1) == hipSuccess);
  }
  // device = Non Existing Device
  SECTION("device is out of bounds") {
    int deviceCount = 0;
    HIP_CHECK(hipGetDeviceCount(&deviceCount));
    REQUIRE_FALSE(deviceCount == 0);
    REQUIRE_FALSE(hipDeviceGetPCIBusId(pciBusId, MAX_DEVICE_LENGTH, deviceCount) == hipSuccess);
  }
}

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