Skip to main content
`Ctrl`+`K`

# 6.5. CUPTI PC Sampling Utility API

Functions, types, and enums that implement the CUPTI PC Sampling Utility API.

## 6.5.1. Data Structures

CUPTI::PcSamplingUtil::BufferInfo

  BufferInfo will be stored in the file for every buffer i.e for every call of UtilDumpPcSamplingBufferInFile() API.

CUPTI::PcSamplingUtil::CUptiUtil_GetBufferInfoParams

  Params for CuptiUtilGetBufferInfo .

CUPTI::PcSamplingUtil::CUptiUtil_GetHeaderDataParams

  Params for CuptiUtilGetHeaderData .

CUPTI::PcSamplingUtil::CUptiUtil_GetPcSampDataParams

  Params for CuptiUtilGetPcSampData .

CUPTI::PcSamplingUtil::CUptiUtil_MergePcSampDataParams

  Params for CuptiUtilMergePcSampData .

CUPTI::PcSamplingUtil::CUptiUtil_PutPcSampDataParams

  Params for CuptiUtilPutPcSampData .

CUPTI::PcSamplingUtil::Header

  Header info will be stored in file.

CUPTI::PcSamplingUtil::PcSamplingStallReasons

  All available stall reasons name and respective indexes will be stored in it.

## 6.5.2. Macros

CUptiUtil_GetBufferInfoParamsSize

CUptiUtil_GetHeaderDataParamsSize

CUptiUtil_GetPcSampDataParamsSize

CUptiUtil_MergePcSampDataParamsSize

CUptiUtil_PutPcSampDataParamsSize

## 6.5.3. Enumerations

CUPTI::PcSamplingUtil::CUptiUtilResult

  CUPTI PC sampling utility API result codes.

CUPTI::PcSamplingUtil::PcSamplingBufferType

  CUPTI PC sampling buffer types.

## 6.5.4. Functions

CUptiUtilResult CUPTI::PcSamplingUtil::CuptiUtilCloseFile(CUptiUtil_FileHandle fileHandle)

  Close a file handle opened by CuptiUtilOpenFile .

CUptiUtilResult CUPTI::PcSamplingUtil::CuptiUtilGetBufferInfo(CUptiUtil_GetBufferInfoParams *pParams)

  Get buffer info data of file.

CUptiUtilResult CUPTI::PcSamplingUtil::CuptiUtilGetHeaderData(CUptiUtil_GetHeaderDataParams *pParams)

  Get header data of file.

CUptiUtilResult CUPTI::PcSamplingUtil::CuptiUtilGetPcSampData(CUptiUtil_GetPcSampDataParams *pParams)

  Retrieve PC sampling data from file into allocated buffer.

CUptiUtilResult CUPTI::PcSamplingUtil::CuptiUtilMergePcSampData(CUptiUtil_MergePcSampDataParams *pParams)

  Merge PC sampling data range id wise.

CUptiUtilResult CUPTI::PcSamplingUtil::CuptiUtilOpenFile(const char *fileName, CUptiUtil_FileHandle *pFileHandle)

  Open a file for reading PC sampling data.

CUptiUtilResult CUPTI::PcSamplingUtil::CuptiUtilPutPcSampData(CUptiUtil_PutPcSampDataParams *pParams)

  Dump PC sampling data into the file.

## 6.5.5. Typedefs

CUPTI::PcSamplingUtil::CUptiUtil_FileHandle

  Opaque file handle for PC sampling utility read APIs.

## 6.5.6. Macros

CUptiUtil_GetBufferInfoParamsSize

CUptiUtil_GetHeaderDataParamsSize

CUptiUtil_GetPcSampDataParamsSize

CUptiUtil_MergePcSampDataParamsSize

CUptiUtil_PutPcSampDataParamsSize