3.2. Initialization

Variables

CUDBGResult  ( *CUDBGAPI_st::clearAttachState )( )
Clear attach-specific state prior to detach.
CUDBGResult  ( *CUDBGAPI_st::finalize )( )
Finalize the API, shutting down the debugging session.
CUDBGResult  ( *CUDBGAPI_st::getSupportedDebuggerCapabilities )( CUDBGCapabilityFlags* capabilities )
Returns debug agent capabilities that are supported by this version of the API.
CUDBGResult  ( *CUDBGAPI_st::initialize )( )
Initialize the API.
CUDBGResult  ( *CUDBGAPI_st::initializeAttachStub )( )
Initialize the attach stub.
CUDBGResult  ( *CUDBGAPI_st::requestCleanupOnDetach )( uint32_t appResumeFlag )
Request for cleanup of driver state when detaching.
CUDBGResult  ( *CUDBGAPI_st::requestCleanupOnDetach55 )( )
Request for cleanup of driver state when detaching.

Variables

CUDBGResult ( *CUDBGAPI_st::clearAttachState )( )

Clear attach-specific state prior to detach. This call prepares the API for detaching. See the "Attaching and Detaching" section for more information.

Since CUDA 5.0.

Returns

CUDBG_SUCCESS, CUDBG_ERROR_UNINITIALIZED, CUDBG_ERROR_INITIALIZATION_FAILURE, CUDBG_ERROR_RECURSIVE_API_CALL

CUDBGResult ( *CUDBGAPI_st::finalize )( )

Finalize the API, shutting down the debugging session. Since CUDA 3.0.

See also:

initialize

Returns

CUDBG_SUCCESS, CUDBG_ERROR_UNINITIALIZED, CUDBG_ERROR_INITIALIZATION_FAILURE, CUDBG_ERROR_RECURSIVE_API_CALL

CUDBGResult ( *CUDBGAPI_st::getSupportedDebuggerCapabilities )( CUDBGCapabilityFlags* capabilities )

Returns debug agent capabilities that are supported by this version of the API. This API method can be called without initializing the API.

Since CUDA 12.5.

Parameters
capabilities
- returned debug engine capabilities
Returns

CUDBG_SUCCESS, CUDBG_ERROR_INVALID_ARGS, CUDBG_ERROR_INITIALIZATION_FAILURE, CUDBG_ERROR_RECURSIVE_API_CALL

CUDBGResult ( *CUDBGAPI_st::initialize )( )

Initialize the API. setNotifyNewEventCallback() and getSupportedDebuggerCapabilities() can be called before initialize(). If no CUDA devices are detected on the system, CUDBG_ERROR_NO_DEVICE_AVAILABLE is returned.

Since CUDA 3.0.

See also:

finalize

Returns

CUDBG_SUCCESS, CUDBG_ERROR_INITIALIZATION_FAILURE, CUDBG_ERROR_NO_DEVICE_AVAILABLE

CUDBGResult ( *CUDBGAPI_st::initializeAttachStub )( )

Initialize the attach stub. This is no longer necessary starting with driver version r590.

Since CUDA 5.0.

Returns

CUDBG_SUCCESS

CUDBGResult ( *CUDBGAPI_st::requestCleanupOnDetach )( uint32_t appResumeFlag )

Request for cleanup of driver state when detaching. Needs to be conditionally called by the client depending on the state of the debugged application. See the "Attaching and Detaching" section for more information.

Since CUDA 6.0.

Parameters
appResumeFlag
- value of CUDBG_RESUME_FOR_ATTACH_DETACH as read from the application's process space.
Returns

CUDBG_SUCCESS, CUDBG_ERROR_INVALID_ARGS, CUDBG_ERROR_UNINITIALIZED, CUDBG_ERROR_INTERNAL, CUDBG_ERROR_INITIALIZATION_FAILURE, CUDBG_ERROR_RECURSIVE_API_CALL

CUDBGResult ( *CUDBGAPI_st::requestCleanupOnDetach55 )( )

Request for cleanup of driver state when detaching. Needs to be conditionally called by the client depending on the state of the debugged application. See the "Attaching and Detaching" section for more information.

Since CUDA 5.0.

Note:

DEPRECATED in CUDA 6.0: Use requestCleanupOnDetach instead.

See also:

requestCleanupOnDetach

Returns

CUDBG_SUCCESS, CUDBG_ERROR_INVALID_ARGS, CUDBG_ERROR_UNINITIALIZED, CUDBG_ERROR_INTERNAL, CUDBG_ERROR_INITIALIZATION_FAILURE, CUDBG_ERROR_RECURSIVE_API_CALL