TheRock/rocm-systems/projects/cuid/tests/unit/gim_util_test.cc

/*
 * Copyright (c) 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 "unit/gim_util_test.h"

#include <gtest/gtest.h>
#include <sys/stat.h>

#include <cstdint>
#include <cstdio>
#include <string>
#include <vector>

#include "src/gim_util.h"

using cuid::gim::GimAsicInfo;
using cuid::gim::GimClient;
using cuid::gim::GimDeviceEntry;

namespace {

bool gim_dev_present() {
  struct stat st {};
  return ::stat("/dev/gim-smi0", &st) == 0;
}

}  // namespace

// ---------------------------------------------------------------------------
// TestGimClientAvailability
// ---------------------------------------------------------------------------
TestGimClientAvailability::TestGimClientAvailability() {
  SetTitle("GIM Client Availability");
  SetDescription(
      "Verify GimClient reports device-node presence and falls back to "
      "UNSUPPORTED when the GIM driver is absent.");
}

void TestGimClientAvailability::SetUp() {}

void TestGimClientAvailability::Run() {
  // is_available reports the presence of /dev/gim-smi0 and never throws.
  EXPECT_EQ(GimClient::is_available(), gim_dev_present());

  // get_asic_info_for_bdf() should validate BDF format before contacting the
  // driver, regardless of driver presence.
  {
    GimClient client;
    GimAsicInfo info;
    EXPECT_EQ(client.get_asic_info_for_bdf("not-a-bdf", info), AMDCUID_STATUS_INVALID_ARGUMENT);
    EXPECT_EQ(client.get_asic_info_for_bdf("", info), AMDCUID_STATUS_INVALID_ARGUMENT);
  }

  if (gim_dev_present()) {
    IF_VERB(1) { printf("  GIM device present; skipping absent-driver behavior checks\n"); }
    return;
  }

  // init() must return UNSUPPORTED on systems with no GIM driver, so callers
  // can safely treat the GIM backend as an optional fallback.
  {
    GimClient client;
    EXPECT_EQ(client.init(), AMDCUID_STATUS_UNSUPPORTED);
    EXPECT_FALSE(client.is_connected());
  }

  // get_devices() must clear the output vector and return UNSUPPORTED when GIM
  // is unavailable.
  {
    GimClient client;
    std::vector<GimDeviceEntry> devices = {{0xdead, "0000:00:00.0", false}};
    EXPECT_EQ(client.get_devices(devices), AMDCUID_STATUS_UNSUPPORTED);
    EXPECT_TRUE(devices.empty());
  }
}

// ---------------------------------------------------------------------------
// TestGimParseAsicSerial
// ---------------------------------------------------------------------------
TestGimParseAsicSerial::TestGimParseAsicSerial() {
  SetTitle("GIM Parse ASIC Serial");
  SetDescription(
      "Verify GimClient::parse_asic_serial accepts canonical hex forms and "
      "rejects malformed input without modifying the output on failure.");
}

void TestGimParseAsicSerial::SetUp() {}

void TestGimParseAsicSerial::Run() {
  // Accepted forms.
  {
    uint64_t value = 0;

    EXPECT_TRUE(GimClient::parse_asic_serial("0x1234abcd", value));
    EXPECT_EQ(value, 0x1234abcdu);

    EXPECT_TRUE(GimClient::parse_asic_serial("FFFFFFFFFFFFFFFF", value));
    EXPECT_EQ(value, UINT64_MAX);

    EXPECT_TRUE(GimClient::parse_asic_serial("0X1", value));
    EXPECT_EQ(value, 0x1u);
  }

  // Rejected forms.
  {
    uint64_t value = 0xCAFEu;

    // Empty input.
    EXPECT_FALSE(GimClient::parse_asic_serial("", value));
    EXPECT_EQ(value, 0xCAFEu) << "value must not be modified on failure";

    // Non-hex character.
    EXPECT_FALSE(GimClient::parse_asic_serial("0xZZZ", value));
    EXPECT_EQ(value, 0xCAFEu);

    // 0x prefix only.
    EXPECT_FALSE(GimClient::parse_asic_serial("0x", value));

    // More than 64 bits worth of hex digits.
    EXPECT_FALSE(GimClient::parse_asic_serial("0x10000000000000000", value));
  }
}

// ---------------------------------------------------------------------------
// TestGimFormatBdf
// ---------------------------------------------------------------------------
TestGimFormatBdf::TestGimFormatBdf() {
  SetTitle("GIM Format BDF");
  SetDescription(
      "Verify GimClient::format_bdf renders packed BDF values in canonical "
      "PCI dddd:bb:dd.f form.");
}

void TestGimFormatBdf::SetUp() {}

void TestGimFormatBdf::Run() {
  // domain=0x0000, bus=0x65, device=0x00, function=0
  const uint64_t packed =
      (uint64_t{0x0000} << 16) | (uint64_t{0x65} << 8) | (uint64_t{0x00} << 3) | uint64_t{0};
  EXPECT_EQ(GimClient::format_bdf(packed), "0000:65:00.0");

  // domain=0x1234, bus=0xab, device=0x1f, function=7 (max field values)
  const uint64_t packed2 =
      (uint64_t{0x1234} << 16) | (uint64_t{0xab} << 8) | (uint64_t{0x1f} << 3) | uint64_t{7};
  EXPECT_EQ(GimClient::format_bdf(packed2), "1234:ab:1f.7");
}