forked from geopm/geopm.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathGEOPM_CXX_MAN_MSRIOGroup.3.html
478 lines (463 loc) · 44.2 KB
/
GEOPM_CXX_MAN_MSRIOGroup.3.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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
<!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::MSRIOGroup -- IOGroup providing MSR-based signals and controls — 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/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::MonitorAgent -- agent that enforces no policies" href="GEOPM_CXX_MAN_MonitorAgent.3.html" />
<link rel="prev" title="geopm::MSRIO(3) -- methods for reading and writing MSRs" href="GEOPM_CXX_MAN_MSRIO.3.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"><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_c.3.html">geopm_agent_c(3) -- query information about available agents</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_ctl_c.3.html">geopm_ctl_c(3) -- geopm runtime control thread</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_daemon_c.3.html">geopm_daemon_c(3) -- helpers for geopm daemons</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_endpoint_c.3.html">geopm_endpoint_c(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.h(3) -- helper methods for encoding</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_imbalancer.3.html">geopm_imbalancer.h(3) -- set artificial runtime imbalance</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_pio_c.3.html">geopm_pio_c(3) -- interfaces to query and modify platform</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_policystore_c.3.html">geopm_policystore_c(3) -- geopm resource policy store interface</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_prof_c.3.html">geopm_prof_c(3) -- application profiling interfaces</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_sched.3.html">geopm_sched.h(3) -- interface with Linux scheduler</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_time.3.html">geopm_time.h(3) -- helper methods for time</a></li>
<li class="toctree-l3"><a class="reference internal" href="geopm_topo_c.3.html">geopm_topo_c(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 current"><a class="current reference internal" href="#">geopm::MSRIOGroup -- IOGroup providing MSR-based signals and controls</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#description">DESCRIPTION</a></li>
<li class="toctree-l4"><a class="reference internal" href="#class-methods">CLASS METHODS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#enumerations">ENUMERATIONS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#environment">ENVIRONMENT</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_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::RegionAggregator(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#signals-and-controls">Signals and Controls</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::MSRIOGroup -- IOGroup providing MSR-based signals and controls</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/GEOPM_CXX_MAN_MSRIOGroup.3.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-msriogroup-iogroup-providing-msr-based-signals-and-controls">
<h1>geopm::MSRIOGroup -- IOGroup providing MSR-based signals and controls<a class="headerlink" href="#geopm-msriogroup-iogroup-providing-msr-based-signals-and-controls" title="Permalink to this headline"></a></h1>
<section id="synopsis">
<h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
<p>#include <a class="reference external" href="https://github.com/geopm/geopm/blob/dev/src/MSRIOGroup.hpp"><geopm/MSRIOGroup.hpp></a></p>
<p><code class="docutils literal notranslate"><span class="pre">Link</span> <span class="pre">with</span> <span class="pre">-lgeopm</span> <span class="pre">(MPI)</span> <span class="pre">or</span> <span class="pre">-lgeopmpolicy</span> <span class="pre">(non-MPI)</span></code></p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">virtual</span> <span class="pre">set<string></span> <span class="pre">signal_names(</span></code>:
<code class="docutils literal notranslate"><span class="pre">void)</span> <span class="pre">const</span> <span class="pre">=</span> <span class="pre">0</span></code>;</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">virtual</span> <span class="pre">set<string></span> <span class="pre">control_names(</span></code>:
<code class="docutils literal notranslate"><span class="pre">void)</span> <span class="pre">const</span> <span class="pre">=</span> <span class="pre">0</span></code>;</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">virtual</span> <span class="pre">bool</span> <span class="pre">is_valid_signal(</span></code>:
<cite>const string &`_signal*name*`</cite>) const = 0;``</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">virtual</span> <span class="pre">bool</span> <span class="pre">is_valid_control(</span></code>:
<cite>const string &`_control*name*`</cite>) const = 0;``</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">virtual</span> <span class="pre">int</span> <span class="pre">signal_domain_type(</span></code>:
<cite>const string &`_signal*name*`</cite>) const = 0;``</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">virtual</span> <span class="pre">int</span> <span class="pre">control_domain_type(</span></code>:
<cite>const string &`_control*name*`</cite>) const = 0;``</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">virtual</span> <span class="pre">int</span> <span class="pre">push_signal(</span></code>:
<cite>const string &`_signal*name*`</cite>,`` <span class="raw-html-m2r"><br></span>
<code class="docutils literal notranslate"><span class="pre">int</span></code> _domain<em>type</em><code class="docutils literal notranslate"><span class="pre">,</span></code> <span class="raw-html-m2r"><br></span>
<code class="docutils literal notranslate"><span class="pre">int</span></code> _domain<em>idx</em><code class="docutils literal notranslate"><span class="pre">)</span> <span class="pre">=</span> <span class="pre">0</span></code>;</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">virtual</span> <span class="pre">int</span> <span class="pre">push_control(</span></code>:
<cite>const string &`_control*name*`</cite>,`` <span class="raw-html-m2r"><br></span>
<code class="docutils literal notranslate"><span class="pre">int</span></code> _domain<em>type</em><code class="docutils literal notranslate"><span class="pre">,</span></code> <span class="raw-html-m2r"><br></span>
<code class="docutils literal notranslate"><span class="pre">int</span></code> _domain<em>idx</em><code class="docutils literal notranslate"><span class="pre">)</span> <span class="pre">=</span> <span class="pre">0</span></code>;</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">virtual</span> <span class="pre">void</span> <span class="pre">read_batch(</span></code>:
<code class="docutils literal notranslate"><span class="pre">void)</span> <span class="pre">=</span> <span class="pre">0</span></code>;</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">virtual</span> <span class="pre">void</span> <span class="pre">write_batch(</span></code>:
<code class="docutils literal notranslate"><span class="pre">void)</span> <span class="pre">=</span> <span class="pre">0</span></code>;</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">virtual</span> <span class="pre">double</span> <span class="pre">sample(</span></code>:
<code class="docutils literal notranslate"><span class="pre">int</span></code> _sample<em>idx</em><code class="docutils literal notranslate"><span class="pre">)</span> <span class="pre">=</span> <span class="pre">0;</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">virtual</span> <span class="pre">void</span> <span class="pre">adjust(</span></code>:
<code class="docutils literal notranslate"><span class="pre">int</span></code> _control<em>idx</em><code class="docutils literal notranslate"><span class="pre">,</span></code> <span class="raw-html-m2r"><br></span>
<code class="docutils literal notranslate"><span class="pre">double</span></code> <em>setting</em><code class="docutils literal notranslate"><span class="pre">)</span> <span class="pre">=</span> <span class="pre">0;</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">virtual</span> <span class="pre">double</span> <span class="pre">read_signal(</span></code>:
<cite>const string &`_signal*name*`</cite>,`` <span class="raw-html-m2r"><br></span>
<code class="docutils literal notranslate"><span class="pre">int</span></code> _domain<em>type</em><code class="docutils literal notranslate"><span class="pre">,</span></code> <span class="raw-html-m2r"><br></span>
<code class="docutils literal notranslate"><span class="pre">int</span></code> _domain<em>idx</em><code class="docutils literal notranslate"><span class="pre">)</span> <span class="pre">=</span> <span class="pre">0;</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">virtual</span> <span class="pre">void</span> <span class="pre">write_control(</span></code>:
<cite>const string &`_control*name*`</cite>,`` <span class="raw-html-m2r"><br></span>
<code class="docutils literal notranslate"><span class="pre">int</span></code> _domain<em>type</em><code class="docutils literal notranslate"><span class="pre">,</span></code> <span class="raw-html-m2r"><br></span>
<code class="docutils literal notranslate"><span class="pre">int</span></code> _domain<em>idx</em><code class="docutils literal notranslate"><span class="pre">,</span></code> <span class="raw-html-m2r"><br></span>
<code class="docutils literal notranslate"><span class="pre">double</span></code> <em>setting</em><code class="docutils literal notranslate"><span class="pre">)</span> <span class="pre">=</span> <span class="pre">0;</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">virtual</span> <span class="pre">void</span> <span class="pre">save_control(</span></code>:
<code class="docutils literal notranslate"><span class="pre">void)</span> <span class="pre">=</span> <span class="pre">0</span></code>;</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">virtual</span> <span class="pre">void</span> <span class="pre">restore_control(</span></code>:
<code class="docutils literal notranslate"><span class="pre">void)</span> <span class="pre">=</span> <span class="pre">0</span></code>;</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">virtual</span> <span class="pre">function<double(const</span> <span class="pre">vector<double></span> <span class="pre">&)></span> <span class="pre">agg_function(</span></code>:
<cite>const string &`_signal*name*`</cite>) const = 0;``</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">virtual</span> <span class="pre">string</span> <span class="pre">signal_description(</span></code>:
<cite>const string &`_signal*name*`</cite>) const = 0;``</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">virtual</span> <span class="pre">string</span> <span class="pre">control_description(</span></code>:
<cite>const string &`_control*name*`</cite>) const = 0;``</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">std::string</span> <span class="pre">msr_allowlist(</span></code>:
<code class="docutils literal notranslate"><span class="pre">void)</span> <span class="pre">const;</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">std::string</span> <span class="pre">msr_allowlist(</span></code>:
<cite>int `_cpuid_`</cite>) const;``</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">int</span> <span class="pre">cpuid(</span></code>:
<code class="docutils literal notranslate"><span class="pre">void)</span> <span class="pre">const;</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">void</span> <span class="pre">register_msr_signal(</span></code>:
<cite>const std::string &`_signal*name*`</cite>);``</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">void</span> <span class="pre">register_msr_control(</span></code>:
<cite>const std::string &`_control*name*`</cite>);``</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">static</span> <span class="pre">std::string</span> <span class="pre">plugin_name(</span></code>:
<code class="docutils literal notranslate"><span class="pre">void);</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">static</span> <span class="pre">std::unique_ptr<IOGroup></span> <span class="pre">make_plugin(</span></code>:
<code class="docutils literal notranslate"><span class="pre">void);</span></code></p></li>
</ul>
</section>
<section id="description">
<h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>The MSRIOGroup implements the <a class="reference external" href="GEOPM_CXX_MAN_IOGroup.3.html">geopm::IOGroup(3)</a> interface to
provide hardware signals and controls using MSRs on Intel platforms.
It relies on <strong>geopm::MSR(3)</strong> and <a class="reference external" href="GEOPM_CXX_MAN_MSRIO.3.html">geopm::MSRIO(3)</a>.</p>
</section>
<section id="class-methods">
<h2>CLASS METHODS<a class="headerlink" href="#class-methods" title="Permalink to this headline"></a></h2>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">signal_names</span></code>():
Returns the list of signal names provided by this IOGroup. This
includes aliases for common hardware-based signals such as
CPU_FREQUENCY_STATUS, as well as the supported MSRs for the current platform.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">control_names</span></code>():
Returns the list of control names provided by this IOGroup. This
includes aliases for common hardware-based controls such as
CPU_FREQUENCY_CONTROL, as well as the supported MSRs for the current platform.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">is_valid_signal</span></code>():
Returns whether the given _signal<em>name</em> is supported by the
MSRIOGroup for the current platform. Note that different
platforms may have different supported MSRs.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">is_valid_control</span></code>():
Returns whether the given _control<em>name</em> is supported by the
MSRIOGroup for the current platform. Note that different
platforms may have different supported MSRs.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">signal_domain_type</span></code>():
Returns the domain type for the the signal specified by
_signal<em>name</em>. The domain for a signal may be different on
different platforms.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">control_domain_type</span></code>():
Returns the domain type for the the control specified by
_control<em>name</em>. The domain for a control may be different on
different platforms.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">push_signal</span></code>():
Adds the signal specified by _signal<em>name</em> for _domain<em>type</em> at
index _domain<em>idx</em> to the list of signals to be read during
read_batch(). If the domain of a signal spans multiple Linux
logical CPUs, only one CPU from that domain will be read, since
all CPUs from the same domain and index will return the same
value.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">push_control</span></code>():
Adds the control specified by _control<em>name</em> for _domain<em>type</em> at
index _domain<em>idx</em> to the list of controls to be written during
write_batch(). If the domain of a control spans multiple Linux
logical CPUs, values written to that control will be written to
all CPUs in the domain.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">read_batch</span></code>():
Sets up <a class="reference external" href="GEOPM_CXX_MAN_MSRIO.3.html">geopm::MSRIO(3)</a> for batch reading if needed, then reads
all pushed signals through the MSRIO::read_batch() method.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">write_batch</span></code>():
Writes all adjusted values through the <a class="reference external" href="GEOPM_CXX_MAN_MSRIO.3.html">geopm::MSRIO(3)</a>
write_batch() method.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sample</span></code>():
Returns the value of the signal specified by a _signal<em>idx</em>
returned from push_signal(). The value will have been updated by
the most recent call to read_batch().</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">adjust</span></code>():
Sets the control specified by a _control<em>idx</em> returned from
push_control() to the value <em>setting</em>. The value will be written
to the underlying MSR by the next call to write_batch().</p></li>
<li><dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">read_signal</span></code>():</dt><dd><p>Immediately read and decode the underlying MSR supporting</p>
</dd>
</dl>
<p>_signal<em>name</em> for _domain<em>type</em> at index _domain<em>idx</em> and return
the result in SI units.</p>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">write_control</span></code>():
Immediately encode the SI unit value <em>setting</em> and write the
correct bits of the MSR supporting _control<em>name</em> for
_domain<em>type</em> at _domain<em>idx</em>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">save_control</span></code>():
Attempts to read and save the current values of all control MSRs
for the platform. If any control is not able to be read, it will
be skipped.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">restore_control</span></code>():
Using the values saved by save_control(), attempts to write back
the original values of all control MSRs. Any control that is not
able to be written will be skipped.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">agg_function</span></code>():
Returns the function that should be used to aggregate
_signal<em>name</em>. If one was not previously specified by this class,
the default function is select_first from <a class="reference external" href="GEOPM_CXX_MAN_Agg.3.html">geopm::Agg(3)</a>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">signal_description</span></code>():
Returns a string description for _signal<em>name</em>, if defined.
Further descriptions of MSR signals can be found in The Intel
Software Developer's Manual at
<a class="reference external" href="https://software.intel.com/en-us/articles/intel-sdm">https://software.intel.com/en-us/articles/intel-sdm</a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">control_description</span></code>():
Returns a string description for _control<em>name</em>, if defined.
Further descriptions of MSR controls can be found in The Intel
Software Developer's Manual at
<a class="reference external" href="https://software.intel.com/en-us/articles/intel-sdm">https://software.intel.com/en-us/articles/intel-sdm</a>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">signal_behavior</span></code>():
Returns one of the IOGroup::signal_behavior_e values which
describes about how a signal will change as a function of time.
This can be used when generating reports to decide how to
summarize a signal's value for the entire application run.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">msr_allowlist</span></code>():
Fill string with the msr-safe allowlist file contents reflecting
all known MSRs for the current platform, or if <em>cpuid</em> is
provided, for the platform specified by <em>cpuid</em>. Returns a string
formatted to be written to an msr-safe allowlist file.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">cpuid</span></code>():
Get the cpuid of the current platform.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">register_msr_signal</span></code>():
Register a single MSR field as a signal. This is called by
init_msr(). The _signal<em>name</em> is a compound signal name of the
form "msr_name:field_name" where msr_name is the name of the MSR
and the field_name is the name of the signal field held in the
MSR.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">register_msr_control</span></code>():
Register a single MSR field as a control. This is called by
init_msr(). The _control<em>name</em> is a compound control name of the
form "msr_name:field_name" where msr_name is the name of the MSR
and the field_name is the name of the control field held in the
MSR.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">plugin_name</span></code>():
Returns the name of the plugin to use when this plugin is
registered with the IOGroup factory; see
<a class="reference external" href="GEOPM_CXX_MAN_PluginFactory.3.html">geopm::PluginFactory(3)</a> for more details.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">make_plugin</span></code>():
Returns a pointer to a new MSRIOGroup object; see
<a class="reference external" href="GEOPM_CXX_MAN_PluginFactory.3.html">geopm::PluginFactory(3)</a> for more details.</p></li>
</ul>
</section>
<section id="enumerations">
<h2>ENUMERATIONS<a class="headerlink" href="#enumerations" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">enum</span> <span class="pre">m_cpuid_e</span></code>:
Contains the list of currently-supported cpuid values. The cpuid
can be determined by running <code class="docutils literal notranslate"><span class="pre">lscpu</span></code> and appending the CPU family
in hex to the Model in hex.</p></li>
</ul>
</section>
<section id="environment">
<h2>ENVIRONMENT<a class="headerlink" href="#environment" title="Permalink to this headline"></a></h2>
<p>If the <code class="docutils literal notranslate"><span class="pre">GEOPM_PLUGIN_PATH</span></code> environment variable is set to a
colon-separated list of paths, the paths will be checked for files
starting with "<a href="#id7"><span class="problematic" id="id8">msr_</span></a>" and ending in ".json". The default plugin path
will also be searched. The MSRIOGroup will attempt to load additional
MSR definitions from any JSON file it finds. The files must follow this
schema:</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="nt">"$schema"</span><span class="p">:</span> <span class="s2">"http://json-schema.org/draft-04/schema#"</span><span class="p">,</span>
<span class="nt">"id"</span><span class="p">:</span> <span class="s2">"https://geopm.github.io/msrs.schema.json"</span><span class="p">,</span>
<span class="nt">"title"</span><span class="p">:</span> <span class="s2">"MSR specification"</span><span class="p">,</span>
<span class="nt">"definitions"</span> <span class="p">:</span> <span class="p">{</span>
<span class="nt">"msrFields"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"type"</span><span class="p">:</span> <span class="s2">"object"</span><span class="p">,</span>
<span class="nt">"properties"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"begin_bit"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"type"</span><span class="p">:</span> <span class="s2">"integer"</span>
<span class="p">},</span>
<span class="nt">"end_bit"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"type"</span><span class="p">:</span> <span class="s2">"integer"</span>
<span class="p">},</span>
<span class="nt">"function"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"enum"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"scale"</span><span class="p">,</span> <span class="s2">"log_half"</span><span class="p">,</span> <span class="s2">"7_bit_float"</span><span class="p">,</span> <span class="s2">"overflow"</span><span class="p">]</span>
<span class="p">},</span>
<span class="nt">"units"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"enum"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"none"</span><span class="p">,</span> <span class="s2">"seconds"</span><span class="p">,</span> <span class="s2">"hertz"</span><span class="p">,</span> <span class="s2">"watts"</span><span class="p">,</span> <span class="s2">"joules"</span><span class="p">,</span> <span class="s2">"celsius"</span><span class="p">]</span>
<span class="p">},</span>
<span class="nt">"scalar"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"type"</span><span class="p">:</span> <span class="s2">"number"</span>
<span class="p">},</span>
<span class="nt">"behavior"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"enum"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"constant"</span><span class="p">,</span> <span class="s2">"monotone"</span><span class="p">,</span> <span class="s2">"variable"</span><span class="p">,</span> <span class="s2">"label"</span><span class="p">]</span>
<span class="p">},</span>
<span class="nt">"writeable"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"type"</span><span class="p">:</span> <span class="s2">"boolean"</span>
<span class="p">},</span>
<span class="nt">"aggregation"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"enum"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"sum"</span><span class="p">,</span> <span class="s2">"average"</span><span class="p">,</span> <span class="s2">"median"</span><span class="p">,</span> <span class="s2">"logical_and"</span><span class="p">,</span> <span class="s2">"logical_or"</span><span class="p">,</span> <span class="s2">"region_hash"</span><span class="p">,</span> <span class="s2">"region_hint"</span><span class="p">,</span> <span class="s2">"min"</span><span class="p">,</span> <span class="s2">"max"</span><span class="p">,</span> <span class="s2">"stddev"</span><span class="p">,</span> <span class="s2">"select_first"</span><span class="p">,</span> <span class="s2">"expect_same"</span><span class="p">]</span>
<span class="p">},</span>
<span class="nt">"description"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"type"</span><span class="p">:</span> <span class="s2">"string"</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="nt">"required"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"begin_bit"</span><span class="p">,</span> <span class="s2">"end_bit"</span><span class="p">,</span> <span class="s2">"function"</span><span class="p">,</span> <span class="s2">"scalar"</span><span class="p">,</span> <span class="s2">"units"</span><span class="p">,</span> <span class="s2">"writeable"</span><span class="p">,</span> <span class="s2">"behavior"</span><span class="p">],</span>
<span class="nt">"additionalProperties"</span><span class="p">:</span> <span class="kc">false</span>
<span class="p">},</span>
<span class="nt">"msrObject"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"type"</span><span class="p">:</span> <span class="s2">"object"</span><span class="p">,</span>
<span class="nt">"properties"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"offest"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"type"</span><span class="p">:</span> <span class="s2">"string"</span>
<span class="p">},</span>
<span class="nt">"domain"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"enum"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"board"</span><span class="p">,</span> <span class="s2">"package"</span><span class="p">,</span> <span class="s2">"core"</span><span class="p">,</span> <span class="s2">"cpu"</span><span class="p">,</span> <span class="s2">"board_memory"</span><span class="p">,</span> <span class="s2">"package_memory"</span><span class="p">,</span> <span class="s2">"board_nic"</span><span class="p">,</span> <span class="s2">"package_nic"</span><span class="p">,</span> <span class="s2">"board_accelerator"</span><span class="p">,</span> <span class="s2">"package_accelerator"</span><span class="p">,</span> <span class="s2">"board_accelerator_chip"</span><span class="p">]</span>
<span class="p">},</span>
<span class="nt">"fields"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"type"</span><span class="p">:</span> <span class="s2">"object"</span><span class="p">,</span>
<span class="nt">"additionalProperties"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"$ref"</span><span class="p">:</span> <span class="s2">"#/definitions/msrFields"</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="p">},</span>
<span class="nt">"required"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"offset"</span><span class="p">,</span> <span class="s2">"domain"</span><span class="p">,</span> <span class="s2">"fields"</span><span class="p">],</span>
<span class="nt">"additionalProperties"</span><span class="p">:</span> <span class="kc">false</span>
<span class="p">},</span>
<span class="p">},</span>
<span class="nt">"type"</span><span class="p">:</span> <span class="s2">"object"</span><span class="p">,</span>
<span class="nt">"properties"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"msrs"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"type"</span><span class="p">:</span> <span class="s2">"object"</span><span class="p">,</span>
<span class="nt">"additionalProperties"</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">"$ref"</span><span class="p">:</span> <span class="s2">"#/definitions/msrObject"</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="nt">"additionalProperties"</span><span class="p">:</span> <span class="kc">false</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Refer to the documentation for <code class="docutils literal notranslate"><span class="pre">--geopm-plugin-path</span></code> in
<a class="reference external" href="geopmlaunch.1.html">geopmlaunch(1)</a>.</p>
</section>
<section id="see-also">
<h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><a class="reference external" href="geopm.7.html">geopm(7)</a>,
<a class="reference external" href="GEOPM_CXX_MAN_IOGroup.3.html">geopm::IOGroup(3)</a>,
<strong>geopm::MSR(3)</strong>,
<a class="reference external" href="GEOPM_CXX_MAN_MSRIO.3.html">geopm::MSRIO(3)</a>,
<a class="reference external" href="geopmlaunch.1.html">geopmlaunch(1)</a></p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="GEOPM_CXX_MAN_MSRIO.3.html" class="btn btn-neutral float-left" title="geopm::MSRIO(3) -- methods for reading and writing MSRs" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="GEOPM_CXX_MAN_MonitorAgent.3.html" class="btn btn-neutral float-right" title="geopm::MonitorAgent -- agent that enforces no policies" 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>