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
|
<!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>12.8. Internal frameworks — OpenPMIx 5.0.8a1 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.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/sphinx_highlight.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="12.9. Manually installing the GNU Autootools" href="gnu-autotools.html" />
<link rel="prev" title="12.7. Source code" href="source-code.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">
OpenPMIx
</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" aria-label="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="../quickstart.html">1. Quick start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-help.html">2. Getting help</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release-notes/index.html">3. Release notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../exceptions.html">4. Exceptions to the PMIx Standard</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installing-pmix/index.html">5. Building and installing PMIx</a></li>
<li class="toctree-l1"><a class="reference internal" href="../how-things-work/index.html">6. How Things Work</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release-notes.html">7. Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../history.html">8. History</a></li>
<li class="toctree-l1"><a class="reference internal" href="../versions.html">9. Version Numbers and Binary Compatibility</a></li>
<li class="toctree-l1"><a class="reference internal" href="../mca.html">10. The Modular Component Architecture (MCA)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../building-apps/index.html">11. Building PMIx applications</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">12. Developer’s guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="prerequisites.html">12.1. Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="git-github.html">12.2. GitHub, Git, and related topics</a></li>
<li class="toctree-l2"><a class="reference internal" href="compiler-pickyness.html">12.3. Compiler Pickyness by Default</a></li>
<li class="toctree-l2"><a class="reference internal" href="autogen.html">12.4. Running <code class="docutils literal notranslate"><span class="pre">autogen.pl</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="building-pmix.html">12.5. Building PMIx</a></li>
<li class="toctree-l2"><a class="reference internal" href="terminology.html">12.6. OpenPMIx terminology</a></li>
<li class="toctree-l2"><a class="reference internal" href="source-code.html">12.7. Source code</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">12.8. Internal frameworks</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#framework-notes">12.8.1. Framework notes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#mca-parameter-notes">12.8.2. MCA parameter notes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="gnu-autotools.html">12.9. Manually installing the GNU Autootools</a></li>
<li class="toctree-l2"><a class="reference internal" href="sphinx.html">12.10. Installing and running Sphinx (building the OpenPMIx docs)</a></li>
<li class="toctree-l2"><a class="reference internal" href="rst-for-markdown-expats.html">12.11. ReStructured Text for those who know Markdown</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">13. Contributing to OpenPMIx</a></li>
<li class="toctree-l1"><a class="reference internal" href="../license.html">14. License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security.html">15. OpenPMIx Security Policy</a></li>
<li class="toctree-l1"><a class="reference internal" href="../news/index.html">16. News</a></li>
<li class="toctree-l1"><a class="reference internal" href="../man/index.html">17. OpenPMIx manual pages</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">OpenPMIx</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" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="index.html"><span class="section-number">12. </span>Developer’s guide</a></li>
<li class="breadcrumb-item active"><span class="section-number">12.8. </span>Internal frameworks</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/developers/frameworks.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">
<style>
.wy-table-responsive table td,.wy-table-responsive table th{white-space:normal}
</style><div class="section" id="internal-frameworks">
<span id="label-frameworks"></span><h1><span class="section-number">12.8. </span>Internal frameworks<a class="headerlink" href="#internal-frameworks" title="Permalink to this heading"></a></h1>
<p>The Modular Component Architecture (MCA) is the backbone of PMIx
– most services and functionality are implemented through MCA
components.</p>
<p>Here is a list of all the component frameworks in PMIx as of
this writing May-2025:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">bfrops</span></code>: Buffer Operations, including support for pack/unpack,
copy, print, compare, and load of data types and structured objects</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">gds</span></code>: Generalized DataStore for storing job-level and other data</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">pcompress</span></code>: Compress to support compression of large data objects</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">pdl</span></code>: DLopen support</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">pfexec</span></code>: Fork/Exec support to allow tools to start child processes</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">pgpu</span></code>: GPU support</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">pif</span></code>: Interface discovery</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">pinstalldirs</span></code>: Install Directories - provides a struct containing
all installation locations</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">plog</span></code>: Logging of user-provided alerts</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">pmdl</span></code>: Programming Model - provides support for a range of
programming models and libraries, including collection of default
parameters and environmental variables for forwarding and setting
of library-specific environmental variables</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">pnet</span></code>: Network support, including computation of endpoints to
support the <code class="docutils literal notranslate"><span class="pre">instant</span> <span class="pre">on</span></code> launch procedure</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">preg</span></code>: Regular expression generator and parser</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">prm</span></code>: Resource Manager support - translation of generic PMIx directives
(e.g., mapping and resource definitions) to RM-specific values and
general RM-specific support</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">psec</span></code>: Security operations such as connection handshakes</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">psensor</span></code>: Sensor framework for monitoring processes, including
resource utilization and state-of-health (e.g., heartbeat)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">psquash</span></code>: Internal framework for squashing integer data values
during transmission</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">pstat</span></code>: Statistics, including reporting resource usage at the
process, node, and disk levels</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ptl</span></code>: Transport Layer for client-server and tool-server
communication</p></li>
</ul>
<div class="section" id="framework-notes">
<h2><span class="section-number">12.8.1. </span>Framework notes<a class="headerlink" href="#framework-notes" title="Permalink to this heading"></a></h2>
<p>Each framework typically has one or more components that are used at
run-time. For example, the <code class="docutils literal notranslate"><span class="pre">bfrops</span></code> framework is used by PMIx
to pack/unpack data for transmission, copy data objects, and other
data manipulation operations. The <code class="docutils literal notranslate"><span class="pre">v3</span></code> component, for example,
supports the data object definitions introduced in v3 of the
library, while the <code class="docutils literal notranslate"><span class="pre">v41</span></code> component supports those introduced
in v4.1.</p>
</div>
<div class="section" id="mca-parameter-notes">
<h2><span class="section-number">12.8.2. </span>MCA parameter notes<a class="headerlink" href="#mca-parameter-notes" title="Permalink to this heading"></a></h2>
<p>Each component typically has some tunable parameters that can be
changed at run-time. Use the <a class="reference internal" href="../man/man1/pmix_info.1.html#man1-pmix-info"><span class="std std-ref">pmix_info(1)</span></a>
command to check a component to see what its tunable parameters are.
For example:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>shell$<span class="w"> </span>pmix_info<span class="w"> </span>--param<span class="w"> </span>psensor<span class="w"> </span>file
</pre></div>
</div>
<p>shows the parameters (and default values) for the <code class="docutils literal notranslate"><span class="pre">file</span></code> <code class="docutils literal notranslate"><span class="pre">psensor</span></code>
component.</p>
<p>See <a class="reference internal" href="../mca.html#label-running-setting-mca-param-values"><span class="std std-ref">this section</span></a> for
details on how to set MCA parameters at run time.</p>
</div>
</div>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="source-code.html" class="btn btn-neutral float-left" title="12.7. Source code" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="gnu-autotools.html" class="btn btn-neutral float-right" title="12.9. Manually installing the GNU Autootools" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2014-2025, OpenPMIx Community.
<span class="lastupdated">Last updated on 2025-05-30 16:40:24 UTC.
</span></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>
|
