Status Codes

Status Codes#

ROCProfilerV1 API: Status Codes
Status Codes

Most operations return a status code to indicate success or error. More...

Enumerations

enum  rocprofiler_status_t {
  ROCPROFILER_STATUS_SUCCESS = 0 , ROCPROFILER_STATUS_ERROR = -1 , ROCPROFILER_STATUS_ERROR_ALREADY_INITIALIZED = -2 , ROCPROFILER_STATUS_ERROR_NOT_INITIALIZED = -3 ,
  ROCPROFILER_STATUS_ERROR_SESSION_MISSING_BUFFER = -4 , ROCPROFILER_STATUS_ERROR_TIMESTAMP_NOT_APPLICABLE = -5 , ROCPROFILER_STATUS_ERROR_AGENT_NOT_FOUND = -6 , ROCPROFILER_STATUS_ERROR_AGENT_INFORMATION_MISSING = -7 ,
  ROCPROFILER_STATUS_ERROR_QUEUE_NOT_FOUND = -8 , ROCPROFILER_STATUS_ERROR_QUEUE_INFORMATION_MISSING = -9 , ROCPROFILER_STATUS_ERROR_KERNEL_NOT_FOUND = -10 , ROCPROFILER_STATUS_ERROR_KERNEL_INFORMATION_MISSING = -11 ,
  ROCPROFILER_STATUS_ERROR_COUNTER_NOT_FOUND = -12 , ROCPROFILER_STATUS_ERROR_COUNTER_INFORMATION_MISSING = -13 , ROCPROFILER_STATUS_ERROR_TRACER_API_DATA_NOT_FOUND = -14 , ROCPROFILER_STATUS_ERROR_TRACER_API_DATA_INFORMATION_MISSING = -15 ,
  ROCPROFILER_STATUS_ERROR_INCORRECT_DOMAIN = -16 , ROCPROFILER_STATUS_ERROR_SESSION_NOT_FOUND = -17 , ROCPROFILER_STATUS_ERROR_CORRUPTED_SESSION_BUFFER = -18 , ROCPROFILER_STATUS_ERROR_RECORD_CORRUPTED = -19 ,
  ROCPROFILER_STATUS_ERROR_INCORRECT_REPLAY_MODE = -20 , ROCPROFILER_STATUS_ERROR_SESSION_MISSING_FILTER = -21 , ROCPROFILER_STATUS_ERROR_INCORRECT_SIZE = -22 , ROCPROFILER_STATUS_ERROR_INCORRECT_FLUSH_INTERVAL = -23 ,
  ROCPROFILER_STATUS_ERROR_SESSION_FILTER_DATA_MISMATCH = -24 , ROCPROFILER_STATUS_ERROR_FILTER_DATA_CORRUPTED = -25 , ROCPROFILER_STATUS_ERROR_CORRUPTED_LABEL_DATA = -26 , ROCPROFILER_STATUS_ERROR_RANGE_STACK_IS_EMPTY = -27 ,
  ROCPROFILER_STATUS_ERROR_PASS_NOT_STARTED = -28 , ROCPROFILER_STATUS_ERROR_HAS_ACTIVE_SESSION = -29 , ROCPROFILER_STATUS_ERROR_SESSION_NOT_ACTIVE = -30 , ROCPROFILER_STATUS_ERROR_FILTER_NOT_FOUND = -31 ,
  ROCPROFILER_STATUS_ERROR_BUFFER_NOT_FOUND = -32 , ROCPROFILER_STATUS_ERROR_FILTER_NOT_SUPPORTED = -33
}
 ROCProfiler API status codes. More...
 

Functions

ROCPROFILER_API const char * rocprofiler_error_str (rocprofiler_status_t status) ROCPROFILER_VERSION_9_0
 Query the textual description of the given error for the current thread. More...
 

Detailed Description

Most operations return a status code to indicate success or error.

Enumeration Type Documentation

◆ rocprofiler_status_t

ROCProfiler API status codes.

Enumerator
ROCPROFILER_STATUS_SUCCESS 

The function has executed successfully.

ROCPROFILER_STATUS_ERROR 

A generic error has occurred.

ROCPROFILER_STATUS_ERROR_ALREADY_INITIALIZED 

ROCProfiler is already initialized.

ROCPROFILER_STATUS_ERROR_NOT_INITIALIZED 

ROCProfiler is not initialized.

ROCPROFILER_STATUS_ERROR_SESSION_MISSING_BUFFER 

Missing Buffer for a session.

ROCPROFILER_STATUS_ERROR_TIMESTAMP_NOT_APPLICABLE 

Timestamps can't be collected.

ROCPROFILER_STATUS_ERROR_AGENT_NOT_FOUND 

Agent is not found with given identifier.

ROCPROFILER_STATUS_ERROR_AGENT_INFORMATION_MISSING 

Agent information is missing for the given identifier.

ROCPROFILER_STATUS_ERROR_QUEUE_NOT_FOUND 

Queue is not found for the given identifier.

ROCPROFILER_STATUS_ERROR_QUEUE_INFORMATION_MISSING 

The requested information about the queue is not found.

ROCPROFILER_STATUS_ERROR_KERNEL_NOT_FOUND 

Kernel is not found with given identifier.

ROCPROFILER_STATUS_ERROR_KERNEL_INFORMATION_MISSING 

The requested information about the kernel is not found.

ROCPROFILER_STATUS_ERROR_COUNTER_NOT_FOUND 

Counter is not found with the given identifier.

ROCPROFILER_STATUS_ERROR_COUNTER_INFORMATION_MISSING 

The requested Counter information for the given kernel is missing.

ROCPROFILER_STATUS_ERROR_TRACER_API_DATA_NOT_FOUND 

The requested Tracing API Data for the given data identifier is missing.

ROCPROFILER_STATUS_ERROR_TRACER_API_DATA_INFORMATION_MISSING 

The requested information for the tracing API Data is missing.

ROCPROFILER_STATUS_ERROR_INCORRECT_DOMAIN 

The given Domain is incorrect.

ROCPROFILER_STATUS_ERROR_SESSION_NOT_FOUND 

The requested Session given the session identifier is not found.

ROCPROFILER_STATUS_ERROR_CORRUPTED_SESSION_BUFFER 

The requested Session Buffer given the session identifier is corrupted or deleted.

ROCPROFILER_STATUS_ERROR_RECORD_CORRUPTED 

The requested record given the record identifier is corrupted or deleted.

ROCPROFILER_STATUS_ERROR_INCORRECT_REPLAY_MODE 

Incorrect Replay mode.

ROCPROFILER_STATUS_ERROR_SESSION_MISSING_FILTER 

Missing Filter for a session.

ROCPROFILER_STATUS_ERROR_INCORRECT_SIZE 

The size given for the buffer is not applicable.

ROCPROFILER_STATUS_ERROR_INCORRECT_FLUSH_INTERVAL 

Incorrect Flush interval.

ROCPROFILER_STATUS_ERROR_SESSION_FILTER_DATA_MISMATCH 

The session filter can't accept the given data.

ROCPROFILER_STATUS_ERROR_FILTER_DATA_CORRUPTED 

The given filter data is corrupted.

ROCPROFILER_STATUS_ERROR_CORRUPTED_LABEL_DATA 

The given label is corrupted.

ROCPROFILER_STATUS_ERROR_RANGE_STACK_IS_EMPTY 

There is no label in the labels stack to be popped.

ROCPROFILER_STATUS_ERROR_PASS_NOT_STARTED 

There is no pass that started.

ROCPROFILER_STATUS_ERROR_HAS_ACTIVE_SESSION 

There is already Active session, Can't activate two session at the same time.

ROCPROFILER_STATUS_ERROR_SESSION_NOT_ACTIVE 

Can't terminate a non active session.

ROCPROFILER_STATUS_ERROR_FILTER_NOT_FOUND 

The required filter is not found for the given session.

ROCPROFILER_STATUS_ERROR_BUFFER_NOT_FOUND 

The required buffer is not found for the given session.

ROCPROFILER_STATUS_ERROR_FILTER_NOT_SUPPORTED 

The required Filter is not supported.

Function Documentation

◆ rocprofiler_error_str()

ROCPROFILER_API const char* rocprofiler_error_str ( rocprofiler_status_t  status)

Query the textual description of the given error for the current thread.

Returns a NULL terminated string describing the error of the given ROCProfiler API call by the calling thread that did not return success.

Return values
Returnthe error string.