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.2  2004/08/04 15:54:18  rasky
  24  * Merge da SC: prima versione veramente funzionante
  25  *
  26  * Revision 1.1  2004/07/31 16:33:58  rasky
  27  * Spostato lo heap da kern/ a mware/
  28  *
  29  * Revision 1.2  2004/06/03 11:27:09  bernie
  30  * Add dual-license information.
  31  *
  32  * Revision 1.1  2004/05/23 17:27:00  bernie
  33  * Import kern/ subdirectory.
  34  *
  35  */
  36
  37 #ifndef MWARE_HEAP_H
  38 #define MWARE_HEAP_H
  39
  40 #include <compiler.h>
  41 #include <config.h>
  42
  43 struct _MemChunk;
  44
  45 //! A heap
  46 struct Heap
  47 {
  48         struct _MemChunk *FreeList;     //!< Head of the free list
  49 };
  50
  51
  52 //! Initialize \a heap within the buffer pointed by \a memory which is of \a size bytes
  53 void heap_init(struct Heap* heap, void* memory, size_t size);
  54
  55 //! Allocate a chunk of memory of \a size bytes from the heap
  56 void *heap_allocmem(struct Heap* heap, size_t size);
  57
  58 //! Free a chunk of memory of \a size bytes from the heap
  59 void heap_freemem(struct Heap* heap, void *mem, size_t size);
  60
  61
  62 #define HNEW(heap, type) \
  63         (type*)heap_allocmem(heap, sizeof(type))
  64
  65 #define HNEWVEC(heap, type, nelem) \
  66         (type*)heap_allocmem(heap, sizeof(type) * (nelem))
  67
  68 #define HDELETE(heap, type, mem) \
  69         heap_freemem(heap, mem, sizeof(type))
  70
  71 #define HDELETEVEC(heap, type, nelem, mem) \
  72         heap_freemem(heap, mem, sizeof(type) * (nelem))
  73
  74
  75 #if CONFIG_HEAP_MALLOC
  76
  77 void *heap_malloc(struct Heap* heap, size_t size);
  78 void *heap_calloc(struct Heap* heap, size_t size);
  79 void heap_free(struct Heap* heap, void * mem);
  80
  81 #endif
  82
  83 #endif /* MWARE_HEAP_H */