rocm-systems/projects/rdc/rdc_libs/rdc/src/RdcEmbeddedHandler.cc

/*
Copyright (c) 2020 - present 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 "rdc_lib/impl/RdcEmbeddedHandler.h"

#include <string.h>

#include "amd_smi/amdsmi.h"
#include "common/rdc_fields_supported.h"
#include "rdc_lib/RdcException.h"
#include "rdc_lib/RdcLogger.h"
#include "rdc_lib/RdcNotification.h"
#include "rdc_lib/impl/RdcCacheManagerImpl.h"
#include "rdc_lib/impl/RdcGroupSettingsImpl.h"
#include "rdc_lib/impl/RdcMetricFetcherImpl.h"
#include "rdc_lib/impl/RdcMetricsUpdaterImpl.h"
#include "rdc_lib/impl/RdcModuleMgrImpl.h"
#include "rdc_lib/impl/RdcNotificationImpl.h"
#include "rdc_lib/impl/RdcWatchTableImpl.h"
#include "rdc_lib/rdc_common.h"

namespace {
// call the smi_init when load library
// and smi_shutdown when unload the library.
class smi_initializer {
  smi_initializer() {
    // Make sure smi will not be initialized multiple times
    amdsmi_shut_down();
    amdsmi_status_t ret = amdsmi_init(AMDSMI_INIT_AMD_GPUS);
    if (ret != AMDSMI_STATUS_SUCCESS) {
      throw amd::rdc::RdcException(RDC_ST_FAIL_LOAD_MODULE, "SMI initialize fail");
    }
  }
  ~smi_initializer() { amdsmi_shut_down(); }

 public:
  static smi_initializer& getInstance() {
    static smi_initializer instance;
    return instance;
  }
};

static smi_initializer& in = smi_initializer::getInstance();
}  // namespace

amd::rdc::RdcHandler* make_handler(rdc_operation_mode_t op_mode) {
  return new amd::rdc::RdcEmbeddedHandler(op_mode);
}

namespace amd {
namespace rdc {

// TODO(bill_liu): make it configurable
const uint32_t METIC_UPDATE_FREQUENCY = 1000;  // 1000 microseconds by default

RdcEmbeddedHandler::RdcEmbeddedHandler(rdc_operation_mode_t mode)
    : group_settings_(new RdcGroupSettingsImpl()),
      cache_mgr_(new RdcCacheManagerImpl()),
      metric_fetcher_(new RdcMetricFetcherImpl()),
      rdc_module_mgr_(new RdcModuleMgrImpl(metric_fetcher_)),
      rdc_notif_(new RdcNotificationImpl()),
      watch_table_(new RdcWatchTableImpl(group_settings_, cache_mgr_, rdc_module_mgr_, rdc_notif_)),
      metrics_updater_(new RdcMetricsUpdaterImpl(watch_table_, METIC_UPDATE_FREQUENCY)) {
  if (mode == RDC_OPERATION_MODE_AUTO) {
    RDC_LOG(RDC_DEBUG, "Run RDC with RDC_OPERATION_MODE_AUTO");
    metrics_updater_->start();
  }
}

RdcEmbeddedHandler::~RdcEmbeddedHandler() { metrics_updater_->stop(); }

// JOB API
rdc_status_t RdcEmbeddedHandler::rdc_job_start_stats(rdc_gpu_group_t groupId, const char job_id[64],
                                                     uint64_t update_freq) {
  rdc_gpu_gauges_t gpu_gauges;
  rdc_status_t status = get_gpu_gauges(&gpu_gauges);
  if (status != RDC_ST_OK) return status;

  return watch_table_->rdc_job_start_stats(groupId, job_id, update_freq, gpu_gauges);
}

rdc_status_t RdcEmbeddedHandler::get_gpu_gauges(rdc_gpu_gauges_t* gpu_gauges) {
  uint32_t gpu_index_list[RDC_MAX_NUM_DEVICES];
  uint32_t count = 0;

  if (gpu_gauges == nullptr) {
    return RDC_ST_BAD_PARAMETER;
  }
  rdc_status_t status = rdc_device_get_all(gpu_index_list, &count);
  if (status != RDC_ST_OK) {
    return status;
  }

  // Fetch total memory and current ecc errors
  for (uint32_t i = 0; i < count; i++) {
    rdc_field_value value;
    status = metric_fetcher_->fetch_smi_field(gpu_index_list[i], RDC_FI_GPU_MEMORY_TOTAL, &value);
    if (status != RDC_ST_OK) {
      RDC_LOG(RDC_ERROR, "Fail to get total memory of GPU " << gpu_index_list[i]);
      return status;
    }
    gpu_gauges->insert(
        {{gpu_index_list[i], RDC_FI_GPU_MEMORY_TOTAL}, static_cast<uint64_t>(value.value.l_int)});

    status = metric_fetcher_->fetch_smi_field(gpu_index_list[i], RDC_FI_ECC_CORRECT_TOTAL, &value);
    if (status == RDC_ST_OK) {
      gpu_gauges->insert({{gpu_index_list[i], RDC_FI_ECC_CORRECT_TOTAL},
                          static_cast<uint64_t>(value.value.l_int)});
    }
    status =
        metric_fetcher_->fetch_smi_field(gpu_index_list[i], RDC_FI_ECC_UNCORRECT_TOTAL, &value);
    if (status == RDC_ST_OK) {
      gpu_gauges->insert({{gpu_index_list[i], RDC_FI_ECC_UNCORRECT_TOTAL},
                          static_cast<uint64_t>(value.value.l_int)});
    }
  }
  return RDC_ST_OK;
}

rdc_status_t RdcEmbeddedHandler::rdc_job_get_stats(const char job_id[64],
                                                   rdc_job_info_t* p_job_info) {
  if (p_job_info == nullptr) {
    return RDC_ST_BAD_PARAMETER;
  }

  rdc_gpu_gauges_t gpu_gauges;
  rdc_status_t status = get_gpu_gauges(&gpu_gauges);
  if (status != RDC_ST_OK) return status;

  return cache_mgr_->rdc_job_get_stats(job_id, gpu_gauges, p_job_info);
}

rdc_status_t RdcEmbeddedHandler::rdc_job_stop_stats(const char job_id[64]) {
  rdc_gpu_gauges_t gpu_gauges;
  rdc_status_t status = get_gpu_gauges(&gpu_gauges);
  if (status != RDC_ST_OK) return status;

  return watch_table_->rdc_job_stop_stats(job_id, gpu_gauges);
}

rdc_status_t RdcEmbeddedHandler::rdc_job_remove(const char job_id[64]) {
  return watch_table_->rdc_job_remove(job_id);
}

rdc_status_t RdcEmbeddedHandler::rdc_job_remove_all() { return watch_table_->rdc_job_remove_all(); }

// Discovery API
rdc_status_t RdcEmbeddedHandler::rdc_device_get_all(uint32_t gpu_index_list[RDC_MAX_NUM_DEVICES],
                                                    uint32_t* count) {
  if (!count) {
    return RDC_ST_BAD_PARAMETER;
  }
  rdc_field_value device_count;
  rdc_status_t status = metric_fetcher_->fetch_smi_field(0, RDC_FI_GPU_COUNT, &device_count);
  if (status != RDC_ST_OK) {
    return status;
  }

  // Assign the index to the index list
  *count = device_count.value.l_int;
  for (uint32_t i = 0; i < *count; i++) {
    gpu_index_list[i] = i;
  }

  return RDC_ST_OK;
}

rdc_status_t RdcEmbeddedHandler::rdc_device_get_attributes(uint32_t gpu_index,
                                                           rdc_device_attributes_t* p_rdc_attr) {
  if (!p_rdc_attr) {
    return RDC_ST_BAD_PARAMETER;
  }
  rdc_field_value device_name;
  rdc_status_t status = metric_fetcher_->fetch_smi_field(gpu_index, RDC_FI_DEV_NAME, &device_name);
  strncpy_with_null(p_rdc_attr->device_name, device_name.value.str, RDC_MAX_STR_LENGTH);
  return status;
}

rdc_status_t RdcEmbeddedHandler::rdc_device_get_component_version(rdc_component_t component, rdc_component_version_t* p_rdc_compv) {
  if (!p_rdc_compv) {
    return RDC_ST_BAD_PARAMETER;
  }

  if (component == RDC_AMDMSI_COMPONENT) {
    amdsmi_status_t ret;
    amdsmi_version_t ver = {0xFFFFFFFF, 0xFFFFFFFF, 0xFFFFFFFF, 0xFFFFFFFF, nullptr};

    ret = amdsmi_get_lib_version(&ver);

    if (ret != AMDSMI_STATUS_SUCCESS) {
      RDC_LOG(RDC_ERROR, "Failed to obtain the version of the server's amd-smi library. reason: " << (ret == AMDSMI_STATUS_INVAL ? "Invalid parameters" : "unknown"));
      return RDC_ST_MSI_ERROR;
    }

    strncpy_with_null(p_rdc_compv->version, ver.build, RDC_MAX_VERSION_STR_LENGTH);
    return RDC_ST_OK;
  } else {
    return RDC_ST_BAD_PARAMETER;
  }
}

// Group API
rdc_status_t RdcEmbeddedHandler::rdc_group_gpu_create(rdc_group_type_t type, const char* group_name,
                                                      rdc_gpu_group_t* p_rdc_group_id) {
  if (!group_name || !p_rdc_group_id) {
    return RDC_ST_BAD_PARAMETER;
  }

  rdc_status_t status = group_settings_->rdc_group_gpu_create(group_name, p_rdc_group_id);

  if (status != RDC_ST_OK || type == RDC_GROUP_EMPTY) {
    return status;
  }

  // Add All GPUs to the group
  uint32_t count = 0;
  uint32_t gpu_index_list[RDC_MAX_NUM_DEVICES];
  status = rdc_device_get_all(gpu_index_list, &count);
  if (status != RDC_ST_OK) {
    return status;
  }
  for (uint32_t i = 0; i < count; i++) {
    status = rdc_group_gpu_add(*p_rdc_group_id, gpu_index_list[i]);
  }

  return status;
}

rdc_status_t RdcEmbeddedHandler::rdc_group_gpu_add(rdc_gpu_group_t group_id, uint32_t gpu_index) {
  uint32_t count = 0;
  uint32_t gpu_index_list[RDC_MAX_NUM_DEVICES];
  rdc_status_t status = rdc_device_get_all(gpu_index_list, &count);
  if (status != RDC_ST_OK) {
    return status;
  }
  bool is_gpu_exist = false;
  for (uint32_t i = 0; i < count; i++) {
    if (gpu_index_list[i] == gpu_index) {
      is_gpu_exist = true;
      break;
    }
  }

  if (!is_gpu_exist) {
    RDC_LOG(RDC_INFO, "Fail to add GPU index " << gpu_index << " to group " << group_id
                                               << " as the GPU index is invalid.");
    return RDC_ST_NOT_FOUND;
  }

  return group_settings_->rdc_group_gpu_add(group_id, gpu_index);
}

rdc_status_t RdcEmbeddedHandler::rdc_group_field_create(uint32_t num_field_ids,
                                                        rdc_field_t* field_ids,
                                                        const char* field_group_name,
                                                        rdc_field_grp_t* rdc_field_group_id) {
  if (!field_group_name || !rdc_field_group_id || !field_ids) {
    return RDC_ST_BAD_PARAMETER;
  }

  // Check the field is valid or not
  if (num_field_ids <= RDC_MAX_FIELD_IDS_PER_FIELD_GROUP) {
    for (uint32_t i = 0; i < num_field_ids; i++) {
      if (!is_field_valid(field_ids[i])) {
        RDC_LOG(RDC_INFO, "Fail to create field group with unknown field id " << field_ids[i]);
        return RDC_ST_NOT_SUPPORTED;
      }
    }
  } else {
    return RDC_ST_MAX_LIMIT;
  }

  return group_settings_->rdc_group_field_create(num_field_ids, field_ids, field_group_name,
                                                 rdc_field_group_id);
}

rdc_status_t RdcEmbeddedHandler::rdc_group_field_get_info(
    rdc_field_grp_t rdc_field_group_id, rdc_field_group_info_t* field_group_info) {
  if (!field_group_info) {
    return RDC_ST_BAD_PARAMETER;
  }
  return group_settings_->rdc_group_field_get_info(rdc_field_group_id, field_group_info);
}

rdc_status_t RdcEmbeddedHandler::rdc_group_gpu_get_info(rdc_gpu_group_t p_rdc_group_id,
                                                        rdc_group_info_t* p_rdc_group_info) {
  if (!p_rdc_group_info) {
    return RDC_ST_BAD_PARAMETER;
  }

  return group_settings_->rdc_group_gpu_get_info(p_rdc_group_id, p_rdc_group_info);
}

rdc_status_t RdcEmbeddedHandler::rdc_group_get_all_ids(rdc_gpu_group_t group_id_list[],
                                                       uint32_t* count) {
  if (!count) {
    return RDC_ST_BAD_PARAMETER;
  }
  return group_settings_->rdc_group_get_all_ids(group_id_list, count);
}

rdc_status_t RdcEmbeddedHandler::rdc_group_field_get_all_ids(rdc_field_grp_t field_group_id_list[],
                                                             uint32_t* count) {
  if (!count) {
    return RDC_ST_BAD_PARAMETER;
  }
  return group_settings_->rdc_group_field_get_all_ids(field_group_id_list, count);
}

rdc_status_t RdcEmbeddedHandler::rdc_group_gpu_destroy(rdc_gpu_group_t p_rdc_group_id) {
  return group_settings_->rdc_group_gpu_destroy(p_rdc_group_id);
}

rdc_status_t RdcEmbeddedHandler::rdc_group_field_destroy(rdc_field_grp_t rdc_field_group_id) {
  return group_settings_->rdc_group_field_destroy(rdc_field_group_id);
}

// Field API
rdc_status_t RdcEmbeddedHandler::rdc_field_watch(rdc_gpu_group_t group_id,
                                                 rdc_field_grp_t field_group_id,
                                                 uint64_t update_freq, double max_keep_age,
                                                 uint32_t max_keep_samples) {
  return watch_table_->rdc_field_watch(group_id, field_group_id, update_freq, max_keep_age,
                                       max_keep_samples);
}

rdc_status_t RdcEmbeddedHandler::rdc_field_get_latest_value(uint32_t gpu_index, rdc_field_t field,
                                                            rdc_field_value* value) {
  if (!value) {
    return RDC_ST_BAD_PARAMETER;
  }
  if (!is_field_valid(field)) {
    RDC_LOG(RDC_INFO, "Fail to get latest value with unknown field id " << field);
    return RDC_ST_NOT_SUPPORTED;
  }
  return cache_mgr_->rdc_field_get_latest_value(gpu_index, field, value);
}

rdc_status_t RdcEmbeddedHandler::rdc_field_get_value_since(uint32_t gpu_index, rdc_field_t field,
                                                           uint64_t since_time_stamp,
                                                           uint64_t* next_since_time_stamp,
                                                           rdc_field_value* value) {
  if (!next_since_time_stamp || !value) {
    return RDC_ST_BAD_PARAMETER;
  }
  if (!is_field_valid(field)) {
    RDC_LOG(RDC_INFO, "Fail to get value since with unknown field id " << field);
    return RDC_ST_NOT_SUPPORTED;
  }
  return cache_mgr_->rdc_field_get_value_since(gpu_index, field, since_time_stamp,
                                               next_since_time_stamp, value);
}

rdc_status_t RdcEmbeddedHandler::rdc_field_unwatch(rdc_gpu_group_t group_id,
                                                   rdc_field_grp_t field_group_id) {
  return watch_table_->rdc_field_unwatch(group_id, field_group_id);
}

// Diagnostic API
rdc_status_t RdcEmbeddedHandler::rdc_diagnostic_run(rdc_gpu_group_t group_id,
                                                    rdc_diag_level_t level, const char* config,
                                                    size_t config_size,
                                                    rdc_diag_response_t* response) {
  if (!response) {
    return RDC_ST_BAD_PARAMETER;
  }

  // Get GPU group information
  rdc_group_info_t rdc_group_info;
  rdc_status_t status = rdc_group_gpu_get_info(group_id, &rdc_group_info);
  if (status != RDC_ST_OK) return status;

  auto diag = rdc_module_mgr_->get_diagnostic_module();
  return diag->rdc_diagnostic_run(rdc_group_info, level, config, config_size, response);
}

rdc_status_t RdcEmbeddedHandler::rdc_test_case_run(rdc_gpu_group_t group_id,
                                                   rdc_diag_test_cases_t test_case,
                                                   const char* config, size_t config_size,
                                                   rdc_diag_test_result_t* result) {
  if (!result) {
    return RDC_ST_BAD_PARAMETER;
  }
  // Get GPU group information
  rdc_group_info_t rdc_group_info;
  rdc_status_t status = rdc_group_gpu_get_info(group_id, &rdc_group_info);
  if (status != RDC_ST_OK) return status;

  auto diag = rdc_module_mgr_->get_diagnostic_module();
  return diag->rdc_test_case_run(test_case, rdc_group_info.entity_ids, rdc_group_info.count, config,
                                 config_size, result);
}

// Control API
rdc_status_t RdcEmbeddedHandler::rdc_field_update_all(uint32_t wait_for_update) {
  if (wait_for_update == 1) {
    return watch_table_->rdc_field_update_all();
  }

  //  Async update the field and return immediately.
  updater_ = std::async(std::launch::async, [this]() { watch_table_->rdc_field_update_all(); });

  return RDC_ST_OK;
}

// It is just a client interface under the GRPC framework and is not used as an RDC API.
// Just write an empty function to solve compilation errors
rdc_status_t RdcEmbeddedHandler::get_mixed_component_version(mixed_component_t component, mixed_component_version_t* p_mixed_compv) {
  (void)(component);
  (void)(p_mixed_compv);
  return RDC_ST_OK;
}

}  // namespace rdc
}  // namespace amd