module GHC.HeapView (
GenClosure(..),
Closure,
allPtrs,
ClosureType(..),
StgInfoTable(..),
HalfWord,
getClosureData,
getBoxedClosureData,
getClosureRaw,
ppPrintClosure,
HeapTree(..),
buildHeapTree,
ppHeapTree,
HeapGraphEntry(..),
HeapGraphIndex,
HeapGraph(..),
lookupHeapGraph,
heapGraphRoot,
buildHeapGraph,
ppHeapGraph,
Box(..),
asBox,
WeakBox,
weakBox,
isAlive,
derefWeakBox,
WeakClosure,
weakenClosure,
)
where
import GHC.Exts ( Any,
Ptr(..), Addr#, Int(..), Word(..), Word#, Int#,
ByteArray#, Array#, sizeofByteArray#, sizeofArray#, indexArray#, indexWordArray#,
unsafeCoerce# )
import GHC.Arr (Array(..))
import GHC.Constants ( wORD_SIZE, tAG_MASK, wORD_SIZE_IN_BITS )
import System.IO.Unsafe ( unsafePerformIO )
import Foreign hiding ( unsafePerformIO )
import Numeric ( showHex )
import Data.Char
import Data.List
import Data.Maybe ( isJust, fromJust, catMaybes )
import System.Mem.Weak
import Data.Functor
import Data.Foldable ( Foldable )
import Data.Traversable ( Traversable )
import qualified Data.Traversable as T
import qualified Data.IntMap as M
import Control.Monad
import Control.Monad.Trans.State
import Control.Monad.Trans.Class
import Control.Monad.IO.Class
import Control.Monad.Trans.Writer.Strict
import Control.Arrow ( first, second )
#include "ghcautoconf.h"
data Box = Box Any
#if SIZEOF_VOID_P == 8
type HalfWord = Word32
#else
type HalfWord = Word16
#endif
instance Show Box where
showsPrec _ (Box a) rs =
pad_out (showHex addr "") ++ (if tag>0 then "/" ++ show tag else "") ++ rs
where
ptr = W# (aToWord# a)
tag = ptr .&. fromIntegral tAG_MASK
addr = ptr tag
pad_out ls =
'0':'x':(replicate (2*wORD_SIZE length ls) '0') ++ ls
instance Eq Box where
Box a == Box b = case reallyUnsafePtrEqualityUpToTag# a b of
0# -> False
_ -> True
asBox :: a -> Box
asBox x = Box (unsafeCoerce# x)
data StgInfoTable = StgInfoTable {
ptrs :: HalfWord,
nptrs :: HalfWord,
tipe :: ClosureType,
srtlen :: HalfWord
}
deriving (Show)
instance Storable StgInfoTable where
sizeOf itbl
= sum
[
fieldSz ptrs itbl,
fieldSz nptrs itbl,
sizeOf (undefined :: HalfWord),
fieldSz srtlen itbl
]
alignment _
= wORD_SIZE
poke _a0 _itbl
= error "Storable StgInfoTable is read-only"
peek a0
= flip (evalStateT) (castPtr a0)
$ do
ptrs' <- load
nptrs' <- load
tipe' <- load
srtlen' <- load
return
StgInfoTable {
ptrs = ptrs',
nptrs = nptrs',
tipe = toEnum (fromIntegral (tipe'::HalfWord)),
srtlen = srtlen'
}
fieldSz :: (Storable a, Storable b) => (a -> b) -> a -> Int
fieldSz sel x = sizeOf (sel x)
load :: Storable a => PtrIO a
load = do addr <- advance
lift (peek addr)
type PtrIO = StateT (Ptr Word8) IO
advance :: Storable a => PtrIO (Ptr a)
advance = StateT adv where
adv addr = case castPtr addr of { addrCast -> return
(addrCast, addr `plusPtr` sizeOfPointee addrCast) }
sizeOfPointee :: (Storable a) => Ptr a -> Int
sizeOfPointee addr = sizeOf (typeHack addr)
where typeHack = undefined :: Ptr a -> a
data ClosureType =
INVALID_OBJECT
| CONSTR
| CONSTR_1_0
| CONSTR_0_1
| CONSTR_2_0
| CONSTR_1_1
| CONSTR_0_2
| CONSTR_STATIC
| CONSTR_NOCAF_STATIC
| FUN
| FUN_1_0
| FUN_0_1
| FUN_2_0
| FUN_1_1
| FUN_0_2
| FUN_STATIC
| THUNK
| THUNK_1_0
| THUNK_0_1
| THUNK_2_0
| THUNK_1_1
| THUNK_0_2
| THUNK_STATIC
| THUNK_SELECTOR
| BCO
| AP
| PAP
| AP_STACK
| IND
| IND_PERM
| IND_STATIC
| RET_BCO
| RET_SMALL
| RET_BIG
| RET_DYN
| RET_FUN
| UPDATE_FRAME
| CATCH_FRAME
| UNDERFLOW_FRAME
| STOP_FRAME
| BLOCKING_QUEUE
| BLACKHOLE
| MVAR_CLEAN
| MVAR_DIRTY
| ARR_WORDS
| MUT_ARR_PTRS_CLEAN
| MUT_ARR_PTRS_DIRTY
| MUT_ARR_PTRS_FROZEN0
| MUT_ARR_PTRS_FROZEN
| MUT_VAR_CLEAN
| MUT_VAR_DIRTY
| WEAK
| PRIM
| MUT_PRIM
| TSO
| STACK
| TREC_CHUNK
| ATOMICALLY_FRAME
| CATCH_RETRY_FRAME
| CATCH_STM_FRAME
| WHITEHOLE
deriving (Show, Eq, Enum, Ord)
data GenClosure b =
ConsClosure {
info :: StgInfoTable
, ptrArgs :: [b]
, dataArgs :: [Word]
, pkg :: String
, modl :: String
, name :: String
} |
ThunkClosure {
info :: StgInfoTable
, ptrArgs :: [b]
, dataArgs :: [Word]
} |
SelectorClosure {
info :: StgInfoTable
, selectee :: b
} |
IndClosure {
info :: StgInfoTable
, indirectee :: b
} |
BlackholeClosure {
info :: StgInfoTable
, indirectee :: b
} |
APClosure {
info :: StgInfoTable
, arity :: HalfWord
, n_args :: HalfWord
, fun :: b
, payload :: [b]
} |
PAPClosure {
info :: StgInfoTable
, arity :: HalfWord
, n_args :: HalfWord
, fun :: b
, payload :: [b]
} |
APStackClosure {
info :: StgInfoTable
, fun :: b
, payload :: [b]
} |
BCOClosure {
info :: StgInfoTable
, instrs :: b
, literals :: b
, bcoptrs :: b
, arity :: HalfWord
, size :: HalfWord
, bitmap :: Word
} |
ArrWordsClosure {
info :: StgInfoTable
, bytes :: Word
, arrWords :: [Word]
} |
MutArrClosure {
info :: StgInfoTable
, mccPtrs :: Word
, mccSize :: Word
, mccPayload :: [b]
} |
MutVarClosure {
info :: StgInfoTable
, var :: b
} |
MVarClosure {
info :: StgInfoTable
, queueHead :: b
, queueTail :: b
, value :: b
} |
FunClosure {
info :: StgInfoTable
, ptrArgs :: [b]
, dataArgs :: [Word]
} |
BlockingQueueClosure {
info :: StgInfoTable
, link :: b
, blackHole :: b
, owner :: b
, queue :: b
} |
OtherClosure {
info :: StgInfoTable
, hvalues :: [b]
, rawWords :: [Word]
} |
UnsupportedClosure {
info :: StgInfoTable
}
deriving (Show, Functor, Foldable, Traversable)
type Closure = GenClosure Box
allPtrs :: GenClosure b -> [b]
allPtrs (ConsClosure {..}) = ptrArgs
allPtrs (ThunkClosure {..}) = ptrArgs
allPtrs (SelectorClosure {..}) = [selectee]
allPtrs (IndClosure {..}) = [indirectee]
allPtrs (BlackholeClosure {..}) = [indirectee]
allPtrs (APClosure {..}) = fun:payload
allPtrs (PAPClosure {..}) = fun:payload
allPtrs (APStackClosure {..}) = fun:payload
allPtrs (BCOClosure {..}) = [instrs,literals,bcoptrs]
allPtrs (ArrWordsClosure {..}) = []
allPtrs (MutArrClosure {..}) = mccPayload
allPtrs (MutVarClosure {..}) = [var]
allPtrs (MVarClosure {..}) = [queueHead,queueTail,value]
allPtrs (FunClosure {..}) = ptrArgs
allPtrs (BlockingQueueClosure {..}) = [link, blackHole, owner, queue]
allPtrs (OtherClosure {..}) = hvalues
allPtrs (UnsupportedClosure {..}) = []
#ifdef PRIM_SUPPORTS_ANY
foreign import prim "aToWordzh" aToWord# :: Any -> Word#
foreign import prim "slurpClosurezh" slurpClosure# :: Any -> (# Addr#, ByteArray#, Array# b #)
foreign import prim "reallyUnsafePtrEqualityUpToTag" reallyUnsafePtrEqualityUpToTag# :: Any -> Any -> Int#
#else
foreign import prim "slurpClosurezh" slurpClosure'# :: Word# -> (# Addr#, ByteArray#, Array# b #)
foreign import prim "reallyUnsafePtrEqualityUpToTag" reallyUnsafePtrEqualityUpToTag'# :: Word# -> Word# -> Int#
data Ptr' a = Ptr' a
aToWord# :: Any -> Word#
aToWord# a = case Ptr' a of mb@(Ptr' _) -> case unsafeCoerce# mb :: Word of W# addr -> addr
slurpClosure# :: Any -> (# Addr#, ByteArray#, Array# b #)
slurpClosure# a = slurpClosure'# (aToWord# a)
reallyUnsafePtrEqualityUpToTag# :: Any -> Any -> Int#
reallyUnsafePtrEqualityUpToTag# a b = reallyUnsafePtrEqualityUpToTag'# (aToWord# a) (aToWord# b)
#endif
getClosureRaw :: a -> IO (Ptr StgInfoTable, [Word], [Box])
getClosureRaw x =
case slurpClosure# (unsafeCoerce# x) of
(# iptr, dat, ptrs #) -> do
let nelems = (I# (sizeofByteArray# dat)) `div` wORD_SIZE
rawWords = [W# (indexWordArray# dat i) | I# i <- [0.. fromIntegral nelems 1] ]
pelems = I# (sizeofArray# ptrs)
ptrList = amap' Box $ Array 0 (pelems 1) pelems ptrs
ptrList `seq` rawWords `seq` return (Ptr iptr, rawWords, ptrList)
amap' :: (t -> b) -> Array Int t -> [b]
amap' f (Array i0 i _ arr#) = map g [0 .. i i0]
where g (I# i#) = case indexArray# arr# i# of
(# e #) -> f e
dataConInfoPtrToNames :: Ptr StgInfoTable -> IO (String, String, String)
dataConInfoPtrToNames ptr = do
conDescAddress <- getConDescAddress ptr
wl <- peekArray0 0 conDescAddress
let (pkg, modl, name) = parse wl
return (b2s pkg, b2s modl, b2s name)
where
b2s :: [Word8] -> String
b2s = fmap (chr . fromIntegral)
getConDescAddress :: Ptr StgInfoTable -> IO (Ptr Word8)
getConDescAddress ptr'
| True = do
offsetToString <- peek (ptr' `plusPtr` (negate wORD_SIZE))
return $ (ptr' `plusPtr` stdInfoTableSizeB)
`plusPtr` (fromIntegral (offsetToString :: Word))
opt_SccProfilingOn = False
stdInfoTableSizeW :: Int
stdInfoTableSizeW
= size_fixed + size_prof
where
size_fixed = 2
size_prof | opt_SccProfilingOn = 2
| otherwise = 0
stdInfoTableSizeB :: Int
stdInfoTableSizeB = stdInfoTableSizeW * wORD_SIZE
parse :: [Word8] -> ([Word8], [Word8], [Word8])
parse input = if not . all (>0) . fmap length $ [pkg,modl,occ]
then ([], [], input)
else (pkg, modl, occ)
where
(pkg, rest1) = break (== fromIntegral (ord ':')) input
(modl, occ)
= (concat $ intersperse [dot] $ reverse modWords, occWord)
where
(modWords, occWord) = if (length rest1 < 1)
then parseModOcc [] []
else parseModOcc [] (tail rest1)
dot = fromIntegral (ord '.')
parseModOcc :: [[Word8]] -> [Word8] -> ([[Word8]], [Word8])
parseModOcc acc str
= case break (== dot) str of
(top, []) -> (acc, top)
(top, _:bot) -> parseModOcc (top : acc) bot
getClosureData :: a -> IO Closure
getClosureData x = do
(iptr, wds, ptrs) <- getClosureRaw x
itbl <- peek iptr
case tipe itbl of
t | t >= CONSTR && t <= CONSTR_NOCAF_STATIC -> do
(pkg, modl, name) <- dataConInfoPtrToNames iptr
return $ ConsClosure itbl ptrs (drop (length ptrs + 1) wds) pkg modl name
t | t >= THUNK && t <= THUNK_STATIC -> do
return $ ThunkClosure itbl ptrs (drop (length ptrs + 2) wds)
t | t >= FUN && t <= FUN_STATIC -> do
return $ FunClosure itbl ptrs (drop (length ptrs + 1) wds)
AP ->
return $ APClosure itbl
(fromIntegral $ wds !! 2)
(fromIntegral $ shiftR (wds !! 2) (wORD_SIZE_IN_BITS `div` 2))
(head ptrs) (tail ptrs)
PAP ->
return $ PAPClosure itbl
(fromIntegral $ wds !! 2)
(fromIntegral $ shiftR (wds !! 2) (wORD_SIZE_IN_BITS `div` 2))
(head ptrs) (tail ptrs)
AP_STACK ->
return $ APStackClosure itbl (head ptrs) (tail ptrs)
THUNK_SELECTOR ->
return $ SelectorClosure itbl (head ptrs)
IND ->
return $ IndClosure itbl (head ptrs)
IND_STATIC ->
return $ IndClosure itbl (head ptrs)
BLACKHOLE ->
return $ BlackholeClosure itbl (head ptrs)
BCO ->
return $ BCOClosure itbl (ptrs !! 0) (ptrs !! 1) (ptrs !! 2)
(fromIntegral $ wds !! 4)
(fromIntegral $ shiftR (wds !! 4) (wORD_SIZE_IN_BITS `div` 2))
(wds !! 5)
ARR_WORDS ->
return $ ArrWordsClosure itbl (wds !! 1) (drop 2 wds)
t | t == MUT_ARR_PTRS_FROZEN || t == MUT_ARR_PTRS_FROZEN0 ->
return $ MutArrClosure itbl (wds !! 1) (wds !! 2) ptrs
t | t == MUT_VAR_CLEAN || t == MUT_VAR_DIRTY ->
return $ MutVarClosure itbl (head ptrs)
t | t == MVAR_CLEAN || t == MVAR_DIRTY ->
return $ MVarClosure itbl (ptrs !! 0) (ptrs !! 1) (ptrs !! 2)
BLOCKING_QUEUE ->
return $ OtherClosure itbl ptrs wds
_ ->
return $ UnsupportedClosure itbl
getBoxedClosureData :: Box -> IO Closure
getBoxedClosureData (Box a) = getClosureData a
isChar :: GenClosure b -> Maybe Char
isChar (ConsClosure { name = "C#", dataArgs = [ch], ptrArgs = []}) = Just (chr (fromIntegral ch))
isChar _ = Nothing
isCons :: GenClosure b -> Maybe (b, b)
isCons (ConsClosure { name = ":", dataArgs = [], ptrArgs = [h,t]}) = Just (h,t)
isCons _ = Nothing
isTup :: GenClosure b -> Maybe [b]
isTup (ConsClosure { dataArgs = [], ..}) =
if length name >= 3 &&
head name == '(' && last name == ')' &&
all (==',') (tail (init name))
then Just ptrArgs else Nothing
isTup _ = Nothing
isNil :: GenClosure b -> Bool
isNil (ConsClosure { name = "[]", dataArgs = [], ptrArgs = []}) = True
isNil _ = False
ppPrintClosure :: (Int -> b -> String) -> Int -> GenClosure b -> String
ppPrintClosure showBox prec c = case c of
_ | Just ch <- isChar c -> app $
["C#", show ch]
_ | Just (h,t) <- isCons c -> addBraces (5 <= prec) $
showBox 5 h ++ " : " ++ showBox 4 t
_ | Just vs <- isTup c ->
"(" ++ intercalate "," (map (showBox 0) vs) ++ ")"
ConsClosure {..} -> app $
name : map (showBox 10) ptrArgs ++ map show dataArgs
ThunkClosure {..} -> app $
"_thunk" : map (showBox 10) ptrArgs ++ map show dataArgs
SelectorClosure {..} -> app
["_sel", showBox 10 selectee]
IndClosure {..} -> app
["_ind", showBox 10 indirectee]
BlackholeClosure {..} -> app
["_bh", showBox 10 indirectee]
APClosure {..} -> app $ map (showBox 10) $
fun : payload
PAPClosure {..} -> app $ map (showBox 10) $
fun : payload
APStackClosure {..} -> app $ map (showBox 10) $
fun : payload
BCOClosure {..} -> app
["_bco"]
ArrWordsClosure {..} -> app
["toArray", intercalate "," (map show arrWords) ]
MutArrClosure {..} -> app
["toMutArray", intercalate "," (map (showBox 10) mccPayload)]
MutVarClosure {..} -> app $
["_mutVar", (showBox 10) var]
MVarClosure {..} -> app $
["MVar", (showBox 10) value]
FunClosure {..} ->
"_fun" ++ braceize (map (showBox 0) ptrArgs ++ map show dataArgs)
BlockingQueueClosure {..} ->
"_blockingQueue"
OtherClosure {..} ->
"_other"
UnsupportedClosure {..} ->
"_unsupported"
where
addBraces True t = "(" ++ t ++ ")"
addBraces False t = t
app [] = "()"
app [a] = a
app xs = addBraces (10 <= prec) (intercalate " " xs)
braceize [] = ""
braceize xs = "{" ++ intercalate "," xs ++ "}"
data HeapTree = HeapTree WeakBox (GenClosure HeapTree) | EndOfHeapTree
heapTreeClosure :: HeapTree -> Maybe (GenClosure HeapTree)
heapTreeClosure (HeapTree _ c) = Just c
heapTreeClosure EndOfHeapTree = Nothing
buildHeapTree :: Int -> Box -> IO HeapTree
buildHeapTree 0 _ = do
return $ EndOfHeapTree
buildHeapTree n b = do
w <- weakBox b
c <- getBoxedClosureData b
c' <- T.mapM (buildHeapTree (n1)) c
return $ HeapTree w c'
ppHeapTree :: HeapTree -> String
ppHeapTree = go 0
where
go _ EndOfHeapTree = "..."
go prec t@(HeapTree _ c')
| Just s <- isHeapTreeString t = show s
| Just l <- isHeapTreeList t = "[" ++ intercalate "," (map ppHeapTree l) ++ "]"
| otherwise = ppPrintClosure go prec c'
isHeapTreeList :: HeapTree -> Maybe ([HeapTree])
isHeapTreeList tree = do
c <- heapTreeClosure tree
if isNil c
then return []
else do
(h,t) <- isCons c
t' <- isHeapTreeList t
return $ (:) h t'
isHeapTreeString :: HeapTree -> Maybe String
isHeapTreeString t = do
list <- isHeapTreeList t
if (null list)
then Nothing
else mapM (isChar <=< heapTreeClosure) list
data HeapGraphEntry = HeapGraphEntry WeakBox (GenClosure (Maybe HeapGraphIndex))
deriving (Show)
type HeapGraphIndex = Int
newtype HeapGraph = HeapGraph (M.IntMap HeapGraphEntry)
deriving (Show)
lookupHeapGraph :: HeapGraphIndex -> HeapGraph -> Maybe HeapGraphEntry
lookupHeapGraph i (HeapGraph m) = M.lookup i m
heapGraphRoot :: HeapGraphIndex
heapGraphRoot = 0
buildHeapGraph :: Int -> Box -> IO HeapGraph
buildHeapGraph limit initialBox = do
let initialState = ([], [0..])
HeapGraph <$> execWriterT (runStateT (add limit initialBox) initialState)
where
add 0 _ = return Nothing
add n b = do
(existing,_) <- get
case lookup b existing of
Just i -> return $ Just i
Nothing -> do
i <- nextI
modify (first ((b,i):))
c <- liftIO $ getBoxedClosureData b
c' <- T.mapM (add (n1)) c
w <- liftIO $ weakBox b
lift $ tell (M.singleton i (HeapGraphEntry w c'))
return $ Just i
nextI = do
i <- gets (head . snd)
modify (second tail)
return i
ppHeapGraph :: HeapGraph -> String
ppHeapGraph (HeapGraph m) = letWrapper ++ ppRef 0 (Just heapGraphRoot)
where
bindings = boundMultipleTimes (HeapGraph m) [heapGraphRoot]
letWrapper =
if null bindings
then ""
else "let " ++ intercalate "\n " (map ppBinding bindings) ++ "\nin "
ppBinding i = "x" ++ show i ++ " = " ++ ppEntry 0 (iToE i)
ppEntry prec e@(HeapGraphEntry _ c)
| Just s <- isString e = show s
| Just l <- isList e = "[" ++ intercalate "," (map (ppRef 0) l) ++ "]"
| otherwise = ppPrintClosure ppRef prec c
ppRef _ Nothing = "..."
ppRef prec (Just i) | i `elem` bindings = "x" ++ show i
| otherwise = ppEntry prec (iToE i)
iToE i = fromJust (M.lookup i m)
iToUnboundE i = if i `elem` bindings then Nothing else M.lookup i m
isList :: HeapGraphEntry -> Maybe ([Maybe HeapGraphIndex])
isList (HeapGraphEntry _ c) =
if isNil c
then return []
else do
(h,t) <- isCons c
ti <- t
e <- iToUnboundE ti
t' <- isList e
return $ (:) h t'
isString :: HeapGraphEntry -> Maybe String
isString e = do
list <- isList e
if (null list)
then Nothing
else mapM (isChar . (\(HeapGraphEntry _ c) -> c) <=< iToUnboundE <=< id) list
boundMultipleTimes :: HeapGraph -> [HeapGraphIndex] -> [HeapGraphIndex]
boundMultipleTimes (HeapGraph m) roots = map head $ filter (not.null) $ map tail $ group $ sort $
roots ++ concatMap (\(HeapGraphEntry _ c) -> catMaybes (allPtrs c)) (M.elems m)
newtype WeakBox = WeakBox (Weak Box)
type WeakClosure = GenClosure WeakBox
instance Show WeakBox where
showsPrec p (WeakBox w) rs = case unsafePerformIO (deRefWeak w) of
Nothing -> let txt = "(freed)" in
replicate (2*wORD_SIZE length txt) ' ' ++ txt ++ rs
Just b -> showsPrec p b rs
weakBox :: Box -> IO WeakBox
weakBox b@(Box a) = WeakBox `fmap` mkWeak a b Nothing
isAlive :: WeakBox -> IO Bool
isAlive (WeakBox w) = isJust `fmap` deRefWeak w
derefWeakBox :: WeakBox -> IO (Maybe Box)
derefWeakBox (WeakBox w) = deRefWeak w
weakenClosure :: Closure -> IO WeakClosure
weakenClosure = T.mapM weakBox