ABI: add option to build libmpi_abi.so #6390
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hzhou
force-pushed
the
2302_abi
branch
3 times, most recently
from
237b902
to
086c8d6
Compare
|
So instead of calling PMPI from the ABI compat layer, we now have basically a duplicate binding layer, right? To be clear, IMO, this is a good thing. It should allow support for PMPI/QMPI tools and avoids the patent issue noted by @jeffhammond. |
Yes. The ABI binding will not contain any QMPI or MPIX stuff (until standardized). I essentially grabbed the mpi_abi.h from @jeffhammond https://github.com/jeffhammond/mukautuva -- BTW, it is missing MPI_T typedefs. This PR will omit the MPI-IO for now since we haven't migrated the ROMIO binding layer yet. |
|
@jeffhammond Could you consolidate the header files into |
|
Yeah, I think I am close enough to do that. I'll work on it tomorrow. |
hzhou
force-pushed
the
2302_abi
branch
2 times, most recently
from
916136b
to
4249e14
Compare
hzhou
force-pushed
the
2302_abi
branch
4 times, most recently
from
6c7cc7d
to
5e2129a
Compare
|
test:mpich/ch3/most ✔️ 1 unrelated failure - |
hzhou
force-pushed
the
2302_abi
branch
6 times, most recently
from
05b8e0d
to
faa83d1
Compare
4 tasks
hzhou
force-pushed
the
2302_abi
branch
3 times, most recently
from
c4f3a52
to
cfcfd5e
Compare
* Try avoid print handle as int * MPI_MESSAGE_NULL may not be MPI_REQUEST_NULL * MPI_Comm may not be the same as MPI_Win * Cast to (long long) to print MPI_Count
We should not assume handles to be of integer type.
Custom clean up code (ref. MPI_Comm_spawn_multiple) are loaded in func['code-clean_up']. We need avoid overwriting this attribute or we will lose the custom cleanup code then function is being processed twice.
Newer gcc warns when non-null array constants such as MPI_UNWEIGHTED is passed to paramber typed as "int param[]". Make the parameter type simply a pointer avoids such warnings.
Remove the assumption that MPI_PROC_NULL is -1 and MPI_ANY_SOURCE is -2.
The constants may be defined as negative integers, as in the current ABI draft.
MPID_MAX_PORT_NAME is 1024, and it is the same as abi MPI_MAX_PORT_NAME. Alternatively, we can raise MPID_MAX_PORT_NAME to higher value.
This is a stand-in mpi_abi.h, extracted from https://github.com/jeffhammond/mukautuva.
Then internal code need deal with both the types from ABI header and the
actual types used by MPICH. Generate mpi_abi_internal.h from mpi_abi.h
by renaming all MPI_ typenames into ABI_ prefix. Generate mpi_abi_util.c
to initialize an internal table for builtin datatypes and ops
conversions.
Generates:
src/binding/abi/mpi_abi_internal.h
src/binding/abi/mpi_abi_util.c
Various conversion functions.
Use --enable-mpi-abi configure option to enable build and installing libmpi_abi.so.
Dump c_binding_abi.c, to be linked into libmpi_abi.so.
If MPI_ABI is defined, make mpi.h to effectively the same as mpi_abi.h. This allows applications to use mpicc_abi to compile their code without any changes.
When BUILD_MPI_ABI is defined, include mpi_abi_internal.h, and exclude the portion that defines constants and typedefs that are already defined in mpi_abi_internal.h. We essentially swapping the ABI for all internal code. Note that we need to always define the MPICH specific parts or some internal code won't build. MPICH_SUPPRESS_PROTOTYPES is no longer used, so we removed it.
Internal all handles object may not be part of the ABI. Add check macro to replace it on entry.
The ABI signature of callback functions can be different. We need convert the handle input upon calling callbacks.
MPI-5 ABI may define various DUP_FN as constants. We can easily swap them during input.
MPI_COMBINER_HVECTOR_INTEGER, MPI_COMBINER_HINDEXED_INTEGER, and MPI_COMBINER_STRUCT_INTEGER are removed in the current MPI standards and thus can be missing from the abi header. Add macro-guard to prevent compile failures.
* Pass --enable-mpi-abi to romio configure * Build libromio_abi.so and libpromio_abi.so when enabled * Include mpi_abi.h instead of mpi.h when BUILD_MPI_ABI is defined * internally adio.h will include mpio.h without abi, and romio_abi_internal.h with abi. I.e. mpio.h is skipped ifdef BUILD_MPI_ABI.
Three routines are defined in ROMIO, potentially using ABI header. We need handler conversion to use inside MPICH. Only include mpir_ext.h in the code that needs it. With BUILD_MPI_ABI, we need alter the function parameter types for conversions. Since we no longer include mpir_ext.h in the binding files, we need explicitly declare them. We can treat them as void pointers to avoid the distinction between ABI and non-ABI versions.
ROMIO directly uses the MPI ABI header since it sits on top of the MPI layer. As such, we need add ABI handle conversions for functions defined in MPICH and called by ROMIO. Define them all in src/glue/romio/glue_romio.c.
Update builtin handle constants based on upstream huffman coding scheme. Ref: https://github.com/mpiwg-abi/specification-text-draft/blob/main/print-handle-constants.py
Update constant definitions based on upstream reference - https://github.com/mpiwg-abi/specification-text-draft/blob/main/IntegerConstants.md
Taking mpi.h from https://github.com/mpiwg-abi/header_and_stub_library at commit 38a272b.
raffenet
approved these changes
Dec 13, 2023
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Description
Reference the current MPI ABI working group: https://github.com/mpiwg-abi
This pr enable mpich to build libmpi_abi.so, which conforms to the new (in-progress) MPI ABI standard
Use
--enable-mpi-abito enable it.To test
Points
For users
mpiccbuilds mpich abi,mpicc_abibuilds mpi5 abilibmpi.souses mpich abi,libmpi_abi.souses mpi5 abimpi.hwill effectively becomempi_abi.hwhenmpicc_abiis used. User code always#include <mpi.h>implementations
src/binding/abi/mpi_abi_util.cprovides the shim for ABI link-time constantssrc/binding/abi/mpi_abi_util.hprovides conversion routinessrc/binding/abi/c_binding_abi.cprovides all theMPI_andPMPI_functionsmpi_abi_internal.hfrommpi_abi.hfor internal use (mpi_abi_util.candc_binding_abi.c)Notes
Let's push for
MPI_Aint/Offset/Count/Fintto be compatible ABIMPICH will need to support both MPICH ABI and MPI-5 ABI for the foreseeable future
Open MPI likely can use MPI-5 ABI directly for its future versions
MPI handler constant objects need to use pointers in ABI; MPICH can dereference its handle
Scalar constants
Author Checklist
Particularly focus on why, not what. Reference background, issues, test failures, xfail entries, etc.
Commits are self-contained and do not do two things at once.
Commit message is of the form:
module: short descriptionCommit message explains what's in the commit.
Whitespace checker. Warnings test. Additional tests via comments.
For non-Argonne authors, check contribution agreement.
If necessary, request an explicit comment from your companies PR approval manager.