Merge pull request #7200 from cpshereda/master-opal_gethostname-change

Fix unsafe use of gethostname()

Author: jsquyres

ompi/info/info.c

@@ -17,6 +17,8 @@
  * Copyright (c) 2015-2018 Research Organization for Information Science
  *                         and Technology (RIST). All rights reserved.
  * Copyright (c) 2016-2017 IBM Corporation. All rights reserved.
+ * Copyright (c) 2019      Triad National Security, LLC. All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -40,6 +42,7 @@
 #endif
 #include <assert.h>
 
+#include "opal/runtime/opal.h"
 #include "opal/util/argv.h"
 #include "opal/util/opal_getcwd.h"
 #include "opal/util/output.h"
@@ -82,7 +85,7 @@ opal_pointer_array_t ompi_info_f_to_c_table = {{0}};
  */
 int ompi_mpiinfo_init(void)
 {
-    char val[OPAL_MAXHOSTNAMELEN];
+    const char *val;
     char *cptr;
 
     /* initialize table */
@@ -121,7 +124,7 @@ int ompi_mpiinfo_init(void)
     }
 
     /* local host name */
-    gethostname(val, sizeof(val));
+    val = opal_gethostname();
     opal_info_set(&ompi_mpi_info_env.info.super, "host", val);
 
     /* architecture name */

ompi/mca/common/monitoring/common_monitoring.c

@@ -10,6 +10,7 @@
  * Copyright (c) 2017-2018 Los Alamos National Security, LLC. All rights
  *                         reserved.
  * Copyright (c) 2018      Amazon.com, Inc. or its affiliates.  All Rights reserved.
+ * Copyright (c) 2019      Triad National Security, LLC. All rights reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -26,6 +27,7 @@
 #include <opal/class/opal_hash_table.h>
 #include <opal/util/output.h>
 #include "opal/util/printf.h"
+#include "opal/runtime/opal.h"
 #include <math.h>
 
 #if SIZEOF_LONG_LONG == SIZEOF_SIZE_T
@@ -213,11 +215,11 @@ int mca_common_monitoring_init( void )
     if( !mca_common_monitoring_enabled ) return OMPI_ERROR;
     if( 1 < opal_atomic_add_fetch_32(&mca_common_monitoring_hold, 1) ) return OMPI_SUCCESS; /* Already initialized */
 
-    char hostname[OPAL_MAXHOSTNAMELEN] = "NA";
+    const char *hostname;
     /* Initialize constant */
     log10_2 = log10(2.);
     /* Open the opal_output stream */
-    gethostname(hostname, sizeof(hostname));
+    hostname = opal_gethostname();
     opal_asprintf(&mca_common_monitoring_output_stream_obj.lds_prefix,
              "[%s:%06d] monitoring: ", hostname, getpid());
     mca_common_monitoring_output_stream_id =

ompi/mca/pml/v/pml_v_output.c

@@ -3,6 +3,8 @@
  *                         All rights reserved.
  * Copyright (c) 2017      IBM Corporation. All rights reserved.
  * Copyright (c) 2018      Amazon.com, Inc. or its affiliates.  All Rights reserved.
+ * Copyright (c) 2019      Triad National Security, LLC. All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -12,6 +14,7 @@
 
 #include "ompi_config.h"
 
+#include "opal/runtime/opal.h"
 #include "opal/util/output.h"
 #include "opal/util/printf.h"
 
@@ -24,7 +27,7 @@
 
 int ompi_pml_v_output_open(char *output, int verbosity) {
     opal_output_stream_t lds;
-    char hostname[OPAL_MAXHOSTNAMELEN] = "NA";
+    const char *hostname;
 
     OBJ_CONSTRUCT(&lds, opal_output_stream_t);
     if(!output) {
@@ -43,7 +46,7 @@ int ompi_pml_v_output_open(char *output, int verbosity) {
             lds.lds_file_suffix = output;
         }
         lds.lds_is_debugging = true;
-        gethostname(hostname, sizeof(hostname));
+        hostname = opal_gethostname();
         opal_asprintf(&lds.lds_prefix, "[%s:%05d] pml_v: ", hostname, getpid());
         lds.lds_verbose_level = verbosity;
         mca_pml_v.output = opal_output_open(&lds);

ompi/runtime/ompi_mpi_abort.c

@@ -19,6 +19,8 @@
  * Copyright (c) 2015      Mellanox Technologies, Inc.
  *                         All rights reserved.
  * Copyright (c) 2017      FUJITSU LIMITED.  All rights reserved.
+ * Copyright (c) 2019      Triad National Security, LLC. All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -42,6 +44,7 @@
 #endif
 #include <errno.h>
 
+#include "opal/runtime/opal.h"
 #include "opal/mca/backtrace/backtrace.h"
 #include "opal/util/error.h"
 #include "opal/runtime/opal_params.h"
@@ -121,7 +124,7 @@ int
 ompi_mpi_abort(struct ompi_communicator_t* comm,
                int errcode)
 {
-    char *host, hostname[OPAL_MAXHOSTNAMELEN];
+    const char *host;
     pid_t pid = 0;
 
     /* Protection for recursive invocation */
@@ -131,12 +134,11 @@ ompi_mpi_abort(struct ompi_communicator_t* comm,
     have_been_invoked = true;
 
     /* If MPI is initialized, we know we have a runtime nodename, so
-       use that.  Otherwise, call gethostname. */
+       use that.  Otherwise, call opal_gethostname. */
     if (ompi_rte_initialized) {
         host = ompi_process_info.nodename;
     } else {
-        gethostname(hostname, sizeof(hostname));
-        host = hostname;
+        host = opal_gethostname();
     }
     pid = getpid();
 

ompi/runtime/ompi_mpi_finalize.c

@@ -21,6 +21,8 @@
  *                         and Technology (RIST). All rights reserved.
  *
  * Copyright (c) 2016-2017 IBM Corporation. All rights reserved.
+ * Copyright (c) 2019      Triad National Security, LLC. All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -119,9 +121,9 @@ int ompi_mpi_finalize(void)
         /* Note that if we're not initialized or already finalized, we
            cannot raise an MPI exception.  The best that we can do is
            write something to stderr. */
-        char hostname[OPAL_MAXHOSTNAMELEN];
+        const char *hostname;
         pid_t pid = getpid();
-        gethostname(hostname, sizeof(hostname));
+        hostname = opal_gethostname();
 
         if (state < OMPI_MPI_STATE_INIT_COMPLETED) {
             opal_show_help("help-mpi-runtime.txt",

ompi/tools/mpisync/sync.c

@@ -1,6 +1,8 @@
 /*
  * Copyright (C) 2014      Artem Polyakov <[email protected]>
  * Copyright (c) 2014-2017 Intel, Inc. All rights reserved.
+ * Copyright (c) 2019      Triad National Security, LLC. All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -9,6 +11,7 @@
  */
 
 #include "opal_config.h"
+#include "opal/runtime/opal.h"
 
 #include <stdio.h>
 #include <mpi.h>
@@ -77,7 +80,8 @@ int main(int argc, char **argv)
     int rank, commsize;
     double offs = 0, rtt = 0;
     char hname[OPAL_MAXHOSTNAMELEN];
-
+    const char *local_hname;
+ 
     MPI_Comm_rank(comm, &rank);
     MPI_Comm_size(comm, &commsize);
 
@@ -99,11 +103,20 @@ int main(int argc, char **argv)
         MPI_Finalize();
         exit(1);
     }
-
-    if( gethostname(hname, sizeof(hname)) ){
-        perror("Cannot get hostname. Abort");
-        MPI_Abort(MPI_COMM_WORLD, 1);
-    }
+    /* All error checking for getting the hostname is done with the initial
+       populating of opal_process_info.nodename inside opal/runtime/opal_init.c */
+    local_hname = opal_gethostname();
+
+    /* Truncate hostname if it is longer than OPAL_MAXHOSTNAMELEN,
+       since we are only reading that length with the MPI_Gather.
+       If full and complete hostnames are necessary in all cases,
+       this could be implemented with MPI_Gatherv rather than
+       MPI_Gather, instead of using the longer but more
+       accurate OPAL_LOCAL_MAXHOSTNAMELEN value, because for very
+       large task counts there is a risk of running out of memory
+       if OPAL_LOCAL_MAXHOSTNAMELEN is used. */
+    strncpy(hname, local_hname, OPAL_MAXHOSTNAMELEN - 1);
+    hname[OPAL_MAXHOSTNAMELEN - 1] = '\0';
 
     int rc = hpctimer_initialize("gettimeofday");
 

opal/include/opal_config_bottom.h

@@ -301,6 +301,12 @@
 #define OPAL_MAXHOSTNAMELEN (255 + 1)
 #endif
 
+#define OPAL_LOCAL_MAXHOSTNAMELEN 4096
+
+#if (OPAL_MAXHOSTNAMELEN > OPAL_LOCAL_MAXHOSTNAMELEN)
+#define OPAL_LOCAL_MAXHOSTNAMELEN OPAL_MAXHOSTNAMELEN
+#endif
+
 /*
  * Do we want memory debugging?
  *

opal/mca/base/mca_base_component_find.c

@@ -16,6 +16,8 @@
  *                         and Technology (RIST). All rights reserved.
  * Copyright (c) 2014-2015 Los Alamos National Security, LLC. All rights
  *                         reserved.
+ * Copyright (c) 2019      Triad National Security, LLC. All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -45,6 +47,7 @@
 #include <netdb.h>
 #endif
 
+#include "opal/runtime/opal.h"
 #include "opal/mca/installdirs/installdirs.h"
 #include "opal/util/opal_environ.h"
 #include "opal/util/output.h"
@@ -330,8 +333,8 @@ static int component_find_check (mca_base_framework_t *framework, char **request
         }
 
         if (!found) {
-            char h[OPAL_MAXHOSTNAMELEN];
-            gethostname(h, sizeof(h));
+            const char *h;
+            h = opal_gethostname();
             opal_show_help("help-mca-base.txt",
                            "find-available:not-valid", true,
                            h, framework->framework_name, requested_component_names[i]);

opal/mca/base/mca_base_open.c

@@ -15,7 +15,7 @@
  *                         reserved.
  * Copyright (c) 2017      IBM Corporation.  All rights reserved.
  * Copyright (c) 2018      Amazon.com, Inc. or its affiliates.  All Rights reserved.
- * Copyright (c) 2018      Triad National Security, LLC. All rights
+ * Copyright (c) 2018-2019 Triad National Security, LLC. All rights
  *                         reserved.
  * $COPYRIGHT$
  *
@@ -73,7 +73,7 @@ int mca_base_open(void)
 {
     char *value;
     opal_output_stream_t lds;
-    char hostname[OPAL_MAXHOSTNAMELEN];
+    const char *hostname;
     int var_id;
 
     if (mca_base_opened++) {
@@ -159,7 +159,7 @@ int mca_base_open(void)
     } else {
         set_defaults(&lds);
     }
-    gethostname(hostname, sizeof(hostname));
+    hostname = opal_gethostname();
     opal_asprintf(&lds.lds_prefix, "[%s:%05d] ", hostname, getpid());
     opal_output_reopen(0, &lds);
     opal_output_verbose (MCA_BASE_VERBOSE_COMPONENT, 0, "mca: base: opening components");

opal/mca/if/linux_ipv6/if_linux_ipv6.c

@@ -3,6 +3,8 @@
  * Copyright (c) 2010      Oracle and/or its affiliates.  All rights reserved.
  * Copyright (c) 2018      Amazon.com, Inc. or its affiliates.  All Rights
  *                         reserved.
+ * Copyright (c) 2019      Triad National Security, LLC. All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -45,6 +47,7 @@
 #include <ifaddrs.h>
 #endif
 
+#include "opal/runtime/opal.h"
 #include "opal/constants.h"
 #include "opal/util/if.h"
 #include "opal/util/output.h"
@@ -127,8 +130,8 @@ static int if_linux_ipv6_open(void)
             opal_if_t *intf;
 
             if (!hexdecode(addrhex, a6.s6_addr, sizeof a6.s6_addr)) {
-                char hostname[OPAL_MAXHOSTNAMELEN];
-                gethostname(hostname, sizeof(hostname));
+                const char *hostname;
+                hostname = opal_gethostname();
                 opal_show_help("help-opal-if-linux-ipv6.txt",
                                "fail to parse if_inet6", true,
                                hostname, ifname, addrhex);