From: bernie <bernie@38d2e660-2303-0410-9eaa-f027e97ec537>
Date: Tue, 26 Oct 2004 09:02:13 +0000 (+0000)
Subject: heap_free(): Handle NULL pointers like free(), write documentation.
X-Git-Tag: 1.0.0~977
X-Git-Url: https://codewiz.org/gitweb?a=commitdiff_plain;h=e4ba598c0bbe1627a16804c88776d76b7314e1b6;p=bertos.git

heap_free(): Handle NULL pointers like free(), write documentation.


git-svn-id: https://src.develer.com/svnoss/bertos/trunk@264 38d2e660-2303-0410-9eaa-f027e97ec537
---

diff --git a/mware/heap.c b/mware/heap.c
index 249081b5..f1315505 100755
--- a/mware/heap.c
+++ b/mware/heap.c
@@ -15,6 +15,9 @@
 
 /*#*
  *#* $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.
  *#*
@@ -201,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 */