Library Reference

version 2.112.0

Internal API

If you spot a problem with this page, click here to create a Bugzilla issue.

Quickly fork, edit online, and submit a pull request for this page.Requires a signed-in GitHub account. This works well for small changes.If you'd like to make larger changes you may want to consider usinga local clone.

core.memory

This module provides an interface to the garbage collector used by applications written in the D programming language. It allows the garbage collector in the runtime to be swapped without affecting binary compatibility of applications.

Using this module is not necessary in typical D code. It is mostly useful when doing low-level memory management.

Notes to users

The GC is a conservative mark-and-sweep collector. It only runs a collection cycle when an allocation is requested of it, never otherwise. Hence, if the program is not doing allocations, there will be no GC collection pauses. The pauses occur because all threads the GC knows about are halted so the threads' stacks and registers can be scanned for references to GC allocated data.

The GC does not know about threads that were created by directly calling the OS/C runtime thread creation APIs and D threads that were detached from the D runtime after creation. Such threads will not be paused for a GC collection, and the GC might not detect references to GC allocated data held by them. This can cause memory corruption. There are several ways to resolve this issue:
1. Do not hold references to GC allocated data in such threads.
2. Register/unregister such data with calls toaddRoot/removeRoot andaddRange/removeRange.
3. Maintain another reference to that same data in another thread that the GC does know about.
4. Disable GC collection cycles while that thread is active withdisable/enable.
5. Register the thread with the GC usingcore.thread.osthread.thread_attachThis/core.thread.threadbase.thread_detachThis.

Notes to implementors

On POSIX systems, the signalsSIGRTMIN andSIGRTMIN + 1 are reserved by this module for use in the garbage collector implementation. Typically, they will be used to stop and resume other threads when performing a collection, but an implementation may choose not to use this mechanism (or not stop the world at all, in the case of concurrent garbage collectors).

Registers, the stack, and any other memory locations added through theGC.addRange function are always scanned conservatively. This means that even if a variable is e.g. of typefloat, it will still be scanned for possible GC pointers. And, if the word-interpreted representation of the variable matches a GC-managed memory block's address, that memory block is considered live.

Implementations are free to scan the non-root heap in a precise manner, so that fields of types likefloat will not be considered relevant when scanning the heap. Thus, casting a GC pointer to an integral type (e.g.size_t) and storing it in a field of that type inside the GC heap may mean that it will not be recognized if the memory block was allocated with precise type info or with theGC.BlkAttr.NO_SCAN attribute.

Destructors will always be executed while other threads are active; that is, an implementation that stops the world must not execute destructors until the world has been resumed.

A destructor of an object must not access object references within the object. This means that an implementation is free to optimize based on this rule.

An implementation is free to perform heap compaction and copying so long as no valid GC pointers are invalidated in the process. However, memory allocated withGC.BlkAttr.NO_MOVE must not be moved/copied.

Implementations must support interior pointers. That is, if the only reference to a GC-managed memory block points into the middle of the block rather than the beginning (for example), the GC must consider the memory block live. The exception to this rule is when a memory block is allocated with theGC.BlkAttr.NO_INTERIOR attribute; it is the user's responsibility to make sure such memory blocks have a proper pointer to them when they should be considered live.

It is acceptable for an implementation to store bit flags into pointer values and GC-managed memory blocks, so long as such a trick is not visible to the application. In practice, this means that only a stop-the-world collector can do this.

Implementations are free to assume that GC pointers are only stored on word boundaries. Unaligned pointers may be ignored entirely.

Implementations are free to run collections at any point. It is, however, recommendable to only do so when an allocation attempt happens and there is insufficient memory available.

License:

Boost License 1.0

Authors:

Sean Kelly, Alex Rønne Petersen

Sourcecore/memory.d

immutable size_tpageSize;

The size of a system page in bytes.

This value is set at startup time of the application. It's safe to use early in the start process, like in shared module constructors and initialization of the D runtime itself.

Examples:

ubyte[] buffer =newubyte[pageSize];

structGC;

This struct encapsulates all garbage collection functionality for the D programming language.

structStats;

Aggregation of GC stats to be exposed via public API

size_tusedSize;: number of used bytes on the GC heap (might only get updated after a collection)
size_tfreeSize;: number of free bytes on the GC heap (might only get updated after a collection)
ulongallocatedInCurrentThread;: number of bytes allocated for current thread since program start

structProfileStats;

Aggregation of current profile information

size_tnumCollections;: total number of GC cycles
DurationtotalCollectionTime;: total time spent doing GC
DurationtotalPauseTime;: total time threads were paused doing GC
DurationmaxPauseTime;: largest time threads were paused during one GC cycle
DurationmaxCollectionTime;: largest time spent doing one GC cycle

static pure nothrow @safe voidenable();

Enables automatic garbage collection behavior if collections have previously been suspended by a call toGC.disable(). This function is reentrant, and must be called once for every call toGC.disable() before automatic collections are enabled.

static pure nothrow @safe voiddisable();

Disables automatic garbage collections performed to minimize the process footprint. Collections may continue to occur in instances where the implementation deems necessary for correct program behavior, such as during an out of memory condition. This function is reentrant, butGC.enable() must be called once for each call toGC.disable(). Unlike the@nogc attribute,GC.disable() halts collections across all threads, yet still allows GC allocations. Disabling collections eliminates GC pauses.

static pure nothrow @safe voidcollect();

Begins a full collection. While the meaning of this may change based on the garbage collector implementation, typical behavior is to scan all stack segments for roots, mark accessible memory blocks as alive, and then to reclaim free space. This action may need to suspend all running threads for at least part of the collection process.

static pure nothrow @safe voidminimize();

Indicates that the managed memory space be minimized by returning free physical memory to the operating system. The amount of free memory returned depends on the allocator design and on program behavior.

enumBlkAttr: uint;

Elements for a bit field representing memory block attributes. These are manipulated via the getAttr, setAttr, clrAttr functions.

NONE

No attributes set.

FINALIZE

Finalize the data in this block on collect.

NO_SCAN

Do not scan through this block on collect.

NO_MOVE

Do not move this memory block on collect.

APPENDABLE

This block contains the info to allow appending.

This can be used to manually allocate arrays. Initial slice size is 0.

NoteThe slice's usable size will not match the block size. Usecapacity to retrieve actual usable capacity.

Example

// Allocate the underlying array.int*  pToArray =cast(int*)GC.malloc(10 *int.sizeof, GC.BlkAttr.NO_SCAN | GC.BlkAttr.APPENDABLE);// Bind a slice. Check the slice has capacity information.int[] slice = pToArray[0 .. 0];assert(capacity(slice) > 0);// Appending to the slice will not relocate it.slice.length = 5;slice ~= 1;assert(slice.ptr == p);

NO_INTERIOR

This block is guaranteed to have a pointer to its base while it is alive. Interior pointers can be safely ignored. This attribute is useful for eliminating false pointers in very large data structures and is only implemented for data structures at least a page in size.

aliasBlkInfo = .BlkInfo_;

Contains aggregate information about a block of managed memory. The purpose of this struct is to support a more efficient query style in instances where detailed information is needed.

base = A pointer to the base of the block in question. size = The size of the block, calculated from base. attr = Attribute bits set on the memory block.

static nothrow uintgetAttr(scope const void*p); static pure nothrow uintgetAttr(void*p);

Returns a bit field representing all block attributes set for the memory referenced by p. If p references memory not originally allocated by this garbage collector, points to the interior of a memory block, or if p is null, zero will be returned.

Parameters:

void*p A pointer to the root of a valid memory block or to null.

Returns:

A bit field containing any bits set for the memory block referenced by p or zero on error.

static nothrow uintsetAttr(scope const void*p, uinta); static pure nothrow uintsetAttr(void*p, uinta);

Sets the specified bits for the memory references by p. If p references memory not originally allocated by this garbage collector, points to the interior of a memory block, or if p is null, no action will be performed.

Parameters:

void*`p`	A pointer to the root of a valid memory block or to null.
uint`a`	A bit field containing any bits to set for this memory block.

Returns:

The result of a call togetAttr after the specified bits have been set.

static nothrow uintclrAttr(scope const void*p, uinta); static pure nothrow uintclrAttr(void*p, uinta);

Clears the specified bits for the memory references by p. If p references memory not originally allocated by this garbage collector, points to the interior of a memory block, or if p is null, no action will be performed.

Parameters:

void*`p`	A pointer to the root of a valid memory block or to null.
uint`a`	A bit field containing any bits to clear for this memory block.

Returns:

The result of a call togetAttr after the specified bits have been cleared.

static pure nothrow void*malloc(size_tsz, uintba = 0, scope const TypeInfoti = null);

Requests an aligned block of managed memory from the garbage collector. This memory may be deleted at will with a call to free, or it may be discarded and cleaned up automatically during a collection run. If allocation fails, this function will call onOutOfMemory which is expected to throw an OutOfMemoryError.

Parameters:

size_t`sz`	The desired allocation size in bytes.
uint`ba`	A bitmask of the attributes to set on this block.
TypeInfo`ti`	TypeInfo to describe the memory. The GC might use this information to improve scanning for pointers or to call finalizers.

Returns:

A reference to the allocated memory or null if insufficient memory is available.

Warning: Allocated memory will be uninitialized, and may happen to hold pointers to GC memory. Consider zeroing out any uninitialized bytes which won't be immediately written to.

Throws:

OutOfMemoryError on allocation failure.

static pure nothrow BlkInfoqalloc(size_tsz, uintba = 0, scope const TypeInfoti = null);

Requests an aligned block of managed memory from the garbage collector. This memory may be deleted at will with a call tofree, or it may be discarded and cleaned up automatically during a collection run. If allocation fails, this function will call onOutOfMemory which is expected to throw an OutOfMemoryError.

Parameters:

size_t`sz`	The desired allocation size in bytes.
uint`ba`	A bitmask of the attributes to set on this block.
TypeInfo`ti`	TypeInfo to describe the memory. The GC might use this information to improve scanning for pointers or to call finalizers.

Returns:

Information regarding the allocated memory block or BlkInfo.init on error.

Warning: Allocated memory will be uninitialized, and may happen to hold pointers to GC memory. Consider zeroing out any uninitialized bytes which won't be immediately written to.

Throws:

OutOfMemoryError on allocation failure.

static pure nothrow void*calloc(size_tsz, uintba = 0, const TypeInfoti = null);

Requests an aligned block of managed memory from the garbage collector, which is initialized with all bits set to zero. This memory may be deleted at will with a call to free, or it may be discarded and cleaned up automatically during a collection run. If allocation fails, this function will call onOutOfMemory which is expected to throw an OutOfMemoryError.

Parameters:

size_t`sz`	The desired allocation size in bytes.
uint`ba`	A bitmask of the attributes to set on this block.
TypeInfo`ti`	TypeInfo to describe the memory. The GC might use this information to improve scanning for pointers or to call finalizers.

Returns:

A reference to the allocated memory or null if insufficient memory is available.

Throws:

OutOfMemoryError on allocation failure.

static pure nothrow void*realloc(return scope void*p, size_tsz, uintba = 0, const TypeInfoti = null);

Extend, shrink or allocate a new block of memory keeping the contents of an existing block

Ifsz is zero, the memory referenced by p will be deallocated as if by a call tofree. Ifp isnull, new memory will be allocated viamalloc. Ifp is pointing to memory not allocated from the GC or to the interior of an allocated memory block, no operation is performed and null is returned.

Otherwise, a new memory block of sizesz will be allocated as if by a call tomalloc, or the implementation may instead resize or shrink the memory block in place. The contents of the new memory block will be the same as the contents of the old memory block, up to the lesser of the new and old sizes.

The caller guarantees that there are no other live pointers to the passed memory block, still it might not be freed immediately byrealloc. The garbage collector can reclaim the memory block in a later collection if it is unused. If allocation fails, this function will throw anOutOfMemoryError.

Ifba is zero (the default) the attributes of the existing memory will be used for an allocation. Ifba is not zero and no new memory is allocated, the bits in ba will replace those of the current memory block.

Parameters:

void*`p`	A pointer to the base of a valid memory block or tonull.
size_t`sz`	The desired allocation size in bytes.
uint`ba`	A bitmask of the BlkAttr attributes to set on this block.
TypeInfo`ti`	TypeInfo to describe the memory. The GC might use this information to improve scanning for pointers or to call finalizers.

Returns:

A reference to the allocated memory on success ornull ifsz is zero or the pointer does not point to the base of an GC allocated memory block.

Warning: Any extra bytes past the initial size will be uninitialized, and may happen to hold pointers to GC memory. Consider zeroing out any uninitialized bytes which won't be immediately written to.

Throws:

OutOfMemoryError on allocation failure.

Examples:

enum size1 = 1 << 11 + 1;// page in large object poolenum size2 = 1 << 22 + 1;// larger than large object pool sizeauto data1 =cast(ubyte*)GC.calloc(size1);auto data2 =cast(ubyte*)GC.realloc(data1, size2);GC.BlkInfo info = GC.query(data2);assert(info.size >= size2);

static pure nothrow size_textend(void*p, size_tmx, size_tsz, const TypeInfoti = null);

Requests that the managed memory block referenced by p be extended in place by at least mx bytes, with a desired extension of sz bytes. If an extension of the required size is not possible or if p references memory not originally allocated by this garbage collector, no action will be taken.

Parameters:

void*`p`	A pointer to the root of a valid memory block or to null.
size_t`mx`	The minimum extension size in bytes.
size_t`sz`	The desired extension size in bytes.
TypeInfo`ti`	TypeInfo to describe the full memory block. The GC might use this information to improve scanning for pointers or to call finalizers.

Returns:

The size in bytes of the extended memory block referenced by p or zero if no extension occurred.

Warning: Any extension bytes will be uninitialized, and may happen to hold pointers to GC memory. Consider zeroing out any uninitialized bytes which won't be immediately written to.

NoteExtend may also be used to extend slices (or memory blocks withAPPENDABLE info). However, use the return value only as an indicator of success.capacity should be used to retrieve actual usable slice capacity.

Examples:

Standard extending

size_t size = 1000;int*p =cast(int*)GC.malloc(size *int.sizeof, GC.BlkAttr.NO_SCAN);//Try to extend the allocated data by 1000 elements, preferred 2000.size_t u = GC.extend(p, 1000 *int.sizeof, 2000 *int.sizeof);if (u != 0)    size = u /int.sizeof;

Examples:

slice extending

int[] slice =newint[](1000);int*p     = slice.ptr;//Check we have access to capacity before attempting the extendif (slice.capacity){//Try to extend slice by 1000 elements, preferred 2000.    size_t u = GC.extend(p, 1000 *int.sizeof, 2000 *int.sizeof);if (u != 0)    {        slice.length = slice.capacity;assert(slice.length >= 2000);    }}

static pure nothrow size_treserve(size_tsz);

Requests that at least sz bytes of memory be obtained from the operating system and marked as free.

Parameters:

size_tsz The desired size in bytes.

Returns:

The actual number of bytes reserved or zero on error.

static pure nothrow @nogc voidfree(void*p);

Deallocates the memory referenced by p. If p is null, no action occurs. If p references memory not originally allocated by this garbage collector, if p points to the interior of a memory block, or if this method is called from a finalizer, no action will be taken. The block will not be finalized regardless of whether theFINALIZE attribute is set. If finalization is desired, calldestroy prior toGC.free.

Parameters:

void*p A pointer to the root of a valid memory block or to null.

static pure nothrow @nogc @trusted inout(void)*addrOf(inout(void)*p); static pure nothrow @nogc @trusted void*addrOf(void*p);

Returns the base address of the memory block containing p. This value is useful to determine whether p is an interior pointer, and the result may be passed to routines such as sizeOf which may otherwise fail. If p references memory not originally allocated by this garbage collector, if p is null, or if the garbage collector does not support this operation, null will be returned.

Parameters:

inout(void)*p A pointer to the root or the interior of a valid memory block or to null.

Returns:

The base address of the memory block referenced by p or null on error.

static nothrow @nogc size_tsizeOf(scope const void*p); static pure nothrow @nogc size_tsizeOf(void*p);

Returns the true size of the memory block referenced by p. This value represents the maximum number of bytes for which a call torealloc may resize the existing block in place. If p references memory not originally allocated by this garbage collector, points to the interior of a memory block, or if p is null, zero will be returned.

Parameters:

void*p A pointer to the root of a valid memory block or to null.

Returns:

The size in bytes of the memory block referenced by p or zero on error.

static nothrow BlkInfoquery(return scope const void*p); static pure nothrow BlkInfoquery(return scope void*p);

Returns aggregate information about the memory block containing p. If p references memory not originally allocated by this garbage collector, if p is null, or if the garbage collector does not support this operation, BlkInfo.init will be returned. Typically, support for this operation is dependent on support for addrOf.

Parameters:

void*p A pointer to the root or the interior of a valid memory block or to null.

Returns:

Information regarding the memory block referenced by p or BlkInfo.init on error.

static nothrow @nogc @safe Statsstats();

Returns runtime stats for currently active GC implementation Seecore.memory.GC.Stats for list of available metrics.

static nothrow @nogc @safe ProfileStatsprofileStats();

Returns runtime profile stats for currently active GC implementation Seecore.memory.GC.ProfileStats for list of available metrics.

static pure nothrow @nogc voidaddRoot(const void*p);

Adds an internal root pointing to the GC memory block referenced by p. As a result, the block referenced by p itself and any blocks accessible via it will be considered live until the root is removed again.

If p is null, no operation is performed.

Parameters:

void*p A pointer into a GC-managed memory block or null.

Example

// Typical C-style callback mechanism; the passed function// is invoked with the user-supplied context pointer at a// later point.extern(C)void addCallback(voidfunction(void*),void*);// Allocate an object on the GC heap (this would usually be// some application-specific context data).auto context =new Object;// Make sure that it is not collected even if it is no// longer referenced from D code (stack, GC heap, …).GC.addRoot(cast(void*)context);// Also ensure that a moving collector does not relocate// the object.GC.setAttr(cast(void*)context, GC.BlkAttr.NO_MOVE);// Now context can be safely passed to the C library.addCallback(&myHandler,cast(void*)context);extern(C)void myHandler(void* ctx){// Assuming that the callback is invoked only once, the// added root can be removed again now to allow the GC// to collect it later.    GC.removeRoot(ctx);    GC.clrAttr(ctx, GC.BlkAttr.NO_MOVE);auto context =cast(Object)ctx;// Use context here…}

static pure nothrow @nogc voidremoveRoot(const void*p);

Removes the memory block referenced by p from an internal list of roots to be scanned during a collection. If p is null or is not a value previously passed to addRoot() then no operation is performed.

Parameters:

void*p A pointer into a GC-managed memory block or null.

static pure nothrow @nogc voidaddRange(const void*p, size_tsz, const TypeInfoti = null);

Addsp[0 .. sz] to the list of memory ranges to be scanned for pointers during a collection. If p is null, no operation is performed.

Note thatp[0 .. sz] is treated as an opaque range of memory assumed to be suitably managed by the caller. In particular, if p points into a GC-managed memory block, addRange doesnot mark this block as live.

Parameters:

void*`p`	A pointer to a valid memory address or to null.
size_t`sz`	The size in bytes of the block to add. If sz is zero then the no operation will occur. If p is null then sz must be zero.
TypeInfo`ti`	TypeInfo to describe the memory. The GC might use this information to improve scanning for pointers or to call finalizers

Example

// Allocate a piece of memory on the C heap.enum size = 1_000;auto rawMemory = core.stdc.stdlib.malloc(size);// Add it as a GC range.GC.addRange(rawMemory, size);// Now, pointers to GC-managed memory stored in// rawMemory will be recognized on collection.

static pure nothrow @nogc voidremoveRange(const void*p);

Removes the memory range starting at p from an internal list of ranges to be scanned during a collection. If p is null or does not represent a value previously passed to addRange() then no operation is performed.

Parameters:

void*p A pointer to a valid memory address or to null.

static voidrunFinalizers(scope const void[]segment);

Runs any finalizer that is located in address range of the given code segment. This is used before unloading shared libraries. All matching objects which have a finalizer in this code segment are assumed to be dead, using them while or after calling this method has undefined behavior.

Parameters:

void[]segment address range of a code segment.

static nothrow @nogc @safe boolinFinalizer();

Queries the GC whether the current thread is running object finalization as part of a GC collection, or an explicit call to runFinalizers.

As some GC implementations (such as the current conservative one) don't support GC memory allocation during object finalization, this function can be used to guard against such programming errors.

Returns:

true if the current thread is in a finalizer, a destructor invoked by the GC.

Examples:

// Only code called from a destructor is executed during finalization.assert(!GC.inFinalizer);

Examples:

enum Outcome{    notCalled,    calledManually,    calledFromDruntime}staticclass Resource{static Outcome outcome;this()    {        outcome = Outcome.notCalled;    }    ~this()    {if (GC.inFinalizer)        {            outcome = Outcome.calledFromDruntime;import core.exception : InvalidMemoryOperationError;try            {/*                 * Presently, allocating GC memory during finalization                 * is forbidden and leads to                 * `InvalidMemoryOperationError` being thrown.                 *                 * `GC.inFinalizer` can be used to guard against                 * programming erros such as these and is also a more                 * efficient way to verify whether a destructor was                 * invoked by the GC.                 */cast(void) GC.malloc(1);assert(false);            }catch (InvalidMemoryOperationError e)            {return;            }assert(false);        }else            outcome = Outcome.calledManually;    }}staticvoid createGarbage(){auto r =new Resource;    r =null;}assert(Resource.outcome == Outcome.notCalled);createGarbage();GC.collect;assert(    Resource.outcome == Outcome.notCalled ||    Resource.outcome == Outcome.calledFromDruntime);auto r =new Resource;GC.runFinalizers((cast(constvoid*)typeid(Resource).destructor)[0..1]);assert(Resource.outcome == Outcome.calledFromDruntime);Resource.outcome = Outcome.notCalled;debug(MEMSTOMP) {}else{// assume Resource data is still available    r.destroy;assert(Resource.outcome == Outcome.notCalled);}r =new Resource;assert(Resource.outcome == Outcome.notCalled);r.destroy;assert(Resource.outcome == Outcome.calledManually);

static nothrow ulongallocatedInCurrentThread();

Returns the number of bytes allocated for the current thread since program start. It is the same as GC.stats().allocatedInCurrentThread, but faster.

Examples:

Using allocatedInCurrentThread

ulong currentlyAllocated = GC.allocatedInCurrentThread();struct DataStruct{long l1;long l2;long l3;long l4;}DataStruct* unused =new DataStruct;assert(GC.allocatedInCurrentThread() == currentlyAllocated + 32);assert(GC.stats().allocatedInCurrentThread == currentlyAllocated + 32);

pure nothrow @nogc @trusted void*pureMalloc()(size_tsize); pure nothrow @nogc @trusted void*pureCalloc()(size_tnmemb, size_tsize); pure nothrow @nogc @system void*pureRealloc()(void*ptr, size_tsize); pure nothrow @nogc @system voidpureFree()(void*ptr);

Pure variants of C's memory allocation functionsmalloc,calloc, andrealloc and deallocation functionfree.

UNIX 98 requires that errno be set to ENOMEM upon failure. Purity is achieved by saving and restoring the value oferrno, thus behaving as if it were never changed.

Movatterモバイル変換

Library Reference

core.memory