rocm-systems/projects/amdsmi/tests/amd_smi_test/test_base.h

/*
 * 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.
 */

#ifndef TESTS_AMD_SMI_TEST_TEST_BASE_H_
#define TESTS_AMD_SMI_TEST_TEST_BASE_H_

#include <cstdint>
#include <string>
#include <vector>
#include <map>
#include <limits>
#include "amd_smi/amdsmi.h"

// The max devices can be monitored
#define MAX_MONITOR_DEVICES 128
class TestBase {
 public:
  TestBase(void);

  virtual ~TestBase(void);

  enum VerboseLevel {VERBOSE_MIN = 0, VERBOSE_STANDARD, VERBOSE_PROGRESS};

  // @Brief: Before run the core measure codes, do something to set up
  // i.e. init runtime, prepare packet...
  // The init_flags option will override any flags set for the whole test
  // suite
  void SetUp(uint64_t init_flags);
  virtual void SetUp(void);

  // @Brief: Core measurement codes executing here
  virtual void Run(void);

  // @Brief: Do something clean up
  virtual void Close(void);

  // @Brief: Display the results
  virtual void DisplayResults(void) const;

  // @Brief: Display information about the test
  virtual void DisplayTestInfo(void);

  const std::string & description(void) const {return description_;}

  void set_description(std::string d);

  void set_title(std::string name) {
    title_ = name;
  }
  std::string title(void) const {
    return title_;
  }
  void set_verbosity(uint32_t v) {
    verbosity_ = v;
  }
  uint32_t verbosity(void) const {
    return verbosity_;
  }
  void set_dont_fail(bool f) {
    dont_fail_ = f;
  }
  bool dont_fail(void) const {
    return dont_fail_;
  }
  void set_num_monitor_devs(uint32_t i) {
    num_monitor_devs_ = i;
  }
  uint32_t num_monitor_devs(void) const {
    return num_monitor_devs_;
  }
  void set_init_options(uint64_t x) {
    init_options_ = x;
  }
  uint64_t init_options(void) const {
    return init_options_;
  }
  void set_num_iterations(uint32_t x) {
    num_iterations_ = x;
  }
  uint32_t num_iterations(void) const {
    return num_iterations_;
  }

  const std::map<amdsmi_accelerator_partition_type_t, std::string> partition_types_map = {
    { AMDSMI_ACCELERATOR_PARTITION_INVALID, "N/A" },
    { AMDSMI_ACCELERATOR_PARTITION_SPX, "SPX" },
    { AMDSMI_ACCELERATOR_PARTITION_DPX, "DPX" },
    { AMDSMI_ACCELERATOR_PARTITION_TPX, "TPX" },
    { AMDSMI_ACCELERATOR_PARTITION_QPX, "QPX" },
    { AMDSMI_ACCELERATOR_PARTITION_CPX, "CPX" },
    { AMDSMI_ACCELERATOR_PARTITION_MAX, "MAX" },
  };

  const std::map<amdsmi_accelerator_partition_type_t, std::string> accelerator_types_map = {
    { AMDSMI_ACCELERATOR_PARTITION_INVALID, "AMDSMI_ACCELERATOR_PARTITION_INVALID" },
    { AMDSMI_ACCELERATOR_PARTITION_SPX, "AMDSMI_ACCELERATOR_PARTITION_SPX" },
    { AMDSMI_ACCELERATOR_PARTITION_DPX, "AMDSMI_ACCELERATOR_PARTITION_DPX" },
    { AMDSMI_ACCELERATOR_PARTITION_TPX, "AMDSMI_ACCELERATOR_PARTITION_TPX" },
    { AMDSMI_ACCELERATOR_PARTITION_QPX, "AMDSMI_ACCELERATOR_PARTITION_QPX" },
    { AMDSMI_ACCELERATOR_PARTITION_CPX, "AMDSMI_ACCELERATOR_PARTITION_CPX" },
    { AMDSMI_ACCELERATOR_PARTITION_MAX, "AMDSMI_ACCELERATOR_PARTITION_MAX" },
  };

  struct AcceleratorProfileConfig {
    amdsmi_accelerator_partition_type_t original_profile_type;
    std::string original_profile_type_str;
    uint32_t original_profile_index;
    uint32_t number_of_profiles;
    std::vector<amdsmi_accelerator_partition_type_t> available_profiles;
    std::vector<std::string> available_profile_str;
    std::vector<uint32_t> available_profile_indices;
  };

  AcceleratorProfileConfig getAvailableProfileConfigs(uint32_t device_index,
                              amdsmi_accelerator_partition_profile_t current_profile,
                              amdsmi_accelerator_partition_profile_config_t config,
                              bool isVerbose);

  uint32_t promptNumDevicesToTest(uint32_t current_num_devices);

  std::string getResourceType(amdsmi_accelerator_partition_resource_type_t resource_type);

  template <typename T>
  bool checkIfMaxValue(T value) {
    T max_value = std::numeric_limits<T>::max();
    if (value == max_value) {
      return true;
    } else {
      return false;
    }
  }

 protected:
  void MakeHeaderStr(const char *inStr, std::string *outStr) const;
  void PrintDeviceHeader(amdsmi_processor_handle dv_ind);
  bool setup_failed_;   ///< Record that setup failed to return ierr in Run
  uint32_t num_monitor_devs_;  ///< Number of monitor devices found
  ///< device handles
  amdsmi_processor_handle processor_handles_[MAX_MONITOR_DEVICES];
  uint32_t socket_count_;  ///< socket count
  std::vector<amdsmi_socket_handle> sockets_;  ///< sockets

 private:
  std::string description_;
  std::string title_;   ///< Displayed title of test
  uint32_t verbosity_;   ///< How much additional output to produce
  bool dont_fail_;       ///< Don't quit test on individual failure if true
  uint64_t init_options_;  ///< rsmi initialization options
  uint32_t num_iterations_;
};

#define IF_VERB(VB) if (verbosity() && verbosity() >= (TestBase::VERBOSE_##VB))
#define IF_NVERB(VB) if (verbosity() < (TestBase::VERBOSE_##VB))

// Macros to be used within TestBase classes
#define CHK_ERR_ASRT(RET) { \
    if ((RET) != AMDSMI_STATUS_SUCCESS) { \
        std::cout << std::endl << "\t===> TEST FAILURE." << std::endl; \
        const char *err_str; \
        std::cout << "\t===> ERROR: AMDSMI call returned " << (RET) << std::endl; \
        amdsmi_status_code_to_string((RET), &err_str); \
        std::cout << "\t===> (" << err_str << ")" << std::endl; \
        std::cout << "\t===> at " << __FILE__ << ":" << std::dec << __LINE__ << \
                                                                  std::endl; \
    } \
    if (dont_fail() && ((RET) != AMDSMI_STATUS_SUCCESS)) { \
        std::cout << \
         "\t===> Abort is over-ridden due to dont_fail command line option." \
                                                               << std::endl; \
        return; \
    } \
    ASSERT_EQ(AMDSMI_STATUS_SUCCESS, (RET)); \
}

void MakeHeaderStr(const char *inStr, std::string *outStr);
extern const char kSetupLabel[];

#endif  // TESTS_AMD_SMI_TEST_TEST_BASE_H_