CUPTI User's Guide

More documents

Recommendations

Info

esource tracking, and a domain for CUDA synchronization notification.Callback ID: Each callback is given a unique ID within the corresponding callback domainso that you can identify it within your callback function. The CUDA driver API IDsare defined in cupti_driver_cbid.h and the CUDA runtime API IDs are defined incupti_runtime_cbid.h. Both of these headers are included for you when youinclude cupti.h. The CUDA resource callback IDs are defined byCUpti_CallbackIdResource and the CUDA synchronization callback IDs are definedby CUpti_CallbackIdSync.Callback Function: Your callback function must be of type CUpti_CallbackFunc. Thisfunction type has two arguments that specify the callback domain and ID so thatyou know why the callback is occurring. The type also has a cbdata argument thatis used to pass data specific to the callback.Subscriber: A subscriber is used to associate each of your callback functions with one ormore CUDA API functions. There can be at most one subscriber initialized withcuptiSubscribe() at any time. Before initializing a new subscriber, the existingsubscriber must be finalized with cuptiUnsubscribe().Each callback domain is described in detail below.Driver and Runtime API CallbacksUsing the callback API with the CUPTI_CB_DOMAIN_DRIVER_API orCUPTI_CB_DOMAIN_RUNTIME_API domains, you can associate a callback function with oneor more CUDA API functions. When those CUDA functions are invoked in theapplication, your callback function is invoked as well. For these domains, the cbdataargument to your callback function will be of the type CUpti_CallbackData.The following code shows a typical sequence used to associate a callback function with oneor more CUDA API functions. To simplify the presentation error checking code has beenremoved.CUpti_SubscriberHandle subscriber ;MyDataStruct * my_data = ...;...cuptiSubscribe (& subscriber ,( CUpti_CallbackFunc ) my_callback , my_data );cuptiEnableDomain (1, subscriber ,CUPTI_CB_DOMAIN_RUNTIME_API );First, cuptiSubscribe is used to initialize a subscriber with the my_callback callbackfunction. Next, cuptiEnableDomain is used to associate that callback with all the CUDAruntime API functions. Using this code sequence will cause my_callback to be calledCUDA Tools SDK CUPTI User’s Guide DA-05679-001_v01 | 6
twice each time any of the CUDA runtime API functions are invoked, once on entry to theCUDA function and once just before exit from the CUDA function. CUPTI callback APIfunctions cuptiEnableCallback and cuptiEnableAllDomains can also be used toassociate CUDA API functions with a callback (see reference below for more information).The following code shows a typical callback function.void CUPTIAPImy_callback ( void * userdata , CUpti_CallbackDomain domain ,CUpti_CallbackId cbid , const void * cbdata ){const CUpti_CallbackData * cbInfo = ( CUpti_CallbackData *)←↪cbdata ;MyDataStruct * my_data = ( MyDataStruct *) userdata ;if (( domain == CUPTI_CB_DOMAIN_RUNTIME_API ) &&( cbid == CUPTI_RUNTIME_TRACE_CBID_cudaMemcpy_v3020 )) {if ( cbInfo -> callbackSite == CUPTI_API_ENTER ) {cudaMemcpy_v3020_params * funcParams =( cudaMemcpy_v3020_params *)(cbInfo ->functionParams );...}size_t count = funcParams -> count ;enum cudaMemcpyKind kind = funcParams -> kind ;...In your callback function, you use the CUpti_CallbackDomain and CUpti_CallbackIDparameters to determine which CUDA API function invocation is causing this callback. Inthe example above, we are checking for the CUDA runtime cudaMemCpy function. TheCUpti_CallbackData parameter holds a structure of useful information that can be usedwithin the callback. In this case we use the callbackSite member of the structure todetect that the callback is occurring on entry to cudaMemCpy, and we use thefunctionParams member to access the parameters that were passed to cudaMemCpy. Toaccess the parameters we first cast functionParams to a structure type corresponding tothe cudaMemCpy function. These parameter structures are contained ingenerated_cuda_runtime_api_meta.h, generated_cuda_meta.h, and a number of otherfiles. When possible these files are included for you by cupti.h.The callback_event and callback_timestamp samples described on page 25 bothshow how to use the callback API for the driver and runtime API domains.CUDA Tools SDK CUPTI User’s Guide DA-05679-001_v01 | 7
Page 1 and 2: CUDA Tools SDKCUPTI User’s GuideD
Page 3 and 4: CUPTIThe CUDA Profiling Tools Inter
Page 5: CUPTI_CBID_RESOURCE_CONTEXT_CREATED
Page 9 and 10: device-specific limits. At any give
Page 11 and 12: Sampling EventsThe event API can al
Page 13: CapabilityEvent Name Description Ty
Page 16 and 17: CapabilityEvent Name Description Ty
Page 18 and 19: CapabilityEvent Name Description Ty
Page 20: CapabilityEvent Name Description Ty
Page 26 and 27: CUPTI ReferenceCUPTI VersionDefines
Page 28 and 29: CUPTI Result CodesEnumerations◮ e
Page 30 and 31: CUPTI_ERROR_INVALID_METRIC_IDCUPTI_
Page 32 and 33: CUPTI_ACTIVITY_COMPUTE_API_OPENCL =
Page 34 and 35: size_t ∗validBufferSizeBytes)Quer
Page 36 and 37: CUPTI_ACTIVITY_MEMCPY_KIND_HTOAcopy
Page 38 and 39: CUptiResult cuptiActivityEnqueueBuf
Page 40 and 41: CUptiResult cuptiActivityGetNumDrop
Page 42 and 43: CUpti_Activity Type ReferenceThe ba
Page 44 and 45: CUpti_ActivityKind CUpti_ActivityAP
Page 46 and 47: Detailed DescriptionThis activity r
Page 48 and 49: uint32_t CUpti_ActivityDevice::maxI
Page 50 and 51: uint64_t CUpti_ActivityEvent::value
Page 52 and 53: Field Documentationint32_t CUpti_Ac
Page 54 and 55: uint16_t CUpti_ActivityKernel::regi
Page 56 and 57:
uint8_t CUpti_ActivityMemcpy::copyK
Page 58 and 59:
CUpti_ActivityMemset Type Reference
Page 60 and 61:
CUpti_ActivityMetric Type Reference
Page 62 and 63:
CUPTI Callback APIData Structures
Page 64 and 65:
Enable or disabled all callbacks fo
Page 66 and 67:
Enumerator:CUPTI_CBID_RESOURCE_INVA
Page 68 and 69:
Parameters:enable New enable state
Page 70 and 71:
CUptiResult cuptiUnsubscribe (CUpti
Page 72 and 73:
context.uint32_t CUpti_CallbackData
Page 74 and 75:
CUpti_ResourceData Type ReferenceDa
Page 76 and 77:
CUPTI Event APIData Structures◮ s
Page 78 and 79:
CUPTI_EVENT_GROUP_ATTR_NUM_EVENTS =
Page 80 and 81:
∗eventValueBuffer, size_t ∗even
Page 82 and 83:
CUPTI_DEVICE_ATTR_MAX_EVENT_DOMAIN_
Page 84 and 85:
CUPTI_EVENT_GROUP_ATTR_PROFILE_ALL_
Page 86 and 87:
valueSize The size of the value buf
Page 88 and 89:
Return values:CUPTI_SUCCESSCUPTI_ER
Page 90 and 91:
Parameters:device The CUDA deviceev
Page 92 and 93:
Parameters:eventGroup The event gro
Page 94 and 95:
flags Flags controlling the reading
Page 96 and 97:
Return values:CUPTI_SUCCESSCUPTI_ER
Page 98 and 99:
CUPTI_ERROR_INVALID_OPERATION if an
Page 100 and 101:
CUPTI_METRIC_VALUE_KIND_PERCENT = 2
Page 102 and 103:
enum CUpti_MetricCategoryEach metri
Page 104 and 105:
metricArray Returns the IDs of the
Page 106 and 107:
CUPTI_ERROR_NOT_INITIALIZEDCUPTI_ER
Page 108 and 109:
CUPTI_ERROR_INVALID_PARAMETER if me
show all

CUPTI User's Guide

Create successful ePaper yourself

Delete template?

Save as template?