SQUASH_ME: OMNIBUS COMMIT

mpi_info_toint/fromint prior to MPI_Init or MPI_Session_init
first pass at errhandler support
simplify python support for user-defined err handlers
VERSION - add support for versioning libmpi_abi
add a blurb about how current and age and revision
should work for this library.
add man pages for new MPI_Abi and fromint/toint functions
attributes - clean up extra helper data
using the bindings_extra_state arg to ompi_attr_create_keyval
add a readme about the MPI ABI support
fortran: add the MPI_Abi entry points
python framework: improve debugging
also import util module

Signed-off-by: Howard Pritchard <[email protected]>

Author: hppritcha

.gitignore

@@ -539,6 +539,7 @@ ompi/mpi/c/standard_*.c
 ompi/mpi/c/abi.h
 ompi/mpi/c/abi_get_info.c
 ompi/mpi/c/abi_converters.h
+ompi/mpi/c/abi_converters.c
 ompi/mpi/c/standard_abi
 ompi/mpi/tool/*_generated*.c
 

VERSION

@@ -20,7 +20,7 @@ minor=1
 release=0
 
 # MPI Standard Compliance Level
-mpi_standard_version=3
+mpi_standard_version=5
 mpi_standard_subversion=1
 
 # OMPI required dependency versions.
@@ -92,6 +92,14 @@ date="Unreleased developer copy"
 # but they are "public" within the OMPI code base and select 3rd party
 # software packages.
 
+# The current and age values of the libmpi_abi shared library are
+# implicitly determined by the MPI ABI definition of the
+# version of the MPI specification supported by this Open MPI release.
+# The MPI ABI is intended not to break backward compatibility,
+# so presumably the current and age values will move in lock step.
+# We assume we have flexibility with the revision number as
+# bugs are fixed, etc.
+
 # Version numbers are described in the Libtool current:revision:age
 # format.
 
@@ -100,6 +108,7 @@ libmpi_mpifh_so_version=0:0:0
 libmpi_usempi_tkr_so_version=0:0:0
 libmpi_usempi_ignore_tkr_so_version=0:0:0
 libmpi_usempif08_so_version=0:0:0
+libmpi_abi_so_version=0:0:0
 libopen_pal_so_version=0:0:0
 libmpi_java_so_version=0:0:0
 liboshmem_so_version=0:0:0

configure.ac

@@ -147,6 +147,7 @@ OPAL_SAVE_VERSION([OPAL], [Open Portable Access Layer], [$srcdir/VERSION],
 
 m4_ifdef([project_ompi],
          [AC_SUBST(libmpi_so_version)
+          AC_SUBST(libmpi_abi_so_version)
           AC_SUBST(libmpi_mpifh_so_version)
           AC_SUBST(libmpi_usempi_tkr_so_version)
           AC_SUBST(libmpi_usempi_ignore_tkr_so_version)

docs/Makefile.am

@@ -87,6 +87,12 @@ OMPI_MAN1 = \
         opal_wrapper.1
 
 OMPI_MAN3 = \
+        MPI_Abi_get_fortran_booleans.3 \
+        MPI_Abi_get_fortran_info.3 \
+        MPI_Abi_get_info.3 \
+        MPI_Abi_get_version.3 \
+        MPI_Abi_set_fortran_booleans.3 \
+        MPI_Abi_set_fortran_info.3 \
         MPI_Abort.3 \
         MPI_Accumulate.3 \
         MPI_Add_error_class.3 \
@@ -151,6 +157,7 @@ OMPI_MAN3 = \
         MPI_Comm_flush_buffer.3 \
         MPI_Comm_free.3 \
         MPI_Comm_free_keyval.3 \
+        MPI_Comm_fromint.3 \
         MPI_Comm_get_attr.3 \
         MPI_Comm_get_errhandler.3 \
         MPI_Comm_get_info.3 \
@@ -174,6 +181,7 @@ OMPI_MAN3 = \
         MPI_Comm_split.3 \
         MPI_Comm_split_type.3 \
         MPI_Comm_test_inter.3 \
+        MPI_Comm_toint.3 \
         MPI_Compare_and_swap.3 \
         MPI_Dims_create.3 \
         MPI_Dist_graph_create.3 \
@@ -182,8 +190,10 @@ OMPI_MAN3 = \
         MPI_Dist_graph_neighbors_count.3 \
         MPI_Errhandler_create.3 \
         MPI_Errhandler_free.3 \
+        MPI_Errhandler_fromint.3 \
         MPI_Errhandler_get.3 \
         MPI_Errhandler_set.3 \
+        MPI_Errhandler_toint.3 \
         MPI_Error_class.3 \
         MPI_Error_string.3 \
         MPI_Errors.3 \
@@ -196,6 +206,7 @@ OMPI_MAN3 = \
         MPI_File_create_errhandler.3 \
         MPI_File_delete.3 \
         MPI_File_f2c.3 \
+        MPI_File_fromint.3 \
         MPI_File_get_amode.3 \
         MPI_File_get_atomicity.3 \
         MPI_File_get_byte_offset.3 \
@@ -239,6 +250,7 @@ OMPI_MAN3 = \
         MPI_File_set_size.3 \
         MPI_File_set_view.3 \
         MPI_File_sync.3 \
+        MPI_File_toint.3 \
         MPI_File_write.3 \
         MPI_File_write_all.3 \
         MPI_File_write_all_begin.3 \
@@ -282,13 +294,15 @@ OMPI_MAN3 = \
         MPI_Group_excl.3 \
         MPI_Group_f2c.3 \
         MPI_Group_free.3 \
+        MPI_Group_fromint.3 \
         MPI_Group_from_session_pset.3 \
         MPI_Group_incl.3 \
         MPI_Group_intersection.3 \
         MPI_Group_range_excl.3 \
         MPI_Group_range_incl.3 \
         MPI_Group_rank.3 \
         MPI_Group_size.3 \
+        MPI_Group_toint.3 \
         MPI_Group_translate_ranks.3 \
         MPI_Group_union.3 \
         MPI_Iallgather.3 \
@@ -317,12 +331,14 @@ OMPI_MAN3 = \
         MPI_Info_env.3 \
         MPI_Info_f2c.3 \
         MPI_Info_free.3 \
+        MPI_Info_fromint.3 \
         MPI_Info_get.3 \
         MPI_Info_get_nkeys.3 \
         MPI_Info_get_nthkey.3 \
         MPI_Info_get_string.3 \
         MPI_Info_get_valuelen.3 \
         MPI_Info_set.3 \
+        MPI_Info_toint.3 \
         MPI_Init.3 \
         MPI_Initialized.3 \
         MPI_Init_thread.3 \
@@ -348,6 +364,8 @@ OMPI_MAN3 = \
         MPI_Lookup_name.3 \
         MPI_Message_c2f.3 \
         MPI_Message_f2c.3 \
+        MPI_Message_fromint.3 \
+        MPI_Message_toint.3 \
         MPI_Mprobe.3 \
         MPI_Mrecv.3 \
         MPI_Neighbor_allgather.3 \
@@ -366,6 +384,8 @@ OMPI_MAN3 = \
         MPI_Open_port.3 \
         MPI_Op_f2c.3 \
         MPI_Op_free.3 \
+        MPI_Op_fromint.3 \
+        MPI_Op_toint.3 \
         MPI_Pack.3 \
         MPI_Pack_external.3 \
         MPI_Pack_external_size.3 \
@@ -398,10 +418,12 @@ OMPI_MAN3 = \
         MPI_Request_c2f.3 \
         MPI_Request_f2c.3 \
         MPI_Request_free.3 \
+        MPI_Request_fromint.3 \
         MPI_Request_get_status.3 \
         MPI_Request_get_status_all.3 \
         MPI_Request_get_status_any.3 \
         MPI_Request_get_status_some.3 \
+        MPI_Request_toint.3 \
         MPI_Rget.3 \
         MPI_Rget_accumulate.3 \
         MPI_Rput.3 \
@@ -423,12 +445,14 @@ OMPI_MAN3 = \
         MPI_Session_f2c.3 \
         MPI_Session_finalize.3 \
         MPI_Session_flush_buffer.3 \
+        MPI_Session_fromint.3 \
         MPI_Session_get_info.3 \
         MPI_Session_get_nth_pset.3 \
         MPI_Session_get_num_psets.3 \
         MPI_Session_get_pset_info.3 \
         MPI_Session_iflush_buffer.3 \
         MPI_Session_init.3 \
+        MPI_Session_toint.3 \
         MPI_Sizeof.3 \
         MPI_Ssend.3 \
         MPI_Ssend_init.3 \
@@ -440,6 +464,7 @@ OMPI_MAN3 = \
         MPI_Status_f082f.3 \
         MPI_Status_f2c.3 \
         MPI_Status_f2f08.3 \
+        MPI_Status_fromint.3 \
         MPI_Status_get_error.3 \
         MPI_Status_get_source.3 \
         MPI_Status_get_tag.3 \
@@ -449,6 +474,7 @@ OMPI_MAN3 = \
         MPI_Status_set_error.3 \
         MPI_Status_set_source.3 \
         MPI_Status_set_tag.3 \
+        MPI_Status_toint.3 \
         MPI_T.3 \
         MPI_T_category_changed.3 \
         MPI_T_category_get_categories.3 \
@@ -525,6 +551,7 @@ OMPI_MAN3 = \
         MPI_Type_f2c.3 \
         MPI_Type_free.3 \
         MPI_Type_free_keyval.3 \
+        MPI_Type_fromint.3 \
         MPI_Type_get_attr.3 \
         MPI_Type_get_contents.3 \
         MPI_Type_get_envelope.3 \
@@ -544,6 +571,7 @@ OMPI_MAN3 = \
         MPI_Type_size.3 \
         MPI_Type_size_x.3 \
         MPI_Type_struct.3 \
+        MPI_Type_toint.3 \
         MPI_Type_ub.3 \
         MPI_Type_vector.3 \
         MPI_Unpack.3 \
@@ -573,6 +601,7 @@ OMPI_MAN3 = \
         MPI_Win_flush_local_all.3 \
         MPI_Win_free.3 \
         MPI_Win_free_keyval.3 \
+        MPI_Win_fromint.3 \
         MPI_Win_get_attr.3 \
         MPI_Win_get_errhandler.3 \
         MPI_Win_get_group.3 \
@@ -589,6 +618,7 @@ OMPI_MAN3 = \
         MPI_Win_start.3 \
         MPI_Win_sync.3 \
         MPI_Win_test.3 \
+        MPI_Win_toint.3 \
         MPI_Win_unlock.3 \
         MPI_Win_unlock_all.3 \
         MPI_Win_wait.3 \

docs/building-apps/index.rst

@@ -14,6 +14,7 @@ Open MPI "wrapper" compilers.
    removed-mpi-constructs
    deprecation-warnings
    building-static-apps
+   mpi-abi
 
 .. warning:: Open MPI does not attempt to interoperate with other MPI
              implementations, nor executables that were compiled for

docs/building-apps/mpi-abi.rst

@@ -0,0 +1,33 @@
+.. _label-building-with-mpi-abi:
+
+Building MPI applications using the MPI ABI
+===========================================
+
+What is the MPI ABI
+-------------------
+
+Starting with MPI 5.0, the MPI standard specifies an ABI for the c and
+Fortran MPI interfaces.  In this release, Open MPI supports the c
+part of the MPI ABI.
+
+By using the MPI ABI, an MPI application can be built against one 
+implementation of MPI that supports the MPI ABI, and later run using
+the MPI ABI compliant MPI library generated using a different MPI
+implementation.  This assumes that the application is dynamically linked.
+
+The MPI 5.0 standard specifies the file name of the MPI ABI compliant
+library - libmpi_abi.  The major version of the library is 1 and minor
+version is 0.
+
+How to build an application using the MPI ABI
+---------------------------------------------
+
+To build an application against the MPI ABI compliant Open MPI library,
+the ``mpicc_abi`` compiler wrapper must be used for compiling and 
+linking the application or shared library.
+
+This release does not support the Fortran ABI so there is no ``mpifort_abi``
+compiler wrapper.  This mixed c/Fortran MPI apps cannot make use of the
+MPI ABI library with this release.
+
+

docs/man-openmpi/man3/MPI_Abi_get_fortran_booleans.3.rst

@@ -0,0 +1,40 @@
+.. _mpi_abi_get_fortran_booleans:
+
+
+MPI_Abi_get_fortran_booleans
+============================
+
+.. include_body
+
+:ref:`MPI_Abi_get_fortran_booleans` |mdash| Retrieves Fortran ABI details for the provided Fortran logical of size *logical_size*.
+
+.. The following file was automatically generated
+.. include:: ./bindings/mpi_abi_get_fortran_booleans.rst
+
+INPUT PARAMETERS
+----------------
+* ``logical_size``: the size of Fortran logical in bytes
+
+OUTPUT PARAMETERS
+-----------------
+* ``logical_true``: the Fortran literal value TRUE
+* ``logical_false``: the Fortran literal value FALSE
+* ``is_set``: flag to indicate whether the logical boolean values were set previously (logical)
+* ``ierror``: Fortran only: Error status (integer).
+
+DESCRIPTION
+-----------
+
+:ref:`MPI_Abi_get_fortran_booleans` returns a values of TRUE and FALSE for a given Fortran
+logical size.  *is_set* is set to true if the these values have been previously set either
+by a call to :ref:`MPI_Abi_set_fortran_booleans` or internally by MPI.
+
+ERRORS
+------
+
+.. include:: ./ERRORS.rst
+
+.. seealso::
+   * :ref:`MPI_Abi_set_fortran_info`
+   * :ref:`MPI_Abi_get_fortran_info`
+   * :ref:`MPI_Abi_set_fortran_booleans`

docs/man-openmpi/man3/MPI_Abi_get_fortran_info.3.rst

@@ -0,0 +1,37 @@
+.. _mpi_abi_get_fortran_info:
+
+
+MPI_Abi_get_fortran_info
+========================
+
+.. include_body
+
+:ref:`MPI_Abi_get_fortran_info` |mdash| Retrieves Fortran ABI details info object
+
+.. The following file was automatically generated
+.. include:: ./bindings/mpi_abi_get_fortran_info.rst
+
+OUTPUT PARAMETERS
+-----------------
+* ``info``: New info object returned with Fortran ABI details.
+* ``ierror``: Fortran only: Error status (integer).
+
+DESCRIPTION
+-----------
+
+:ref:`MPI_Abi_get_fortran_info` returns a new info object providing
+additional information related to the Fortran ABI.
+
+NOTES
+-----
+
+The user is responsible for freeing info_used via :ref:`MPI_Info_free`.
+
+ERRORS
+------
+
+.. include:: ./ERRORS.rst
+
+.. seealso::
+   * :ref:`MPI_Info_free`
+   * :ref:`MPI_Abi_set_fortran_info`

docs/man-openmpi/man3/MPI_Abi_get_info.3.rst

@@ -0,0 +1,36 @@
+.. _mpi_abi_get_info:
+
+
+MPI_Abi_get_info
+================
+
+.. include_body
+
+:ref:`MPI_Abi_get_info` |mdash| Retrieves info hints about the ABI implementation
+
+.. The following file was automatically generated
+.. include:: ./bindings/mpi_abi_get_info.rst
+
+OUTPUT PARAMETERS
+-----------------
+* ``info``: New info object returned with ABI details.
+* ``ierror``: Fortran only: Error status (integer).
+
+DESCRIPTION
+-----------
+
+:ref:`MPI_Abi_get_info` returns a new info object providing
+additional information related to the ABI.
+
+NOTES
+-----
+
+The user is responsible for freeing info_used via :ref:`MPI_Info_free`.
+
+ERRORS
+------
+
+.. include:: ./ERRORS.rst
+
+.. seealso::
+   * :ref:`MPI_Info_free`