4 * This file is part of BeRTOS.
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.
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.
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
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.
29 * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
30 * Copyright 1999, 2000, 2001, 2008 Bernie Innocenti <bernie@codewiz.org>
33 * \brief Heap subsystem (public interface).
35 * \todo Heap memory could be defined as an array of MemChunk, and used
36 * in this form also within the implementation. This would probably remove
37 * memory alignment problems, and also some aliasing issues.
40 * \author Bernie Innocenti <bernie@codewiz.org>
42 * $WIZ$ module_name = "heap"
43 * $WIZ$ module_configuration = "bertos/cfg/cfg_heap.h"
49 #include "cfg/cfg_heap.h"
50 #include <cfg/compiler.h>
51 #include <cfg/macros.h> // IS_POW2()
53 /* NOTE: struct size must be a 2's power! */
54 typedef struct _MemChunk
56 struct _MemChunk *next;
60 STATIC_ASSERT(IS_POW2(sizeof(MemChunk)));
62 typedef MemChunk heap_buf_t;
67 struct _MemChunk *FreeList; ///< Head of the free list
71 * Utility macro to allocate a heap of size \a size.
73 * \param name Variable name for the heap.
74 * \param size Heap size in bytes.
76 #define HEAP_DEFINE_BUF(name, size) \
77 heap_buf_t name[((size) + sizeof(heap_buf_t) - 1) / sizeof(heap_buf_t)]
79 /// Initialize \a heap within the buffer pointed by \a memory which is of \a size bytes
80 void heap_init(struct Heap* heap, void* memory, size_t size);
82 /// Allocate a chunk of memory of \a size bytes from the heap
83 void *heap_allocmem(struct Heap* heap, size_t size);
85 /// Free a chunk of memory of \a size bytes from the heap
86 void heap_freemem(struct Heap* heap, void *mem, size_t size);
88 size_t heap_freeSpace(struct Heap *h);
90 #define HNEW(heap, type) \
91 (type*)heap_allocmem(heap, sizeof(type))
93 #define HNEWVEC(heap, type, nelem) \
94 (type*)heap_allocmem(heap, sizeof(type) * (nelem))
96 #define HDELETE(heap, type, mem) \
97 heap_freemem(heap, mem, sizeof(type))
99 #define HDELETEVEC(heap, type, nelem, mem) \
100 heap_freemem(heap, mem, sizeof(type) * (nelem))
103 #if CONFIG_HEAP_MALLOC
105 void *heap_malloc(struct Heap* heap, size_t size);
106 void *heap_calloc(struct Heap* heap, size_t size);
107 void heap_free(struct Heap* heap, void * mem);
111 int heap_testSetup(void);
112 int heap_testRun(void);
113 int heap_testTearDown(void);
115 #endif /* STRUCT_HEAP_H */