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.
39 * \version $Id: heap.h 1532 2008-08-04 07:21:26Z bernie $
40 * \author Bernie Innocenti <bernie@codewiz.org>
46 #include "cfg/cfg_heap.h"
47 #include <cfg/compiler.h>
54 struct _MemChunk *FreeList; ///< Head of the free list
58 /// Initialize \a heap within the buffer pointed by \a memory which is of \a size bytes
59 void heap_init(struct Heap* heap, void* memory, size_t size);
61 /// Allocate a chunk of memory of \a size bytes from the heap
62 void *heap_allocmem(struct Heap* heap, size_t size);
64 /// Free a chunk of memory of \a size bytes from the heap
65 void heap_freemem(struct Heap* heap, void *mem, size_t size);
68 #define HNEW(heap, type) \
69 (type*)heap_allocmem(heap, sizeof(type))
71 #define HNEWVEC(heap, type, nelem) \
72 (type*)heap_allocmem(heap, sizeof(type) * (nelem))
74 #define HDELETE(heap, type, mem) \
75 heap_freemem(heap, mem, sizeof(type))
77 #define HDELETEVEC(heap, type, nelem, mem) \
78 heap_freemem(heap, mem, sizeof(type) * (nelem))
81 #if CONFIG_HEAP_MALLOC
83 void *heap_malloc(struct Heap* heap, size_t size);
84 void *heap_calloc(struct Heap* heap, size_t size);
85 void heap_free(struct Heap* heap, void * mem);
89 #endif /* STRUCT_HEAP_H */