src/mm/memory.h

   1 /* src/mm/memory.h - macros for memory management
   2
   3    Copyright (C) 1996-2005, 2006, 2007 R. Grafl, A. Krall, C. Kruegel,
   4    C. Oates, R. Obermaisser, M. Platter, M. Probst, S. Ring,
   5    E. Steiner, C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich,
   6    J. Wenninger, Institut f. Computersprachen - TU Wien
   7
   8    This file is part of CACAO.
   9
  10    This program is free software; you can redistribute it and/or
  11    modify it under the terms of the GNU General Public License as
  12    published by the Free Software Foundation; either version 2, or (at
  13    your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful, but
  16    WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18    General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program; if not, write to the Free Software
  22    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  23    02110-1301, USA.
  24
  25 */
  26
  27
  28 #ifndef _MEMORY_H
  29 #define _MEMORY_H
  30
  31 /* forward typedefs ***********************************************************/
  32
  33 typedef struct dumpblock_t dumpblock_t;
  34 typedef struct dumpinfo_t  dumpinfo_t;
  35
  36 #include "config.h"
  37
  38 #include <string.h>
  39
  40 #include "vm/types.h"
  41
  42
  43 /* ATTENTION: We need to define dumpblock_t and dumpinfo_t before
  44    internal includes, as we need dumpinfo_t as nested structure in
  45    threadobject. */
  46
  47 /* dumpblock ******************************************************************/
  48
  49 #define DUMPBLOCKSIZE    2 << 13    /* 2 * 8192 bytes */
  50 #define ALIGNSIZE        8
  51
  52 struct dumpblock_t {
  53         dumpblock_t *prev;
  54         u1          *dumpmem;
  55         s4           size;
  56 };
  57
  58
  59 /* dump_allocation *************************************************************
  60
  61    This struct is used to record dump memory allocations for ENABLE_MEMCHECK.
  62
  63 *******************************************************************************/
  64
  65 #if defined(ENABLE_MEMCHECK)
  66 typedef struct dump_allocation_t dump_allocation_t;
  67
  68 struct dump_allocation_t {
  69         dump_allocation_t *next;
  70         u1                *mem;
  71         s4                 useddumpsize;
  72         s4                 size;
  73 };
  74 #endif
  75
  76
  77 /* dumpinfo *******************************************************************/
  78
  79 struct dumpinfo_t {
  80         dumpblock_t       *currentdumpblock;        /* the current top-most block */
  81         s4                 allocateddumpsize;     /* allocated bytes in this area */
  82         s4                 useddumpsize;          /* used bytes in this dump area */
  83 #if defined(ENABLE_MEMCHECK)
  84         dump_allocation_t *allocations;       /* list of allocations in this area */
  85 #endif
  86 };
  87
  88
  89 /* internal includes **********************************************************/
  90
  91 #include "mm/gc-common.h"
  92
  93
  94 /*
  95 ---------------------------- Interface description -----------------------
  96
  97 There are two possible choices for allocating memory:
  98
  99         1.   explicit allocating / deallocating
 100
 101                         mem_alloc ..... allocate a memory block
 102                         mem_free ...... free a memory block
 103                         mem_realloc ... change size of a memory block (position may change)
 104                         mem_usage ..... amount of allocated memory
 105
 106
 107         2.   explicit allocating, automatic deallocating
 108
 109                         dump_alloc .... allocate a memory block in the dump area
 110                         dump_realloc .. change size of a memory block (position may change)
 111                         dump_size ..... marks the current top of dump
 112                         dump_release .. free all memory requested after the mark
 113
 114
 115 There are some useful macros:
 116
 117         NEW (type) ....... allocate memory for an element of type `type`
 118         FREE (ptr,type) .. free memory
 119
 120         MNEW (type,num) .. allocate memory for an array
 121         MFREE (ptr,type,num) .. free memory
 122
 123         MREALLOC (ptr,type,num1,num2) .. enlarge the array to size num2
 124
 125 These macros do the same except they operate on the dump area:
 126
 127         DNEW,  DMNEW, DMREALLOC   (there is no DFREE)
 128
 129
 130 -------------------------------------------------------------------------------
 131
 132 Some more macros:
 133
 134         MEMORY_ALIGN (pos, size) ... make pos divisible by size. always returns an
 135                                  address >= pos.
 136
 137
 138         OFFSET (s,el) ....... returns the offset of 'el' in structure 's' in bytes.
 139
 140         MCOPY (dest,src,type,num) ... copy 'num' elements of type 'type'.
 141
 142
 143 */
 144
 145 #define MEMORY_ALIGN(pos,size) ((((pos) + (size) - 1) / (size)) * (size))
 146 #define PADDING(pos,size)     (MEMORY_ALIGN((pos),(size)) - (pos))
 147 #define OFFSET(s,el)          ((s4) ((ptrint) &(((s*) 0)->el)))
 148
 149
 150 #define NEW(type)             ((type *) mem_alloc(sizeof(type)))
 151 #define FREE(ptr,type)        mem_free((ptr), sizeof(type))
 152
 153 #define MNEW(type,num)        ((type *) mem_alloc(sizeof(type) * (num)))
 154 #define MFREE(ptr,type,num)   mem_free((ptr), sizeof(type) * (num))
 155
 156 #define MREALLOC(ptr,type,num1,num2) mem_realloc((ptr), sizeof(type) * (num1), \
 157                                                         sizeof(type) * (num2))
 158
 159
 160 #define DNEW(type)            ((type *) dump_alloc(sizeof(type)))
 161 #define DMNEW(type,num)       ((type *) dump_alloc(sizeof(type) * (num)))
 162 #define DMREALLOC(ptr,type,num1,num2) dump_realloc((ptr), sizeof(type) * (num1), \
 163                                                           sizeof(type) * (num2))
 164
 165 #define MCOPY(dest,src,type,num) memcpy((dest), (src), sizeof(type) * (num))
 166 #define MSET(ptr,byte,type,num) memset((ptr), (byte), sizeof(type) * (num))
 167 #define MZERO(ptr,type,num)     MSET(ptr,0,type,num)
 168 #define MMOVE(dest,src,type,num) memmove((dest), (src), sizeof(type) * (num))
 169
 170 #define CNEW(type,num)        ((type *) memory_cnew(sizeof(type) * (num)))
 171 #define CFREE(ptr,num)        memory_cfree((ptr),(num))
 172
 173
 174 /* GC macros ******************************************************************/
 175
 176 /* Uncollectable memory which can contain references */
 177
 178 #define GCNEW_UNCOLLECTABLE(type,num) ((type *) heap_alloc_uncollectable(sizeof(type) * (num)))
 179
 180 #define GCNEW(type)           heap_allocate(sizeof(type), true, NULL)
 181 #define GCMNEW(type,num)      heap_allocate(sizeof(type) * (num), true, NULL)
 182
 183 #define GCFREE(ptr)           heap_free((ptr))
 184
 185
 186 /* function prototypes ********************************************************/
 187
 188 /* initializes the memory subsystem */
 189 bool memory_init(void);
 190
 191 void *memory_mmap_anon(void *addr, size_t len, int prot, int flags);
 192
 193 void *memory_cnew(s4 size);
 194 void  memory_cfree(void *p, s4 size);
 195
 196 void *mem_alloc(s4 size);
 197 void  mem_free(void *m, s4 size);
 198 void *mem_realloc(void *src, s4 len1, s4 len2);
 199
 200 #if defined(ENABLE_THREADS)
 201 bool  memory_start_thread(void);
 202 #endif
 203
 204 void *dump_alloc(s4 size);
 205 void *dump_realloc(void *src, s4 len1, s4 len2);
 206 s4    dump_size(void);
 207 void  dump_release(s4 size);
 208
 209 #endif /* _MEMORY_H */
 210
 211
 212 /*
 213  * These are local overrides for various environment variables in Emacs.
 214  * Please do not remove this and leave it at the end of the file, where
 215  * Emacs will automagically detect them.
 216  * ---------------------------------------------------------------------
 217  * Local variables:
 218  * mode: c
 219  * indent-tabs-mode: t
 220  * c-basic-offset: 4
 221  * tab-width: 4
 222  * End:
 223  */