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

A garbage collection algorithm is a specific way to get rid of unused heap objects.

Constructors

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

name (state -> (addresses, addresses, 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

Methods

addrs :: HeapObject -> Seq MemAddr

addrs' :: HeapObject -> Seq MemAddr

Addresses Closure

Methods

addrs :: Closure -> Seq MemAddr

addrs' :: Closure -> Seq MemAddr

Addresses Locals

Methods

addrs :: Locals -> Seq MemAddr

addrs' :: Locals -> Seq MemAddr

Addresses Globals

Methods

addrs :: Globals -> Seq MemAddr

addrs' :: Globals -> Seq MemAddr

Addresses Code

Methods

addrs :: Code -> Seq MemAddr

addrs' :: Code -> Seq MemAddr

Addresses Value

Methods

addrs :: Value -> Seq MemAddr

addrs' :: Value -> Seq MemAddr

Addresses MemAddr

Methods

addrs :: MemAddr -> Seq MemAddr

addrs' :: MemAddr -> Seq MemAddr

Addresses StackFrame

Methods

addrs :: StackFrame -> Seq MemAddr

addrs' :: StackFrame -> Seq MemAddr

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

Methods

addrs :: f a -> Seq MemAddr

addrs' :: f a -> Seq MemAddr

class UpdateAddrs a where

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

Minimal complete definition

updateAddrs

Methods

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

Instances

UpdateAddrs Locals

Methods

updateAddrs :: (MemAddr -> MemAddr) -> Locals -> Locals

UpdateAddrs Globals

Methods

updateAddrs :: (MemAddr -> MemAddr) -> Globals -> Globals

UpdateAddrs Code

Methods

updateAddrs :: (MemAddr -> MemAddr) -> Code -> Code

UpdateAddrs Value

Methods

updateAddrs :: (MemAddr -> MemAddr) -> Value -> Value

UpdateAddrs MemAddr

Methods

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

UpdateAddrs StackFrame

Methods

updateAddrs :: (MemAddr -> MemAddr) -> StackFrame -> StackFrame

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

Methods

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