Detailed Description

Return/error codes for all STM functions.

This enumeration contains unique return/error codes to identify the source of a failure. Some errors have direct correspondence to standard errno.h codes, indicated [IN BRACKETS], and may result from failures in lower level system calls. Others indicate failures specific to misuse of STM library functions.

Definition in file stm_error.h.

Go to the source code of this file.

Enumerations
enum	stmErrorCode_t { STM_SUCCESS = 0 , STM_ERROR_EXPECTED , STM_ERROR_NOT_INITIALIZED , STM_ERROR_BAD_PARAMETER , STM_ERROR_NOT_SUPPORTED , STM_ERROR_TIMEOUT , STM_ERROR_NOT_FOUND , STM_ERROR_INVALID_STATE , STM_ERROR_GENERIC , STM_ERROR_BAD_VALUE , STM_ERROR_NVSCISYNC , STM_ERROR_SYNC , STM_ERROR_NVSCISYNC_TIMEOUT , STM_ERROR_CUDA , STM_ERROR_VULKAN , STM_ERROR_INSUFFICIENT_MEMORY , STM_ERROR_NVMEDIA_DLA , STM_ERROR_CUDLA , STM_ERROR_PVA , STM_ERROR_CONNECTION , STM_ERROR_UNKNOWN_CLOCK , STM_ERROR_FAILED_READING_TIMESTAMPS , STM_ERROR_UNKNOWN_STATE , STM_ERROR_BAD_STATE_TRANSITION , STM_ERROR_SCHEDULE_ID_INVALID , STM_NUM_ERROR_CODES }
	Return/error codes for all STM functions. More...

Functions
static const char *	stmErrorCodeToString (stmErrorCode_t err)
	Convert STM error code to string representation. More...

Variables
const char *	stmErrorCodeNames []

Enumeration Type Documentation

◆ stmErrorCode_t

enum stmErrorCode_t

Return/error codes for all STM functions.

This enumeration contains unique return/error codes to identify the source of a failure. Some errors have direct correspondence to standard errno.h codes, indicated [IN BRACKETS], and may result from failures in lower level system calls. Others indicate failures specific to misuse of STM library functions.

Enumerator
STM_SUCCESS	[EOK] No error
STM_ERROR_EXPECTED	Failure in one of the allowed/expected ways
STM_ERROR_NOT_INITIALIZED	STM client context not initialized through previous call to stmClientInit()
STM_ERROR_BAD_PARAMETER	Invalid parameter value
STM_ERROR_NOT_SUPPORTED	Operation not supported
STM_ERROR_TIMEOUT	Operation timeout
STM_ERROR_NOT_FOUND	Lookup failed in STM
STM_ERROR_INVALID_STATE	STM in invalid state
STM_ERROR_GENERIC	Generic error; no other information
STM_ERROR_BAD_VALUE	Invalid value in STM
STM_ERROR_NVSCISYNC	NvSciSync operation in STM returned an error
STM_ERROR_SYNC	Synchronization operation in STM returned an error
STM_ERROR_NVSCISYNC_TIMEOUT	NvSciSync operation in STM timed out
STM_ERROR_CUDA	CUDA operation in STM returned an error
STM_ERROR_VULKAN	Vulkan operation in STM returned an error
STM_ERROR_INSUFFICIENT_MEMORY	[ENOMEM] Not enough memory
STM_ERROR_NVMEDIA_DLA	NVMEDIA_DLA operation in STM returned an error
STM_ERROR_CUDLA	CUDLA operation in STM returned an error
STM_ERROR_PVA	CUPVA operation in STM returned an error
STM_ERROR_CONNECTION
STM_ERROR_UNKNOWN_CLOCK
STM_ERROR_FAILED_READING_TIMESTAMPS
STM_ERROR_UNKNOWN_STATE
STM_ERROR_BAD_STATE_TRANSITION
STM_ERROR_SCHEDULE_ID_INVALID
STM_NUM_ERROR_CODES

Definition at line 47 of file stm_error.h.

Function Documentation

◆ stmErrorCodeToString()

static const char * stmErrorCodeToString ( stmErrorCode_t err )

inlinestatic

Convert STM error code to string representation.

Parameters

[in] err stmErrorCode_t error.

Returns: String representation of stmErrorCode_t.

Definition at line 109 of file stm_error.h.

References stmErrorCodeNames.

Variable Documentation

◆ stmErrorCodeNames

const char* stmErrorCodeNames[]

extern

Referenced by stmErrorCodeToString().