prte: code changes done by UofL capstone students and more

Add configure CLI option to allow optionally prefixing PRTE binary and
library filenames.

prted: support --with-prte-binary-prefix

Add the prefix to the prted binary name that was passed in via
--with-prte-binary-prefix.

Add prefixing capability to prrte library and binaries

Updated Makefile.am files to include @PRTE_BINARY_PREFIX@ in library and
binary names where appropriate.
Verified successful build and functionality of prefixed binaries
This commit ensures compatiblity with prefixed binary naming while
maintaining the integrity of the build system and runtime.

Added and finalized ompi- prefix updates for PRRTE manpages.

Added ompi- prefix for all instances of prte commands within both the man/man1 and man/man5 directories, and also renamed necessary files to accommodate changes.

Updated and corrected ompi- prefix for prrte manpages

Finalized changes to prrte manpages with -ompi prefix

Changed configuration.rst file to fix warning that is being treated as an error

Also fixed docs/Makefile.am for appropriate file renames

Turned main function in prte.c into library function provided in libprrte.so

manual addition of much of the content of UofL work in

uofl-capstone-open-mpi#6

avoid defining PRTE_BINARY_PREFIX twice

makefile fixes for prrte binary prefixing

There were changes to PRRTE after UofL merged

uofl-capstone-open-mpi#9

into their fork of prrte.  These changes get it working again.

modify some makefiles that UofL somehow missed

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

Author: jsquyres

.gitignore

@@ -166,6 +166,11 @@ src/tools/pcc/pcc
 src/tools/pcc/pcc-wrapper-data.txt
 src/tools/pterm/pterm
 src/tools/pterm/prte-term
+src/tools/prun/ompi-prun
+src/tools/prte_info/ompi-prte_info
+src/tools/prted/ompi-prted
+src/tools/prte/ompi-prte
+src/tools/pterm/ompi-pterm
 
 src/util/hostfile/hostfile_lex.c
 src/util/keyval/keyval_lex.c

config/prte_configure_options.m4

@@ -21,6 +21,7 @@ dnl Copyright (c) 2016-2020 Intel, Inc.  All rights reserved.
 dnl Copyright (c) 2021-2025 Nanook Consulting  All rights reserved.
 dnl Copyright (c) 2022      Amazon.com, Inc. or its affiliates.
 dnl                         All Rights reserved.
+dnl Copyright (c) 2024      Jeffrey M. Squyres.  All rights reserved.
 dnl $COPYRIGHT$
 dnl
 dnl Additional copyrights may follow
@@ -420,6 +421,27 @@ else
 fi
 AC_DEFINE_UNQUOTED([PRTE_TESTBUILD_LAUNCHERS], [$prte_testbuild_launchers],
                    [Enable testbuild PLM launchers (default: disabled)])
+
+# Optionally add a prefix to all the PRTE executable and library names
+AC_MSG_CHECKING([if want custom PRTE binary prefix])
+AC_ARG_WITH([prte-binary-prefix],
+    [AS_HELP_STRING([--with-prte-binary-prefix=STRING],
+                    ["Optionally add a prefix to all PRTE binary names (executables and libraries) names"])])
+# Set default prefix to "ompi-"
+AS_IF([test -z "$with_prte_binary_prefix"],
+      [with_prte_binary_prefix=ompi-])
+
+AS_IF([test "$with_prte_binary_prefix" = "no" || \
+           test "$with_prte_binary_prefix" = "yes" || \
+           test "$with_prte_binary_prefix" = ""],
+      [PRTE_BINARY_PREFIX=],
+      [PRTE_BINARY_PREFIX=$with_prte_binary_prefix])
+
+AC_MSG_RESULT([$PRTE_BINARY_PREFIX])
+AC_SUBST(PRTE_BINARY_PREFIX)
+AC_DEFINE_UNQUOTED([PRTE_BINARY_PREFIX], ["$PRTE_BINARY_PREFIX"],
+                   [The prefix to use with PRTE binaries and libraries])
+
 PRTE_SUMMARY_ADD([Miscellaneous], [Testbuild launchers], [], [$prte_testbuild_launchers_msg])
 
 ])dnl

contrib/libadd_mca_comp_update.py

@@ -8,7 +8,7 @@
 
 import glob, os, re, shutil
 
-projects= { 'prte' : ["$(top_builddir)/src/libprrte.la"],
+projects= { 'prte' : ["$(top_builddir)/src/lib@PRTE_BINARY_PREFIX@prrte.la"],
           }
 
 no_anchor_file = []

docs/Makefile.am

@@ -63,15 +63,15 @@ EXTRA_DIST = \
 # explicitly listed.
 
 PRTE_MAN1 = \
-        prte.1 \
-        prte_info.1 \
-        prted.1 \
-        prterun.1 \
-        prun.1 \
-        pterm.1
+        ompi-prte.1 \
+        ompi-prte_info.1 \
+        ompi-prted.1 \
+        ompi-prterun.1 \
+        ompi-prun.1 \
+        ompi-pterm.1
 
 PRTE_MAN5 = \
-        prte.5
+        ompi-prte.5
 
 MAN_OUTDIR = $(OUTDIR)/man
 

docs/configuration.rst

@@ -6,7 +6,7 @@ as a Distributed Virtual Machine (DVM) in two ways. First, the
 ``prte`` command can be executed at a shell prompt. This will discover
 the available resources (either from hostfile or as allocated by a
 resource manager) and start a PRRTE shepherd daemon (:ref:`prted(1)
-<man1-prted>`) on each of the indicated nodes.
+<man1-ompi-prted>`) on each of the indicated nodes.
 
 The other method, however, is to bootstrap the DVM at time of cluster
 startup. Bootstrapping PRRTE allows the DVM to serve as the system-level

docs/man/man1/index.rst

@@ -4,9 +4,9 @@ Commands (section 1)
 .. toctree::
    :maxdepth: 1
 
-   prte.1.rst
-   prte_info.1.rst
-   prted.1.rst
-   prterun.1.rst
-   prun.1.rst
-   pterm.1.rst
+   ompi-prte.1.rst
+   ompi-prte_info.1.rst
+   ompi-prted.1.rst
+   ompi-prterun.1.rst
+   ompi-prun.1.rst
+   ompi-pterm.1.rst

docs/man/man1/prte.1.rst renamed to docs/man/man1/ompi-prte.1.rst

@@ -1,29 +1,29 @@
-.. _man1-prte:
+.. _man1-ompi-prte:
 
-prte
-====
+ompi-prte
+=========
 
-prte |mdash| instantiate an instance of PRRTE DVM
+ompi-prte |mdash| instantiate an instance of PRRTE DVM
 
 SYNOPSIS
 --------
 
 .. code:: sh
 
-   shell$ prte ...options...
+   shell$ ompi-prte ...options...
 
 DESCRIPTION
 -----------
 
-``prte`` instantiates an instance of the PMIx Reference Run Time
+``ompi-prte`` instantiates an instance of the PMIx Reference Run Time
 Environment (PRRTE) distributed virtual machine (DVM).
 
 Extensive help documentation for this command is provided through
-``prte --help [topic]``.
+``ompi-prte --help [topic]``.
 
 At least for now, that content is not available in man page form.
 Pull requests to add all the content (via repeatable infrastructure)
 would be greatly appreciated.
 
 .. seealso::
-   :ref:`prterun(1) <man1-prterun>`
+   :ref:`ompi-prterun(1) <man1-ompi-prterun>`

docs/man/man1/prte_info.1.rst renamed to docs/man/man1/ompi-prte_info.1.rst

@@ -1,29 +1,29 @@
-.. _man1-prte_info:
+.. _man1-ompi-prte_info:
 
-prte_info
-=========
+ompi-prte_info
+==============
 
-prte_info |mdash| Provide detailed information on your PRRTE installation
+ompi-prte_info |mdash| Provide detailed information on your PRRTE installation
 
 SYNOPSIS
 --------
 
 .. code:: sh
 
-   prte_info ...options...
+   ompi-prte_info ...options...
 
 DESCRIPTION
 -----------
 
-``prte_info`` provide detailed information on your PMIx Reference Run
+``ompi-prte_info`` provide detailed information on your PMIx Reference Run
 Time (PRRTE) installation.
 
 Extensive help documentation for this command is provided through
-``prte_info --help [topic]``.
+``ompi-prte_info --help [topic]``.
 
 At least for now, that content is not available in man page form.
 Pull requests to add all the content (via repeatable infrastructure)
 would be greatly appreciated.
 
 .. seealso::
-   :ref:`prte(1) <man1-prte>`
+   :ref:`ompi-prte(1) <man1-ompi-prte>`

docs/man/man1/prted.1.rst renamed to docs/man/man1/ompi-prted.1.rst

@@ -1,29 +1,29 @@
-.. _man1-prted:
+.. _man1-ompi-prted:
 
-prted
-=====
+ompi-prted
+==========
 
-prted |mdash| helper daemon for PRRTE
+ompi-prted |mdash| helper daemon for PRRTE
 
 SYNOPSIS
 --------
 
 .. code:: sh
 
-   shell$ prted ...options...
+   shell$ ompi-prted ...options...
 
 DESCRIPTION
 -----------
 
-``prted`` is the back end helper daemon for PMIx Reference Runtime
+``ompi-prted`` is the back end helper daemon for PMIx Reference Runtime
 Environment (PRRTE).
 
 Extensive help documentation for this command is provided through
-``prted --help [topic]``.
+``ompi-prted --help [topic]``.
 
 At least for now, that content is not available in man page form.
 Pull requests to add all the content (via repeatable infrastructure)
 would be greatly appreciated.
 
 .. seealso::
-   :ref:`prte(1) <man1-prte>`
+   :ref:`ompi-prte(1) <man1-ompi-prte>`

docs/man/man1/prterun.1.rst renamed to docs/man/man1/ompi-prterun.1.rst

@@ -1,27 +1,27 @@
-.. _man1-prterun:
+.. _man1-ompi-prterun:
 
-prterun
-========
+ompi-prterun
+============
 
-prterun |mdash| launch an application with a default DVM
+ompi-prterun |mdash| launch an application with a default DVM
 
 SYNOPSIS
 --------
 
 .. code:: sh
 
-   shell$ prterun ...options...
+   shell$ ompi-prterun ...options...
 
 DESCRIPTION
 -----------
 
-``prterun`` submits a job to the PMIx Reference Runtime Environment
+``ompi-prterun`` submits a job to the PMIx Reference Runtime Environment
 (PRRTE).  A default set of distributed virtual
-machine (DVM) options are used; use :ref:`prun(1) <man1-prun>` if you
+machine (DVM) options are used; use :ref:`ompi-prun(1) <man1-ompi-prun>` if you
 wish to utilize specific DVM options.
 
 Much of this same help documentation for this command is also provided
-through ``prun --help [topic]``.
+through ``ompi-prun --help [topic]``.
 
 .. admonition:: PRRTE Docs TODO
    :class: error
@@ -46,4 +46,4 @@ EXIT STATUS
 Description of the various exit statuses of this command.
 
 .. seealso::
-   :ref:`prte(1) <man1-prte>`
+   :ref:`ompi-prte(1) <man1-ompi-prte>`