Make more portable.

[bertos.git] / mware / heap.c

diff --git a/mware/heap.c b/mware/heap.c
index b5d9775079209df4c7a6565bdd598976c9d72e6b..f1315505e6eaf06265a8770694eccca4b9c8b9c4 100755 (executable)
--- a/mware/heap.c
+++ b/mware/heap.c
@@ -13,25 +13,29 @@
  * \author Bernardo Innocenti <bernie@develer.com>
  */
 
-/*
- * $Log$
- * Revision 1.2  2004/08/04 15:54:18  rasky
- * Merge da SC: prima versione veramente funzionante
- *
- * Revision 1.1  2004/07/31 16:33:58  rasky
- * Spostato lo heap da kern/ a mware/
- *
- * Revision 1.2  2004/06/03 11:27:09  bernie
- * Add dual-license information.
- *
- * Revision 1.1  2004/05/23 17:27:00  bernie
- * Import kern/ subdirectory.
- *
- */
+/*#*
+ *#* $Log$
+ *#* Revision 1.6  2004/10/26 09:02:13  bernie
+ *#* heap_free(): Handle NULL pointers like free(), write documentation.
+ *#*
+ *#* Revision 1.5  2004/10/03 20:43:22  bernie
+ *#* Import changes from sc/firmware.
+ *#*
+ *#* Revision 1.1  2004/07/31 16:33:58  rasky
+ *#* Spostato lo heap da kern/ a mware/
+ *#*
+ *#* Revision 1.2  2004/06/03 11:27:09  bernie
+ *#* Add dual-license information.
+ *#*
+ *#* Revision 1.1  2004/05/23 17:27:00  bernie
+ *#* Import kern/ subdirectory.
+ *#*
+ *#*/
 
 #include "heap.h"
 #include <string.h>           // memset()
-#include <drv/kdebug.h>       // ASSERT()
+#include <macros.h>           // IS_POW2()
+#include <debug.h>            // ASSERT()
 
 /* NOTE: struct size must be a 2's power! */
 typedef struct _MemChunk
@@ -200,11 +204,28 @@ void *heap_calloc(struct Heap* h, size_t size)
        return mem;
 }
 
-void heap_free(struct Heap* h, void *mem_)
+/*!
+ * Free a block of memory, determining its size automatically.
+ *
+ * \param h    Heap from which the block was allocated.
+ * \param mem  Pointer to a block of memory previously allocated with
+ *             either heap_malloc() or heap_calloc().
+ *
+ * \note If \a mem is a NULL pointer, no operation is performed.
+ *
+ * \note Freeing the same memory block twice has undefined behavior.
+ *
+ * \note This function works like the ANSI C free().
+ */
+void heap_free(struct Heap *h, void *mem)
 {
-       size_t* mem = (size_t*)mem_;
-       --mem;
-       heap_freemem(h, mem, *mem);
+       size_t *_mem = (size_t *)mem;
+
+       if (_mem)
+       {
+               --_mem;
+               heap_freemem(h, _mem, *_mem);
+       }
 }
 
 #endif /* CONFIG_HEAP_MALLOC */