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 Bernardo Innocenti <bernie@develer.com>
34 * \brief Heap subsystem (public interface).
38 * \author Bernardo Innocenti <bernie@develer.com>
40 * \todo Heap memory could be defined as an array of MemChunk, and used
41 * in this form also within the implementation. This would probably remove
42 * memory alignment problems, and also some aliasing issues.
48 *#* Revision 1.7 2006/07/19 12:56:27 bernie
49 *#* Convert to new Doxygen style.
51 *#* Revision 1.6 2005/11/27 23:36:19 bernie
52 *#* Use appconfig.h instead of cfg/config.h.
54 *#* Revision 1.5 2005/11/04 16:20:02 bernie
55 *#* Fix reference to README.devlib in header.
57 *#* Revision 1.4 2005/04/11 19:10:28 bernie
58 *#* Include top-level headers from cfg/ subdir.
60 *#* Revision 1.3 2004/08/25 14:12:09 rasky
61 *#* Aggiornato il comment block dei log RCS
63 *#* Revision 1.2 2004/08/04 15:54:18 rasky
64 *#* Merge da SC: prima versione veramente funzionante
66 *#* Revision 1.1 2004/07/31 16:33:58 rasky
67 *#* Spostato lo heap da kern/ a mware/
69 *#* Revision 1.2 2004/06/03 11:27:09 bernie
70 *#* Add dual-license information.
72 *#* Revision 1.1 2004/05/23 17:27:00 bernie
73 *#* Import kern/ subdirectory.
80 #include <cfg/compiler.h>
81 #include <appconfig.h>
88 struct _MemChunk *FreeList; ///< Head of the free list
92 /// Initialize \a heap within the buffer pointed by \a memory which is of \a size bytes
93 void heap_init(struct Heap* heap, void* memory, size_t size);
95 /// Allocate a chunk of memory of \a size bytes from the heap
96 void *heap_allocmem(struct Heap* heap, size_t size);
98 /// Free a chunk of memory of \a size bytes from the heap
99 void heap_freemem(struct Heap* heap, void *mem, size_t size);
102 #define HNEW(heap, type) \
103 (type*)heap_allocmem(heap, sizeof(type))
105 #define HNEWVEC(heap, type, nelem) \
106 (type*)heap_allocmem(heap, sizeof(type) * (nelem))
108 #define HDELETE(heap, type, mem) \
109 heap_freemem(heap, mem, sizeof(type))
111 #define HDELETEVEC(heap, type, nelem, mem) \
112 heap_freemem(heap, mem, sizeof(type) * (nelem))
115 #if CONFIG_HEAP_MALLOC
117 void *heap_malloc(struct Heap* heap, size_t size);
118 void *heap_calloc(struct Heap* heap, size_t size);
119 void heap_free(struct Heap* heap, void * mem);
123 #endif /* MWARE_HEAP_H */