rocm-systems/tests/rocm_smi_test/functional/power_read.cc

/*
 * =============================================================================
 *   ROC Runtime Conformance Release License
 * =============================================================================
 * The University of Illinois/NCSA
 * Open Source License (NCSA)
 *
 * Copyright (c) 2019-2023, Advanced Micro Devices, Inc.
 * All rights reserved.
 *
 * Developed by:
 *
 *                 AMD Research and AMD ROC Software Development
 *
 *                 Advanced Micro Devices, Inc.
 *
 *                 www.amd.com
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal with 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:
 *
 *  - Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimers.
 *  - Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimers in
 *    the documentation and/or other materials provided with the distribution.
 *  - Neither the names of <Name of Development Group, Name of Institution>,
 *    nor the names of its contributors may be used to endorse or promote
 *    products derived from this Software without specific prior written
 *    permission.
 *
 * 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 CONTRIBUTORS 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 WITH THE SOFTWARE.
 *
 */

#include <stdint.h>
#include <stddef.h>

#include <iostream>
#include <string>

#include "gtest/gtest.h"
#include "rocm_smi/rocm_smi.h"
#include "rocm_smi_test/functional/power_read.h"
#include "rocm_smi_test/test_common.h"
#include "rocm_smi/rocm_smi_utils.h"

TestPowerRead::TestPowerRead() : TestBase() {
  set_title("RSMI Power Read Test");
  set_description("The Power Read tests verifies that "
                                "power related values can be read properly.");
}

TestPowerRead::~TestPowerRead(void) {
}

void TestPowerRead::SetUp(void) {
  TestBase::SetUp();

  return;
}

void TestPowerRead::DisplayTestInfo(void) {
  TestBase::DisplayTestInfo();
}

void TestPowerRead::DisplayResults(void) const {
  TestBase::DisplayResults();
  return;
}

void TestPowerRead::Close() {
  // This will close handles opened within rsmitst utility calls and call
  // rsmi_shut_down(), so it should be done after other hsa cleanup
  TestBase::Close();
}


void TestPowerRead::Run(void) {
  rsmi_status_t err;
  uint64_t val_ui64, val2_ui64;
  RSMI_POWER_TYPE type = RSMI_INVALID_POWER;

  TestBase::Run();
  if (setup_failed_) {
    std::cout << "** SetUp Failed for this test. Skipping.**" << std::endl;
    return;
  }

  for (uint32_t x = 0; x < num_iterations(); ++x) {
    for (uint32_t i = 0; i < num_monitor_devs(); ++i) {
      PrintDeviceHeader(i);

      err = rsmi_dev_power_cap_get(i, 0, &val_ui64);
      CHK_ERR_ASRT(err)
      IF_VERB(STANDARD) {
        std::cout << "\t**Current Power Cap: " << val_ui64 << "uW" <<std::endl;
      }
      err = rsmi_dev_power_cap_default_get(i, &val_ui64);
      CHK_ERR_ASRT(err)
      IF_VERB(STANDARD) {
        std::cout << "\t**Default Power Cap: " << val_ui64 << "uW" <<std::endl;
      }
      err = rsmi_dev_power_cap_range_get(i, 0, &val_ui64, &val2_ui64);
      CHK_ERR_ASRT(err)
      IF_VERB(STANDARD) {
        std::cout << "\t**Power Cap Range: " << val2_ui64 << " to " <<
                                                 val_ui64 << " uW" << std::endl;
      }

      /* Average Power */
      err = rsmi_dev_power_ave_get(i, 0, &val_ui64);

      ASSERT_TRUE(err == RSMI_STATUS_SUCCESS
                 || err == RSMI_STATUS_NOT_SUPPORTED);
      if (err == RSMI_STATUS_NOT_SUPPORTED) {
        std::cout <<
            "\t**Average Power Usage: not supported on this device"
                                                                   << std::endl;
      } else {
        CHK_RSMI_PERM_ERR(err)
        IF_VERB(STANDARD) {
          std::cout << "\t**Average Power Usage: ";
          if (err == RSMI_STATUS_SUCCESS) {
            std::cout << static_cast<float>(val_ui64) / 1000 << " W"
                      << std::endl;
          }
        }
        // Verify api support checking functionality is working
        err = rsmi_dev_power_ave_get(i, 0, nullptr);
        ASSERT_EQ(err, RSMI_STATUS_INVALID_ARGS);
      }

      /* Current Socket Power */
      err = rsmi_dev_current_socket_power_get(i, &val_ui64);
      ASSERT_TRUE(err == RSMI_STATUS_SUCCESS
                 || err == RSMI_STATUS_NOT_SUPPORTED);
      if (err == RSMI_STATUS_NOT_SUPPORTED) {
        std::cout <<
            "\t**Current Socket Power: not supported"
            " on this device" << std::endl;
      } else {
        CHK_RSMI_PERM_ERR(err)
        IF_VERB(STANDARD) {
          std::cout << "\t**Current Socket Power: ";
          if (err == RSMI_STATUS_SUCCESS) {
            std::cout << static_cast<float>(val_ui64) / 1000 << " W"
                      << std::endl;
          }
        }
        // Verify api support checking functionality is working
        err = rsmi_dev_current_socket_power_get(i, nullptr);
        ASSERT_EQ(err, RSMI_STATUS_INVALID_ARGS);
      }

      /* Generic Power */
      err = rsmi_dev_power_get(i, &val_ui64, &type);
      ASSERT_TRUE(err == RSMI_STATUS_SUCCESS
                 || err == RSMI_STATUS_NOT_SUPPORTED);
      ASSERT_TRUE(type == RSMI_AVERAGE_POWER || type == RSMI_CURRENT_POWER
                  || type == RSMI_INVALID_POWER);

      if (err == RSMI_STATUS_NOT_SUPPORTED) {
        std::cout <<
            "\t**Generic Power: not supported"
            " on this device" << std::endl;
      } else {
        CHK_RSMI_PERM_ERR(err)
        IF_VERB(STANDARD) {
          std::cout << "\t**Generic Power: ";
          if (err == RSMI_STATUS_SUCCESS) {
            std::cout << "[" << amd::smi::power_type_string(type) << "] "
                      << static_cast<float>(val_ui64) / 1000 << " W"
                      << std::endl;
          }
        }
        // Verify api support checking functionality is working
        err = rsmi_dev_power_get(i, nullptr, nullptr);
        ASSERT_EQ(err, RSMI_STATUS_INVALID_ARGS);
      }
      std::cout << "\n";
    }
  }
}