mirror of
https://github.com/nim-lang/Nim.git
synced 2025-12-30 18:02:05 +00:00
339 lines
11 KiB
Nim
339 lines
11 KiB
Nim
#
|
|
#
|
|
# Nim's Runtime Library
|
|
# (c) Copyright 2015 Andreas Rumpf
|
|
#
|
|
# See the file "copying.txt", included in this
|
|
# distribution, for details about the copyright.
|
|
#
|
|
|
|
# Nim high-level memory manager: It supports Boehm's GC, no GC and the
|
|
# native Nim GC. The native Nim GC is the default.
|
|
|
|
#{.push checks:on, assertions:on.}
|
|
{.push checks:off.}
|
|
|
|
const
|
|
debugGC = false # we wish to debug the GC...
|
|
logGC = false
|
|
traceGC = false # extensive debugging
|
|
alwaysCycleGC = false
|
|
alwaysGC = defined(fulldebug) # collect after every memory
|
|
# allocation (for debugging)
|
|
leakDetector = false
|
|
overwriteFree = false
|
|
trackAllocationSource = leakDetector
|
|
|
|
cycleGC = true # (de)activate the cycle GC
|
|
reallyDealloc = true # for debugging purposes this can be set to false
|
|
reallyOsDealloc = true
|
|
coalescRight = true
|
|
coalescLeft = true
|
|
logAlloc = false
|
|
useCellIds = defined(corruption)
|
|
|
|
type
|
|
PPointer = ptr pointer
|
|
TByteArray = array[0..1000_0000, byte]
|
|
PByte = ptr TByteArray
|
|
PString = ptr string
|
|
|
|
# Page size of the system; in most cases 4096 bytes. For exotic OS or
|
|
# CPU this needs to be changed:
|
|
const
|
|
PageShift = 12
|
|
PageSize = 1 shl PageShift
|
|
PageMask = PageSize-1
|
|
|
|
MemAlign = 8 # also minimal allocatable memory block
|
|
|
|
BitsPerPage = PageSize div MemAlign
|
|
UnitsPerPage = BitsPerPage div (sizeof(int)*8)
|
|
# how many ints do we need to describe a page:
|
|
# on 32 bit systems this is only 16 (!)
|
|
|
|
TrunkShift = 9
|
|
BitsPerTrunk = 1 shl TrunkShift # needs to be power of 2 and divisible by 64
|
|
TrunkMask = BitsPerTrunk - 1
|
|
IntsPerTrunk = BitsPerTrunk div (sizeof(int)*8)
|
|
IntShift = 5 + ord(sizeof(int) == 8) # 5 or 6, depending on int width
|
|
IntMask = 1 shl IntShift - 1
|
|
|
|
proc raiseOutOfMem() {.noinline.} =
|
|
if outOfMemHook != nil: outOfMemHook()
|
|
echo("out of memory")
|
|
quit(1)
|
|
|
|
when defined(boehmgc):
|
|
when defined(windows):
|
|
const boehmLib = "boehmgc.dll"
|
|
elif defined(macosx):
|
|
const boehmLib = "libgc.dylib"
|
|
else:
|
|
const boehmLib = "/usr/lib/libgc.so.1"
|
|
|
|
proc boehmGCinit {.importc: "GC_init", dynlib: boehmLib.}
|
|
proc boehmGC_disable {.importc: "GC_disable", dynlib: boehmLib.}
|
|
proc boehmGC_enable {.importc: "GC_enable", dynlib: boehmLib.}
|
|
proc boehmGCincremental {.
|
|
importc: "GC_enable_incremental", dynlib: boehmLib.}
|
|
proc boehmGCfullCollect {.importc: "GC_gcollect", dynlib: boehmLib.}
|
|
proc boehmAlloc(size: int): pointer {.
|
|
importc: "GC_malloc", dynlib: boehmLib.}
|
|
proc boehmAllocAtomic(size: int): pointer {.
|
|
importc: "GC_malloc_atomic", dynlib: boehmLib.}
|
|
proc boehmRealloc(p: pointer, size: int): pointer {.
|
|
importc: "GC_realloc", dynlib: boehmLib.}
|
|
proc boehmDealloc(p: pointer) {.importc: "GC_free", dynlib: boehmLib.}
|
|
|
|
proc boehmGetHeapSize: int {.importc: "GC_get_heap_size", dynlib: boehmLib.}
|
|
## Return the number of bytes in the heap. Excludes collector private
|
|
## data structures. Includes empty blocks and fragmentation loss.
|
|
## Includes some pages that were allocated but never written.
|
|
|
|
proc boehmGetFreeBytes: int {.importc: "GC_get_free_bytes", dynlib: boehmLib.}
|
|
## Return a lower bound on the number of free bytes in the heap.
|
|
|
|
proc boehmGetBytesSinceGC: int {.importc: "GC_get_bytes_since_gc",
|
|
dynlib: boehmLib.}
|
|
## Return the number of bytes allocated since the last collection.
|
|
|
|
proc boehmGetTotalBytes: int {.importc: "GC_get_total_bytes",
|
|
dynlib: boehmLib.}
|
|
## Return the total number of bytes allocated in this process.
|
|
## Never decreases.
|
|
|
|
proc allocAtomic(size: int): pointer =
|
|
result = boehmAllocAtomic(size)
|
|
zeroMem(result, size)
|
|
|
|
when not defined(useNimRtl):
|
|
|
|
proc alloc(size: int): pointer =
|
|
result = boehmAlloc(size)
|
|
if result == nil: raiseOutOfMem()
|
|
proc alloc0(size: int): pointer =
|
|
result = alloc(size)
|
|
zeroMem(result, size)
|
|
proc realloc(p: pointer, newsize: int): pointer =
|
|
result = boehmRealloc(p, newsize)
|
|
if result == nil: raiseOutOfMem()
|
|
proc dealloc(p: pointer) = boehmDealloc(p)
|
|
|
|
proc allocShared(size: int): pointer =
|
|
result = boehmAlloc(size)
|
|
if result == nil: raiseOutOfMem()
|
|
proc allocShared0(size: int): pointer =
|
|
result = alloc(size)
|
|
zeroMem(result, size)
|
|
proc reallocShared(p: pointer, newsize: int): pointer =
|
|
result = boehmRealloc(p, newsize)
|
|
if result == nil: raiseOutOfMem()
|
|
proc deallocShared(p: pointer) = boehmDealloc(p)
|
|
|
|
when hasThreadSupport:
|
|
proc getFreeSharedMem(): int =
|
|
boehmGetFreeBytes()
|
|
proc getTotalSharedMem(): int =
|
|
boehmGetHeapSize()
|
|
proc getOccupiedSharedMem(): int =
|
|
getTotalSharedMem() - getFreeSharedMem()
|
|
|
|
#boehmGCincremental()
|
|
|
|
proc GC_disable() = boehmGC_disable()
|
|
proc GC_enable() = boehmGC_enable()
|
|
proc GC_fullCollect() = boehmGCfullCollect()
|
|
proc GC_setStrategy(strategy: GC_Strategy) = discard
|
|
proc GC_enableMarkAndSweep() = discard
|
|
proc GC_disableMarkAndSweep() = discard
|
|
proc GC_getStatistics(): string = return ""
|
|
|
|
proc getOccupiedMem(): int = return boehmGetHeapSize()-boehmGetFreeBytes()
|
|
proc getFreeMem(): int = return boehmGetFreeBytes()
|
|
proc getTotalMem(): int = return boehmGetHeapSize()
|
|
|
|
proc setStackBottom(theStackBottom: pointer) = discard
|
|
|
|
proc initGC() =
|
|
when defined(macosx): boehmGCinit()
|
|
|
|
proc newObj(typ: PNimType, size: int): pointer {.compilerproc.} =
|
|
if ntfNoRefs in typ.flags: result = allocAtomic(size)
|
|
else: result = alloc(size)
|
|
proc newSeq(typ: PNimType, len: int): pointer {.compilerproc.} =
|
|
result = newObj(typ, addInt(mulInt(len, typ.base.size), GenericSeqSize))
|
|
cast[PGenericSeq](result).len = len
|
|
cast[PGenericSeq](result).reserved = len
|
|
|
|
proc growObj(old: pointer, newsize: int): pointer =
|
|
result = realloc(old, newsize)
|
|
|
|
proc nimGCref(p: pointer) {.compilerproc, inline.} = discard
|
|
proc nimGCunref(p: pointer) {.compilerproc, inline.} = discard
|
|
|
|
proc unsureAsgnRef(dest: PPointer, src: pointer) {.compilerproc, inline.} =
|
|
dest[] = src
|
|
proc asgnRef(dest: PPointer, src: pointer) {.compilerproc, inline.} =
|
|
dest[] = src
|
|
proc asgnRefNoCycle(dest: PPointer, src: pointer) {.compilerproc, inline.} =
|
|
dest[] = src
|
|
|
|
type
|
|
TMemRegion = object {.final, pure.}
|
|
|
|
proc alloc(r: var TMemRegion, size: int): pointer =
|
|
result = boehmAlloc(size)
|
|
if result == nil: raiseOutOfMem()
|
|
proc alloc0(r: var TMemRegion, size: int): pointer =
|
|
result = alloc(size)
|
|
zeroMem(result, size)
|
|
proc dealloc(r: var TMemRegion, p: pointer) = boehmDealloc(p)
|
|
proc deallocOsPages(r: var TMemRegion) {.inline.} = discard
|
|
proc deallocOsPages() {.inline.} = discard
|
|
|
|
include "system/cellsets"
|
|
elif defined(nogc) and defined(useMalloc):
|
|
|
|
when not defined(useNimRtl):
|
|
proc alloc(size: int): pointer =
|
|
result = cmalloc(size)
|
|
if result == nil: raiseOutOfMem()
|
|
proc alloc0(size: int): pointer =
|
|
result = alloc(size)
|
|
zeroMem(result, size)
|
|
proc realloc(p: pointer, newsize: int): pointer =
|
|
result = crealloc(p, newsize)
|
|
if result == nil: raiseOutOfMem()
|
|
proc dealloc(p: pointer) = cfree(p)
|
|
|
|
proc allocShared(size: int): pointer =
|
|
result = cmalloc(size)
|
|
if result == nil: raiseOutOfMem()
|
|
proc allocShared0(size: int): pointer =
|
|
result = alloc(size)
|
|
zeroMem(result, size)
|
|
proc reallocShared(p: pointer, newsize: int): pointer =
|
|
result = crealloc(p, newsize)
|
|
if result == nil: raiseOutOfMem()
|
|
proc deallocShared(p: pointer) = cfree(p)
|
|
|
|
proc GC_disable() = discard
|
|
proc GC_enable() = discard
|
|
proc GC_fullCollect() = discard
|
|
proc GC_setStrategy(strategy: GC_Strategy) = discard
|
|
proc GC_enableMarkAndSweep() = discard
|
|
proc GC_disableMarkAndSweep() = discard
|
|
proc GC_getStatistics(): string = return ""
|
|
|
|
proc getOccupiedMem(): int = discard
|
|
proc getFreeMem(): int = discard
|
|
proc getTotalMem(): int = discard
|
|
|
|
proc setStackBottom(theStackBottom: pointer) = discard
|
|
|
|
proc initGC() = discard
|
|
|
|
proc newObj(typ: PNimType, size: int): pointer {.compilerproc.} =
|
|
result = alloc(size)
|
|
proc newSeq(typ: PNimType, len: int): pointer {.compilerproc.} =
|
|
result = newObj(typ, addInt(mulInt(len, typ.base.size), GenericSeqSize))
|
|
cast[PGenericSeq](result).len = len
|
|
cast[PGenericSeq](result).reserved = len
|
|
proc newObjNoInit(typ: PNimType, size: int): pointer =
|
|
result = alloc(size)
|
|
|
|
proc growObj(old: pointer, newsize: int): pointer =
|
|
result = realloc(old, newsize)
|
|
|
|
proc nimGCref(p: pointer) {.compilerproc, inline.} = discard
|
|
proc nimGCunref(p: pointer) {.compilerproc, inline.} = discard
|
|
|
|
proc unsureAsgnRef(dest: PPointer, src: pointer) {.compilerproc, inline.} =
|
|
dest[] = src
|
|
proc asgnRef(dest: PPointer, src: pointer) {.compilerproc, inline.} =
|
|
dest[] = src
|
|
proc asgnRefNoCycle(dest: PPointer, src: pointer) {.compilerproc, inline.} =
|
|
dest[] = src
|
|
|
|
type
|
|
TMemRegion = object {.final, pure.}
|
|
|
|
proc alloc(r: var TMemRegion, size: int): pointer =
|
|
result = alloc(size)
|
|
proc alloc0(r: var TMemRegion, size: int): pointer =
|
|
result = alloc0(size)
|
|
proc dealloc(r: var TMemRegion, p: pointer) = dealloc(p)
|
|
proc deallocOsPages(r: var TMemRegion) {.inline.} = discard
|
|
proc deallocOsPages() {.inline.} = discard
|
|
|
|
elif defined(nogc):
|
|
# Even though we don't want the GC, we cannot simply use C's memory manager
|
|
# because Nim's runtime wants ``realloc`` to zero out the additional
|
|
# space which C's ``realloc`` does not. And we cannot get the old size of an
|
|
# object, because C does not support this operation... Even though every
|
|
# possible implementation has to have a way to determine the object's size.
|
|
# C just sucks.
|
|
when appType == "lib":
|
|
{.warning: "nogc in a library context may not work".}
|
|
|
|
include "system/alloc"
|
|
|
|
proc initGC() = discard
|
|
proc GC_disable() = discard
|
|
proc GC_enable() = discard
|
|
proc GC_fullCollect() = discard
|
|
proc GC_setStrategy(strategy: GC_Strategy) = discard
|
|
proc GC_enableMarkAndSweep() = discard
|
|
proc GC_disableMarkAndSweep() = discard
|
|
proc GC_getStatistics(): string = return ""
|
|
|
|
|
|
proc newObj(typ: PNimType, size: int): pointer {.compilerproc.} =
|
|
result = alloc0(size)
|
|
|
|
proc newObjNoInit(typ: PNimType, size: int): pointer =
|
|
result = alloc(size)
|
|
|
|
proc newSeq(typ: PNimType, len: int): pointer {.compilerproc.} =
|
|
result = newObj(typ, addInt(mulInt(len, typ.base.size), GenericSeqSize))
|
|
cast[PGenericSeq](result).len = len
|
|
cast[PGenericSeq](result).reserved = len
|
|
proc growObj(old: pointer, newsize: int): pointer =
|
|
result = realloc(old, newsize)
|
|
|
|
proc setStackBottom(theStackBottom: pointer) = discard
|
|
proc nimGCref(p: pointer) {.compilerproc, inline.} = discard
|
|
proc nimGCunref(p: pointer) {.compilerproc, inline.} = discard
|
|
|
|
proc unsureAsgnRef(dest: PPointer, src: pointer) {.compilerproc, inline.} =
|
|
dest[] = src
|
|
proc asgnRef(dest: PPointer, src: pointer) {.compilerproc, inline.} =
|
|
dest[] = src
|
|
proc asgnRefNoCycle(dest: PPointer, src: pointer) {.compilerproc, inline.} =
|
|
dest[] = src
|
|
|
|
var allocator {.rtlThreadVar.}: TMemRegion
|
|
instantiateForRegion(allocator)
|
|
|
|
include "system/cellsets"
|
|
|
|
else:
|
|
include "system/alloc"
|
|
|
|
include "system/cellsets"
|
|
when not leakDetector:
|
|
sysAssert(sizeof(TCell) == sizeof(TFreeCell), "sizeof TFreeCell")
|
|
when compileOption("gc", "v2"):
|
|
include "system/gc2"
|
|
elif defined(gcMarkAndSweep):
|
|
# XXX use 'compileOption' here
|
|
include "system/gc_ms"
|
|
elif defined(gcGenerational):
|
|
include "system/gc"
|
|
else:
|
|
include "system/gc"
|
|
|
|
{.pop.}
|
|
|