This commit introduces C++ support.
[cacao.git] / src / mm / memory.h
index d512c54fe7544473887c7e55d5fbf244041ef66e..8a88321d38480fceaa3ebb1d34759a2b84952dd9 100644 (file)
@@ -1,9 +1,7 @@
-/* toolbox/memory.h - macros for memory management
+/* src/mm/memory.h - macros for memory management
 
-   Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
-   R. Grafl, A. Krall, C. Kruegel, C. Oates, R. Obermaisser,
-   M. Probst, S. Ring, E. Steiner, C. Thalinger, D. Thuernbeck,
-   P. Tomsich, J. Wenninger
+   Copyright (C) 1996-2005, 2006, 2007, 2008
+   CACAOVM - Verein zur Foerderung der freien virtuellen Maschine CACAO
 
    This file is part of CACAO.
 
 
    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., 59 Temple Place - Suite 330, Boston, MA
-   02111-1307, USA.
-
-   Contact: cacao@complang.tuwien.ac.at
-
-   Authors: Reinhard Grafl
-
-   $Id: memory.h 575 2003-11-09 17:26:53Z twisti $
+   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+   02110-1301, USA.
 
 */
 
 #ifndef _MEMORY_H
 #define _MEMORY_H
 
-#include "types.h"
+#include "config.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <string.h>
+
+#include "vm/types.h"
+
+#include "mm/codememory.h"
+#include "mm/dumpmemory.h"
+
+
+/* constants for ENABLE_MEMCHECK **********************************************/
+
+#if defined(ENABLE_MEMCHECK)
+#define MEMORY_CANARY_SIZE          16
+#define MEMORY_CANARY_FIRST_BYTE    0xca
+#define MEMORY_CLEAR_BYTE           0xa5
+#endif /* defined(ENABLE_MEMCHECK) */
+
+
+/* internal includes **********************************************************/
+
+#include "mm/gc-common.h"
+
 
 /* 
 ---------------------------- Interface description -----------------------
@@ -48,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`
@@ -67,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.
@@ -87,57 +91,66 @@ Some more macros:
 
 */
 
-/* Uncollectable memory which can contain references */
-void *heap_alloc_uncollectable(u4 bytelen);
-#define GCNEW(type,num)       heap_alloc_uncollectable(sizeof(type) * (num))
+#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))
 
-#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)))
 
+/* GC macros (boehm only) *****************************************************/
 
-#define NEW(type)             ((type*) mem_alloc(sizeof(type)))
-#define FREE(ptr,type)        mem_free(ptr, sizeof(type))
+#if defined(ENABLE_GC_BOEHM)
 
-#define LNEW(type)            ((type*) lit_mem_alloc(sizeof(type)))
-#define LFREE(ptr,type)       lit_mem_free(ptr, sizeof(type))
+/* Uncollectable memory which can contain references */
 
-#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 GCNEW_UNCOLLECTABLE(type,num) ((type *) heap_alloc_uncollectable(sizeof(type) * (num)))
 
-#define DNEW(type)            ((type*) dump_alloc(sizeof(type)))
-#define DMNEW(type,num)       ((type*) dump_alloc(sizeof(type) * (num)))
-#define DMREALLOC(ptr,type,num1,num2)  dump_realloc(ptr, sizeof(type) * (num1),\
-                                                         sizeof(type) * (num2))
+#define GCNEW(type)           heap_alloc(sizeof(type), true, NULL, true)
+#define GCMNEW(type,num)      heap_alloc(sizeof(type) * (num), true, NULL, true)
 
-#define MCOPY(dest,src,type,num)  memcpy(dest,src, sizeof(type)* (num))
+#define GCFREE(ptr)           heap_free((ptr))
 
-#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
 
 
-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();
+/* 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 *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_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
 
-void mem_usagelog(int givewarnings);
 #endif /* _MEMORY_H */
 
 
@@ -152,4 +165,5 @@ void mem_usagelog(int givewarnings);
  * c-basic-offset: 4
  * tab-width: 4
  * End:
+ * vim:noexpandtab:sw=4:ts=4:
  */