<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta>
<meta http-equiv="X-UA-Compatible" content="IE=edge"></meta>
<meta name="copyright" content="(C) Copyright 2005"></meta>
<meta name="DC.rights.owner" content="(C) Copyright 2005"></meta>
<meta name="DC.Type" content="cppModule"></meta>
<meta name="DC.Title" content="CUPTI Metric API"></meta>
<meta name="abstract" content=""></meta>
<meta name="description" content=""></meta>
<meta name="DC.Format" content="XHTML"></meta>
<meta name="DC.Identifier" content="group__CUPTI__METRIC__API"></meta>
<link rel="stylesheet" type="text/css" href="../common/formatting/commonltr.css"></link>
<link rel="stylesheet" type="text/css" href="../common/formatting/site.css"></link>
<title>CUPTI :: CUDA Toolkit Documentation</title>
<!--[if lt IE 9]>
<script src="../common/formatting/html5shiv-printshiv.min.js"></script>
<![endif]-->
<script type="text/javascript" charset="utf-8" src="../common/formatting/jquery.min.js"></script>
<script type="text/javascript" charset="utf-8" src="../common/formatting/jquery.ba-hashchange.min.js"></script>
<link rel="canonical" href="http://docs.nvidia.com/cuda/cupti/index.html"></link>
<link rel="stylesheet" type="text/css" href="../common/formatting/qwcode.highlight.css"></link>
</head>
<body>
<article id="contents">
<div id="breadcrumbs"><a href="group__CUPTI__EVENT__API.html" shape="rect">< Previous</a> | <a href="annotated.html" shape="rect">Next ></a></div>
<div id="release-info">CUPTI
(<a href="../../pdf/CUPTI_Library.pdf">PDF</a>)
-
CUDA Toolkit v5.5
(<a href="https://developer.nvidia.com/cuda-toolkit-archive">older</a>)
-
Last updated
July 19, 2013
-
<a href="mailto:cudatools@nvidia.com?subject=CUDA Tools Documentation Feedback: cupti">Send Feedback</a></div>
<div class="topic reference apiRef apiPackage cppModule" id="group__CUPTI__METRIC__API"><a name="group__CUPTI__METRIC__API" shape="rect">
<!-- --></a><h2 class="topictitle2 cppModule">2.6. CUPTI Metric API</h2>
<div class="section">
<p>Functions, types, and enums that implement the CUPTI Metric API. </p>
</div>
<h3 class="fake_sectiontitle member_header">Classes</h3>
<dl class="members">
<dt><span class="member_type">union </span><span class="member_name">
<div><a class="link" href="unionCUpti__MetricValue.html#unionCUpti__MetricValue" title="A metric value." shape="rect">CUpti_MetricValue</a></div></span></dt>
<dd class="shortdesc"><span></span><span class="desc">A metric value. </span><a href="unionCUpti__MetricValue.html#unionCUpti__MetricValue" class="link" title="A metric value." shape="rect"></a></dd>
</dl>
<h3 class="fake_sectiontitle member_header">Typedefs</h3>
<dl class="members">
<dt><span class="member_type">typedef uint32_t </span><span class="member_name"><a href="#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" shape="rect">CUpti_MetricID</a></span></dt>
<dd class="shortdesc"><span></span><span class="desc">ID for a metric. </span></dd>
</dl>
<h3 class="fake_sectiontitle member_header">Enumerations</h3>
<dl class="members">
<dt><span class="member_type">enum </span><span class="member_name"><a href="#group__CUPTI__METRIC__API_1g66397dfdbcf6ebf23d8cdf656c35fd52" shape="rect">CUpti_MetricAttribute</a></span></dt>
<dd class="shortdesc"><span></span><span class="desc">Metric attributes. </span></dd>
<dt><span class="member_type">enum </span><span class="member_name"><a href="#group__CUPTI__METRIC__API_1g6394f0e2d13535f97bfba7554ffd3f83" shape="rect">CUpti_MetricCategory</a></span></dt>
<dd class="shortdesc"><span></span><span class="desc">A metric category. </span></dd>
<dt><span class="member_type">enum </span><span class="member_name"><a href="#group__CUPTI__METRIC__API_1g59396bc237d98ee0595e5743bde89b9d" shape="rect">CUpti_MetricEvaluationMode</a></span></dt>
<dd class="shortdesc"><span></span><span class="desc">A metric evaluation mode. </span></dd>
<dt><span class="member_type">enum </span><span class="member_name"><a href="#group__CUPTI__METRIC__API_1g8205fe38839f3804696bc7e68640cd95" shape="rect">CUpti_MetricPropertyDeviceClass</a></span></dt>
<dd class="shortdesc"><span></span><span class="desc">Device class. </span></dd>
<dt><span class="member_type">enum </span><span class="member_name"><a href="#group__CUPTI__METRIC__API_1g5bafb626ac31ac98400d9191316871f7" shape="rect">CUpti_MetricPropertyID</a></span></dt>
<dd class="shortdesc"><span></span><span class="desc">Metric device properties. </span></dd>
<dt><span class="member_type">enum </span><span class="member_name"><a href="#group__CUPTI__METRIC__API_1g7ed011480e0cfd81d50cb0e508f6cc16" shape="rect">CUpti_MetricValueKind</a></span></dt>
<dd class="shortdesc"><span></span><span class="desc">Kinds of metric values. </span></dd>
<dt><span class="member_type">enum </span><span class="member_name"><a href="#group__CUPTI__METRIC__API_1g60cd86ce5f31121816ea1e3f965ac669" shape="rect">CUpti_MetricValueUtilizationLevel</a></span></dt>
<dd class="shortdesc"><span></span><span class="desc">Enumeration of utilization levels for metrics values of kind CUPTI_METRIC_VALUE_KIND_UTILIZATION_LEVEL. Utilization values
can vary from IDLE (0) to MAX (10) but the enumeration only provides specific names for a few values. </span></dd>
</dl>
<h3 class="fake_sectiontitle member_header">Functions</h3>
<dl class="members">
<dt><span class="member_type"><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> </span><span class="member_name"><a href="#group__CUPTI__METRIC__API_1gb9b4e76fc9a5a7b53e201838a82cb01b" shape="rect">cuptiDeviceEnumMetrics</a> ( CUdevice<span> </span><span class="keyword keyword apiItemName">device</span>, size_t*<span> </span><span class="keyword keyword apiItemName">arraySizeBytes</span>, <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a>*<span> </span><span class="keyword keyword apiItemName">metricArray</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Get the metrics for a device. </span></dd>
<dt><span class="member_type"><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> </span><span class="member_name"><a href="#group__CUPTI__METRIC__API_1g324da71188baec5939c57c1f24a8773b" shape="rect">cuptiDeviceGetNumMetrics</a> ( CUdevice<span> </span><span class="keyword keyword apiItemName">device</span>, uint32_t*<span> </span><span class="keyword keyword apiItemName">numMetrics</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Get the number of metrics for a device. </span></dd>
<dt><span class="member_type"><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> </span><span class="member_name"><a href="#group__CUPTI__METRIC__API_1g6edf9f093d3e05644821c0a1548ebe22" shape="rect">cuptiEnumMetrics</a> ( size_t*<span> </span><span class="keyword keyword apiItemName">arraySizeBytes</span>, <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a>*<span> </span><span class="keyword keyword apiItemName">metricArray</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Get all the metrics available on any device. </span></dd>
<dt><span class="member_type"><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> </span><span class="member_name"><a href="#group__CUPTI__METRIC__API_1ga977bb7bfa362130f2aeb7bcdba57fe8" shape="rect">cuptiGetNumMetrics</a> ( uint32_t*<span> </span><span class="keyword keyword apiItemName">numMetrics</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Get the total number of metrics available on any device. </span></dd>
<dt><span class="member_type"><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> </span><span class="member_name"><a href="#group__CUPTI__METRIC__API_1gffab8f5a74b98e7680710203e3932450" shape="rect">cuptiMetricCreateEventGroupSets</a> ( CUcontext<span> </span><span class="keyword keyword apiItemName">context</span>, size_t<span> </span><span class="keyword keyword apiItemName">metricIdArraySizeBytes</span>, <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a>*<span> </span><span class="keyword keyword apiItemName">metricIdArray</span>, <a href="structCUpti__EventGroupSets.html#structCUpti__EventGroupSets" title="A set of event group sets. " shape="rect">CUpti_EventGroupSets</a>**<span> </span><span class="keyword keyword apiItemName">eventGroupPasses</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">For a set of metrics, get the grouping that indicates the number of passes and the event groups necessary to collect the events
required for those metrics. </span></dd>
<dt><span class="member_type"><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> </span><span class="member_name"><a href="#group__CUPTI__METRIC__API_1g7b6aa1f0bb09627f89bbbeb0300bc67a" shape="rect">cuptiMetricEnumEvents</a> ( <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a><span> </span><span class="keyword keyword apiItemName">metric</span>, size_t*<span> </span><span class="keyword keyword apiItemName">eventIdArraySizeBytes</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g6ce7370be9ed31ce6f2d475de39045df" title="ID for an event. " shape="rect">CUpti_EventID</a>*<span> </span><span class="keyword keyword apiItemName">eventIdArray</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Get the events required to calculating a metric. </span></dd>
<dt><span class="member_type"><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> </span><span class="member_name"><a href="#group__CUPTI__METRIC__API_1g5bbb72ce28d7f2a6cd02607379c72bc9" shape="rect">cuptiMetricEnumProperties</a> ( <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a><span> </span><span class="keyword keyword apiItemName">metric</span>, size_t*<span> </span><span class="keyword keyword apiItemName">propIdArraySizeBytes</span>, <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g5bafb626ac31ac98400d9191316871f7" title="Metric device properties. " shape="rect">CUpti_MetricPropertyID</a>*<span> </span><span class="keyword keyword apiItemName">propIdArray</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Get the properties required to calculating a metric. </span></dd>
<dt><span class="member_type"><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> </span><span class="member_name"><a href="#group__CUPTI__METRIC__API_1gad77ae5441ca5c8cee0156b4ecc4d3f5" shape="rect">cuptiMetricGetAttribute</a> ( <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a><span> </span><span class="keyword keyword apiItemName">metric</span>, <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g66397dfdbcf6ebf23d8cdf656c35fd52" title="Metric attributes. " shape="rect">CUpti_MetricAttribute</a><span> </span><span class="keyword keyword apiItemName">attrib</span>, size_t*<span> </span><span class="keyword keyword apiItemName">valueSize</span>, void*<span> </span><span class="keyword keyword apiItemName">value</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Get a metric attribute. </span></dd>
<dt><span class="member_type"><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> </span><span class="member_name"><a href="#group__CUPTI__METRIC__API_1g8f6838118a1782e1aec6c3ffae1df81d" shape="rect">cuptiMetricGetIdFromName</a> ( CUdevice<span> </span><span class="keyword keyword apiItemName">device</span>, const char*<span> </span><span class="keyword keyword apiItemName">metricName</span>, <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a>*<span> </span><span class="keyword keyword apiItemName">metric</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Find an metric by name. </span></dd>
<dt><span class="member_type"><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> </span><span class="member_name"><a href="#group__CUPTI__METRIC__API_1g2e278d4e7e4237f863ed70facfa9c771" shape="rect">cuptiMetricGetNumEvents</a> ( <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a><span> </span><span class="keyword keyword apiItemName">metric</span>, uint32_t*<span> </span><span class="keyword keyword apiItemName">numEvents</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Get number of events required to calculate a metric. </span></dd>
<dt><span class="member_type"><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> </span><span class="member_name"><a href="#group__CUPTI__METRIC__API_1gbdf8e8a3c0e561e8d85604669682b4ed" shape="rect">cuptiMetricGetNumProperties</a> ( <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a><span> </span><span class="keyword keyword apiItemName">metric</span>, uint32_t*<span> </span><span class="keyword keyword apiItemName">numProp</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Get number of properties required to calculate a metric. </span></dd>
<dt><span class="member_type"><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> </span><span class="member_name"><a href="#group__CUPTI__METRIC__API_1gf42dcb1d349f91265e7809bbba2fc01e" shape="rect">cuptiMetricGetValue</a> ( CUdevice<span> </span><span class="keyword keyword apiItemName">device</span>, <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a><span> </span><span class="keyword keyword apiItemName">metric</span>, size_t<span> </span><span class="keyword keyword apiItemName">eventIdArraySizeBytes</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g6ce7370be9ed31ce6f2d475de39045df" title="ID for an event. " shape="rect">CUpti_EventID</a>*<span> </span><span class="keyword keyword apiItemName">eventIdArray</span>, size_t<span> </span><span class="keyword keyword apiItemName">eventValueArraySizeBytes</span>, uint64_t*<span> </span><span class="keyword keyword apiItemName">eventValueArray</span>, uint64_t<span> </span><span class="keyword keyword apiItemName">timeDuration</span>, <a href="unionCUpti__MetricValue.html#unionCUpti__MetricValue" title="A metric value. " shape="rect">CUpti_MetricValue</a>*<span> </span><span class="keyword keyword apiItemName">metricValue</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Calculate the value for a metric. </span></dd>
<dt><span class="member_type"><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> </span><span class="member_name"><a href="#group__CUPTI__METRIC__API_1gc3ec4701e9878845536282a14ed27245" shape="rect">cuptiMetricGetValue2</a> ( <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a><span> </span><span class="keyword keyword apiItemName">metric</span>, size_t<span> </span><span class="keyword keyword apiItemName">eventIdArraySizeBytes</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g6ce7370be9ed31ce6f2d475de39045df" title="ID for an event. " shape="rect">CUpti_EventID</a>*<span> </span><span class="keyword keyword apiItemName">eventIdArray</span>, size_t<span> </span><span class="keyword keyword apiItemName">eventValueArraySizeBytes</span>, uint64_t*<span> </span><span class="keyword keyword apiItemName">eventValueArray</span>, size_t<span> </span><span class="keyword keyword apiItemName">propIdArraySizeBytes</span>, <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g5bafb626ac31ac98400d9191316871f7" title="Metric device properties. " shape="rect">CUpti_MetricPropertyID</a>*<span> </span><span class="keyword keyword apiItemName">propIdArray</span>, size_t<span> </span><span class="keyword keyword apiItemName">propValueArraySizeBytes</span>, uint64_t*<span> </span><span class="keyword keyword apiItemName">propValueArray</span>, <a href="unionCUpti__MetricValue.html#unionCUpti__MetricValue" title="A metric value. " shape="rect">CUpti_MetricValue</a>*<span> </span><span class="keyword keyword apiItemName">metricValue</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Calculate the value for a metric. </span></dd>
</dl>
<div class="description">
<h3 class="sectiontitle">Typedefs</h3>
<dl class="description">
<dt class="description"><a name="group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" id="group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" shape="rect">
<!-- --></a><span>typedef uint32_t CUpti_MetricID</span></dt>
<dd class="description">
<div class="section">
<p>ID for a metric. A metric provides a measure of some aspect of the device. </p>
</div>
</dd>
</dl>
</div>
<div class="description">
<h3 class="sectiontitle">Enumerations</h3>
<dl class="description">
<dt class="description"><a name="group__CUPTI__METRIC__API_1g66397dfdbcf6ebf23d8cdf656c35fd52" id="group__CUPTI__METRIC__API_1g66397dfdbcf6ebf23d8cdf656c35fd52" shape="rect">
<!-- --></a><span>enum CUpti_MetricAttribute</span></dt>
<dd class="description">
<div class="section">
<p>Metric attributes describe properties of a metric. These attributes can be read using <a class="xref" href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1gad77ae5441ca5c8cee0156b4ecc4d3f5" title="Get a metric attribute." shape="rect">cuptiMetricGetAttribute</a>.
</p>
</div>
<div class="enum-members">
<h6 class="enumerator_header">
Values
</h6>
<dl class="enumerator">
<dt><span class="enum-member-name-def">CUPTI_METRIC_ATTR_NAME = <span class="ph ph apiData">0</span></span></dt>
<dd>Metric name. Value is a null terminated const c-string. </dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_ATTR_SHORT_DESCRIPTION = <span class="ph ph apiData">1</span></span></dt>
<dd>Short description of metric. Value is a null terminated const c-string. </dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_ATTR_LONG_DESCRIPTION = <span class="ph ph apiData">2</span></span></dt>
<dd>Long description of metric. Value is a null terminated const c-string. </dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_ATTR_CATEGORY = <span class="ph ph apiData">3</span></span></dt>
<dd>Category of the metric. Value is of type CUpti_MetricCategory. </dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_ATTR_VALUE_KIND = <span class="ph ph apiData">4</span></span></dt>
<dd>Value type of the metric. Value is of type CUpti_MetricValueKind. </dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_ATTR_EVALUATION_MODE = <span class="ph ph apiData">5</span></span></dt>
<dd>Metric evaluation mode. Value is of type CUpti_MetricEvaluationMode. </dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_ATTR_FORCE_INT = <span class="ph ph apiData">0x7fffffff</span></span></dt>
<dd></dd>
</dl>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__METRIC__API_1g6394f0e2d13535f97bfba7554ffd3f83" id="group__CUPTI__METRIC__API_1g6394f0e2d13535f97bfba7554ffd3f83" shape="rect">
<!-- --></a><span>enum CUpti_MetricCategory</span></dt>
<dd class="description">
<div class="section">
<p>Each metric is assigned to a category that represents the general type of the metric. A metric's category is accessed using
<a class="xref" href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1gad77ae5441ca5c8cee0156b4ecc4d3f5" title="Get a metric attribute." shape="rect">cuptiMetricGetAttribute</a> and the CUPTI_METRIC_ATTR_CATEGORY attribute.
</p>
</div>
<div class="enum-members">
<h6 class="enumerator_header">
Values
</h6>
<dl class="enumerator">
<dt><span class="enum-member-name-def">CUPTI_METRIC_CATEGORY_MEMORY = <span class="ph ph apiData">0</span></span></dt>
<dd>A memory related metric. </dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_CATEGORY_INSTRUCTION = <span class="ph ph apiData">1</span></span></dt>
<dd>An instruction related metric. </dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_CATEGORY_MULTIPROCESSOR = <span class="ph ph apiData">2</span></span></dt>
<dd>A multiprocessor related metric. </dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_CATEGORY_CACHE = <span class="ph ph apiData">3</span></span></dt>
<dd>A cache related metric. </dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_CATEGORY_TEXTURE = <span class="ph ph apiData">4</span></span></dt>
<dd>A texture related metric. </dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_CATEGORY_FORCE_INT = <span class="ph ph apiData">0x7fffffff</span></span></dt>
<dd></dd>
</dl>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__METRIC__API_1g59396bc237d98ee0595e5743bde89b9d" id="group__CUPTI__METRIC__API_1g59396bc237d98ee0595e5743bde89b9d" shape="rect">
<!-- --></a><span>enum CUpti_MetricEvaluationMode</span></dt>
<dd class="description">
<div class="section">
<p>A metric can be evaluated per hardware instance to know the load balancing across instances of a domain or the metric can
be evaluated in aggregate mode when the events involved in metric evaluation are from different event domains. It might be
possible to evaluate some metrics in both modes for convenience. A metric's evaluation mode is accessed using <a class="xref" href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g59396bc237d98ee0595e5743bde89b9d" title="A metric evaluation mode." shape="rect">CUpti_MetricEvaluationMode</a> and the CUPTI_METRIC_ATTR_EVALUATION_MODE attribute.
</p>
</div>
<div class="enum-members">
<h6 class="enumerator_header">
Values
</h6>
<dl class="enumerator">
<dt><span class="enum-member-name-def">CUPTI_METRIC_EVALUATION_MODE_PER_INSTANCE = <span class="ph ph apiData">1</span></span></dt>
<dd>If this bit is set, the metric can be profiled for each instance of the domain. The event values passed to <a class="xref" href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1gf42dcb1d349f91265e7809bbba2fc01e" title="Calculate the value for a metric." shape="rect">cuptiMetricGetValue</a> can contain values for one instance of the domain. And <a class="xref" href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1gf42dcb1d349f91265e7809bbba2fc01e" title="Calculate the value for a metric." shape="rect">cuptiMetricGetValue</a> can be called for each instance.
</dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_EVALUATION_MODE_AGGREGATE = <span class="ph ph apiData">1<<1</span></span></dt>
<dd>If this bit is set, the metric can be profiled over all instances. The event values passed to <a class="xref" href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1gf42dcb1d349f91265e7809bbba2fc01e" title="Calculate the value for a metric." shape="rect">cuptiMetricGetValue</a> can be aggregated values of events for all instances of the domain.
</dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_EVALUATION_MODE_FORCE_INT = <span class="ph ph apiData">0x7fffffff</span></span></dt>
<dd></dd>
</dl>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__METRIC__API_1g8205fe38839f3804696bc7e68640cd95" id="group__CUPTI__METRIC__API_1g8205fe38839f3804696bc7e68640cd95" shape="rect">
<!-- --></a><span>enum CUpti_MetricPropertyDeviceClass</span></dt>
<dd class="description">
<div class="section">
<p>Enumeration of device classes for metric property CUPTI_METRIC_PROPERTY_DEVICE_CLASS. </p>
</div>
<div class="enum-members">
<h6 class="enumerator_header">
Values
</h6>
<dl class="enumerator">
<dt><span class="enum-member-name-def">CUPTI_METRIC_PROPERTY_DEVICE_CLASS_TESLA = <span class="ph ph apiData">0</span></span></dt>
<dd></dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_PROPERTY_DEVICE_CLASS_QUADRO = <span class="ph ph apiData">1</span></span></dt>
<dd></dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_PROPERTY_DEVICE_CLASS_GEFORCE = <span class="ph ph apiData">2</span></span></dt>
<dd></dd>
</dl>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__METRIC__API_1g5bafb626ac31ac98400d9191316871f7" id="group__CUPTI__METRIC__API_1g5bafb626ac31ac98400d9191316871f7" shape="rect">
<!-- --></a><span>enum CUpti_MetricPropertyID</span></dt>
<dd class="description">
<div class="section">
<p>Metric device properties describe device properties which are needed for a metric. Some of these properties can be collected
using cuDeviceGetAttribute.
</p>
</div>
<div class="enum-members">
<h6 class="enumerator_header">
Values
</h6>
<dl class="enumerator">
<dt><span class="enum-member-name-def">CUPTI_METRIC_PROPERTY_MULTIPROCESSOR_COUNT</span></dt>
<dd></dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_PROPERTY_WARPS_PER_MULTIPROCESSOR</span></dt>
<dd></dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_PROPERTY_KERNEL_GPU_TIME</span></dt>
<dd></dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_PROPERTY_CLOCK_RATE</span></dt>
<dd></dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_PROPERTY_FRAME_BUFFER_COUNT</span></dt>
<dd></dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_PROPERTY_GLOBAL_MEMORY_BANDWIDTH</span></dt>
<dd></dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_PROPERTY_PCIE_LINK_RATE</span></dt>
<dd></dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_PROPERTY_PCIE_LINK_WIDTH</span></dt>
<dd></dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_PROPERTY_PCIE_GEN</span></dt>
<dd></dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_PROPERTY_DEVICE_CLASS</span></dt>
<dd></dd>
</dl>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__METRIC__API_1g7ed011480e0cfd81d50cb0e508f6cc16" id="group__CUPTI__METRIC__API_1g7ed011480e0cfd81d50cb0e508f6cc16" shape="rect">
<!-- --></a><span>enum CUpti_MetricValueKind</span></dt>
<dd class="description">
<div class="section">
<p>Metric values can be one of several different kinds. Corresponding to each kind is a member of the <a class="xref" href="unionCUpti__MetricValue.html#unionCUpti__MetricValue" title="A metric value." shape="rect">CUpti_MetricValue</a> union. The metric value returned by <a class="xref" href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1gf42dcb1d349f91265e7809bbba2fc01e" title="Calculate the value for a metric." shape="rect">cuptiMetricGetValue</a> should be accessed using the appropriate member of that union based on its value kind.
</p>
</div>
<div class="enum-members">
<h6 class="enumerator_header">
Values
</h6>
<dl class="enumerator">
<dt><span class="enum-member-name-def">CUPTI_METRIC_VALUE_KIND_DOUBLE = <span class="ph ph apiData">0</span></span></dt>
<dd>The metric value is a 64-bit double. </dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_VALUE_KIND_UINT64 = <span class="ph ph apiData">1</span></span></dt>
<dd>The metric value is a 64-bit unsigned integer. </dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_VALUE_KIND_PERCENT = <span class="ph ph apiData">2</span></span></dt>
<dd>The metric value is a percentage represented by a 64-bit double. For example, 57.5% is represented by the value 57.5. </dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_VALUE_KIND_THROUGHPUT = <span class="ph ph apiData">3</span></span></dt>
<dd>The metric value is a throughput represented by a 64-bit integer. The unit for throughput values is bytes/second. </dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_VALUE_KIND_INT64 = <span class="ph ph apiData">4</span></span></dt>
<dd>The metric value is a 64-bit signed integer. </dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_VALUE_KIND_UTILIZATION_LEVEL = <span class="ph ph apiData">5</span></span></dt>
<dd>The metric value is a utilization level, as represented by CUpti_MetricValueUtilizationLevel. </dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_VALUE_KIND_FORCE_INT = <span class="ph ph apiData">0x7fffffff</span></span></dt>
<dd></dd>
</dl>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__METRIC__API_1g60cd86ce5f31121816ea1e3f965ac669" id="group__CUPTI__METRIC__API_1g60cd86ce5f31121816ea1e3f965ac669" shape="rect">
<!-- --></a><span>enum CUpti_MetricValueUtilizationLevel</span></dt>
<dd class="description">
<div class="section">
<p></p>
</div>
<div class="enum-members">
<h6 class="enumerator_header">
Values
</h6>
<dl class="enumerator">
<dt><span class="enum-member-name-def">CUPTI_METRIC_VALUE_UTILIZATION_IDLE = <span class="ph ph apiData">0</span></span></dt>
<dd></dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_VALUE_UTILIZATION_LOW = <span class="ph ph apiData">2</span></span></dt>
<dd></dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_VALUE_UTILIZATION_MID = <span class="ph ph apiData">5</span></span></dt>
<dd></dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_VALUE_UTILIZATION_HIGH = <span class="ph ph apiData">8</span></span></dt>
<dd></dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_VALUE_UTILIZATION_MAX = <span class="ph ph apiData">10</span></span></dt>
<dd></dd>
<dt><span class="enum-member-name-def">CUPTI_METRIC_VALUE_UTILIZATION_FORCE_INT = <span class="ph ph apiData">0x7fffffff</span></span></dt>
<dd></dd>
</dl>
</div>
</dd>
</dl>
</div>
<div class="description">
<h3 class="sectiontitle">Functions</h3>
<dl class="description">
<dt class="description"><a name="group__CUPTI__METRIC__API_1gb9b4e76fc9a5a7b53e201838a82cb01b" id="group__CUPTI__METRIC__API_1gb9b4e76fc9a5a7b53e201838a82cb01b" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiDeviceEnumMetrics ( CUdevice<span> </span><span class="keyword keyword apiItemName">device</span>, size_t*<span> </span><span class="keyword keyword apiItemName">arraySizeBytes</span>, <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a>*<span> </span><span class="keyword keyword apiItemName">metricArray</span> ) </span></dt>
<dd class="description">
<div class="section">Get the metrics for a device. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">device</span></tt></dt>
<dd>The CUDA device </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">arraySizeBytes</span></tt></dt>
<dd>The size of <tt class="ph tt code">metricArray</tt> in bytes, and returns the number of bytes written to <tt class="ph tt code">metricArray</tt></dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">metricArray</span></tt></dt>
<dd>Returns the IDs of the metrics for the device</dd>
</dl>
</div>
<div class="section">
<h6 class="return_header">Returns</h6>
<p class="return">
<ul>
<li>CUPTI_SUCCESS
<p class="p"></p>
</li>
<li>CUPTI_ERROR_NOT_INITIALIZED
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_DEVICE
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">arraySizeBytes</tt> or <tt class="ph tt code">metricArray</tt> are NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Returns the metric IDs in <tt class="ph tt code">metricArray</tt> for a device. The size of the <tt class="ph tt code">metricArray</tt> buffer is given by <tt class="ph tt code">*arraySizeBytes</tt>. The size of the <tt class="ph tt code">metricArray</tt> buffer must be at least <tt class="ph tt code">numMetrics</tt> * sizeof(CUpti_MetricID) or else all metric IDs will not be returned. The value returned in <tt class="ph tt code">*arraySizeBytes</tt> contains the number of bytes returned in <tt class="ph tt code">metricArray</tt>.
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__METRIC__API_1g324da71188baec5939c57c1f24a8773b" id="group__CUPTI__METRIC__API_1g324da71188baec5939c57c1f24a8773b" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiDeviceGetNumMetrics ( CUdevice<span> </span><span class="keyword keyword apiItemName">device</span>, uint32_t*<span> </span><span class="keyword keyword apiItemName">numMetrics</span> ) </span></dt>
<dd class="description">
<div class="section">Get the number of metrics for a device. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">device</span></tt></dt>
<dd>The CUDA device </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">numMetrics</span></tt></dt>
<dd>Returns the number of metrics available for the device</dd>
</dl>
</div>
<div class="section">
<h6 class="return_header">Returns</h6>
<p class="return">
<ul>
<li>CUPTI_SUCCESS
<p class="p"></p>
</li>
<li>CUPTI_ERROR_NOT_INITIALIZED
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_DEVICE
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">numMetrics</tt> is NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Returns the number of metrics available for a device.</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__METRIC__API_1g6edf9f093d3e05644821c0a1548ebe22" id="group__CUPTI__METRIC__API_1g6edf9f093d3e05644821c0a1548ebe22" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEnumMetrics ( size_t*<span> </span><span class="keyword keyword apiItemName">arraySizeBytes</span>, <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a>*<span> </span><span class="keyword keyword apiItemName">metricArray</span> ) </span></dt>
<dd class="description">
<div class="section">Get all the metrics available on any device. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">arraySizeBytes</span></tt></dt>
<dd>The size of <tt class="ph tt code">metricArray</tt> in bytes, and returns the number of bytes written to <tt class="ph tt code">metricArray</tt></dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">metricArray</span></tt></dt>
<dd>Returns the IDs of the metrics</dd>
</dl>
</div>
<div class="section">
<h6 class="return_header">Returns</h6>
<p class="return">
<ul>
<li>CUPTI_SUCCESS
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">arraySizeBytes</tt> or <tt class="ph tt code">metricArray</tt> are NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Returns the metric IDs in <tt class="ph tt code">metricArray</tt> for all CUDA-capable devices. The size of the <tt class="ph tt code">metricArray</tt> buffer is given by <tt class="ph tt code">*arraySizeBytes</tt>. The size of the <tt class="ph tt code">metricArray</tt> buffer must be at least <tt class="ph tt code">numMetrics</tt> * sizeof(CUpti_MetricID) or all metric IDs will not be returned. The value returned in <tt class="ph tt code">*arraySizeBytes</tt> contains the number of bytes returned in <tt class="ph tt code">metricArray</tt>.
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__METRIC__API_1ga977bb7bfa362130f2aeb7bcdba57fe8" id="group__CUPTI__METRIC__API_1ga977bb7bfa362130f2aeb7bcdba57fe8" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiGetNumMetrics ( uint32_t*<span> </span><span class="keyword keyword apiItemName">numMetrics</span> ) </span></dt>
<dd class="description">
<div class="section">Get the total number of metrics available on any device. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">numMetrics</span></tt></dt>
<dd>Returns the number of metrics</dd>
</dl>
</div>
<div class="section">
<h6 class="return_header">Returns</h6>
<p class="return">
<ul>
<li>CUPTI_SUCCESS
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">numMetrics</tt> is NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Returns the total number of metrics available on any CUDA-capable devices.</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__METRIC__API_1gffab8f5a74b98e7680710203e3932450" id="group__CUPTI__METRIC__API_1gffab8f5a74b98e7680710203e3932450" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiMetricCreateEventGroupSets ( CUcontext<span> </span><span class="keyword keyword apiItemName">context</span>, size_t<span> </span><span class="keyword keyword apiItemName">metricIdArraySizeBytes</span>, <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a>*<span> </span><span class="keyword keyword apiItemName">metricIdArray</span>, <a href="structCUpti__EventGroupSets.html#structCUpti__EventGroupSets" title="A set of event group sets. " shape="rect">CUpti_EventGroupSets</a>**<span> </span><span class="keyword keyword apiItemName">eventGroupPasses</span> ) </span></dt>
<dd class="description">
<div class="section">For a set of metrics, get the grouping that indicates the number of passes and the event groups necessary to collect the events
required for those metrics.
</div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">context</span></tt></dt>
<dd>The context for event collection </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">metricIdArraySizeBytes</span></tt></dt>
<dd>Size of the metricIdArray in bytes </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">metricIdArray</span></tt></dt>
<dd>Array of metric IDs </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">eventGroupPasses</span></tt></dt>
<dd>Returns a <a class="xref" href="structCUpti__EventGroupSets.html#structCUpti__EventGroupSets" title="A set of event group sets." shape="rect">CUpti_EventGroupSets</a> object that indicates the number of passes required to collect the events and the events to collect on each pass
</dd>
</dl>
</div>
<div class="section">
<h6 class="return_header">Returns</h6>
<p class="return">
<ul>
<li>CUPTI_SUCCESS
<p class="p"></p>
</li>
<li>CUPTI_ERROR_NOT_INITIALIZED
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_CONTEXT
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_METRIC_ID
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">metricIdArray</tt> or <tt class="ph tt code">eventGroupPasses</tt> is NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>For a set of metrics, get the grouping that indicates the number of passes and the event groups necessary to collect the events
required for those metrics.
</p>
<p class="p apiDesc_subtitle"><strong class="ph b">See also:</strong></p>
<p class="p see_subsection"><a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g0fd307d429d4e37f61f45472de069910" title="For a set of events, get the grouping that indicates the number of passes and the event groups necessary to collect the events." shape="rect">cuptiEventGroupSetsCreate</a> for details on event group set creation.
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__METRIC__API_1g7b6aa1f0bb09627f89bbbeb0300bc67a" id="group__CUPTI__METRIC__API_1g7b6aa1f0bb09627f89bbbeb0300bc67a" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiMetricEnumEvents ( <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a><span> </span><span class="keyword keyword apiItemName">metric</span>, size_t*<span> </span><span class="keyword keyword apiItemName">eventIdArraySizeBytes</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g6ce7370be9ed31ce6f2d475de39045df" title="ID for an event. " shape="rect">CUpti_EventID</a>*<span> </span><span class="keyword keyword apiItemName">eventIdArray</span> ) </span></dt>
<dd class="description">
<div class="section">Get the events required to calculating a metric. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">metric</span></tt></dt>
<dd>ID of the metric </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">eventIdArraySizeBytes</span></tt></dt>
<dd>The size of <tt class="ph tt code">eventIdArray</tt> in bytes, and returns the number of bytes written to <tt class="ph tt code">eventIdArray</tt></dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">eventIdArray</span></tt></dt>
<dd>Returns the IDs of the events required to calculate <tt class="ph tt code">metric</tt></dd>
</dl>
</div>
<div class="section">
<h6 class="return_header">Returns</h6>
<p class="return">
<ul>
<li>CUPTI_SUCCESS
<p class="p"></p>
</li>
<li>CUPTI_ERROR_NOT_INITIALIZED
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_METRIC_ID
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">eventIdArraySizeBytes</tt> or <tt class="ph tt code">eventIdArray</tt> are NULL.
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Gets the event IDs in <tt class="ph tt code">eventIdArray</tt> required to calculate a <tt class="ph tt code">metric</tt>. The size of the <tt class="ph tt code">eventIdArray</tt> buffer is given by <tt class="ph tt code">*eventIdArraySizeBytes</tt> and must be at least <tt class="ph tt code">numEvents</tt> * sizeof(CUpti_EventID) or all events will not be returned. The value returned in <tt class="ph tt code">*eventIdArraySizeBytes</tt> contains the number of bytes returned in <tt class="ph tt code">eventIdArray</tt>.
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__METRIC__API_1g5bbb72ce28d7f2a6cd02607379c72bc9" id="group__CUPTI__METRIC__API_1g5bbb72ce28d7f2a6cd02607379c72bc9" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiMetricEnumProperties ( <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a><span> </span><span class="keyword keyword apiItemName">metric</span>, size_t*<span> </span><span class="keyword keyword apiItemName">propIdArraySizeBytes</span>, <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g5bafb626ac31ac98400d9191316871f7" title="Metric device properties. " shape="rect">CUpti_MetricPropertyID</a>*<span> </span><span class="keyword keyword apiItemName">propIdArray</span> ) </span></dt>
<dd class="description">
<div class="section">Get the properties required to calculating a metric. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">metric</span></tt></dt>
<dd>ID of the metric </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">propIdArraySizeBytes</span></tt></dt>
<dd>The size of <tt class="ph tt code">propIdArray</tt> in bytes, and returns the number of bytes written to <tt class="ph tt code">propIdArray</tt></dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">propIdArray</span></tt></dt>
<dd>Returns the IDs of the properties required to calculate <tt class="ph tt code">metric</tt></dd>
</dl>
</div>
<div class="section">
<h6 class="return_header">Returns</h6>
<p class="return">
<ul>
<li>CUPTI_SUCCESS
<p class="p"></p>
</li>
<li>CUPTI_ERROR_NOT_INITIALIZED
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_METRIC_ID
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">propIdArraySizeBytes</tt> or <tt class="ph tt code">propIdArray</tt> are NULL.
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Gets the property IDs in <tt class="ph tt code">propIdArray</tt> required to calculate a <tt class="ph tt code">metric</tt>. The size of the <tt class="ph tt code">propIdArray</tt> buffer is given by <tt class="ph tt code">*propIdArraySizeBytes</tt> and must be at least <tt class="ph tt code">numProp</tt> * sizeof(CUpti_DeviceAttribute) or all properties will not be returned. The value returned in <tt class="ph tt code">*propIdArraySizeBytes</tt> contains the number of bytes returned in <tt class="ph tt code">propIdArray</tt>.
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__METRIC__API_1gad77ae5441ca5c8cee0156b4ecc4d3f5" id="group__CUPTI__METRIC__API_1gad77ae5441ca5c8cee0156b4ecc4d3f5" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiMetricGetAttribute ( <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a><span> </span><span class="keyword keyword apiItemName">metric</span>, <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g66397dfdbcf6ebf23d8cdf656c35fd52" title="Metric attributes. " shape="rect">CUpti_MetricAttribute</a><span> </span><span class="keyword keyword apiItemName">attrib</span>, size_t*<span> </span><span class="keyword keyword apiItemName">valueSize</span>, void*<span> </span><span class="keyword keyword apiItemName">value</span> ) </span></dt>
<dd class="description">
<div class="section">Get a metric attribute. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">metric</span></tt></dt>
<dd>ID of the metric </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">attrib</span></tt></dt>
<dd>The metric attribute to read </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">valueSize</span></tt></dt>
<dd>The size of the <tt class="ph tt code">value</tt> buffer in bytes, and returns the number of bytes written to <tt class="ph tt code">value</tt></dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">value</span></tt></dt>
<dd>Returns the attribute's value</dd>
</dl>
</div>
<div class="section">
<h6 class="return_header">Returns</h6>
<p class="return">
<ul>
<li>CUPTI_SUCCESS
<p class="p"></p>
</li>
<li>CUPTI_ERROR_NOT_INITIALIZED
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_METRIC_ID
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">valueSize</tt> or <tt class="ph tt code">value</tt> is NULL, or if <tt class="ph tt code">attrib</tt> is not a metric attribute
</p>
</li>
<li>CUPTI_ERROR_PARAMETER_SIZE_NOT_SUFFICIENT
<p class="p">For non-c-string attribute values, indicates that the <tt class="ph tt code">value</tt> buffer is too small to hold the attribute value.
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Returns a metric attribute in <tt class="ph tt code">*value</tt>. The size of the <tt class="ph tt code">value</tt> buffer is given by <tt class="ph tt code">*valueSize</tt>. The value returned in <tt class="ph tt code">*valueSize</tt> contains the number of bytes returned in <tt class="ph tt code">value</tt>.
</p>
<p class="p">If the attribute value is a c-string that is longer than <tt class="ph tt code">*valueSize</tt>, then only the first <tt class="ph tt code">*valueSize</tt> characters will be returned and there will be no terminating null byte.
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__METRIC__API_1g8f6838118a1782e1aec6c3ffae1df81d" id="group__CUPTI__METRIC__API_1g8f6838118a1782e1aec6c3ffae1df81d" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiMetricGetIdFromName ( CUdevice<span> </span><span class="keyword keyword apiItemName">device</span>, const char*<span> </span><span class="keyword keyword apiItemName">metricName</span>, <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a>*<span> </span><span class="keyword keyword apiItemName">metric</span> ) </span></dt>
<dd class="description">
<div class="section">Find an metric by name. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">device</span></tt></dt>
<dd>The CUDA device </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">metricName</span></tt></dt>
<dd>The name of metric to find </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">metric</span></tt></dt>
<dd>Returns the ID of the found metric or undefined if unable to find the metric</dd>
</dl>
</div>
<div class="section">
<h6 class="return_header">Returns</h6>
<p class="return">
<ul>
<li>CUPTI_SUCCESS
<p class="p"></p>
</li>
<li>CUPTI_ERROR_NOT_INITIALIZED
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_DEVICE
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_METRIC_NAME
<p class="p">if unable to find a metric with name <tt class="ph tt code">metricName</tt>. In this case <tt class="ph tt code">*metric</tt> is undefined
</p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">metricName</tt> or <tt class="ph tt code">metric</tt> are NULL.
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Find a metric by name and return the metric ID in <tt class="ph tt code">*metric</tt>.
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__METRIC__API_1g2e278d4e7e4237f863ed70facfa9c771" id="group__CUPTI__METRIC__API_1g2e278d4e7e4237f863ed70facfa9c771" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiMetricGetNumEvents ( <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a><span> </span><span class="keyword keyword apiItemName">metric</span>, uint32_t*<span> </span><span class="keyword keyword apiItemName">numEvents</span> ) </span></dt>
<dd class="description">
<div class="section">Get number of events required to calculate a metric. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">metric</span></tt></dt>
<dd>ID of the metric </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">numEvents</span></tt></dt>
<dd>Returns the number of events required for the metric</dd>
</dl>
</div>
<div class="section">
<h6 class="return_header">Returns</h6>
<p class="return">
<ul>
<li>CUPTI_SUCCESS
<p class="p"></p>
</li>
<li>CUPTI_ERROR_NOT_INITIALIZED
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_METRIC_ID
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">numEvents</tt> is NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Returns the number of events in <tt class="ph tt code">numEvents</tt> that are required to calculate a metric.
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__METRIC__API_1gbdf8e8a3c0e561e8d85604669682b4ed" id="group__CUPTI__METRIC__API_1gbdf8e8a3c0e561e8d85604669682b4ed" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiMetricGetNumProperties ( <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a><span> </span><span class="keyword keyword apiItemName">metric</span>, uint32_t*<span> </span><span class="keyword keyword apiItemName">numProp</span> ) </span></dt>
<dd class="description">
<div class="section">Get number of properties required to calculate a metric. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">metric</span></tt></dt>
<dd>ID of the metric </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">numProp</span></tt></dt>
<dd>Returns the number of properties required for the metric</dd>
</dl>
</div>
<div class="section">
<h6 class="return_header">Returns</h6>
<p class="return">
<ul>
<li>CUPTI_SUCCESS
<p class="p"></p>
</li>
<li>CUPTI_ERROR_NOT_INITIALIZED
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_METRIC_ID
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">numProp</tt> is NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Returns the number of properties in <tt class="ph tt code">numProp</tt> that are required to calculate a metric.
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__METRIC__API_1gf42dcb1d349f91265e7809bbba2fc01e" id="group__CUPTI__METRIC__API_1gf42dcb1d349f91265e7809bbba2fc01e" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiMetricGetValue ( CUdevice<span> </span><span class="keyword keyword apiItemName">device</span>, <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a><span> </span><span class="keyword keyword apiItemName">metric</span>, size_t<span> </span><span class="keyword keyword apiItemName">eventIdArraySizeBytes</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g6ce7370be9ed31ce6f2d475de39045df" title="ID for an event. " shape="rect">CUpti_EventID</a>*<span> </span><span class="keyword keyword apiItemName">eventIdArray</span>, size_t<span> </span><span class="keyword keyword apiItemName">eventValueArraySizeBytes</span>, uint64_t*<span> </span><span class="keyword keyword apiItemName">eventValueArray</span>, uint64_t<span> </span><span class="keyword keyword apiItemName">timeDuration</span>, <a href="unionCUpti__MetricValue.html#unionCUpti__MetricValue" title="A metric value. " shape="rect">CUpti_MetricValue</a>*<span> </span><span class="keyword keyword apiItemName">metricValue</span> ) </span></dt>
<dd class="description">
<div class="section">Calculate the value for a metric. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">device</span></tt></dt>
<dd>The CUDA device that the metric is being calculated for </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">metric</span></tt></dt>
<dd>The metric ID </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">eventIdArraySizeBytes</span></tt></dt>
<dd>The size of <tt class="ph tt code">eventIdArray</tt> in bytes
</dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">eventIdArray</span></tt></dt>
<dd>The event IDs required to calculate <tt class="ph tt code">metric</tt></dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">eventValueArraySizeBytes</span></tt></dt>
<dd>The size of <tt class="ph tt code">eventValueArray</tt> in bytes
</dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">eventValueArray</span></tt></dt>
<dd>The normalized event values required to calculate <tt class="ph tt code">metric</tt>. The values must be order to match the order of events in <tt class="ph tt code">eventIdArray</tt></dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">timeDuration</span></tt></dt>
<dd>The duration over which the events were collected, in ns </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">metricValue</span></tt></dt>
<dd>Returns the value for the metric</dd>
</dl>
</div>
<div class="section">
<h6 class="return_header">Returns</h6>
<p class="return">
<ul>
<li>CUPTI_SUCCESS
<p class="p"></p>
</li>
<li>CUPTI_ERROR_NOT_INITIALIZED
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_METRIC_ID
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_OPERATION
<p class="p"></p>
</li>
<li>CUPTI_ERROR_PARAMETER_SIZE_NOT_SUFFICIENT
<p class="p">if the eventIdArray does not contain all the events needed for metric </p>
</li>
<li>CUPTI_ERROR_INVALID_EVENT_VALUE
<p class="p">if any of the event values required for the metric is CUPTI_EVENT_OVERFLOW </p>
</li>
<li>CUPTI_ERROR_INVALID_METRIC_VALUE
<p class="p">if the computed metric value cannot be represented in the metric's value type. For example, if the metric value type is unsigned
and the computed metric value is negative
</p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">metricValue</tt>, <tt class="ph tt code">eventIdArray</tt> or <tt class="ph tt code">eventValueArray</tt> is NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Use the events collected for a metric to calculate the metric value. Metric value evaluation depends on the evaluation mode
<a class="xref" href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g59396bc237d98ee0595e5743bde89b9d" title="A metric evaluation mode." shape="rect">CUpti_MetricEvaluationMode</a> that the metric supports. If a metric has evaluation mode as CUPTI_METRIC_EVALUATION_MODE_PER_INSTANCE, then it assumes that
the input event value is for one domain instance. If a metric has evaluation mode as CUPTI_METRIC_EVALUATION_MODE_AGGREGATE,
it assumes that input event values are normalized to represent all domain instances on a device. For the most accurate metric
collection, the events required for the metric should be collected for all profiled domain instances. For example, to collect
all instances of an event, set the CUPTI_EVENT_GROUP_ATTR_PROFILE_ALL_DOMAIN_INSTANCES attribute on the group containing the
event to 1. The normalized value for the event is then: (<tt class="ph tt code">sum_event_values</tt> * <tt class="ph tt code">totalInstanceCount</tt>) / <tt class="ph tt code">instanceCount</tt>, where <tt class="ph tt code">sum_event_values</tt> is the summation of the event values across all profiled domain instances, <tt class="ph tt code">totalInstanceCount</tt> is obtained from querying CUPTI_EVENT_DOMAIN_ATTR_TOTAL_INSTANCE_COUNT and <tt class="ph tt code">instanceCount</tt> is obtained from querying CUPTI_EVENT_GROUP_ATTR_INSTANCE_COUNT (or CUPTI_EVENT_DOMAIN_ATTR_INSTANCE_COUNT).
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__METRIC__API_1gc3ec4701e9878845536282a14ed27245" id="group__CUPTI__METRIC__API_1gc3ec4701e9878845536282a14ed27245" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiMetricGetValue2 ( <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g0d2977d7b73cd78f216d5526998a92d4" title="ID for a metric. " shape="rect">CUpti_MetricID</a><span> </span><span class="keyword keyword apiItemName">metric</span>, size_t<span> </span><span class="keyword keyword apiItemName">eventIdArraySizeBytes</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g6ce7370be9ed31ce6f2d475de39045df" title="ID for an event. " shape="rect">CUpti_EventID</a>*<span> </span><span class="keyword keyword apiItemName">eventIdArray</span>, size_t<span> </span><span class="keyword keyword apiItemName">eventValueArraySizeBytes</span>, uint64_t*<span> </span><span class="keyword keyword apiItemName">eventValueArray</span>, size_t<span> </span><span class="keyword keyword apiItemName">propIdArraySizeBytes</span>, <a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g5bafb626ac31ac98400d9191316871f7" title="Metric device properties. " shape="rect">CUpti_MetricPropertyID</a>*<span> </span><span class="keyword keyword apiItemName">propIdArray</span>, size_t<span> </span><span class="keyword keyword apiItemName">propValueArraySizeBytes</span>, uint64_t*<span> </span><span class="keyword keyword apiItemName">propValueArray</span>, <a href="unionCUpti__MetricValue.html#unionCUpti__MetricValue" title="A metric value. " shape="rect">CUpti_MetricValue</a>*<span> </span><span class="keyword keyword apiItemName">metricValue</span> ) </span></dt>
<dd class="description">
<div class="section">Calculate the value for a metric. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">metric</span></tt></dt>
<dd>The metric ID </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">eventIdArraySizeBytes</span></tt></dt>
<dd>The size of <tt class="ph tt code">eventIdArray</tt> in bytes
</dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">eventIdArray</span></tt></dt>
<dd>The event IDs required to calculate <tt class="ph tt code">metric</tt></dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">eventValueArraySizeBytes</span></tt></dt>
<dd>The size of <tt class="ph tt code">eventValueArray</tt> in bytes
</dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">eventValueArray</span></tt></dt>
<dd>The normalized event values required to calculate <tt class="ph tt code">metric</tt>. The values must be order to match the order of events in <tt class="ph tt code">eventIdArray</tt></dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">propIdArraySizeBytes</span></tt></dt>
<dd>The size of <tt class="ph tt code">propIdArray</tt> in bytes
</dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">propIdArray</span></tt></dt>
<dd>The metric property IDs required to calculate <tt class="ph tt code">metric</tt></dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">propValueArraySizeBytes</span></tt></dt>
<dd>The size of <tt class="ph tt code">propValueArray</tt> in bytes
</dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">propValueArray</span></tt></dt>
<dd>The metric property values required to calculate <tt class="ph tt code">metric</tt>. The values must be order to match the order of metric properties in <tt class="ph tt code">propIdArray</tt></dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">metricValue</span></tt></dt>
<dd>Returns the value for the metric</dd>
</dl>
</div>
<div class="section">
<h6 class="return_header">Returns</h6>
<p class="return">
<ul>
<li>CUPTI_SUCCESS
<p class="p"></p>
</li>
<li>CUPTI_ERROR_NOT_INITIALIZED
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_METRIC_ID
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_OPERATION
<p class="p"></p>
</li>
<li>CUPTI_ERROR_PARAMETER_SIZE_NOT_SUFFICIENT
<p class="p">if the eventIdArray does not contain all the events needed for metric </p>
</li>
<li>CUPTI_ERROR_INVALID_EVENT_VALUE
<p class="p">if any of the event values required for the metric is CUPTI_EVENT_OVERFLOW </p>
</li>
<li>CUPTI_ERROR_NOT_COMPATIBLE
<p class="p">if the computed metric value cannot be represented in the metric's value type. For example, if the metric value type is unsigned
and the computed metric value is negative
</p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">metricValue</tt>, <tt class="ph tt code">eventIdArray</tt> or <tt class="ph tt code">eventValueArray</tt> is NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Use the events and properties collected for a metric to calculate the metric value. Metric value evaluation depends on the
evaluation mode <a class="xref" href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API_1g59396bc237d98ee0595e5743bde89b9d" title="A metric evaluation mode." shape="rect">CUpti_MetricEvaluationMode</a> that the metric supports. If a metric has evaluation mode as CUPTI_METRIC_EVALUATION_MODE_PER_INSTANCE, then it assumes that
the input event value is for one domain instance. If a metric has evaluation mode as CUPTI_METRIC_EVALUATION_MODE_AGGREGATE,
it assumes that input event values are normalized to represent all domain instances on a device. For the most accurate metric
collection, the events required for the metric should be collected for all profiled domain instances. For example, to collect
all instances of an event, set the CUPTI_EVENT_GROUP_ATTR_PROFILE_ALL_DOMAIN_INSTANCES attribute on the group containing the
event to 1. The normalized value for the event is then: (<tt class="ph tt code">sum_event_values</tt> * <tt class="ph tt code">totalInstanceCount</tt>) / <tt class="ph tt code">instanceCount</tt>, where <tt class="ph tt code">sum_event_values</tt> is the summation of the event values across all profiled domain instances, <tt class="ph tt code">totalInstanceCount</tt> is obtained from querying CUPTI_EVENT_DOMAIN_ATTR_TOTAL_INSTANCE_COUNT and <tt class="ph tt code">instanceCount</tt> is obtained from querying CUPTI_EVENT_GROUP_ATTR_INSTANCE_COUNT (or CUPTI_EVENT_DOMAIN_ATTR_INSTANCE_COUNT).
</p>
<p class="p"></p>
</div>
</dd>
</dl>
</div>
</div>
<hr id="contents-end"></hr>
<div id="breadcrumbs"><a href="group__CUPTI__EVENT__API.html" shape="rect">< Previous</a> | <a href="annotated.html" shape="rect">Next ></a></div>
<div id="release-info">CUPTI
(<a href="../../pdf/CUPTI_Library.pdf">PDF</a>)
-
CUDA Toolkit v5.5
(<a href="https://developer.nvidia.com/cuda-toolkit-archive">older</a>)
-
Last updated
July 19, 2013
-
<a href="mailto:cudatools@nvidia.com?subject=CUDA Tools Documentation Feedback: cupti">Send Feedback</a></div>
</article>
<header id="header"><span id="company">NVIDIA</span><span id="site-title">CUDA Toolkit Documentation</span><form id="search" method="get" action="search">
<input type="text" name="search-text"></input><fieldset id="search-location">
<legend>Search In:</legend>
<label><input type="radio" name="search-type" value="site"></input>Entire Site</label>
<label><input type="radio" name="search-type" value="document"></input>Just This Document</label></fieldset>
<button type="reset">clear search</button>
<button id="submit" type="submit">search</button></form>
</header>
<nav id="site-nav">
<div class="category closed"><span class="twiddle">▷</span><a href="../index.html" title="The root of the site.">CUDA Toolkit</a></div>
<ul class="closed">
<li><a href="../cuda-toolkit-release-notes/index.html" title="The Release Notes for the CUDA Toolkit from v4.0 to today.">Release Notes</a></li>
<li><a href="../eula/index.html" title="The End User License Agreements for the NVIDIA CUDA Toolkit, the NVIDIA CUDA Samples, the NVIDIA Display Driver, and NVIDIA NSight (Visual Studio Edition).">EULA</a></li>
<li><a href="../cuda-getting-started-guide-for-linux/index.html" title="This guide discusses how to install and check for correct operation of the CUDA Development Tools on GNU/Linux systems.">Getting Started Linux</a></li>
<li><a href="../cuda-getting-started-guide-for-mac-os-x/index.html" title="This guide discusses how to install and check for correct operation of the CUDA Development Tools on Mac OS X systems.">Getting Started Mac OS X</a></li>
<li><a href="../cuda-getting-started-guide-for-microsoft-windows/index.html" title="This guide discusses how to install and check for correct operation of the CUDA Development Tools on Microsoft Windows systems.">Getting Started Windows</a></li>
<li><a href="../cuda-c-programming-guide/index.html" title="This guide provides a detailed discussion of the CUDA programming model and programming interface. It then describes the hardware implementation, and provides guidance on how to achieve maximum performance. The Appendixes include a list of all CUDA-enabled devices, detailed description of all extensions to the C language, listings of supported mathematical functions, C++ features supported in host and device code, details on texture fetching, technical specifications of various devices, and concludes by introducing the low-level driver API.">Programming Guide</a></li>
<li><a href="../cuda-c-best-practices-guide/index.html" title="This guide presents established parallelization and optimization techniques and explains coding metaphors and idioms that can greatly simplify programming for CUDA-capable GPU architectures. The intent is to provide guidelines for obtaining the best performance from NVIDIA GPUs using the CUDA Toolkit.">Best Practices Guide</a></li>
<li><a href="../kepler-compatibility-guide/index.html" title="This application note is intended to help developers ensure that their NVIDIA CUDA applications will run effectively on GPUs based on the NVIDIA Kepler Architecture. This document provides guidance to ensure that your software applications are compatible with Kepler.">Kepler Compatibility Guide</a></li>
<li><a href="../kepler-tuning-guide/index.html" title="Kepler is NVIDIA's next-generation architecture for CUDA compute applications. Applications that follow the best practices for the Fermi architecture should typically see speedups on the Kepler architecture without any code changes. This guide summarizes the ways that an application can be fine-tuned to gain additional speedups by leveraging Kepler architectural features.">Kepler Tuning Guide</a></li>
<li><a href="../parallel-thread-execution/index.html" title="This guide provides detailed instructions on the use of PTX, a low-level parallel thread execution virtual machine and instruction set architecture (ISA). PTX exposes the GPU as a data-parallel computing device.">PTX ISA</a></li>
<li><a href="../optimus-developer-guide/index.html" title="This document explains how CUDA APIs can be used to query for GPU capabilities in NVIDIA Optimus systems.">Developer Guide for Optimus</a></li>
<li><a href="../video-decoder/index.html" title="This document provides the video decoder API specification and the format conversion and display using DirectX or OpenGL following decode.">Video Decoder</a></li>
<li><a href="../video-encoder/index.html" title="This document provides the CUDA video encoder specifications, including the C-library API functions and encoder query parameters.">Video Encoder</a></li>
<li><a href="../inline-ptx-assembly/index.html" title="This document shows how to inline PTX (parallel thread execution) assembly language statements into CUDA code. It describes available assembler statement parameters and constraints, and the document also provides a list of some pitfalls that you may encounter.">Inline PTX Assembly</a></li>
<li><a href="../cuda-runtime-api/index.html" title="The CUDA runtime API.">CUDA Runtime API</a></li>
<li><a href="../cuda-driver-api/index.html" title="The CUDA driver API.">CUDA Driver API</a></li>
<li><a href="../cuda-math-api/index.html" title="The CUDA math API.">CUDA Math API</a></li>
<li><a href="../cublas/index.html" title="The CUBLAS library is an implementation of BLAS (Basic Linear Algebra Subprograms) on top of the NVIDIA CUDA runtime. It allows the user to access the computational resources of NVIDIA Graphical Processing Unit (GPU), but does not auto-parallelize across multiple GPUs.">CUBLAS</a></li>
<li><a href="../cufft/index.html" title="The CUFFT library user guide.">CUFFT</a></li>
<li><a href="../curand/index.html" title="The CURAND library user guide.">CURAND</a></li>
<li><a href="../cusparse/index.html" title="The CUSPARSE library user guide.">CUSPARSE</a></li>
<li><a href="../npp/index.html" title="NVIDIA NPP is a library of functions for performing CUDA accelerated processing. The initial set of functionality in the library focuses on imaging and video processing and is widely applicable for developers in these areas. NPP will evolve over time to encompass more of the compute heavy tasks in a variety of problem domains. The NPP library is written to maximize flexibility, while maintaining high performance.">NPP</a></li>
<li><a href="../thrust/index.html" title="The Thrust getting started guide.">Thrust</a></li>
<li><a href="../cuda-samples/index.html" title="This document contains a complete listing of the code samples that are included with the NVIDIA CUDA Toolkit. It describes each code sample, lists the minimum GPU specification, and provides links to the source code and white papers if available.">CUDA Samples</a></li>
<li><a href="../cuda-compiler-driver-nvcc/index.html" title="This document is a reference guide on the use of the CUDA compiler driver nvcc. Instead of being a specific CUDA compilation driver, nvcc mimics the behavior of the GNU compiler gcc, accepting a range of conventional compiler options, such as for defining macros and include/library paths, and for steering the compilation process.">NVCC</a></li>
<li><a href="../cuda-gdb/index.html" title="The NVIDIA tool for debugging CUDA applications running on Linux and Mac, providing developers with a mechanism for debugging CUDA applications running on actual hardware. CUDA-GDB is an extension to the x86-64 port of GDB, the GNU Project debugger.">CUDA-GDB</a></li>
<li><a href="../cuda-memcheck/index.html" title="CUDA-MEMCHECK is a suite of run time tools capable of precisely detecting out of bounds and misaligned memory access errors, checking device allocation leaks, reporting hardware errors and identifying shared memory data access hazards.">CUDA-MEMCHECK</a></li>
<li><a href="../nsight-eclipse-edition-getting-started-guide/index.html" title="Nsight Eclipse Edition getting started guide">Nsight Eclipse Edition</a></li>
<li><a href="../profiler-users-guide/index.html" title="This is the guide to the Profiler.">Profiler</a></li>
<li><a href="../cuda-binary-utilities/index.html" title="The application notes for cuobjdump and nvdisasm.">CUDA Binary Utilities</a></li>
<li><a href="../floating-point/index.html" title="A number of issues related to floating point accuracy and compliance are a frequent source of confusion on both CPUs and GPUs. The purpose of this white paper is to discuss the most common issues related to NVIDIA GPUs and to supplement the documentation in the CUDA C Programming Guide.">Floating Point and IEEE 754</a></li>
<li><a href="../incomplete-lu-cholesky/index.html" title="In this white paper we show how to use the CUSPARSE and CUBLAS libraries to achieve a 2x speedup over CPU in the incomplete-LU and Cholesky preconditioned iterative methods. We focus on the Bi-Conjugate Gradient Stabilized and Conjugate Gradient iterative methods, that can be used to solve large sparse nonsymmetric and symmetric positive definite linear systems, respectively. Also, we comment on the parallel sparse triangular solve, which is an essential building block in these algorithms.">Incomplete-LU and Cholesky Preconditioned Iterative Methods</a></li>
<li><a href="../libnvvm-api/index.html" title="The libNVVM API.">libNVVM API</a></li>
<li><a href="../libdevice-users-guide/index.html" title="The libdevice library is an LLVM bitcode library that implements common functions for GPU kernels.">libdevice User's Guide</a></li>
<li><a href="../nvvm-ir-spec/index.html" title="NVVM IR is a compiler IR (internal representation) based on the LLVM IR. The NVVM IR is designed to represent GPU compute kernels (for example, CUDA kernels). High-level language front-ends, like the CUDA C compiler front-end, can generate NVVM IR.">NVVM IR</a></li>
<li><a href="../cupti/index.html" title="The CUPTI API.">CUPTI</a></li>
<li><a href="../debugger-api/index.html" title="The CUDA debugger API.">Debugger API</a></li>
<li><a href="../gpudirect-rdma/index.html" title="A tool for Kepler-class GPUs and CUDA 5.0 enabling a direct path for communication between the GPU and a peer device on the PCI Express bus when the devices share the same upstream root complex using standard features of PCI Express. This document introduces the technology and describes the steps necessary to enable a RDMA for GPUDirect connection to NVIDIA GPUs within the Linux device driver model.">RDMA for GPUDirect</a></li>
</ul>
<div class="category"><span class="twiddle">▼</span><a href="index.html" title="CUPTI">CUPTI</a></div>
<ul>
<li><a href="r_main.html#r_main">1. Introduction</a><ul>
<li><a href="r_main.html#r_compatibility_requirements">1.1. CUPTI Compatibility and Requirements</a></li>
<li><a href="r_main.html#r_initialization">1.2. CUPTI Initialization</a></li>
<li><a href="r_main.html#r_activity">1.3. CUPTI Activity API</a></li>
<li><a href="r_main.html#r_callback_api">1.4. CUPTI Callback API</a><ul>
<li><a href="r_main.html#r_driver_runtime_api_callback">1.4.1. Driver and Runtime API Callbacks</a></li>
<li><a href="r_main.html#r_resource_callbacks">1.4.2. Resource Callbacks</a></li>
<li><a href="r_main.html#r_synchronization_callbacks">1.4.3. Synchronization Callbacks</a></li>
<li><a href="r_main.html#r_nvtx_callbacks">1.4.4. NVIDIA Tools Extension Callbacks</a></li>
</ul>
</li>
<li><a href="r_main.html#r_event_api">1.5. CUPTI Event API</a><ul>
<li><a href="r_main.html#r_collecting_kernel_execution_events">1.5.1. Collecting Kernel Execution Events</a></li>
<li><a href="r_main.html#r_sampling_events">1.5.2. Sampling Events</a></li>
</ul>
</li>
<li><a href="r_main.html#r_metric_api">1.6. CUPTI Metric API</a><ul>
<li><a href="r_main.html#r_metric_reference_1x">1.6.1. Metric Reference - Compute Capability 1.x</a></li>
<li><a href="r_main.html#r_metric_reference_2x">1.6.2. Metric Reference - Compute Capability 2.x</a></li>
<li><a href="r_main.html#r_metric_reference_3x">1.6.3. Metric Reference - Compute Capability 3.x</a></li>
</ul>
</li>
<li><a href="r_main.html#r_samples">1.7. Samples</a></li>
</ul>
</li>
<li><a href="modules.html#modules">2. Modules</a><ul>
<li><a href="group__CUPTI__VERSION__API.html#group__CUPTI__VERSION__API">2.1. CUPTI Version</a></li>
<li><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API">2.2. CUPTI Result Codes</a></li>
<li><a href="group__CUPTI__ACTIVITY__API.html#group__CUPTI__ACTIVITY__API">2.3. CUPTI Activity API</a></li>
<li><a href="group__CUPTI__CALLBACK__API.html#group__CUPTI__CALLBACK__API">2.4. CUPTI Callback API</a></li>
<li><a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API">2.5. CUPTI Event API</a></li>
<li><a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API">2.6. CUPTI Metric API</a></li>
</ul>
</li>
<li><a href="annotated.html#annotated">3. Data Structures</a><ul>
<li><a href="structCUpti__Activity.html#structCUpti__Activity">3.1. CUpti_Activity</a></li>
<li><a href="structCUpti__ActivityAPI.html#structCUpti__ActivityAPI">3.2. CUpti_ActivityAPI</a></li>
<li><a href="structCUpti__ActivityBranch.html#structCUpti__ActivityBranch">3.3. CUpti_ActivityBranch</a></li>
<li><a href="structCUpti__ActivityCdpKernel.html#structCUpti__ActivityCdpKernel">3.4. CUpti_ActivityCdpKernel</a></li>
<li><a href="structCUpti__ActivityContext.html#structCUpti__ActivityContext">3.5. CUpti_ActivityContext</a></li>
<li><a href="structCUpti__ActivityDevice.html#structCUpti__ActivityDevice">3.6. CUpti_ActivityDevice</a></li>
<li><a href="structCUpti__ActivityEnvironment.html#structCUpti__ActivityEnvironment">3.7. CUpti_ActivityEnvironment</a></li>
<li><a href="structCUpti__ActivityEvent.html#structCUpti__ActivityEvent">3.8. CUpti_ActivityEvent</a></li>
<li><a href="structCUpti__ActivityEventInstance.html#structCUpti__ActivityEventInstance">3.9. CUpti_ActivityEventInstance</a></li>
<li><a href="structCUpti__ActivityGlobalAccess.html#structCUpti__ActivityGlobalAccess">3.10. CUpti_ActivityGlobalAccess</a></li>
<li><a href="structCUpti__ActivityKernel.html#structCUpti__ActivityKernel">3.11. CUpti_ActivityKernel</a></li>
<li><a href="structCUpti__ActivityKernel2.html#structCUpti__ActivityKernel2">3.12. CUpti_ActivityKernel2</a></li>
<li><a href="structCUpti__ActivityMarker.html#structCUpti__ActivityMarker">3.13. CUpti_ActivityMarker</a></li>
<li><a href="structCUpti__ActivityMarkerData.html#structCUpti__ActivityMarkerData">3.14. CUpti_ActivityMarkerData</a></li>
<li><a href="structCUpti__ActivityMemcpy.html#structCUpti__ActivityMemcpy">3.15. CUpti_ActivityMemcpy</a></li>
<li><a href="structCUpti__ActivityMemcpy2.html#structCUpti__ActivityMemcpy2">3.16. CUpti_ActivityMemcpy2</a></li>
<li><a href="structCUpti__ActivityMemset.html#structCUpti__ActivityMemset">3.17. CUpti_ActivityMemset</a></li>
<li><a href="structCUpti__ActivityMetric.html#structCUpti__ActivityMetric">3.18. CUpti_ActivityMetric</a></li>
<li><a href="structCUpti__ActivityMetricInstance.html#structCUpti__ActivityMetricInstance">3.19. CUpti_ActivityMetricInstance</a></li>
<li><a href="structCUpti__ActivityName.html#structCUpti__ActivityName">3.20. CUpti_ActivityName</a></li>
<li><a href="unionCUpti__ActivityObjectKindId.html#unionCUpti__ActivityObjectKindId">3.21. CUpti_ActivityObjectKindId</a></li>
<li><a href="structCUpti__ActivityOverhead.html#structCUpti__ActivityOverhead">3.22. CUpti_ActivityOverhead</a></li>
<li><a href="structCUpti__ActivityPreemption.html#structCUpti__ActivityPreemption">3.23. CUpti_ActivityPreemption</a></li>
<li><a href="structCUpti__ActivitySourceLocator.html#structCUpti__ActivitySourceLocator">3.24. CUpti_ActivitySourceLocator</a></li>
<li><a href="structCUpti__CallbackData.html#structCUpti__CallbackData">3.25. CUpti_CallbackData</a></li>
<li><a href="structCUpti__EventGroupSet.html#structCUpti__EventGroupSet">3.26. CUpti_EventGroupSet</a></li>
<li><a href="structCUpti__EventGroupSets.html#structCUpti__EventGroupSets">3.27. CUpti_EventGroupSets</a></li>
<li><a href="unionCUpti__MetricValue.html#unionCUpti__MetricValue">3.28. CUpti_MetricValue</a></li>
<li><a href="structCUpti__NvtxData.html#structCUpti__NvtxData">3.29. CUpti_NvtxData</a></li>
<li><a href="structCUpti__ResourceData.html#structCUpti__ResourceData">3.30. CUpti_ResourceData</a></li>
<li><a href="structCUpti__SynchronizeData.html#structCUpti__SynchronizeData">3.31. CUpti_SynchronizeData</a></li>
</ul>
</li>
<li><a href="functions.html#functions">4. Data Fields</a></li>
<li><a href="notices-header.html#notices-header">Notices</a><ul></ul>
</li>
</ul>
</nav>
<nav id="search-results">
<h2>Search Results</h2>
<ol></ol>
</nav>
<script language="JavaScript" type="text/javascript" charset="utf-8" src="../common/formatting/common.min.js"></script>
<script language="JavaScript" type="text/javascript" charset="utf-8" src="../common/scripts/omniture/s_code_us_dev_aut1-nolinktrackin.js"></script>
<script language="JavaScript" type="text/javascript" charset="utf-8" src="../common/scripts/omniture/omniture.js"></script>
<noscript><a href="http://www.omniture.com" title="Web Analytics"><img src="http://omniture.nvidia.com/b/ss/nvidiacudadocs/1/H.17--NS/0" height="1" width="1" border="0" alt=""></img></a></noscript>
<script language="JavaScript" type="text/javascript" charset="utf-8" src="../common/scripts/google-analytics/google-analytics-write.js"></script>
<script language="JavaScript" type="text/javascript" charset="utf-8" src="../common/scripts/google-analytics/google-analytics-tracker.js"></script>
</body>
</html>
