This commit introduces C++ support.
[cacao.git] / src / mm / memory.h
index 7029f4b48f0b9db58b45e1d695f33afd79b3dbeb..8a88321d38480fceaa3ebb1d34759a2b84952dd9 100644 (file)
@@ -1,73 +1,59 @@
-/************************* toolbox/memory.h ************************************
+/* src/mm/memory.h - macros for memory management
 
-       Copyright (c) 1997 A. Krall, R. Grafl, M. Gschwind, M. Probst
+   Copyright (C) 1996-2005, 2006, 2007, 2008
+   CACAOVM - Verein zur Foerderung der freien virtuellen Maschine CACAO
 
-       See file COPYRIGHT for information on usage and disclaimer of warranties
+   This file is part of CACAO.
 
-       Macros for memory management
+   This program is free software; you can redistribute it and/or
+   modify it under the terms of the GNU General Public License as
+   published by the Free Software Foundation; either version 2, or (at
+   your option) any later version.
 
-       Authors: Reinhard Grafl      EMAIL: cacao@complang.tuwien.ac.at
+   This program is distributed in the hope that it will be useful, but
+   WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   General Public License for more details.
 
-       Last Change: 1996/10/03
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+   02110-1301, USA.
 
-*******************************************************************************/
+*/
 
-#include "types.h"
 
-#ifdef USE_BOEHM
-/* Uncollectable memory which can contain references */
-void *heap_alloc_uncollectable(u4 bytelen);
-#define GCNEW(type,num) heap_alloc_uncollectable(sizeof(type) * (num))
+#ifndef _MEMORY_H
+#define _MEMORY_H
+
+#include "config.h"
+
+#ifdef __cplusplus
+extern "C" {
 #endif
 
-#define ALIGN(pos,size)       ( ( ((pos)+(size)-1) / (size))*(size) )
-#define PADDING(pos,size)     ( ALIGN((pos),(size)) - (pos) )
-#define OFFSET(s,el)          ( (int) ( (size_t) &( ((s*)0) -> el ) ) )
+#include <string.h>
 
+#include "vm/types.h"
 
-#define NEW(type)             ((type*) mem_alloc ( sizeof(type) ))
-#define FREE(ptr,type)        mem_free (ptr, sizeof(type) )
+#include "mm/codememory.h"
+#include "mm/dumpmemory.h"
 
-#define LNEW(type)             ((type*) lit_mem_alloc ( sizeof(type) ))
-#define LFREE(ptr,type)        lit_mem_free (ptr, sizeof(type) )
 
-#define MNEW(type,num)        ((type*) mem_alloc ( sizeof(type) * (num) ))
-#define MFREE(ptr,type,num)   mem_free (ptr, sizeof(type) * (num) )
-#define MREALLOC(ptr,type,num1,num2) mem_realloc (ptr, sizeof(type) * (num1), \
-                                                       sizeof(type) * (num2) )
+/* constants for ENABLE_MEMCHECK **********************************************/
 
-#define DNEW(type)            ((type*) mem_alloc ( sizeof(type) ))
-#define DMNEW(type,num)       ((type*) mem_alloc ( sizeof(type) * (num) ))
-#define DMREALLOC(ptr,type,num1,num2)  mem_realloc (ptr, sizeof(type)*(num1),\
-                                                       sizeof(type) * (num2) )
+#if defined(ENABLE_MEMCHECK)
+#define MEMORY_CANARY_SIZE          16
+#define MEMORY_CANARY_FIRST_BYTE    0xca
+#define MEMORY_CLEAR_BYTE           0xa5
+#endif /* defined(ENABLE_MEMCHECK) */
 
-#define MCOPY(dest,src,type,num)  memcpy (dest,src, sizeof(type)* (num) )
 
-#ifdef USE_CODEMMAP
-#define CNEW(type,num)        ((type*) mem_mmap ( sizeof(type) * (num) ))
-#define CFREE(ptr,num)
-#else
-#define CNEW(type,num)        ((type*) mem_alloc ( sizeof(type) * (num) ))
-#define CFREE(ptr,num)        mem_free (ptr, num)
-#endif
+/* internal includes **********************************************************/
+
+#include "mm/gc-common.h"
+
 
-void *mem_alloc(int length);
-void *mem_mmap(int length);
-void *lit_mem_alloc(int length);
-void mem_free(void *m, int length);
-void lit_mem_free(void *m, int length);
-void *mem_realloc(void *m, int len1, int len2);
-long int mem_usage();
-
-void *dump_alloc(int length);
-void *dump_realloc(void *m, int len1, int len2);
-long int dump_size();
-void dump_release(long int size);
-
-void mem_usagelog(int givewarnings);
 /* 
 ---------------------------- Interface description -----------------------
 
@@ -80,15 +66,6 @@ There are two possible choices for allocating memory:
                        mem_realloc ... change size of a memory block (position may change)
                        mem_usage ..... amount of allocated memory
 
-
-       2.   explicit allocating, automatic deallocating
-       
-                       dump_alloc .... allocate a memory block in the dump area
-                       dump_realloc .. change size of a memory block (position may change)
-                       dump_size ..... marks the current top of dump
-                       dump_release .. free all memory requested after the mark
-                                       
-       
 There are some useful macros:
 
        NEW (type) ....... allocate memory for an element of type `type`
@@ -99,17 +76,12 @@ There are some useful macros:
        
        MREALLOC (ptr,type,num1,num2) .. enlarge the array to size num2
                                         
-These macros do the same except they operate on the dump area:
-       
-       DNEW,  DMNEW, DMREALLOC   (there is no DFREE)
-
-
 -------------------------------------------------------------------------------
 
 Some more macros:
 
-       ALIGN (pos, size) ... make pos divisible by size. always returns an
-                                                 address >= pos.
+       MEMORY_ALIGN (pos, size) ... make pos divisible by size. always returns an
+                                 address >= pos.
                              
        
        OFFSET (s,el) ....... returns the offset of 'el' in structure 's' in bytes.
@@ -118,3 +90,80 @@ Some more macros:
        
 
 */
+
+#define MEMORY_ALIGN(pos,size) ((((pos) + (size) - 1) / (size)) * (size))
+#define PADDING(pos,size)     (MEMORY_ALIGN((pos),(size)) - (pos))
+#define OFFSET(s,el)          ((int32_t) ((ptrint) &(((s*) 0)->el)))
+
+
+#define NEW(type)             ((type *) mem_alloc(sizeof(type)))
+#define FREE(ptr,type)        mem_free((ptr), sizeof(type))
+
+#define MNEW(type,num)        ((type *) mem_alloc(sizeof(type) * (num)))
+#define MFREE(ptr,type,num)   mem_free((ptr), sizeof(type) * (num))
+
+#define MREALLOC(ptr,type,num1,num2) mem_realloc((ptr), sizeof(type) * (num1), \
+                                                        sizeof(type) * (num2))
+
+
+#define MCOPY(dest,src,type,num) memcpy((dest), (src), sizeof(type) * (num))
+#define MSET(ptr,byte,type,num) memset((ptr), (byte), sizeof(type) * (num))
+#define MZERO(ptr,type,num)     MSET(ptr,0,type,num)
+#define MMOVE(dest,src,type,num) memmove((dest), (src), sizeof(type) * (num))
+
+
+/* GC macros (boehm only) *****************************************************/
+
+#if defined(ENABLE_GC_BOEHM)
+
+/* Uncollectable memory which can contain references */
+
+#define GCNEW_UNCOLLECTABLE(type,num) ((type *) heap_alloc_uncollectable(sizeof(type) * (num)))
+
+#define GCNEW(type)           heap_alloc(sizeof(type), true, NULL, true)
+#define GCMNEW(type,num)      heap_alloc(sizeof(type) * (num), true, NULL, true)
+
+#define GCFREE(ptr)           heap_free((ptr))
+
+#endif
+
+
+/* function prototypes ********************************************************/
+
+bool  memory_init(void);
+
+void  memory_mprotect(void *addr, size_t len, int prot);
+
+void *memory_checked_alloc(size_t size);
+
+void *memory_cnew(int32_t size);
+void  memory_cfree(void *p, int32_t size);
+
+void *mem_alloc(int32_t size);
+void  mem_free(void *m, int32_t size);
+void *mem_realloc(void *src, int32_t len1, int32_t len2);
+
+#if defined(ENABLE_THREADS)
+bool  memory_start_thread(void);
+#endif
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _MEMORY_H */
+
+
+/*
+ * These are local overrides for various environment variables in Emacs.
+ * Please do not remove this and leave it at the end of the file, where
+ * Emacs will automagically detect them.
+ * ---------------------------------------------------------------------
+ * Local variables:
+ * mode: c
+ * indent-tabs-mode: t
+ * c-basic-offset: 4
+ * tab-width: 4
+ * End:
+ * vim:noexpandtab:sw=4:ts=4:
+ */