Typedefs | |
typedef SanitizerPatchResult(SANITIZERAPI * | SanitizerCallbackBarrier )(void *userdata, uint64_t pc, uint32_t barIndex, uint32_t threadCount, uint32_t flags) |
Function type for a barrier callback. | |
typedef SanitizerPatchResult(SANITIZERAPI * | SanitizerCallbackBlockEnter )(void *userdata, uint64_t pc) |
Function type for a CUDA block enter callback. | |
typedef SanitizerPatchResult(SANITIZERAPI * | SanitizerCallbackBlockExit )(void *userdata, uint64_t pc) |
Function type for a CUDA block exit callback. | |
typedef SanitizerPatchResult(SANITIZERAPI * | SanitizerCallbackCall )(void *userdata, uint64_t pc, uint64_t targetPc, uint32_t flags) |
Function type for a function call callback. | |
typedef SanitizerPatchResult(SANITIZERAPI * | SanitizerCallbackCudaBarrier )(void *userdata, uint64_t pc, void *barrier, uint32_t kind, uint32_t data) |
Function type for a CUDA Barrier action callback. | |
typedef SanitizerPatchResult(SANITIZERAPI * | SanitizerCallbackDeviceSideFree )(void *userdata, uint64_t pc, void *ptr) |
Function type for a device-side free call. | |
typedef SanitizerPatchResult(SANITIZERAPI * | SanitizerCallbackDeviceSideMalloc )(void *userdata, uint64_t pc, void *allocatedPtr, uint64_t allocatedSize) |
Function type for a device-side malloc call. | |
typedef SanitizerPatchResult(SANITIZERAPI * | SanitizerCallbackMemcpyAsync )(void *userdata, uint64_t pc, void *src, void *dst, uint32_t accessSize) |
Function type for a global to shared memory asynchronous copy. | |
typedef SanitizerPatchResult(SANITIZERAPI * | SanitizerCallbackMemoryAccess )(void *userdata, uint64_t pc, void *ptr, uint32_t accessSize, uint32_t flags, const void *newValue) |
Function type for a memory access callback. | |
typedef SanitizerPatchResult(SANITIZERAPI * | SanitizerCallbackRet )(void *userdata, uint64_t pc) |
Function type for a function return callback. | |
typedef SanitizerPatchResult(SANITIZERAPI * | SanitizerCallbackShfl )(void *userdata, uint64_t pc) |
Function type for a shfl callback. | |
typedef SanitizerPatchResult(SANITIZERAPI * | SanitizerCallbackSyncwarp )(void *userdata, uint64_t pc, uint32_t mask) |
Function type for a syncwarp callback. | |
Enumerations | |
enum | Sanitizer_BarrierFlags { SANITIZER_BARRIER_FLAG_NONE = 0, SANITIZER_BARRIER_FLAG_UNALIGNED_ALLOWED = 0x1 } |
Flags describing a barrier. More... | |
enum | Sanitizer_CallFlags { SANITIZER_CALL_FLAG_NONE = 0, SANITIZER_CALL_FLAG_UNALIGNED_ALLOWED = 0x1 } |
Flags describing a function call. More... | |
enum | Sanitizer_CudaBarrierInstructionKind { SANITIZER_CUDA_BARRIER_INVALID = 0, SANITIZER_CUDA_BARRIER_INIT = 1, SANITIZER_CUDA_BARRIER_ARRIVE = 2, SANITIZER_CUDA_BARRIER_ARRIVE_NOCOMPLETE = 3, SANITIZER_CUDA_BARRIER_WAIT = 4, SANITIZER_CUDA_BARRIER_INVALIDATE = 5 } |
CUDA Barrier action kind. More... | |
enum | Sanitizer_DeviceMemoryFlags { SANITIZER_MEMORY_DEVICE_FLAG_NONE = 0, SANITIZER_MEMORY_DEVICE_FLAG_READ = 0x1, SANITIZER_MEMORY_DEVICE_FLAG_WRITE = 0x2, SANITIZER_MEMORY_DEVICE_FLAG_ATOMSYS = 0x4 } |
Flags describing a memory access. More... | |
enum | Sanitizer_InstructionId { SANITIZER_INSTRUCTION_INVALID = 0, SANITIZER_INSTRUCTION_BLOCK_ENTER = 1, SANITIZER_INSTRUCTION_BLOCK_EXIT = 2, SANITIZER_INSTRUCTION_GLOBAL_MEMORY_ACCESS = 3, SANITIZER_INSTRUCTION_SHARED_MEMORY_ACCESS = 4, SANITIZER_INSTRUCTION_LOCAL_MEMORY_ACCESS = 5, SANITIZER_INSTRUCTION_BARRIER = 6, SANITIZER_INSTRUCTION_SYNCWARP = 7, SANITIZER_INSTRUCTION_SHFL = 8, SANITIZER_INSTRUCTION_CALL = 9, SANITIZER_INSTRUCTION_RET = 10, SANITIZER_INSTRUCTION_DEVICE_SIDE_MALLOC = 11, SANITIZER_INSTRUCTION_DEVICE_SIDE_FREE = 12, SANITIZER_INSTRUCTION_CUDA_BARRIER = 13, SANITIZER_INSTRUCTION_MEMCPY_ASYNC = 14 } |
Instrumentation. More... | |
enum | SanitizerPatchResult { SANITIZER_PATCH_SUCCESS = 0, SANITIZER_PATCH_ERROR = 1 } |
Sanitizer patch result codes. More... | |
Functions | |
SanitizerResult SANITIZERAPI | sanitizerAddPatches (const void *image, CUcontext ctx) |
Load a module containing patches that can be used by the patching API. | |
SanitizerResult SANITIZERAPI | sanitizerAddPatchesFromFile (const char *filename, CUcontext ctx) |
Load a module containing patches that can be used by the patching API. | |
SanitizerResult SANITIZERAPI | sanitizerGetCallbackPcAndSize (CUcontext ctx, const char *deviceCallbackName, uint64_t *pc, uint64_t *size) |
Get PC and size of a device callback. | |
SanitizerResult SANITIZERAPI | sanitizerGetFunctionPcAndSize (CUmodule module, const char *functionName, uint64_t *pc, uint64_t *size) |
Get PC and size of a CUDA function. | |
SanitizerResult SANITIZERAPI | sanitizerPatchInstructions (const Sanitizer_InstructionId instructionId, CUmodule module, const char *deviceCallbackName) |
Set instrumentation points and patches to be applied in a module. | |
SanitizerResult SANITIZERAPI | sanitizerPatchModule (CUmodule module) |
Perform the actual instrumentation of a module. | |
SanitizerResult SANITIZERAPI | sanitizerSetCallbackData (CUfunction kernel, const void *userdata) |
Specifies the user data pointer for callbacks. | |
SanitizerResult SANITIZERAPI | sanitizerSetLaunchCallbackData (Sanitizer_LaunchHandle launch, CUfunction kernel, Sanitizer_StreamHandle stream, const void *userdata) |
Specifies the user data pointer for callbacks. | |
SanitizerResult SANITIZERAPI | sanitizerUnpatchModule (CUmodule module) |
Remove existing instrumentation of a module. |
typedef SanitizerPatchResult(SANITIZERAPI * SanitizerCallbackBarrier)(void *userdata, uint64_t pc, uint32_t barIndex, uint32_t threadCount, uint32_t flags) |
userdata
is a pointer to user data. See sanitizerPatchModule pc
is the program counter of the patched instruction barIndex
is the barrier index. threadCount
is the number of expected threads (must be a multiple of the warp size). flags
contains information about the barrier. See Sanitizer_BarrierFlags to interpret this value. 0 means that all threads are participating in the barrier.
typedef SanitizerPatchResult(SANITIZERAPI * SanitizerCallbackBlockEnter)(void *userdata, uint64_t pc) |
userdata
is a pointer to user data. See sanitizerPatchModule pc
is the program counter of the entry point of the block
typedef SanitizerPatchResult(SANITIZERAPI * SanitizerCallbackBlockExit)(void *userdata, uint64_t pc) |
userdata
is a pointer to user data. See sanitizerPatchModule pc
is the program counter of the patched instruction
typedef SanitizerPatchResult(SANITIZERAPI * SanitizerCallbackCall)(void *userdata, uint64_t pc, uint64_t targetPc, uint32_t flags) |
userdata
is a pointer to user data. See sanitizerPatchModule pc
is the program counter of the patched instruction targetPc
is the PC where the called function is located. flags
contains information about the function call.
typedef SanitizerPatchResult(SANITIZERAPI * SanitizerCallbackCudaBarrier)(void *userdata, uint64_t pc, void *barrier, uint32_t kind, uint32_t data) |
userdata
is a pointer to user data. See sanitizerPatchModule pc
is the program counter of the patched instruction barrier
Barrier address which can be used as a unique identifier kind
Barrier action type. See Sanitizer_CudaBarrierInstructionKind data
Barrier data. This is specific to each action type, refer to Sanitizer_CudaBarrierInstructionKind
typedef SanitizerPatchResult(SANITIZERAPI * SanitizerCallbackDeviceSideFree)(void *userdata, uint64_t pc, void *ptr) |
userdata
is a pointer to user data. See sanitizerPatchModule pc
is the program counter of the patched instruction ptr
is the pointer passed to device-side free.
typedef SanitizerPatchResult(SANITIZERAPI * SanitizerCallbackDeviceSideMalloc)(void *userdata, uint64_t pc, void *allocatedPtr, uint64_t allocatedSize) |
userdata
is a pointer to user data. See sanitizerPatchModule pc
is the program counter of the patched instruction allocatedPtr
is the pointer returned by device-side malloc allocatedSize
is the size requested by the user to device-side malloc.
typedef SanitizerPatchResult(SANITIZERAPI * SanitizerCallbackMemcpyAsync)(void *userdata, uint64_t pc, void *src, void *dst, uint32_t accessSize) |
userdata
is a pointer to user data. See sanitizerPatchModule pc
is the program counter of the patched instruction src
is the address of the global memory being read. This can be NULL if src-size is 0. dst
is the address of the shared memory being written. This is an offset within the shared memory window accessSize
is the size of the access in bytes. Valid values are 4, 8 and 16.
typedef SanitizerPatchResult(SANITIZERAPI * SanitizerCallbackMemoryAccess)(void *userdata, uint64_t pc, void *ptr, uint32_t accessSize, uint32_t flags, const void *newValue) |
userdata
is a pointer to user data. See sanitizerPatchModule pc
is the program counter of the patched instruction ptr
is the address of the memory being accessed. For local or shared memory access, this is the offset within the local or shared memory window. accessSize
is the size of the access in bytes. Valid values are 1, 2, 4, 8, and 16. flags
contains information about the type of access. See Sanitizer_DeviceMemoryFlags to interpret this value. newValue
is a pointer to the new value being written if the acces is a write. If the access is a read or an atomic, the pointer will be NULL.
typedef SanitizerPatchResult(SANITIZERAPI * SanitizerCallbackRet)(void *userdata, uint64_t pc) |
userdata
is a pointer to user data. See sanitizerPatchModule pc
is the program counter of the patched instruction
typedef SanitizerPatchResult(SANITIZERAPI * SanitizerCallbackShfl)(void *userdata, uint64_t pc) |
userdata
is a pointer to user data. See sanitizerPatchModule pc
is the program counter of the patched instruction
typedef SanitizerPatchResult(SANITIZERAPI * SanitizerCallbackSyncwarp)(void *userdata, uint64_t pc, uint32_t mask) |
userdata
is a pointer to user data. See sanitizerPatchModule pc
is the program counter of the patched instruction mask
is the thread mask passed to __syncwarp().
Flags describing a barrier. These values are to be or-combined in the value of flags for a SanitizerCallbackBarrier callback.
enum Sanitizer_CallFlags |
Flags describing a function call. These values are to be or-combined in the value of flags for a SanitizerCallbackCall callback.
Refer to the CUDA Barrier interface section of the CUDA toolkit documentation for a more extensive description of these actions.
Flags describing a memory access. These values are to be or-combined in the value of flags for a SanitizerCallbackMemoryAccess callback.
Instrumentation. Every entry represent an instruction type or a function call where a callback patch can be inserted.
enum SanitizerPatchResult |
SanitizerResult SANITIZERAPI sanitizerAddPatches | ( | const void * | image, | |
CUcontext | ctx | |||
) |
The patches loaded are only valid for the specified CUDA context.
image | Pointer to module data to load. This API supports the same module formats as the cuModuleLoadData and cuModuleLoadFatBinary functions from the CUDA driver API. | |
ctx | CUDA context in which to load the patches. If ctx is NULL, the current context will be used. |
SANITIZER_SUCCESS | on success | |
SANITIZER_ERROR_NOT_INITIALIZED | if unable to initialize the sanitizer | |
SANITIZER_ERROR_INVALID_PARAMETER | if image does not point to a valid CUDA module. |
SanitizerResult SANITIZERAPI sanitizerAddPatchesFromFile | ( | const char * | filename, | |
CUcontext | ctx | |||
) |
The patches loaded are only valid for the specified CUDA context.
filename | Path to the module file. This API supports the same module formats as the cuModuleLoad function from the CUDA driver API. | |
ctx | CUDA context in which to load the patches. If ctx is NULL, the current context will be used. |
SANITIZER_SUCCESS | on success | |
SANITIZER_ERROR_NOT_INITIALIZED | if unable to initialize the sanitizer | |
SANITIZER_ERROR_INVALID_PARAMETER | if filename is not a path to a valid CUDA module. |
SanitizerResult SANITIZERAPI sanitizerGetCallbackPcAndSize | ( | CUcontext | ctx, | |
const char * | deviceCallbackName, | |||
uint64_t * | pc, | |||
uint64_t * | size | |||
) |
[in] | ctx | CUDA context in which the patches were loaded. If ctx is NULL, the current context will be used. |
[in] | deviceCallbackName | device function callback name |
[out] | pc | Callback PC returned |
[out] | size | Callback size returned |
SANITIZER_SUCCESS | on success | |
SANITIZER_ERROR_INVALID_PARAMETER | if deviceCallbackName function cannot be located, if pc is NULL or if size is NULL. |
SanitizerResult SANITIZERAPI sanitizerGetFunctionPcAndSize | ( | CUmodule | module, | |
const char * | functionName, | |||
uint64_t * | pc, | |||
uint64_t * | size | |||
) |
[in] | module | CUDA module containing the function |
[in] | deviceCallbackName | CUDA function name |
[out] | pc | Function start program counter (PC) returned |
[out] | size | Function size in bytes returned |
SANITIZER_SUCCESS | on success | |
SANITIZER_ERROR_INVALID_PARAMETER | if functionName function cannot be located, if pc is NULL or if size is NULL. |
SanitizerResult SANITIZERAPI sanitizerPatchInstructions | ( | const Sanitizer_InstructionId | instructionId, | |
CUmodule | module, | |||
const char * | deviceCallbackName | |||
) |
Mark that all instrumentation points matching instructionId are to be patched in order to call the device function identified by deviceCallbackName. It is up to the API client to ensure that this device callback exists and match the correct callback format for this instrumentation point.
instructionId | Instrumentation point for which to insert patches | |
module | CUDA module to instrument | |
deviceCallbackName | Name of the device function callback that the inserted patch will call at the instrumented points. This function is expected to be found in code previously loaded by sanitizerAddPatchesFromFile or sanitizerAddPatches. |
SANITIZER_SUCCESS | on success | |
SANITIZER_ERROR_NOT_INITIALIZED | if unable to initialize the sanitizer | |
SANITIZER_ERROR_INVALID_PARAMETER | if module is not a CUDA module or if deviceCallbackName function cannot be located. |
SanitizerResult SANITIZERAPI sanitizerPatchModule | ( | CUmodule | module | ) |
Perform the instrumentation of a CUDA module based on previous calls to sanitizerPatchInstructions. This function also specifies the device memory buffer to be passed in as userdata to all callback functions.
module | CUDA module to instrument |
SANITIZER_SUCCESS | on success | |
SANITIZER_ERROR_INVALID_PARAMETER | if module is not a CUDA module |
SanitizerResult SANITIZERAPI sanitizerSetCallbackData | ( | CUfunction | kernel, | |
const void * | userdata | |||
) |
Mark all subsequent launches of kernel
to use userdata
pointer as the device memory buffer to pass in to callback functions.
kernel | CUDA function to link to user data. Callbacks in subsequent launches on this kernel will use userdata as callback data. | |
userdata | Device memory buffer. This data will be passed to callback functions via the userdata parameter. |
SANITIZER_SUCCESS | on success |
SanitizerResult SANITIZERAPI sanitizerSetLaunchCallbackData | ( | Sanitizer_LaunchHandle | launch, | |
CUfunction | kernel, | |||
Sanitizer_StreamHandle | stream, | |||
const void * | userdata | |||
) |
Mark launch
to use userdata
pointer as the device memory buffer to pass in to callback functions. This function is only available if the driver version is 455 or newer.
launch | Kernel launch to link to user data. Callbacks in this kernel launch will use userdata as callback data. | |
kernel | CUDA function associated with the kernel launch. | |
stream | CUDA stream associated with the stream launch. | |
userdata | Device memory buffer. This data will be passed to callback functions via the userdata parameter. |
SANITIZER_SUCCESS | on success |
SanitizerResult SANITIZERAPI sanitizerUnpatchModule | ( | CUmodule | module | ) |
Remove any instrumentation of a CUDA module performed by previous calls to sanitizerPatchModule.
module | CUDA module on which to remove instrumentation |
SANITIZER_SUCCESS | on success |