Fix naming conventions.
[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 README.devlib 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.6  2005/11/27 23:36:19  bernie
24  *#* Use appconfig.h instead of cfg/config.h.
25  *#*
26  *#* Revision 1.5  2005/11/04 16:20:02  bernie
27  *#* Fix reference to README.devlib in header.
28  *#*
29  *#* Revision 1.4  2005/04/11 19:10:28  bernie
30  *#* Include top-level headers from cfg/ subdir.
31  *#*
32  *#* Revision 1.3  2004/08/25 14:12:09  rasky
33  *#* Aggiornato il comment block dei log RCS
34  *#*
35  *#* Revision 1.2  2004/08/04 15:54:18  rasky
36  *#* Merge da SC: prima versione veramente funzionante
37  *#*
38  *#* Revision 1.1  2004/07/31 16:33:58  rasky
39  *#* Spostato lo heap da kern/ a mware/
40  *#*
41  *#* Revision 1.2  2004/06/03 11:27:09  bernie
42  *#* Add dual-license information.
43  *#*
44  *#* Revision 1.1  2004/05/23 17:27:00  bernie
45  *#* Import kern/ subdirectory.
46  *#*
47  *#*/
48
49 #ifndef MWARE_HEAP_H
50 #define MWARE_HEAP_H
51
52 #include <cfg/compiler.h>
53 #include <appconfig.h>
54
55 struct _MemChunk;
56
57 //! A heap
58 struct Heap
59 {
60         struct _MemChunk *FreeList;     //!< Head of the free list
61 };
62
63
64 //! Initialize \a heap within the buffer pointed by \a memory which is of \a size bytes
65 void heap_init(struct Heap* heap, void* memory, size_t size);
66
67 //! Allocate a chunk of memory of \a size bytes from the heap
68 void *heap_allocmem(struct Heap* heap, size_t size);
69
70 //! Free a chunk of memory of \a size bytes from the heap
71 void heap_freemem(struct Heap* heap, void *mem, size_t size);
72
73
74 #define HNEW(heap, type) \
75         (type*)heap_allocmem(heap, sizeof(type))
76
77 #define HNEWVEC(heap, type, nelem) \
78         (type*)heap_allocmem(heap, sizeof(type) * (nelem))
79
80 #define HDELETE(heap, type, mem) \
81         heap_freemem(heap, mem, sizeof(type))
82
83 #define HDELETEVEC(heap, type, nelem, mem) \
84         heap_freemem(heap, mem, sizeof(type) * (nelem))
85
86
87 #if CONFIG_HEAP_MALLOC
88
89 void *heap_malloc(struct Heap* heap, size_t size);
90 void *heap_calloc(struct Heap* heap, size_t size);
91 void heap_free(struct Heap* heap, void * mem);
92
93 #endif
94
95 #endif /* MWARE_HEAP_H */