forked from geopm/geopm.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclient.html
143 lines (129 loc) · 7.25 KB
/
client.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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Guide for Service Clients — 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="Guide for HPC Runtime Users" href="runtime.html" />
<link rel="prev" title="Guide for Service Administrators" href="admin.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 current"><a class="reference internal" href="service.html">Guide for Service Users</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="service_readme.html">GEOPM Service</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html">Guide to Service Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="requires.html">Guide to Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="build.html">Guide to Source Builds</a></li>
<li class="toctree-l2"><a class="reference internal" href="security.html">Guide to Service Security</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin.html">Guide for Service Administrators</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Guide for Service Clients</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#reading-instructions-retired">Reading Instructions Retired</a></li>
</ul>
</li>
</ul>
</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"><a class="reference internal" href="reference.html">Reference Manual</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">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="service.html">Guide for Service Users</a> »</li>
<li>Guide for Service Clients</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/client.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">
<div class="section" id="guide-for-service-clients">
<h1>Guide for Service Clients<a class="headerlink" href="#guide-for-service-clients" title="Permalink to this heading"></a></h1>
<p>The <code class="docutils literal notranslate"><span class="pre">geopmsession</span></code> command line tool is one way to use the GEOPM
Service's client facing DBus APIs. This provides an easy way to read
signals once, read them periodically, or write to a set of controls
for the lifetime of the session. Note that the system administrator
must grant access to the signals or controls with the <code class="docutils literal notranslate"><span class="pre">geopmaccess</span></code>
command line tool before they will be available to a non-root user
with the <code class="docutils literal notranslate"><span class="pre">geopmsession</span></code> command.</p>
<div class="section" id="reading-instructions-retired">
<h2>Reading Instructions Retired<a class="headerlink" href="#reading-instructions-retired" title="Permalink to this heading"></a></h2>
<p>In this example we will read the hardware counter that measures
instructions retired for Linux logical CPU 0 and 1. This read will be
done every 100 milliseconds for one second. Additionally we will read
the TIME signal for the first column of output. The result will be a
comma separated list of the three values read printed ten times to
standard output.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">echo</span> <span class="s2">"TIME board 0</span>
<span class="s2"> CPU_INSTRUCTIONS_RETIRED cpu 0</span>
<span class="s2"> CPU_INSTRUCTIONS_RETIRED cpu 1"</span> <span class="p">|</span> geopmsession -t <span class="m">1</span> -p <span class="m">0</span>.1
</pre></div>
</div>
</div>
</div>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="admin.html" class="btn btn-neutral float-left" title="Guide for Service Administrators" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="runtime.html" class="btn btn-neutral float-right" title="Guide for HPC Runtime Users" 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>