Skip to content

Commit 3f18ae2

Browse files
committed
add short blurb for users about c ABI support
and how to use it Signed-off-by: Howard Pritchard <[email protected]>
1 parent 43a3314 commit 3f18ae2

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

docs/building-apps/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Open MPI "wrapper" compilers.
1414
removed-mpi-constructs
1515
deprecation-warnings
1616
building-static-apps
17+
mpi-abi
1718

1819
.. warning:: Open MPI does not attempt to interoperate with other MPI
1920
implementations, nor executables that were compiled for

docs/building-apps/mpi-abi.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
.. _label-building-with-mpi-abi:
2+
3+
Building MPI applications using the MPI ABI
4+
===========================================
5+
6+
What is the MPI ABI
7+
-------------------
8+
9+
Starting with MPI 5.0, the MPI standard specifies an ABI for the c and
10+
Fortran MPI interfaces. In this release, Open MPI supports the c
11+
part of the MPI ABI.
12+
13+
By using the MPI ABI, an MPI application can be built against one
14+
implementation of MPI that supports the MPI ABI, and later run using
15+
the MPI ABI compliant MPI library generated using a different MPI
16+
implementation. This assumes that the application is dynamically linked.
17+
18+
The MPI 5.0 standard specifies the file name of the MPI ABI compliant
19+
library - libmpi_abi. The major version of the library is 1 and minor
20+
version is 0.
21+
22+
How to build an application using the MPI ABI
23+
---------------------------------------------
24+
25+
To build an application against the MPI ABI compliant Open MPI library,
26+
the ``mpicc_abi`` compiler wrapper must be used for compiling and
27+
linking the application or shared library.
28+
29+
This release does not support the Fortran ABI so there is no ``mpifort_abi``
30+
compiler wrapper. This mixed c/Fortran MPI apps cannot make use of the
31+
MPI ABI library with this release.
32+
33+

0 commit comments

Comments
 (0)