GHC.Debug.Retainers

Functions for computing retainers

Documentation

findRetainers :: Maybe Int -> ClosureFilter -> [ClosurePtr] -> DebugM [[ClosurePtr]]

From the given roots, find any path to one of the given pointers. Note: This function can be quite slow! The first argument is a limit to how many paths to find. You should normally set this to a small number such as 10.

findRetainersOf :: Maybe Int -> [ClosurePtr] -> [ClosurePtr] -> DebugM [[ClosurePtr]]

findRetainersOfConstructor :: Maybe Int -> [ClosurePtr] -> String -> DebugM [[ClosurePtr]]

findRetainersOfConstructorExact :: Maybe Int -> [ClosurePtr] -> String -> DebugM [[ClosurePtr]]

findRetainersOfInfoTable :: Maybe Int -> [ClosurePtr] -> InfoTablePtr -> DebugM [[ClosurePtr]]

addLocationToStack :: [ClosurePtr] -> DebugM [(SizedClosureP, Maybe SourceInformation)]

displayRetainerStack :: [(String, [(SizedClosureP, Maybe SourceInformation)])] -> IO ()

addLocationToStack' :: [ClosurePtr] -> DebugM [(ClosurePtr, SizedClosureP, Maybe SourceInformation)]

displayRetainerStack' :: [(String, [(ClosurePtr, SizedClosureP, Maybe SourceInformation)])] -> IO ()

findRetainersOfArrWords :: Maybe Int -> [ClosurePtr] -> Size -> DebugM [[ClosurePtr]]

data EraRange

Constructors

EraRange

Fields

• startEra :: Word64
• endEra :: Word64

Instances

Show EraRange

Defined in GHC.Debug.Retainers

Methods

showsPrec :: Int -> EraRange -> ShowS

show :: EraRange -> String

showList :: [EraRange] -> ShowS

Eq EraRange

Defined in GHC.Debug.Retainers

Methods

(==) :: EraRange -> EraRange -> Bool

(/=) :: EraRange -> EraRange -> Bool

Ord EraRange

Defined in GHC.Debug.Retainers

Methods

compare :: EraRange -> EraRange -> Ordering

(<) :: EraRange -> EraRange -> Bool

(<=) :: EraRange -> EraRange -> Bool

(>) :: EraRange -> EraRange -> Bool

(>=) :: EraRange -> EraRange -> Bool

max :: EraRange -> EraRange -> EraRange

min :: EraRange -> EraRange -> EraRange

profHeaderInEraRange :: Maybe (ProfHeader a) -> Maybe EraRange -> Bool

data ClosureFilter

Constructors

ConstructorDescFilter (ConstrDesc -> Bool)

InfoFilter (StgInfoTable -> Bool)

InfoPtrFilter (InfoTablePtr -> Bool)

InfoSourceFilter (SourceInformation -> Bool)

SizeFilter (Size -> Bool)

ProfHeaderFilter (Maybe ProfHeaderWithPtr -> Bool)

AddressFilter (ClosurePtr -> Bool)

AndFilter ClosureFilter ClosureFilter

OrFilter ClosureFilter ClosureFilter

NotFilter ClosureFilter

PureFilter Bool

profHeaderReferencesCCS :: Maybe ProfHeaderWithPtr -> Set CCSPtr -> Bool

findRetainersOfEra :: Maybe Int -> EraRange -> [ClosurePtr] -> DebugM [[ClosurePtr]]