Copyright	(c) 2026 Jared Tobin
License	MIT
Maintainer	Jared Tobin <jared@ppad.tech>
Safe Haskell	Safe-Inferred
Language	Haskell2010

Vestigia.Memcheck

Description

What a memcheck run reported, read from its XML (protocol version 4 and later): each error context with its kind, its stack, the origin of the undefined value where memcheck tracked one, and how many times it occurred.

Synopsis

data Frame = Frame {
- frIp :: !Integer
- frObj :: !(Maybe Text)
- frFn :: !(Maybe Text)
- frFile :: !(Maybe Text)
- frLine :: !(Maybe Int)
}
data Origin
- = ClientRequest ![Frame]
- | OtherOrigin !Text ![Frame]
- | NoOrigin
data MemError = MemError {
- meKind :: !Text
- meWhat :: !Text
- meStack :: ![Frame]
- meOrigin :: !Origin
- meCount :: !Int
}
data Memcheck = Memcheck {
- mcVersion :: !(Maybe Text)
- mcCommand :: ![Text]
- mcFinished :: !Bool
- mcErrors :: ![MemError]
}
readMemcheck :: Text -> Either String Memcheck

Documentation

data Frame Source #

One stack frame: the instruction address, and what debug information says of it.

Constructors

Frame
Fields frIp :: !Integer frObj :: !(Maybe Text) frFn :: !(Maybe Text) frFile :: !(Maybe Text) frLine :: !(Maybe Int)

Instances

Instances details

Show Frame Source #
Instance details Defined in Vestigia.Memcheck Methods showsPrec :: Int -> Frame -> ShowS # show :: Frame -> String # showList :: [Frame] -> ShowS #
Eq Frame Source #
Instance details Defined in Vestigia.Memcheck Methods (==) :: Frame -> Frame -> Bool # (/=) :: Frame -> Frame -> Bool #

data Origin Source #

Where an undefined value came from: a client request (the harness's mark on a secret), something else memcheck named (an allocation, an uninitialised stack slot), or nothing tracked.

Constructors

ClientRequest ![Frame]
OtherOrigin !Text ![Frame]
NoOrigin

Instances

Instances details

Show Origin Source #
Instance details Defined in Vestigia.Memcheck Methods showsPrec :: Int -> Origin -> ShowS # show :: Origin -> String # showList :: [Origin] -> ShowS #
Eq Origin Source #
Instance details Defined in Vestigia.Memcheck Methods (==) :: Origin -> Origin -> Bool # (/=) :: Origin -> Origin -> Bool #

data MemError Source #

One error context.

Constructors

MemError
Fields meKind :: !Text meWhat :: !Text meStack :: ![Frame] meOrigin :: !Origin meCount :: !Int

Instances

Instances details

Show MemError Source #
Instance details Defined in Vestigia.Memcheck Methods showsPrec :: Int -> MemError -> ShowS # show :: MemError -> String # showList :: [MemError] -> ShowS #
Eq MemError Source #
Instance details Defined in Vestigia.Memcheck Methods (==) :: MemError -> MemError -> Bool # (/=) :: MemError -> MemError -> Bool #

data Memcheck Source #

A run: the tool's version, the command it ran, whether it finished, and its errors in the order reported.

Constructors

Memcheck
Fields mcVersion :: !(Maybe Text) mcCommand :: ![Text] mcFinished :: !Bool mcErrors :: ![MemError]

Instances

Instances details

Show Memcheck Source #
Instance details Defined in Vestigia.Memcheck Methods showsPrec :: Int -> Memcheck -> ShowS # show :: Memcheck -> String # showList :: [Memcheck] -> ShowS #
Eq Memcheck Source #
Instance details Defined in Vestigia.Memcheck Methods (==) :: Memcheck -> Memcheck -> Bool # (/=) :: Memcheck -> Memcheck -> Bool #

readMemcheck :: Text -> Either String Memcheck Source #

Read a memcheck XML document.