1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
|
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>NV::Rules::IAction — NsightCompute 12.4 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/design-style.b7bb847fb20b106c3d81b95245e65545.min.css" type="text/css" />
<link rel="stylesheet" href="../_static/omni-style.css" type="text/css" />
<link rel="stylesheet" href="../_static/api-styles.css" type="text/css" />
<link rel="shortcut icon" href="../_static/nsight-compute.ico"/>
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/mermaid-init.js"></script>
<script src="../_static/design-tabs.js"></script>
<script src="../_static/version.js"></script>
<script src="../_static/social-media.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="NV::Rules::IBaseContext" href="classNV_1_1Rules_1_1IBaseContext.html" />
<link rel="prev" title="NV::Rules" href="namespaceNV_1_1Rules.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html">
<img src="../_static/nsight-compute.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Nsight Compute</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../ReleaseNotes/index.html">1. Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ProfilingGuide/index.html">2. Kernel Profiling Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../NsightCompute/index.html">3. Nsight Compute</a></li>
<li class="toctree-l1"><a class="reference internal" href="../NsightComputeCli/index.html">4. Nsight Compute CLI</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer Interfaces</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../CustomizationGuide/index.html">1. Customization Guide</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../NvRulesAPI/index.html">2. NvRules API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="modules.html">2.1. Modules</a></li>
<li class="toctree-l2"><a class="reference internal" href="data-structures.html">2.2. Data Structures</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="namespaces.html">2.3. Namespaces</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="namespaceNV.html">2.3.1. NV</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="namespaceNV_1_1Rules.html">Rules</a><ul class="current">
<li class="toctree-l5 current"><a class="current reference internal" href="#">IAction</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1IBaseContext.html">IBaseContext</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1IContext.html">IContext</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1IController.html">IController</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1IEvaluator.html">IEvaluator</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1IFrontend.html">IFrontend</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1IMessageVault.html">IMessageVault</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1IMetric.html">IMetric</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1INvtxDomainInfo.html">INvtxDomainInfo</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1INvtxRange.html">INvtxRange</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1INvtxState.html">INvtxState</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1IRange.html">IRange</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1ISourceInfo.html">ISourceInfo</a></li>
<li class="toctree-l5"><a class="reference internal" href="namespaceNV_1_1Rules.html#enumerations">Enumerations</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Training</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Training/index.html">Training</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Release Information</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Archives/index.html">Archives</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Copyright and Licenses</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../CopyrightAndLicenses/index.html">Copyright and Licenses</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">NsightCompute</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> »</li>
<li><a href="../NvRulesAPI/index.html"><span class="section-number">2. </span>NvRules API</a> »</li>
<li><a href="namespaces.html"><span class="section-number">2.3. </span>Namespaces</a> »</li>
<li><a href="namespaceNV.html"><span class="section-number">2.3.1. </span>NV</a> »</li>
<li><a href="namespaceNV_1_1Rules.html">NV::Rules</a> »</li>
<li>NV::Rules::IAction</li>
<li class="wy-breadcrumbs-aside">
</li>
<li class="wy-breadcrumbs-aside">
<span>v2024.1.1 |</span>
<a href="https://developer.nvidia.com/nsight-compute-history" class="reference external">Archive</a>
<span> </span>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="nv-rules-iaction">
<h1>NV::Rules::IAction<a class="headerlink" href="#nv-rules-iaction" title="Permalink to this headline"></a></h1>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules7IActionE">
<span id="_CPPv3N2NV5Rules7IActionE"></span><span id="_CPPv2N2NV5Rules7IActionE"></span><span id="NV::Rules::IAction"></span><span class="target" id="classnv_1_1rules_1_1iaction"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">IAction</span></span></span><a class="headerlink" href="#_CPPv4N2NV5Rules7IActionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Action interface. </p>
<p>Represents an activity such as a CUDA kernel on a single range, for which zero or more metrics were collected </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric-h3 rubric" id="breathe-section-title-public-types">Public Types</p>
<dl class="cpp enum-class">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules7IAction8NameBaseE">
<span id="_CPPv3N2NV5Rules7IAction8NameBaseE"></span><span id="_CPPv2N2NV5Rules7IAction8NameBaseE"></span><span class="target" id="classnv_1_1rules_1_1iaction_1a9e643b707ad8c701f6f2a29ecac6b108"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">NameBase</span></span></span><a class="headerlink" href="#_CPPv4N2NV5Rules7IAction8NameBaseE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Basis for action names. </p>
<p>The basis determines how the action name is represented when calling name. <code class="docutils literal notranslate"><span class="pre">FUNCTION</span></code> is the minimal base name without parameters or return value. <code class="docutils literal notranslate"><span class="pre">DEMANGLED</span></code> is the demangled name, including parameters and return value. <code class="docutils literal notranslate"><span class="pre">MANGLED</span></code> is the mangled name, including parameters and return value. </p>
<p><em>Values:</em></p>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules7IAction8NameBase8FUNCTIONE">
<span id="_CPPv3N2NV5Rules7IAction8NameBase8FUNCTIONE"></span><span id="_CPPv2N2NV5Rules7IAction8NameBase8FUNCTIONE"></span><span class="target" id="classnv_1_1rules_1_1iaction_1a9e643b707ad8c701f6f2a29ecac6b108a6a72a6a776662a244f82d31e9274a07b"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FUNCTION</span></span></span><a class="headerlink" href="#_CPPv4N2NV5Rules7IAction8NameBase8FUNCTIONE" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules7IAction8NameBase9DEMANGLEDE">
<span id="_CPPv3N2NV5Rules7IAction8NameBase9DEMANGLEDE"></span><span id="_CPPv2N2NV5Rules7IAction8NameBase9DEMANGLEDE"></span><span class="target" id="classnv_1_1rules_1_1iaction_1a9e643b707ad8c701f6f2a29ecac6b108a543ceec46727bb86fca5cdc628cef470"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DEMANGLED</span></span></span><a class="headerlink" href="#_CPPv4N2NV5Rules7IAction8NameBase9DEMANGLEDE" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules7IAction8NameBase7MANGLEDE">
<span id="_CPPv3N2NV5Rules7IAction8NameBase7MANGLEDE"></span><span id="_CPPv2N2NV5Rules7IAction8NameBase7MANGLEDE"></span><span class="target" id="classnv_1_1rules_1_1iaction_1a9e643b707ad8c701f6f2a29ecac6b108a0a4b1f7ec455ebb20beff5f71081f729"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MANGLED</span></span></span><a class="headerlink" href="#_CPPv4N2NV5Rules7IAction8NameBase7MANGLEDE" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric-h3 rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules7IAction17add_double_metricEPKcN7IMetric9ValueKindEd">
<span id="_CPPv3N2NV5Rules7IAction17add_double_metricEPKcN7IMetric9ValueKindEd"></span><span id="_CPPv2N2NV5Rules7IAction17add_double_metricEPKcN7IMetric9ValueKindEd"></span><span id="NV::Rules::IAction::add_double_metric__cCP.IMetric::ValueKind.double"></span><span class="target" id="classnv_1_1rules_1_1iaction_1afec093dd83a0c7f2e44eb90f4170a7ff"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="classNV_1_1Rules_1_1IMetric.html#_CPPv4N2NV5Rules7IMetricE" title="NV::Rules::IMetric"><span class="n"><span class="pre">IMetric</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">add_double_metric</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">value_name</span></span>, <a class="reference internal" href="classNV_1_1Rules_1_1IMetric.html#_CPPv4N2NV5Rules7IMetricE" title="NV::Rules::IMetric"><span class="n"><span class="pre">IMetric</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="classNV_1_1Rules_1_1IMetric.html#_CPPv4N2NV5Rules7IMetric9ValueKindE" title="NV::Rules::IMetric::ValueKind"><span class="n"><span class="pre">ValueKind</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">value_kind</span></span>, <span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N2NV5Rules7IAction17add_double_metricEPKcN7IMetric9ValueKindEd" title="Permalink to this definition"></a><br /></dt>
<dd><p>Add a single floating point metric to this action. </p>
<p>
Add a single floating point metric with name <code class="docutils literal notranslate"><span class="pre">value_name</span></code> and kind <code class="docutils literal notranslate"><span class="pre">value_kind</span></code> to this action </p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>the new IMetric</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules7IAction18add_integer_metricEPKcN7IMetric9ValueKindE8uint64_t">
<span id="_CPPv3N2NV5Rules7IAction18add_integer_metricEPKcN7IMetric9ValueKindE8uint64_t"></span><span id="_CPPv2N2NV5Rules7IAction18add_integer_metricEPKcN7IMetric9ValueKindE8uint64_t"></span><span id="NV::Rules::IAction::add_integer_metric__cCP.IMetric::ValueKind.uint64_t"></span><span class="target" id="classnv_1_1rules_1_1iaction_1a0ac9916a2a442afa5e6092fe5e8b15db"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="classNV_1_1Rules_1_1IMetric.html#_CPPv4N2NV5Rules7IMetricE" title="NV::Rules::IMetric"><span class="n"><span class="pre">IMetric</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">add_integer_metric</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">value_name</span></span>, <a class="reference internal" href="classNV_1_1Rules_1_1IMetric.html#_CPPv4N2NV5Rules7IMetricE" title="NV::Rules::IMetric"><span class="n"><span class="pre">IMetric</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="classNV_1_1Rules_1_1IMetric.html#_CPPv4N2NV5Rules7IMetric9ValueKindE" title="NV::Rules::IMetric::ValueKind"><span class="n"><span class="pre">ValueKind</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">value_kind</span></span>, <span class="n"><span class="pre">uint64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N2NV5Rules7IAction18add_integer_metricEPKcN7IMetric9ValueKindE8uint64_t" title="Permalink to this definition"></a><br /></dt>
<dd><p>Add a single integer metric to this action. </p>
<p>
Add a single integer metric to with name <code class="docutils literal notranslate"><span class="pre">value_name</span></code> and kind <code class="docutils literal notranslate"><span class="pre">value_kind</span></code> this action. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>the new IMetric</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules7IAction10add_metricEPKc">
<span id="_CPPv3N2NV5Rules7IAction10add_metricEPKc"></span><span id="_CPPv2N2NV5Rules7IAction10add_metricEPKc"></span><span id="NV::Rules::IAction::add_metric__cCP"></span><span class="target" id="classnv_1_1rules_1_1iaction_1ad78872ad07b1ecd42ca866ba397cc79d"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">IMutableMetric</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">add_metric</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">value_name</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N2NV5Rules7IAction10add_metricEPKc" title="Permalink to this definition"></a><br /></dt>
<dd><p>Add a single mutable metric to this action. </p>
<p>
Add a single, mutable metric with name <code class="docutils literal notranslate"><span class="pre">value_name</span></code> to this action. The metric is not initialized with any kind or value and needs to be assigned proper values and/or instances afterwards. IMutableMetric provides the following interface:</p>
<p>void set_double(IMetric::ValueKind value_kind, double value)</p>
<p>Return true if the value was set, false otherwise. Assign the metric a floating-point value of value_kind Acceptable kinds are FLOAT, DOUBLE or ANY (for which the implementation chooses the kind internally)</p>
<p>bool set_double(size_t instance, IMetric::ValueKind value_kind, double value)</p>
<p>Return true if the instance value was set, false otherwise. Assign the metric an instance floating-point value of value_kind Acceptable kinds are FLOAT, DOUBLE or ANY (for which the implementation chooses the kind internally)</p>
<p>void set_uint64(IMetric::ValueKind value_kind, uint64_t value)</p>
<p>Return true if the value was set, false otherwise. Assign the metric an integer value of value_kind Acceptable kinds are UINT32, UINT64 or ANY (for which the implementation chooses the kind internally)</p>
<p>bool set_uint64(size_t instance, IMetric::ValueKind value_kind, uint64_t value)</p>
<p>Return true if the instance value was set, false otherwise. Assign the metric an instance integer value of value_kind Acceptable kinds are UINT32, UINT64 or ANY (for which the implementation chooses the kind internally)</p>
<p>void set_string(IMetric::ValueKind value_kind, const char* value)</p>
<p>Return true if the value was set, false otherwise. Assign the metric a string value of value_kind Acceptable kinds are STRING or ANY (for which the implementation chooses the kind internally)</p>
<p>bool set_string(size_t instance, IMetric::ValueKind value_kind, const char* value)</p>
<p>Return true if the instance value was set, false otherwise. Assign the metric an instance string value of value_kind Acceptable kinds are STRING or ANY (for which the implementation chooses the kind internally)</p>
<p>IMutableMetric *mutable_correlation_ids()</p>
<p>Returns a new, mutable metric object representing the correlation IDs for the metric’s instance values. Correlation IDs are used to associate instance values with the “instance” their value represents. In the returned new metric object, the correlation IDs are that object’s instance values. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>the new IMutableMetric</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules7IAction17add_string_metricEPKcN7IMetric9ValueKindEPKc">
<span id="_CPPv3N2NV5Rules7IAction17add_string_metricEPKcN7IMetric9ValueKindEPKc"></span><span id="_CPPv2N2NV5Rules7IAction17add_string_metricEPKcN7IMetric9ValueKindEPKc"></span><span id="NV::Rules::IAction::add_string_metric__cCP.IMetric::ValueKind.cCP"></span><span class="target" id="classnv_1_1rules_1_1iaction_1a6e3fd9bcb4c450a5fdc10cd8a65bd372"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="classNV_1_1Rules_1_1IMetric.html#_CPPv4N2NV5Rules7IMetricE" title="NV::Rules::IMetric"><span class="n"><span class="pre">IMetric</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">add_string_metric</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">value_name</span></span>, <a class="reference internal" href="classNV_1_1Rules_1_1IMetric.html#_CPPv4N2NV5Rules7IMetricE" title="NV::Rules::IMetric"><span class="n"><span class="pre">IMetric</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="classNV_1_1Rules_1_1IMetric.html#_CPPv4N2NV5Rules7IMetric9ValueKindE" title="NV::Rules::IMetric::ValueKind"><span class="n"><span class="pre">ValueKind</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">value_kind</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N2NV5Rules7IAction17add_string_metricEPKcN7IMetric9ValueKindEPKc" title="Permalink to this definition"></a><br /></dt>
<dd><p>Add a single string metric to this action. </p>
<p>
Add a single string metric with name <code class="docutils literal notranslate"><span class="pre">value_name</span></code> and kind <code class="docutils literal notranslate"><span class="pre">value_kind</span></code> to this action </p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>the new IMetric</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules7IAction14metric_by_nameEPKc">
<span id="_CPPv3N2NV5Rules7IAction14metric_by_nameEPKc"></span><span id="_CPPv2N2NV5Rules7IAction14metric_by_nameEPKc"></span><span id="NV::Rules::IAction::metric_by_name__cCP"></span><span class="target" id="classnv_1_1rules_1_1iaction_1a09d52d0f299f8c165491c53e0c827cb9"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="classNV_1_1Rules_1_1IMetric.html#_CPPv4N2NV5Rules7IMetricE" title="NV::Rules::IMetric"><span class="n"><span class="pre">IMetric</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">metric_by_name</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">metric_name</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N2NV5Rules7IAction14metric_by_nameEPKc" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get a single metric by name. </p>
<p>Get a single IMetric by <code class="docutils literal notranslate"><span class="pre">metric_name</span></code> </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules7IAction12metric_namesEv">
<span id="_CPPv3N2NV5Rules7IAction12metric_namesEv"></span><span id="_CPPv2N2NV5Rules7IAction12metric_namesEv"></span><span id="NV::Rules::IAction::metric_names"></span><span class="target" id="classnv_1_1rules_1_1iaction_1af377c6471ee343fca855eb84fa140c69"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">set</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">metric_names</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N2NV5Rules7IAction12metric_namesEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get the set of metric names. </p>
<p>Get the set of metrics available for this action </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules7IAction4nameE8NameBase">
<span id="_CPPv3N2NV5Rules7IAction4nameE8NameBase"></span><span id="_CPPv2N2NV5Rules7IAction4nameE8NameBase"></span><span id="NV::Rules::IAction::name__NameBase"></span><span class="target" id="classnv_1_1rules_1_1iaction_1af4bf85700d3d3b475c6381094e56d3a9"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">name</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N2NV5Rules7IAction8NameBaseE" title="NV::Rules::IAction::NameBase"><span class="n"><span class="pre">NameBase</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">base</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N2NV5Rules7IAction8NameBaseE" title="NV::Rules::IAction::NameBase"><span class="n"><span class="pre">NameBase</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N2NV5Rules7IAction8NameBase8FUNCTIONE" title="NV::Rules::IAction::NameBase::FUNCTION"><span class="n"><span class="pre">FUNCTION</span></span></a><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N2NV5Rules7IAction4nameE8NameBase" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get the action name. </p>
<p>Get the action name </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules7IAction10nvtx_stateEv">
<span id="_CPPv3N2NV5Rules7IAction10nvtx_stateEv"></span><span id="_CPPv2N2NV5Rules7IAction10nvtx_stateEv"></span><span id="NV::Rules::IAction::nvtx_state"></span><span class="target" id="classnv_1_1rules_1_1iaction_1a4f43bfc84423eaaf85c843ae380e9494"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="classNV_1_1Rules_1_1INvtxState.html#_CPPv4N2NV5Rules10INvtxStateE" title="NV::Rules::INvtxState"><span class="n"><span class="pre">INvtxState</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">nvtx_state</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N2NV5Rules7IAction10nvtx_stateEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get the NVTX state associated with this action. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>a new INvtxState object if any NVTX state is available for this action. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules7IAction9ptx_by_pcE8uint64_t">
<span id="_CPPv3N2NV5Rules7IAction9ptx_by_pcE8uint64_t"></span><span id="_CPPv2N2NV5Rules7IAction9ptx_by_pcE8uint64_t"></span><span id="NV::Rules::IAction::ptx_by_pc__uint64_t"></span><span class="target" id="classnv_1_1rules_1_1iaction_1a6ce615f3ec4e3f5fd1554583dd6bcedf"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ptx_by_pc</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">address</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N2NV5Rules7IAction9ptx_by_pcE8uint64_t" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get the PTX for a function address within this action. </p>
<p>
Get the PTX for a function <code class="docutils literal notranslate"><span class="pre">address</span></code> within this action. The address is expected to be absolute, i.e. as obtained from the correlation IDs of source-correlated metrics. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>PTX string. An empty string is returned if no PTX is associated with this address</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules7IAction10sass_by_pcE8uint64_t">
<span id="_CPPv3N2NV5Rules7IAction10sass_by_pcE8uint64_t"></span><span id="_CPPv2N2NV5Rules7IAction10sass_by_pcE8uint64_t"></span><span id="NV::Rules::IAction::sass_by_pc__uint64_t"></span><span class="target" id="classnv_1_1rules_1_1iaction_1aa1fc608333aefe67f0559ab03094acb4"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">sass_by_pc</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">address</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N2NV5Rules7IAction10sass_by_pcE8uint64_t" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get the disassembled SASS for a function address within this action. </p>
<p>
Get the disassembled SASS for a function <code class="docutils literal notranslate"><span class="pre">address</span></code> within this action. The address is expected to be absolute, i.e. as obtained from the correlation IDs of source-correlated metrics. The SASS may include formatting whitespace as generated by the disassembler. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>SASS string. An empty string is returned if no SASS is associated with this address</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules7IAction12source_filesEv">
<span id="_CPPv3N2NV5Rules7IAction12source_filesEv"></span><span id="_CPPv2N2NV5Rules7IAction12source_filesEv"></span><span id="NV::Rules::IAction::source_files"></span><span class="target" id="classnv_1_1rules_1_1iaction_1aa524b05426973c0ab5edd4b2cc14575f"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">source_files</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N2NV5Rules7IAction12source_filesEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get the source files associated with an action. </p>
<p>
Get the map of source files associated with this action, along with their content. If content is not available for a file (e.g. because it hadn’t been imported into the report), the file name will map to an empty string. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>a map from file name to file content</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules7IAction11source_infoE8uint64_t">
<span id="_CPPv3N2NV5Rules7IAction11source_infoE8uint64_t"></span><span id="_CPPv2N2NV5Rules7IAction11source_infoE8uint64_t"></span><span id="NV::Rules::IAction::source_info__uint64_t"></span><span class="target" id="classnv_1_1rules_1_1iaction_1a55069b0290189fd9cf41833b4f4e9809"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="classNV_1_1Rules_1_1ISourceInfo.html#_CPPv4N2NV5Rules11ISourceInfoE" title="NV::Rules::ISourceInfo"><span class="n"><span class="pre">ISourceInfo</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">source_info</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">address</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N2NV5Rules7IAction11source_infoE8uint64_t" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get the source info for a function address within this action. </p>
<p>
Get the source info for <code class="docutils literal notranslate"><span class="pre">address</span></code> within this action. Addresses are commonly obtained as correlation ids of source-correlated metrics. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>a new ISourceInfo object if it is available</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules7IActionD0Ev">
<span id="_CPPv3N2NV5Rules7IActionD0Ev"></span><span id="_CPPv2N2NV5Rules7IActionD0Ev"></span><span id="NV::Rules::IAction::~IAction"></span><span class="target" id="classnv_1_1rules_1_1iaction_1a85130dc84498687eab55f550228409b7"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">~IAction</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N2NV5Rules7IActionD0Ev" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
</div>
</dd></dl>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>© Copyright 2018-2024, NVIDIA Corporation & Affiliates. All rights reserved.
<span class="lastupdated">Last updated on Mar 06, 2024.
</span></p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
|
