299 lines
21 KiB
HTML
299 lines
21 KiB
HTML
<!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>OpenPMIx v5.0.5 — OpenPMIx 5.0.5 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="1. Quick start" href="quickstart.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="#" 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>
|
||
<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"><a class="reference internal" href="developers/index.html">12. Developer’s guide</a></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="#">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="#" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item active">OpenPMIx v5.0.5</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="_sources/index.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="openpmix-opmix-ver">
|
||
<h1>OpenPMIx v5.0.5<a class="headerlink" href="#openpmix-opmix-ver" title="Permalink to this heading"></a></h1>
|
||
<p>The charter of the PMIx community is to:</p>
|
||
<ol class="arabic simple">
|
||
<li><p>Develop an open source (non-copy-left licensed) and independent
|
||
(i.e., not affiliated with any specific programming model code
|
||
base) standalone library to support application interactions with
|
||
Resource Managers (RMs).</p></li>
|
||
<li><p>Retain transparent compatibility with the existing PMI-1 and PMI-2
|
||
definitions, and any future PMI releases.</p></li>
|
||
<li><p>Support the <em>Instant On</em> initiative for rapid startup of
|
||
applications at exascale and beyond.</p></li>
|
||
<li><p>Work with the HPC community to define and implement new APIs that
|
||
support evolving programming model requirements for application-RM
|
||
interactions.</p></li>
|
||
</ol>
|
||
<blockquote>
|
||
<div><div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>You will see <code class="docutils literal notranslate"><span class="pre">OpenPMIx</span></code> frequently referred to
|
||
as just <code class="docutils literal notranslate"><span class="pre">PMIx</span></code>. While there is a separate PMIx Standard, there
|
||
are (as of this writing) no alternative implementations of that
|
||
Standard. In fact, the Standard post-dates the library by several
|
||
years, and often lags behind the library in terms of new definitions.
|
||
Thus, it is customary to refer to the library as just <code class="docutils literal notranslate"><span class="pre">PMIx</span></code> and
|
||
drop the longer name - at least, until some other implementation
|
||
arises (which many consider unlikely).</p>
|
||
</div>
|
||
</div></blockquote>
|
||
<p>PMIx is designed to be particularly easy for resource managers to
|
||
adopt, thus facilitating a rapid uptake into that community for
|
||
application portability. Both client and server libraries are
|
||
included, along with reference examples of client usage and
|
||
server-side integration.</p>
|
||
<p>PMIx targets support for the Linux operating system. A reasonable
|
||
effort is made to support all major, modern Linux distributions;
|
||
however, validation is limited to the most recent 2-3 releases of
|
||
RedHat Enterprise Linux (RHEL), Fedora, CentOS, and SUSE Linux
|
||
Enterprise Server (SLES). Support for vendor-specific operating
|
||
systems is included as provided by the vendor.</p>
|
||
</div>
|
||
<div class="section" id="table-of-contents">
|
||
<h1>Table of contents<a class="headerlink" href="#table-of-contents" title="Permalink to this heading"></a></h1>
|
||
<div class="toctree-wrapper compound">
|
||
<ul>
|
||
<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><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="release-notes/general.html">3.1. General notes</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="release-notes/platform.html">3.2. Platform Notes</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="release-notes/compilers.html">3.3. Compiler Notes</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="release-notes/run-time.html">3.4. General Run-Time Support Notes</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">4. Exceptions to the PMIx Standard</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#extensions">4.1. Extensions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#qualified-values">4.2. Qualified Values</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#scheduler-integration-apis">4.3. Scheduler Integration APIs</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#tool-apis">4.4. Tool APIs</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#utility-apis">4.5. Utility APIs</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#argv-handling">4.6. Argv Handling</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#value-struct-functions">4.7. Value Struct Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#data-array-functions">4.8. Data Array Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#info-struct-functions">4.9. Info Struct Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#coordinate-struct-functions">4.10. Coordinate Struct Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#topology-functions">4.11. Topology Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#cpuset-functions">4.12. Cpuset Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#geometry-functions">4.13. Geometry Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#device-distance-functions">4.14. Device Distance Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#byte-object-functions">4.15. Byte Object Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#endpoint-functions">4.16. Endpoint Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#envar-functions">4.17. Envar Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#data-buffer-functions">4.18. Data Buffer Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#proc-struct-functions">4.19. Proc Struct Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#proc-info-functions">4.20. Proc Info Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#proc-stats-functions">4.21. Proc Stats Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#disk-stats-functions">4.22. Disk Stats Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#net-stats-functions">4.23. Net Stats Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#process-data-functions">4.24. Process Data Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#app-struct-functions">4.25. App Struct Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#pmix-info-list-functions">4.26. PMIx Info List Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#pretty-print-functions">4.27. Pretty-Print Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#constants">4.28. Constants</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#attributes">4.29. Attributes</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#datatypes">4.30. Datatypes</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#macros">4.31. Macros</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="exceptions.html#scheduler-integration">4.32. Scheduler Integration</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="installing-pmix/index.html">5. Building and installing PMIx</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="installing-pmix/quickstart.html">5.1. Installation</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="installing-pmix/definitions.html">5.2. Definitions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="installing-pmix/filesystem-requirements.html">5.3. Filesystem requirements</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="installing-pmix/vpath-builds.html">5.4. VPATH builds</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="installing-pmix/compilers-and-flags.html">5.5. Specifying compilers and flags</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="installing-pmix/required-support-libraries.html">5.6. Required support libraries</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="installing-pmix/configure-cli-options/index.html">5.7. <code class="docutils literal notranslate"><span class="pre">configure</span></code> command line options</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="installing-pmix/configure-output-summary.html">5.8. <code class="docutils literal notranslate"><span class="pre">configure</span></code> output summary</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="installing-pmix/make-targets.html">5.9. <code class="docutils literal notranslate"><span class="pre">make</span></code> targets</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="installing-pmix/installation-location.html">5.10. Installation location</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="installing-pmix/packagers.html">5.11. Advice for packagers</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="how-things-work/index.html">6. How Things Work</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="how-things-work/session_dirs.html">6.1. Session Directories</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="release-notes.html">7. Release Notes</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="release-notes.html#general-notes">7.1. General notes</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="release-notes.html#compiler-notes">7.2. Compiler Notes</a></li>
|
||
</ul>
|
||
</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><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="versions.html#software-version-number">9.1. Software Version Number</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="versions.html#shared-library-version-number">9.2. Shared Library Version Number</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="versions.html#application-binary-interface-abi-compatibility">9.3. Application Binary Interface (ABI) Compatibility</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="versions.html#cross-version-compatibility">9.4. Cross-Version Compatibility</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="mca.html">10. The Modular Component Architecture (MCA)</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="mca.html#terminology">10.1. Terminology</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="mca.html#setting-mca-parameter-values">10.2. Setting MCA parameter values</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="mca.html#selecting-which-pmix-components-are-used-at-run-time">10.3. Selecting which PMIx components are used at run time</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="mca.html#common-mca-parameters">10.4. Common MCA parameters</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="building-apps/index.html">11. Building PMIx applications</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="building-apps/quickstart.html">11.1. Quick start: Building PMIx-based applications</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="building-apps/customizing-wrappers.html">11.2. Customizing wrapper compiler behavior</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="building-apps/extracting-wrapper-flags.html">11.3. Extracting flags from the wrapper compilers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="building-apps/deprecation-warnings.html">11.4. Deprecated Definitions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="building-apps/building-static-apps.html">11.5. Building fully-static PMIx applications</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="developers/index.html">12. Developer’s guide</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="developers/prerequisites.html">12.1. Prerequisites</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="developers/git-github.html">12.2. GitHub, Git, and related topics</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="developers/compiler-pickyness.html">12.3. Compiler Pickyness by Default</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="developers/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="developers/building-pmix.html">12.5. Building PMIx</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="developers/terminology.html">12.6. OpenPMIx terminology</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="developers/source-code.html">12.7. Source code</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="developers/frameworks.html">12.8. Internal frameworks</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="developers/gnu-autotools.html">12.9. Manually installing the GNU Autootools</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="developers/sphinx.html">12.10. Installing and running Sphinx (building the OpenPMIx docs)</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="developers/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><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="contributing.html#open-source-contributions">13.1. Open source contributions</a></li>
|
||
</ul>
|
||
</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><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="security.html#vulnerability-disclosure-process">15.1. Vulnerability Disclosure Process</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="security.html#software-authenticity-and-integrity">15.2. Software Authenticity and Integrity</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="news/index.html">16. News</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="news/news-v5.x.html">16.1. PMIx v5.x series</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="news/news-v4.x.html">16.2. PMIx v4.x series</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="news/news-v3.x.html">16.3. PMIx v3.x series</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="news/news-v2.x.html">16.4. PMIx v2.x series</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="news/news-v1.x.html">16.5. PMIx v1.x series</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="man/index.html">17. OpenPMIx manual pages</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="man/man1/index.html">17.1. Commands (section 1)</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="man/man3/index.html">17.2. APIs (section 3)</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="man/man5/index.html">17.3. Config file manual pages (section 5)</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="quickstart.html" class="btn btn-neutral float-right" title="1. Quick start" 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, The OpenPMIx Community.</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> |