CUPTI SASS Metrics API
Detailed Description
Functions, types, and enums that implement the CUPTI SASS Metrics API.
Enumeration Type Documentation
- Enumerator:
-
CUPTI_SASS_METRICS_OUTPUT_GRANULARITY_GPU |
SASS metric data will be collected at GPU level. In CUpti_SassMetricsGetDataProperties_Params struct the numOfInstances will be equal to 1 |
CUPTI_SASS_METRICS_OUTPUT_GRANULARITY_SM |
SASS metric data will be collected at SM level In CUpti_SassMetricsGetDataProperties_Params struct the numOfInstances will be equal to number of SMs in the GPU |
CUPTI_SASS_METRICS_OUTPUT_GRANULARITY_SMSP |
SASS metric data will be collected at SM sub-partition level In CUpti_SassMetricsGetDataProperties_Params struct the numOfInstances will be equal to number of SM sub-partitions in the GPU |
Function Documentation
CUptiResult cuptiSassMetricsDisable |
( |
CUpti_SassMetricsDisable_Params * |
pParams |
) |
|
- Parameters:
-
| Refer | CUpti_SassMetricsDisable_Params |
- Return values:
-
| CUPTI_SUCCESS | |
| CUPTI_ERROR_INVALID_PARAMETER | if any pParams is not valid |
| CUPTI_ERROR_NOT_SUPPORTED | indicates that the system/device doesn't support SASS metric data collection |
| CUPTI_ERROR_INVALID_CONTEXT | if any cuda context has not been created prior to this API call |
| CUPTI_ERROR_INVALID_OPERATION | if this API is called multiple times for a cuda context without calling cuptiSassMetricsEnable() API or called before cuptiSassMetricsSetConfig() API call. |
CUptiResult cuptiSassMetricsEnable |
( |
CUpti_SassMetricsEnable_Params * |
pParams |
) |
|
- Parameters:
-
| Refer | CUpti_SassMetricsEnable_Params |
- Return values:
-
| CUPTI_SUCCESS | |
| CUPTI_ERROR_INVALID_PARAMETER | if any pParams is not valid |
| CUPTI_ERROR_NOT_SUPPORTED | indicates that the system/device doesn't support SASS metric data collection |
| CUPTI_ERROR_INVALID_CONTEXT | if any cuda context has not been created prior to this API call |
| CUPTI_ERROR_INVALID_OPERATION | if this API is called multiple times for a cuda context without calling cuptiSassMetricsDisable() API or called before cuptiSassMetricsSetConfig() API call. |
CUptiResult cuptiSassMetricsFlushData |
( |
CUpti_SassMetricsFlushData_Params * |
pParams |
) |
|
- Parameters:
-
| Refer | CUpti_SassMetricsFlushData_Params |
- Return values:
-
| CUPTI_SUCCESS | |
| CUPTI_ERROR_INVALID_PARAMETER | if any pParams is not valid |
| CUPTI_ERROR_NOT_SUPPORTED | indicates that the system/device doesn't support SASS metric data collection. |
| CUPTI_ERROR_INVALID_OPERATION | if this API is called outside the enable/disable range. |
CUptiResult cuptiSassMetricsGetDataProperties |
( |
CUpti_SassMetricsGetDataProperties_Params * |
pParams |
) |
|
- Parameters:
-
| Refer | CUpti_SassMetricsGetDataProperties_Params |
- Return values:
-
| CUPTI_SUCCESS | |
| CUPTI_ERROR_INVALID_PARAMETER | if any pParams is not valid |
| CUPTI_ERROR_NOT_SUPPORTED | indicates that the system/device doesn't support SASS metric data collection |
| CUPTI_ERROR_INVALID_OPERATION | if this API is called outside the enable/disable range. |
CUptiResult cuptiSassMetricsGetMetrics |
( |
CUpti_SassMetrics_GetMetrics_Params * |
pParams |
) |
|
- Parameters:
-
| Refer | CUpti_SassMetrics_GetMetrics_Params |
- Return values:
-
| CUPTI_SUCCESS | |
| CUPTI_ERROR_INVALID_PARAMETER | if any pParams is not valid |
| CUPTI_ERROR_NOT_SUPPORTED | indicates that the system/device doesn't support SASS metric collection |
CUptiResult cuptiSassMetricsGetNumOfMetrics |
( |
CUpti_SassMetrics_GetNumOfMetrics_Params * |
pParams |
) |
|
- Parameters:
-
| Refer | CUpti_SassMetrics_GetNumOfMetrics_Params |
- Return values:
-
| CUPTI_SUCCESS | |
| CUPTI_ERROR_INVALID_PARAMETER | if any pParams is not valid |
| CUPTI_ERROR_NOT_SUPPORTED | indicates that the system/device doesn't support SASS metric collection |
CUptiResult cuptiSassMetricsGetProperties |
( |
CUpti_SassMetrics_GetProperties_Params * |
pParams |
) |
|
- Parameters:
-
| Refer | CUpti_SassMetrics_GetProperties_Params |
- Return values:
-
| CUPTI_SUCCESS | |
| CUPTI_ERROR_INVALID_PARAMETER | if any pParams is not valid |
| CUPTI_ERROR_NOT_SUPPORTED | indicates that the system/device doesn't support SASS metric data collection |
CUptiResult cuptiSassMetricsSetConfig |
( |
CUpti_SassMetricsSetConfig_Params * |
pParams |
) |
|
- Parameters:
-
| Refer | CUpti_SassMetricsSetConfig_Params |
- Return values:
-
| CUPTI_SUCCESS | |
| CUPTI_ERROR_INVALID_PARAMETER | if any pParams is not valid |
| CUPTI_ERROR_INVALID_CONTEXT | if any cuda context has not been created prior to this API call |
| CUPTI_ERROR_INVALID_OPERATION | if this is called multiple times for the device without calling unset config API |
| CUPTI_ERROR_NOT_SUPPORTED | indicates that the system/device doesn't support SASS metric data collection |
CUptiResult cuptiSassMetricsUnsetConfig |
( |
CUpti_SassMetricsUnsetConfig_Params * |
pParams |
) |
|
- Parameters:
-
| Refer | CUpti_SassMetricsSetConfig_Params |
- Return values:
-
| CUPTI_SUCCESS | |
| CUPTI_ERROR_INVALID_PARAMETER | if any pParams is not valid |
| CUPTI_ERROR_INVALID_CONTEXT | if any cuda context has not been created prior to this API call |
| CUPTI_ERROR_INVALID_OPERATION | if this is called multiple times for the device without calling set config API |
| CUPTI_ERROR_NOT_SUPPORTED | indicates that the system/device doesn't support SASS metric data collection |