The Diagnostic API interface

The API interface defines how the caller will use the API. An example also shows how the API can be used. It also defines the RdcDiagnostic module which can load the library dynamically and then dispatch diagnostic test to run. Change-Id: I1e041aab86f7e19338860f5ba65262977f4ea9cb [ROCm/rdc commit: eab3625d65]
2021-05-04 09:49:55 -04:00
parent 307b8ee085
commit f504f697e3
23 changed files with 856 additions and 10 deletions
@@ -135,6 +135,7 @@ add_library(${BOOTSTRAP_LIB} SHARED ${BOOTSTRAP_LIB_SRC_LIST} ${BOOTSTRAP_LIB_IN
 target_link_libraries(${BOOTSTRAP_LIB} pthread dl)
 target_include_directories(${BOOTSTRAP_LIB} PRIVATE
                                         "${RSMI_INC_DIR}"
+                                         "${ROCM_DIR}/include"
                                         "${PROJECT_SOURCE_DIR}"
                                         "${PROJECT_SOURCE_DIR}/include"
                                         "${COMMON_DIR}"
@@ -159,6 +160,7 @@ set(RDC_LIB_SRC_LIST ${RDC_LIB_SRC_LIST} "${SRC_DIR}/rdc/src/RdcWatchTableImpl.c
 set(RDC_LIB_SRC_LIST ${RDC_LIB_SRC_LIST} "${SRC_DIR}/rdc/src/RdcRasLib.cc")
 set(RDC_LIB_SRC_LIST ${RDC_LIB_SRC_LIST} "${SRC_DIR}/rdc/src/RdcSmiLib.cc")
 set(RDC_LIB_SRC_LIST ${RDC_LIB_SRC_LIST} "${SRC_DIR}/rdc/src/RdcTelemetryModule.cc")
+set(RDC_LIB_SRC_LIST ${RDC_LIB_SRC_LIST} "${SRC_DIR}/rdc/src/RdcDiagnosticModule.cc")
 set(RDC_LIB_SRC_LIST ${RDC_LIB_SRC_LIST} "${SRC_DIR}/rdc/src/RdcModuleMgrImpl.cc")
 set(RDC_LIB_SRC_LIST ${RDC_LIB_SRC_LIST} "${SRC_DIR}/rdc/src/RdcNotificationImpl.cc")
 set(RDC_LIB_SRC_LIST ${RDC_LIB_SRC_LIST} "${SRC_DIR}/rdc/src/RsmiUtils.cc")
@@ -182,6 +184,9 @@ set(RDC_LIB_INC_LIST ${RDC_LIB_INC_LIST} "${RDC_LIB_INC_DIR}/rdc_lib/impl/RdcMod
 set(RDC_LIB_INC_LIST ${RDC_LIB_INC_LIST} "${RDC_LIB_INC_DIR}/rdc_lib/RdcModuleMgr.h")
 set(RDC_LIB_INC_LIST ${RDC_LIB_INC_LIST} "${RDC_LIB_INC_DIR}/rdc_lib/RdcTelemetry.h")
 set(RDC_LIB_INC_LIST ${RDC_LIB_INC_LIST} "${RDC_LIB_INC_DIR}/rdc_lib/impl/RdcTelemetryModule.h")
+set(RDC_LIB_INC_LIST ${RDC_LIB_INC_LIST} "${RDC_LIB_INC_DIR}/rdc_lib/RdcDiagnostic.h")
+set(RDC_LIB_INC_LIST ${RDC_LIB_INC_LIST} "${RDC_LIB_INC_DIR}/rdc_lib/RdcDiagnosticLibInterface.h")
+set(RDC_LIB_INC_LIST ${RDC_LIB_INC_LIST} "${RDC_LIB_INC_DIR}/rdc_lib/impl/RdcDiagnosticModule.h")
 set(RDC_LIB_INC_LIST ${RDC_LIB_INC_LIST} "${RDC_LIB_INC_DIR}/rdc_lib/RdcNotification.h")
 set(RDC_LIB_INC_LIST ${RDC_LIB_INC_LIST} "${RDC_LIB_INC_DIR}/rdc_lib/impl/RdcNotificationImpl.h")
 set(RDC_LIB_INC_LIST ${RDC_LIB_INC_LIST} "${RDC_LIB_INC_DIR}/rdc_lib/impl/RsmiUtils.h")
@@ -190,7 +195,7 @@ set(RDC_LIB_INC_LIST ${RDC_LIB_INC_LIST} "${COMMON_DIR}/rdc_capabilities.h")

 message("RDC_LIB_INC_LIST=${RDC_LIB_INC_LIST}")

-link_directories(${RSMI_LIB_DIR} "${GRPC_ROOT}/lib" "${GRPC_ROOT}/lib64")
+link_directories(${RSMI_LIB_DIR} "${GRPC_ROOT}/lib" "${GRPC_ROOT}/lib64" "${ROCM_DIR}/lib")
 add_library(${RDC_LIB} SHARED ${RDC_LIB_SRC_LIST} ${RDC_LIB_INC_LIST})
 target_link_libraries(${RDC_LIB} ${BOOTSTRAP_LIB} pthread rocm_smi64 cap)
 target_include_directories(${RDC_LIB} PRIVATE
@@ -322,6 +322,18 @@ rdc_status_t rdc_group_field_destroy(rdc_handle_t p_rdc_handle,
              rdc_group_field_destroy(rdc_field_group_id);
 }

+rdc_status_t rdc_diagnostic_run(rdc_handle_t p_rdc_handle,
+    rdc_gpu_group_t group_id,
+    rdc_diag_level_t level,
+    rdc_diag_response_t* response) {
+        if (!p_rdc_handle) {
+                return RDC_ST_INVALID_HANDLER;
+        }
+
+        return static_cast<amd::rdc::RdcHandler*>(p_rdc_handle)->
+              rdc_diagnostic_run(group_id, level, response);
+}
+
 const char* rdc_status_string(rdc_status_t result) {
    switch (result) {
        case RDC_ST_OK:
@@ -361,6 +373,21 @@ const char* rdc_status_string(rdc_status_t result) {
    }
 }

+const char* rdc_diagnostic_result_string(rdc_diag_result_t result) {
+        switch (result) {
+        case RDC_DIAG_RESULT_PASS:
+                return "Pass";
+        case RDC_DIAG_RESULT_SKIP:
+                return "Skip";
+        case RDC_DIAG_RESULT_WARN:
+                return "Warn";
+        case RDC_DIAG_RESULT_FAIL:
+                return "Fail";
+        default:
+                return "Unknown";
+        }
+}
+
 const char* field_id_string(rdc_field_t field_id) {
  amd::rdc::fld_id2name_map_t &field_id_to_descript =
                                 amd::rdc::get_field_id_description_from_id();
@@ -0,0 +1,146 @@
+/*
+Copyright (c) 2021 - 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/RdcDiagnosticModule.h"
+#include <map>
+#include <vector>
+#include <functional>
+#include "rdc_lib/RdcLogger.h"
+#include "rdc_lib/impl/RdcSmiLib.h"
+#include "rdc_lib/impl/RdcRasLib.h"
+
+namespace amd {
+namespace rdc {
+
+rdc_status_t RdcDiagnosticModule::rdc_diag_test_cases_query(
+        rdc_diag_test_cases_t test_cases[MAX_TEST_CASES],
+        uint32_t* test_case_count) {
+    if (test_case_count == nullptr) {
+        return RDC_ST_BAD_PARAMETER;
+    }
+    auto ite = diagnostic_modules_.begin();
+    *test_case_count = 0;
+    for (; ite != diagnostic_modules_.end(); ite++) {
+        uint32_t count = 0;
+        rdc_status_t status = (*ite)->rdc_diag_test_cases_query(
+                &(test_cases[*test_case_count]), &count);
+        if (status == RDC_ST_OK) {
+            *test_case_count += count;
+        }
+    }
+    return RDC_ST_OK;
+}
+
+rdc_status_t RdcDiagnosticModule::rdc_test_case_run(
+        rdc_diag_test_cases_t test_case,
+        uint32_t gpu_index[RDC_MAX_NUM_DEVICES],
+        uint32_t gpu_count,
+        rdc_diag_test_result_t* result) {
+    if (result == nullptr) {
+        return RDC_ST_BAD_PARAMETER;
+    }
+
+    // Init test status
+    auto ite = testcases_to_module_.find(test_case);
+    if (ite == testcases_to_module_.end()) {
+        result->status = RDC_DIAG_RESULT_SKIP;
+        strncpy_with_null(result->info, "Not implemented", MAX_DIAG_MSG_LENGTH);
+        return RDC_ST_NOT_SUPPORTED;
+    }
+    return ite->second->rdc_test_case_run(test_case,
+            gpu_index, gpu_count, result);
+}
+
+rdc_status_t RdcDiagnosticModule::rdc_diagnostic_run(
+        const rdc_group_info_t& gpus,
+        rdc_diag_level_t level,
+        rdc_diag_response_t* response) {
+    if (response == nullptr) {
+        return RDC_ST_BAD_PARAMETER;
+    }
+
+    std::vector<rdc_diag_test_cases_t> rdc_runs;
+    if (level >= RDC_DIAG_LVL_SHORT) {  // Short run and above
+        rdc_runs.push_back(RDC_DIAG_COMPUTE_PROCESS);
+        rdc_runs.push_back(RDC_DIAG_NODE_TOPOLOGY);
+        rdc_runs.push_back(RDC_DIAG_GPU_PARAMETERS);
+        rdc_runs.push_back(RDC_DIAG_COMPUTE_QUEUE);
+        rdc_runs.push_back(RDC_DIAG_SDMA_QUEUE);
+        rdc_runs.push_back(RDC_DIAG_VRAM_CHECK);
+        rdc_runs.push_back(RDC_DIAG_SYS_MEM_CHECK);
+    }
+
+    response->results_count = 0;
+    for (unsigned int i=0; i < rdc_runs.size(); i++) {
+        response->diag_info[i].test_case = rdc_runs[i];
+        rdc_test_case_run(rdc_runs[i],
+            const_cast<uint32_t*>(gpus.entity_ids),
+            gpus.count, &(response->diag_info[i]));
+        response->results_count++;
+    }
+
+    return RDC_ST_OK;
+}
+
+rdc_status_t RdcDiagnosticModule::rdc_diag_init(uint64_t flag) {
+    auto ite = diagnostic_modules_.begin();
+    for (; ite != diagnostic_modules_.end(); ite++) {
+        (*ite)->rdc_diag_init(flag);
+    }
+    return RDC_ST_OK;
+}
+
+rdc_status_t RdcDiagnosticModule::RdcDiagnosticModule::rdc_diag_destroy() {
+    auto ite = diagnostic_modules_.begin();
+    for (; ite != diagnostic_modules_.end(); ite++) {
+        (*ite)->rdc_diag_destroy();
+    }
+    return RDC_ST_OK;
+}
+
+RdcDiagnosticModule::RdcDiagnosticModule(const RdcSmiLibPtr& smi_lib,
+    const RdcRasLibPtr& ras_module) {
+    if (smi_lib) {
+       diagnostic_modules_.push_back(smi_lib);
+    }
+
+    if (ras_module) {
+       diagnostic_modules_.push_back(ras_module);
+    }
+
+    auto ite = diagnostic_modules_.begin();
+    for (; ite != diagnostic_modules_.end(); ite++) {
+       rdc_diag_test_cases_t test_cases[MAX_TEST_CASES];
+       uint32_t test_count = 0;
+       rdc_status_t status = (*ite)->
+            rdc_diag_test_cases_query(test_cases, &test_count);
+       if (status == RDC_ST_OK) {
+            for (uint32_t index = 0; index < test_count; index++) {
+                testcases_to_module_.insert({test_cases[index], (*ite)});
+            }
+       }
+    }
+}
+
+
+}  // namespace rdc
+}  // namespace amd
+
@@ -381,6 +381,22 @@ rdc_status_t RdcEmbeddedHandler::rdc_field_unwatch(rdc_gpu_group_t 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,
+    rdc_diag_response_t* response) {
+
+    // 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, response);
+}
+
 // Control API
 rdc_status_t RdcEmbeddedHandler::rdc_field_update_all(
    uint32_t wait_for_update) {
@@ -21,13 +21,15 @@ THE SOFTWARE.
 */
 #include "rdc_lib/impl/RdcModuleMgrImpl.h"
 #include "rdc_lib/impl/RdcTelemetryModule.h"
+#include "rdc_lib/impl/RdcDiagnosticModule.h"
 #include "rdc_lib/impl/RdcRasLib.h"

 namespace amd {
 namespace rdc {

 RdcModuleMgrImpl::RdcModuleMgrImpl(const RdcMetricFetcherPtr& fetcher):
-                fetcher_(fetcher) {
+                smi_lib_(std::make_shared<RdcSmiLib>(fetcher)) {
+    // The smi_lib_ always need to be loaded.
 }


@@ -42,12 +44,30 @@ RdcTelemetryPtr RdcModuleMgrImpl::get_telemetry_module() {
    }

    if (!rdc_telemetry_module_) {
-        rdc_telemetry_module_.reset(new RdcTelemetryModule(fetcher_, ras_lib_));
+        rdc_telemetry_module_.reset(new RdcTelemetryModule(smi_lib_, ras_lib_));
    }

    return rdc_telemetry_module_;
 }

+RdcDiagnosticPtr RdcModuleMgrImpl::get_diagnostic_module() {
+    if (rdc_diagnostic_module_) {
+        return rdc_diagnostic_module_;
+    }
+
+    //  Delay load
+    if (!ras_lib_) {
+        ras_lib_.reset(new RdcRasLib("librdc_ras.so"));
+    }
+
+    if (!rdc_diagnostic_module_) {
+        rdc_diagnostic_module_.reset(
+            new RdcDiagnosticModule(smi_lib_, ras_lib_));
+    }
+
+    return rdc_diagnostic_module_;
+}
+
 }  // namespace rdc
 }  // namespace amd

@@ -149,6 +149,46 @@ rdc_status_t RdcRasLib::rdc_telemetry_fields_unwatch(rdc_gpu_field_t* fields,
    return status;
 }

+
+rdc_status_t RdcRasLib::rdc_diag_test_cases_query(
+        rdc_diag_test_cases_t test_cases[MAX_TEST_CASES],
+        uint32_t* test_case_count) {
+    (void)test_cases;
+    (void)test_case_count;
+    return RDC_ST_NOT_SUPPORTED;
+}
+
+    // Run a specific test case
+rdc_status_t RdcRasLib::rdc_test_case_run(
+        rdc_diag_test_cases_t test_case,
+        uint32_t gpu_index[RDC_MAX_NUM_DEVICES],
+        uint32_t gpu_count,
+        rdc_diag_test_result_t* result) {
+    (void)test_case;
+    (void)gpu_index;
+    (void)result;
+    (void)gpu_count;
+    return RDC_ST_NOT_SUPPORTED;
+}
+
+rdc_status_t RdcRasLib::rdc_diagnostic_run(
+        const rdc_group_info_t& gpus,
+        rdc_diag_level_t level,
+        rdc_diag_response_t* response) {
+    (void)gpus;
+    (void)level;
+    (void)response;
+    return RDC_ST_NOT_SUPPORTED;
+}
+
+rdc_status_t RdcRasLib::rdc_diag_init(uint64_t flags) {
+    (void)flags;
+    return RDC_ST_NOT_SUPPORTED;
+}
+rdc_status_t RdcRasLib::rdc_diag_destroy() {
+    return RDC_ST_NOT_SUPPORTED;
+}
+
 }  // namespace rdc
 }  // namespace amd

@@ -24,6 +24,8 @@ THE SOFTWARE.
 #include "rdc_lib/RdcLogger.h"
 #include "rdc_lib/impl/RdcSmiLib.h"

+
+
 namespace amd {
 namespace rdc {

@@ -161,6 +163,43 @@ rdc_status_t RdcSmiLib::rdc_telemetry_fields_query(
    return RDC_ST_OK;
 }

+rdc_status_t RdcSmiLib::rdc_diag_test_cases_query(
+        rdc_diag_test_cases_t test_cases[MAX_TEST_CASES],
+        uint32_t* test_case_count) {
+    if (test_case_count == nullptr) {
+        return RDC_ST_BAD_PARAMETER;
+    }
+
+    return RDC_ST_NOT_SUPPORTED;
+}
+
+// Run a specific test case
+rdc_status_t RdcSmiLib::rdc_test_case_run(
+        rdc_diag_test_cases_t test_case,
+        uint32_t gpu_index[RDC_MAX_NUM_DEVICES],
+        uint32_t gpu_count,
+        rdc_diag_test_result_t* result) {
+    if (result == nullptr) {
+        return RDC_ST_BAD_PARAMETER;
+    }
+    return RDC_ST_NOT_SUPPORTED;
+}
+
+rdc_status_t RdcSmiLib::rdc_diagnostic_run(
+        const rdc_group_info_t&,
+        rdc_diag_level_t,
+        rdc_diag_response_t*) {
+    return RDC_ST_NOT_SUPPORTED;
+}
+
+rdc_status_t RdcSmiLib::rdc_diag_init(uint64_t) {
+    return RDC_ST_OK;
+}
+
+rdc_status_t RdcSmiLib::rdc_diag_destroy() {
+    return RDC_ST_OK;
+}
+
 }  // namespace rdc
 }  // namespace amd

@@ -93,10 +93,9 @@ rdc_status_t RdcTelemetryModule::rdc_telemetry_fields_unwatch(
 }

 RdcTelemetryModule::RdcTelemetryModule(
-    const RdcMetricFetcherPtr& fetcher,
+    const RdcSmiLibPtr& smi_lib,
    const RdcRasLibPtr& ras_module) {
-    auto smi_telemetry_module = std::make_shared<RdcSmiLib>(fetcher);
-    telemetry_modules_.push_back(smi_telemetry_module);
+    telemetry_modules_.push_back(smi_lib);
    if (ras_module) {
       telemetry_modules_.push_back(ras_module);
    }
@@ -554,6 +554,17 @@ rdc_status_t RdcStandaloneHandler::rdc_field_unwatch(rdc_gpu_group_t group_id,
    return error_handle(status, reply.status());
 }

+// Diagnostic API
+rdc_status_t RdcStandaloneHandler::rdc_diagnostic_run(
+        rdc_gpu_group_t group_id,
+        rdc_diag_level_t level,
+        rdc_diag_response_t* response) {
+            (void)group_id;
+            (void)level;
+            (void)response;
+        return RDC_ST_NOT_SUPPORTED;
+}
+

 // Control RdcAPI
 rdc_status_t RdcStandaloneHandler::rdc_field_update_all(