src/mm/memory.h

   1 /* src/mm/memory.h - macros for memory management
   2
   3    Copyright (C) 1996-2005, 2006, 2007, 2008
   4    CACAOVM - Verein zur Foerderung der freien virtuellen Maschine CACAO
   5
   6    This file is part of CACAO.
   7
   8    This program is free software; you can redistribute it and/or
   9    modify it under the terms of the GNU General Public License as
  10    published by the Free Software Foundation; either version 2, or (at
  11    your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22
  23 */
  24
  25
  26 #ifndef _MEMORY_H
  27 #define _MEMORY_H
  28
  29 #include "config.h"
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 #include <string.h>
  36
  37 #include "vm/types.h"
  38
  39 #include "mm/codememory.h"
  40 #include "mm/dumpmemory.h"
  41
  42
  43 /* constants for ENABLE_MEMCHECK **********************************************/
  44
  45 #if defined(ENABLE_MEMCHECK)
  46 #define MEMORY_CANARY_SIZE          16
  47 #define MEMORY_CANARY_FIRST_BYTE    0xca
  48 #define MEMORY_CLEAR_BYTE           0xa5
  49 #endif /* defined(ENABLE_MEMCHECK) */
  50
  51
  52 /* internal includes **********************************************************/
  53
  54 #include "mm/gc-common.h"
  55
  56
  57 /*
  58 ---------------------------- Interface description -----------------------
  59
  60 There are two possible choices for allocating memory:
  61
  62         1.   explicit allocating / deallocating
  63
  64                         mem_alloc ..... allocate a memory block
  65                         mem_free ...... free a memory block
  66                         mem_realloc ... change size of a memory block (position may change)
  67                         mem_usage ..... amount of allocated memory
  68
  69 There are some useful macros:
  70
  71         NEW (type) ....... allocate memory for an element of type `type`
  72         FREE (ptr,type) .. free memory
  73
  74         MNEW (type,num) .. allocate memory for an array
  75         MFREE (ptr,type,num) .. free memory
  76
  77         MREALLOC (ptr,type,num1,num2) .. enlarge the array to size num2
  78
  79 -------------------------------------------------------------------------------
  80
  81 Some more macros:
  82
  83         MEMORY_ALIGN (pos, size) ... make pos divisible by size. always returns an
  84                                  address >= pos.
  85
  86
  87         OFFSET (s,el) ....... returns the offset of 'el' in structure 's' in bytes.
  88
  89         MCOPY (dest,src,type,num) ... copy 'num' elements of type 'type'.
  90
  91
  92 */
  93
  94 #define MEMORY_ALIGN(pos,size) ((((pos) + (size) - 1) / (size)) * (size))
  95 #define PADDING(pos,size)     (MEMORY_ALIGN((pos),(size)) - (pos))
  96 #define OFFSET(s,el)          ((int32_t) ((ptrint) &(((s*) 0)->el)))
  97
  98
  99 #define NEW(type)             ((type *) mem_alloc(sizeof(type)))
 100 #define FREE(ptr,type)        mem_free((ptr), sizeof(type))
 101
 102 #define MNEW(type,num)        ((type *) mem_alloc(sizeof(type) * (num)))
 103 #define MFREE(ptr,type,num)   mem_free((ptr), sizeof(type) * (num))
 104
 105 #define MREALLOC(ptr,type,num1,num2) mem_realloc((ptr), sizeof(type) * (num1), \
 106                                                         sizeof(type) * (num2))
 107
 108
 109 #define MCOPY(dest,src,type,num) memcpy((dest), (src), sizeof(type) * (num))
 110 #define MSET(ptr,byte,type,num) memset((ptr), (byte), sizeof(type) * (num))
 111 #define MZERO(ptr,type,num)     MSET(ptr,0,type,num)
 112 #define MMOVE(dest,src,type,num) memmove((dest), (src), sizeof(type) * (num))
 113
 114
 115 /* GC macros (boehm only) *****************************************************/
 116
 117 #if defined(ENABLE_GC_BOEHM)
 118
 119 /* Uncollectable memory which can contain references */
 120
 121 #define GCNEW_UNCOLLECTABLE(type,num) ((type *) heap_alloc_uncollectable(sizeof(type) * (num)))
 122
 123 #define GCNEW(type)           heap_alloc(sizeof(type), true, NULL, true)
 124 #define GCMNEW(type,num)      heap_alloc(sizeof(type) * (num), true, NULL, true)
 125
 126 #define GCFREE(ptr)           heap_free((ptr))
 127
 128 #endif
 129
 130
 131 /* function prototypes ********************************************************/
 132
 133 bool  memory_init(void);
 134
 135 void  memory_mprotect(void *addr, size_t len, int prot);
 136
 137 void *memory_checked_alloc(size_t size);
 138
 139 void *memory_cnew(int32_t size);
 140 void  memory_cfree(void *p, int32_t size);
 141
 142 void *mem_alloc(int32_t size);
 143 void  mem_free(void *m, int32_t size);
 144 void *mem_realloc(void *src, int32_t len1, int32_t len2);
 145
 146 #if defined(ENABLE_THREADS)
 147 bool  memory_start_thread(void);
 148 #endif
 149
 150 #ifdef __cplusplus
 151 }
 152 #endif
 153
 154 #endif /* _MEMORY_H */
 155
 156
 157 /*
 158  * These are local overrides for various environment variables in Emacs.
 159  * Please do not remove this and leave it at the end of the file, where
 160  * Emacs will automagically detect them.
 161  * ---------------------------------------------------------------------
 162  * Local variables:
 163  * mode: c
 164  * indent-tabs-mode: t
 165  * c-basic-offset: 4
 166  * tab-width: 4
 167  * End:
 168  * vim:noexpandtab:sw=4:ts=4:
 169  */