mpi: add request_get_status_all/any/some

- add the man pages for the newly implemented MPI_Request_get_status_all/any/some functions.
- c-bindings: add support for const request args

Three new functions were added to the MPI API as part of the 4.1 standard.
These used an array of const MPI_Request s which the bindings code
didn't support.

This commit also fixes back the mpi.h prototypes to include the constants
and required changes to the new template files.

- request_get_status variants: add f08 interfaces

also switch MPI_Request_get_status to use new method for generating
f08 bindings.

- Update fortran bindings interfaces generation code.

- f90/f77 interfaces will be added as another commit.
- use-mpi-ignore: start using binding infrastructure
- request_get_status_mult: add f77 functions

Signed-off-by: Edgar Gabriel <edgar.gabriel@amd.com>
Signed-off-by: Howard Pritchard <howardp@lanl.gov>

Author: edgargabriel

.gitignore

@@ -539,3 +539,5 @@ ompi/mpi/c/*_generated*.c
 ompi/mpi/fortran/use-mpi-f08/*_generated.F90
 ompi/mpi/fortran/use-mpi-f08/base/*_generated.c
 ompi/mpi/fortran/use-mpi-f08/mod/mpi-f08-interfaces-generated.h
+ompi/mpi/fortran/use-mpi-ignore-tkr/mpi-ignore-tkr-interfaces-generated.h
+ompi/mpi/fortran/use-mpi-ignore-tkr/*_generated.F90

docs/Makefile.am

@@ -388,6 +388,9 @@ OMPI_MAN3 = \
         MPI_Request_f2c.3 \
         MPI_Request_free.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_Rget.3 \
         MPI_Rget_accumulate.3 \
         MPI_Rput.3 \

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

@@ -0,0 +1,49 @@
+.. _mpi_request_get_status_all:
+
+
+MPI_Request_get_status_all
+==========================
+
+.. include_body
+
+:ref:`MPI_Request_get_status_all` |mdash| Access information associated with an
+array of requests without freeing the requests.
+
+.. The following file was automatically generated
+.. include:: ./bindings/mpi_request_get_status_all.rst
+
+INPUT PARAMETERS
+----------------
+* ``count``: List length (non-negative integer)
+* ``array_of_requests``: Array of requests (array of handles).
+
+OUTPUT PARAMETERS
+-----------------
+* ``flag``: Boolean flag, same as from :ref:`MPI_Test` (logical).
+* ``array_of_statuses``: Array of ``MPI_Status`` objects if flag is true (array of status).
+* ``ierror``: Fortran only: Error status (integer).
+
+DESCRIPTION
+-----------
+
+:ref:`MPI_Request_get_status_all` sets ``flag = true`` if all
+operations associated with *active* handles in the array have completed.
+In this case, each status entry that corresponds to an active request
+is set to the status of the corresponding operation. It
+does not deallocate or deactivate the request; a subsequent call to
+any of the MPI test, wait, or free routines should be executed with each
+of those requests.
+
+Each status entry that corresponds to a null or inactive handle is set
+to empty.  Otherwise, ``flag = false`` is returned and the values of the
+status entries are undefined.
+
+If your application does not need to examine the *status* field, you can
+save resources by using the predefined constant ``MPI_STATUSES_IGNORE`` as a
+special value for the ``array_of_statuses`` argument.
+
+
+ERRORS
+------
+
+.. include:: ./ERRORS.rst

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

@@ -0,0 +1,53 @@
+.. _mpi_request_get_status_any:
+
+
+MPI_Request_get_status_any
+==========================
+
+.. include_body
+
+:ref:`MPI_Request_get_status_any` |mdash| Access information associated with an
+array of requests without freeing the requests.
+
+.. The following file was automatically generated
+.. include:: ./bindings/mpi_request_get_status_any.rst
+
+INPUT PARAMETERS
+----------------
+* ``count``: List length (non-negative integer)
+* ``array_of_requests``: Array of requests (array of handles).
+
+OUTPUT PARAMETERS
+-----------------
+* ``index``: Index of operation that completed (integer).
+* ``flag``: Boolean flag, same as from :ref:`MPI_Test` (logical).
+* ``status``: ``MPI_Status`` object if flag is true (status).
+* ``ierror``: Fortran only: Error status (integer).
+
+DESCRIPTION
+-----------
+
+:ref:`MPI_Request_get_status_any` sets ``flag = true`` if either one
+of the operations associated with active handles has completed. In
+this case it returns in ``index`` the index of this request in the
+array and the status of the operation in ``status``.  It does not
+deallocate or deactivate the request; a subsequent call to any of the MPI
+test, wait, or free routines should be executed with that request.
+
+If no operation completed, it returns ``flag = false`` and a value of
+``MPI_UNDEFINED`` in ``index``. ``status`` is undefined in this
+scenario.
+
+If ``array_of_requests`` contains no active handles then the call
+returns immediately with ``flag = true``, ``index = MPI_UNDEFINED``,
+and an empty status.
+
+If your application does not need to examine the *status* field, you can
+save resources by using the predefined constant ``MPI_STATUS_IGNORE`` as a
+special value for the ``status`` argument.
+
+
+ERRORS
+------
+
+.. include:: ./ERRORS.rst

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

@@ -0,0 +1,52 @@
+.. _mpi_request_get_status_some:
+
+
+MPI_Request_get_status_some
+===========================
+
+.. include_body
+
+:ref:`MPI_Request_get_status_some` |mdash| Access information associated with an
+array of requests without freeing the requests.
+
+.. The following file was automatically generated
+.. include:: ./bindings/mpi_request_get_status_some.rst
+
+INPUT PARAMETERS
+----------------
+* ``incount``: List length (non-negative integer).
+* ``array_of_requests``: Array of requests (array of handles).
+
+OUTPUT PARAMETERS
+-----------------
+* ``outcount``: Number of completed requests (integer).
+* ``array_of_indices``: Array of indices of operations that completed (array of integers).
+* ``array_of_statuses``: Array of ``MPI_Status`` objects for operations that completed (array of status).
+* ``ierror``: Fortran only: Error status (integer).
+
+DESCRIPTION
+-----------
+
+:ref:`MPI_Request_get_status_some` returns in outcount the number of
+requests from the list ``array_of_requests`` that have completed. The
+first ``outcount`` locations of the array ``array_of_indices`` and
+``array_of_statuses`` will contain the indices of the operations
+within the array ``array_of_requests`` and the status of these
+operations respectively. The array is indexed from zero in C and from
+one in Fortran. It does not deallocate or deactivate the request; a
+subsequent call to any of the MPI test, wait, or free routines should be
+executed with each completed request.
+
+If no operation in ``array_of_requests`` is complete, it returns
+``outcount = 0``. If all operations in ``array_of_requests`` are either
+``MPI_REQUEST_NULL`` or inactive, ``outcount`` will be set to ``MPI_UNDEFINED``.
+
+If your application does not need to examine the *status* field, you can
+save resources by using the predefined constant ``MPI_STATUSES_IGNORE`` as a
+special value for the ``array_of_statuses`` argument.
+
+
+ERRORS
+------
+
+.. include:: ./ERRORS.rst

docs/man-openmpi/man3/index.rst

@@ -309,6 +309,9 @@ MPI API manual pages (section 3)
    MPI_Request_f2c.3.rst
    MPI_Request_free.3.rst
    MPI_Request_get_status.3.rst
+   MPI_Request_get_status_all.3.rst
+   MPI_Request_get_status_any.3.rst
+   MPI_Request_get_status_some.3.rst
    MPI_Rget.3.rst
    MPI_Rget_accumulate.3.rst
    MPI_Rput.3.rst

ompi/include/mpi.h.in

@@ -2232,6 +2232,12 @@ OMPI_DECLSPEC  MPI_Request MPI_Request_f2c(MPI_Fint request);
 OMPI_DECLSPEC  int MPI_Request_free(MPI_Request *request);
 OMPI_DECLSPEC  int MPI_Request_get_status(MPI_Request request, int *flag,
                                           MPI_Status *status);
+OMPI_DECLSPEC int MPI_Request_get_status_all(int count, const MPI_Request array_of_requests[], int *flag,
+                                             MPI_Status array_of_statuses[]);
+OMPI_DECLSPEC int MPI_Request_get_status_any(int count, const MPI_Request array_of_requests[], int *index,
+                                             int *flag, MPI_Status *status);
+OMPI_DECLSPEC int MPI_Request_get_status_some(int incount, const MPI_Request array_of_requests[], int *outcount,
+                                              int array_of_indices[], MPI_Status array_of_statuses[]);
 OMPI_DECLSPEC  int MPI_Rget(void *origin_addr, int origin_count, MPI_Datatype origin_datatype,
                             int target_rank, MPI_Aint target_disp, int target_count, MPI_Datatype target_datatype,
                             MPI_Win win, MPI_Request *request);
@@ -3383,6 +3389,12 @@ OMPI_DECLSPEC  MPI_Request PMPI_Request_f2c(MPI_Fint request);
 OMPI_DECLSPEC  int PMPI_Request_free(MPI_Request *request);
 OMPI_DECLSPEC  int PMPI_Request_get_status(MPI_Request request, int *flag,
                                            MPI_Status *status);
+OMPI_DECLSPEC int PMPI_Request_get_status_all(int count, const MPI_Request array_of_requests[], int *flag,
+                                              MPI_Status array_of_statuses[]);
+OMPI_DECLSPEC int PMPI_Request_get_status_any(int count, const MPI_Request array_of_requests[], int *index,
+                                              int *flag, MPI_Status *status);
+OMPI_DECLSPEC int PMPI_Request_get_status_some(int incount, const MPI_Request array_of_requests[], int *outcount,
+                                               int array_of_indices[], MPI_Status array_of_statuses[]);
 OMPI_DECLSPEC  int PMPI_Rget(void *origin_addr, int origin_count, MPI_Datatype origin_datatype,
                              int target_rank, MPI_Aint target_disp, int target_count, MPI_Datatype target_datatype,
                              MPI_Win win, MPI_Request *request);

ompi/mpi/bindings/bindings.py

@@ -33,6 +33,8 @@ def main():
     parser_fortran = subparsers.add_parser('fortran', help='subcommand for generating Fortran code')
     parser_fortran.add_argument('--generate-ts-suffix', action="store_true",
                                 help='generate ts suffixes for appropriate routines')
+    parser_fortran.add_argument('--fort-std', choices=('f90', 'f08'),
+                             help='fortran standard to use for fortran module and code generation')
     # Handler for generating actual code
     subparsers_fortran = parser_fortran.add_subparsers()
     parser_code = subparsers_fortran.add_parser('code', help='generate binding code')

ompi/mpi/bindings/ompi_bindings/c_type.py

@@ -556,14 +556,38 @@ def type_text(self, enable_count=False):
     def argument(self):
         return f'(MPI_Request) {self.name}'
 
+@Type.add_type('REQUEST_CONST', abi_type=['ompi'])
+class TypeConstRequest(TypeRequest):
+
+    def type_text(self, enable_count=False):
+        return f'const MPI_Request *'
+
+    def parameter(self, enable_count=False, **kwargs):
+        if self.count_param is None:
+            return f'const MPI_Request {self.name}'
+        else:
+            return f'const MPI_Request {self.name}[]'
+
+#
+# TODO ABI NEEDS WORK
+#
+@Type.add_type('REQUEST_CONST', abi_type=['standard'])
+class TypeConstRequestStandard(TypeRequestStandard):
+
+    def type_text(self, enable_count=False):
+        name = self.mangle_name('MPI_Request')
+        return f'const {name}'
+
+    @property
+    def argument(self):
+        return f'(MPI_Request) {self.name}'
 
 @Type.add_type('REQUEST_INOUT', abi_type=['ompi'])
 class TypeRequestInOut(Type):
 
     def type_text(self, enable_count=False):
         return 'MPI_Request *'
 
-
 @Type.add_type('REQUEST_INOUT', abi_type=['standard'])
 class TypeRequestInOutStandard(Type):
 
@@ -593,7 +617,6 @@ def parameter(self, enable_count=False, **kwargs):
         else:
             return f'{type_name} {self.name}[]'
 
-
 @Type.add_type('STATUS', abi_type=['ompi'])
 class TypeStatus(Type):