Remove \version svn tag.

[bertos.git] / bertos / struct / heap.h

diff --git a/bertos/struct/heap.h b/bertos/struct/heap.h
index c19c2ec76653cf118683bda9bbb2a08e4b73a356..fc36cc7bf910f0fea2b4ebda92b340ad04c730fc 100644 (file)
--- a/bertos/struct/heap.h
+++ b/bertos/struct/heap.h
@@ -36,8 +36,10 @@
  * in this form also within the implementation. This would probably remove
  * memory alignment problems, and also some aliasing issues.
  *
- * \version $Id: heap.h 1532 2008-08-04 07:21:26Z bernie $
  * \author Bernie Innocenti <bernie@codewiz.org>
+ *
+ * $WIZ$ module_name = "heap"
+ * $WIZ$ module_configuration = "bertos/cfg/cfg_heap.h"
  */
 
 #ifndef STRUCT_HEAP_H
@@ -45,15 +47,33 @@
 
 #include "cfg/cfg_heap.h"
 #include <cfg/compiler.h>
+#include <cfg/macros.h> // IS_POW2()
+
+/* NOTE: struct size must be a 2's power! */
+typedef struct _MemChunk
+{
+       struct _MemChunk *next;
+       size_t size;
+} MemChunk;
+
+STATIC_ASSERT(IS_POW2(sizeof(MemChunk)));
 
-struct _MemChunk;
+typedef MemChunk heap_buf_t;
 
 /// A heap
-struct Heap
+typedef struct Heap
 {
        struct _MemChunk *FreeList;     ///< Head of the free list
-};
+} Heap;
 
+/**
+ * Utility macro to allocate a heap of size \a size.
+ *
+ * \param name Variable name for the heap.
+ * \param size Heap size in bytes.
+ */
+#define HEAP_DEFINE_BUF(name, size) \
+       heap_buf_t name[((size) + sizeof(heap_buf_t) - 1) / sizeof(heap_buf_t)]
 
 /// Initialize \a heap within the buffer pointed by \a memory which is of \a size bytes
 void heap_init(struct Heap* heap, void* memory, size_t size);
@@ -64,6 +84,7 @@ void *heap_allocmem(struct Heap* heap, size_t size);
 /// Free a chunk of memory of \a size bytes from the heap
 void heap_freemem(struct Heap* heap, void *mem, size_t size);
 
+size_t heap_freeSpace(struct Heap *h);
 
 #define HNEW(heap, type) \
        (type*)heap_allocmem(heap, sizeof(type))
@@ -86,4 +107,8 @@ void heap_free(struct Heap* heap, void * mem);
 
 #endif
 
+int heap_testSetup(void);
+int heap_testRun(void);
+int heap_testTearDown(void);
+
 #endif /* STRUCT_HEAP_H */