Merge pull request open-mpi#9820 from jsquyres/pr/show-help-file-audit

Fix issues turned up by opal_show_help() audit

Author: awlauria

contrib/check-help-strings.pl

@@ -1,6 +1,6 @@
 #!/usr/bin/env perl
 #
-# Copyright (c) 2014 Cisco Systems, Inc.  All rights reserved.
+# Copyright (c) 2014-2022 Cisco Systems, Inc.  All rights reserved.
 # $COPYRIGHT$
 #
 # Simple script to check all the opal_show_help (and orte_show_help)
@@ -242,13 +242,13 @@ sub check_name {
     my $sep = shift;
     my $src = shift;
 
-    while ($src =~ m/$name\s*$sep\s*"(.+?)"\s*,\s*"(.+?)"/) {
+    while ($src =~ m/$name\s*$sep\s*"(.+?)"\s*,.*?"(.+?)"/) {
         my $file = $1;
         my $topic = $2;
         check_file_topic($info, $file, $topic);
 
         # Don't find this one again
-        $src =~ s/$name\s*$sep\s*"(.+?)"\s*,\s*"(.+?)"/SHOW_HELP_REPLACED/;
+        $src =~ s/$name\s*$sep\s*"(.+?)"\s*,.*?"(.+?)"/SHOW_HELP_REPLACED/;
     }
 
     return $src;

ompi/dpm/dpm.c

@@ -10,7 +10,7 @@
  *                         University of Stuttgart.  All rights reserved.
  * Copyright (c) 2004-2005 The Regents of the University of California.
  *                         All rights reserved.
- * Copyright (c) 2007-2020 Cisco Systems, Inc.  All rights reserved.
+ * Copyright (c) 2007-2022 Cisco Systems, Inc.  All rights reserved.
  * Copyright (c) 2006-2009 University of Houston.  All rights reserved.
  * Copyright (c) 2009      Sun Microsystems, Inc.  All rights reserved.
  * Copyright (c) 2011-2015 Los Alamos National Security, LLC.  All rights
@@ -2060,7 +2060,7 @@ static int start_dvm(char **hostfiles, char **dash_host)
         execv(cmd, args);
 
         /* if I get here, the execv failed! */
-        opal_show_help("help-ess-base.txt", "ess-base:execv-error",
+        opal_show_help("help-dpm.txt", "execv-error",
                        true, cmd, strerror(errno));
         exit(1);
 

ompi/dpm/help-dpm.txt

@@ -1,6 +1,7 @@
 # -*- text -*-
 #
 # Copyright (c) 2020      Intel, Inc.  All rights reserved.
+# Copyright (c) 2022      Cisco Systems, Inc.  All rights reserved.
 # $COPYRIGHT$
 #
 # Additional copyrights may follow
@@ -44,3 +45,20 @@ the number of procs for each resource and the type of resource to be used.
   Specified value:  %s
 
 We are not able to proceed. Please correct your application.
+#
+[execv-error]
+
+The singleton application was not able to find an executabe in your
+PATH or in the directory where PRTE was initially installed, and
+therefore cannot continue.
+
+For reference, we tried the following command:
+
+  %s
+
+and got the error %s.
+
+This could mean that your PATH or executable name is wrong, or that
+you do not have the necessary permissions.  Please ensure that the
+executable is able to be found and executed as it is required for
+singleton operations.

ompi/errhandler/errhandler_predefined.c

@@ -11,7 +11,7 @@
  * Copyright (c) 2004-2005 The Regents of the University of California.
  *                         All rights reserved.
  * Copyright (c) 2006      University of Houston. All rights reserved.
- * Copyright (c) 2008-2018 Cisco Systems, Inc.  All rights reserved
+ * Copyright (c) 2008-2022 Cisco Systems, Inc.  All rights reserved.
  * Copyright (c) 2009      Sun Microsystems, Inc.  All rights reserved.
  * Copyright (c) 2010-2011 Oak Ridge National Labs.  All rights reserved.
  * Copyright (c) 2012      Los Alamos National Security, LLC.
@@ -338,6 +338,9 @@ static void backend_abort_aggregate(int fatal, char *type,
     usable_err_msg = (NULL == err_msg) ? unknown_error  : err_msg;
 
     if (NULL != name) {
+        // For the show_help topic checker script
+        // SHOW_HELP:"help-mpi-errors.txt","mpi_errors_are_fatal"
+        // SHOW_HELP:"help-mpi-errors.txt","mpi_errors_abort"
         opal_show_help("help-mpi-errors.txt",
                        fatal? "mpi_errors_are_fatal": "mpi_errors_abort",
                        false,

ompi/mca/mtl/psm2/help-mtl-psm2.txt

@@ -2,6 +2,7 @@
 #
 # Copyright (C) 2009. QLogic Corporation.  All rights reserved.
 # Copyright (c) 2013-2017 Intel, Inc. All rights reserved.
+# Copyright (c) 2022      Cisco Systems, Inc.  All rights reserved.
 # $COPYRIGHT$
 #
 # Additional copyrights may follow
@@ -13,11 +14,6 @@ Initialization of PSM2 library failed.
 
   Error: %s
 #
-[debug level]
-Unable to set PSM2 debug level.
-
-  Error: %s
-#
 [unable to open endpoint]
 PSM2 was unable to open an endpoint. Please make sure that the network link is
 active on the node and the hardware is functioning.
@@ -40,9 +36,6 @@ Unable to post application receive buffer (psm2_mq_irecv or psm2_mq_imrecv).
   Buffer:     %p
   Length:     %llu
 #
-[path query mechanism unknown]
-Unknown path record query mechanism %s. Supported mechanisms are %s.
-#
 [message too big]
 Message size %llu bigger than supported by PSM2 API. Max = %llu
 #

ompi/mpi/help-mpi-api.txt

@@ -2,7 +2,7 @@
 #
 # Copyright (c) 2006      High Performance Computing Center Stuttgart,
 #                         University of Stuttgart.  All rights reserved.
-# Copyright (c) 2006-2015 Cisco Systems, Inc.  All rights reserved.
+# Copyright (c) 2006-2022 Cisco Systems, Inc.  All rights reserved.
 # Copyright (c) 2018 IBM Corporation. All rights reserved.
 # Copyright (c) 2020      The University of Tennessee and The University
 #                         of Tennessee Research Foundation.  All rights
@@ -30,8 +30,3 @@ this environment.
 
   MPI function: %s
   Reason:       %s
-[info-set-with-reserved-prefix]
-Comments
-MPI_Info_set warning, key is using a reserved prefix.
-  Key:             %s
-  Reserved prefix: %s

ompi/runtime/help-mpi-runtime.txt

@@ -10,7 +10,7 @@
 #                         University of Stuttgart.  All rights reserved.
 # Copyright (c) 2004-2005 The Regents of the University of California.
 #                         All rights reserved.
-# Copyright (c) 2007-2018 Cisco Systems, Inc.  All rights reserved
+# Copyright (c) 2007-2022 Cisco Systems, Inc.  All rights reserved.
 # Copyright (c) 2013      NVIDIA Corporation.  All rights reserved.
 # Copyright (c) 2017-2020 Intel, Inc.  All rights reserved.
 # $COPYRIGHT$
@@ -95,16 +95,6 @@ Open MPI with --enable-heterogeneous.
 The user requested CUDA support with the --mca mpi_cuda_support 1 flag
 but the library was not compiled with any support.
 #
-[noconxcpt]
-The user has called an operation involving MPI_Connect and/or MPI_Accept,
-but this environment lacks the necessary infrastructure support for
-that operation. Open MPI relies on the PMIx_Publish/Lookup (or one of
-its predecessors) APIs for this operation.
-
-This typically happens when launching outside of mpirun where the underlying
-resource manager does not provide publish/lookup support. One way of solving
-the problem is to simply use mpirun to start the application.
-#
 [lib-call-fail]
 A library call unexpectedly failed.  This is a terminal error; please
 show this message to an Open MPI wizard:

opal/mca/btl/sm/Makefile.am

@@ -9,7 +9,7 @@
 #                         University of Stuttgart.  All rights reserved.
 # Copyright (c) 2004-2005 The Regents of the University of California.
 #                         All rights reserved.
-# Copyright (c) 2009-2014 Cisco Systems, Inc.  All rights reserved.
+# Copyright (c) 2009-2022 Cisco Systems, Inc.  All rights reserved.
 # Copyright (c) 2011-2014 Los Alamos National Security, LLC. All rights
 #                         reserved.
 # Copyright (c) 2017      IBM Corporation.  All rights reserved.
@@ -23,8 +23,6 @@
 
 AM_CPPFLAGS = $(btl_sm_CPPFLAGS)
 
-dist_opaldata_DATA = help-btl-sm.txt
-
 libmca_btl_sm_la_sources = \
     btl_sm_module.c \
     btl_sm.h \

opal/mca/btl/sm/btl_sm_component.c

@@ -11,7 +11,7 @@
  * Copyright (c) 2004-2005 The Regents of the University of California.
  *                         All rights reserved.
  * Copyright (c) 2006-2007 Voltaire. All rights reserved.
- * Copyright (c) 2009-2010 Cisco Systems, Inc.  All rights reserved.
+ * Copyright (c) 2009-2022 Cisco Systems, Inc.  All rights reserved.
  * Copyright (c) 2010-2018 Los Alamos National Security, LLC.
  *                         All rights reserved.
  * Copyright (c) 2011      NVIDIA Corporation.  All rights reserved.
@@ -35,7 +35,6 @@
 #include "opal/mca/threads/mutex.h"
 #include "opal/util/output.h"
 #include "opal/util/printf.h"
-#include "opal/util/show_help.h"
 
 #include "opal/mca/btl/sm/btl_sm.h"
 #include "opal/mca/btl/sm/btl_sm_fbox.h"

opal/mca/btl/sm/btl_sm_module.c

@@ -11,7 +11,7 @@
  * Copyright (c) 2004-2005 The Regents of the University of California.
  *                         All rights reserved.
  * Copyright (c) 2006-2007 Voltaire. All rights reserved.
- * Copyright (c) 2009      Cisco Systems, Inc.  All rights reserved.
+ * Copyright (c) 2009-2022 Cisco Systems, Inc.  All rights reserved.
  * Copyright (c) 2010-2015 Los Alamos National Security, LLC. All rights
  *                         reserved.
  * Copyright (c) 2014-2020 Intel, Inc.  All rights reserved.
@@ -29,7 +29,6 @@
  */
 
 #include "opal_config.h"
-#include "opal/util/show_help.h"
 
 #include "opal/mca/btl/sm/btl_sm.h"
 #include "opal/mca/btl/sm/btl_sm_fbox.h"