hipDNN backend status C API

hipDNN backend status C API#

2026-03-31

3 min read time

Applies to Linux and Windows

Status codes returned by hipDNN backend API functions.

This file defines the status codes used throughout the hipDNN backend API. All hipDNN backend functions return a hipdnnStatus_t value to indicate success or the type of error that occurred.

Enums

enum hipdnnStatus_t#

Return status codes for hipDNN backend API functions.

Each hipDNN backend function returns a status code indicating the result of the operation. HIPDNN_STATUS_SUCCESS indicates successful completion, while other values indicate specific error conditions.

Error codes are organized into categories:

  • Success (0): Operation completed successfully

  • Parameter errors (1-7): Invalid inputs from the caller

  • Not supported (8): Requested functionality unavailable

  • Internal errors (9-13): Library internal failures

  • Plugin errors (14): Errors from loaded plugins

Values:

enumerator HIPDNN_STATUS_SUCCESS#

Operation completed successfully.

enumerator HIPDNN_STATUS_NOT_INITIALIZED#

Data or descriptor not properly initialized before use.

enumerator HIPDNN_STATUS_BAD_PARAM#

Invalid parameter error (category)

An incorrect value or parameter was passed to the function. Check the function documentation for valid parameter ranges.

enumerator HIPDNN_STATUS_BAD_PARAM_NULL_POINTER#

Null pointer received where non-null was required.

The API received a null pointer from the user where a valid pointer was expected.

enumerator HIPDNN_STATUS_BAD_PARAM_NOT_FINALIZED#

Descriptor not finalized before use.

The backend descriptor must be finalized by calling hipdnnBackendFinalize() before it can be used.

enumerator HIPDNN_STATUS_BAD_PARAM_OUT_OF_BOUND#

Array index or count out of valid range.

An out-of-bound value was passed to the API, such as an invalid array index or element count.

enumerator HIPDNN_STATUS_BAD_PARAM_SIZE_INSUFFICIENT#

Buffer too small for requested operation.

The provided memory buffer has insufficient space for the requested data. Query the required size first.

enumerator HIPDNN_STATUS_BAD_PARAM_STREAM_MISMATCH#

Stream mismatch between handle and execution.

The HIP stream passed to the API does not match the stream associated with the hipDNN handle.

enumerator HIPDNN_STATUS_NOT_SUPPORTED#

Functionality not supported.

The requested functionality is not currently supported by hipDNN. This may be due to unsupported data types, tensor layouts, or operation configurations.

enumerator HIPDNN_STATUS_INTERNAL_ERROR#

Internal library error (category)

An internal hipDNN operation failed. This typically indicates a bug in the library.

enumerator HIPDNN_STATUS_ALLOC_FAILED#

Memory allocation failed.

A memory allocation operation failed. This could be either host or device memory allocation.

enumerator HIPDNN_STATUS_INTERNAL_ERROR_HOST_ALLOCATION_FAILED#

Host memory allocation failed.

An internal host (CPU) memory allocation failed inside the hipDNN library.

enumerator HIPDNN_STATUS_INTERNAL_ERROR_DEVICE_ALLOCATION_FAILED#

Device memory allocation failed.

An internal device (GPU) memory allocation failed inside the hipDNN library.

enumerator HIPDNN_STATUS_EXECUTION_FAILED#

GPU kernel execution failed.

The GPU program failed to execute. This could indicate invalid tensor data, incorrect dimensions, or a GPU error.

enumerator HIPDNN_STATUS_PLUGIN_ERROR#

Plugin error.

An error occurred in a loaded plugin. Check plugin-specific error messages for details.