module GHC.HeapView (
Closure(..),
allPtrs,
ClosureType(..),
StgInfoTable(..),
HalfWord,
getClosureData,
getBoxedClosureData,
getClosureRaw,
Box(..),
asBox,
)
where
import GHC.Exts
import GHC.Arr (Array(..))
import GHC.Constants ( wORD_SIZE, tAG_MASK, wORD_SIZE_IN_BITS )
import Foreign
import Numeric ( showHex )
import Data.Char
import Data.List ( intersperse )
data Box = Box Any
type HalfWord = Word32
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 reallyUnsafePtrEquality# a b of
1# -> True
_ -> False
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
= runState (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 = State (Ptr Word8) IO
advance :: Storable a => PtrIO (Ptr a)
advance = State adv where
adv addr = case castPtr addr of { addrCast -> return
(addr `plusPtr` sizeOfPointee addrCast, addrCast) }
sizeOfPointee :: (Storable a) => Ptr a -> Int
sizeOfPointee addr = sizeOf (typeHack addr)
where typeHack = undefined :: Ptr a -> a
newtype State s m a = State (s -> m (s, a))
instance Monad m => Monad (State s m) where
return a = State (\s -> return (s, a))
State m >>= k = State (\s -> m s >>= \(s', a) -> case k a of State n -> n s')
fail str = State (\_ -> fail str)
lift :: Monad m => m a -> State s m a
lift m = State (\s -> m >>= \a -> return (s, a))
runState :: (Monad m) => s -> State s m a -> m a
runState s (State m) = m s >>= return . snd
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 Closure =
ConsClosure {
info :: StgInfoTable
, ptrArgs :: [Box]
, dataArgs :: [Word]
, pkg :: String
, modl :: String
, name :: String
} |
ThunkClosure {
info :: StgInfoTable
, ptrArgs :: [Box]
, dataArgs :: [Word]
} |
SelectorClosure {
info :: StgInfoTable
, selectee :: Box
} |
IndClosure {
info :: StgInfoTable
, indirectee :: Box
} |
BlackholeClosure {
info :: StgInfoTable
, indirectee :: Box
} |
APClosure {
info :: StgInfoTable
, arity :: HalfWord
, n_args :: HalfWord
, fun :: Box
, payload :: [Box]
} |
PAPClosure {
info :: StgInfoTable
, arity :: HalfWord
, n_args :: HalfWord
, fun :: Box
, payload :: [Box]
} |
BCOClosure {
info :: StgInfoTable
, instrs :: Box
, literals :: Box
, bcoptrs :: Box
, arity :: HalfWord
, size :: HalfWord
, bitmap :: Word
} |
ArrWordsClosure {
info :: StgInfoTable
, bytes :: Word
, arrWords :: [Word]
} |
MutArrClosure {
info :: StgInfoTable
, mccPtrs :: Word
, mccSize :: Word
, mccPayload :: [Box]
} |
MutVarClosure {
info :: StgInfoTable
, var :: Box
} |
MVarClosure {
info :: StgInfoTable
, queueHead :: Box
, queueTail :: Box
, value :: Box
} |
FunClosure {
info :: StgInfoTable
, ptrArgs :: [Box]
, dataArgs :: [Word]
} |
BlockingQueueClosure {
info :: StgInfoTable
, link :: Box
, blackHole :: Box
, owner :: Box
, queue :: Box
} |
OtherClosure {
info :: StgInfoTable
, hvalues :: [Box]
, rawWords :: [Word]
}
deriving (Show)
allPtrs :: Closure -> [Box]
allPtrs (ConsClosure {..}) = ptrArgs
allPtrs (ThunkClosure {..}) = ptrArgs
allPtrs (SelectorClosure {..}) = [selectee]
allPtrs (IndClosure {..}) = [indirectee]
allPtrs (BlackholeClosure {..}) = [indirectee]
allPtrs (APClosure {..}) = fun:payload
allPtrs (PAPClosure {..}) = 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
#ifdef PRIM_SUPPORTS_ANY
foreign import prim "aToWordzh" aToWord# :: Any -> Word#
foreign import prim "slurpClosurezh" slurpClosure# :: Any -> (# Addr#, ByteArray#, Array# b #)
#else
foreign import prim "slurpClosurezh" slurpClosure'# :: Word# -> (# Addr#, ByteArray#, Array# b #)
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)
#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)
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
closure -> error $ "getClosureData: Cannot handle closure type " ++ show closure
getBoxedClosureData :: Box -> IO Closure
getBoxedClosureData (Box a) = getClosureData a