Handle asprintf errors with opal_asprintf wrapper

The Open MPI code base assumed that asprintf always behaved like
the FreeBSD variant, where ptr is set to NULL on error.  However,
the C standard (and Linux) only guarantee that the return code will
be -1 on error and leave ptr undefined.  Rather than fix all the
usage in the code, we use opal_asprintf() wrapper instead, which
guarantees the BSD-like behavior of ptr always being set to NULL.
In addition to being correct, this will fix many, many warnings
in the Open MPI code base.

Signed-off-by: Brian Barrett <bbarrett@amazon.com>

Author: bwbarrett

contrib/build-mca-comps-outside-of-tree/btl_tcp2_component.c

@@ -12,6 +12,7 @@
  * Copyright (c) 2007-2010 Cisco Systems, Inc.  All rights reserved.
  * Copyright (c) 2008      Sun Microsystems, Inc.  All rights reserved.
  * Copyright (c) 2009      Oak Ridge National Laboratory
+ * Copyright (c) 2018      Amazon.com, Inc. or its affiliates.  All Rights reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -55,6 +56,7 @@
 #include "opal/util/argv.h"
 #include "opal/util/net.h"
 #include "opal/util/opal_sos.h"
+#include "opal/util/printf.h"
 
 #include "orte/types.h"
 #include "orte/util/show_help.h"
@@ -225,7 +227,7 @@ int mca_btl_tcp2_component_open(void)
                        mca_btl_tcp2_component.tcp_port_min );
         mca_btl_tcp2_component.tcp_port_min = 1024;
     }
-    asprintf( &message,
+    opal_asprintf( &message,
               "The number of ports where the TCP BTL will try to bind (default %d)."
               " This parameter together with the port min, define a range of ports"
               " where Open MPI will open sockets.",
@@ -244,7 +246,7 @@ int mca_btl_tcp2_component_open(void)
                        mca_btl_tcp2_component.tcp6_port_min );
         mca_btl_tcp2_component.tcp6_port_min = 1024;
     }
-    asprintf( &message,
+    opal_asprintf( &message,
               "The number of ports where the TCP BTL will try to bind (default %d)."
               " This parameter together with the port min, define a range of ports"
               " where Open MPI will open sockets.",

contrib/check_unnecessary_headers.sh

@@ -122,7 +122,7 @@ SEARCH_HEADER[37]="opal/util/os_dirpath.h opal_os_dirpath_create opal_os_dirpath
 SEARCH_HEADER[38]="opal/util/os_path.h opal_os_path opal_make_filename_os_friendly"
 SEARCH_HEADER[39]="opal/util/output.h opal_output_stream_t opal_output_init opal_output_finalize opal_output_open opal_output_reopen opal_output_switch opal_output_reopen_all opal_output_close opal_output opal_output_verbose opal_output_vverbose opal_output_string opal_output_vstring opal_output_set_verbosity opal_output_get_verbosity opal_output_set_output_file_info OPAL_OUTPUT OPAL_OUTPUT_VERBOSE"
 SEARCH_HEADER[40]="opal/util/path.h opal_path_find opal_path_findv opal_path_is_absolute opal_find_absolute_path opal_path_access"
-SEARCH_HEADER[41]="opal/util/printf.h snprintf vsnprintf asprintf vasprintf"
+SEARCH_HEADER[41]="opal/util/printf.h snprintf vsnprintf"
 SEARCH_HEADER[42]="opal/util/show_help.h opal_show_help_init opal_show_help_finalize opal_show_help opal_show_vhelp opal_show_help_string opal_show_help_finish_parsing"
 SEARCH_HEADER[43]="opal/util/strncpy.h opal_strncpy"
 SEARCH_HEADER[44]="opal/util/sys_limits.h opal_sys_limits opal_util_init_sys_limits"

contrib/scaling/mpi_memprobe.c

@@ -11,6 +11,7 @@
 #include "mpi.h"
 #include "opal/mca/pmix/pmix.h"
 #include "opal/util/argv.h"
+#include "opal/util/printf.h"
 #include "orte/runtime/runtime.h"
 #include "orte/util/proc_info.h"
 #include "orte/util/name_fns.h"
@@ -113,19 +114,19 @@ static void sample(void)
     wait_for_release = true;
     /* log my own results as a single string so the output
      * doesn't get garbled on the other end */
-    asprintf(&tmp, "Data for node %s", orte_process_info.nodename);
+    opal_asprintf(&tmp, "Data for node %s", orte_process_info.nodename);
     opal_argv_append_nosize(&answer, tmp);
     free(tmp);
     OPAL_LIST_FOREACH(kv, &response, opal_value_t) {
         lt = (opal_list_t*)kv->data.ptr;
         if (NULL != lt) {
             OPAL_LIST_FOREACH(ival, lt, opal_value_t) {
                 if (0 == strcmp(ival->key, OPAL_PMIX_DAEMON_MEMORY)) {
-                    asprintf(&tmp, "\tDaemon: %f", ival->data.fval);
+                    opal_asprintf(&tmp, "\tDaemon: %f", ival->data.fval);
                     opal_argv_append_nosize(&answer, tmp);
                     free(tmp);
                 } else if (0 == strcmp(ival->key, OPAL_PMIX_CLIENT_AVG_MEMORY)) {
-                    asprintf(&tmp, "\tClient: %f", ival->data.fval);
+                    opal_asprintf(&tmp, "\tClient: %f", ival->data.fval);
                     opal_argv_append_nosize(&answer, tmp);
                     free(tmp);
                 } else {

ompi/communicator/comm_cid.c

@@ -22,6 +22,7 @@
  *                         and Technology (RIST). All rights reserved.
  * Copyright (c) 2016      IBM Corporation.  All rights reserved.
  * Copyright (c) 2017      Mellanox Technologies. All rights reserved.
+ * Copyright (c) 2018      Amazon.com, Inc. or its affiliates.  All Rights reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -33,6 +34,7 @@
 
 #include "opal/dss/dss.h"
 #include "opal/mca/pmix/pmix.h"
+#include "opal/util/printf.h"
 
 #include "ompi/proc/proc.h"
 #include "ompi/communicator/communicator.h"
@@ -900,7 +902,7 @@ static int ompi_comm_allreduce_pmix_reduce_complete (ompi_comm_request_t *reques
     opal_dss.unload(&sbuf, (void**)&info.data.bo.bytes, &info.data.bo.size);
     OBJ_DESTRUCT(&sbuf);
 
-    bytes_written = asprintf(&info.key,
+    bytes_written = opal_asprintf(&info.key,
                              cid_context->send_first ? "%s:%s:send:%d"
                                                      : "%s:%s:recv:%d",
                              cid_context->port_string,
@@ -910,7 +912,7 @@ static int ompi_comm_allreduce_pmix_reduce_complete (ompi_comm_request_t *reques
     if (bytes_written == -1) {
         opal_output_verbose (verbosity_level, output_id, "writing info.key failed\n");
     } else {
-        bytes_written = asprintf(&pdat.value.key,
+        bytes_written = opal_asprintf(&pdat.value.key,
                                  cid_context->send_first ? "%s:%s:recv:%d"
                                                          : "%s:%s:send:%d",
                                  cid_context->port_string,

ompi/datatype/ompi_datatype_create.c

@@ -10,6 +10,7 @@
  *                         University of Stuttgart.  All rights reserved.
  * Copyright (c) 2009      Oak Ridge National Labs.  All rights reserved.
  * Copyright (c) 2010-2018 Cisco Systems, Inc.  All rights reserved
+ * Copyright (c) 2018      Amazon.com, Inc. or its affiliates.  All Rights reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -23,6 +24,7 @@
 #include <string.h>
 
 #include "opal/class/opal_pointer_array.h"
+#include "opal/util/printf.h"
 #include "ompi/datatype/ompi_datatype.h"
 #include "ompi/attribute/attribute.h"
 
@@ -110,7 +112,7 @@ ompi_datatype_duplicate( const ompi_datatype_t* oldType, ompi_datatype_t** newTy
     new_ompi_datatype->args = NULL;
 
     char *new_name;
-    asprintf(&new_name, "Dup %s", oldType->name);
+    opal_asprintf(&new_name, "Dup %s", oldType->name);
     strncpy(new_ompi_datatype->name, new_name, MPI_MAX_OBJECT_NAME - 1);
     new_ompi_datatype->name[MPI_MAX_OBJECT_NAME - 1] = '\0';
     free(new_name);

ompi/debuggers/dlopen_test.c

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2009-2018 Cisco Systems, Inc.  All rights reserved.
+ * Copyright (c) 2018      Amazon.com, Inc. or its affiliates.  All Rights reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -15,6 +16,7 @@
 #include <unistd.h>
 
 #include "opal/runtime/opal.h"
+#include "opal/util/printf.h"
 #include "opal/mca/dl/base/base.h"
 
 #if !OPAL_HAVE_DL_SUPPORT
@@ -119,7 +121,7 @@ static int do_test(void)
        get here, manually prefix the filename with .libs/ and try
        again. */
     char *rel_filename;
-    asprintf(&rel_filename, ".libs/%s", filename);
+    opal_asprintf(&rel_filename, ".libs/%s", filename);
     if (NULL == rel_filename) {
         return 1;
     }

ompi/debuggers/ompi_debuggers.c

@@ -13,6 +13,7 @@
  * Copyright (c) 2007-2016 Cisco Systems, Inc.  All rights reserved.
  * Copyright (c) 2012-2015 Los Alamos National Security, LLC. All rights
  *                         reserved.
+ * Copyright (c) 2018      Amazon.com, Inc. or its affiliates.  All Rights reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -48,6 +49,7 @@
 
 #include "opal/mca/base/base.h"
 #include "opal/util/argv.h"
+#include "opal/util/printf.h"
 #include "opal/mca/installdirs/installdirs.h"
 #include "debuggers.h"
 #include "ompi/mca/rte/rte.h"
@@ -132,7 +134,7 @@ static void check(char *dir, char *file, char **locations)
 {
     char *str;
 
-    asprintf(&str, "%s/%s.so", dir, file);
+    opal_asprintf(&str, "%s/%s.so", dir, file);
 
 #if defined(HAVE_SYS_STAT_H)
     {

ompi/dpm/dpm.c

@@ -18,6 +18,7 @@
  * Copyright (c) 2013-2017 Intel, Inc. All rights reserved.
  * Copyright (c) 2014-2017 Research Organization for Information Science
  *                         and Technology (RIST). All rights reserved.
+ * Copyright (c) 2018      Amazon.com, Inc. or its affiliates.  All Rights reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -41,6 +42,7 @@
 #include "opal/util/opal_getcwd.h"
 #include "opal/util/proc.h"
 #include "opal/util/show_help.h"
+#include "opal/util/printf.h"
 #include "opal/dss/dss.h"
 #include "opal/mca/hwloc/base/base.h"
 #include "opal/mca/pmix/pmix.h"
@@ -153,7 +155,7 @@ int ompi_dpm_connect_accept(ompi_communicator_t *comm, int root,
             return OMPI_ERR_NOT_SUPPORTED;
         }
         opal_argv_append_nosize(&members, nstring);
-        (void)asprintf(&nstring, "%d", size);
+        (void)opal_asprintf(&nstring, "%d", size);
         opal_argv_append_nosize(&members, nstring);
         free(nstring);
     } else {
@@ -208,11 +210,11 @@ int ompi_dpm_connect_accept(ompi_communicator_t *comm, int root,
         OBJ_CONSTRUCT(&info, opal_value_t);
         OBJ_CONSTRUCT(&pdat, opal_pmix_pdata_t);
         if (send_first) {
-            (void)asprintf(&info.key, "%s:connect", port_string);
-            (void)asprintf(&pdat.value.key, "%s:accept", port_string);
+            (void)opal_asprintf(&info.key, "%s:connect", port_string);
+            (void)opal_asprintf(&pdat.value.key, "%s:accept", port_string);
         } else {
-            (void)asprintf(&info.key, "%s:accept", port_string);
-            (void)asprintf(&pdat.value.key, "%s:connect", port_string);
+            (void)opal_asprintf(&info.key, "%s:accept", port_string);
+            (void)opal_asprintf(&pdat.value.key, "%s:connect", port_string);
         }
         info.type = OPAL_STRING;
         info.data.string = opal_argv_join(members, ':');
@@ -812,7 +814,7 @@ int ompi_dpm_spawn(int count, const char *array_of_commands[],
                 info = OBJ_NEW(opal_value_t);
                 info->key = strdup(OPAL_PMIX_PPR);
                 info->type = OPAL_STRING;
-                (void)asprintf(&(info->data.string), "%s:n", slot_list);
+                (void)opal_asprintf(&(info->data.string), "%s:n", slot_list);
                 opal_list_append(&job_info, &info->super);
             }
             ompi_info_get (array_of_info[i], "pernode", sizeof(slot_list) - 1, slot_list, &flag);

ompi/errhandler/errhandler_predefined.c

@@ -16,6 +16,7 @@
  * Copyright (c) 2012      Los Alamos National Security, LLC.
  *                         All rights reserved.
  * Copyright (c) 2016      Intel, Inc.  All rights reserved.
+ * Copyright (c) 2018      Amazon.com, Inc. or its affiliates.  All Rights reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -194,7 +195,7 @@ static void backend_fatal_aggregate(char *type,
     arg = va_arg(arglist, char*);
     va_end(arglist);
 
-    if (asprintf(&prefix, "[%s:%05d]",
+    if (opal_asprintf(&prefix, "[%s:%05d]",
                  ompi_process_info.nodename,
                  (int) ompi_process_info.pid) == -1) {
         prefix = NULL;
@@ -207,7 +208,7 @@ static void backend_fatal_aggregate(char *type,
     if (NULL != error_code) {
         err_msg = ompi_mpi_errnum_get_string(*error_code);
         if (NULL == err_msg) {
-            if (asprintf(&err_msg, unknown_error_code,
+            if (opal_asprintf(&err_msg, unknown_error_code,
                          *error_code) == -1) {
                 err_msg = NULL;
                 opal_output(0, "%s", "Could not write to err_msg");
@@ -333,7 +334,7 @@ static void backend_fatal_no_aggregate(char *type,
         }
 
         if (NULL != name) {
-            /* Don't use asprintf() here because there may be stack /
+            /* Don't use opal_asprintf() here because there may be stack /
                heap corruption by the time we're invoked, so just do
                it on the stack */
             str[0] = '\0';

ompi/mca/coll/fca/coll_fca_component.c

@@ -5,6 +5,7 @@
  *                         and Technology (RIST). All rights reserved.
  * Copyright (c) 2015      Los Alamos National Security, LLC. All rights
  *                         reserved.
+ * Copyright (c) 2018      Amazon.com, Inc. or its affiliates.  All Rights reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -27,9 +28,9 @@
 #ifdef HAVE_UNISTD_H
 #include <unistd.h>
 #endif
-#include "opal/mca/installdirs/installdirs.h"
-
 
+#include "opal/mca/installdirs/installdirs.h"
+#include "opal/util/printf.h"
 
 #include "coll_fca.h"
 
@@ -1212,10 +1213,10 @@ static char *fca_check_file(char *file)
 static char *fca_get_spec_file(void)
 {
     char *file;
-    asprintf(&file, "%s/etc/fca_mpi_spec.ini", COLL_FCA_HOME);
+    opal_asprintf(&file, "%s/etc/fca_mpi_spec.ini", COLL_FCA_HOME);
     if (NULL == fca_check_file(file)) {
         free(file);
-        asprintf(&file, "%s/../fca/etc/fca_mpi_spec.ini", opal_install_dirs.prefix);
+        opal_asprintf(&file, "%s/../fca/etc/fca_mpi_spec.ini", opal_install_dirs.prefix);
         if (NULL == fca_check_file(file)) {
             free(file);
             return NULL;