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>
43 #include <cfg/macros.h> // IS_POW2()
44 #include <cfg/debug.h> // ASSERT()
46 #include <string.h> // memset()
48 /* NOTE: struct size must be a 2's power! */
49 typedef struct _MemChunk
51 struct _MemChunk *next;
55 STATIC_ASSERT(IS_POW2(sizeof(MemChunk)));
57 #define FREE_FILL_CODE 0xDEAD
58 #define ALLOC_FILL_CODE 0xBEEF
60 void heap_init(struct Heap* h, void* memory, size_t size)
63 memset(memory, FREE_FILL_CODE, size);
66 /* Initialize heap with a single big chunk */
67 h->FreeList = (MemChunk *)memory;
68 h->FreeList->next = NULL;
69 h->FreeList->size = size;
73 void *heap_allocmem(struct Heap* h, size_t size)
75 MemChunk *chunk, *prev;
77 /* Round size up to the allocation granularity */
78 size = ROUND2(size, sizeof(MemChunk));
80 /* Handle allocations of 0 bytes */
82 size = sizeof(MemChunk);
84 /* Walk on the free list looking for any chunk big enough to
85 * fit the requested block size.
87 for (prev = (MemChunk *)&h->FreeList, chunk = h->FreeList;
89 prev = chunk, chunk = chunk->next)
91 if (chunk->size >= size)
93 if (chunk->size == size)
95 /* Just remove this chunk from the free list */
96 prev->next = chunk->next;
98 memset(chunk, ALLOC_FILL_CODE, size);
100 return (void *)chunk;
104 /* Allocate from the END of an existing chunk */
107 memset((uint8_t *)chunk + chunk->size, ALLOC_FILL_CODE, size);
109 return (void *)((uint8_t *)chunk + chunk->size);
114 return NULL; /* fail */
118 void heap_freemem(struct Heap* h, void *mem, size_t size)
124 memset(mem, FREE_FILL_CODE, size);
127 /* Round size up to the allocation granularity */
128 size = ROUND2(size, sizeof(MemChunk));
130 /* Handle allocations of 0 bytes */
132 size = sizeof(MemChunk);
134 /* Special case: first chunk in the free list */
135 ASSERT((uint8_t*)mem != (uint8_t*)h->FreeList);
136 if (((uint8_t *)mem) < ((uint8_t *)h->FreeList))
138 /* Insert memory block before the current free list head */
139 prev = (MemChunk *)mem;
140 prev->next = h->FreeList;
144 else /* Normal case: not the first chunk in the free list */
147 * Walk on the free list. Stop at the insertion point (when mem
148 * is between prev and prev->next)
151 while (prev->next < (MemChunk *)mem && prev->next)
154 /* Make sure mem is not *within* prev */
155 ASSERT((uint8_t*)mem >= (uint8_t*)prev + prev->size);
157 /* Should it be merged with previous block? */
158 if (((uint8_t *)prev) + prev->size == ((uint8_t *)mem))
163 else /* not merged with previous chunk */
165 MemChunk *curr = (MemChunk*)mem;
167 /* insert it after the previous node
168 * and move the 'prev' pointer forward
169 * for the following operations
171 curr->next = prev->next;
175 /* Adjust for the following test */
180 /* Also merge with next chunk? */
181 if (((uint8_t *)prev) + prev->size == ((uint8_t *)prev->next))
183 prev->size += prev->next->size;
184 prev->next = prev->next->next;
186 /* There should be only one merge opportunity, becuase we always merge on free */
187 ASSERT((uint8_t*)prev + prev->size != (uint8_t*)prev->next);
191 #if CONFIG_HEAP_MALLOC
193 void *heap_malloc(struct Heap* h, size_t size)
197 size += sizeof(size_t);
198 if ((mem = (size_t*)heap_allocmem(h, size)))
204 void *heap_calloc(struct Heap* h, size_t size)
208 if ((mem = heap_malloc(h, size)))
209 memset(mem, 0, size);
215 * Free a block of memory, determining its size automatically.
217 * \param h Heap from which the block was allocated.
218 * \param mem Pointer to a block of memory previously allocated with
219 * either heap_malloc() or heap_calloc().
221 * \note If \a mem is a NULL pointer, no operation is performed.
223 * \note Freeing the same memory block twice has undefined behavior.
225 * \note This function works like the ANSI C free().
227 void heap_free(struct Heap *h, void *mem)
229 size_t *_mem = (size_t *)mem;
234 heap_freemem(h, _mem, *_mem);
238 #endif /* CONFIG_HEAP_MALLOC */