bertos/struct/heap.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 1999, 2000, 2001, 2008 Bernie Innocenti <bernie@codewiz.org>
  31  * -->
  32  *
  33  * \defgroup heap Embedded optimized memory allocator
  34  * \ingroup core
  35  * \{
  36  *
  37  * \brief Heap subsystem (public interface).
  38  *
  39  * \todo Heap memory could be defined as an array of MemChunk, and used
  40  * in this form also within the implementation. This would probably remove
  41  * memory alignment problems, and also some aliasing issues.
  42  *
  43  * \author Bernie Innocenti <bernie@codewiz.org>
  44  *
  45  * $WIZ$ module_name = "heap"
  46  * $WIZ$ module_configuration = "bertos/cfg/cfg_heap.h"
  47  */
  48
  49 #ifndef STRUCT_HEAP_H
  50 #define STRUCT_HEAP_H
  51
  52 #include "cfg/cfg_heap.h"
  53 #include <cfg/compiler.h>
  54 #include <cfg/macros.h> // IS_POW2()
  55
  56 /* NOTE: struct size must be a 2's power! */
  57 typedef struct _MemChunk
  58 {
  59         struct _MemChunk *next;
  60         size_t size;
  61 } MemChunk;
  62
  63 STATIC_ASSERT(IS_POW2(sizeof(MemChunk)));
  64
  65 typedef MemChunk heap_buf_t;
  66
  67 /// A heap
  68 typedef struct Heap
  69 {
  70         struct _MemChunk *FreeList;     ///< Head of the free list
  71 } Heap;
  72
  73 /**
  74  * Utility macro to allocate a heap of size \a size.
  75  *
  76  * \param name Variable name for the heap.
  77  * \param size Heap size in bytes.
  78  */
  79 #define HEAP_DEFINE_BUF(name, size) \
  80         heap_buf_t name[((size) + sizeof(heap_buf_t) - 1) / sizeof(heap_buf_t)]
  81
  82 /// Initialize \a heap within the buffer pointed by \a memory which is of \a size bytes
  83 void heap_init(struct Heap* heap, void* memory, size_t size);
  84
  85 /// Allocate a chunk of memory of \a size bytes from the heap
  86 void *heap_allocmem(struct Heap* heap, size_t size);
  87
  88 /// Free a chunk of memory of \a size bytes from the heap
  89 void heap_freemem(struct Heap* heap, void *mem, size_t size);
  90
  91 size_t heap_freeSpace(struct Heap *h);
  92
  93 #define HNEW(heap, type) \
  94         (type*)heap_allocmem(heap, sizeof(type))
  95
  96 #define HNEWVEC(heap, type, nelem) \
  97         (type*)heap_allocmem(heap, sizeof(type) * (nelem))
  98
  99 #define HDELETE(heap, type, mem) \
 100         heap_freemem(heap, mem, sizeof(type))
 101
 102 #define HDELETEVEC(heap, type, nelem, mem) \
 103         heap_freemem(heap, mem, sizeof(type) * (nelem))
 104
 105
 106 #if CONFIG_HEAP_MALLOC
 107
 108 /**
 109  * \name Compatibility interface with C standard library
 110  * \{
 111  */
 112 void *heap_malloc(struct Heap* heap, size_t size);
 113 void *heap_calloc(struct Heap* heap, size_t size);
 114 void heap_free(struct Heap* heap, void * mem);
 115 /** \} */
 116
 117 #endif
 118
 119 /** \} */ //defgroup heap
 120
 121 int heap_testSetup(void);
 122 int heap_testRun(void);
 123 int heap_testTearDown(void);
 124
 125 #endif /* STRUCT_HEAP_H */