module GHC.Vacuum (
HNodeId
,HNode(..)
,emptyHNode
,vacuum,vacuumTo,vacuumLazy
,dump,dumpTo,dumpLazy
,toAdjList
,nameGraph
,ShowHNode(..)
,showHNodes
,ppHs,ppDot
,Draw(..),G(..)
,draw,printDraw,split
,Closure(..)
,InfoTab(..)
,getClosure
,closureType
,getInfoTab
,getInfoPtr
,peekInfoTab
,nodePkg,nodeMod
,nodeName,itabName
,HValue
) where
import Prelude hiding(catch)
import GHC.Vacuum.Dot as Dot
import GHC.Vacuum.ClosureType
import GHC.Vacuum.Internal as GHC
import Data.Char
import Data.Word
import Data.List
import Data.Map(Map)
import Data.IntMap(IntMap)
import qualified Data.IntMap as IM
import qualified Data.Map as M
import Data.Monoid(Monoid(..))
import Data.Array.IArray
import System.IO.Unsafe
import Control.Monad
import Data.Bits
import Text.PrettyPrint(Doc,text)
import Language.Haskell.Meta.Utils(pretty)
import Control.Applicative
import Control.Exception
import Foreign
import GHC.Arr(Array(..))
import GHC.Exts
vacuum :: a -> IntMap HNode
vacuum a = unsafePerformIO (dump a)
vacuumTo :: Int -> a -> IntMap HNode
vacuumTo n a = unsafePerformIO (dumpTo n a)
vacuumLazy :: a -> IntMap HNode
vacuumLazy a = unsafePerformIO (dumpLazy a)
dump :: a -> IO (IntMap HNode)
dump a = execH (dumpH a)
dumpTo :: Int -> a -> IO (IntMap HNode)
dumpTo n a = execH (dumpToH n a)
dumpLazy :: a -> IO (IntMap HNode)
dumpLazy a = execH (dumpLazyH a)
toAdjList :: IntMap HNode -> [(Int, [Int])]
toAdjList = fmap (mapsnd nodePtrs) . IM.toList
nameGraph :: IntMap HNode -> [(String, [String])]
nameGraph m = let g = toAdjList m
pp i = maybe "..."
(\n -> nodeName n ++ "|" ++ show i)
(IM.lookup i m)
in fmap (\(x,xs) -> (pp x, fmap pp xs)) g
data ShowHNode = ShowHNode
{showHNode :: Int -> HNode -> String
,externHNode :: Int -> String}
showHNodes :: ShowHNode -> IntMap HNode -> [(String, [String])]
showHNodes (ShowHNode showN externN) m
= let g = toAdjList m
pp i = maybe (externN i) (showN i) (IM.lookup i m)
in fmap (\(x,xs) -> (pp x, fmap pp xs)) g
ppHs :: (Show a) => a -> Doc
ppHs = text . pretty
ppDot :: [(String, [String])] -> Doc
ppDot = Dot.graphToDot id
type HNodeId = Int
data HNode = HNode
{nodePtrs :: [HNodeId]
,nodeLits :: [Word]
,nodeInfo :: InfoTab}
deriving(Eq,Ord,Read,Show)
data InfoTab
= ConInfo {itabPkg :: String
,itabMod :: String
,itabCon :: String
,itabPtrs :: Word
,itabLits :: Word
,itabType :: ClosureType
,itabSrtLen :: Word
,itabCode :: [Word]}
| OtherInfo {itabPtrs :: Word
,itabLits :: Word
,itabType :: ClosureType
,itabSrtLen :: Word
,itabCode :: [Word]}
deriving(Eq,Ord,Read,Show)
data Closure = Closure
{closPtrs :: [HValue]
,closLits :: [Word]
,closITab :: InfoTab}
deriving(Show)
instance Show HValue where show _ = "(HValue)"
data Draw e v m a = Draw
{mkV :: Int -> a -> m v
,mkE :: v -> v -> m e
,succs :: a -> [Int]}
newtype G e v = G {unG :: IntMap (v, IntMap e)}
deriving(Eq,Ord,Read,Show)
draw :: (Monad m) => Draw e v m a -> IntMap a -> m (G e v)
draw (Draw mkV mkE succs) g = do
vs <- IM.fromList `liftM` forM (IM.toList g)
(\(i,a) -> do v <- mkV i a
return (i,(v,succs a)))
(G . IM.fromList) `liftM` forM (IM.toList vs)
(\(i,(v,ps)) -> do let us = fmap (vs IM.!) ps
es <- IM.fromList `liftM` forM ps
(\p -> do e <- mkE v (fst (vs IM.! p))
return (p,e))
return (i,(v,es)))
printDraw :: Draw (Int,Int) Int IO HNode
printDraw = Draw
{mkV = \i _ -> print i >> return i
,mkE = \u v -> print (u,v) >> return (u,v)
,succs = nodePtrs}
split :: (a -> [Int]) -> IntMap a -> IntMap ([Int],[Int])
split f = flip IM.foldWithKey mempty (\i a m ->
let ps = f a
in foldl' (\m p -> IM.insertWith mappend p ([i],[]) m)
(IM.insertWith mappend i ([],ps) m)
ps)
emptyHNode :: ClosureType -> HNode
emptyHNode ct = HNode
{nodePtrs = []
,nodeLits = []
,nodeInfo = if isCon ct
then ConInfo [] [] [] 0 0 ct 0 []
else OtherInfo 0 0 ct 0 []}
nodePkg :: HNode -> String
nodeMod :: HNode -> String
nodeName :: HNode -> String
nodePkg = fst3 . itabName . nodeInfo
nodeMod = snd3 . itabName . nodeInfo
nodeName = trd3 . itabName . nodeInfo
fst3 (x,_,_) = x
snd3 (_,x,_) = x
trd3 (_,_,x) = x
itabName :: InfoTab -> (String, String, String)
itabName i@(ConInfo{}) = (itabPkg i, itabMod i, itabCon i)
itabName _ = ([], [], [])
getInfoPtr :: a -> Ptr StgInfoTable
getInfoPtr a = let b = a `seq` Box a
in b `seq` case unpackClosure# a of
(# iptr,_,_ #)
| ghciTablesNextToCode -> Ptr iptr
| otherwise -> Ptr iptr `plusPtr`
negate wORD_SIZE
defined :: HValue -> IO HValue
defined a = grab (return $! a) (return . unsafeCoerce#)
grab :: IO a -> (SomeException -> IO a) -> IO a
grab = catch
getClosure :: a -> IO Closure
getClosure a = grab (getClosure_ a) getClosure
getClosure_ :: a -> IO Closure
getClosure_ a =
case unpackClosure# a of
(# iptr
,ptrs
,nptrs #) -> do
let iptr' | ghciTablesNextToCode = Ptr iptr
| otherwise = Ptr iptr `plusPtr` negate wORD_SIZE
itab <- peekInfoTab iptr'
let elems = fromIntegral (itabPtrs itab)
ptrs0 = if elems < 1
then []
else dumpArray (Array 0 (elems 1) elems ptrs)
lits = [W# (indexWordArray# nptrs i)
| I# i <- [0.. fromIntegral (itabLits itab1)] ]
return (Closure ptrs0 lits itab)
closureType :: a -> IO ClosureType
closureType a = itabType <$> getInfoTab a
getInfoTab :: a -> IO InfoTab
getInfoTab a =
case unpackClosure# a of
(# iptr
,_
,_ #) -> do
let iptr' | ghciTablesNextToCode = Ptr iptr
| otherwise = Ptr iptr `plusPtr` negate wORD_SIZE
peekInfoTab iptr'
peekInfoTab :: Ptr StgInfoTable -> IO InfoTab
peekInfoTab p = do
stg <- peek p
let ct = (toEnum . fromIntegral . GHC.tipe) stg
case ct of
_ | hasName stg -> do (a,b,c) <- dataConInfoPtrToNames (castPtr p)
return $ ConInfo
{itabPkg = a
,itabMod = b
,itabCon = c
,itabPtrs = (fromIntegral . GHC.ptrs) stg
,itabLits = (fromIntegral . GHC.nptrs) stg
,itabType = ct
,itabSrtLen = fromIntegral (GHC.srtlen stg)
,itabCode = fmap fromIntegral (GHC.code stg)}
_ -> return $ OtherInfo
{itabPtrs = (fromIntegral . GHC.ptrs) stg
,itabLits = (fromIntegral . GHC.nptrs) stg
,itabType = ct
,itabSrtLen = fromIntegral (GHC.srtlen stg)
,itabCode = fmap fromIntegral (GHC.code stg)}
hasName :: StgInfoTable -> Bool
hasName stg = let ct = (toEnum . fromIntegral . GHC.tipe) stg :: ClosureType
lits = (fromIntegral . GHC.nptrs) stg :: Int
ptrs = (fromIntegral . GHC.ptrs) stg :: Int
in isCon ct
&& lits < 1024
&& ptrs < 1024
type H a = S Env a
execH :: H a -> IO (IntMap HNode)
execH m = snd `fmap` runH m
runH :: H a -> IO (a, IntMap HNode)
runH m = do
(a, s) <- runS m emptyEnv
return (a, graph s)
data Env = Env
{uniq :: HNodeId
,seen :: [(HValue, HNodeId)]
,hvals :: IntMap HValue
,graph :: IntMap HNode}
emptyEnv :: Env
emptyEnv = Env
{uniq = 0
,seen = []
,hvals = mempty
,graph = mempty}
dumpH :: a -> H ()
dumpH a = go =<< rootH a
where go :: HValue -> H ()
go a = do
ids <- nodeH a
case ids of
[] -> return ()
_ -> mapM_ go =<< mapM getHVal ids
dumpToH :: Int -> a -> H ()
dumpToH n _ | n < 1 = return ()
dumpToH n a = go (n1) =<< rootH a
where go :: Int -> HValue -> H ()
go 0 _ = return ()
go n a = do
ids <- nodeH a
case ids of
[] -> return ()
_ -> mapM_ (go (n1)) =<< mapM getHVal ids
dumpLazyH :: a -> H ()
dumpLazyH !a = go =<< rootH a
where go :: HValue -> H ()
go a = do
ids <- nodeLazyH a
case ids of
[] -> return ()
_ -> mapM_ go =<< mapM getHVal ids
data Box a = Box a
rootH :: a -> H HValue
rootH a = do
let b = Box a
c <- io (getClosure $! b)
case closPtrs c of
[hval] -> io (defined hval)
_ -> error "zomg"
nodeH :: HValue -> H [HNodeId]
nodeH a = do
clos <- io (getClosure $! a)
(i, _) <- getId a
let itab = closITab clos
ptrs = closPtrs clos
ptrs' <- case itabType itab of
t | isCon t -> return (avoid (itabCon itab) ptrs)
| otherwise -> return ptrs
ptrs'' <- io (mapM defined ptrs')
xs <- mapM getId ptrs''
let news = (fmap fst . fst . partition snd) xs
n = HNode (fmap fst xs)
(closLits clos)
(closITab clos)
insertG i n
return news
nodeLazyH :: HValue -> H [HNodeId]
nodeLazyH a = do
clos <- io (getClosure a)
(i, _) <- getId a
let itab = closITab clos
ptrs = closPtrs clos
ptrs' <- case itabType itab of
t | isCon t -> return (avoid (itabCon itab) ptrs)
| isThunk t -> return []
| otherwise -> return ptrs
xs <- mapM getIdLazy ptrs'
let news = (fmap fst . fst . partition snd) xs
n = HNode (fmap fst xs)
(closLits clos)
(closITab clos)
insertG i n
return news
avoid :: String -> [HValue] -> [HValue]
avoid con = maybe id id (IM.lookup (hash con) criminals)
criminals :: IntMap ([HValue] -> [HValue])
criminals = IM.fromList . fmap (mapfst hash) $
[("J#", const [])
,("MVar", const [])
,("STRef", const [])
,("Array", take 2)
,("MallocPtr", const [])
,("PlainPtr", const [])
,("PS", drop 1)
,("Chunk", drop 1)
,("FileHandle", take 1)
,("DuplexHandle", take 1)
]
hash :: String -> Int
hash [] = 0
hash s = go 0 (fmap ord s)
where go !h [] = h
go !h (n:ns) =
let a = (h `shiftL` 4)
b = a + n
c = b .&. 0xf0000000
!d = case c==0 of
False -> let !e = c `shiftR` 24
in b `xor` e
True -> b
!e = complement c
!f = d `xor` e
in go f ns
getHVal :: HNodeId -> H HValue
getHVal i = (IM.! i) `fmap` gets hvals
insertG :: HNodeId -> HNode -> H ()
insertG i n = do
g <- gets graph
modify (\e->e{graph = IM.insert i n g})
newId :: H HNodeId
newId = do
n <- gets uniq
modify (\e->e{uniq=n+1})
return n
getId :: HValue -> H (HNodeId, Bool)
getId hval = hval `seq` do
s <- gets seen
case look hval s of
Just i -> return (i, False)
Nothing -> do
i <- newId
vs <- gets hvals
modify (\e->e{seen=(hval,i):s
,hvals= IM.insert i hval vs})
return (i, True)
getIdLazy :: HValue -> H (HNodeId, Bool)
getIdLazy hval = do
s <- gets seen
case lookLazy hval s of
Just i -> return (i, False)
Nothing -> do
i <- newId
vs <- gets hvals
modify (\e->e{seen=(hval,i):s
,hvals= IM.insert i hval vs})
return (i, True)
look :: HValue -> [(HValue, a)] -> Maybe a
look _ [] = Nothing
look hval ((x,i):xs)
| hval .==. x = Just i
| otherwise = look hval xs
(.==.) :: HValue -> HValue -> Bool
a .==. b = a `seq` b `seq`
(0 /= I# (reallyUnsafePtrEquality# a b))
lookLazy :: HValue -> [(HValue, a)] -> Maybe a
lookLazy _ [] = Nothing
lookLazy hval ((x,i):xs)
| hval =.= x = Just i
| otherwise = lookLazy hval xs
(=.=) :: HValue -> HValue -> Bool
a =.= b = (0 /= I# (reallyUnsafePtrEquality# a b))
dumpArray :: Array Int a -> [a]
dumpArray a = let (m,n) = bounds a
in fmap (a!) [m..n]
mapfst f = \(a,b) -> (f a,b)
mapsnd f = \(a,b) -> (a,f b)
f *** g = \(a, b) -> (f a, g b)
p2i :: Ptr a -> Int
i2p :: Int -> Ptr a
p2i (Ptr a#) = I# (addr2Int# a#)
i2p (I# n#) = Ptr (int2Addr# n#)