forked from geopm/geopm.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
geopm_pio.7.html
367 lines (352 loc) · 32.2 KB
/
geopm_pio.7.html
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
<!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>geopm_pio(7) -- GEOPM PlatformIO interface — GEOPM documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[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/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.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="geopm_pio_cnl(7) -- Signals and controls for Compute Node Linux Board-Level Metrics" href="geopm_pio_cnl.7.html" />
<link rel="prev" title="geopm(7) -- Global Extensible Open Power Manager" href="geopm.7.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" class="icon icon-home"> GEOPM
<img src="https://geopm.github.io/images/geopm-logo-clear.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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="overview.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="service.html">Guide for Service Users</a></li>
<li class="toctree-l1"><a class="reference internal" href="runtime.html">Guide for HPC Runtime Users</a></li>
<li class="toctree-l1"><a class="reference internal" href="contrib.html">Guide for Contributors</a></li>
<li class="toctree-l1"><a class="reference internal" href="devel.html">Guide for GEOPM Developers</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="reference.html">Reference Manual</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="reference.html#geopm-manual-pages">GEOPM Manual Pages</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="geopm.7.html">geopm(7) -- Global Extensible Open Power Manager</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">geopm_pio(7) -- GEOPM PlatformIO interface</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#description">Description</a></li>
<li class="toctree-l4"><a class="reference internal" href="#aliasing-signals-and-controls">Aliasing Signals And Controls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#descriptions-of-high-level-aliases">Descriptions Of High Level Aliases</a></li>
<li class="toctree-l4"><a class="reference internal" href="#see-also">See Also</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="geopm_pio_cnl.7.html">geopm_pio_cnl(7) -- Signals and controls for Compute Node Linux Board-Level Metrics</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_pio_cpuinfo.7.html">geopm_pio_cpuinfo(7) -- Signals and controls for the CPUInfoIOGroup</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_pio_dcgm.7.html">geopm_pio_dcgm(7) -- IOGroup providing signals and controls for NVIDIA GPUs</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_pio_levelzero.7.html">geopm_pio_levelzero(7) -- IOGroup providing signals and controls for Intel GPUs</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_pio_msr.7.html">geopm_pio_msr(7) -- Signals and controls for Model Specific Registers (MSRs)</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_pio_nvml.7.html">geopm_pio_nvml(7) -- IOGroup providing signals and controls for NVIDIA GPUs</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_pio_profile.7.html">geopm_pio_profile(7) -- Signals and controls for the ProfileIOGroup</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_pio_service.7.html">geopm_pio_service(7) -- Signals and controls for the ServiceIOGroup</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_pio_sst.7.html">geopm_pio_sst(7) -- Signals and controls for Intel Speed Select Technology</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_pio_time.7.html">geopm_pio_time(7) -- Signals and controls for Time IO Group</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopmaccess.1.html">geopmaccess(1) -- Access management for the GEOPM Service</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopmadmin.1.html">geopmadmin(1) -- tool for GEOPM system administrators</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopmagent.1.html">geopmagent(1) -- query agent information and create static policies</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopmbench.1.html">geopmbench(1) -- synthetic benchmark application</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopmctl.1.html">geopmctl(1) -- GEOPM runtime control application</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopmendpoint.1.html">geopmendpoint(1) -- command line tool for dynamic policy control</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopmlaunch.1.html">geopmlaunch(1) -- application launch wrapper</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopmread.1.html">geopmread(1) -- query platform information</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopmsession.1.html">geopmsession(1) -- Command line interface for the GEOPM service batch read features</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopmwrite.1.html">geopmwrite(1) -- modify platform state</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopmdpy.7.html">geopmdpy(7) -- global extensible open power manager python daemon package</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopmpy.7.html">geopmpy(7) -- global extensible open power manager python package</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_agent.3.html">geopm_agent(3) -- query information about available agents</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_ctl.3.html">geopm_ctl(3) -- GEOPM runtime control thread</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_daemon.3.html">geopm_daemon(3) -- helpers for GEOPM daemons</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_endpoint.3.html">geopm_endpoint(3) -- dynamic policy control for resource management</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_error.3.html">geopm_error(3) -- error code descriptions</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_fortran.3.html">geopm_fortran(3) -- GEOPM fortran interface</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_hash.3.html">geopm_hash(3) -- helper methods for encoding</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_imbalancer.3.html">geopm_imbalancer(3) -- set artificial runtime imbalance</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_pio.3.html">geopm_pio(3) -- interfaces to query and modify platform</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_policystore.3.html">geopm_policystore(3) -- GEOPM resource policy store interface</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_prof.3.html">geopm_prof(3) -- application profiling interfaces</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_sched.3.html">geopm_sched(3) -- interface with Linux scheduler</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_time.3.html">geopm_time(3) -- helper methods for time</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_topo.3.html">geopm_topo(3) -- query platform component topology</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_version.3.html">geopm_version(3) -- GEOPM library version</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_Agent.3.html">geopm::Agent(3) -- GEOPM agent plugin interface</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_Agg.3.html">geopm::Agg(3) -- data aggregation functions</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_CNLIOGroup.3.html">geopm::CNLIOGroup(3) -- IOGroup for interaction with Compute Node Linux</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_CircularBuffer.3.html">geopm::CircularBuffer(3) -- generic circular buffer</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_Comm.3.html">geopm::Comm(3) -- communication abstractions</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_CpuinfoIOGroup.3.html">geopm::CpuinfoIOGroup(3) -- IOGroup for CPU frequency limits</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_Daemon.3.html">geopm::Daemon(3) -- GEOPM daemon helper methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_Endpoint.3.html">geopm::Endpoint(3) -- GEOPM endpoint interface</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_Exception.3.html">geopm::Exception(3) -- custom GEOPM exceptions</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_Helper.3.html">geopm::Helper -- common helper methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_IOGroup.3.html">geopm::IOGroup(3) -- provides system values and settings</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_MPIComm.3.html">geopm::MPIComm(3) -- implementation of Comm using MPI</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_MSRIO.3.html">geopm::MSRIO(3) -- methods for reading and writing MSRs</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_MSRIOGroup.3.html">geopm::MSRIOGroup -- IOGroup providing MSR-based signals and controls</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_MonitorAgent.3.html">geopm::MonitorAgent -- agent that enforces no policies</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_PlatformIO.3.html">geopm::PlatformIO(3) -- GEOPM platform interface</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_PlatformTopo.3.html">geopm::PlatformTopo(3) -- platform topology information</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_PluginFactory.3.html">geopm::PluginFactory(3) -- abstract factory for plugins</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_PowerBalancer.3.html">geopm::PowerBalancer(3) -- balances power according to epoch runtime</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_PowerBalancerAgent.3.html">geopm::PowerBalancerAgent(3) -- agent optimizing performance under a power cap</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_PowerGovernor.3.html">geopm::PowerGovernor(3) -- enforces a power limit</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_PowerGovernorAgent.3.html">geopm::PowerGovernorAgent(3) -- agent that enforces a power cap</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_ProfileIOGroup.3.html">geopm::ProfileIOGroup(3) -- IOGroup providing application signals</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_SampleAggregator.3.html">geopm::SampleAggregator(3) -- per-region aggregated signal data</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_SharedMemory.3.html">geopm::SharedMemory(3) -- abstractions for shared memory</a></li>
<li class="toctree-l3"><a class="reference internal" href="GEOPM_CXX_MAN_TimeIOGroup.3.html">geopm::TimeIOGroup(3) -- IOGroup providing time signals</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_report.7.html">geopm_report(7) -- GEOPM summary report file</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_agent_frequency_map.7.html">geopm_agent_frequency_map(7) -- agent for running regions at user selected frequencies</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_agent_monitor.7.html">geopm_agent_monitor(7) -- agent implementation for aggregating statistics</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_agent_power_balancer.7.html">geopm_agent_power_balancer(7) -- agent optimizes performance under a power cap</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_agent_power_governor.7.html">geopm_agent_power_governor(7) -- agent enforces a power cap</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#doxygen-pages">Doxygen Pages</a></li>
</ul>
</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">GEOPM</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="reference.html">Reference Manual</a> »</li>
<li>geopm_pio(7) -- GEOPM PlatformIO interface</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/geopm_pio.7.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="geopm-pio-7-geopm-platformio-interface">
<h1>geopm_pio(7) -- GEOPM PlatformIO interface<a class="headerlink" href="#geopm-pio-7-geopm-platformio-interface" title="Permalink to this heading"></a></h1>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">PlatformIO</span></code> class provides a high-level interface for signals
(system monitors) and controls (system settings). There are a large
number of built-in signals and controls. These built-in signals and
controls include hardware metrics, hardware settings, and signals
derived from application behavior. Application behavior is tracked by
GEOPM's integration with MPI and OpenMP and also by application use of
the <a class="reference internal" href="geopm_prof.3.html"><span class="doc">geopm_prof(3)</span></a> mark-up interface. In
addition to the built-in features, <code class="docutils literal notranslate"><span class="pre">PlatformIO</span></code> can be extended
through the <a class="reference internal" href="GEOPM_CXX_MAN_IOGroup.3.html"><span class="doc">geopm::IOGroup(3)</span></a> plugin
interface to provide arbitrary signals and controls.</p>
<p>A domain is a discrete component within a compute node where a signal
or control is applicable. For more information about the
<code class="docutils literal notranslate"><span class="pre">geopm_domain_e</span></code> enum and the hierarchical platform description see
<a class="reference internal" href="geopm_topo.3.html"><span class="doc">geopm_topo(3)</span></a>. A
signal represents any measurement in SI units that can be sampled or
any unit-free integer that can be read. A control represents a
request for a hardware domain to operate such that a related signal
measured from the hardware domain will track the request. For
example, the user can set a <code class="docutils literal notranslate"><span class="pre">CPU_POWER_LIMIT_CONTROL</span></code> in units of
<em>watts</em> and the related signal, <code class="docutils literal notranslate"><span class="pre">CPU_POWER</span></code>, will remain below
the limit. Similarly the user can set a <code class="docutils literal notranslate"><span class="pre">CPU_FREQUENCY_MAX_CONTROL</span></code> in
<em>hertz</em> and the related signal, <code class="docutils literal notranslate"><span class="pre">CPU_FREQUENCY_STATUS</span></code> will show the
CPU operating at the value set.</p>
<p>See the <a class="reference internal" href="geopmread.1.html"><span class="doc">geopmread(1)</span></a> and <a class="reference internal" href="geopmwrite.1.html"><span class="doc">geopmwrite(1)</span></a> tools for command-line interaction with the <code class="docutils literal notranslate"><span class="pre">PlatformIO</span></code>
interface.</p>
</section>
<section id="aliasing-signals-and-controls">
<h2>Aliasing Signals And Controls<a class="headerlink" href="#aliasing-signals-and-controls" title="Permalink to this heading"></a></h2>
<p>There are two classes of signals and control names: "low level" and
"high level". All <code class="docutils literal notranslate"><span class="pre">IOGroup</span></code>'s are expected to provide low level
signals and controls with names that are prefixed with the <code class="docutils literal notranslate"><span class="pre">IOGroup</span></code>
name and two colons, e.g. the <code class="docutils literal notranslate"><span class="pre">MSRIOGroup</span></code> provides the
<code class="docutils literal notranslate"><span class="pre">MSR::PKG_ENERGY_STATUS:ENERGY</span></code> signal. If the signal or control may
be supported on more than one platform, the implementation should be
aliased to a high level name. This high level name enables the signal
or control to be supported by more than one <code class="docutils literal notranslate"><span class="pre">IOGroup</span></code>, and different
platforms will support the loading different sets of <code class="docutils literal notranslate"><span class="pre">IOGroups</span></code>. The
<code class="docutils literal notranslate"><span class="pre">MSRIOGroup</span></code> aliases the above signal to the high level
<code class="docutils literal notranslate"><span class="pre">PACKAGE_ENERGY</span></code> signal which can be used on any platform to measure
the current package energy value. Agents are encouraged to request
high level signals and controls to make the implementation more
portable. The high level signals and controls supported by built-in
<code class="docutils literal notranslate"><span class="pre">IOGroup</span></code> classes are listed below. See <a class="reference internal" href="GEOPM_CXX_MAN_PluginFactory.3.html"><span class="doc">geopm::PluginFactory(3)</span></a> section on <a class="reference internal" href="GEOPM_CXX_MAN_PluginFactory.3.html#plugin-search-path-and-load-order"><span class="std std-ref">SEARCH AND LOAD ORDER</span></a> for
information about how the <code class="docutils literal notranslate"><span class="pre">GEOPM_PLUGIN_PATH</span></code> environment variable is used to
select which <code class="docutils literal notranslate"><span class="pre">IOGroup</span></code> implementation is used in the case where more than one
provides the same high level signal or control.</p>
<p>Signal names that end in <code class="docutils literal notranslate"><span class="pre">#</span></code> (for example, raw MSR values) are 64-bit
integers encoded to be stored as doubles. When accessing these
integer signals, the return value of <code class="docutils literal notranslate"><span class="pre">read_signal()</span></code> or <code class="docutils literal notranslate"><span class="pre">sample()</span></code>
should not be used directly as a double precision number. To
decode the 64-bit integer from the double use
<code class="docutils literal notranslate"><span class="pre">geopm_signal_to_field()</span></code> described in <a class="reference internal" href="geopm_hash.3.html"><span class="doc">geopm_hash(3)</span></a>. The
<a class="reference internal" href="GEOPM_CXX_MAN_MSRIOGroup.3.html"><span class="doc">geopm::MSRIOGroup(3)</span></a> also provides raw MSR field signals that are
encoded in this way.</p>
</section>
<section id="descriptions-of-high-level-aliases">
<h2>Descriptions Of High Level Aliases<a class="headerlink" href="#descriptions-of-high-level-aliases" title="Permalink to this heading"></a></h2>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">BOARD_ENERGY</span></code></dt><dd><p>Total energy measured on the server's board. See <a class="reference internal" href="geopm_pio_cnl.7.html#requirements"><span class="std std-ref">geopm_pio_cnl(7)</span></a> for signal availability requirements.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">BOARD_POWER</span></code></dt><dd><p>Power measured on the server's board. See <a class="reference internal" href="geopm_pio_cnl.7.html#requirements"><span class="std std-ref">geopm_pio_cnl(7)</span></a> for signal availability requirements.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">CPU_CORE_TEMPERATURE</span></code></dt><dd><p>CPU core temperature, in degrees Celsius.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">CPU_CYCLES_REFERENCE</span></code></dt><dd><p>The count of the number of cycles while the logical processor is not in a
halt state and not in a stop-clock state. The count rate is fixed at the
TIMESTAMP_COUNT rate.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">CPU_CYCLES_THREAD</span></code></dt><dd><p>The count of the number of cycles while the logical processor is not in a
halt state. The count rate may change based on core frequency.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">CPU_ENERGY</span></code></dt><dd><p>An increasing meter of energy consumed by the package over time. It will
reset periodically due to roll-over.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">CPU_FREQUENCY_CONTROL</span></code></dt><dd><p>Target operating frequency of the CPU based on the control register. On a
system where <code class="docutils literal notranslate"><span class="pre">CPU_FREQUENCY_MAX_CONTROL</span></code> and
<code class="docutils literal notranslate"><span class="pre">CPU_FREQUENCY_MIN_CONTROL</span></code> are available, setting this control should
be equivalent to setting both of those controls to the same value.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">CPU_FREQUENCY_MAX_CONTROL</span></code></dt><dd><p>Target maximum operating frequency of the CPU based on the control
register.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">CPU_FREQUENCY_MAX_AVAIL</span></code></dt><dd><p>Maximum processor frequency.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">CPU_FREQUENCY_MIN_CONTROL</span></code></dt><dd><p>Target minimum operating frequency of the CPU based on the control
register.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">CPU_FREQUENCY_STATUS</span></code></dt><dd><p>The current operating frequency of the CPU.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">CPU_INSTRUCTIONS_RETIRED</span></code></dt><dd><p>The count of the number of instructions executed.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">CPU_PACKAGE_TEMPERATURE</span></code></dt><dd><p>CPU package temperature, in degrees Celsius.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">CPU_POWER_LIMIT_CONTROL</span></code></dt><dd><p>The average power usage limit over the time window specified in
PL1_TIME_WINDOW.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">CPU_POWER_TIME_WINDOW</span></code></dt><dd><p>The time window associated with power limit 1.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">CPU_POWER_MAX_AVAIL</span></code></dt><dd><p>The maximum power limit based on the electrical specification.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">CPU_POWER_MIN_AVAIL</span></code></dt><dd><p>The minimum power limit based on the electrical specification.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">CPU_POWER_LIMIT_DEFAULT</span></code></dt><dd><p>Maximum power to stay within the thermal limits based on the design (TDP).</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">CPU_POWER</span></code></dt><dd><p>Total power aggregated over the processor package.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">CPU_TIMESTAMP_COUNTER</span></code></dt><dd><p>An always running, monotonically increasing counter that is incremented at
a constant rate. For use as a wall clock timer.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">CPU_UNCORE_FREQUENCY_STATUS</span></code></dt><dd><p>Target operating frequency of the uncore.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">DRAM_ENERGY</span></code></dt><dd><p>An increasing meter of energy consumed by the DRAM over time. It will reset
periodically due to roll-over.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">DRAM_POWER</span></code></dt><dd><p>Total power aggregated over the DRAM DIMMs associated with a NUMA node.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">EPOCH_COUNT</span></code></dt><dd><p>Number of completed executions of an epoch. Prior to the first call
by the application to <code class="docutils literal notranslate"><span class="pre">geopm_prof_epoch()</span></code> the signal returns as <code class="docutils literal notranslate"><span class="pre">-1</span></code>.
With each call to <code class="docutils literal notranslate"><span class="pre">geopm_prof_epoch()</span></code> the count increases by one.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">GPU_CORE_ACTIVITY</span></code></dt><dd><p>GPU compute core activity expressed as a ratio of cycles.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">GPU_CORE_FREQENCY_MAX_AVAIL</span></code></dt><dd><p>Maximum supported GPU core frequency over the specified domain.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">GPU_CORE_FREQENCY_MIN_AVAIL</span></code></dt><dd><p>Minimum supported GPU core frequency over the specified domain.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">GPU_CORE_FREQUENCY_CONTROL</span></code></dt><dd><p>Average requested GPU core frequency over the specified domain.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">GPU_CORE_FREQUENCY_STATUS</span></code></dt><dd><p>Average achieved GPU core frequency over the specified domain.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">GPU_ENERGY</span></code></dt><dd><p>Total energy aggregated over the GPU package.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">GPU_POWER_LIMIT_CONTROL</span></code></dt><dd><p>Average GPU power usage limit.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">GPU_POWER</span></code></dt><dd><p>Total power aggregated over the GPU package.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">GPU_TEMPERATURE</span></code></dt><dd><p>Average GPU temperature in degrees Celsius.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">GPU_UNCORE_ACTIVITY</span></code></dt><dd><p>GPU memory access activity expressed as a ratio of cycles.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">GPU_UTILIZATION</span></code></dt><dd><p>Average GPU utilization expressed as a ratio of cycles.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">REGION_HASH</span></code></dt><dd><p>The hash of the region of code (see <a class="reference internal" href="geopm_prof.3.html"><span class="doc">geopm_prof(3)</span></a>) currently being
run by all ranks, otherwise <code class="docutils literal notranslate"><span class="pre">GEOPM_REGION_HASH_UNMARKED</span></code>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">REGION_HINT</span></code></dt><dd><p>The region hint (see <a class="reference internal" href="geopm_prof.3.html"><span class="doc">geopm_prof(3)</span></a>) associated with the currently
running region. For any interval when all ranks are within an MPI
function inside of a user defined region, the hint will change from the
hint associated with the user defined region to <code class="docutils literal notranslate"><span class="pre">GEOPM_REGION_HINT_NETWORK</span></code>.
If the user defined region was defined with <code class="docutils literal notranslate"><span class="pre">GEOPM_REGION_HINT_NETWORK</span></code> and
there is an interval within the region when all ranks are within an MPI
function, GEOPM will not attribute the time spent within the MPI function as
MPI time in the report files. It will be instead attributed to the time
spent in the region as a whole.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">REGION_PROGRESS</span></code></dt><dd><p>Minimum per-rank reported progress through the current region.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">REGION_RUNTIME</span></code></dt><dd><p>Maximum per-rank of the last recorded runtime for the current
region.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">TIME</span></code></dt><dd><p>Time elapsed since the beginning of execution.</p>
</dd>
</dl>
</section>
<section id="see-also">
<h2>See Also<a class="headerlink" href="#see-also" title="Permalink to this heading"></a></h2>
<p><a class="reference internal" href="geopm.7.html"><span class="doc">geopm(7)</span></a>,
<a class="reference internal" href="geopm_pio_cnl.7.html"><span class="doc">geopm_pio_cnl(7)</span></a>,
<a class="reference internal" href="geopm_pio.3.html"><span class="doc">geopm_pio(3)</span></a>,
<a class="reference internal" href="geopm_prof.3.html"><span class="doc">geopm_prof(3)</span></a>,
<a class="reference internal" href="geopm_topo.3.html"><span class="doc">geopm_topo(3)</span></a>,</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="geopm.7.html" class="btn btn-neutral float-left" title="geopm(7) -- Global Extensible Open Power Manager" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="geopm_pio_cnl.7.html" class="btn btn-neutral float-right" title="geopm_pio_cnl(7) -- Signals and controls for Compute Node Linux Board-Level Metrics" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2015 - 2022, Intel Corporation. All rights reserved..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>