src/mm/memory.h

   1 /* mm/memory.h - macros for memory management
   2
   3    Copyright (C) 1996-2005 R. Grafl, A. Krall, C. Kruegel, C. Oates,
   4    R. Obermaisser, M. Platter, M. Probst, S. Ring, E. Steiner,
   5    C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich, J. Wenninger,
   6    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., 59 Temple Place - Suite 330, Boston, MA
  23    02111-1307, USA.
  24
  25    Contact: cacao@complang.tuwien.ac.at
  26
  27    Authors: Reinhard Grafl
  28
  29    $Id: memory.h 1815 2004-12-22 12:52:24Z twisti $
  30
  31 */
  32
  33
  34 #ifndef _MEMORY_H
  35 #define _MEMORY_H
  36
  37 #include <string.h>
  38
  39 #include "arch.h"
  40 #include "types.h"
  41 #include "mm/boehm.h"
  42
  43
  44 /*
  45 ---------------------------- Interface description -----------------------
  46
  47 There are two possible choices for allocating memory:
  48
  49         1.   explicit allocating / deallocating
  50
  51                         mem_alloc ..... allocate a memory block
  52                         mem_free ...... free a memory block
  53                         mem_realloc ... change size of a memory block (position may change)
  54                         mem_usage ..... amount of allocated memory
  55
  56
  57         2.   explicit allocating, automatic deallocating
  58
  59                         dump_alloc .... allocate a memory block in the dump area
  60                         dump_realloc .. change size of a memory block (position may change)
  61                         dump_size ..... marks the current top of dump
  62                         dump_release .. free all memory requested after the mark
  63
  64
  65 There are some useful macros:
  66
  67         NEW (type) ....... allocate memory for an element of type `type`
  68         FREE (ptr,type) .. free memory
  69
  70         MNEW (type,num) .. allocate memory for an array
  71         MFREE (ptr,type,num) .. free memory
  72
  73         MREALLOC (ptr,type,num1,num2) .. enlarge the array to size num2
  74
  75 These macros do the same except they operate on the dump area:
  76
  77         DNEW,  DMNEW, DMREALLOC   (there is no DFREE)
  78
  79
  80 -------------------------------------------------------------------------------
  81
  82 Some more macros:
  83
  84         ALIGN (pos, size) ... make pos divisible by size. always returns an
  85                                                   address >= pos.
  86
  87
  88         OFFSET (s,el) ....... returns the offset of 'el' in structure 's' in bytes.
  89
  90         MCOPY (dest,src,type,num) ... copy 'num' elements of type 'type'.
  91
  92
  93 */
  94
  95
  96 #define DUMPBLOCKSIZE    2 << 13    /* 2 * 8192 bytes */
  97 #define ALIGNSIZE        8
  98
  99
 100 /* dumpblock *******************************************************************
 101
 102    TODO
 103
 104 *******************************************************************************/
 105
 106 typedef struct dumpblock dumpblock;
 107
 108 struct dumpblock {
 109         dumpblock *prev;
 110         u1        *dumpmem;
 111         s4         size;
 112 };
 113
 114
 115 /* dumpinfo ********************************************************************
 116
 117    DOCUMENT ME!
 118
 119 *******************************************************************************/
 120
 121 typedef struct dumpinfo dumpinfo;
 122
 123 struct dumpinfo {
 124         dumpblock *currentdumpblock;
 125         s4         allocateddumpsize;
 126         s4         useddumpsize;
 127 };
 128
 129
 130 /* Uncollectable memory which can contain references */
 131
 132 #define GCNEW(type,num)       ((type *) heap_alloc_uncollectable(sizeof(type) * (num)))
 133 #define GCFREE(ptr)           heap_free((ptr))
 134
 135 #define ALIGN(pos,size)       ((((pos) + (size) - 1) / (size)) * (size))
 136 #define PADDING(pos,size)     (ALIGN((pos),(size)) - (pos))
 137 #define OFFSET(s,el)          ((int) ((size_t) & (((s*) 0)->el)))
 138
 139
 140 #define NEW(type)             ((type *) mem_alloc(sizeof(type)))
 141 #define FREE(ptr,type)        mem_free((ptr), sizeof(type))
 142
 143 #define MNEW(type,num)        ((type *) mem_alloc(sizeof(type) * (num)))
 144 #define MFREE(ptr,type,num)   mem_free((ptr), sizeof(type) * (num))
 145 #define MREALLOC(ptr,type,num1,num2) mem_realloc((ptr), sizeof(type) * (num1), \
 146                                                         sizeof(type) * (num2))
 147
 148 #define DNEW(type)            ((type *) dump_alloc(sizeof(type)))
 149 #define DMNEW(type,num)       ((type *) dump_alloc(sizeof(type) * (num)))
 150 #define DMREALLOC(ptr,type,num1,num2) dump_realloc((ptr), sizeof(type) * (num1), \
 151                                                           sizeof(type) * (num2))
 152
 153 #define MCOPY(dest,src,type,num) memcpy((dest), (src), sizeof(type) * (num))
 154 #define MSET(ptr,byte,type,num) memset((ptr), (byte), sizeof(type) * (num))
 155
 156 #if defined(USE_CODEMMAP)
 157 #define CNEW(type,num)        ((type *) mem_mmap(sizeof(type) * (num)))
 158 #define CFREE(ptr,num)        /* nothing */
 159 #else
 160 #define CNEW(type,num)        ((type *) mem_alloc(sizeof(type) * (num)))
 161 #define CFREE(ptr,num)        mem_free((ptr), (num))
 162 #endif
 163
 164
 165 /* function prototypes ********************************************************/
 166
 167 void *mem_mmap(s4 size);
 168 void *mem_alloc(s4 size);
 169 void  mem_free(void *m, s4 size);
 170 void *mem_realloc(void *src, s4 len1, s4 len2);
 171
 172 void *dump_alloc(s4 size);
 173 void *dump_realloc(void *src, s4 len1, s4 len2);
 174 s4    dump_size(void);
 175 void  dump_release(s4 size);
 176
 177 #endif /* _MEMORY_H */
 178
 179
 180 /*
 181  * These are local overrides for various environment variables in Emacs.
 182  * Please do not remove this and leave it at the end of the file, where
 183  * Emacs will automagically detect them.
 184  * ---------------------------------------------------------------------
 185  * Local variables:
 186  * mode: c
 187  * indent-tabs-mode: t
 188  * c-basic-offset: 4
 189  * tab-width: 4
 190  * End:
 191  */