AI/rocm-systems
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Set status codes to fixed values

Browse Source 
Assign fixed values to status codes to prevent enum auto assign
from changing them.

Signed-off-by: Jason Albert <jason.albert@amd.com>
Change-Id: I0ca1de7ba503ce8a75c56026f5a54e212204595b


[ROCm/amdsmi commit: 3b1584915b]
This commit is contained in:
Jason Albert
2022-11-04 12:54:27 -05:00
committed by Jason Albert
parent ebfd8e1b23
commit 0e5519726b
2 changed files with 79 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
projects/amdsmi/include/amd_smi/amd_smi.h
+36 -30
View File
@@ -103,38 +103,44 @@ typedef enum device_type {
} device_type_t;
/**
* @brief Error codes retured by amd_smi_lib functions
* @brief Error codes returned by amdsmi functions
*/
// Please avoid status codes that are multiples of 256 (256, 512, etc..)
// Return values in the shell get modulo 256 applied, meaning any multiple of 256 ends up as 0
typedef enum amdsmi_status_t {
AMDSMI_STATUS_SUCCESS = 0, /**< Call succeeded */
AMDSMI_STATUS_INVAL, /**< Invalid parameters */
AMDSMI_STATUS_NOT_SUPPORTED, /**< Command not supported */
AMDSMI_STATUS_FILE_ERROR, /**< Problem accessing a file. */
AMDSMI_STATUS_NO_PERM, /**< Permission Denied */
AMDSMI_STATUS_OUT_OF_RESOURCES, /**< Not enough memory */
AMDSMI_STATUS_INTERNAL_EXCEPTION, /**< An internal exception was caught */
AMDSMI_STATUS_INPUT_OUT_OF_BOUNDS, /**< The provided input is out of allowable or safe range */
AMDSMI_STATUS_INIT_ERROR, /**< An error occurred when initializing internal data structures */
AMDSMI_STATUS_NOT_YET_IMPLEMENTED, /**< Not implemented yet */
AMDSMI_STATUS_NOT_FOUND, /**< Device Not found */
AMDSMI_STATUS_INSUFFICIENT_SIZE, /**< Not enough resources were available for the operation */
AMDSMI_STATUS_INTERRUPT, /**< An interrupt occurred during execution of function */
AMDSMI_STATUS_UNEXPECTED_SIZE, /**< An unexpected amount of data was read */
AMDSMI_STATUS_NO_DATA, /**< No data was found for a given input */
AMDSMI_STATUS_UNEXPECTED_DATA, /**< The data read or provided to function is not what was expected */
AMDSMI_STATUS_BUSY, /**< Device busy */
AMDSMI_STATUS_REFCOUNT_OVERFLOW, /**< An internal reference counter exceeded INT32_MAX */
AMDSMI_LIB_START = 1000,
AMDSMI_STATUS_FAIL_LOAD_MODULE = AMDSMI_LIB_START, //!< Fail to load lib
AMDSMI_STATUS_FAIL_LOAD_SYMBOL,
AMDSMI_STATUS_DRM_ERROR, //!< Error when call libdrm
AMDSMI_STATUS_IO, /**< I/O Error */
AMDSMI_STATUS_FAULT, /**< Bad address */
AMDSMI_STATUS_API_FAILED, /**< API call failed */
AMDSMI_STATUS_TIMEOUT, /**< Timeout in API call */
AMDSMI_STATUS_NO_SLOT, /**< No more free slot */
AMDSMI_STATUS_RETRY, /**< Retry operation */
AMDSMI_STATUS_NOT_INIT, /**< Device not initialized */
AMDSMI_STATUS_SUCCESS = 0, //!< Call succeeded
// Library usage errors
AMDSMI_STATUS_INVAL = 1, //!< Invalid parameters
AMDSMI_STATUS_NOT_SUPPORTED = 2, //!< Command not supported
AMDSMI_STATUS_NOT_YET_IMPLEMENTED = 3, //!< Not implemented yet
AMDSMI_STATUS_FAIL_LOAD_MODULE = 4, //!< Fail to load lib
AMDSMI_STATUS_FAIL_LOAD_SYMBOL = 5, //!< Fail to load symbol
AMDSMI_STATUS_DRM_ERROR = 6, //!< Error when call libdrm
AMDSMI_STATUS_API_FAILED = 7, //!< API call failed
AMDSMI_STATUS_TIMEOUT = 8, //!< Timeout in API call
AMDSMI_STATUS_RETRY = 9, //!< Retry operation
AMDSMI_STATUS_NO_PERM = 10, //!< Permission Denied
AMDSMI_STATUS_INTERRUPT = 11, //!< An interrupt occurred during execution of function
AMDSMI_STATUS_IO = 12, //!< I/O Error
AMDSMI_STATUS_ADDRESS_FAULT = 13, //!< Bad address
AMDSMI_STATUS_FILE_ERROR = 14, //!< Problem accessing a file
AMDSMI_STATUS_OUT_OF_RESOURCES = 15, //!< Not enough memory
AMDSMI_STATUS_INTERNAL_EXCEPTION = 16, //!< An internal exception was caught
AMDSMI_STATUS_INPUT_OUT_OF_BOUNDS = 17, //!< The provided input is out of allowable or safe range
AMDSMI_STATUS_INIT_ERROR = 18, //!< An error occurred when initializing internal data structures
AMDSMI_STATUS_REFCOUNT_OVERFLOW = 19, //!< An internal reference counter exceeded INT32_MAX
// Device related errors
AMDSMI_STATUS_BUSY = 30, //!< Device busy
AMDSMI_STATUS_NOT_FOUND = 31, //!< Device Not found
AMDSMI_STATUS_NOT_INIT = 32, //!< Device not initialized
AMDSMI_STATUS_NO_SLOT = 33, //!< No more free slot
// Data and size errors
AMDSMI_STATUS_NO_DATA = 40, //!< No data was found for a given input
AMDSMI_STATUS_INSUFFICIENT_SIZE = 41, //!< Not enough resources were available for the operation
AMDSMI_STATUS_UNEXPECTED_SIZE = 42, //!< An unexpected amount of data was read
AMDSMI_STATUS_UNEXPECTED_DATA = 43, //!< The data read or provided to function is not what was expected
// General errors
AMDSMI_STATUS_MAP_ERROR = 0xFFFFFFFE, //!< The internal library error did not map to a status code
AMDSMI_STATUS_UNKNOWN_ERROR = 0xFFFFFFFF, //!< An unknown error occurred
} amdsmi_status_t;
projects/amdsmi/src/amd_smi/amd_smi.cc
+43 -6
View File
@@ -68,9 +68,41 @@
#include "amd_smi/impl/amdgpu_drm.h"
#include "amd_smi/impl/amd_smi_utils.h"
// TODO(bliu): One to one map to all status code
// Define a map of rsmi status codes to amdsmi status codes
static const std::map<rsmi_status_t, amdsmi_status_t> rsmi_status_map = {
{RSMI_STATUS_SUCCESS, AMDSMI_STATUS_SUCCESS},
{RSMI_STATUS_INVALID_ARGS, AMDSMI_STATUS_INVAL},
{RSMI_STATUS_NOT_SUPPORTED, AMDSMI_STATUS_NOT_SUPPORTED},
{RSMI_STATUS_PERMISSION, AMDSMI_STATUS_NO_PERM},
{RSMI_STATUS_OUT_OF_RESOURCES, AMDSMI_STATUS_OUT_OF_RESOURCES},
{RSMI_STATUS_INTERNAL_EXCEPTION, AMDSMI_STATUS_INTERNAL_EXCEPTION},
{RSMI_STATUS_INPUT_OUT_OF_BOUNDS, AMDSMI_STATUS_INPUT_OUT_OF_BOUNDS},
{RSMI_STATUS_INIT_ERROR, AMDSMI_STATUS_INIT_ERROR},
{RSMI_INITIALIZATION_ERROR, AMDSMI_STATUS_INIT_ERROR},
{RSMI_STATUS_NOT_YET_IMPLEMENTED, AMDSMI_STATUS_NOT_YET_IMPLEMENTED},
{RSMI_STATUS_NOT_FOUND, AMDSMI_STATUS_NOT_FOUND},
{RSMI_STATUS_INSUFFICIENT_SIZE, AMDSMI_STATUS_INSUFFICIENT_SIZE},
{RSMI_STATUS_INTERRUPT, AMDSMI_STATUS_INTERRUPT},
{RSMI_STATUS_UNEXPECTED_SIZE, AMDSMI_STATUS_UNEXPECTED_SIZE},
{RSMI_STATUS_NO_DATA, AMDSMI_STATUS_NO_DATA},
{RSMI_STATUS_UNEXPECTED_DATA, AMDSMI_STATUS_UNEXPECTED_DATA},
{RSMI_STATUS_BUSY, AMDSMI_STATUS_BUSY},
{RSMI_STATUS_REFCOUNT_OVERFLOW, AMDSMI_STATUS_REFCOUNT_OVERFLOW},
{RSMI_STATUS_UNKNOWN_ERROR, AMDSMI_STATUS_UNKNOWN_ERROR},
};
static amdsmi_status_t rsmi_to_amdsmi_status(rsmi_status_t status) {
return static_cast<amdsmi_status_t>(status);
amdsmi_status_t amdsmi_status = AMDSMI_STATUS_MAP_ERROR;
// Look for it in the map
// If found: use the mapped value
// If not found: return the map error established above
auto search = rsmi_status_map.find(status);
if (search != rsmi_status_map.end()) {
amdsmi_status = search->second;
}
return amdsmi_status;
}
static amdsmi_status_t get_gpu_device_from_handle(amdsmi_device_handle device_handle,
@@ -117,10 +149,6 @@ amdsmi_shut_down() {
amdsmi_status_t
amdsmi_status_string(amdsmi_status_t status, const char **status_string) {
if (status <= AMDSMI_LIB_START) {
return rsmi_to_amdsmi_status(
rsmi_status_string(static_cast<rsmi_status_t>(status), status_string));
}
switch (status) {
case AMDSMI_STATUS_FAIL_LOAD_MODULE:
*status_string = "FAIL_LOAD_MODULE: Fail to load module.";
@@ -132,6 +160,15 @@ amdsmi_status_string(amdsmi_status_t status, const char **status_string) {
*status_string = "DRM_ERROR: Fail to run function in libdrm.";
break;
default:
// The case above didn't have a match, so look up the amdsmi status in the rsmi status map
// If found, get the rsmi status string. If not, return unknown error string
for (auto& iter : rsmi_status_map) {
if (iter.second == status) {
rsmi_status_string(iter.first, status_string);
return AMDSMI_STATUS_SUCCESS;
}
}
// Not found
*status_string = "An unknown error occurred";
return AMDSMI_STATUS_UNKNOWN_ERROR;
}