Merge pull request open-mpi#12020 from awlauria/news

awlauria · web-flow · commit dd93cdb92a21 · 2023-10-25T15:46:20.000-04:00
news updates for v5.0.0 release
diff --git a/docs/news/news-v5.0.x.rst b/docs/news/news-v5.0.x.rst
@@ -4,9 +4,9 @@ Open MPI v5.0.x series
 This file contains all the NEWS updates for the Open MPI v5.0.x
 series, in reverse chronological order.
 
-Open MPI version 5.0.0rc13
+Open MPI version 5.0.0
 --------------------------
-:Date: 29 September 2023
+:Date: 25 October 2023
 
 .. admonition:: The MPIR API has been removed
    :class: warning
@@ -66,32 +66,42 @@ Open MPI version 5.0.0rc13
                 Libevent symbols and then statically pulled the
                 library into ``libmpi.so``.
 
-- Changes since rc12:
-
-  - Update PMIx to the ``v4.2.6`` release tag. Hash: ``f20e0d5``.
-  - Update PRRTE to the ``v3.0.1`` release tag. Hash: ``63370ca``.
-  - Lots of documentation updates.
-  - Fixed parameter name in ``MPI_Intercomm_merge``. Thanks to Yan Wu for the report.
-  - ``OFI``: Update NIC selection to determine optimal interfaces from the current process.
-  - Fix reordering of received data in ``MPI_Gather``.
-  - Disable builds with ``HWLOC`` versions >= 3.0.0. This is currently not supported.
-  - Fix re-ordering of ranks in ``MPI_Dist_graph_create``.
-  - ``coll/HAN``: Fix bug when using ``MPI_IN_PLACE`` with ``MPI_Reduce``.
-  - Fix ``MPI_Type_Dup`` to propagate errors from inner calls.
-  - Fix the compilation of the monitoring infrastructure.
-  - Various other bug fixes.
+- Internal PMIx and PRRTe versions:
+
+  - PMIx release tag v4.2.7. Commit hash: ``57c405c52ad76bab0be9f95e29a6df660673081e``.
+  - PRRTE release tag v3.0.2. Commit hash: ``1552e36f0852bbc6d901ec95983369f0a3c283f6``.
 
 - All other notable updates for v5.0.0:
 
+  - MPI-4.0 updates and additions:
+
+    - Support for MPI Sessions has been added.
+    - Added partitioned communication using persistent sends
+      and persistent receives.
+    - Added persistent collectives to the ``MPI_`` namespace
+      (they were previously available via the ``MPIX_`` prefix).
+    - Added ``MPI_Isendrecv()`` and its variants.
+    - Added support for ``MPI_Comm_idup_with_info()``.
+    - Added support for ``MPI_Info_get_string()``.
+    - Added support for ``initial_error_handler`` and the
+      ``ERRORS_ABORT`` infrastructure.
+    - Added error handling for unbound errors to ``MPI_COMM_SELF``.
+    - Made ``MPI_Comm_get_info()``, ``MPI_File_get_info()``, and
+      ``MPI_Win_get_info()`` compliant to the standard.
+    - Droped unknown/ignored info keys on communicators, files,
+      and windows.
+    - Initial implementations of ``MPI_COMM_TYPE_HW_GUIDED`` and
+      ``MPI_COMM_TYPE_HW_GUIDED`` added.
+    - ``MPI_Info_get()`` and ``MPI_Info_get_valuelen()`` are now
+      deprecated.
+    - Issue a deprecation warning when ``MPI_Cancel()`` is called for
+      a non-blocking send request.
+
   - New Features:
 
     - ULFM Fault Tolerance support has been added. See :ref:`the ULFM
       section <ulfm-label>`.
     - CUDA is now supported in the ``ofi`` MTL.
-    - New MCA parameter ``ompi_display_comm``, enabling a
-      communication report.  When set to ``mpi_init``, display the
-      report when ``MPI_Init()`` is invoked.  When set to
-      ``mpi_finalize``, display the report during ``MPI_Finalize()``.
     - A threading framework has been added to allow building Open MPI
       with different threading libraries. It currently supports
       `Argobots <https://www.argobots.org/>`_, `Qthreads
@@ -116,30 +126,14 @@ Open MPI version 5.0.0rc13
       ``memory_patcher``. Thanks to Rich Welch for the contribution.
     - ``coll/ucc``: Added support for the ``MPI_Scatter()`` and
       ``MPI_Iscatter()`` collectives.
-
-  - MPI-4.0 updates and additions:
-
-    - Support for MPI Sessions has been added.
-    - Added partitioned communication using persistent sends
-      and persistent receives.
-    - Added persistent collectives to the ``MPI_`` namespace
-      (they were previously available via the ``MPIX_`` prefix).
-    - Added ``MPI_Isendrecv()`` and its variants.
-    - Added support for ``MPI_Comm_idup_with_info()``.
-    - Added support for ``MPI_Info_get_string()``.
-    - Added support for ``initial_error_handler`` and the
-      ``ERRORS_ABORT`` infrastructure.
-    - Added error handling for unbound errors to ``MPI_COMM_SELF``.
-    - Made ``MPI_Comm_get_info()``, ``MPI_File_get_info()``, and
-      ``MPI_Win_get_info()`` compliant to the standard.
-    - Droped unknown/ignored info keys on communicators, files,
-      and windows.
-    - Initial implementations of ``MPI_COMM_TYPE_HW_GUIDED`` and
-      ``MPI_COMM_TYPE_HW_GUIDED`` added.
-    - ``MPI_Info_get()`` and ``MPI_Info_get_valuelen()`` are now
-      deprecated.
-    - Issue a deprecation warning when ``MPI_Cancel()`` is called for
-      a non-blocking send request.
+    - New algorithm for Allgather and Allgatherv has been added, based
+      on the paper *"Sparbit: a new logarithmic-cost and data
+      locality-aware MPI Allgather algorithm"*. Default algorithm
+      selection rules are unchanged; to use these algorithms add:
+      ``--mca coll_tuned_allgather_algorithm sparbit`` and/or ``--mca
+      coll_tuned_allgatherv_algorithm sparbit`` to your ``mpirun``
+      command.  Thanks to Wilton Jaciel Loch and Guilherme Koslovski
+      for their contribution.
 
   - Transport updates and improvements
 
@@ -173,10 +167,6 @@ Open MPI version 5.0.0rc13
 
     - Shared Memory:
 
-      - The legacy ``sm`` (shared memory) BTL has been removed.  The
-        next-generation shared memory BTL ``vader`` replaces it, and
-        has been renamed to be ``sm`` (``vader`` will still work as an
-        alias).
       - Update the new ``sm`` BTL to not use Linux Cross Memory Attach
         (CMA) in user namespaces.
       - Fixed a crash when using the new ``sm`` BTL when compiled with
@@ -187,6 +177,10 @@ Open MPI version 5.0.0rc13
 
   - Deprecations and removals:
 
+    - The legacy ``sm`` (shared memory) BTL has been removed.  The
+      next-generation shared memory BTL ``vader`` replaces it, and
+      has been renamed to be ``sm`` (``vader`` will still work as an
+      alias).
     - ORTE, the underlying Open MPI launcher has been removed, and
       replaced with the `PMIx Reference RunTime Environment
       <https://github.com/openpmix/prrte>`_ (``PRTE``).
@@ -214,18 +208,29 @@ Open MPI version 5.0.0rc13
       environment is no longer supported.  32 bit support is still
       available in the v4.x series.
 
-  - Hardware Locality updates:
+  - Other updates and bug fixes:
 
-    - Open MPI now requires Hardware Locality v1.11.0 or later.
-    - The internally-bundled Hardware Locality shipped with Open MPI
-      has been updated to v2.7.1.
-    - Open MPI builds Hardware Locality with ``--enable-plugins`` when
-      appropriate.
+    - Updated Open MPI to use ``ROMIO`` v3.4.1.
+    - Add missing ``MPI_Status`` conversion subroutines:
+      ``MPI_Status_c2f08()``, ``MPI_Status_f082c()``,
+      ``MPI_Status_f082f()``, ``MPI_Status_f2f08()`` and the
+      ``PMPI_*`` related subroutines.
+    - MPI module: added the ``mpi_f08`` ``TYPE(MPI_*)`` types for
+      Fortran.  Thanks to George Katevenis for the report and their
+      contribution to the patch.
+    - The default atomics have been changed to be GCC, with C11 as a
+      fallback. C11 atomics incurs sequential memory ordering, which
+      in most cases is not desired.
+    - Various datatype bugfixes and performance improvements.
+    - Various pack/unpack bugfixes and performance improvements.
+    - Various OSHMEM bugfixes and performance improvements.
+    - Thanks to Jeff Hammond, Pak Lui, Felix Uhl, Naribayashi Akira, 
+      Julien Emmanuel, and Yaz Saito for their invaluable contributions.
 
   - Documentation updates and improvements:
 
     - Open MPI has consolidated and converted all of its documentation
-      to use `ReStructured Text
+      to use `ReStructured Text.
       <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_
       and `Sphinx <https://www.sphinx-doc.org/>`_.
 
@@ -262,93 +267,3 @@ Open MPI version 5.0.0rc13
       - Yixin Zhang
       - William Zhang
 
-  - Build updates and fixes:
-
-    - Various changes and cleanup to fix, and better support the
-      static building of Open MPI.
-    - Change the default component build behavior to prefer building
-      components as part of the core Open MPI library instead of
-      individual DSOs.  Currently, this means the Open SHMEM layer
-      will only build if the UCX library is found.
-    - ``autogen.pl`` now supports a ``-j`` option to run
-      multi-threaded.  Users can also use the environment variable
-      ``AUTOMAKE_JOBS``.
-    - Updated ``autogen.pl`` to support macOS Big Sur. Thanks to
-      @fxcoudert for reporting the issue.
-    - Fixed bug where ``autogen.pl`` would not ignore all excluded
-      components when using the ``--exclude`` option.
-    - Fixed a bug the ``-r`` option of ``buildrpm.sh`` which would
-      result in an rpm build failure. Thanks to John K. McIver III for
-      reporting and fixing.
-    - Removed the ``C++`` compiler requirement to build Open MPI.
-    - Updates to improve the handling of the compiler version string
-      in the build system.  This fixes a compiler error with clang and
-      armclang.
-    - Added OpenPMIx binaries to the build, including ``pmix_info``.
-      Thanks to Mamzi Bayatpour for their contribution to this effort.
-    - Open MPI now links to Libevent using ``-levent_core``
-      and ``-levent_pthread`` instead of ``-levent``.
-    - Added support for setting the wrapper C compiler.  This adds a
-      new option: ``--with-wrapper-cc=NAME`` to the ``configure`` command.
-    - Fixed compilation errors when running on IME file systems due to
-      a missing header inclusion. Thanks to Sylvain Didelot for
-      finding and fixing this issue.
-    - Add support for GNU Autoconf v2.7.x.
-
-  - Other updates and bug fixes:
-
-    - Updated Open MPI to use ``ROMIO`` v3.4.1.
-    - ``common/ompio``: implement pipelined read and write operation.
-      This new new code path shows significant performance
-      improvements for reading/writing device buffers compared to the
-      previous implementation, and reduces the memory footprint of
-      Open MPI IO ("OMPIO") by allocating smaller temporary buffers.
-    - Fixed Fortran-8-byte-INTEGER vs. C-4-byte-int issue in the
-      ``mpi_f08`` MPI Fortran bindings module. Thanks to @ahaichen for
-      reporting the bug.
-    - Add missing ``MPI_Status`` conversion subroutines:
-      ``MPI_Status_c2f08()``, ``MPI_Status_f082c()``,
-      ``MPI_Status_f082f()``, ``MPI_Status_f2f08()`` and the
-      ``PMPI_*`` related subroutines.
-    - Fixed Fortran keyword issue when compiling ``oshmem_info``.
-      Thanks to Pak Lui for finding and fixing the bug.
-    - Added check for Fortran ``ISO_FORTRAN_ENV:REAL16``. Thanks to
-      Jeff Hammond for reporting this issue.
-    - Fixed Fortran preprocessor issue with ``CPPFLAGS``.
-      Thanks to Jeff Hammond for reporting this issue.
-    - MPI module: added the ``mpi_f08`` ``TYPE(MPI_*)`` types for
-      Fortran.  Thanks to George Katevenis for the report and their
-      contribution to the patch.
-    - Fixed a typo in an error string when showing the stack
-      frame. Thanks to Naribayashi Akira for finding and fixing the
-      bug.
-    - Fixed output error strings and some comments in the Open MPI
-      code base.  Thanks to Julien Emmanuel for tirelessly finding and
-      fixing these issues.
-    - The ``uct`` BTL transport now supports ``UCX`` v1.9 and higher.
-      There is no longer a maximum supported version.
-    - Updated the UCT BTL defaults to allow NVIDIA/Mellanox HCAs
-      (``mlx4_0``, and ``mlx5_0``) for compatibility with the
-      one-sided ``rdma`` component.
-    - Fixed a crash during CUDA initialization.
-      Thanks to Yaz Saito for finding and fixing the bug.
-    - Singleton ``MPI_Comm_spawn()`` support has been fixed.
-    - PowerPC atomics: Force usage of ppc assembly by default.
-    - The default atomics have been changed to be GCC, with C11 as a
-      fallback. C11 atomics incurs sequential memory ordering, which
-      in most cases is not desired.
-    - Various datatype bugfixes and performance improvements.
-    - Various pack/unpack bugfixes and performance improvements.
-    - Various OSHMEM bugfixes and performance improvements.
-    - New algorithm for Allgather and Allgatherv has been added, based
-      on the paper *"Sparbit: a new logarithmic-cost and data
-      locality-aware MPI Allgather algorithm"*. Default algorithm
-      selection rules are unchanged; to use these algorithms add:
-      ``--mca coll_tuned_allgather_algorithm sparbit`` and/or ``--mca
-      coll_tuned_allgatherv_algorithm sparbit`` to your ``mpirun``
-      command.  Thanks to Wilton Jaciel Loch and Guilherme Koslovski
-      for their contribution.
-    - Updated the usage of ``.gitmodules`` to use relative paths from
-      absolute paths. This allows the submodule cloning to use the
-      same protocol as Open MPI cloning. Thanks to Felix Uhl for the
-      contribution.
