3.1. General

Classes

struct 

CuDim2

2-dimensional coordinates for threads, blocks, etc.

struct 

CuDim3

3-dimensional coordinates for threads, blocks, etc.

Defines

#define CUDBG_APICLIENT_PID cudbgApiClientPid

Name of the global variable containing the API client PID. This variable is set by the API client to identify itself.

#define CUDBG_APICLIENT_REVISION cudbgApiClientRevision

Name of the global variable containing the API client revision. This variable is set by the API client to identify the API revision it wants to use.

#define CUDBG_API_VERSION_MAJOR 13

Major release version number. This matches the major version of the CUDA driver exposing this API.

#define CUDBG_API_VERSION_MINOR 2

Minor release version number. This matches the minor version of the CUDA driver exposing this API.

#define CUDBG_API_VERSION_REVISION 172

API revision number. This number is incremented every time changes are made to the API.

#define CUDBG_ATTACH_HANDLER_AVAILABLE

Name of the global variable containing the attach handler available flag. This variable is set by the debug engine to indicate that the attach handler is available.

#define CUDBG_DEBUGGER_CAPABILITIES

Name of the global variable containing the debug engine capabilities bitmask. This variable is set by the API client to indicate the requested capabilities. See the CUDBGCapabilityFlags enum for the list of available capabilities.

#define CUDBG_DEBUGGER_INITIALIZED cudbgDebuggerInitialized

Name of the global variable containing the debug engine initialized flag. This variable is set by the debug engine to indicate that it has been initialized.

#define CUDBG_ENABLE_LAUNCH_BLOCKING

Name of the global variable containing the enable launch blocking flag. This variable is set by the API client to enable blocking launches of CUDA kernels.

#define CUDBG_INITIATE_DEBUGGER_ATTACH_PROCEDURE_FD

Name of the global variable containing the debug engine attach procedure initiation FD. If this FD is not -1, write a single byte (any value) to it to initiate the CUDA debug engine attach procedure. After the request was received and the attach procedure has finished, the CUDBG_REPORT_ATTACH_PROCEDURE_FINISHED function is called.

#define CUDBG_IPC_FLAG_NAME cudbgIpcFlag

Name of the global variable containing the IPC flag. This variable is set by the API client to indicate that it is ready to attach to a running CUDA application.

#define CUDBG_MAX_DEVICES 64

Maximum number of supported devices.

#define CUDBG_MAX_LANES 32

Maximum number of lanes per warp.

#define CUDBG_MAX_LOG_LEN 256

Maximum length of a single CUDA log message.

#define CUDBG_MAX_SMS 256

Maximum number of SMs per device.

#define CUDBG_MAX_WARPS 64

Maximum number of warps per SM.

#define CUDBG_MAX_WARP_BARRIERS 16

Maximum number of convergence barriers per warp.

#define CUDBG_PRE_INIT cudbgPreInit

Name of the pre-init global function. The API client can set a breakpoint on this function to be notified before the CUDA driver starts its initialization.

#define CUDBG_REPORTED_DRIVER_API_ERROR_CODE

Name of the global variable containing the code of the driver API error being reported. This variable is set by the debug engine when a driver API error is reported.

#define CUDBG_REPORTED_DRIVER_API_ERROR_FUNC_NAME_ADDR

Name of the global variable containing the address of the name of the function in which the driver API error occurred. This variable is set by the debug engine when a driver API error is reported.

#define CUDBG_REPORTED_DRIVER_API_ERROR_FUNC_NAME_SIZE

Name of the global variable containing the size of the name of the function in which the driver API error occurred. This variable is set by the debug engine when a driver API error is reported.

#define CUDBG_REPORTED_DRIVER_API_ERROR_NAME_ADDR

Name of the global variable containing the address where the driver API error name is stored. This variable is set by the debug engine when a driver API error is reported.

#define CUDBG_REPORTED_DRIVER_API_ERROR_NAME_SIZE

Name of the global variable containing the size of the driver API error name being reported. This variable is set by the debug engine when a driver API error is reported.

#define CUDBG_REPORTED_DRIVER_API_ERROR_SOURCE

Name of the global variable containing the driver API error source. This variable is set by the debug engine when a driver API error is reported. See the CUDBGReportedDriverApiErrorSource enum for the list of available sources.

#define CUDBG_REPORTED_DRIVER_API_ERROR_STRING_ADDR

Name of the global variable containing the address where the driver API error string is stored. This variable is set by the debug engine when a driver API error is reported.

#define CUDBG_REPORTED_DRIVER_API_ERROR_STRING_SIZE

Name of the global variable containing the size of the driver API error string being reported. This variable is set by the debug engine when a driver API error is reported.

#define CUDBG_REPORTED_DRIVER_INTERNAL_ERROR_CODE

Name of the global variable containing the driver internal error code. This variable is set by the debug engine when an internal driver error is reported.

#define CUDBG_REPORT_ATTACH_PROCEDURE_FINISHED

Name of the global function that's called to report the completion of the attach procedure. The API client can set a breakpoint on this function to be notified about the completion of the attach procedure. This function is called after the attach is done after signalling CUDBG_INITIATE_DEBUGGER_ATTACH_PROCEDURE_FD.

#define CUDBG_REPORT_DRIVER_API_ERROR

Name of the global function that's called to report a driver API error. The API client can set a breakpoint on this function to be notified about driver API errors.

#define CUDBG_REPORT_DRIVER_API_ERROR_FLAGS

Name of the global variable containing the driver API error flag. This variable is set by the API client to indicate which driver API errors should be reported. See the CUDBGReportDriverApiErrorFlags enum for the list of available flags.

#define CUDBG_REPORT_DRIVER_INTERNAL_ERROR

Name of the global function that's called to report an internal driver error. The API client can set a breakpoint on this function to be notified about internal driver errors.

#define CUDBG_RESUME_FOR_ATTACH_DETACH

Name of the global variable containing the resume for attach detach flag. This variable is set by the debug engine to indicate that the API client should resume the CUDA application (including the CPU) to complete the attach or detach procedure.

#define CUDBG_RPC_ENABLED cudbgRpcEnabled

Name of the global variable containing the RPC enabled flag. This variable is only used by debuggers that use the RPCD interface (e.g. CUDA-GDB).

#define CUDBG_SESSION_ID cudbgSessionId

Name of the global variable containing the session ID. This variable is set by the API client to identify the session.

#define CUDBG_USE_EXTERNAL_DEBUGGER cudbgUseExternalDebugger

Name of the global variable containing the external debug engine in use flag. Can be read to detect whether the external debug engine implementation (libcudadebugger.so) is used or not.

Enumerations

enum CUDBGCapabilityFlags

Debug engine capability flags. Clients should request the capabilities they want by setting the CUDBG_DEBUGGER_CAPABILITIES global variable and then checking the supported capabilities by calling the getSupportedDebuggerCapabilities() API method and adjusting their behavior accordingly. Capabilities requested but not supported by the debug engine will be ignored and should not be relied upon.

enum CUDBGReportDriverApiErrorFlags

API error reporting flags.

enum CUDBGReportedDriverApiErrorSource

Driver API error source.

enum CUDBGResult

Result values of all the API routines.

Functions

void CUDBG_PRE_INIT ( )

Empty global function that gets called before CUDA driver initialization. The API client can set a breakpoint on this function to be notified before the CUDA driver starts its initialization.

void CUDBG_REPORT_ATTACH_PROCEDURE_FINISHED ( void )

Report that the attach procedure has finished. The API client can set a breakpoint on this function to be notified that the attach procedure has finished.

void CUDBG_REPORT_DRIVER_API_ERROR ( void )

Report a driver API error. The API client can set a breakpoint on this function to be notified about driver API errors.

void CUDBG_REPORT_DRIVER_INTERNAL_ERROR ( void )

Report a driver internal error. The API client can set a breakpoint on this function to be notified about driver internal errors.

void cudbgApiAttach ( void )

Attach to a CUDA application. Remotely called by the API client during the attach procedure to attach to the CUDA application.

void cudbgApiDetach ( void )

Detach from a CUDA application. Remotely called by the API client during the detach procedure to detach from the CUDA application.

void cudbgApiInit ( uint32_t arg )

Initialize the CUDA Debugger API. Remotely called by the API client during the attach procedure to initialize the debugger API.

CUDBGResult cudbgGetAPIVersion ( uint32_t* major, uint32_t* minor, uint32_t* rev )

Get the API version supported by the CUDA driver.

const _CUDBG_INLINE char* cudbgGetErrorString ( CUDBGResult error )

Returns the string representation of a result value. It is preferred to use this function instead of indexing CUDBGResultNames directly as future versions of the old API methods might start returning new result values.