Snprintf2 (#1399)

* Replaced many uses of sprintf with safer snprintf

Many very straightforward, but in a few cases added a length parameter to some private functions, because buffer length was otherwise unknowable.

* Removed unnecessary use of static on small buffers

This improves thread safety.

* Committing clang-format changes

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

1 files changed, 83 insertions, 68 deletions

diff --git a/java/src/jni/h5util.c b/java/src/jni/h5util.c
index 02e99af..5a01dc9 100644
--- a/java/src/jni/h5util.c
+++ b/java/src/jni/h5util.c
@@ -182,7 +182,7 @@ size_t
 h5str_convert(JNIEnv *env, char **in_str, hid_t container, hid_t tid, void *out_buf, size_t out_buf_offset)
 {
     unsigned char *ucptr = NULL;
-    static char    fmt_llong[8], fmt_ullong[8];
+    char           fmt_llong[8], fmt_ullong[8];
     H5T_class_t    tclass      = H5T_NO_CLASS;
     const char     delimiter[] = " ," H5_COMPOUND_BEGIN_INDICATOR H5_COMPOUND_END_INDICATOR
         H5_ARRAY_BEGIN_INDICATOR H5_ARRAY_END_INDICATOR H5_VLEN_BEGIN_INDICATOR H5_VLEN_END_INDICATOR;
@@ -211,10 +211,10 @@ h5str_convert(JNIEnv *env, char **in_str, hid_t container, hid_t tid, void *out_
 
     /* Build default formats for long long types */
     if (!fmt_llong[0]) {
-        if (HDsprintf(fmt_llong, "%%%sd", H5_PRINTF_LL_WIDTH) < 0)
-            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_convert: HDsprintf failure");
-        if (HDsprintf(fmt_ullong, "%%%su", H5_PRINTF_LL_WIDTH) < 0)
-            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_convert: HDsprintf failure");
+        if (HDsnprintf(fmt_llong, sizeof(fmt_llong), "%%%sd", H5_PRINTF_LL_WIDTH) < 0)
+            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_convert: HDsnprintf failure");
+        if (HDsnprintf(fmt_ullong, sizeof(fmt_ullong), "%%%su", H5_PRINTF_LL_WIDTH) < 0)
+            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_convert: HDsnprintf failure");
     } /* end if */
 
     switch (tclass) {
@@ -759,7 +759,7 @@ size_t
 h5str_sprintf(JNIEnv *env, h5str_t *out_str, hid_t container, hid_t tid, void *in_buf, int expand_data)
 {
     unsigned char *ucptr = (unsigned char *)in_buf;
-    static char    fmt_llong[8], fmt_ullong[8];
+    char           fmt_llong[8], fmt_ullong[8];
     H5T_class_t    tclass   = H5T_NO_CLASS;
     size_t         typeSize = 0;
     H5T_sign_t     nsign    = H5T_SGN_ERROR;
@@ -794,11 +794,12 @@ h5str_sprintf(JNIEnv *env, h5str_t *out_str, hid_t container, hid_t tid, void *i
 
                     HDmemcpy(&tmp_float, cptr, sizeof(float));
 
-                    if (NULL == (this_str = (char *)HDmalloc(25)))
+                    size_t this_len = 25;
+                    if (NULL == (this_str = (char *)HDmalloc(this_len)))
                         H5_OUT_OF_MEMORY_ERROR(ENVONLY, "h5str_sprintf: failed to allocate string buffer");
 
-                    if (HDsprintf(this_str, "%g", tmp_float) < 0)
-                        H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsprintf failure");
+                    if (HDsnprintf(this_str, this_len, "%g", tmp_float) < 0)
+                        H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsnprintf failure");
 
                     break;
                 }
@@ -808,11 +809,12 @@ h5str_sprintf(JNIEnv *env, h5str_t *out_str, hid_t container, hid_t tid, void *i
 
                     HDmemcpy(&tmp_double, cptr, sizeof(double));
 
-                    if (NULL == (this_str = (char *)HDmalloc(25)))
+                    size_t this_len = 25;
+                    if (NULL == (this_str = (char *)HDmalloc(this_len)))
                         H5_OUT_OF_MEMORY_ERROR(ENVONLY, "h5str_sprintf: failed to allocate string buffer");
 
-                    if (HDsprintf(this_str, "%g", tmp_double) < 0)
-                        H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsprintf failure");
+                    if (HDsnprintf(this_str, "%g", this_len, tmp_double) < 0)
+                        H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsnprintf failure");
 
                     break;
                 }
@@ -822,11 +824,12 @@ h5str_sprintf(JNIEnv *env, h5str_t *out_str, hid_t container, hid_t tid, void *i
 
                     HDmemcpy(&tmp_ldouble, cptr, sizeof(long double));
 
-                    if (NULL == (this_str = (char *)HDmalloc(27)))
+                    size_t this_len = 27;
+                    if (NULL == (this_str = (char *)HDmalloc(this_len)))
                         H5_OUT_OF_MEMORY_ERROR(ENVONLY, "h5str_sprintf: failed to allocate string buffer");
 
-                    if (HDsprintf(this_str, "%Lg", tmp_ldouble) < 0)
-                        H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsprintf failure");
+                    if (HDsnprintf(this_str, this_len, "%Lg", tmp_ldouble) < 0)
+                        H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsnprintf failure");
 
                     break;
                 }
@@ -888,25 +891,26 @@ h5str_sprintf(JNIEnv *env, h5str_t *out_str, hid_t container, hid_t tid, void *i
                     unsigned char tmp_uchar = 0;
                     char          tmp_char  = 0;
 
+                    size_t this_len = 7;
                     if (H5T_SGN_NONE == nsign) {
                         HDmemcpy(&tmp_uchar, cptr, sizeof(unsigned char));
 
-                        if (NULL == (this_str = (char *)HDmalloc(7)))
+                        if (NULL == (this_str = (char *)HDmalloc(this_len)))
                             H5_OUT_OF_MEMORY_ERROR(ENVONLY,
                                                    "h5str_sprintf: failed to allocate string buffer");
 
-                        if (HDsprintf(this_str, "%hhu", tmp_uchar) < 0)
-                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsprintf failure");
+                        if (HDsnprintf(this_str, this_len, "%hhu", tmp_uchar) < 0)
+                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsnprintf failure");
                     }
                     else {
                         HDmemcpy(&tmp_char, cptr, sizeof(char));
 
-                        if (NULL == (this_str = (char *)HDmalloc(7)))
+                        if (NULL == (this_str = (char *)HDmalloc(this_len)))
                             H5_OUT_OF_MEMORY_ERROR(ENVONLY,
                                                    "h5str_sprintf: failed to allocate string buffer");
 
-                        if (HDsprintf(this_str, "%hhd", tmp_char) < 0)
-                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsprintf failure");
+                        if (HDsnprintf(this_str, this_len, "%hhd", tmp_char) < 0)
+                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsnprintf failure");
                     }
 
                     break;
@@ -916,25 +920,26 @@ h5str_sprintf(JNIEnv *env, h5str_t *out_str, hid_t container, hid_t tid, void *i
                     unsigned short tmp_ushort = 0;
                     short          tmp_short  = 0;
 
+                    size_t this_len = 9;
                     if (H5T_SGN_NONE == nsign) {
                         HDmemcpy(&tmp_ushort, cptr, sizeof(unsigned short));
 
-                        if (NULL == (this_str = (char *)HDmalloc(9)))
+                        if (NULL == (this_str = (char *)HDmalloc(this_len)))
                             H5_OUT_OF_MEMORY_ERROR(ENVONLY,
                                                    "h5str_sprintf: failed to allocate string buffer");
 
-                        if (HDsprintf(this_str, "%hu", tmp_ushort) < 0)
-                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsprintf failure");
+                        if (HDsnprintf(this_str, this_len, "%hu", tmp_ushort) < 0)
+                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsnprintf failure");
                     }
                     else {
                         HDmemcpy(&tmp_short, cptr, sizeof(short));
 
-                        if (NULL == (this_str = (char *)HDmalloc(9)))
+                        if (NULL == (this_str = (char *)HDmalloc(this_len)))
                             H5_OUT_OF_MEMORY_ERROR(ENVONLY,
                                                    "h5str_sprintf: failed to allocate string buffer");
 
-                        if (HDsprintf(this_str, "%hd", tmp_short) < 0)
-                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsprintf failure");
+                        if (HDsnprintf(this_str, this_len, "%hd", tmp_short) < 0)
+                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsnprintf failure");
                     }
 
                     break;
@@ -944,25 +949,26 @@ h5str_sprintf(JNIEnv *env, h5str_t *out_str, hid_t container, hid_t tid, void *i
                     unsigned int tmp_uint = 0;
                     int          tmp_int  = 0;
 
+                    size_t this_len = 14;
                     if (H5T_SGN_NONE == nsign) {
                         HDmemcpy(&tmp_uint, cptr, sizeof(unsigned int));
 
-                        if (NULL == (this_str = (char *)HDmalloc(14)))
+                        if (NULL == (this_str = (char *)HDmalloc(this_len)))
                             H5_OUT_OF_MEMORY_ERROR(ENVONLY,
                                                    "h5str_sprintf: failed to allocate string buffer");
 
-                        if (HDsprintf(this_str, "%u", tmp_uint) < 0)
-                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsprintf failure");
+                        if (HDsnprintf(this_str, this_len, "%u", tmp_uint) < 0)
+                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsnprintf failure");
                     }
                     else {
                         HDmemcpy(&tmp_int, cptr, sizeof(int));
 
-                        if (NULL == (this_str = (char *)HDmalloc(14)))
+                        if (NULL == (this_str = (char *)HDmalloc(this_len)))
                             H5_OUT_OF_MEMORY_ERROR(ENVONLY,
                                                    "h5str_sprintf: failed to allocate string buffer");
 
-                        if (HDsprintf(this_str, "%d", tmp_int) < 0)
-                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsprintf failure");
+                        if (HDsnprintf(this_str, this_len, "%d", tmp_int) < 0)
+                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsnprintf failure");
                     }
 
                     break;
@@ -972,25 +978,26 @@ h5str_sprintf(JNIEnv *env, h5str_t *out_str, hid_t container, hid_t tid, void *i
                     unsigned long tmp_ulong = 0;
                     long          tmp_long  = 0;
 
+                    size_t this_len = 23;
                     if (H5T_SGN_NONE == nsign) {
                         HDmemcpy(&tmp_ulong, cptr, sizeof(unsigned long));
 
-                        if (NULL == (this_str = (char *)HDmalloc(23)))
+                        if (NULL == (this_str = (char *)HDmalloc(this_len)))
                             H5_OUT_OF_MEMORY_ERROR(ENVONLY,
                                                    "h5str_sprintf: failed to allocate string buffer");
 
-                        if (HDsprintf(this_str, "%lu", tmp_ulong) < 0)
-                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsprintf failure");
+                        if (HDsnprintf(this_str, this_len, "%lu", tmp_ulong) < 0)
+                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsnprintf failure");
                     }
                     else {
                         HDmemcpy(&tmp_long, cptr, sizeof(long));
 
-                        if (NULL == (this_str = (char *)HDmalloc(23)))
+                        if (NULL == (this_str = (char *)HDmalloc(this_len)))
                             H5_OUT_OF_MEMORY_ERROR(ENVONLY,
                                                    "h5str_sprintf: failed to allocate string buffer");
 
-                        if (HDsprintf(this_str, "%ld", tmp_long) < 0)
-                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsprintf failure");
+                        if (HDsnprintf(this_str, this_len, "%ld", tmp_long) < 0)
+                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsnprintf failure");
                     }
 
                     break;
@@ -1001,25 +1008,26 @@ h5str_sprintf(JNIEnv *env, h5str_t *out_str, hid_t container, hid_t tid, void *i
                     unsigned long long tmp_ullong = 0;
                     long long          tmp_llong  = 0;
 
+                    size_t this_len = 25;
                     if (H5T_SGN_NONE == nsign) {
                         HDmemcpy(&tmp_ullong, cptr, sizeof(unsigned long long));
 
-                        if (NULL == (this_str = (char *)HDmalloc(25)))
+                        if (NULL == (this_str = (char *)HDmalloc(this_len)))
                             H5_OUT_OF_MEMORY_ERROR(ENVONLY,
                                                    "h5str_sprintf: failed to allocate string buffer");
 
-                        if (HDsprintf(this_str, fmt_ullong, tmp_ullong) < 0)
-                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsprintf failure");
+                        if (HDsnprintf(this_str, this_len, fmt_ullong, tmp_ullong) < 0)
+                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsnprintf failure");
                     }
                     else {
                         HDmemcpy(&tmp_llong, cptr, sizeof(long long));
 
-                        if (NULL == (this_str = (char *)HDmalloc(25)))
+                        if (NULL == (this_str = (char *)HDmalloc(this_len)))
                             H5_OUT_OF_MEMORY_ERROR(ENVONLY,
                                                    "h5str_sprintf: failed to allocate string buffer");
 
-                        if (HDsprintf(this_str, fmt_llong, tmp_llong) < 0)
-                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsprintf failure");
+                        if (HDsnprintf(this_str, this_len, fmt_llong, tmp_llong) < 0)
+                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsnprintf failure");
                     }
 
                     break;
@@ -1079,17 +1087,18 @@ h5str_sprintf(JNIEnv *env, h5str_t *out_str, hid_t container, hid_t tid, void *i
             else {
                 size_t i;
 
-                if (NULL == (this_str = (char *)HDmalloc(4 * (typeSize + 1))))
+                size_t this_len = 4 * (typeSize + 1);
+                if (NULL == (this_str = (char *)HDmalloc(this_len)))
                     H5_OUT_OF_MEMORY_ERROR(ENVONLY, "h5str_sprintf: failed to allocate string buffer");
 
                 if (1 == typeSize) {
-                    if (HDsprintf(this_str, "%#02x", ucptr[0]) < 0)
-                        H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsprintf failure");
+                    if (HDsnprintf(this_str, this_len, "%#02x", ucptr[0]) < 0)
+                        H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsnprintf failure");
                 }
                 else {
                     for (i = 0; i < typeSize; i++)
-                        if (HDsprintf(this_str, "%s%02x", i ? ":" : "", ucptr[i]) < 0)
-                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsprintf failure");
+                        if (HDsnprintf(this_str, this_len, "%s%02x", i ? ":" : "", ucptr[i]) < 0)
+                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsnprintf failure");
                 }
             }
 
@@ -1134,11 +1143,12 @@ h5str_sprintf(JNIEnv *env, h5str_t *out_str, hid_t container, hid_t tid, void *i
                                     else
                                         H5_LIBRARY_ERROR(ENVONLY);
 
-                                    if (NULL == (this_str = (char *)HDmalloc(14)))
+                                    size_t this_len = 14;
+                                    if (NULL == (this_str = (char *)HDmalloc(this_len)))
                                         H5_OUT_OF_MEMORY_ERROR(
                                             ENVONLY, "h5str_sprintf: failed to allocate string buffer");
-                                    if (HDsprintf(this_str, "%u-", (unsigned)oi.type) < 0)
-                                        H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsprintf failure");
+                                    if (HDsnprintf(this_str, this_len, "%u-", (unsigned)oi.type) < 0)
+                                        H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsnprintf failure");
                                     if (!h5str_append(out_str, this_str))
                                         H5_ASSERTION_ERROR(ENVONLY, "Unable to append string.");
                                     HDfree(this_str);
@@ -1150,11 +1160,13 @@ h5str_sprintf(JNIEnv *env, h5str_t *out_str, hid_t container, hid_t tid, void *i
 
                                         H5Otoken_to_str(tid, &oi.token, &token_str);
 
-                                        if (NULL == (this_str = (char *)HDmalloc(64 + strlen(token_str) + 1)))
+                                        size_t this_len = 64 + strlen(token_str) + 1;
+                                        if (NULL == (this_str = (char *)HDmalloc(this_len)))
                                             H5_OUT_OF_MEMORY_ERROR(
                                                 ENVONLY, "h5str_sprintf: failed to allocate string buffer");
-                                        if (HDsprintf(this_str, "%lu:%s", oi.fileno, token_str) < 0)
-                                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsprintf failure");
+                                        if (HDsnprintf(this_str, this_len, "%lu:%s", oi.fileno, token_str) <
+                                            0)
+                                            H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsnprintf failure");
 
                                         H5free_memory(token_str);
                                     }
@@ -1307,17 +1319,18 @@ h5str_sprintf(JNIEnv *env, h5str_t *out_str, hid_t container, hid_t tid, void *i
 
             /* All other types get printed as hexadecimal */
 
-            if (NULL == (this_str = (char *)HDmalloc(4 * (typeSize + 1))))
+            size_t this_len = 4 * (typeSize + 1);
+            if (NULL == (this_str = (char *)HDmalloc(this_len)))
                 H5_OUT_OF_MEMORY_ERROR(ENVONLY, "h5str_sprintf: failed to allocate string buffer");
 
             if (1 == typeSize) {
-                if (HDsprintf(this_str, "%#02x", ucptr[0]) < 0)
-                    H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsprintf failure");
+                if (HDsnprintf(this_str, this_len, "%#02x", ucptr[0]) < 0)
+                    H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsnprintf failure");
             }
             else {
                 for (i = 0; i < typeSize; i++)
-                    if (HDsprintf(this_str, "%s%02x", i ? ":" : "", ucptr[i]) < 0)
-                        H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsprintf failure");
+                    if (HDsnprintf(this_str, this_len, "%s%02x", i ? ":" : "", ucptr[i]) < 0)
+                        H5_JNI_FATAL_ERROR(ENVONLY, "h5str_sprintf: HDsnprintf failure");
             }
 
             break;
@@ -1519,8 +1532,9 @@ h5str_dump_region_blocks(JNIEnv *env, h5str_t *str, hid_t region_space, hid_t re
             for (j = 0; j < ndims; j++) {
                 tmp_str[0] = '\0';
 
-                if (HDsprintf(tmp_str, "%s%lu", j ? "," : "(", (unsigned long)ptdata[i * 2 * ndims + j]) < 0)
-                    H5_JNI_FATAL_ERROR(ENVONLY, "h5str_dump_region_blocks: HDsprintf failure");
+                if (HDsnprintf(tmp_str, sizeof(tmp_str), "%s%lu", j ? "," : "(",
+                               (unsigned long)ptdata[i * 2 * ndims + j]) < 0)
+                    H5_JNI_FATAL_ERROR(ENVONLY, "h5str_dump_region_blocks: HDsnprintf failure");
 
                 if (!h5str_append(str, tmp_str))
                     H5_ASSERTION_ERROR(ENVONLY, "Unable to append string.");
@@ -1529,9 +1543,9 @@ h5str_dump_region_blocks(JNIEnv *env, h5str_t *str, hid_t region_space, hid_t re
             for (j = 0; j < ndims; j++) {
                 tmp_str[0] = '\0';
 
-                if (HDsprintf(tmp_str, "%s%lu", j ? "," : ")-(",
-                              (unsigned long)ptdata[i * 2 * ndims + j + ndims]) < 0)
-                    H5_JNI_FATAL_ERROR(ENVONLY, "h5str_dump_region_blocks: HDsprintf failure");
+                if (HDsnprintf(tmp_str, sizeof(tmp_str), "%s%lu", j ? "," : ")-(",
+                               (unsigned long)ptdata[i * 2 * ndims + j + ndims]) < 0)
+                    H5_JNI_FATAL_ERROR(ENVONLY, "h5str_dump_region_blocks: HDsnprintf failure");
 
                 if (!h5str_append(str, tmp_str))
                     H5_ASSERTION_ERROR(ENVONLY, "Unable to append string.");
@@ -1696,8 +1710,9 @@ h5str_dump_region_points(JNIEnv *env, h5str_t *str, hid_t region_space, hid_t re
             for (j = 0; j < ndims; j++) {
                 tmp_str[0] = '\0';
 
-                if (HDsprintf(tmp_str, "%s%lu", j ? "," : "(", (unsigned long)(ptdata[i * ndims + j])) < 0)
-                    H5_JNI_FATAL_ERROR(ENVONLY, "h5str_dump_region_points: HDsprintf failure");
+                if (HDsnprintf(tmp_str, sizeof(tmp_str), "%s%lu", j ? "," : "(",
+                               (unsigned long)(ptdata[i * ndims + j])) < 0)
+                    H5_JNI_FATAL_ERROR(ENVONLY, "h5str_dump_region_points: HDsnprintf failure");
 
                 if (!h5str_append(str, tmp_str))
                     H5_ASSERTION_ERROR(ENVONLY, "Unable to append string.");