<!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 Event 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__EVENT__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/scripts/tynt/tynt.js"></script>
<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>
<script type="text/javascript" charset="utf-8" src="../common/formatting/jquery.scrollintoview.min.js"></script>
<script type="text/javascript" src="../search/htmlFileList.js"></script>
<script type="text/javascript" src="../search/htmlFileInfoList.js"></script>
<script type="text/javascript" src="../search/nwSearchFnt.min.js"></script>
<script type="text/javascript" src="../search/stemmers/en_stemmer.min.js"></script>
<script type="text/javascript" src="../search/index-1.js"></script>
<script type="text/javascript" src="../search/index-2.js"></script>
<script type="text/javascript" src="../search/index-3.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>
<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>
<div id="site-content">
<nav id="site-nav">
<div class="category closed"><a href="../index.html" title="The root of the site.">CUDA Toolkit
v6.5</a></div>
<div class="category"><a href="index.html" title="CUPTI">CUPTI</a></div>
<ul>
<li>
<div class="section-link"><a href="r_main.html#r_main">1. Usage</a></div>
<ul>
<li>
<div class="section-link"><a href="r_main.html#r_compatibility_requirements">1.1. CUPTI Compatibility and Requirements</a></div>
</li>
<li>
<div class="section-link"><a href="r_main.html#r_initialization">1.2. CUPTI Initialization</a></div>
</li>
<li>
<div class="section-link"><a href="r_main.html#r_activity">1.3. CUPTI Activity API</a></div>
<ul>
<li>
<div class="section-link"><a href="r_main.html#r_context_activity">1.3.1. Context Activity Record</a></div>
</li>
<li>
<div class="section-link"><a href="r_main.html#r_legacy_activity">1.3.2. Legacy Activity Records</a></div>
</li>
</ul>
</li>
<li>
<div class="section-link"><a href="r_main.html#r_callback_api">1.4. CUPTI Callback API</a></div>
<ul>
<li>
<div class="section-link"><a href="r_main.html#r_driver_runtime_api_callback">1.4.1. Driver and Runtime API Callbacks</a></div>
</li>
<li>
<div class="section-link"><a href="r_main.html#r_resource_callbacks">1.4.2. Resource Callbacks</a></div>
</li>
<li>
<div class="section-link"><a href="r_main.html#r_synchronization_callbacks">1.4.3. Synchronization Callbacks</a></div>
</li>
<li>
<div class="section-link"><a href="r_main.html#r_nvtx_callbacks">1.4.4. NVIDIA Tools Extension Callbacks</a></div>
</li>
</ul>
</li>
<li>
<div class="section-link"><a href="r_main.html#r_event_api">1.5. CUPTI Event API</a></div>
<ul>
<li>
<div class="section-link"><a href="r_main.html#r_collecting_kernel_execution_events">1.5.1. Collecting Kernel Execution Events</a></div>
</li>
<li>
<div class="section-link"><a href="r_main.html#r_sampling_events">1.5.2. Sampling Events</a></div>
</li>
</ul>
</li>
<li>
<div class="section-link"><a href="r_main.html#r_metric_api">1.6. CUPTI Metric API</a></div>
</li>
<li>
<div class="section-link"><a href="r_main.html#r_samples">1.7. Samples</a></div>
</li>
</ul>
</li>
<li>
<div class="section-link"><a href="modules.html#modules">2. Modules</a></div>
<ul>
<li>
<div class="section-link"><a href="group__CUPTI__VERSION__API.html#group__CUPTI__VERSION__API">2.1. CUPTI Version</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API">2.2. CUPTI Result Codes</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUPTI__ACTIVITY__API.html#group__CUPTI__ACTIVITY__API">2.3. CUPTI Activity API</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUPTI__CALLBACK__API.html#group__CUPTI__CALLBACK__API">2.4. CUPTI Callback API</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API">2.5. CUPTI Event API</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUPTI__METRIC__API.html#group__CUPTI__METRIC__API">2.6. CUPTI Metric API</a></div>
</li>
</ul>
</li>
<li>
<div class="section-link"><a href="annotated.html#annotated">3. Data Structures</a></div>
<ul>
<li>
<div class="section-link"><a href="structCUpti__Activity.html#structCUpti__Activity">3.1. CUpti_Activity</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityAPI.html#structCUpti__ActivityAPI">3.2. CUpti_ActivityAPI</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityAutoBoostState.html#structCUpti__ActivityAutoBoostState">3.3. CUpti_ActivityAutoBoostState</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityBranch.html#structCUpti__ActivityBranch">3.4. CUpti_ActivityBranch</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityBranch2.html#structCUpti__ActivityBranch2">3.5. CUpti_ActivityBranch2</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityCdpKernel.html#structCUpti__ActivityCdpKernel">3.6. CUpti_ActivityCdpKernel</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityContext.html#structCUpti__ActivityContext">3.7. CUpti_ActivityContext</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityDevice.html#structCUpti__ActivityDevice">3.8. CUpti_ActivityDevice</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityDeviceAttribute.html#structCUpti__ActivityDeviceAttribute">3.9. CUpti_ActivityDeviceAttribute</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityEnvironment.html#structCUpti__ActivityEnvironment">3.10. CUpti_ActivityEnvironment</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityEvent.html#structCUpti__ActivityEvent">3.11. CUpti_ActivityEvent</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityEventInstance.html#structCUpti__ActivityEventInstance">3.12. CUpti_ActivityEventInstance</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityFunction.html#structCUpti__ActivityFunction">3.13. CUpti_ActivityFunction</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityGlobalAccess.html#structCUpti__ActivityGlobalAccess">3.14. CUpti_ActivityGlobalAccess</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityGlobalAccess2.html#structCUpti__ActivityGlobalAccess2">3.15. CUpti_ActivityGlobalAccess2</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityInstructionExecution.html#structCUpti__ActivityInstructionExecution">3.16. CUpti_ActivityInstructionExecution</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityKernel.html#structCUpti__ActivityKernel">3.17. CUpti_ActivityKernel</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityKernel2.html#structCUpti__ActivityKernel2">3.18. CUpti_ActivityKernel2</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityMarker.html#structCUpti__ActivityMarker">3.19. CUpti_ActivityMarker</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityMarkerData.html#structCUpti__ActivityMarkerData">3.20. CUpti_ActivityMarkerData</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityMemcpy.html#structCUpti__ActivityMemcpy">3.21. CUpti_ActivityMemcpy</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityMemcpy2.html#structCUpti__ActivityMemcpy2">3.22. CUpti_ActivityMemcpy2</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityMemset.html#structCUpti__ActivityMemset">3.23. CUpti_ActivityMemset</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityMetric.html#structCUpti__ActivityMetric">3.24. CUpti_ActivityMetric</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityMetricInstance.html#structCUpti__ActivityMetricInstance">3.25. CUpti_ActivityMetricInstance</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityModule.html#structCUpti__ActivityModule">3.26. CUpti_ActivityModule</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityName.html#structCUpti__ActivityName">3.27. CUpti_ActivityName</a></div>
</li>
<li>
<div class="section-link"><a href="unionCUpti__ActivityObjectKindId.html#unionCUpti__ActivityObjectKindId">3.28. CUpti_ActivityObjectKindId</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityOverhead.html#structCUpti__ActivityOverhead">3.29. CUpti_ActivityOverhead</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityPreemption.html#structCUpti__ActivityPreemption">3.30. CUpti_ActivityPreemption</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivitySharedAccess.html#structCUpti__ActivitySharedAccess">3.31. CUpti_ActivitySharedAccess</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivitySourceLocator.html#structCUpti__ActivitySourceLocator">3.32. CUpti_ActivitySourceLocator</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityUnifiedMemoryCounter.html#structCUpti__ActivityUnifiedMemoryCounter">3.33. CUpti_ActivityUnifiedMemoryCounter</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ActivityUnifiedMemoryCounterConfig.html#structCUpti__ActivityUnifiedMemoryCounterConfig">3.34. CUpti_ActivityUnifiedMemoryCounterConfig</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__CallbackData.html#structCUpti__CallbackData">3.35. CUpti_CallbackData</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__EventGroupSet.html#structCUpti__EventGroupSet">3.36. CUpti_EventGroupSet</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__EventGroupSets.html#structCUpti__EventGroupSets">3.37. CUpti_EventGroupSets</a></div>
</li>
<li>
<div class="section-link"><a href="unionCUpti__MetricValue.html#unionCUpti__MetricValue">3.38. CUpti_MetricValue</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ModuleResourceData.html#structCUpti__ModuleResourceData">3.39. CUpti_ModuleResourceData</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__NvtxData.html#structCUpti__NvtxData">3.40. CUpti_NvtxData</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__ResourceData.html#structCUpti__ResourceData">3.41. CUpti_ResourceData</a></div>
</li>
<li>
<div class="section-link"><a href="structCUpti__SynchronizeData.html#structCUpti__SynchronizeData">3.42. CUpti_SynchronizeData</a></div>
</li>
</ul>
</li>
<li>
<div class="section-link"><a href="functions.html#functions">4. Data Fields</a></div>
</li>
<li>
<div class="section-link"><a href="notices-header.html#notices-header">Notices</a></div>
<ul></ul>
</li>
</ul>
</nav>
<div id="resize-nav"></div>
<nav id="search-results">
<h2>Search Results</h2>
<ol></ol>
</nav>
<div id="contents-container">
<div id="breadcrumbs-container">
<div id="breadcrumbs"><a href="group__CUPTI__CALLBACK__API.html" shape="rect">< Previous</a> | <a href="group__CUPTI__METRIC__API.html" shape="rect">Next ></a></div>
<div id="release-info">CUPTI
(<a href="../../pdf/CUPTI_Library.pdf">PDF</a>)
-
v6.5
(<a href="https://developer.nvidia.com/cuda-toolkit-archive">older</a>)
-
Last updated August 1, 2014
-
<a href="mailto:cudatools@nvidia.com?subject=CUDA Toolkit Documentation Feedback: CUPTI">Send Feedback</a>
-
<span class="st_facebook"></span><span class="st_twitter"></span><span class="st_linkedin"></span><span class="st_reddit"></span><span class="st_slashdot"></span><span class="st_tumblr"></span><span class="st_sharethis"></span></div>
</div>
<article id="contents">
<div class="topic reference apiRef apiPackage cppModule" id="group__CUPTI__EVENT__API"><a name="group__CUPTI__EVENT__API" shape="rect">
<!-- --></a><h2 class="topictitle2 cppModule">2.5. CUPTI Event API</h2>
<div class="section">
<p>Functions, types, and enums that implement the CUPTI Event API. </p>
</div>
<h3 class="fake_sectiontitle member_header">Classes</h3>
<dl class="members">
<dt><span class="member_type">struct </span><span class="member_name">
<div><a class="link" href="structCUpti__EventGroupSet.html#structCUpti__EventGroupSet" title="A set of event groups." shape="rect">CUpti_EventGroupSet</a></div></span></dt>
<dd class="shortdesc"><span></span><span class="desc">A set of event groups. </span><a href="structCUpti__EventGroupSet.html#structCUpti__EventGroupSet" class="link" title="A set of event groups." shape="rect"></a></dd>
<dt><span class="member_type">struct </span><span class="member_name">
<div><a class="link" href="structCUpti__EventGroupSets.html#structCUpti__EventGroupSets" title="A set of event group sets." shape="rect">CUpti_EventGroupSets</a></div></span></dt>
<dd class="shortdesc"><span></span><span class="desc">A set of event group sets. </span><a href="structCUpti__EventGroupSets.html#structCUpti__EventGroupSets" class="link" title="A set of event group sets." shape="rect"></a></dd>
</dl>
<h3 class="fake_sectiontitle member_header">Defines</h3>
<dl class="members">
<dt><span class="member_type">#define </span><span class="member_name"><a href="#group__CUPTI__EVENT__API_1g4f280929637a726da2ba4c907e5b9ba1" shape="rect">CUPTI_EVENT_OVERFLOW</a></span></dt>
<dd class="shortdesc"><span></span><span class="desc">The overflow value for a CUPTI event. </span></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__EVENT__API_1g8a898bd33ce64d353b79d7d39e74d198" shape="rect">CUpti_EventDomainID</a></span></dt>
<dd class="shortdesc"><span></span><span class="desc">ID for an event domain. </span></dd>
<dt><span class="member_type">typedef void * </span><span class="member_name"><a href="#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" shape="rect">CUpti_EventGroup</a></span></dt>
<dd class="shortdesc"><span></span><span class="desc">A group of events. </span></dd>
<dt><span class="member_type">typedef uint32_t </span><span class="member_name"><a href="#group__CUPTI__EVENT__API_1g6ce7370be9ed31ce6f2d475de39045df" shape="rect">CUpti_EventID</a></span></dt>
<dd class="shortdesc"><span></span><span class="desc">ID for an event. </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__EVENT__API_1g07af1fece58c6f17c48067740034e31b" shape="rect">CUpti_DeviceAttribute</a></span></dt>
<dd class="shortdesc"><span></span><span class="desc">Device attributes. </span></dd>
<dt><span class="member_type">enum </span><span class="member_name"><a href="#group__CUPTI__EVENT__API_1g77fc6151563b2f16b4eeea3d9bdbf3f3" shape="rect">CUpti_DeviceAttributeDeviceClass</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__EVENT__API_1g232a6c540682383abd4cee93ee18e6aa" shape="rect">CUpti_EventAttribute</a></span></dt>
<dd class="shortdesc"><span></span><span class="desc">Event attributes. </span></dd>
<dt><span class="member_type">enum </span><span class="member_name"><a href="#group__CUPTI__EVENT__API_1gd9604f1d97d7c84664aa37f325e35f39" shape="rect">CUpti_EventCategory</a></span></dt>
<dd class="shortdesc"><span></span><span class="desc">An event category. </span></dd>
<dt><span class="member_type">enum </span><span class="member_name"><a href="#group__CUPTI__EVENT__API_1gdafc575cd4614872eba5d99e2f2bc831" shape="rect">CUpti_EventCollectionMethod</a></span></dt>
<dd class="shortdesc"><span></span><span class="desc">The collection method used for an event. </span></dd>
<dt><span class="member_type">enum </span><span class="member_name"><a href="#group__CUPTI__EVENT__API_1g54361f7bed89987eabb91300cc218712" shape="rect">CUpti_EventCollectionMode</a></span></dt>
<dd class="shortdesc"><span></span><span class="desc">Event collection modes. </span></dd>
<dt><span class="member_type">enum </span><span class="member_name"><a href="#group__CUPTI__EVENT__API_1ga201105be2a6a988b72e70a643c82ad5" shape="rect">CUpti_EventDomainAttribute</a></span></dt>
<dd class="shortdesc"><span></span><span class="desc">Event domain attributes. </span></dd>
<dt><span class="member_type">enum </span><span class="member_name"><a href="#group__CUPTI__EVENT__API_1gc8aaac37b2aefeea5177c0b813806b9f" shape="rect">CUpti_EventGroupAttribute</a></span></dt>
<dd class="shortdesc"><span></span><span class="desc">Event group attributes. </span></dd>
<dt><span class="member_type">enum </span><span class="member_name"><a href="#group__CUPTI__EVENT__API_1ge8ea7de2653cc087a9c5399386604528" shape="rect">CUpti_ReadEventFlags</a></span></dt>
<dd class="shortdesc"><span></span><span class="desc">Flags for cuptiEventGroupReadEvent an cuptiEventGroupReadAllEvents. </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__EVENT__API_1g430869bc1bfcc11589241bac94774c06" shape="rect">cuptiDeviceEnumEventDomains</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__EVENT__API.html#group__CUPTI__EVENT__API_1g8a898bd33ce64d353b79d7d39e74d198" title="ID for an event domain. " shape="rect">CUpti_EventDomainID</a>*<span> </span><span class="keyword keyword apiItemName">domainArray</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Get the event domains 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__EVENT__API_1g631a8f494a7f0f3d254ad49f2040eff5" shape="rect">cuptiDeviceGetAttribute</a> ( CUdevice<span> </span><span class="keyword keyword apiItemName">device</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g07af1fece58c6f17c48067740034e31b" title="Device attributes. " shape="rect">CUpti_DeviceAttribute</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">Read a device 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__EVENT__API_1gbb745099ffef139c4ee98a1de82fcac2" shape="rect">cuptiDeviceGetEventDomainAttribute</a> ( CUdevice<span> </span><span class="keyword keyword apiItemName">device</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g8a898bd33ce64d353b79d7d39e74d198" title="ID for an event domain. " shape="rect">CUpti_EventDomainID</a><span> </span><span class="keyword keyword apiItemName">eventDomain</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1ga201105be2a6a988b72e70a643c82ad5" title="Event domain attributes. " shape="rect">CUpti_EventDomainAttribute</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">Read an event domain 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__EVENT__API_1gfebb6c61c0c1f8427e187223d799cda5" shape="rect">cuptiDeviceGetNumEventDomains</a> ( CUdevice<span> </span><span class="keyword keyword apiItemName">device</span>, uint32_t*<span> </span><span class="keyword keyword apiItemName">numDomains</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Get the number of domains 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__EVENT__API_1g581c6a513e81f9431854561f43c06f36" shape="rect">cuptiDeviceGetTimestamp</a> ( CUcontext<span> </span><span class="keyword keyword apiItemName">context</span>, uint64_t*<span> </span><span class="keyword keyword apiItemName">timestamp</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Read a device timestamp. </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__EVENT__API_1g1746f087372090b5289e2512864b8e25" shape="rect">cuptiDisableKernelReplayMode</a> ( CUcontext<span> </span><span class="keyword keyword apiItemName">context</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Disable kernel replay mode. </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__EVENT__API_1g2a99f01445e5ba2f7e4ba89796e9b20f" shape="rect">cuptiEnableKernelReplayMode</a> ( CUcontext<span> </span><span class="keyword keyword apiItemName">context</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Enable kernel replay mode. </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__EVENT__API_1g3f6f5236a79cafda724796dc2d599ad1" shape="rect">cuptiEnumEventDomains</a> ( size_t*<span> </span><span class="keyword keyword apiItemName">arraySizeBytes</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g8a898bd33ce64d353b79d7d39e74d198" title="ID for an event domain. " shape="rect">CUpti_EventDomainID</a>*<span> </span><span class="keyword keyword apiItemName">domainArray</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Get the event domains 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__EVENT__API_1gd23627587d3f21c3d637edd562e362d3" shape="rect">cuptiEventDomainEnumEvents</a> ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g8a898bd33ce64d353b79d7d39e74d198" title="ID for an event domain. " shape="rect">CUpti_EventDomainID</a><span> </span><span class="keyword keyword apiItemName">eventDomain</span>, size_t*<span> </span><span class="keyword keyword apiItemName">arraySizeBytes</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">eventArray</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Get the events in a domain. </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__EVENT__API_1gf8084beb1c692a17616fb99523a044a5" shape="rect">cuptiEventDomainGetAttribute</a> ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g8a898bd33ce64d353b79d7d39e74d198" title="ID for an event domain. " shape="rect">CUpti_EventDomainID</a><span> </span><span class="keyword keyword apiItemName">eventDomain</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1ga201105be2a6a988b72e70a643c82ad5" title="Event domain attributes. " shape="rect">CUpti_EventDomainAttribute</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">Read an event domain 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__EVENT__API_1g7341de781de833b65e0748b37acc802f" shape="rect">cuptiEventDomainGetNumEvents</a> ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g8a898bd33ce64d353b79d7d39e74d198" title="ID for an event domain. " shape="rect">CUpti_EventDomainID</a><span> </span><span class="keyword keyword apiItemName">eventDomain</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 in a domain. </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__EVENT__API_1gec3d52db48a14aef9e8b35785bb4d60e" shape="rect">cuptiEventGetAttribute</a> ( <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">event</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g232a6c540682383abd4cee93ee18e6aa" title="Event attributes. " shape="rect">CUpti_EventAttribute</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 an event 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__EVENT__API_1gd27429cf327f99db6b49e88548f801d4" shape="rect">cuptiEventGetIdFromName</a> ( CUdevice<span> </span><span class="keyword keyword apiItemName">device</span>, const char*<span> </span><span class="keyword keyword apiItemName">eventName</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">event</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Find an event 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__EVENT__API_1g08b80dcd21975492c7d756eac59d8b6a" shape="rect">cuptiEventGroupAddEvent</a> ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</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">event</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Add an event to an event group. </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__EVENT__API_1g9d5cad301581eb32e94ffc7c1b9afc9d" shape="rect">cuptiEventGroupCreate</a> ( CUcontext<span> </span><span class="keyword keyword apiItemName">context</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a>*<span> </span><span class="keyword keyword apiItemName">eventGroup</span>, uint32_t<span> </span><span class="keyword keyword apiItemName">flags</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Create a new event group for a context. </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__EVENT__API_1g99f31aed86f5c117ef07409982f25bd0" shape="rect">cuptiEventGroupDestroy</a> ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Destroy an event group. </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__EVENT__API_1g63365c4bb038575bcd6b1a2ba13649d4" shape="rect">cuptiEventGroupDisable</a> ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Disable an event group. </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__EVENT__API_1g1b72c6cea4de6cc0ebee2c0b41453223" shape="rect">cuptiEventGroupEnable</a> ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Enable an event group. </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__EVENT__API_1g573c7e8a0295d36cf0051e27554971a8" shape="rect">cuptiEventGroupGetAttribute</a> ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1gc8aaac37b2aefeea5177c0b813806b9f" title="Event group attributes. " shape="rect">CUpti_EventGroupAttribute</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">Read an event group 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__EVENT__API_1gbb522fec20a70e3b5d8f819693c4f2dd" shape="rect">cuptiEventGroupReadAllEvents</a> ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1ge8ea7de2653cc087a9c5399386604528" title="Flags for cuptiEventGroupReadEvent an cuptiEventGroupReadAllEvents. " shape="rect">CUpti_ReadEventFlags</a><span> </span><span class="keyword keyword apiItemName">flags</span>, size_t*<span> </span><span class="keyword keyword apiItemName">eventValueBufferSizeBytes</span>, uint64_t*<span> </span><span class="keyword keyword apiItemName">eventValueBuffer</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">numEventIdsRead</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Read the values for all the events in an event group. </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__EVENT__API_1g31c30e2c86218a3501ae8a21127dec15" shape="rect">cuptiEventGroupReadEvent</a> ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1ge8ea7de2653cc087a9c5399386604528" title="Flags for cuptiEventGroupReadEvent an cuptiEventGroupReadAllEvents. " shape="rect">CUpti_ReadEventFlags</a><span> </span><span class="keyword keyword apiItemName">flags</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">event</span>, size_t*<span> </span><span class="keyword keyword apiItemName">eventValueBufferSizeBytes</span>, uint64_t*<span> </span><span class="keyword keyword apiItemName">eventValueBuffer</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Read the value for an event in an event group. </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__EVENT__API_1g4d7555b6c900a27dee2ee3465701bb96" shape="rect">cuptiEventGroupRemoveAllEvents</a> ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Remove all events from an event group. </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__EVENT__API_1g0da4bfbdde94a0fcb5bba2f1c69aa1f0" shape="rect">cuptiEventGroupRemoveEvent</a> ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</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">event</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Remove an event from an event group. </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__EVENT__API_1gbda509844936046694b6081cffa4886d" shape="rect">cuptiEventGroupResetAllEvents</a> ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Zero all the event counts in an event group. </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__EVENT__API_1gdeea7eb4a79d3c7e85db597f2c98d5ac" shape="rect">cuptiEventGroupSetAttribute</a> ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1gc8aaac37b2aefeea5177c0b813806b9f" title="Event group attributes. " shape="rect">CUpti_EventGroupAttribute</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">Write an event group 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__EVENT__API_1g0dc70d03c11800d734801a3d4fdac073" shape="rect">cuptiEventGroupSetDisable</a> ( <a href="structCUpti__EventGroupSet.html#structCUpti__EventGroupSet" title="A set of event groups. " shape="rect">CUpti_EventGroupSet</a>*<span> </span><span class="keyword keyword apiItemName">eventGroupSet</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Disable an event group set. </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__EVENT__API_1gff1d5b7675cc2748eadae7348e30cbfc" shape="rect">cuptiEventGroupSetEnable</a> ( <a href="structCUpti__EventGroupSet.html#structCUpti__EventGroupSet" title="A set of event groups. " shape="rect">CUpti_EventGroupSet</a>*<span> </span><span class="keyword keyword apiItemName">eventGroupSet</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Enable an event group set. </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__EVENT__API_1g0fd307d429d4e37f61f45472de069910" shape="rect">cuptiEventGroupSetsCreate</a> ( CUcontext<span> </span><span class="keyword keyword apiItemName">context</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>, <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 events, get the grouping that indicates the number of passes and the event groups necessary to collect the events.
</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__EVENT__API_1gcf75cc84517241e4c40c21c2f312e2ad" shape="rect">cuptiEventGroupSetsDestroy</a> ( <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">eventGroupSets</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Destroy a CUpti_EventGroupSets object. </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__EVENT__API_1g93814f61b681f440b43c8130f72a99f9" shape="rect">cuptiGetNumEventDomains</a> ( uint32_t*<span> </span><span class="keyword keyword apiItemName">numDomains</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Get the number of event domains 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__EVENT__API_1gdfa8bf3fa3d6c6445f2cb874d0b54cf3" shape="rect">cuptiSetEventCollectionMode</a> ( CUcontext<span> </span><span class="keyword keyword apiItemName">context</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g54361f7bed89987eabb91300cc218712" title="Event collection modes. " shape="rect">CUpti_EventCollectionMode</a><span> </span><span class="keyword keyword apiItemName">mode</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Set the event collection mode. </span></dd>
</dl>
<div class="description">
<h3 class="sectiontitle">Defines</h3>
<dl class="description">
<dt class="description"><a name="group__CUPTI__EVENT__API_1g4f280929637a726da2ba4c907e5b9ba1" id="group__CUPTI__EVENT__API_1g4f280929637a726da2ba4c907e5b9ba1" shape="rect">
<!-- --></a><span>#define CUPTI_EVENT_OVERFLOW </span></dt>
<dd class="description">
<div class="section">
<p>The CUPTI event value that indicates an overflow. </p>
</div>
<div class="section">
<h6 class="define_header">
Value
</h6>
<p class="code">((uint64_t)0xFFFFFFFFFFFFFFFFULL)</p>
</div>
</dd>
</dl>
</div>
<div class="description">
<h3 class="sectiontitle">Typedefs</h3>
<dl class="description">
<dt class="description"><a name="group__CUPTI__EVENT__API_1g8a898bd33ce64d353b79d7d39e74d198" id="group__CUPTI__EVENT__API_1g8a898bd33ce64d353b79d7d39e74d198" shape="rect">
<!-- --></a><span>typedef uint32_t CUpti_EventDomainID</span></dt>
<dd class="description">
<div class="section">
<p>ID for an event domain. ID for an event domain. An event domain represents a group of related events. A device may have multiple
instances of a domain, indicating that the device can simultaneously record multiple instances of each event within that domain.
</p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" id="group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" shape="rect">
<!-- --></a><span>typedef void * CUpti_EventGroup</span></dt>
<dd class="description">
<div class="section">
<p>A group of events. An event group is a collection of events that are managed together. All events in an event group must
belong to the same domain.
</p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g6ce7370be9ed31ce6f2d475de39045df" id="group__CUPTI__EVENT__API_1g6ce7370be9ed31ce6f2d475de39045df" shape="rect">
<!-- --></a><span>typedef uint32_t CUpti_EventID</span></dt>
<dd class="description">
<div class="section">
<p>ID for an event. An event represents a countable activity, action, or occurrence on 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__EVENT__API_1g07af1fece58c6f17c48067740034e31b" id="group__CUPTI__EVENT__API_1g07af1fece58c6f17c48067740034e31b" shape="rect">
<!-- --></a><span>enum CUpti_DeviceAttribute</span></dt>
<dd class="description">
<div class="section">
<p>CUPTI device attributes. These attributes can be read using <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g631a8f494a7f0f3d254ad49f2040eff5" title="Read a device attribute." shape="rect">cuptiDeviceGetAttribute</a>.
</p>
</div>
<div class="enum-members">
<h6 class="enumerator_header">
Values
</h6>
<dl class="enumerator">
<dt><span class="enum-member-name-def">CUPTI_DEVICE_ATTR_MAX_EVENT_ID = <span class="ph ph apiData">1</span></span></dt>
<dd>Number of event IDs for a device. Value is a uint32_t. </dd>
<dt><span class="enum-member-name-def">CUPTI_DEVICE_ATTR_MAX_EVENT_DOMAIN_ID = <span class="ph ph apiData">2</span></span></dt>
<dd>Number of event domain IDs for a device. Value is a uint32_t. </dd>
<dt><span class="enum-member-name-def">CUPTI_DEVICE_ATTR_GLOBAL_MEMORY_BANDWIDTH = <span class="ph ph apiData">3</span></span></dt>
<dd>Get global memory bandwidth in Kbytes/sec. Value is a uint64_t. </dd>
<dt><span class="enum-member-name-def">CUPTI_DEVICE_ATTR_INSTRUCTION_PER_CYCLE = <span class="ph ph apiData">4</span></span></dt>
<dd>Get theoretical maximum number of instructions per cycle. Value is a uint32_t. </dd>
<dt><span class="enum-member-name-def">CUPTI_DEVICE_ATTR_INSTRUCTION_THROUGHPUT_SINGLE_PRECISION = <span class="ph ph apiData">5</span></span></dt>
<dd>Get theoretical maximum number of single precision instructions that can be executed per second. Value is a uint64_t. </dd>
<dt><span class="enum-member-name-def">CUPTI_DEVICE_ATTR_MAX_FRAME_BUFFERS = <span class="ph ph apiData">6</span></span></dt>
<dd>Get number of frame buffers for device. Value is a uint64_t. </dd>
<dt><span class="enum-member-name-def">CUPTI_DEVICE_ATTR_PCIE_LINK_RATE = <span class="ph ph apiData">7</span></span></dt>
<dd>Get PCIE link rate in Mega bits/sec for device. Return 0 if bus-type is non-PCIE. Value is a uint64_t. </dd>
<dt><span class="enum-member-name-def">CUPTI_DEVICE_ATTR_PCIE_LINK_WIDTH = <span class="ph ph apiData">8</span></span></dt>
<dd>Get PCIE link width for device. Return 0 if bus-type is non-PCIE. Value is a uint64_t. </dd>
<dt><span class="enum-member-name-def">CUPTI_DEVICE_ATTR_PCIE_GEN = <span class="ph ph apiData">9</span></span></dt>
<dd>Get PCIE generation for device. Return 0 if bus-type is non-PCIE. Value is a uint64_t. </dd>
<dt><span class="enum-member-name-def">CUPTI_DEVICE_ATTR_DEVICE_CLASS = <span class="ph ph apiData">10</span></span></dt>
<dd>Get the class for the device. Value is a CUpti_DeviceAttributeDeviceClass. </dd>
<dt><span class="enum-member-name-def">CUPTI_DEVICE_ATTR_FLOP_SP_PER_CYCLE = <span class="ph ph apiData">11</span></span></dt>
<dd>Get the peak single precision flop per cycle. Value is a uint64_t. </dd>
<dt><span class="enum-member-name-def">CUPTI_DEVICE_ATTR_FLOP_DP_PER_CYCLE = <span class="ph ph apiData">12</span></span></dt>
<dd>Get the peak double precision flop per cycle. Value is a uint64_t. </dd>
<dt><span class="enum-member-name-def">CUPTI_DEVICE_ATTR_MAX_L2_UNITS = <span class="ph ph apiData">13</span></span></dt>
<dd>Get number of L2 units. Value is a uint64_t. </dd>
<dt><span class="enum-member-name-def">CUPTI_DEVICE_ATTR_FORCE_INT = <span class="ph ph apiData">0x7fffffff</span></span></dt>
<dd></dd>
</dl>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g77fc6151563b2f16b4eeea3d9bdbf3f3" id="group__CUPTI__EVENT__API_1g77fc6151563b2f16b4eeea3d9bdbf3f3" shape="rect">
<!-- --></a><span>enum CUpti_DeviceAttributeDeviceClass</span></dt>
<dd class="description">
<div class="section">
<p>Enumeration of device classes for device attribute CUPTI_DEVICE_ATTR_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_DEVICE_ATTR_DEVICE_CLASS_TESLA = <span class="ph ph apiData">0</span></span></dt>
<dd></dd>
<dt><span class="enum-member-name-def">CUPTI_DEVICE_ATTR_DEVICE_CLASS_QUADRO = <span class="ph ph apiData">1</span></span></dt>
<dd></dd>
<dt><span class="enum-member-name-def">CUPTI_DEVICE_ATTR_DEVICE_CLASS_GEFORCE = <span class="ph ph apiData">2</span></span></dt>
<dd></dd>
</dl>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g232a6c540682383abd4cee93ee18e6aa" id="group__CUPTI__EVENT__API_1g232a6c540682383abd4cee93ee18e6aa" shape="rect">
<!-- --></a><span>enum CUpti_EventAttribute</span></dt>
<dd class="description">
<div class="section">
<p>Event attributes. These attributes can be read using <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1gec3d52db48a14aef9e8b35785bb4d60e" title="Get an event attribute." shape="rect">cuptiEventGetAttribute</a>.
</p>
</div>
<div class="enum-members">
<h6 class="enumerator_header">
Values
</h6>
<dl class="enumerator">
<dt><span class="enum-member-name-def">CUPTI_EVENT_ATTR_NAME = <span class="ph ph apiData">0</span></span></dt>
<dd>Event name. Value is a null terminated const c-string. </dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_ATTR_SHORT_DESCRIPTION = <span class="ph ph apiData">1</span></span></dt>
<dd>Short description of event. Value is a null terminated const c-string. </dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_ATTR_LONG_DESCRIPTION = <span class="ph ph apiData">2</span></span></dt>
<dd>Long description of event. Value is a null terminated const c-string. </dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_ATTR_CATEGORY = <span class="ph ph apiData">3</span></span></dt>
<dd>Category of event. Value is CUpti_EventCategory. </dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_ATTR_FORCE_INT = <span class="ph ph apiData">0x7fffffff</span></span></dt>
<dd></dd>
</dl>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1gd9604f1d97d7c84664aa37f325e35f39" id="group__CUPTI__EVENT__API_1gd9604f1d97d7c84664aa37f325e35f39" shape="rect">
<!-- --></a><span>enum CUpti_EventCategory</span></dt>
<dd class="description">
<div class="section">
<p>Each event is assigned to a category that represents the general type of the event. A event's category is accessed using <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1gec3d52db48a14aef9e8b35785bb4d60e" title="Get an event attribute." shape="rect">cuptiEventGetAttribute</a> and the CUPTI_EVENT_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_EVENT_CATEGORY_INSTRUCTION = <span class="ph ph apiData">0</span></span></dt>
<dd>An instruction related event. </dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_CATEGORY_MEMORY = <span class="ph ph apiData">1</span></span></dt>
<dd>A memory related event. </dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_CATEGORY_CACHE = <span class="ph ph apiData">2</span></span></dt>
<dd>A cache related event. </dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_CATEGORY_PROFILE_TRIGGER = <span class="ph ph apiData">3</span></span></dt>
<dd>A profile-trigger event. </dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_CATEGORY_FORCE_INT = <span class="ph ph apiData">0x7fffffff</span></span></dt>
<dd></dd>
</dl>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1gdafc575cd4614872eba5d99e2f2bc831" id="group__CUPTI__EVENT__API_1gdafc575cd4614872eba5d99e2f2bc831" shape="rect">
<!-- --></a><span>enum CUpti_EventCollectionMethod</span></dt>
<dd class="description">
<div class="section">
<p>The collection method indicates how an event is collected. </p>
</div>
<div class="enum-members">
<h6 class="enumerator_header">
Values
</h6>
<dl class="enumerator">
<dt><span class="enum-member-name-def">CUPTI_EVENT_COLLECTION_METHOD_PM = <span class="ph ph apiData">0</span></span></dt>
<dd>Event is collected using a hardware global performance monitor. </dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_COLLECTION_METHOD_SM = <span class="ph ph apiData">1</span></span></dt>
<dd>Event is collected using a hardware SM performance monitor. </dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_COLLECTION_METHOD_INSTRUMENTED = <span class="ph ph apiData">2</span></span></dt>
<dd>Event is collected using software instrumentation. </dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_COLLECTION_METHOD_FORCE_INT = <span class="ph ph apiData">0x7fffffff</span></span></dt>
<dd></dd>
</dl>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g54361f7bed89987eabb91300cc218712" id="group__CUPTI__EVENT__API_1g54361f7bed89987eabb91300cc218712" shape="rect">
<!-- --></a><span>enum CUpti_EventCollectionMode</span></dt>
<dd class="description">
<div class="section">
<p>The event collection mode determines the period over which the events within the enabled event groups will be collected. </p>
</div>
<div class="enum-members">
<h6 class="enumerator_header">
Values
</h6>
<dl class="enumerator">
<dt><span class="enum-member-name-def">CUPTI_EVENT_COLLECTION_MODE_CONTINUOUS = <span class="ph ph apiData">0</span></span></dt>
<dd>Events are collected for the entire duration between the cuptiEventGroupEnable and cuptiEventGroupDisable calls. For devices
with compute capability less than 2.0, event values are reset when a kernel is launched. For all other devices event values
are only reset when the events are read. For CUDA toolkit v6.0 and older this was the default mode. From CUDA toolkit v6.5
this mode is supported on Tesla devices only.
</dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_COLLECTION_MODE_KERNEL = <span class="ph ph apiData">1</span></span></dt>
<dd>Events are collected only for the durations of kernel executions that occur between the cuptiEventGroupEnable and cuptiEventGroupDisable
calls. Event collection begins when a kernel execution begins, and stops when kernel execution completes. Event values are
reset to zero when each kernel execution begins. If multiple kernel executions occur between the cuptiEventGroupEnable and
cuptiEventGroupDisable calls then the event values must be read after each kernel launch if those events need to be associated
with the specific kernel launch. This is the default mode from CUDA toolkit v6.5, and it is the only supported mode for non-Tesla
(Quadro, GeForce etc.) devices.
</dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_COLLECTION_MODE_FORCE_INT = <span class="ph ph apiData">0x7fffffff</span></span></dt>
<dd></dd>
</dl>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1ga201105be2a6a988b72e70a643c82ad5" id="group__CUPTI__EVENT__API_1ga201105be2a6a988b72e70a643c82ad5" shape="rect">
<!-- --></a><span>enum CUpti_EventDomainAttribute</span></dt>
<dd class="description">
<div class="section">
<p>Event domain attributes. Except where noted, all the attributes can be read using either <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1gbb745099ffef139c4ee98a1de82fcac2" title="Read an event domain attribute." shape="rect">cuptiDeviceGetEventDomainAttribute</a> or <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1gf8084beb1c692a17616fb99523a044a5" title="Read an event domain attribute." shape="rect">cuptiEventDomainGetAttribute</a>.
</p>
</div>
<div class="enum-members">
<h6 class="enumerator_header">
Values
</h6>
<dl class="enumerator">
<dt><span class="enum-member-name-def">CUPTI_EVENT_DOMAIN_ATTR_NAME = <span class="ph ph apiData">0</span></span></dt>
<dd>Event domain name. Value is a null terminated const c-string. </dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_DOMAIN_ATTR_INSTANCE_COUNT = <span class="ph ph apiData">1</span></span></dt>
<dd>Number of instances of the domain for which event counts will be collected. The domain may have additional instances that
cannot be profiled (see CUPTI_EVENT_DOMAIN_ATTR_TOTAL_INSTANCE_COUNT). Can be read only with <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1gbb745099ffef139c4ee98a1de82fcac2" title="Read an event domain attribute." shape="rect">cuptiDeviceGetEventDomainAttribute</a>. Value is a uint32_t.
</dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_DOMAIN_ATTR_TOTAL_INSTANCE_COUNT = <span class="ph ph apiData">3</span></span></dt>
<dd>Total number of instances of the domain, including instances that cannot be profiled. Use CUPTI_EVENT_DOMAIN_ATTR_INSTANCE_COUNT
to get the number of instances that can be profiled. Can be read only with <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1gbb745099ffef139c4ee98a1de82fcac2" title="Read an event domain attribute." shape="rect">cuptiDeviceGetEventDomainAttribute</a>. Value is a uint32_t.
</dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_DOMAIN_ATTR_COLLECTION_METHOD = <span class="ph ph apiData">4</span></span></dt>
<dd>Collection method used for events contained in the event domain. Value is a <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1gdafc575cd4614872eba5d99e2f2bc831" title="The collection method used for an event." shape="rect">CUpti_EventCollectionMethod</a>.
</dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_DOMAIN_ATTR_FORCE_INT = <span class="ph ph apiData">0x7fffffff</span></span></dt>
<dd></dd>
</dl>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1gc8aaac37b2aefeea5177c0b813806b9f" id="group__CUPTI__EVENT__API_1gc8aaac37b2aefeea5177c0b813806b9f" shape="rect">
<!-- --></a><span>enum CUpti_EventGroupAttribute</span></dt>
<dd class="description">
<div class="section">
<p>Event group attributes. These attributes can be read using <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g573c7e8a0295d36cf0051e27554971a8" title="Read an event group attribute." shape="rect">cuptiEventGroupGetAttribute</a>. Attributes marked [rw] can also be written using <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1gdeea7eb4a79d3c7e85db597f2c98d5ac" title="Write an event group attribute." shape="rect">cuptiEventGroupSetAttribute</a>.
</p>
</div>
<div class="enum-members">
<h6 class="enumerator_header">
Values
</h6>
<dl class="enumerator">
<dt><span class="enum-member-name-def">CUPTI_EVENT_GROUP_ATTR_EVENT_DOMAIN_ID = <span class="ph ph apiData">0</span></span></dt>
<dd>The domain to which the event group is bound. This attribute is set when the first event is added to the group. Value is a
CUpti_EventDomainID.
</dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_GROUP_ATTR_PROFILE_ALL_DOMAIN_INSTANCES = <span class="ph ph apiData">1</span></span></dt>
<dd>[rw] Profile all the instances of the domain for this eventgroup. This feature can be used to get load balancing across all
instances of a domain. Value is an integer.
</dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_GROUP_ATTR_USER_DATA = <span class="ph ph apiData">2</span></span></dt>
<dd>[rw] Reserved for user data. </dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_GROUP_ATTR_NUM_EVENTS = <span class="ph ph apiData">3</span></span></dt>
<dd>Number of events in the group. Value is a uint32_t. </dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_GROUP_ATTR_EVENTS = <span class="ph ph apiData">4</span></span></dt>
<dd>Enumerates events in the group. Value is a pointer to buffer of size sizeof(CUpti_EventID) * num_of_events in the eventgroup.
num_of_events can be queried using CUPTI_EVENT_GROUP_ATTR_NUM_EVENTS.
</dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_GROUP_ATTR_INSTANCE_COUNT = <span class="ph ph apiData">5</span></span></dt>
<dd>Number of instances of the domain bound to this event group that will be counted. Value is a uint32_t. </dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_GROUP_ATTR_FORCE_INT = <span class="ph ph apiData">0x7fffffff</span></span></dt>
<dd></dd>
</dl>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1ge8ea7de2653cc087a9c5399386604528" id="group__CUPTI__EVENT__API_1ge8ea7de2653cc087a9c5399386604528" shape="rect">
<!-- --></a><span>enum CUpti_ReadEventFlags</span></dt>
<dd class="description">
<div class="section">
<p>Flags for <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g31c30e2c86218a3501ae8a21127dec15" title="Read the value for an event in an event group." shape="rect">cuptiEventGroupReadEvent</a> an <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1gbb522fec20a70e3b5d8f819693c4f2dd" title="Read the values for all the events in an event group." shape="rect">cuptiEventGroupReadAllEvents</a>.
</p>
</div>
<div class="enum-members">
<h6 class="enumerator_header">
Values
</h6>
<dl class="enumerator">
<dt><span class="enum-member-name-def">CUPTI_EVENT_READ_FLAG_NONE = <span class="ph ph apiData">0</span></span></dt>
<dd>No flags. </dd>
<dt><span class="enum-member-name-def">CUPTI_EVENT_READ_FLAG_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__EVENT__API_1g430869bc1bfcc11589241bac94774c06" id="group__CUPTI__EVENT__API_1g430869bc1bfcc11589241bac94774c06" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiDeviceEnumEventDomains ( 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__EVENT__API.html#group__CUPTI__EVENT__API_1g8a898bd33ce64d353b79d7d39e74d198" title="ID for an event domain. " shape="rect">CUpti_EventDomainID</a>*<span> </span><span class="keyword keyword apiItemName">domainArray</span> ) </span></dt>
<dd class="description">
<div class="section">Get the event domains 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">domainArray</tt> in bytes, and returns the number of bytes written to <tt class="ph tt code">domainArray</tt></dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">domainArray</span></tt></dt>
<dd>Returns the IDs of the event domains 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">domainArray</tt> are NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Returns the event domains IDs in <tt class="ph tt code">domainArray</tt> for a device. The size of the <tt class="ph tt code">domainArray</tt> buffer is given by <tt class="ph tt code">*arraySizeBytes</tt>. The size of the <tt class="ph tt code">domainArray</tt> buffer must be at least <tt class="ph tt code">numdomains</tt> * sizeof(CUpti_EventDomainID) or else all domains 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">domainArray</tt>.
</p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g631a8f494a7f0f3d254ad49f2040eff5" id="group__CUPTI__EVENT__API_1g631a8f494a7f0f3d254ad49f2040eff5" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiDeviceGetAttribute ( CUdevice<span> </span><span class="keyword keyword apiItemName">device</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g07af1fece58c6f17c48067740034e31b" title="Device attributes. " shape="rect">CUpti_DeviceAttribute</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">Read a device 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">device</span></tt></dt>
<dd>The CUDA device </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">attrib</span></tt></dt>
<dd>The attribute to read </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">valueSize</span></tt></dt>
<dd>Size of buffer pointed by the value, 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 value of the attribute</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">valueSize</tt> or <tt class="ph tt code">value</tt> is NULL, or if <tt class="ph tt code">attrib</tt> is not a device 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>Read a device attribute and return it in <tt class="ph tt code">*value</tt>.
</p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1gbb745099ffef139c4ee98a1de82fcac2" id="group__CUPTI__EVENT__API_1gbb745099ffef139c4ee98a1de82fcac2" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiDeviceGetEventDomainAttribute ( CUdevice<span> </span><span class="keyword keyword apiItemName">device</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g8a898bd33ce64d353b79d7d39e74d198" title="ID for an event domain. " shape="rect">CUpti_EventDomainID</a><span> </span><span class="keyword keyword apiItemName">eventDomain</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1ga201105be2a6a988b72e70a643c82ad5" title="Event domain attributes. " shape="rect">CUpti_EventDomainAttribute</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">Read an event domain 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">device</span></tt></dt>
<dd>The CUDA device </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">eventDomain</span></tt></dt>
<dd>ID of the event domain </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">attrib</span></tt></dt>
<dd>The event domain 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_DEVICE
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_EVENT_DOMAIN_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 an event domain 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 an event domain 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">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1gfebb6c61c0c1f8427e187223d799cda5" id="group__CUPTI__EVENT__API_1gfebb6c61c0c1f8427e187223d799cda5" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiDeviceGetNumEventDomains ( CUdevice<span> </span><span class="keyword keyword apiItemName">device</span>, uint32_t*<span> </span><span class="keyword keyword apiItemName">numDomains</span> ) </span></dt>
<dd class="description">
<div class="section">Get the number of domains 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">numDomains</span></tt></dt>
<dd>Returns the number of domains</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">numDomains</tt> is NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Returns the number of domains in <tt class="ph tt code">numDomains</tt> for a device.
</p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g581c6a513e81f9431854561f43c06f36" id="group__CUPTI__EVENT__API_1g581c6a513e81f9431854561f43c06f36" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiDeviceGetTimestamp ( CUcontext<span> </span><span class="keyword keyword apiItemName">context</span>, uint64_t*<span> </span><span class="keyword keyword apiItemName">timestamp</span> ) </span></dt>
<dd class="description">
<div class="section">Read a device timestamp. </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>A context on the device from which to get the timestamp </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">timestamp</span></tt></dt>
<dd>Returns the device timestamp</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_PARAMETER
<p class="p">is <tt class="ph tt code">timestamp</tt> is NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Returns the device timestamp in <tt class="ph tt code">*timestamp</tt>. The timestamp is reported in nanoseconds and indicates the time since the device was last reset.
</p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g1746f087372090b5289e2512864b8e25" id="group__CUPTI__EVENT__API_1g1746f087372090b5289e2512864b8e25" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiDisableKernelReplayMode ( CUcontext<span> </span><span class="keyword keyword apiItemName">context</span> ) </span></dt>
<dd class="description">
<div class="section">Disable kernel replay mode. </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 </dd>
</dl>
</div>
<div class="section">
<h6 class="return_header">Returns</h6>
<p class="return">
<ul>
<li>CUPTI_SUCCESS
<p class="p"></p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Set profiling mode for the context to non-replay (default) mode. Event collection mode will be set to CUPTI_EVENT_COLLECTION_MODE_KERNEL.
All previously enabled event groups and event group sets will be disabled.
</p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g2a99f01445e5ba2f7e4ba89796e9b20f" id="group__CUPTI__EVENT__API_1g2a99f01445e5ba2f7e4ba89796e9b20f" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEnableKernelReplayMode ( CUcontext<span> </span><span class="keyword keyword apiItemName">context</span> ) </span></dt>
<dd class="description">
<div class="section">Enable kernel replay mode. </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 </dd>
</dl>
</div>
<div class="section">
<h6 class="return_header">Returns</h6>
<p class="return">
<ul>
<li>CUPTI_SUCCESS
<p class="p"></p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Set profiling mode for the context to replay mode. In this mode, any number of events can be collected in one run of the kernel.
The event collection mode will automatically switch to CUPTI_EVENT_COLLECTION_MODE_KERNEL. In this mode, <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1gdfa8bf3fa3d6c6445f2cb874d0b54cf3" title="Set the event collection mode." shape="rect">cuptiSetEventCollectionMode</a> will return CUPTI_ERROR_INVALID_OPERATION.
</p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><ul class="ul">
<li class="li">
<p class="p"><strong class="ph b">Kernels</strong> might take longer to run if many events are enabled.
</p>
</li>
<li class="li">
<p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</li>
</ul>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g3f6f5236a79cafda724796dc2d599ad1" id="group__CUPTI__EVENT__API_1g3f6f5236a79cafda724796dc2d599ad1" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEnumEventDomains ( size_t*<span> </span><span class="keyword keyword apiItemName">arraySizeBytes</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g8a898bd33ce64d353b79d7d39e74d198" title="ID for an event domain. " shape="rect">CUpti_EventDomainID</a>*<span> </span><span class="keyword keyword apiItemName">domainArray</span> ) </span></dt>
<dd class="description">
<div class="section">Get the event domains 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">domainArray</tt> in bytes, and returns the number of bytes written to <tt class="ph tt code">domainArray</tt></dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">domainArray</span></tt></dt>
<dd>Returns all the event domains</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">domainArray</tt> are NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Returns all the event domains available on any CUDA-capable device. Event domain IDs are returned in <tt class="ph tt code">domainArray</tt>. The size of the <tt class="ph tt code">domainArray</tt> buffer is given by <tt class="ph tt code">*arraySizeBytes</tt>. The size of the <tt class="ph tt code">domainArray</tt> buffer must be at least <tt class="ph tt code">numDomains</tt> * sizeof(CUpti_EventDomainID) or all domains 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">domainArray</tt>.
</p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1gd23627587d3f21c3d637edd562e362d3" id="group__CUPTI__EVENT__API_1gd23627587d3f21c3d637edd562e362d3" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEventDomainEnumEvents ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g8a898bd33ce64d353b79d7d39e74d198" title="ID for an event domain. " shape="rect">CUpti_EventDomainID</a><span> </span><span class="keyword keyword apiItemName">eventDomain</span>, size_t*<span> </span><span class="keyword keyword apiItemName">arraySizeBytes</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">eventArray</span> ) </span></dt>
<dd class="description">
<div class="section">Get the events in a domain. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">eventDomain</span></tt></dt>
<dd>ID of the event domain </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">arraySizeBytes</span></tt></dt>
<dd>The size of <tt class="ph tt code">eventArray</tt> in bytes, and returns the number of bytes written to <tt class="ph tt code">eventArray</tt></dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">eventArray</span></tt></dt>
<dd>Returns the IDs of the events in the domain</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_EVENT_DOMAIN_ID
<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">eventArray</tt> are NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Returns the event IDs in <tt class="ph tt code">eventArray</tt> for a domain. The size of the <tt class="ph tt code">eventArray</tt> buffer is given by <tt class="ph tt code">*arraySizeBytes</tt>. The size of the <tt class="ph tt code">eventArray</tt> buffer must be at least <tt class="ph tt code">numdomainevents</tt> * sizeof(CUpti_EventID) or else all events 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">eventArray</tt>.
</p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1gf8084beb1c692a17616fb99523a044a5" id="group__CUPTI__EVENT__API_1gf8084beb1c692a17616fb99523a044a5" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEventDomainGetAttribute ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g8a898bd33ce64d353b79d7d39e74d198" title="ID for an event domain. " shape="rect">CUpti_EventDomainID</a><span> </span><span class="keyword keyword apiItemName">eventDomain</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1ga201105be2a6a988b72e70a643c82ad5" title="Event domain attributes. " shape="rect">CUpti_EventDomainAttribute</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">Read an event domain 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">eventDomain</span></tt></dt>
<dd>ID of the event domain </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">attrib</span></tt></dt>
<dd>The event domain 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_EVENT_DOMAIN_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 an event domain 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 an event domain 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">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g7341de781de833b65e0748b37acc802f" id="group__CUPTI__EVENT__API_1g7341de781de833b65e0748b37acc802f" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEventDomainGetNumEvents ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g8a898bd33ce64d353b79d7d39e74d198" title="ID for an event domain. " shape="rect">CUpti_EventDomainID</a><span> </span><span class="keyword keyword apiItemName">eventDomain</span>, uint32_t*<span> </span><span class="keyword keyword apiItemName">numEvents</span> ) </span></dt>
<dd class="description">
<div class="section">Get number of events in a domain. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">eventDomain</span></tt></dt>
<dd>ID of the event domain </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">numEvents</span></tt></dt>
<dd>Returns the number of events in the domain</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_EVENT_DOMAIN_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> for a domain.
</p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1gec3d52db48a14aef9e8b35785bb4d60e" id="group__CUPTI__EVENT__API_1gec3d52db48a14aef9e8b35785bb4d60e" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEventGetAttribute ( <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">event</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g232a6c540682383abd4cee93ee18e6aa" title="Event attributes. " shape="rect">CUpti_EventAttribute</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 an event 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">event</span></tt></dt>
<dd>ID of the event </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">attrib</span></tt></dt>
<dd>The event 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_EVENT_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 an event 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 an event 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">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1gd27429cf327f99db6b49e88548f801d4" id="group__CUPTI__EVENT__API_1gd27429cf327f99db6b49e88548f801d4" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEventGetIdFromName ( CUdevice<span> </span><span class="keyword keyword apiItemName">device</span>, const char*<span> </span><span class="keyword keyword apiItemName">eventName</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">event</span> ) </span></dt>
<dd class="description">
<div class="section">Find an event 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">eventName</span></tt></dt>
<dd>The name of the event to find </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">event</span></tt></dt>
<dd>Returns the ID of the found event or undefined if unable to find the event</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_EVENT_NAME
<p class="p">if unable to find an event with name <tt class="ph tt code">eventName</tt>. In this case <tt class="ph tt code">*event</tt> is undefined
</p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">eventName</tt> or <tt class="ph tt code">event</tt> are NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Find an event by name and return the event ID in <tt class="ph tt code">*event</tt>.
</p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g08b80dcd21975492c7d756eac59d8b6a" id="group__CUPTI__EVENT__API_1g08b80dcd21975492c7d756eac59d8b6a" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEventGroupAddEvent ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</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">event</span> ) </span></dt>
<dd class="description">
<div class="section">Add an event to an event group. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">eventGroup</span></tt></dt>
<dd>The event group </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">event</span></tt></dt>
<dd>The event to add to the group</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_EVENT_ID
<p class="p"></p>
</li>
<li>CUPTI_ERROR_OUT_OF_MEMORY
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_OPERATION
<p class="p">if <tt class="ph tt code">eventGroup</tt> is enabled
</p>
</li>
<li>CUPTI_ERROR_NOT_COMPATIBLE
<p class="p">if <tt class="ph tt code">event</tt> belongs to a different event domain than the events already in <tt class="ph tt code">eventGroup</tt>, or if a device limitation prevents <tt class="ph tt code">event</tt> from being collected at the same time as the events already in <tt class="ph tt code">eventGroup</tt></p>
</li>
<li>CUPTI_ERROR_MAX_LIMIT_REACHED
<p class="p">if <tt class="ph tt code">eventGroup</tt> is full
</p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">eventGroup</tt> is NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Add an event to an event group. The event add can fail for a number of reasons:
<ul class="ul">
<li class="li">
<p class="p">The event group is enabled </p>
</li>
<li class="li">
<p class="p">The event does not belong to the same event domain as the events that are already in the event group </p>
</li>
<li class="li">
<p class="p">Device limitations on the events that can belong to the same group </p>
</li>
<li class="li">
<p class="p">The event group is full</p>
</li>
</ul>
</p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g9d5cad301581eb32e94ffc7c1b9afc9d" id="group__CUPTI__EVENT__API_1g9d5cad301581eb32e94ffc7c1b9afc9d" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEventGroupCreate ( CUcontext<span> </span><span class="keyword keyword apiItemName">context</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a>*<span> </span><span class="keyword keyword apiItemName">eventGroup</span>, uint32_t<span> </span><span class="keyword keyword apiItemName">flags</span> ) </span></dt>
<dd class="description">
<div class="section">Create a new event group for a context. </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 the event group </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">eventGroup</span></tt></dt>
<dd>Returns the new event group </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">flags</span></tt></dt>
<dd>Reserved - must be zero</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_OUT_OF_MEMORY
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">eventGroup</tt> is NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Creates a new event group for <tt class="ph tt code">context</tt> and returns the new group in <tt class="ph tt code">*eventGroup</tt>.
</p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><ul class="ul">
<li class="li">
<p class="p"><tt class="ph tt code">flags</tt> are reserved for future use and should be set to zero.
</p>
</li>
<li class="li">
<p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</li>
</ul>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g99f31aed86f5c117ef07409982f25bd0" id="group__CUPTI__EVENT__API_1g99f31aed86f5c117ef07409982f25bd0" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEventGroupDestroy ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</span> ) </span></dt>
<dd class="description">
<div class="section">Destroy an event group. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">eventGroup</span></tt></dt>
<dd>The event group to destroy</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_OPERATION
<p class="p">if the event group is enabled </p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if eventGroup is NULL </p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Destroy an <tt class="ph tt code">eventGroup</tt> and free its resources. An event group cannot be destroyed if it is enabled.
</p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g63365c4bb038575bcd6b1a2ba13649d4" id="group__CUPTI__EVENT__API_1g63365c4bb038575bcd6b1a2ba13649d4" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEventGroupDisable ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</span> ) </span></dt>
<dd class="description">
<div class="section">Disable an event group. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">eventGroup</span></tt></dt>
<dd>The event group</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_HARDWARE
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">eventGroup</tt> is NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Disable an event group. Disabling an event group stops collection of events contained in the group. </p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g1b72c6cea4de6cc0ebee2c0b41453223" id="group__CUPTI__EVENT__API_1g1b72c6cea4de6cc0ebee2c0b41453223" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEventGroupEnable ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</span> ) </span></dt>
<dd class="description">
<div class="section">Enable an event group. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">eventGroup</span></tt></dt>
<dd>The event group</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_HARDWARE
<p class="p"></p>
</li>
<li>CUPTI_ERROR_NOT_READY
<p class="p">if <tt class="ph tt code">eventGroup</tt> does not contain any events
</p>
</li>
<li>CUPTI_ERROR_NOT_COMPATIBLE
<p class="p">if <tt class="ph tt code">eventGroup</tt> cannot be enabled due to other already enabled event groups
</p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">eventGroup</tt> is NULL
</p>
</li>
<li>CUPTI_ERROR_HARDWARE_BUSY
<p class="p">if another client is profiling and hardware is busy </p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Enable an event group. Enabling an event group zeros the value of all the events in the group and then starts collection of
those events.
</p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g573c7e8a0295d36cf0051e27554971a8" id="group__CUPTI__EVENT__API_1g573c7e8a0295d36cf0051e27554971a8" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEventGroupGetAttribute ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1gc8aaac37b2aefeea5177c0b813806b9f" title="Event group attributes. " shape="rect">CUpti_EventGroupAttribute</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">Read an event group 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">eventGroup</span></tt></dt>
<dd>The event group </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">attrib</span></tt></dt>
<dd>The attribute to read </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">valueSize</span></tt></dt>
<dd>Size of buffer pointed by the value, 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 value of the attribute</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_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 an eventgroup 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>Read an event group attribute and return it in <tt class="ph tt code">*value</tt>.
</p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe but client must guard against simultaneous destruction or modification of <tt class="ph tt code">eventGroup</tt> (for example, client must guard against simultaneous calls to <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g99f31aed86f5c117ef07409982f25bd0" title="Destroy an event group." shape="rect">cuptiEventGroupDestroy</a>, <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g08b80dcd21975492c7d756eac59d8b6a" title="Add an event to an event group." shape="rect">cuptiEventGroupAddEvent</a>, etc.), and must guard against simultaneous destruction of the context in which <tt class="ph tt code">eventGroup</tt> was created (for example, client must guard against simultaneous calls to cudaDeviceReset, cuCtxDestroy, etc.).
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1gbb522fec20a70e3b5d8f819693c4f2dd" id="group__CUPTI__EVENT__API_1gbb522fec20a70e3b5d8f819693c4f2dd" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEventGroupReadAllEvents ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1ge8ea7de2653cc087a9c5399386604528" title="Flags for cuptiEventGroupReadEvent an cuptiEventGroupReadAllEvents. " shape="rect">CUpti_ReadEventFlags</a><span> </span><span class="keyword keyword apiItemName">flags</span>, size_t*<span> </span><span class="keyword keyword apiItemName">eventValueBufferSizeBytes</span>, uint64_t*<span> </span><span class="keyword keyword apiItemName">eventValueBuffer</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">numEventIdsRead</span> ) </span></dt>
<dd class="description">
<div class="section">Read the values for all the events in an event group. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">eventGroup</span></tt></dt>
<dd>The event group </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">flags</span></tt></dt>
<dd>Flags controlling the reading mode </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">eventValueBufferSizeBytes</span></tt></dt>
<dd>The size of <tt class="ph tt code">eventValueBuffer</tt> in bytes, and returns the number of bytes written to <tt class="ph tt code">eventValueBuffer</tt></dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">eventValueBuffer</span></tt></dt>
<dd>Returns the event values </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 in the same order as the values return in eventValueBuffer. </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">numEventIdsRead</span></tt></dt>
<dd>Returns the number of event IDs returned in <tt class="ph tt code">eventIdArray</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_HARDWARE
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_OPERATION
<p class="p">if <tt class="ph tt code">eventGroup</tt> is disabled
</p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">eventGroup</tt>, <tt class="ph tt code">eventValueBufferSizeBytes</tt>, <tt class="ph tt code">eventValueBuffer</tt>, <tt class="ph tt code">eventIdArraySizeBytes</tt>, <tt class="ph tt code">eventIdArray</tt> or <tt class="ph tt code">numEventIdsRead</tt> is NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Read the values for all the events in an event group. The event values are returned in the <tt class="ph tt code">eventValueBuffer</tt> buffer. <tt class="ph tt code">eventValueBufferSizeBytes</tt> indicates the size of <tt class="ph tt code">eventValueBuffer</tt>. The buffer must be at least (sizeof(uint64) * number of events in group) if <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1ggc8aaac37b2aefeea5177c0b813806b9f776be3128e2ab834a96ec9ff16dda611" shape="rect">CUPTI_EVENT_GROUP_ATTR_PROFILE_ALL_DOMAIN_INSTANCES</a> is not set on the group containing the events. The buffer must be at least (sizeof(uint64) * number of domain instances *
number of events in group) if <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1ggc8aaac37b2aefeea5177c0b813806b9f776be3128e2ab834a96ec9ff16dda611" shape="rect">CUPTI_EVENT_GROUP_ATTR_PROFILE_ALL_DOMAIN_INSTANCES</a> is set on the group.
</p>
<p class="p">The data format returned in <tt class="ph tt code">eventValueBuffer</tt> is:
<ul class="ul">
<li class="li">
<p class="p">domain instance 0: event0 event1 ... eventN</p>
</li>
<li class="li">
<p class="p">domain instance 1: event0 event1 ... eventN</p>
</li>
<li class="li">
<p class="p">...</p>
</li>
<li class="li">
<p class="p">domain instance M: event0 event1 ... eventN</p>
</li>
</ul>
</p>
<p class="p">The event order in <tt class="ph tt code">eventValueBuffer</tt> is returned in <tt class="ph tt code">eventIdArray</tt>. The size of <tt class="ph tt code">eventIdArray</tt> is specified in <tt class="ph tt code">eventIdArraySizeBytes</tt>. The size should be at least (sizeof(CUpti_EventID) * number of events in group).
</p>
<p class="p">If any instance of any event counter overflows, the value returned for that event instance will be <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g4f280929637a726da2ba4c907e5b9ba1" title="The overflow value for a CUPTI event." shape="rect">CUPTI_EVENT_OVERFLOW</a>.
</p>
<p class="p">The only allowed value for <tt class="ph tt code">flags</tt> is <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1gge8ea7de2653cc087a9c5399386604528726bee26555027440a8b4acdf6ff13a3" shape="rect">CUPTI_EVENT_READ_FLAG_NONE</a>.
</p>
<p class="p">Reading events from a disabled event group is not allowed. After being read, an event's value is reset to zero. </p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe but client must guard against simultaneous destruction or modification of <tt class="ph tt code">eventGroup</tt> (for example, client must guard against simultaneous calls to <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g99f31aed86f5c117ef07409982f25bd0" title="Destroy an event group." shape="rect">cuptiEventGroupDestroy</a>, <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g08b80dcd21975492c7d756eac59d8b6a" title="Add an event to an event group." shape="rect">cuptiEventGroupAddEvent</a>, etc.), and must guard against simultaneous destruction of the context in which <tt class="ph tt code">eventGroup</tt> was created (for example, client must guard against simultaneous calls to cudaDeviceReset, cuCtxDestroy, etc.). If <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1gbda509844936046694b6081cffa4886d" title="Zero all the event counts in an event group." shape="rect">cuptiEventGroupResetAllEvents</a> is called simultaneously with this function, then returned event values are undefined.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g31c30e2c86218a3501ae8a21127dec15" id="group__CUPTI__EVENT__API_1g31c30e2c86218a3501ae8a21127dec15" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEventGroupReadEvent ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1ge8ea7de2653cc087a9c5399386604528" title="Flags for cuptiEventGroupReadEvent an cuptiEventGroupReadAllEvents. " shape="rect">CUpti_ReadEventFlags</a><span> </span><span class="keyword keyword apiItemName">flags</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">event</span>, size_t*<span> </span><span class="keyword keyword apiItemName">eventValueBufferSizeBytes</span>, uint64_t*<span> </span><span class="keyword keyword apiItemName">eventValueBuffer</span> ) </span></dt>
<dd class="description">
<div class="section">Read the value for an event in an event group. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">eventGroup</span></tt></dt>
<dd>The event group </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">flags</span></tt></dt>
<dd>Flags controlling the reading mode </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">event</span></tt></dt>
<dd>The event to read </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">eventValueBufferSizeBytes</span></tt></dt>
<dd>The size of <tt class="ph tt code">eventValueBuffer</tt> in bytes, and returns the number of bytes written to <tt class="ph tt code">eventValueBuffer</tt></dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">eventValueBuffer</span></tt></dt>
<dd>Returns the event value(s)</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_EVENT_ID
<p class="p"></p>
</li>
<li>CUPTI_ERROR_HARDWARE
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_OPERATION
<p class="p">if <tt class="ph tt code">eventGroup</tt> is disabled
</p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">eventGroup</tt>, <tt class="ph tt code">eventValueBufferSizeBytes</tt> or <tt class="ph tt code">eventValueBuffer</tt> is NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Read the value for an event in an event group. The event value is returned in the <tt class="ph tt code">eventValueBuffer</tt> buffer. <tt class="ph tt code">eventValueBufferSizeBytes</tt> indicates the size of the <tt class="ph tt code">eventValueBuffer</tt> buffer. The buffer must be at least sizeof(uint64) if <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1ggc8aaac37b2aefeea5177c0b813806b9f776be3128e2ab834a96ec9ff16dda611" shape="rect">CUPTI_EVENT_GROUP_ATTR_PROFILE_ALL_DOMAIN_INSTANCES</a> is not set on the group containing the event. The buffer must be at least (sizeof(uint64) * number of domain instances) if
<a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1ggc8aaac37b2aefeea5177c0b813806b9f776be3128e2ab834a96ec9ff16dda611" shape="rect">CUPTI_EVENT_GROUP_ATTR_PROFILE_ALL_DOMAIN_INSTANCES</a> is set on the group.
</p>
<p class="p">If any instance of an event counter overflows, the value returned for that event instance will be <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g4f280929637a726da2ba4c907e5b9ba1" title="The overflow value for a CUPTI event." shape="rect">CUPTI_EVENT_OVERFLOW</a>.
</p>
<p class="p">The only allowed value for <tt class="ph tt code">flags</tt> is <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1gge8ea7de2653cc087a9c5399386604528726bee26555027440a8b4acdf6ff13a3" shape="rect">CUPTI_EVENT_READ_FLAG_NONE</a>.
</p>
<p class="p">Reading an event from a disabled event group is not allowed. After being read, an event's value is reset to zero. </p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe but client must guard against simultaneous destruction or modification of <tt class="ph tt code">eventGroup</tt> (for example, client must guard against simultaneous calls to <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g99f31aed86f5c117ef07409982f25bd0" title="Destroy an event group." shape="rect">cuptiEventGroupDestroy</a>, <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g08b80dcd21975492c7d756eac59d8b6a" title="Add an event to an event group." shape="rect">cuptiEventGroupAddEvent</a>, etc.), and must guard against simultaneous destruction of the context in which <tt class="ph tt code">eventGroup</tt> was created (for example, client must guard against simultaneous calls to cudaDeviceReset, cuCtxDestroy, etc.). If <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1gbda509844936046694b6081cffa4886d" title="Zero all the event counts in an event group." shape="rect">cuptiEventGroupResetAllEvents</a> is called simultaneously with this function, then returned event values are undefined.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g4d7555b6c900a27dee2ee3465701bb96" id="group__CUPTI__EVENT__API_1g4d7555b6c900a27dee2ee3465701bb96" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEventGroupRemoveAllEvents ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</span> ) </span></dt>
<dd class="description">
<div class="section">Remove all events from an event group. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">eventGroup</span></tt></dt>
<dd>The event group</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_OPERATION
<p class="p">if <tt class="ph tt code">eventGroup</tt> is enabled
</p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">eventGroup</tt> is NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Remove all events from an event group. Events cannot be removed if the event group is enabled. </p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g0da4bfbdde94a0fcb5bba2f1c69aa1f0" id="group__CUPTI__EVENT__API_1g0da4bfbdde94a0fcb5bba2f1c69aa1f0" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEventGroupRemoveEvent ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</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">event</span> ) </span></dt>
<dd class="description">
<div class="section">Remove an event from an event group. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">eventGroup</span></tt></dt>
<dd>The event group </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">event</span></tt></dt>
<dd>The event to remove from the group</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_EVENT_ID
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_OPERATION
<p class="p">if <tt class="ph tt code">eventGroup</tt> is enabled
</p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">eventGroup</tt> is NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Remove <tt class="ph tt code">event</tt> from the an event group. The event cannot be removed if the event group is enabled.
</p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1gbda509844936046694b6081cffa4886d" id="group__CUPTI__EVENT__API_1gbda509844936046694b6081cffa4886d" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEventGroupResetAllEvents ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</span> ) </span></dt>
<dd class="description">
<div class="section">Zero all the event counts in an event group. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">eventGroup</span></tt></dt>
<dd>The event group</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_HARDWARE
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">eventGroup</tt> is NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Zero all the event counts in an event group. </p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe but client must guard against simultaneous destruction or modification of <tt class="ph tt code">eventGroup</tt> (for example, client must guard against simultaneous calls to <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g99f31aed86f5c117ef07409982f25bd0" title="Destroy an event group." shape="rect">cuptiEventGroupDestroy</a>, <a class="xref" href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g08b80dcd21975492c7d756eac59d8b6a" title="Add an event to an event group." shape="rect">cuptiEventGroupAddEvent</a>, etc.), and must guard against simultaneous destruction of the context in which <tt class="ph tt code">eventGroup</tt> was created (for example, client must guard against simultaneous calls to cudaDeviceReset, cuCtxDestroy, etc.).
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1gdeea7eb4a79d3c7e85db597f2c98d5ac" id="group__CUPTI__EVENT__API_1gdeea7eb4a79d3c7e85db597f2c98d5ac" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEventGroupSetAttribute ( <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g649750f363752bccbf9e98582d5f6925" title="A group of events. " shape="rect">CUpti_EventGroup</a><span> </span><span class="keyword keyword apiItemName">eventGroup</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1gc8aaac37b2aefeea5177c0b813806b9f" title="Event group attributes. " shape="rect">CUpti_EventGroupAttribute</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">Write an event group 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">eventGroup</span></tt></dt>
<dd>The event group </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">attrib</span></tt></dt>
<dd>The attribute to write </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">valueSize</span></tt></dt>
<dd>The size, in bytes, of the value </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">value</span></tt></dt>
<dd>The attribute value to write</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_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 an event group attribute, or if <tt class="ph tt code">attrib</tt> is not a writable attribute
</p>
</li>
<li>CUPTI_ERROR_PARAMETER_SIZE_NOT_SUFFICIENT
<p class="p">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>Write an event group attribute. </p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g0dc70d03c11800d734801a3d4fdac073" id="group__CUPTI__EVENT__API_1g0dc70d03c11800d734801a3d4fdac073" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEventGroupSetDisable ( <a href="structCUpti__EventGroupSet.html#structCUpti__EventGroupSet" title="A set of event groups. " shape="rect">CUpti_EventGroupSet</a>*<span> </span><span class="keyword keyword apiItemName">eventGroupSet</span> ) </span></dt>
<dd class="description">
<div class="section">Disable an event group set. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">eventGroupSet</span></tt></dt>
<dd>The pointer to the event group set </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_HARDWARE
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">eventGroupSet</tt> is NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Disable a set of event groups. Disabling a set of event groups stops collection of events contained in the groups. </p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><ul class="ul">
<li class="li">
<p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</li>
<li class="li">
<p class="p"><strong class="ph b">If</strong> this call fails, some of the event groups in the set may be disabled and other event groups may remain enabled.
</p>
</li>
</ul>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1gff1d5b7675cc2748eadae7348e30cbfc" id="group__CUPTI__EVENT__API_1gff1d5b7675cc2748eadae7348e30cbfc" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEventGroupSetEnable ( <a href="structCUpti__EventGroupSet.html#structCUpti__EventGroupSet" title="A set of event groups. " shape="rect">CUpti_EventGroupSet</a>*<span> </span><span class="keyword keyword apiItemName">eventGroupSet</span> ) </span></dt>
<dd class="description">
<div class="section">Enable an event group set. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">eventGroupSet</span></tt></dt>
<dd>The pointer to the event group set</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_HARDWARE
<p class="p"></p>
</li>
<li>CUPTI_ERROR_NOT_READY
<p class="p">if <tt class="ph tt code">eventGroup</tt> does not contain any events
</p>
</li>
<li>CUPTI_ERROR_NOT_COMPATIBLE
<p class="p">if <tt class="ph tt code">eventGroup</tt> cannot be enabled due to other already enabled event groups
</p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">eventGroupSet</tt> is NULL
</p>
</li>
<li>CUPTI_ERROR_HARDWARE_BUSY
<p class="p">if other client is profiling and hardware is busy </p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Enable a set of event groups. Enabling a set of event groups zeros the value of all the events in all the groups and then
starts collection of those events.
</p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g0fd307d429d4e37f61f45472de069910" id="group__CUPTI__EVENT__API_1g0fd307d429d4e37f61f45472de069910" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEventGroupSetsCreate ( CUcontext<span> </span><span class="keyword keyword apiItemName">context</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>, <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 events, get the grouping that indicates the number of passes and the event groups necessary to collect the events.
</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">eventIdArraySizeBytes</span></tt></dt>
<dd>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>Array of event IDs that need to be grouped </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_EVENT_ID
<p class="p"></p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">eventIdArray</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>The number of events that can be collected simultaneously varies by device and by the type of the events. When events can
be collected simultaneously, they may need to be grouped into multiple event groups because they are from different event
domains. This function takes a set of events and determines how many passes are required to collect all those events, and
which events can be collected simultaneously in each pass.
</p>
<p class="p">The <a class="xref" href="structCUpti__EventGroupSets.html#structCUpti__EventGroupSets" title="A set of event group sets." shape="rect">CUpti_EventGroupSets</a> returned in <tt class="ph tt code">eventGroupPasses</tt> indicates how many passes are required to collect the events with the <tt class="ph tt code">numSets</tt> field. Within each event group set, the <tt class="ph tt code">sets</tt> array indicates the event groups that should be collected on each pass.
</p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe, but client must guard against another thread simultaneously destroying <tt class="ph tt code">context</tt>.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1gcf75cc84517241e4c40c21c2f312e2ad" id="group__CUPTI__EVENT__API_1gcf75cc84517241e4c40c21c2f312e2ad" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiEventGroupSetsDestroy ( <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">eventGroupSets</span> ) </span></dt>
<dd class="description">
<div class="section">Destroy a CUpti_EventGroupSets object. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">eventGroupSets</span></tt></dt>
<dd>The object to destroy</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_OPERATION
<p class="p">if any of the event groups contained in the sets is enabled </p>
</li>
<li>CUPTI_ERROR_INVALID_PARAMETER
<p class="p">if <tt class="ph tt code">eventGroupSets</tt> is NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Destroy a <a class="xref" href="structCUpti__EventGroupSets.html#structCUpti__EventGroupSets" title="A set of event group sets." shape="rect">CUpti_EventGroupSets</a> object.
</p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1g93814f61b681f440b43c8130f72a99f9" id="group__CUPTI__EVENT__API_1g93814f61b681f440b43c8130f72a99f9" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiGetNumEventDomains ( uint32_t*<span> </span><span class="keyword keyword apiItemName">numDomains</span> ) </span></dt>
<dd class="description">
<div class="section">Get the number of event domains 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">numDomains</span></tt></dt>
<dd>Returns the number of domains</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">numDomains</tt> is NULL
</p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Returns the total number of event domains available on any CUDA-capable device. </p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUPTI__EVENT__API_1gdfa8bf3fa3d6c6445f2cb874d0b54cf3" id="group__CUPTI__EVENT__API_1gdfa8bf3fa3d6c6445f2cb874d0b54cf3" shape="rect">
<!-- --></a><span><a href="group__CUPTI__RESULT__API.html#group__CUPTI__RESULT__API_1g8c54bf95108e67d858f37fcf76c88714" title="CUPTI result codes. " shape="rect">CUptiResult</a> cuptiSetEventCollectionMode ( CUcontext<span> </span><span class="keyword keyword apiItemName">context</span>, <a href="group__CUPTI__EVENT__API.html#group__CUPTI__EVENT__API_1g54361f7bed89987eabb91300cc218712" title="Event collection modes. " shape="rect">CUpti_EventCollectionMode</a><span> </span><span class="keyword keyword apiItemName">mode</span> ) </span></dt>
<dd class="description">
<div class="section">Set the event collection mode. </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 </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">mode</span></tt></dt>
<dd>The event collection mode</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_OPERATION
<p class="p">if called when replay mode is enabled </p>
</li>
<li>CUPTI_ERROR_NOT_SUPPORTED
<p class="p">if mode is not supported on the device </p>
</li>
</ul>
</p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Set the event collection mode for a <tt class="ph tt code">context</tt>. The <tt class="ph tt code">mode</tt> controls the event collection behavior of all events in event groups created in the <tt class="ph tt code">context</tt>. This API is invalid in kernel replay mode.
</p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p"><strong class="ph b">Thread-safety</strong>: this function is thread safe.
</p>
</div>
</p>
<p class="p"></p>
</div>
</dd>
</dl>
</div>
</div>
<hr id="contents-end"></hr>
</article>
</div>
</div>
<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/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>
<script type="text/javascript">var switchTo5x=true;</script><script type="text/javascript" src="http://w.sharethis.com/button/buttons.js"></script><script type="text/javascript">stLight.options({publisher: "998dc202-a267-4d8e-bce9-14debadb8d92", doNotHash: false, doNotCopy: false, hashAddressBar: false});</script></body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
nonfree-release
>
by-pkgid
>
d44b02ea46d82d6a48df31bbd1a088f3
>
files
>
1218
