Cleanup use of strncat().

Make sure the length calculation takes prior
calls into consideration, and make sure it will
be '\0' terminated. The basic format for strncat()
calls are:

strncat(dest, source, dest_size-strlen(dest)-1);

Signed-off-by: Austen Lauria <awlauria@us.ibm.com>
(cherry picked from commit 48a71c1)

Author: awlauria

ompi/errhandler/errhandler_predefined.c

@@ -403,11 +403,11 @@ static void backend_abort_no_aggregate(int fatal, char *type,
 
             len -= strlen(type);
             if (len > 0) {
-                strncat(str, " ", len);
+                strncat(str, " ", len - 1);
 
                 --len;
                 if (len > 0) {
-                    strncat(str, name, len);
+                    strncat(str, name, len - 1);
                 }
             }
             out("*** on %s", str);

ompi/mpiext/affinity/c/mpiext_affinity_c.h

@@ -11,7 +11,7 @@
  *
  */
 
-#define OMPI_AFFINITY_STRING_MAX 1024
+#define OMPI_AFFINITY_STRING_MAX BUFSIZ
 
 typedef enum ompi_affinity_fmt {
     OMPI_AFFINITY_RSRC_STRING_FMT,

ompi/mpiext/affinity/c/mpiext_affinity_str.c

@@ -177,11 +177,9 @@ static char *bitmap2rangestr(int bitmap)
     size_t i;
     int range_start, range_end;
     bool first, isset;
-    char tmp[BUFSIZ];
+    char tmp[OMPI_AFFINITY_STRING_MAX - 1] = {0};
     const int stmp = sizeof(tmp) - 1;
-    static char ret[BUFSIZ];
-
-    memset(ret, 0, sizeof(ret));
+    static char ret[OMPI_AFFINITY_STRING_MAX] = {0};
 
     first = true;
     range_start = -999;
@@ -207,7 +205,7 @@ static char *bitmap2rangestr(int bitmap)
                     snprintf(tmp, stmp, "%d-%d", range_start, range_end);
                 }
                 size_t ret_len = strlen(ret);
-                snprintf(ret + ret_len, BUFSIZ - ret_len, "%s", tmp);
+                snprintf(ret + ret_len, sizeof(ret) - ret_len, "%s", tmp);
 
                 range_start = -999;
             }
@@ -235,7 +233,7 @@ static char *bitmap2rangestr(int bitmap)
             snprintf(tmp, stmp, "%d-%d", range_start, range_end);
         }
         size_t ret_len = strlen(ret);
-        snprintf(ret + ret_len, BUFSIZ - ret_len, "%s",  tmp);
+        snprintf(ret + ret_len, sizeof(ret) - ret_len, "%s",  tmp);
     }
 
     return ret;
@@ -249,7 +247,7 @@ static int cset2str(char *str, int len, hwloc_topology_t topo, hwloc_cpuset_t cp
     bool first;
     int num_sockets, num_cores;
     int ret, socket_index, core_index;
-    char tmp[BUFSIZ];
+    char tmp[OMPI_AFFINITY_STRING_MAX - 1] = {0};
     const int stmp = sizeof(tmp) - 1;
     int **map = NULL;
 
@@ -350,7 +348,7 @@ static bool is_single_cpu(hwloc_cpuset_t cpuset)
  */
 static int cset2mapstr(char *str, int len, hwloc_topology_t topo, hwloc_cpuset_t cpuset)
 {
-    char tmp[BUFSIZ];
+    char tmp[OMPI_AFFINITY_STRING_MAX - 1] = {0};
     int core_index, pu_index;
     const int stmp = sizeof(tmp) - 1;
     hwloc_obj_t socket, core, pu;
@@ -432,7 +430,7 @@ static int get_rsrc_current_binding(char str[OMPI_AFFINITY_STRING_MAX])
 
     /* If we are not bound, indicate that */
     if (!bound) {
-        strncat(str, not_bound_str, OMPI_AFFINITY_STRING_MAX - 1);
+        strncat(str, not_bound_str, OMPI_AFFINITY_STRING_MAX - strlen(str) - 1);
         ret = OMPI_SUCCESS;
     }
 
@@ -461,7 +459,7 @@ static int get_rsrc_exists(char str[OMPI_AFFINITY_STRING_MAX])
 {
     bool first = true;
     int i, num_cores, num_pus;
-    char tmp[OMPI_AFFINITY_STRING_MAX];
+    char tmp[OMPI_AFFINITY_STRING_MAX - 1] = {0};
     const int stmp = sizeof(tmp) - 1;
     hwloc_obj_t socket, core, c2;
 
@@ -471,12 +469,12 @@ static int get_rsrc_exists(char str[OMPI_AFFINITY_STRING_MAX])
          NULL != socket; socket = socket->next_cousin) {
         /* If this isn't the first socket, add a delimiter */
         if (!first) {
-            strncat(str, "; ", OMPI_AFFINITY_STRING_MAX - strlen(str));
+            strncat(str, "; ", OMPI_AFFINITY_STRING_MAX - strlen(str) - 1);
         }
         first = false;
 
         snprintf(tmp, stmp, "socket %d has ", socket->os_index);
-        strncat(str, tmp, OMPI_AFFINITY_STRING_MAX - strlen(str));
+        strncat(str, tmp, OMPI_AFFINITY_STRING_MAX - strlen(str) - 1);
 
         /* Find out how many cores are inside this socket, and get an
            object pointing to the first core.  Also count how many PUs
@@ -496,13 +494,13 @@ static int get_rsrc_exists(char str[OMPI_AFFINITY_STRING_MAX])
             /* Only 1 core */
             if (1 == num_cores) {
                 strncat(str, "1 core with ",
-                        OMPI_AFFINITY_STRING_MAX - strlen(str));
+                        OMPI_AFFINITY_STRING_MAX - strlen(str) - 1);
                 if (1 == num_pus) {
                     strncat(str, "1 hwt",
-                            OMPI_AFFINITY_STRING_MAX - strlen(str));
+                            OMPI_AFFINITY_STRING_MAX - strlen(str) - 1);
                 } else {
                     snprintf(tmp, stmp, "%d hwts", num_pus);
-                    strncat(str, tmp, OMPI_AFFINITY_STRING_MAX - strlen(str));
+                    strncat(str, tmp, OMPI_AFFINITY_STRING_MAX - strlen(str) - 1);
                 }
             }
 
@@ -511,7 +509,7 @@ static int get_rsrc_exists(char str[OMPI_AFFINITY_STRING_MAX])
                 bool same = true;
 
                 snprintf(tmp, stmp, "%d cores", num_cores);
-                strncat(str, tmp, OMPI_AFFINITY_STRING_MAX - strlen(str));
+                strncat(str, tmp, OMPI_AFFINITY_STRING_MAX - strlen(str) - 1);
 
                 /* Do all the cores have the same number of PUs? */
                 for (c2 = core; NULL != c2; c2 = c2->next_cousin) {
@@ -527,32 +525,32 @@ static int get_rsrc_exists(char str[OMPI_AFFINITY_STRING_MAX])
                 /* Yes, they all have the same number of PUs */
                 if (same) {
                     snprintf(tmp, stmp, ", each with %d hwt", num_pus);
-                    strncat(str, tmp, OMPI_AFFINITY_STRING_MAX - strlen(str));
+                    strncat(str, tmp, OMPI_AFFINITY_STRING_MAX - strlen(str) - 1);
                     if (num_pus != 1) {
-                        strncat(str, "s", OMPI_AFFINITY_STRING_MAX - strlen(str));
+                        strncat(str, "s", OMPI_AFFINITY_STRING_MAX - strlen(str) - 1);
                     }
                 }
 
                 /* No, they have differing numbers of PUs */
                 else {
                     bool first_iter = true;
 
-                    strncat(str, "with (", OMPI_AFFINITY_STRING_MAX - strlen(str));
+                    strncat(str, "with (", OMPI_AFFINITY_STRING_MAX - strlen(str) - 1);
                     for (c2 = core; NULL != c2; c2 = c2->next_cousin) {
                         if (!first_iter) {
                             strncat(str, ", ",
-                                    OMPI_AFFINITY_STRING_MAX - strlen(str));
+                                    OMPI_AFFINITY_STRING_MAX - strlen(str) - 1);
                         }
                         first_iter = false;
 
                         i = hwloc_get_nbobjs_inside_cpuset_by_type(opal_hwloc_topology,
                                                                    core->cpuset,
                                                                    HWLOC_OBJ_PU);
                         snprintf(tmp, stmp, "%d", i);
-                        strncat(str, tmp, OMPI_AFFINITY_STRING_MAX - strlen(str));
+                        strncat(str, tmp, OMPI_AFFINITY_STRING_MAX - strlen(str) - 1);
                     }
                     strncat(str, ") hwts",
-                            OMPI_AFFINITY_STRING_MAX - strlen(str));
+                            OMPI_AFFINITY_STRING_MAX - strlen(str) - 1);
                 }
             }
         }
@@ -620,7 +618,7 @@ static int get_layout_current_binding(char str[OMPI_AFFINITY_STRING_MAX])
 
     /* If we are not bound, indicate that */
     if (!bound) {
-        strncat(str, not_bound_str, OMPI_AFFINITY_STRING_MAX - 1);
+        strncat(str, not_bound_str, OMPI_AFFINITY_STRING_MAX - strlen(str) - 1);
         ret = OMPI_SUCCESS;
     }
 
@@ -652,7 +650,6 @@ static int get_layout_current_binding(char str[OMPI_AFFINITY_STRING_MAX])
 static int get_layout_exists(char str[OMPI_AFFINITY_STRING_MAX])
 {
     int core_index, pu_index;
-    int len = OMPI_AFFINITY_STRING_MAX;
     hwloc_obj_t socket, core, pu;
 
     str[0] = '\0';
@@ -662,7 +659,7 @@ static int get_layout_exists(char str[OMPI_AFFINITY_STRING_MAX])
                                         HWLOC_OBJ_SOCKET, 0);
          NULL != socket;
          socket = socket->next_cousin) {
-        strncat(str, "[", len - strlen(str));
+        strncat(str, "[", OMPI_AFFINITY_STRING_MAX - strlen(str) - 1);
 
         /* Iterate over all existing cores in this socket */
         core_index = 0;
@@ -674,7 +671,7 @@ static int get_layout_exists(char str[OMPI_AFFINITY_STRING_MAX])
                                                         socket->cpuset,
                                                         HWLOC_OBJ_CORE, ++core_index)) {
             if (core_index > 0) {
-                strncat(str, "/", len - strlen(str));
+                strncat(str, "/", OMPI_AFFINITY_STRING_MAX - strlen(str) - 1);
             }
 
             /* Iterate over all existing PUs in this core */
@@ -686,10 +683,10 @@ static int get_layout_exists(char str[OMPI_AFFINITY_STRING_MAX])
                  pu = hwloc_get_obj_inside_cpuset_by_type(opal_hwloc_topology,
                                                           core->cpuset,
                                                           HWLOC_OBJ_PU, ++pu_index)) {
-                strncat(str, ".", len - strlen(str));
+                strncat(str, ".", OMPI_AFFINITY_STRING_MAX - strlen(str) - 1);
             }
         }
-        strncat(str, "]", len - strlen(str));
+        strncat(str, "]", OMPI_AFFINITY_STRING_MAX - strlen(str) - 1);
     }
 
     return OMPI_SUCCESS;

ompi/tools/ompi_info/param.c

@@ -62,10 +62,10 @@ static void append(char *dest, size_t max, int *first, char *src)
 
     len = max - strlen(dest);
     if (!(*first)) {
-        strncat(dest, ", ", len);
+        strncat(dest, ", ", len - 1);
         len = max - strlen(dest);
     }
-    strncat(dest, src, len);
+    strncat(dest, src, len - 1);
     *first = 0;
 }
 

opal/util/cmd_line.c

@@ -499,7 +499,7 @@ char *opal_cmd_line_get_usage_msg(opal_cmd_line_t *cmd)
     int argc;
     size_t j;
     char **argv;
-    char *ret, temp[(MAX_WIDTH * 2) - 1], line[MAX_WIDTH * 2];
+    char *ret, line[(MAX_WIDTH * 2) + 1];
     char *start, *desc, *ptr;
     opal_list_item_t *item;
     ompi_cmd_line_option_t *option, **sorted;
@@ -559,27 +559,27 @@ char *opal_cmd_line_get_usage_msg(opal_cmd_line_t *cmd)
                 }
                 if (NULL != option->clo_single_dash_name) {
                     line[2] = (filled) ? '|' : ' ';
-                    strncat(line, "-", sizeof(line) - 1);
-                    strncat(line, option->clo_single_dash_name, sizeof(line) - 1);
+                    strncat(line, "-", sizeof(line) - strlen(line) - 1);
+                    strncat(line, option->clo_single_dash_name, sizeof(line) - strlen(line) - 1);
                     filled = true;
                 }
                 if (NULL != option->clo_long_name) {
                     if (filled) {
-                        strncat(line, "|", sizeof(line) - 1);
+                        strncat(line, "|", sizeof(line) - strlen(line) - 1);
                     } else {
-                        strncat(line, " ", sizeof(line) - 1);
+                        strncat(line, " ", sizeof(line) - strlen(line) - 1);
                     }
-                    strncat(line, "--", sizeof(line) - 1);
-                    strncat(line, option->clo_long_name, sizeof(line) - 1);
+                    strncat(line, "--", sizeof(line) - strlen(line) - 1);
+                    strncat(line, option->clo_long_name, sizeof(line) - strlen(line) - 1);
                 }
-                strncat(line, " ", sizeof(line) - 1);
+                strncat(line, " ", sizeof(line) - strlen(line) - 1);
                 for (i = 0; (int) i < option->clo_num_params; ++i) {
-                    len = sizeof(temp);
-                    snprintf(temp, len, "<arg%d> ", (int) i);
-                    strncat(line, temp, sizeof(line) - 1);
+                    char temp[MAX_WIDTH * 2];
+                    snprintf(temp, MAX_WIDTH * 2, "<arg%d> ", (int) i);
+                    strncat(line, temp, sizeof(line) - strlen(line) - 1);
                 }
                 if (option->clo_num_params > 0) {
-                    strncat(line, " ", sizeof(line) - 1);
+                    strncat(line, " ", sizeof(line) - strlen(line) - 1);
                 }
 
                 /* If we're less than param width, then start adding the
@@ -635,7 +635,7 @@ char *opal_cmd_line_get_usage_msg(opal_cmd_line_t *cmd)
                     /* Last line */
 
                     if (strlen(start) < (MAX_WIDTH - PARAM_WIDTH)) {
-                        strncat(line, start, sizeof(line) - 1);
+                        strncat(line, start, sizeof(line) - strlen(line) - 1);
                         opal_argv_append(&argc, &argv, line);
                         break;
                     }
@@ -647,7 +647,7 @@ char *opal_cmd_line_get_usage_msg(opal_cmd_line_t *cmd)
                     for (ptr = start + (MAX_WIDTH - PARAM_WIDTH); ptr > start; --ptr) {
                         if (isspace(*ptr)) {
                             *ptr = '\0';
-                            strncat(line, start, sizeof(line) - 1);
+                            strncat(line, start, sizeof(line) - strlen(line) - 1);
                             opal_argv_append(&argc, &argv, line);
 
                             start = ptr + 1;
@@ -666,7 +666,7 @@ char *opal_cmd_line_get_usage_msg(opal_cmd_line_t *cmd)
                             if (isspace(*ptr)) {
                                 *ptr = '\0';
 
-                                strncat(line, start, sizeof(line) - 1);
+                                strncat(line, start, sizeof(line) - strlen(line) - 1);
                                 opal_argv_append(&argc, &argv, line);
 
                                 start = ptr + 1;
@@ -680,7 +680,7 @@ char *opal_cmd_line_get_usage_msg(opal_cmd_line_t *cmd)
                            whitespace, then just add it on and be done */
 
                         if (ptr >= start + len) {
-                            strncat(line, start, sizeof(line) - 1);
+                            strncat(line, start, sizeof(line) - strlen(line) - 1);
                             opal_argv_append(&argc, &argv, line);
                             start = desc + len + 1;
                         }

opal/util/os_path.c

@@ -88,15 +88,15 @@ char *opal_os_path(int relative, ...)
     va_start(ap, relative);
     if (NULL != (element = va_arg(ap, char *))) {
         if (path_sep[0] != element[0]) {
-            strncat(path, path_sep, total_length);
+            strncat(path, path_sep, total_length - strlen(path) - 1);
         }
-        strcat(path, element);
+        strncat(path, element, total_length - strlen(path) - 1);
     }
     while (NULL != (element = va_arg(ap, char *))) {
         if (path_sep[0] != element[0]) {
-            strncat(path, path_sep, total_length);
+            strncat(path, path_sep, total_length - strlen(path) - 1);
         }
-        strncat(path, element, total_length);
+        strncat(path, element, total_length - strlen(path) - 1);
     }
 
     va_end(ap);