Mate/BasicBlocks.hs

   1 {-# LANGUAGE CPP #-}
   2 {-# LANGUAGE OverloadedStrings #-}
   3 #include "debug.h"
   4 module Mate.BasicBlocks(
   5   BlockID,
   6   BasicBlock,
   7   BBEnd,
   8   MapBB,
   9   Method,
  10 #ifdef DBG_BB
  11   printMapBB,
  12 #endif
  13   parseMethod,
  14   testCFG -- added by hs to perform benches from outside
  15   )where
  16
  17 import Data.Binary
  18 import Data.Int
  19 import Data.List
  20 import qualified Data.Map as M
  21 import qualified Data.ByteString.Lazy as B
  22
  23 import JVM.ClassFile
  24 import JVM.Converter
  25 import JVM.Assembler
  26
  27 import Mate.Types
  28 import Mate.Debug
  29 import Mate.Utilities
  30
  31 #ifdef DEBUG
  32 import Text.Printf
  33 #endif
  34
  35 -- for immediate representation to determine BBs
  36 type Offset = (Int, Maybe BBEnd) -- (offset in bytecode, offset to jump target)
  37 type OffIns = (Offset, Instruction)
  38
  39
  40 #ifdef DBG_BB
  41 printMapBB :: MapBB -> IO ()
  42 printMapBB hmap = do
  43   putStr "BlockIDs: "
  44   let keys = M.keys hmap
  45   mapM_ (putStr . (flip (++)) ", " . show) keys
  46   putStrLn "\n\nBasicBlocks:"
  47   printMapBB' keys hmap
  48     where
  49       printMapBB' :: [BlockID] -> MapBB -> IO ()
  50       printMapBB' [] _ = return ()
  51       printMapBB' (i:is) hmap' = case M.lookup i hmap' of
  52         Just bb -> do
  53           putStrLn $ "Block " ++ (show i)
  54           mapM_ putStrLn (map ((++) "\t" . show) $ code bb)
  55           case successor bb of
  56             Return -> putStrLn ""
  57             FallThrough t1 -> putStrLn $ "Sucessor: " ++ (show t1) ++ "\n"
  58             OneTarget t1 -> putStrLn $ "Sucessor: " ++ (show t1) ++ "\n"
  59             TwoTarget t1 t2 -> putStrLn $ "Sucessor: " ++ (show t1) ++ ", " ++ (show t2) ++ "\n"
  60           printMapBB' is hmap
  61         Nothing -> error $ "BlockID " ++ show i ++ " not found."
  62 #endif
  63
  64 #if 0
  65 #ifdef DBG_BB
  66 testInstance :: String -> B.ByteString -> MethodSignature -> IO ()
  67 testInstance cf method sig = do
  68   cls <- parseClassFile cf
  69   hmap <- parseMethod cls method sig
  70   printMapBB hmap
  71 #endif
  72
  73 #ifdef DBG_BB
  74 test_main :: IO ()
  75 test_main = do
  76   test_01
  77   test_02
  78   test_03
  79   test_04
  80
  81 test_01, test_02, test_03, test_04 :: IO ()
  82 test_01 = testInstance "./tests/Fib.class" "fib"
  83 test_02 = testInstance "./tests/While.class" "f"
  84 test_03 = testInstance "./tests/While.class" "g"
  85 test_04 = testInstance "./tests/Fac.class" "fac"
  86 #endif
  87 #endif
  88
  89
  90 parseMethod :: Class Direct -> B.ByteString -> MethodSignature -> IO (Maybe RawMethod)
  91 parseMethod cls method sig = do
  92   let maybe_bb = testCFG $ lookupMethodSig method sig cls
  93   let msig = methodSignature $ classMethods cls !! 1
  94   printfBb "BB: analysing \"%s\"\n" $ toString (method `B.append` ": " `B.append` encode msig)
  95 #ifdef DBG_BB
  96   case maybe_bb of
  97     Just m -> printMapBB $ rawMapBB m
  98     Nothing -> return ()
  99 #endif
 100   -- small example how to get information about
 101   -- exceptions of a method
 102   -- TODO: remove ;-)
 103   let (Just m) = lookupMethodSig method sig cls
 104   case attrByName m "Code" of
 105     Nothing ->
 106       printfBb "exception: no handler for this method\n"
 107     Just exceptionstream ->
 108       printfBb "exception: \"%s\"\n" (show $ codeExceptions $ decodeMethod exceptionstream)
 109   return maybe_bb
 110
 111
 112 testCFG :: Maybe (Method Direct) -> Maybe RawMethod
 113 testCFG m = do
 114   m' <- m
 115   codeseg <- attrByName m' "Code"
 116   let decoded = decodeMethod codeseg
 117   let mapbb = buildCFG $ codeInstructions decoded
 118   let locals = fromIntegral (codeMaxLocals decoded)
 119   let stacks = fromIntegral (codeStackSize decoded)
 120   return $ RawMethod mapbb locals stacks
 121
 122
 123 buildCFG :: [Instruction] -> MapBB
 124 buildCFG xs = buildCFG' M.empty xs' xs'
 125   where
 126   xs' :: [OffIns]
 127   xs' = markBackwardTargets $ calculateInstructionOffset xs
 128
 129 -- get already calculated jmp-targets and mark the predecessor of the
 130 -- target-instruction as "FallThrough". we just care about backwards
 131 -- jumps here (forward jumps are handled in buildCFG')
 132 markBackwardTargets :: [OffIns] -> [OffIns]
 133 markBackwardTargets [] = []
 134 markBackwardTargets (x:[]) = [x]
 135 markBackwardTargets insns@(x@((x_off,x_bbend),x_ins):y@((y_off,_),_):xs) =
 136   x_new:markBackwardTargets (y:xs)
 137     where
 138       x_new = if isTarget then checkX y_off else x
 139       checkX w16 = case x_bbend of
 140         Just _ -> x -- already marked, don't change
 141         Nothing -> ((x_off, Just $ FallThrough w16), x_ins) -- mark previous insn
 142
 143       -- look through all remaining insns in the stream if there is a jmp to `y'
 144       isTarget = case find cmpOffset insns of Just _ -> True; Nothing -> False
 145       cmpOffset ((_,Just (OneTarget w16)),_) = w16 == y_off
 146       cmpOffset ((_,Just (TwoTarget _ w16)),_) = w16 == y_off
 147       cmpOffset _ = False
 148
 149
 150 buildCFG' :: MapBB -> [OffIns] -> [OffIns] -> MapBB
 151 buildCFG' hmap [] _ = hmap
 152 buildCFG' hmap (((off, entry), _):xs) insns = buildCFG' (insertlist entryi hmap) xs insns
 153   where
 154     insertlist :: [BlockID] -> MapBB -> MapBB
 155     insertlist [] hmap' = hmap'
 156     insertlist (y:ys) hmap' = insertlist ys newhmap
 157       where
 158         newhmap = if M.member y hmap' then hmap' else M.insert y value hmap'
 159         value = parseBasicBlock y insns
 160     entryi :: [BlockID]
 161     entryi = if off == 0 then 0:ys else ys -- also consider the entrypoint
 162       where
 163         ys = case entry of
 164           Just (TwoTarget t1 t2) -> [t1, t2]
 165           Just (OneTarget t) -> [t]
 166           Just (FallThrough t) -> [t]
 167           Just Return -> []
 168           Nothing -> []
 169
 170
 171 parseBasicBlock :: Int -> [OffIns] -> BasicBlock
 172 parseBasicBlock i insns = BasicBlock insonly endblock
 173   where
 174     startlist = dropWhile (\((x,_),_) -> x < i) insns
 175     (Just ((_, Just endblock),_), is) = takeWhilePlusOne validins startlist
 176     insonly = snd $ unzip is
 177
 178     -- also take last (non-matched) element and return it
 179     takeWhilePlusOne :: (a -> Bool) -> [a] -> (Maybe a,[a])
 180     takeWhilePlusOne _ [] = (Nothing,[])
 181     takeWhilePlusOne p (x:xs)
 182       | p x       =  let (lastins, list) = takeWhilePlusOne p xs in (lastins, x:list)
 183       | otherwise =  (Just x,[x])
 184
 185     validins :: ((Int, Maybe BBEnd), Instruction) -> Bool
 186     validins ((_,x),_) = case x of Just _ -> False; Nothing -> True
 187
 188
 189 calculateInstructionOffset :: [Instruction] -> [OffIns]
 190 calculateInstructionOffset = cio' (0, Nothing)
 191   where
 192     newoffset :: Instruction -> Int -> Offset
 193     newoffset x off = (off + fromIntegral (B.length $ encodeInstructions [x]), Nothing)
 194
 195     addW16Signed :: Int -> Word16 -> Int
 196     addW16Signed i w16 = i + fromIntegral s16
 197       where s16 = fromIntegral w16 :: Int16
 198
 199     cio' :: Offset -> [Instruction] -> [OffIns]
 200     cio' _ [] = []
 201     -- TODO(bernhard): add more instruction with offset (IF_ACMP, JSR, ...)
 202     cio' (off,_) (x:xs) = case x of
 203         IF _ w16 -> twotargets w16
 204         IF_ICMP _ w16 -> twotargets w16
 205         IF_ACMP _ w16 -> twotargets w16
 206         IFNONNULL w16 -> twotargets w16
 207         IFNULL w16 -> twotargets w16
 208         GOTO w16 -> onetarget w16
 209         IRETURN -> notarget
 210         ARETURN -> notarget
 211         RETURN -> notarget
 212         _ -> ((off, Nothing), x):next
 213       where
 214         notarget = ((off, Just Return), x):next
 215         onetarget w16 = ((off, Just $ OneTarget (off `addW16Signed` w16)), x):next
 216         twotargets w16 = ((off, Just $ TwoTarget (off + 3) (off `addW16Signed` w16)), x):next
 217         next = cio' (newoffset x off) xs