Split bson_alloc_array into two versions for bson_malloc0 calls; alignment no longer used

Author: Julia-Garland

src/libbson/src/bson/memory.c

@@ -236,13 +236,13 @@ bson_aligned_alloc0(size_t alignment /* IN */, size_t num_bytes /* IN */)
  *
  * bson_array_alloc --
  *
- *       Allocates zero-filled, aligned memory for an array of objects,
- *       checking for cases of n = 0 and integer overflow in type_size * len,
- *       in which case NULL is returned.
+ *       Allocates memory for an array of objects, checking for cases of 
+ *       n = 0 and integer overflow in type_size * len, in which case NULL 
+ *       is returned.
  *
  * Parameters:
  *       @type_size: The size of each object's type in bytes.
- *       @len: The number of objects to allocate.
+ *       @num_elems: The number of objects to allocate.
  *
  * Returns:
  *       A pointer if successful; otherwise abort() is called and this
@@ -255,13 +255,47 @@ bson_aligned_alloc0(size_t alignment /* IN */, size_t num_bytes /* IN */)
  */
 
 void *
-bson_array_alloc(size_t type_size /* IN */, size_t len /* IN */)
+bson_array_alloc(size_t type_size /* IN */, size_t num_elems /* IN */)
 {
    void *mem = NULL;
-   size_t num_bytes = type_size * len;
+   size_t num_bytes = type_size * num_elems;
 
-   if (BSON_LIKELY(num_bytes) && BSON_LIKELY(type_size == num_bytes / len)) {
-      mem = bson_aligned_alloc0(BSON_ALIGNOF(type_size), num_bytes);
+   if (BSON_LIKELY(num_bytes) && BSON_LIKELY(num_elems == num_bytes / type_size)) {
+      mem = bson_malloc(num_bytes);
+   }
+   return mem;
+}
+
+/*
+ *--------------------------------------------------------------------------
+ *
+ * bson_array_alloc0 --
+ *
+ *       Like bson_array_alloc() except the memory is zeroed after allocation
+ *       for convenience.
+ *
+ * Parameters:
+ *       @type_size: The size of each object's type in bytes.
+ *       @num_elems: The number of objects to allocate.
+ *
+ * Returns:
+ *       A pointer if successful; otherwise abort() is called and this
+ *       function will never return.
+ *
+ * Side effects:
+ *       None.
+ *
+ *--------------------------------------------------------------------------
+ */
+
+ void *
+bson_array_alloc0(size_t type_size /* IN */, size_t num_elems /* IN */)
+{
+   void *mem = NULL;
+   size_t num_bytes = type_size * num_elems;
+
+   if (BSON_LIKELY(num_bytes) && BSON_LIKELY(num_elems == num_bytes / type_size)) {
+      mem = bson_malloc0(num_bytes);
    }
    return mem;
 }

src/libbson/src/bson/memory.h

@@ -48,7 +48,9 @@ bson_aligned_alloc(size_t alignment, size_t num_bytes);
 BSON_EXPORT(void *)
 bson_aligned_alloc0(size_t alignment, size_t num_bytes);
 BSON_EXPORT(void *)
-bson_array_alloc(size_t type_size, size_t len);
+bson_array_alloc(size_t type_size, size_t num_elems);
+BSON_EXPORT(void *)
+bson_array_alloc0(size_t type_size, size_t num_elems);
 BSON_EXPORT(void *)
 bson_realloc(void *mem, size_t num_bytes);
 BSON_EXPORT(void *)

src/libbson/src/jsonsl/jsonsl.c

@@ -1054,7 +1054,7 @@ void jsonsl_jpr_match_state_init(jsonsl_t jsn,
     }
     jsn->jprs = (jsonsl_jpr_t *) bson_array_alloc (sizeof (jsonsl_jpr_t), njprs);
     jsn->jpr_count = njprs;
-    jsn->jpr_root = (size_t *) bson_array_alloc (sizeof (size_t), njprs * jsn->levels_max);
+    jsn->jpr_root = (size_t *) bson_array_alloc0 (sizeof (size_t), njprs * jsn->levels_max);
     memcpy(jsn->jprs, jprs, sizeof(jsonsl_jpr_t) * njprs);
     /* Set the initial jump table values */
 

src/libbson/tests/test-bson-vector.c

@@ -1392,7 +1392,7 @@ test_bson_vector_edge_cases_int8(void)
    // Test some read and write boundaries.
    {
       size_t values_size = 100;
-      int8_t *values = bson_array_alloc(sizeof *values, values_size);
+      int8_t *values = bson_array_alloc0(sizeof *values, values_size);
       TEST_BSON_VECTOR_EDGE_CASES_RW_COMMON(
          view, max_alloc_elements, values, values_size, bson_vector_int8_view_read, bson_vector_int8_view_write);
       bson_free(values);
@@ -1439,7 +1439,7 @@ test_bson_vector_edge_cases_float32(void)
    // Test some read and write boundaries.
    {
       size_t values_size = 100;
-      float *values = bson_array_alloc(sizeof *values, values_size);
+      float *values = bson_array_alloc0(sizeof *values, values_size);
       TEST_BSON_VECTOR_EDGE_CASES_RW_COMMON(
          view, max_alloc_elements, values, values_size, bson_vector_float32_view_read, bson_vector_float32_view_write);
       bson_free(values);
@@ -1506,7 +1506,7 @@ test_bson_vector_edge_cases_packed_bit(void)
    // Only tests one length, but it's chosen to be greater than 8 and not a multiple of 8.
    {
       size_t values_size = 190;
-      bool *values = bson_array_alloc(sizeof *values, values_size);
+      bool *values = bson_array_alloc0(sizeof *values, values_size);
       TEST_BSON_VECTOR_EDGE_CASES_RW_COMMON(view,
                                             max_alloc_elements,
                                             values,

src/libmongoc/src/mongoc/mongoc-cluster-sspi.c

@@ -65,7 +65,7 @@ _mongoc_cluster_sspi_new(mongoc_uri_t *uri, mongoc_stream_t *stream, const char
    service_ascii_len = strlen(service_ascii);
 
    /* this is donated to the sspi */
-   service = bson_array_alloc(sizeof(WCHAR), (service_ascii_len + 1));
+   service = bson_array_alloc0(sizeof(WCHAR), (service_ascii_len + 1));
    service_len =
       MultiByteToWideChar(CP_UTF8, 0, service_ascii, (int)service_ascii_len, service, (int)service_ascii_len);
    service[service_len] = L'\0';
@@ -75,7 +75,7 @@ _mongoc_cluster_sspi_new(mongoc_uri_t *uri, mongoc_stream_t *stream, const char
       tmp_creds_len = strlen(state->sasl.pass);
 
       /* this is donated to the sspi */
-      pass = bson_array_alloc(sizeof(WCHAR), (tmp_creds_len + 1));
+      pass = bson_array_alloc0(sizeof(WCHAR), (tmp_creds_len + 1));
       pass_len = MultiByteToWideChar(CP_UTF8, 0, state->sasl.pass, (int)tmp_creds_len, pass, (int)tmp_creds_len);
       pass[pass_len] = L'\0';
    }
@@ -84,7 +84,7 @@ _mongoc_cluster_sspi_new(mongoc_uri_t *uri, mongoc_stream_t *stream, const char
       tmp_creds_len = strlen(state->sasl.user);
 
       /* this is donated to the sspi */
-      user = bson_array_alloc(sizeof(WCHAR), (tmp_creds_len + 1));
+      user = bson_array_alloc0(sizeof(WCHAR), (tmp_creds_len + 1));
       user_len = MultiByteToWideChar(CP_UTF8, 0, state->sasl.user, (int)tmp_creds_len, user, (int)tmp_creds_len);
       user[user_len] = L'\0';
    }

src/libmongoc/src/mongoc/mongoc-server-description.c

@@ -987,7 +987,7 @@ mongoc_server_description_filter_tags(const mongoc_server_description_t **descri
       return;
    }
 
-   sd_matched = (bool *)bson_array_alloc(sizeof(bool), description_len);
+   sd_matched = (bool *)bson_array_alloc0(sizeof(bool), description_len);
 
    bson_iter_init(&rp_tagset_iter, rp_tags);
 

src/libmongoc/src/mongoc/mongoc-topology-background-monitoring.c

@@ -183,7 +183,7 @@ _remove_orphaned_server_monitors(mongoc_set_t *server_monitors, mongoc_set_t *se
 
    /* Signal shutdown to server monitors no longer in the topology description.
     */
-   server_monitor_ids_to_remove = bson_array_alloc(sizeof(uint32_t), server_monitors->items_len);
+   server_monitor_ids_to_remove = bson_array_alloc0(sizeof(uint32_t), server_monitors->items_len);
    for (size_t i = 0u; i < server_monitors->items_len; i++) {
       mongoc_server_monitor_t *server_monitor;
       uint32_t id;

src/libmongoc/src/mongoc/mongoc-topology-description.c

@@ -798,7 +798,7 @@ mongoc_topology_description_suitable_servers(mongoc_array_t *set, /* OUT */
       .topology_type = topology->type,
       .has_secondary = false,
       .candidates_len = 0,
-      .candidates = bson_array_alloc(sizeof(mongoc_server_description_t *), td_servers->items_len),
+      .candidates = bson_array_alloc0(sizeof(mongoc_server_description_t *), td_servers->items_len),
    };
 
    /* The "effective" read mode is the read mode that we should behave for, and
@@ -2370,7 +2370,7 @@ mongoc_topology_description_get_servers(const mongoc_topology_description_t *td,
 {
    const mongoc_set_t *const set = mc_tpld_servers_const(BSON_ASSERT_PTR_INLINE(td));
    /* enough room for all descriptions, even if some are unknown  */
-   mongoc_server_description_t **sds = bson_array_alloc(sizeof(mongoc_server_description_t *), set->items_len);
+   mongoc_server_description_t **sds = bson_array_alloc0(sizeof(mongoc_server_description_t *), set->items_len);
 
    BSON_ASSERT_PARAM(n);