2635dff1594f9d8e58c12d7f4e9e1e7a8788b02b
[bertos.git] / mware / heap.h
1 /*!
2  * \file
3  * <!--
4  * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
5  * Copyright 1999,2000,2001 Bernardo Innocenti <bernie@develer.com>
6  * This file is part of DevLib - See devlib/README for information.
7  * -->
8  *
9  * \brief Heap subsystem (public interface).
10  *
11  * \version $Id$
12  *
13  * \author Bernardo Innocenti <bernie@develer.com>
14  *
15  * \todo Heap memory could be defined as an array of MemChunk, and used
16  * in this form also within the implementation. This would probably remove
17  * memory alignment problems, and also some aliasing issues.
18  *
19  */
20
21 /*#*
22  *#* $Log$
23  *#* Revision 1.3  2004/08/25 14:12:09  rasky
24  *#* Aggiornato il comment block dei log RCS
25  *#*
26  *#* Revision 1.2  2004/08/04 15:54:18  rasky
27  *#* Merge da SC: prima versione veramente funzionante
28  *#*
29  *#* Revision 1.1  2004/07/31 16:33:58  rasky
30  *#* Spostato lo heap da kern/ a mware/
31  *#*
32  *#* Revision 1.2  2004/06/03 11:27:09  bernie
33  *#* Add dual-license information.
34  *#*
35  *#* Revision 1.1  2004/05/23 17:27:00  bernie
36  *#* Import kern/ subdirectory.
37  *#*
38  *#*/
39
40 #ifndef MWARE_HEAP_H
41 #define MWARE_HEAP_H
42
43 #include <compiler.h>
44 #include <config.h>
45
46 struct _MemChunk;
47
48 //! A heap
49 struct Heap
50 {
51         struct _MemChunk *FreeList;     //!< Head of the free list
52 };
53
54
55 //! Initialize \a heap within the buffer pointed by \a memory which is of \a size bytes
56 void heap_init(struct Heap* heap, void* memory, size_t size);
57
58 //! Allocate a chunk of memory of \a size bytes from the heap
59 void *heap_allocmem(struct Heap* heap, size_t size);
60
61 //! Free a chunk of memory of \a size bytes from the heap
62 void heap_freemem(struct Heap* heap, void *mem, size_t size);
63
64
65 #define HNEW(heap, type) \
66         (type*)heap_allocmem(heap, sizeof(type))
67
68 #define HNEWVEC(heap, type, nelem) \
69         (type*)heap_allocmem(heap, sizeof(type) * (nelem))
70
71 #define HDELETE(heap, type, mem) \
72         heap_freemem(heap, mem, sizeof(type))
73
74 #define HDELETEVEC(heap, type, nelem, mem) \
75         heap_freemem(heap, mem, sizeof(type) * (nelem))
76
77
78 #if CONFIG_HEAP_MALLOC
79
80 void *heap_malloc(struct Heap* heap, size_t size);
81 void *heap_calloc(struct Heap* heap, size_t size);
82 void heap_free(struct Heap* heap, void * mem);
83
84 #endif
85
86 #endif /* MWARE_HEAP_H */