Stg.Machine.GarbageCollection.Common

Definitions used by various garbage collection algorithms.

Documentation

splitHeapWith :: GarbageCollectionAlgorithm -> StgState -> (Set MemAddr, Map MemAddr MemAddr, StgState)

Split the heap contained in a machine state in three parts: the dead objects that can safely be discarded, a maping from old to new addresses if definitions were moved, and the final state with a cleaned up heap.

data GarbageCollectionAlgorithm

Constructors

GarbageCollectionAlgorithm Text (StgState -> (Set MemAddr, Map MemAddr MemAddr, StgState))

Dead addresses, moved addresses, new state

class Addresses a where

Collect all mentioned addresses in a machine element.

Note that none of the types in Stg.Language contain addresses, since an address is not something present in the STG language, only in the execution contest the language is put in in the Stg.Machine modules.

Minimal complete definition

addrs'

Methods

addrs :: a -> Seq MemAddr

All contained addresses in the order they appear, but without duplicates.

Instances

Addresses HeapObject

Addresses Closure

Addresses Locals

Addresses Globals

Addresses Code

Addresses Value

Addresses MemAddr

Addresses StackFrame

(Foldable f, Addresses a) => Addresses (f a)

class UpdateAddrs a where

Update all contained addresses in a certain value. Useful for moving garbage collectors.

Methods

updateAddrs :: (MemAddr -> MemAddr) -> a -> a

Instances

UpdateAddrs Locals

UpdateAddrs Globals

UpdateAddrs Code

UpdateAddrs Value

UpdateAddrs MemAddr

UpdateAddrs StackFrame

(Functor f, UpdateAddrs a) => UpdateAddrs (f a)