# CUPTI Profiler API

## Data Structures
struct | CUpti_Profiler_BeginPass_Params
| Params for cuptiProfilerBeginPass. More...
struct | CUpti_Profiler_BeginSession_Params
| Params for cuptiProfilerBeginSession. More...
struct | CUpti_Profiler_CounterDataImage_CalculateScratchBufferSize_Params
| Params for cuptiProfilerCounterDataImageCalculateScratchBufferSize. More...
struct | CUpti_Profiler_CounterDataImage_CalculateSize_Params
| Params for cuptiProfilerCounterDataImageCalculateSize. More...
struct | CUpti_Profiler_CounterDataImage_Initialize_Params
| Params for cuptiProfilerCounterDataImageInitialize. More...
struct | CUpti_Profiler_CounterDataImage_InitializeScratchBuffer_Params
| Params for cuptiProfilerCounterDataImageInitializeScratchBuffer. More...
struct | CUpti_Profiler_CounterDataImageOptions
| Input parameter to define the counterDataImage. More...
struct | CUpti_Profiler_DeInitialize_Params
| Default parameter for cuptiProfilerDeInitialize. More...
struct | CUpti_Profiler_DisableProfiling_Params
| Params for cuptiProfilerDisableProfiling. More...
struct | CUpti_Profiler_EnableProfiling_Params
| Params for cuptiProfilerEnableProfiling. More...
struct | CUpti_Profiler_EndPass_Params
| Params for cuptiProfilerEndPass. More...
struct | CUpti_Profiler_EndSession_Params
| Params for cuptiProfilerEndSession. More...
struct | CUpti_Profiler_FlushCounterData_Params
| Params for cuptiProfilerFlushCounterData. More...
struct | CUpti_Profiler_GetCounterAvailability_Params
| Params for cuptiProfilerGetCounterAvailability. More...
struct | CUpti_Profiler_Initialize_Params
| Default parameter for cuptiProfilerInitialize. More...
struct | CUpti_Profiler_IsPassCollected_Params
| Params for cuptiProfilerIsPassCollected. More...
struct | CUpti_Profiler_SetConfig_Params
| Params for cuptiProfilerSetConfig. More...
struct | CUpti_Profiler_UnsetConfig_Params
| Params for cuptiProfilerUnsetConfig. More...
## Enumerations
enum | CUpti_ProfilerRange { CUPTI_Range_INVALID, CUPTI_AutoRange, CUPTI_UserRange, CUPTI_Range_COUNT }
| Profiler range attribute. More...
enum | CUpti_ProfilerReplayMode { CUPTI_Replay_INVALID, CUPTI_ApplicationReplay, CUPTI_KernelReplay, CUPTI_UserReplay, CUPTI_Replay_COUNT }
| Profiler replay attribute. More...
## Functions
CUptiResult | cuptiProfilerBeginPass (CUpti_Profiler_BeginPass_Params *pParams)
| Replay API: used for multipass collection.
CUptiResult | cuptiProfilerBeginSession (CUpti_Profiler_BeginSession_Params *pParams)
| Begin profiling session sets up the profiling on the device.
CUptiResult | cuptiProfilerCounterDataImageCalculateScratchBufferSize (CUpti_Profiler_CounterDataImage_CalculateScratchBufferSize_Params *pParams)
| A temporary storage for CounterData image needed for internal operations.
CUptiResult | cuptiProfilerCounterDataImageCalculateSize (CUpti_Profiler_CounterDataImage_CalculateSize_Params *pParams)
| A CounterData image allocates space for values for each counter for each range.
CUptiResult | cuptiProfilerDeInitialize (CUpti_Profiler_DeInitialize_Params *pParams)
| DeInitializes the profiler interface.
CUptiResult | cuptiProfilerDisableProfiling (CUpti_Profiler_DisableProfiling_Params *pParams)
| Disable Profiling.
CUptiResult | cuptiProfilerEnableProfiling (CUpti_Profiler_EnableProfiling_Params *pParams)
| Enables Profiling.
CUptiResult | cuptiProfilerEndPass (CUpti_Profiler_EndPass_Params *pParams)
| Replay API: used for multipass collection.
CUptiResult | cuptiProfilerEndSession (CUpti_Profiler_EndSession_Params *pParams)
| Ends profiling session.
CUptiResult | cuptiProfilerFlushCounterData (CUpti_Profiler_FlushCounterData_Params *pParams)
| Decode all the submitted passes.
CUptiResult | cuptiProfilerGetCounterAvailability (CUpti_Profiler_GetCounterAvailability_Params *pParams)
| Query counter availibility.
CUptiResult | cuptiProfilerInitialize (CUpti_Profiler_Initialize_Params *pParams)
| Initializes the profiler interface.
CUptiResult | cuptiProfilerIsPassCollected (CUpti_Profiler_IsPassCollected_Params *pParams)
| Asynchronous call to query if the submitted pass to GPU is collected.
CUptiResult | cuptiProfilerPopRange (CUpti_Profiler_PopRange_Params *pParams)
| Range API's : Pop user range.
CUptiResult | cuptiProfilerPushRange (CUpti_Profiler_PushRange_Params *pParams)
| Range API's : Push user range.
CUptiResult | cuptiProfilerSetConfig (CUpti_Profiler_SetConfig_Params *pParams)
| Set metrics configuration to be profiled.
CUptiResult | cuptiProfilerUnsetConfig (CUpti_Profiler_UnsetConfig_Params *pParams)
| Unset metrics configuration profiled.

## Detailed Description

Functions, types, and enums that implement the CUPTI Profiler API.

## Enumeration Type Documentation

enum CUpti_ProfilerRange

A metric enabled in the session's configuration is collected separately per unique range-stack in the pass. This is an attribute to collect metrics around each kernel in a profiling session or in an user defined range.

Enumerator:

  CUPTI_Range_INVALID | Invalid value
  CUPTI_AutoRange | Ranges are auto defined around each kernel in a profiling session
  CUPTI_UserRange | A range in which metric data to be collected is defined by the user
  CUPTI_Range_COUNT | Range count

enum CUpti_ProfilerReplayMode

For metrics which require multipass collection, a replay of the GPU kernel(s) is required. This is an attribute which specify how the replay of the kernel(s) to be measured is done.

Enumerator:

  CUPTI_Replay_INVALID | Invalid Value
  CUPTI_ApplicationReplay | Replay is done by CUPTI user around the process
  CUPTI_KernelReplay | Replay is done around kernel implicitly by CUPTI
  CUPTI_UserReplay | Replay is done by CUPTI user within a process
  CUPTI_Replay_COUNT | Replay count

## Function Documentation

CUptiResult cuptiProfilerBeginPass | ( | CUpti_Profiler_BeginPass_Params * | pParams | ) |

These APIs are used if user chooses to replay by itself CUPTI_UserReplay or CUPTI_ApplicationReplay for multipass collection of the metrics configurations. It's a no-op in case of CUPTI_KernelReplay.

CUptiResult cuptiProfilerBeginSession | ( | CUpti_Profiler_BeginSession_Params * | pParams | ) |

Although, it doesn't start the profiling but GPU resources needed for profiling are allocated. Outside of a session, the GPU will return to its normal operating state.

CUptiResult cuptiProfilerCounterDataImageCalculateScratchBufferSize | ( | CUpti_Profiler_CounterDataImage_CalculateScratchBufferSize_Params * | pParams | ) |

Use these APIs to calculate the allocation size and initialize counterData image scratch buffer.

CUptiResult cuptiProfilerCounterDataImageCalculateSize | ( | CUpti_Profiler_CounterDataImage_CalculateSize_Params * | pParams | ) |

User borne the resposibility of managing the counterDataImage allocations. CounterDataPrefix contains meta data about the metrics that will be stored in counterDataImage. Use these APIs to calculate the allocation size and initialize counterData image.

CUptiResult cuptiProfilerDisableProfiling | ( | CUpti_Profiler_DisableProfiling_Params * | pParams | ) |

In CUPTI_AutoRange, these APIs are used to enable/disable profiling for the kernels to be executed in a profiling session.

CUptiResult cuptiProfilerEnableProfiling | ( | CUpti_Profiler_EnableProfiling_Params * | pParams | ) |

In CUPTI_AutoRange, these APIs are used to enable/disable profiling for the kernels to be executed in a profiling session.

CUptiResult cuptiProfilerEndPass | ( | CUpti_Profiler_EndPass_Params * | pParams | ) |

These APIs are used if user chooses to replay by itself CUPTI_UserReplay or CUPTI_ApplicationReplay for multipass collection of the metrics configurations. Its a no-op in case of CUPTI_KernelReplay. Returns information for next pass.

CUptiResult cuptiProfilerEndSession | ( | CUpti_Profiler_EndSession_Params * | pParams | ) |

Frees up the GPU resources acquired for profiling. Outside of a session, the GPU will return to it's normal operating state.

CUptiResult cuptiProfilerFlushCounterData | ( | CUpti_Profiler_FlushCounterData_Params * | pParams | ) |

Flush Counter data API to ensure every pass is decoded into the counterDataImage passed at beginSession. This will cause the CPU/GPU sync to collect all the undecoded pass.

CUptiResult cuptiProfilerGetCounterAvailability | ( | CUpti_Profiler_GetCounterAvailability_Params * | pParams | ) |

Use this API to query counter availability information in a buffer which can be used to filter unavailable raw metrics on host. Note: This API may fail, if any profiling or sampling session is active on the specified context or its device.

CUptiResult cuptiProfilerInitialize | ( | CUpti_Profiler_Initialize_Params * | pParams | ) |

Loads the required libraries in the process address space. Sets up the hooks with the CUDA driver.

CUptiResult cuptiProfilerPopRange | ( | CUpti_Profiler_PopRange_Params * | pParams | ) |

Counter data is collected per unique range-stack. Identified by a string label passsed by the user. It's an invalid operation in case of CUPTI_AutoRange.

CUptiResult cuptiProfilerPushRange | ( | CUpti_Profiler_PushRange_Params * | pParams | ) |

Counter data is collected per unique range-stack. Identified by a string label passsed by the user. It's an invalid operation in case of CUPTI_AutoRange.

CUptiResult cuptiProfilerSetConfig | ( | CUpti_Profiler_SetConfig_Params * | pParams | ) |

Use these APIs to set the config to profile in a session. It can be used for advanced cases such as where multiple configurations are collected into a single CounterData Image on the need basis, without restarting the session.