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