OpenPMIx v4.2.3rc2 — OpenPMIx 4.2.3rc2 documentation

# OpenPMIx v4.2.3rc2

The charter of the PMIx community is to:

1. 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).

2. Retain transparent compatibility with the existing PMI-1 and PMI-2 definitions, and any future PMI releases.

3. Support the Instant On initiative for rapid startup of applications at exascale and beyond.

4. Work with the HPC community to define and implement new APIs that support evolving programming model requirements for application-RM interactions.

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. A list of supported environments and versions is provided [here](etc) - please check regularly as the list is changing!

Error

The above paragraph refers to a list of supported environments and versions, but I don’t know what it is referring to. This text / link should be fixed.

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.

# Table of contents

- 1. Quick start
- 2. History
- 3. Release Notes
  - 3.1. General notes
  - 3.2. Compiler Notes
- 4. Exceptions to the PMIx Standard
  - 4.1. Extensions
  - 4.2. Utility APIs
  - 4.3. Argv Handling
  - 4.4. Value Struct Functions
  - 4.5. Data Array Functions
  - 4.6. Info Struct Functions
  - 4.7. Coordinate Struct Functions
  - 4.8. Topology Functions
  - 4.9. Cpuset Functions
  - 4.10. Geometry Functions
  - 4.11. Device Distance Functions
  - 4.12. Byte Object Functions
  - 4.13. Endpoint Functions
  - 4.14. Envar Functions
  - 4.15. Data Buffer Functions
  - 4.16. Proc Struct Functions
  - 4.17. Proc Info Functions
  - 4.18. Proc Stats Functions
  - 4.19. Disk Stats Functions
  - 4.20. Net Stats Functions
  - 4.21. Process Data Functions
  - 4.22. App Struct Functions
  - 4.23. PMIx Info List Functions
  - 4.24. Pretty-Print Functions
  - 4.25. Constants
  - 4.26. Attributes
  - 4.27. Datatypes
  - 4.28. Macros
- 5. Getting help
- 6. Installation
  - 6.1. Developer Builds
  - 6.2. User Builds
  - 6.3. `configure` options
  - 6.4. Building Static Libraries
- 7. Version Numbers and Binary Compatibility
  - 7.1. Software Version Number
  - 7.2. Shared Library Version Number
  - 7.3. Application Binary Interface (ABI) Compatibility
- 8. Developer’s guide
  - 8.1. Prerequisites
  - 8.2. GitHub, Git, and related topics
  - 8.3. Manually installing the GNU Autootools
  - 8.4. Installing and running Sphinx (building the OpenPMIx docs)
  - 8.5. ReStructured Text for those who know Markdown
- 9. Contributing to OpenPMIx
  - 9.1. Open source contributions
- 10. License
- 11. OpenPMIx Security Policy
  - 11.1. Vulnerability Disclosure Process
  - 11.2. Software Authenticity and Integrity
- 12. OpenPMIx manual pages
  - 12.1. Commands (section 1)
  - 12.2. APIs (section 3)
  - 12.3. Config file manual pages (section 5)