Encode help-*.txt file contents into C source code

Encode the show_help text files into memory so that
we don't have to find and open text files on-the-fly.
This helps with relocation, although not strictly
necessary. Biggest advantage is that we can supply
show_help output from the very beginning, even if
we haven't identified the text file directory.

Enable access to the new system by PRRTE via a new
API by which PRRTE can register its own in-memory
array of help messages. Default to the internal
PMIx array if show_help has yet to be initialized.

Add a new "INMEMHELP" capability flag so that PRRTE
can verify this PMIx version's support. Note that
PRRTE will be updated so that the master branch and
all release branches beginning with v4.0 can require
it to build.

Based on open-mpi/ompi#13144.

Signed-off-by: Ralph Castain <[email protected]>

Author: rhc54

.gitignore

@@ -143,7 +143,7 @@ src/tools/wrapper/pmixcc
 
 
 src/util/keyval/keyval_lex.c
-src/util/showhelp/showhelp_lex.c
+src/util/pmix_show_help_content.c
 
 test/pmi2_client
 test/pmi_client

config/pmix.m4

@@ -1387,6 +1387,7 @@ AC_DEFUN([PMIX_DO_AM_CONDITIONALS],[
         AM_CONDITIONAL(NEED_LIBPMIX, [test "$pmix_need_libpmix" = "1"])
         AM_CONDITIONAL([PMIX_HAVE_JANSSON], [test "x$pmix_check_jansson_happy" = "xyes"])
         AM_CONDITIONAL([PMIX_HAVE_CURL], [test "x$pmix_check_curl_happy" = "xyes"])
+        AM_CONDITIONAL([PMIX_PICKY_COMPILERS], [test "$WANT_PICKY_COMPILER" = "1"])
     ])
     pmix_did_am_conditionals=yes
 ])dnl

contrib/Makefile.am

@@ -15,7 +15,7 @@
 # Copyright (c) 2013-2016 Los Alamos National Security, Inc.  All rights
 #                         reserved.
 # Copyright (c) 2013-2020 Intel, Inc.  All rights reserved.
-# Copyright (c) 2022-2023 Nanook Consulting  All rights reserved.
+# Copyright (c) 2022-2025 Nanook Consulting  All rights reserved.
 # Copyright (c) 2024      Research Organization for Information Science
 #                         and Technology (RIST).  All rights reserved.
 # $COPYRIGHT$

contrib/construct_dictionary.py

@@ -2,7 +2,7 @@
 #
 # Copyright (c) 2020      Intel, Inc.  All rights reserved.
 # Copyright (c) 2020-2022 Cisco Systems, Inc.  All rights reserved
-# Copyright (c) 2021-2024 Nanook Consulting  All rights reserved.
+# Copyright (c) 2021-2025 Nanook Consulting  All rights reserved.
 # Copyright (c) 2022      Triad National Security, LLC. All rights reserved.
 # $COPYRIGHT$
 #
@@ -11,11 +11,9 @@
 # by tools to interpret user input
 #
 
-from __future__ import print_function
 import os
-import os.path
 import sys
-from optparse import OptionParser, OptionGroup
+import argparse
 
 index = 0
 
@@ -240,7 +238,7 @@ def harvest_constants(options, path, constants):
     return 0
 
 
-def _write_header(options, base_path, num_elements):
+def _write_header(options, num_elements):
     contents = '''/*
  * This file is autogenerated by construct_dictionary.py.
  * Do not edit this file by hand.
@@ -268,7 +266,7 @@ def _write_header(options, base_path, num_elements):
         constants = sys.stdout
         outpath = None
     else:
-        outpath = os.path.join(base_path, "pmix_dictionary.h")
+        outpath = os.path.join(options.out, "pmix_dictionary.h")
         try:
             constants = open(outpath, "w+")
         except Exception as e:
@@ -281,44 +279,26 @@ def _write_header(options, base_path, num_elements):
 
 
 def main():
-    parser = OptionParser("usage: %prog [options]")
-    debugGroup = OptionGroup(parser, "Debug Options")
-    debugGroup.add_option("--dryrun",
-                          action="store_true", dest="dryrun", default=False,
-                          help="Show output to screen")
-    parser.add_option_group(debugGroup)
-
-    (options, args) = parser.parse_args()
-
-    # Find the top-level PMIx source tree dir.
-    # Start with the location of this script, which we know is in
-    # $top_srcdir/contrib.
-    top_src_dir = os.path.dirname(sys.argv[0])
-    top_src_dir = os.path.join(top_src_dir, "..")
-    top_src_dir = os.path.abspath(top_src_dir)
-
-    # Sanity check
-    checkfile = os.path.join(top_src_dir, "VERSION")
-    if not os.path.exists(checkfile):
-        print("ERROR: Could not find top source directory for Open PMIx")
-        return 1
-
-    source_include_dir = os.path.join(top_src_dir, "include")
-
-    # This script is invoked from src/include/Makefile.am, and
-    # therefore the cwd will be $(builddir)/src/include.  Verify this
-    # by checking for a file that we know should be in there.
-    build_src_include_dir = os.getcwd()
-    checkfile = os.path.join(build_src_include_dir, "pmix_config.h")
-    if not os.path.exists(checkfile):
-        print("ERROR: Could not find build directory for Open PMIx")
-        return 1
-
-    if options.dryrun:
+    parser = argparse.ArgumentParser(description="Generate attribute dictionary.")
+    parser.add_argument("--root",
+                        required=True,
+                        help="Root directory of code tree")
+    parser.add_argument("--out",
+                        required=True,
+                        help="Output C file")
+    parser.add_argument("--dryrun",
+                        action="store_true",
+                        help="Do not write out resulting file")
+
+    args = parser.parse_args()
+
+    source_include_dir = os.path.join(args.root, "include")
+
+    if args.dryrun:
         constants = sys.stdout
         outpath = None
     else:
-        outpath = os.path.join(build_src_include_dir, "pmix_dictionary.c")
+        outpath = os.path.join(args.out, "pmix_dictionary.c")
         try:
             constants = open(outpath, "w+")
         except Exception as e:
@@ -341,7 +321,7 @@ def main():
     # looking for constants and typedefs
 
     # pmix_common.h.in is in the src tree
-    rc = harvest_constants(options,
+    rc = harvest_constants(args,
                            os.path.join(source_include_dir, "pmix_common.h.in"),
                            constants)
     if 0 != rc:
@@ -353,7 +333,7 @@ def main():
     constants.write(",\n")
 
     # pmix_deprecated.h is in the source tree
-    rc = harvest_constants(options,
+    rc = harvest_constants(args,
                            os.path.join(source_include_dir, "pmix_deprecated.h"),
                            constants)
     if 0 != rc:
@@ -369,7 +349,7 @@ def main():
     constants.close()
 
     # write the header
-    return _write_header(options, build_src_include_dir, index)
+    return _write_header(args, index)
 
 
 if __name__ == '__main__':

include/pmix_version.h.in

@@ -39,13 +39,16 @@
 /* Individual capability flags */
 #define PMIX_CAP_BASE            1
 #define PMIX_CAP_LTO             2
+#define PMIX_CAP_INMEMHELP       3
 
 
 /* These are the capabilities that this version of OpenPMIx has.
  * For now, we just define/use a "base" marker as a starting
  * point
  */
 #define PMIX_CAPABILITIES \
-    (PMIX_CAP_BASE | PMIX_CAP_LTO)
+    (PMIX_CAP_BASE | \
+     PMIX_CAP_LTO | \
+     PMIX_CAP_INMEMHELP)
 
 #endif

src/Makefile.am

@@ -14,7 +14,7 @@
 # Copyright (c) 2013-2020 Intel, Inc.  All rights reserved.
 # Copyright (c) 2021      Amazon.com, Inc. or its affiliates.
 #                         All Rights reserved.
-# Copyright (c) 2021-2022 Nanook Consulting  All rights reserved.
+# Copyright (c) 2021-2025 Nanook Consulting  All rights reserved.
 # $COPYRIGHT$
 #
 # Additional copyrights may follow
@@ -46,7 +46,6 @@ headers =
 sources =
 nodist_headers =
 EXTRA_DIST =
-dist_pmixdata_DATA =
 nobase_pmix_HEADERS =
 pmixdir = $(pmixincludedir)/$(subdir)
 

src/common/Makefile.include

@@ -2,15 +2,15 @@
 #
 # Copyright (c) 2015-2019 Intel, Inc.  All rights reserved.
 # Copyright (c) 2016      Cisco Systems, Inc.  All rights reserved.
-# Copyright (c) 2023-2024 Nanook Consulting  All rights reserved.
+# Copyright (c) 2023-2025 Nanook Consulting  All rights reserved.
 # $COPYRIGHT$
 #
 # Additional copyrights may follow
 #
 # $HEADER$
 #
 
-dist_pmixdata_DATA += \
+EXTRA_DIST += \
         common/help-pfexec-base.txt
 
 sources += \

src/common/pfexec_linux.c

@@ -243,7 +243,7 @@ static int write_help_msg(int fd, pmix_pfexec_pipe_err_msg_t *msg, const char *f
         return PMIX_ERR_BAD_PARAM;
     }
 
-    str = pmix_show_help_vstring(file, topic, true, ap);
+    str = pmix_show_help_vstring("pmix", file, topic, true, ap);
 
     msg->file_str_len = (int) strlen(file);
     if (msg->file_str_len > PMIX_PFEXEC_MAX_FILE_LEN) {
@@ -493,7 +493,7 @@ static pmix_status_t do_parent(pmix_app_t *app, pmix_pfexec_child_t *child, int
         }
 
         /* Print out what we got.  We already have a rendered string,
-           so use pmix_show_help_norender(). */
+           so just print it. */
         if (msg.msg_str_len > 0) {
             fprintf(stderr, "%s\n", str);
             free(str);

src/common/pmix_pfexec.c

@@ -1162,7 +1162,7 @@ static pmix_status_t do_parent(pmix_app_t *app, pmix_pfexec_child_t *child, int
         }
 
         /* Print out what we got.  We already have a rendered string,
-           so use pmix_show_help_norender(). */
+           so just print it. */
         if (msg.msg_str_len > 0) {
             fprintf(stderr, "%s\n", str);
             free(str);

src/hwloc/Makefile.include

@@ -1,14 +1,14 @@
 # -*- makefile -*-
 #
 # Copyright (c) 2016      Intel, Inc.  All rights reserved.
-# Copyright (c) 2021      Nanook Consulting.  All rights reserved.
+# Copyright (c) 2021-2025 Nanook Consulting  All rights reserved.
 # $COPYRIGHT$
 #
 # Additional copyrights may follow
 #
 # $HEADER$
 
-dist_pmixdata_DATA += hwloc/help-ploc.txt
+EXTRA_DIST += hwloc/help-ploc.txt
 
 headers += \
         hwloc/pmix_hwloc.h