Merge pull request contiki-ng#2830 from nvt/heapmem-calloc

heapmem: add a calloc function

Author: nfi

os/lib/heapmem.c

@@ -384,13 +384,12 @@ heapmem_zone_alloc_debug(heapmem_zone_t zone, size_t size,
 heapmem_zone_alloc(heapmem_zone_t zone, size_t size)
 #endif
 {
-  /* Fail early on too large allocation requests to prevent wrapping values. */
-  if(size > HEAPMEM_ARENA_SIZE) {
+  if(zone >= HEAPMEM_MAX_ZONES || zones[zone].name == NULL) {
+    LOG_WARN("Attempt to allocate from invalid zone: %u\n", zone);
     return NULL;
   }
 
-  if(zone >= HEAPMEM_MAX_ZONES || zones[zone].name == NULL) {
-    LOG_WARN("Attempt to allocate from invalid zone: %u\n", zone);
+  if(size > HEAPMEM_ARENA_SIZE || size == 0) {
     return NULL;
   }
 
@@ -587,6 +586,29 @@ heapmem_realloc(void *ptr, size_t size)
 }
 #endif /* HEAPMEM_REALLOC */
 
+/* heapmem_calloc: Allocates memory for a zero-initialized array. */
+void *
+#if HEAPMEM_DEBUG
+heapmem_calloc_debug(size_t nmemb, size_t size,
+		     const char *file, const unsigned line)
+#else
+heapmem_calloc(size_t nmemb, size_t size)
+#endif
+{
+  size_t total_size = nmemb * size;
+
+  /* Overflow check. */
+  if(size == 0 || total_size / size != nmemb) {
+    return NULL;
+  }
+
+  void *ptr = heapmem_alloc(total_size);
+  if(ptr != NULL) {
+    memset(ptr, 0, total_size);
+  }
+  return ptr;
+}
+
 /* heapmem_stats: Provides statistics regarding heap memory usage. */
 void
 heapmem_stats(heapmem_stats_t *stats)

os/lib/heapmem.h

@@ -101,8 +101,7 @@ typedef uint8_t heapmem_zone_t;
 
 /**
  * \brief      Register a zone with a reserved subdivision of the heap.
- * \param name A pointer to a chunk that has been allocated using
- *             heapmem_alloc() or heapmem_realloc().
+ * \param name A string containing the name of the zone.
  * \param zone_size The number of bytes to reserve for the zone.
  * \return     A zone ID if the allocation succeeds, or
  *             HEAPMEM_ZONE_INVALID if it fails.
@@ -112,17 +111,25 @@ heapmem_zone_t heapmem_zone_register(const char *name, size_t zone_size);
 
 #if HEAPMEM_DEBUG
 
-#define heapmem_alloc(size) heapmem_zone_alloc_debug(HEAPMEM_ZONE_GENERAL, (size), __FILE__, __LINE__)
-#define heapmem_zone_alloc(zone, size) heapmem_zone_alloc_debug((zone), (size), __FILE__, __LINE__)
-#define heapmem_realloc(ptr, size) heapmem_realloc_debug((ptr), (size), __FILE__, __LINE__)
-#define heapmem_free(ptr) heapmem_free_debug((ptr), __FILE__, __LINE__)
+#define heapmem_alloc(size) \
+  heapmem_zone_alloc_debug(HEAPMEM_ZONE_GENERAL, (size), __FILE__, __LINE__)
+#define heapmem_zone_alloc(zone, size) \
+  heapmem_zone_alloc_debug((zone), (size), __FILE__, __LINE__)
+#define heapmem_realloc(ptr, size) \
+  heapmem_realloc_debug((ptr), (size), __FILE__, __LINE__)
+#define heapmem_calloc(nmemb, size) \
+  heapmem_calloc_debug((nmemb), (size), __FILE__, __LINE__)
+#define heapmem_free(ptr) \
+  heapmem_free_debug((ptr), __FILE__, __LINE__)
 
 void *heapmem_alloc_debug(size_t size,
 			  const char *file, const unsigned line);
 void *heapmem_zone_alloc_debug(heapmem_zone_t zone, size_t size,
 			  const char *file, const unsigned line);
 void *heapmem_realloc_debug(void *ptr, size_t size,
 			    const char *file, const unsigned line);
+void *heapmem_calloc_debug(size_t nmemb, size_t size,
+			   const char *file, const unsigned line);
 bool heapmem_free_debug(void *ptr,
 			const char *file, const unsigned line);
 
@@ -137,7 +144,6 @@ bool heapmem_free_debug(void *ptr,
  * \sa         heapmem_realloc
  * \sa         heapmem_free
  */
-
 #define heapmem_alloc(size) heapmem_zone_alloc(HEAPMEM_ZONE_GENERAL, (size))
 
 /**
@@ -155,7 +161,7 @@ void *heapmem_zone_alloc(heapmem_zone_t zone, size_t size);
 /**
  * \brief      Reallocate a chunk of memory in the heap.
  * \param ptr  A pointer to a chunk that has been allocated using
- *             heapmem_alloc() or heapmem_realloc().
+ *             heapmem_alloc(), heapmem_calloc(), or heapmem_realloc().
  * \param size The number of bytes to allocate.
  * \return     A pointer to the allocated memory chunk,
  *             or NULL if the allocation failed.
@@ -165,24 +171,36 @@ void *heapmem_zone_alloc(heapmem_zone_t zone, size_t size);
  *       the chunk and returns NULL.
  *
  * \sa         heapmem_alloc
+ * \sa         heapmem_calloc
  * \sa         heapmem_free
  */
-
 void *heapmem_realloc(void *ptr, size_t size);
 
+/**
+ * \brief       Allocate memory for a zero-initialized array.
+ * \param nmemb The number of elements to allocate.
+ * \param size  The size of each element.
+ * \return      A pointer to the allocated memory,
+ *              or NULL if the allocation failed.
+ *
+ * \sa         heapmem_alloc
+ * \sa         heapmem_free
+ */
+void *heapmem_calloc(size_t nmemb, size_t size);
+
 /**
  * \brief      Deallocate a chunk of memory.
  * \param ptr  A pointer to a chunk that has been allocated using
- *             heapmem_alloc() or heapmem_realloc().
+ *             heapmem_alloc(), heapmem_calloc(), or heapmem_realloc().
  * \return     A boolean indicating whether the memory could be deallocated.
  *
  * \note If ptr is NULL, this function will return immediately without
  *       performing any action.
  *
  * \sa         heapmem_alloc
+ * \sa         heapmem_calloc
  * \sa         heapmem_realloc
  */
-
 bool heapmem_free(void *ptr);
 
 #endif /* HEAPMEM_DEBUG */
@@ -199,14 +217,12 @@ bool heapmem_free(void *ptr);
  * and the number of chunks allocated. By using this information, developers
  * can tune their software to use the heapmem allocator more efficiently.
  */
-
 void heapmem_stats(heapmem_stats_t *stats);
 
 /**
  * \brief       Obtain the minimum alignment of allocated addresses.
  * \return      The alignment value, which is a power of two.
  */
-
 size_t heapmem_alignment(void);
 
 #endif /* !HEAPMEM_H */

tests/08-native-runs/12-heapmem/Makefile

@@ -1,4 +1,5 @@
-all: test-heapmem
+CONTIKI_PROJECT = test-heapmem
+all: $(CONTIKI_PROJECT)
 
 TARGET ?= native
 

tests/08-native-runs/12-heapmem/test-heapmem.c

@@ -237,6 +237,37 @@ UNIT_TEST(reallocations)
 
   UNIT_TEST_END();
 }
+/*****************************************************************************/UNIT_TEST_REGISTER(zero_init_alloc, "Heapmem calloc");
+UNIT_TEST(zero_init_alloc)
+{
+#define MAX_SIZE 500
+#define NUM_ALLOCS 10
+
+  UNIT_TEST_BEGIN();
+
+  void *ptr1 = heapmem_calloc(0, MAX_SIZE);
+  UNIT_TEST_ASSERT(ptr1 == NULL);
+
+  void *ptr2 = heapmem_calloc(1, 0);
+  UNIT_TEST_ASSERT(ptr2 == NULL);
+
+  uint8_t *ptr_array[NUM_ALLOCS];
+  for(size_t i = 1; i <= NUM_ALLOCS; i++) {
+    size_t nmemb = i * 10;
+    size_t size = MAX_SIZE / i;
+    ptr_array[i - 1] = heapmem_calloc(nmemb, size);
+    UNIT_TEST_ASSERT(ptr_array[i - 1] != NULL);
+    for(size_t j = 0; j < nmemb * size; j++) {
+      UNIT_TEST_ASSERT(ptr_array[i - 1][j] == 0);
+    }
+  }
+
+  for(size_t i = 1; i <= NUM_ALLOCS; i++) {
+    UNIT_TEST_ASSERT(heapmem_free(ptr_array[NUM_ALLOCS - i]));
+  }
+
+  UNIT_TEST_END();
+}
 /*****************************************************************************/
 UNIT_TEST_REGISTER(stats_check, "Heapmem statistics validation");
 UNIT_TEST(stats_check)
@@ -301,12 +332,15 @@ PROCESS_THREAD(test_heapmem_process, ev, data)
   UNIT_TEST_RUN(max_alloc);
   UNIT_TEST_RUN(invalid_freeing);
   UNIT_TEST_RUN(reallocations);
+  UNIT_TEST_RUN(zero_init_alloc);
   UNIT_TEST_RUN(stats_check);
   UNIT_TEST_RUN(zones);
 
   if(!UNIT_TEST_PASSED(do_many_allocations) ||
      !UNIT_TEST_PASSED(max_alloc) ||
      !UNIT_TEST_PASSED(invalid_freeing) ||
+     !UNIT_TEST_PASSED(reallocations) ||
+     !UNIT_TEST_PASSED(zero_init_alloc) ||
      !UNIT_TEST_PASSED(stats_check) ||
      !UNIT_TEST_PASSED(zones)) {
     printf("=check-me= FAILED\n");

tests/08-native-runs/Makefile

@@ -15,7 +15,8 @@ examples/hello-world/native:./08-native-ping.sh \
 examples/coap/coap-example-server/native:./09-native-coap.sh \
 examples/snmp-server/native:./10-snmp-server.sh \
 tests/08-native-runs/11-aes-ccm/native:./11-aes-ccm.sh \
-tests/08-native-runs/12-heapmem/native:./12-heapmem.sh \
+tests/08-native-runs/12-heapmem/native:./12-heapmem.sh:DEFINES=HEAPMEM_DEBUG=0 \
+tests/08-native-runs/12-heapmem/native:./12-heapmem.sh:DEFINES=HEAPMEM_DEBUG=1 \
 tests/08-native-runs/13-coffee/native:./13-coffee.sh