General

Macros

CUDBG_APICLIENT_PID: Name of the global variable containing the API client PID.
CUDBG_APICLIENT_REVISION: Name of the global variable containing the API client revision.
CUDBG_API_VERSION_MAJOR: Major release version number.
CUDBG_API_VERSION_MINOR: Minor release version number.
CUDBG_API_VERSION_REVISION: API revision number.
CUDBG_ATTACH_HANDLER_AVAILABLE: Name of the global variable containing the attach handler available flag.
CUDBG_DEBUGGER_CAPABILITIES: Name of the global variable containing the debug engine capabilities bitmask.
CUDBG_DEBUGGER_INITIALIZED: Name of the global variable containing the debug engine initialized flag.
CUDBG_ENABLE_LAUNCH_BLOCKING: Name of the global variable containing the enable launch blocking flag.
CUDBG_INITIATE_DEBUGGER_ATTACH_PROCEDURE_FD: Name of the global variable containing the debug engine attach procedure initiation FD.
CUDBG_IPC_FLAG_NAME: Name of the global variable containing the IPC flag.
CUDBG_MAX_DEVICES: Maximum number of supported devices.
CUDBG_MAX_LANES: Maximum number of lanes per warp.
CUDBG_MAX_LOG_LEN: Maximum length of a single CUDA log message.
CUDBG_MAX_SMS: Maximum number of SMs per device.
CUDBG_MAX_WARPS: Maximum number of warps per SM.
CUDBG_MAX_WARP_BARRIERS: Maximum number of convergence barriers per warp.
CUDBG_PRE_INIT: Name of the pre-init global function.
CUDBG_REPORTED_DRIVER_API_ERROR_CODE: Name of the global variable containing the code of the driver API error being reported.
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.
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.
CUDBG_REPORTED_DRIVER_API_ERROR_NAME_ADDR: Name of the global variable containing the address where the driver API error name is stored.
CUDBG_REPORTED_DRIVER_API_ERROR_NAME_SIZE: Name of the global variable containing the size of the driver API error name being reported.
CUDBG_REPORTED_DRIVER_API_ERROR_SOURCE: Name of the global variable containing the driver API error source.
CUDBG_REPORTED_DRIVER_API_ERROR_STRING_ADDR: Name of the global variable containing the address where the driver API error string is stored.
CUDBG_REPORTED_DRIVER_API_ERROR_STRING_SIZE: Name of the global variable containing the size of the driver API error string being reported.
CUDBG_REPORTED_DRIVER_INTERNAL_ERROR_CODE: Name of the global variable containing the driver internal error code.
CUDBG_REPORT_ATTACH_PROCEDURE_FINISHED: Name of the global function that's called to report the completion of the attach procedure.
CUDBG_REPORT_DRIVER_API_ERROR: Name of the global function that's called to report a driver API error.
CUDBG_REPORT_DRIVER_API_ERROR_FLAGS: Name of the global variable containing the driver API error flag.
CUDBG_REPORT_DRIVER_INTERNAL_ERROR: Name of the global function that's called to report an internal driver error.
CUDBG_RESUME_FOR_ATTACH_DETACH: Name of the global variable containing the resume for attach detach flag.
CUDBG_RPC_ENABLED: Name of the global variable containing the RPC enabled flag.
CUDBG_SESSION_ID: Name of the global variable containing the session ID.
CUDBG_USE_EXTERNAL_DEBUGGER: Name of the global variable containing the external debug engine in use flag.

Enumerations

CUDBGCapabilityFlags: Debug engine capability flags.
CUDBGReportDriverApiErrorFlags: API error reporting flags.
CUDBGReportedDriverApiErrorSource: Driver API error source.
CUDBGResult: Result values of all the API routines.

Functions

void cudbgApiAttach(void): Attach to a CUDA application.
void cudbgApiDetach(void): Detach from a CUDA application.
void cudbgApiInit(uint32_t arg): Initialize the CUDA Debugger API.
CUDBGResult cudbgGetAPI(uint32_t major, uint32_t minor, uint32_t rev, CUDBGAPI *api): Get the API associated with the major/minor/revision version numbers.
CUDBGResult cudbgGetAPIVersion(uint32_t *major, uint32_t *minor, uint32_t *rev): Get the API version supported by the CUDA driver.
const char * cudbgGetErrorString(CUDBGResult error): Returns the string representation of a result value.
void cudbgPreInit(): Empty global function that gets called before CUDA driver initialization.
void cudbgReportAttachProcedureFinished(void): Report that the attach procedure has finished.
void cudbgReportDriverApiError(void): Report a driver API error.
void cudbgReportDriverInternalError(void): Report a driver internal error.

Structs

CuDim2: 2-dimensional coordinates for threads, blocks, etc.
CuDim3: 3-dimensional coordinates for threads, blocks, etc.

Typedefs

CUDBGAPI: CUDA Debugger API methods.

Macros

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.

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.

CUDBG_API_VERSION_MAJOR 13

Major release version number.

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

CUDBG_API_VERSION_MINOR 4

Minor release version number.

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

CUDBG_API_VERSION_REVISION 193

API revision number.

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

CUDBG_ATTACH_HANDLER_AVAILABLE cudbgAttachHandlerAvailable

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.

CUDBG_DEBUGGER_CAPABILITIES cudbgDebuggerCapabilities

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.

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.

CUDBG_ENABLE_LAUNCH_BLOCKING cudbgEnableLaunchBlocking

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.

CUDBG_INITIATE_DEBUGGER_ATTACH_PROCEDURE_FD cudbgInitiateDebuggerAttachProcedureFd

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.

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.

CUDBG_MAX_DEVICES 64: Maximum number of supported devices.

CUDBG_MAX_LANES 32: Maximum number of lanes per warp.

CUDBG_MAX_LOG_LEN 256: Maximum length of a single CUDA log message.

CUDBG_MAX_SMS 256: Maximum number of SMs per device.

CUDBG_MAX_WARPS 64: Maximum number of warps per SM.

CUDBG_MAX_WARP_BARRIERS 16: Maximum number of convergence barriers per warp.

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.

CUDBG_REPORTED_DRIVER_API_ERROR_CODE cudbgReportedDriverApiErrorCode

Name of the global variable containing the code of the driver API error being reported.