projects/ldc: druntime/src/common/core/memory.d annotate

annotate druntime/src/common/core/memory.d @ 759:d3eb054172f9

Added copy of druntime from DMD 2.020 modified for LDC.

author	Tomas Lindquist Olsen <tomas.l.olsen@gmail.com>
date	Tue, 11 Nov 2008 01:52:37 +0100
parents
children

rev	line source
759 d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	1 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	2 * The memory module provides an interface to the garbage collector and to
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	3 * any other OS or API-level memory management facilities.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	4 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	5 * Copyright: Copyright (c) 2005-2008, The D Runtime Project
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	6 * License: BSD Style, see LICENSE
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	7 * Authors: Sean Kelly
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	8 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	9 module core.memory;
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	10
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	11
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	12 private
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	13 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	14 extern (C) void gc_init();
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	15 extern (C) void gc_term();
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	16
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	17 extern (C) void gc_enable();
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	18 extern (C) void gc_disable();
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	19 extern (C) void gc_collect();
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	20 extern (C) void gc_minimize();
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	21
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	22 extern (C) uint gc_getAttr( void* p );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	23 extern (C) uint gc_setAttr( void* p, uint a );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	24 extern (C) uint gc_clrAttr( void* p, uint a );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	25
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	26 extern (C) void* gc_malloc( size_t sz, uint ba = 0 );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	27 extern (C) void* gc_calloc( size_t sz, uint ba = 0 );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	28 extern (C) void* gc_realloc( void* p, size_t sz, uint ba = 0 );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	29 extern (C) size_t gc_extend( void* p, size_t mx, size_t sz );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	30 extern (C) size_t gc_reserve( size_t sz );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	31 extern (C) void gc_free( void* p );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	32
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	33 extern (C) void* gc_addrOf( void* p );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	34 extern (C) size_t gc_sizeOf( void* p );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	35
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	36 struct BlkInfo_
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	37 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	38 void* base;
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	39 size_t size;
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	40 uint attr;
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	41 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	42
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	43 extern (C) BlkInfo_ gc_query( void* p );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	44
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	45 extern (C) void gc_addRoot( void* p );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	46 extern (C) void gc_addRange( void* p, size_t sz );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	47
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	48 extern (C) void gc_removeRoot( void* p );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	49 extern (C) void gc_removeRange( void* p );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	50
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	51 extern (C) void* gc_getHandle();
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	52 extern (C) void gc_setHandle( void* p );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	53 extern (C) void gc_endHandle();
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	54 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	55
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	56
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	57 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	58 * This struct encapsulates all garbage collection functionality for the D
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	59 * programming language.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	60 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	61 struct GC
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	62 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	63 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	64 * Enables the garbage collector if collections have previously been
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	65 * suspended by a call to disable. This function is reentrant, and
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	66 * must be called once for every call to disable before the garbage
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	67 * collector is enabled.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	68 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	69 static void enable()
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	70 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	71 gc_enable();
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	72 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	73
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	74
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	75 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	76 * Disables the garbage collector. This function is reentrant, but
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	77 * enable must be called once for each call to disable.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	78 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	79 static void disable()
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	80 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	81 gc_disable();
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	82 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	83
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	84
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	85 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	86 * Begins a full collection. While the meaning of this may change based
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	87 * on the garbage collector implementation, typical behavior is to scan
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	88 * all stack segments for roots, mark accessible memory blocks as alive,
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	89 * and then to reclaim free space. This action may need to suspend all
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	90 * running threads for at least part of the collection process.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	91 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	92 static void collect()
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	93 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	94 gc_collect();
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	95 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	96
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	97 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	98 * Indicates that the managed memory space be minimized by returning free
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	99 * physical memory to the operating system. The amount of free memory
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	100 * returned depends on the allocator design and on program behavior.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	101 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	102 static void minimize()
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	103 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	104 gc_minimize();
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	105 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	106
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	107
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	108 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	109 * Elements for a bit field representing memory block attributes. These
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	110 * are manipulated via the getAttr, setAttr, clrAttr functions.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	111 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	112 enum BlkAttr : uint
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	113 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	114 FINALIZE = 0b0000_0001, /// Finalize the data in this block on collect.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	115 NO_SCAN = 0b0000_0010, /// Do not scan through this block on collect.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	116 NO_MOVE = 0b0000_0100 /// Do not move this memory block on collect.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	117 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	118
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	119
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	120 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	121 * Contains aggregate information about a block of managed memory. The
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	122 * purpose of this struct is to support a more efficient query style in
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	123 * instances where detailed information is needed.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	124 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	125 * base = A pointer to the base of the block in question.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	126 * size = The size of the block, calculated from base.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	127 * attr = Attribute bits set on the memory block.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	128 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	129 alias BlkInfo_ BlkInfo;
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	130
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	131
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	132 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	133 * Returns a bit field representing all block attributes set for the memory
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	134 * referenced by p. If p references memory not originally allocated by
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	135 * this garbage collector, points to the interior of a memory block, or if
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	136 * p is null, zero will be returned.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	137 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	138 * Params:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	139 * p = A pointer to the root of a valid memory block or to null.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	140 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	141 * Returns:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	142 * A bit field containing any bits set for the memory block referenced by
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	143 * p or zero on error.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	144 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	145 static uint getAttr( void* p )
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	146 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	147 return gc_getAttr( p );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	148 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	149
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	150
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	151 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	152 * Sets the specified bits for the memory references by p. If p references
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	153 * memory not originally allocated by this garbage collector, points to the
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	154 * interior of a memory block, or if p is null, no action will be
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	155 * performed.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	156 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	157 * Params:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	158 * p = A pointer to the root of a valid memory block or to null.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	159 * a = A bit field containing any bits to set for this memory block.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	160 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	161 * The result of a call to getAttr after the specified bits have been
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	162 * set.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	163 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	164 static uint setAttr( void* p, uint a )
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	165 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	166 return gc_setAttr( p, a );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	167 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	168
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	169
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	170 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	171 * Clears the specified bits for the memory references by p. If p
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	172 * references memory not originally allocated by this garbage collector,
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	173 * points to the interior of a memory block, or if p is null, no action
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	174 * will be performed.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	175 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	176 * Params:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	177 * p = A pointer to the root of a valid memory block or to null.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	178 * a = A bit field containing any bits to clear for this memory block.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	179 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	180 * Returns:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	181 * The result of a call to getAttr after the specified bits have been
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	182 * cleared.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	183 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	184 static uint clrAttr( void* p, uint a )
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	185 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	186 return gc_clrAttr( p, a );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	187 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	188
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	189
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	190 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	191 * Requests an aligned block of managed memory from the garbage collector.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	192 * This memory may be deleted at will with a call to free, or it may be
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	193 * discarded and cleaned up automatically during a collection run. If
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	194 * allocation fails, this function will call onOutOfMemory which is
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	195 * expected to throw an OutOfMemoryException.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	196 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	197 * Params:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	198 * sz = The desired allocation size in bytes.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	199 * ba = A bitmask of the attributes to set on this block.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	200 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	201 * Returns:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	202 * A reference to the allocated memory or null if insufficient memory
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	203 * is available.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	204 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	205 * Throws:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	206 * OutOfMemoryException on allocation failure.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	207 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	208 static void* malloc( size_t sz, uint ba = 0 )
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	209 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	210 return gc_malloc( sz, ba );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	211 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	212
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	213
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	214 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	215 * Requests an aligned block of managed memory from the garbage collector,
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	216 * which is initialized with all bits set to zero. This memory may be
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	217 * deleted at will with a call to free, or it may be discarded and cleaned
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	218 * up automatically during a collection run. If allocation fails, this
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	219 * function will call onOutOfMemory which is expected to throw an
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	220 * OutOfMemoryException.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	221 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	222 * Params:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	223 * sz = The desired allocation size in bytes.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	224 * ba = A bitmask of the attributes to set on this block.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	225 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	226 * Returns:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	227 * A reference to the allocated memory or null if insufficient memory
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	228 * is available.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	229 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	230 * Throws:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	231 * OutOfMemoryException on allocation failure.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	232 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	233 static void* calloc( size_t sz, uint ba = 0 )
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	234 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	235 return gc_calloc( sz, ba );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	236 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	237
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	238
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	239 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	240 * If sz is zero, the memory referenced by p will be deallocated as if
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	241 * by a call to free. A new memory block of size sz will then be
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	242 * allocated as if by a call to malloc, or the implementation may instead
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	243 * resize the memory block in place. The contents of the new memory block
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	244 * will be the same as the contents of the old memory block, up to the
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	245 * lesser of the new and old sizes. Note that existing memory will only
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	246 * be freed by realloc if sz is equal to zero. The garbage collector is
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	247 * otherwise expected to later reclaim the memory block if it is unused.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	248 * If allocation fails, this function will call onOutOfMemory which is
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	249 * expected to throw an OutOfMemoryException. If p references memory not
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	250 * originally allocated by this garbage collector, or if it points to the
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	251 * interior of a memory block, no action will be taken. If ba is zero
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	252 * (the default) and p references the head of a valid, known memory block
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	253 * then any bits set on the current block will be set on the new block if a
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	254 * reallocation is required. If ba is not zero and p references the head
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	255 * of a valid, known memory block then the bits in ba will replace those on
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	256 * the current memory block and will also be set on the new block if a
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	257 * reallocation is required.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	258 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	259 * Params:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	260 * p = A pointer to the root of a valid memory block or to null.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	261 * sz = The desired allocation size in bytes.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	262 * ba = A bitmask of the attributes to set on this block.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	263 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	264 * Returns:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	265 * A reference to the allocated memory on success or null if sz is
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	266 * zero. On failure, the original value of p is returned.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	267 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	268 * Throws:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	269 * OutOfMemoryException on allocation failure.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	270 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	271 static void* realloc( void* p, size_t sz, uint ba = 0 )
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	272 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	273 return gc_realloc( p, sz, ba );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	274 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	275
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	276
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	277 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	278 * Requests that the managed memory block referenced by p be extended in
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	279 * place by at least mx bytes, with a desired extension of sz bytes. If an
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	280 * extension of the required size is not possible, if p references memory
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	281 * not originally allocated by this garbage collector, or if p points to
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	282 * the interior of a memory block, no action will be taken.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	283 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	284 * Params:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	285 * mx = The minimum extension size in bytes.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	286 * sz = The desired extension size in bytes.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	287 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	288 * Returns:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	289 * The size in bytes of the extended memory block referenced by p or zero
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	290 * if no extension occurred.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	291 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	292 static size_t extend( void* p, size_t mx, size_t sz )
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	293 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	294 return gc_extend( p, mx, sz );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	295 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	296
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	297
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	298 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	299 * Requests that at least sz bytes of memory be obtained from the operating
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	300 * system and marked as free.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	301 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	302 * Params:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	303 * sz = The desired size in bytes.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	304 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	305 * Returns:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	306 * The actual number of bytes reserved or zero on error.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	307 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	308 static size_t reserve( size_t sz )
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	309 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	310 return gc_reserve( sz );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	311 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	312
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	313
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	314 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	315 * Deallocates the memory referenced by p. If p is null, no action
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	316 * occurs. If p references memory not originally allocated by this
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	317 * garbage collector, or if it points to the interior of a memory block,
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	318 * no action will be taken. The block will not be finalized regardless
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	319 * of whether the FINALIZE attribute is set. If finalization is desired,
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	320 * use delete instead.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	321 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	322 * Params:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	323 * p = A pointer to the root of a valid memory block or to null.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	324 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	325 static void free( void* p )
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	326 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	327 gc_free( p );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	328 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	329
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	330
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	331 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	332 * Returns the base address of the memory block containing p. This value
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	333 * is useful to determine whether p is an interior pointer, and the result
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	334 * may be passed to routines such as sizeOf which may otherwise fail. If p
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	335 * references memory not originally allocated by this garbage collector, if
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	336 * p is null, or if the garbage collector does not support this operation,
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	337 * null will be returned.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	338 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	339 * Params:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	340 * p = A pointer to the root or the interior of a valid memory block or to
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	341 * null.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	342 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	343 * Returns:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	344 * The base address of the memory block referenced by p or null on error.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	345 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	346 static void* addrOf( void* p )
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	347 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	348 return gc_addrOf( p );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	349 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	350
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	351
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	352 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	353 * Returns the true size of the memory block referenced by p. This value
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	354 * represents the maximum number of bytes for which a call to realloc may
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	355 * resize the existing block in place. If p references memory not
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	356 * originally allocated by this garbage collector, points to the interior
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	357 * of a memory block, or if p is null, zero will be returned.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	358 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	359 * Params:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	360 * p = A pointer to the root of a valid memory block or to null.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	361 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	362 * Returns:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	363 * The size in bytes of the memory block referenced by p or zero on error.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	364 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	365 static size_t sizeOf( void* p )
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	366 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	367 return gc_sizeOf( p );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	368 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	369
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	370
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	371 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	372 * Returns aggregate information about the memory block containing p. If p
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	373 * references memory not originally allocated by this garbage collector, if
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	374 * p is null, or if the garbage collector does not support this operation,
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	375 * BlkInfo.init will be returned. Typically, support for this operation
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	376 * is dependent on support for addrOf.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	377 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	378 * Params:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	379 * p = A pointer to the root or the interior of a valid memory block or to
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	380 * null.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	381 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	382 * Returns:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	383 * Information regarding the memory block referenced by p or BlkInfo.init
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	384 * on error.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	385 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	386 static BlkInfo query( void* p )
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	387 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	388 return gc_query( p );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	389 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	390
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	391
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	392 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	393 * Adds the memory address referenced by p to an internal list of roots to
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	394 * be scanned during a collection. If p is null, no operation is
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	395 * performed.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	396 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	397 * Params:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	398 * p = A pointer to a valid memory address or to null.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	399 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	400 static void addRoot( void* p )
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	401 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	402 gc_addRoot( p );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	403 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	404
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	405
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	406 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	407 * Adds the memory block referenced by p and of size sz to an internal list
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	408 * of ranges to be scanned during a collection. If p is null, no operation
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	409 * is performed.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	410 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	411 * Params:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	412 * p = A pointer to a valid memory address or to null.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	413 * sz = The size in bytes of the block to add. If sz is zero then the
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	414 * no operation will occur. If p is null then sz must be zero.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	415 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	416 static void addRange( void* p, size_t sz )
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	417 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	418 gc_addRange( p, sz );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	419 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	420
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	421
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	422 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	423 * Removes the memory block referenced by p from an internal list of roots
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	424 * to be scanned during a collection. If p is null or does not represent
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	425 * a value previously passed to add(void*) then no operation is performed.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	426 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	427 * p = A pointer to a valid memory address or to null.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	428 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	429 static void removeRoot( void* p )
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	430 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	431 gc_removeRoot( p );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	432 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	433
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	434
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	435 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	436 * Removes the memory block referenced by p from an internal list of ranges
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	437 * to be scanned during a collection. If p is null or does not represent
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	438 * a value previously passed to add(void*, size_t) then no operation is
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	439 * performed.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	440 *
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	441 * Params:
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	442 * p = A pointer to a valid memory address or to null.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	443 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	444 static void removeRange( void* p )
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	445 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	446 gc_removeRange( p );
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	447 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	448
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	449 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	450 * Get handle to the collector.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	451 * The only thing that can be done with this handle is pass it to
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	452 * setHandle(). getHandle/setHandle/endHandle work together so that
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	453 * if there are multiple instances of the gc running, only one instance
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	454 * can be set to run.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	455 * The most common case of this is under Windows where a D application
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	456 * calls functions in a DLL that is implemented in D.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	457 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	458
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	459 static void* getHandle()
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	460 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	461 return gc_getHandle();
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	462 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	463
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	464 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	465 * Set handle to the collector.
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	466 * The handle p is an opaque handle, acquired by a call to
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	467 * getHandle().
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	468 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	469
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	470 static void setHandle(void* p)
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	471 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	472 gc_setHandle(p);
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	473 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	474
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	475 /**
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	476 * Call when done using the collector specified by the
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	477 * call to setHandle().
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	478 */
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	479
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	480 static void endHandle()
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	481 {
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	482 gc_endHandle();
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	483 }
d3eb054172f9 Added copy of druntime from DMD 2.020 modified for LDC. Tomas Lindquist Olsen <tomas.l.olsen@gmail.com> parents: diff changeset	484 }

Mercurial > projects > ldc

annotate druntime/src/common/core/memory.d @ 759:d3eb054172f9