%
% (c) Galois, 2006
+% (c) University of Glasgow, 2007
%
\section[Coverage]{@coverage@: the main function}
#include "HsVersions.h"
import HsSyn
-import Id ( Id )
-import DynFlags ( DynFlags, mainModIs, mainFunIs )
import Module
-import HscTypes ( HpcInfo, noHpcInfo )
-
-import IdInfo
import Outputable
-import DynFlags ( DynFlag(Opt_D_dump_hpc), hpcDir )
+import DynFlags
import Monad
-
import SrcLoc
-import ErrUtils (doIfSet_dyn)
-import HsUtils ( mkHsApp )
-import Unique
-import UniqSupply
-import Id
+import ErrUtils
import Name
-import TcType
-import TysPrim
-import CoreUtils
-import TyCon
-import Type
-import TysWiredIn ( intTy , stringTy, unitTy, intDataCon, falseDataConId, mkListTy, pairTyCon, tupleCon, mkTupleTy, unboxedSingletonDataCon )
import Bag
-import Var ( TyVar, mkTyVar )
-import DataCon ( dataConWrapId )
-import MkId
-import PrimOp
-import BasicTypes ( RecFlag(..), Activation(NeverActive), Boxity(..) )
-import Data.List ( isSuffixOf )
+import Var
+import Data.List
+import FastString
+import StaticFlags
+import Data.Array
import System.Time (ClockTime(..))
import System.Directory (getModificationTime)
import System.IO (FilePath)
#else
import System.Directory ( createDirectoryIfMissing )
#endif
+
+import HscTypes
+import BreakArray
\end{code}
%************************************************************************
%************************************************************************
\begin{code}
+addCoverageTicksToBinds
+ :: DynFlags
+ -> Module
+ -> ModLocation -- of the current module
+ -> LHsBinds Id
+ -> IO (LHsBinds Id, Int, ModBreaks)
+
addCoverageTicksToBinds dflags mod mod_loc binds = do
- let main_mod = mainModIs dflags
- main_is = case mainFunIs dflags of
- Nothing -> "main"
- Just main -> main
+ let orig_file =
+ case ml_hs_file mod_loc of
+ Just file -> file
+ Nothing -> panic "can not find the original file during hpc trans"
+
+ if "boot" `isSuffixOf` orig_file then return (binds, 0, emptyModBreaks) else do
let mod_name = moduleNameString (moduleName mod)
, mixEntries = []
}
- let hpc_dir = hpcDir dflags
+ let entries = reverse $ mixEntries st
-- write the mix entries for this module
- let tabStop = 1 -- <tab> counts as a normal char in GHC's location ranges.
-
- let orig_file = case ml_hs_file mod_loc of
- Just file -> file
- Nothing -> error "can not find the original file during hpc trans"
-
- modTime <- getModificationTime' orig_file
-
- createDirectoryIfMissing True hpc_dir
-
- mixCreate hpc_dir mod_name (Mix orig_file modTime tabStop $ reverse $ mixEntries st)
+ when opt_Hpc $ do
+ let hpc_dir = hpcDir dflags
+ let tabStop = 1 -- <tab> counts as a normal char in GHC's location ranges.
+ createDirectoryIfMissing True hpc_dir
+ modTime <- getModificationTime' orig_file
+ mixCreate hpc_dir mod_name (Mix orig_file modTime tabStop entries)
+
+ -- Todo: use proper src span type
+ breakArray <- newBreakArray $ length entries
+ let fn = mkFastString orig_file
+ let locsTicks = listArray (0,tickBoxCount st-1)
+ [ mkSrcSpan (mkSrcLoc fn r1 c1) (mkSrcLoc fn r2 c2)
+ | (P r1 c1 r2 c2, _box) <- entries ]
+
+ let modBreaks = emptyModBreaks
+ { modBreaks_flags = breakArray
+ , modBreaks_locs = locsTicks
+ }
doIfSet_dyn dflags Opt_D_dump_hpc $ do
printDump (pprLHsBinds binds1)
--- putStrLn (showSDocDebug (pprLHsBinds binds3))
- return (binds1, tickBoxCount st)
+
+ return (binds1, tickBoxCount st, modBreaks)
\end{code}
addTickLHsBind (L pos (AbsBinds abs_tvs abs_dicts abs_exports abs_binds)) = do
abs_binds' <- addTickLHsBinds abs_binds
return $ L pos $ AbsBinds abs_tvs abs_dicts abs_exports abs_binds'
-addTickLHsBind (L pos (funBind@(FunBind { fun_id = (L _ id) }))) = do
+
+addTickLHsBind (L pos (funBind@(FunBind { fun_id = (L _ id) }))) = do
let name = getOccString id
decl_path <- getPathEntry
- tick_no <- allocATickBox (if null decl_path
- then TopLevelBox [name]
- else LocalBox (name : decl_path))
- pos
-
- mg@(MatchGroup matches' ty) <- addPathEntry (getOccString id)
+ mg@(MatchGroup matches' ty) <- addPathEntry name
$ addTickMatchGroup (fun_matches funBind)
- let arg_count = matchGroupArity mg
- let (tys,res_ty) = splitFunTysN arg_count ty
- return $ L pos $ funBind { fun_matches = MatchGroup matches' ty
- , fun_tick = tick_no
- }
+ -- Todo: we don't want redundant ticks on simple pattern bindings
+ if not opt_Hpc && isSimplePatBind funBind
+ then
+ return $ L pos $ funBind { fun_matches = MatchGroup matches' ty
+ , fun_tick = Nothing
+ }
+ else do
+ tick_no <- allocATickBox (if null decl_path
+ then TopLevelBox [name]
+ else LocalBox (name : decl_path)) pos
+
+ return $ L pos $ funBind { fun_matches = MatchGroup matches' ty
+ , fun_tick = tick_no
+ }
+ where
+ -- a binding is a simple pattern binding if it is a funbind with zero patterns
+ isSimplePatBind :: HsBind a -> Bool
+ isSimplePatBind funBind = matchGroupArity (fun_matches funBind) == 0
-- TODO: Revisit this
addTickLHsBind (L pos (pat@(PatBind { pat_rhs = rhs }))) = do
-}
addTickLHsBind other = return other
-addTickLHsExpr :: LHsExpr Id -> TM (LHsExpr Id)
-addTickLHsExpr (L pos e0) = do
+-- add a tick to the expression no matter what it is
+addTickLHsExprAlways :: LHsExpr Id -> TM (LHsExpr Id)
+addTickLHsExprAlways (L pos e0) = do
e1 <- addTickHsExpr e0
fn <- allocTickBox ExpBox pos
return $ fn $ L pos e1
-addTickLHsExprOptAlt :: Bool -> LHsExpr Id -> TM (LHsExpr Id)
-addTickLHsExprOptAlt oneOfMany (L pos e0) = do
- e1 <- addTickHsExpr e0
- fn <- allocTickBox (if oneOfMany then AltBox else ExpBox) pos
- return $ fn $ L pos e1
+addTickLHsExprNeverOrAlways :: LHsExpr Id -> TM (LHsExpr Id)
+addTickLHsExprNeverOrAlways e
+ | opt_Hpc = addTickLHsExprNever e
+ | otherwise = addTickLHsExprAlways e
+
+addTickLHsExprNeverOrMaybe :: LHsExpr Id -> TM (LHsExpr Id)
+addTickLHsExprNeverOrMaybe e
+ | opt_Hpc = addTickLHsExprNever e
+ | otherwise = addTickLHsExpr e
-- version of addTick that does not actually add a tick,
-- because the scope of this tick is completely subsumed by
-- another.
-addTickLHsExpr' :: LHsExpr Id -> TM (LHsExpr Id)
-addTickLHsExpr' (L pos e0) = do
+addTickLHsExprNever :: LHsExpr Id -> TM (LHsExpr Id)
+addTickLHsExprNever (L pos e0) = do
e1 <- addTickHsExpr e0
return $ L pos e1
+-- selectively add ticks to interesting expressions
+addTickLHsExpr :: LHsExpr Id -> TM (LHsExpr Id)
+addTickLHsExpr (L pos e0) = do
+ e1 <- addTickHsExpr e0
+ if opt_Hpc || isGoodBreakExpr e0
+ then do
+ fn <- allocTickBox ExpBox pos
+ return $ fn $ L pos e1
+ else
+ return $ L pos e1
+
+-- general heuristic: expressions which do not denote values are good break points
+isGoodBreakExpr :: HsExpr Id -> Bool
+isGoodBreakExpr (HsApp {}) = True
+isGoodBreakExpr (OpApp {}) = True
+isGoodBreakExpr (NegApp {}) = True
+isGoodBreakExpr (HsCase {}) = True
+isGoodBreakExpr (HsIf {}) = True
+isGoodBreakExpr (RecordCon {}) = True
+isGoodBreakExpr (RecordUpd {}) = True
+isGoodBreakExpr (ArithSeq {}) = True
+isGoodBreakExpr (PArrSeq {}) = True
+isGoodBreakExpr other = False
+
+addTickLHsExprOptAlt :: Bool -> LHsExpr Id -> TM (LHsExpr Id)
+addTickLHsExprOptAlt oneOfMany (L pos e0)
+ | not opt_Hpc = addTickLHsExpr (L pos e0)
+ | otherwise = do
+ e1 <- addTickHsExpr e0
+ fn <- allocTickBox (if oneOfMany then AltBox else ExpBox) pos
+ return $ fn $ L pos e1
+
addBinTickLHsExpr :: (Bool -> BoxLabel) -> LHsExpr Id -> TM (LHsExpr Id)
addBinTickLHsExpr boxLabel (L pos e0) = do
e1 <- addTickHsExpr e0
allocBinTickBox boxLabel $ L pos e1
-
addTickHsExpr :: HsExpr Id -> TM (HsExpr Id)
addTickHsExpr e@(HsVar _) = return e
addTickHsExpr e@(HsLam matchgroup) =
liftM HsLam (addTickMatchGroup matchgroup)
addTickHsExpr (HsApp e1 e2) =
- liftM2 HsApp (addTickLHsExpr' e1) (addTickLHsExpr e2)
+ liftM2 HsApp (addTickLHsExprNever e1) (addTickLHsExpr e2)
addTickHsExpr (OpApp e1 e2 fix e3) =
liftM4 OpApp
(addTickLHsExpr e1)
- (addTickLHsExpr' e2)
+ (addTickLHsExprNever e2)
(return fix)
(addTickLHsExpr e3)
-addTickHsExpr ( NegApp e neg) =
+addTickHsExpr (NegApp e neg) =
liftM2 NegApp
(addTickLHsExpr e)
(addTickSyntaxExpr hpcSrcSpan neg)
-addTickHsExpr (HsPar e) = liftM HsPar (addTickLHsExpr' e)
+addTickHsExpr (HsPar e) = liftM HsPar (addTickLHsExprNeverOrMaybe e)
addTickHsExpr (SectionL e1 e2) =
liftM2 SectionL
(addTickLHsExpr e1)
addTickHsExpr (HsLet binds e) =
liftM2 HsLet
(addTickHsLocalBinds binds) -- to think about: !patterns.
- (addTickLHsExpr' e)
+ (addTickLHsExprNeverOrAlways e)
addTickHsExpr (HsDo cxt stmts last_exp srcloc) =
liftM4 HsDo
(return cxt)
addTickHsExpr (ExplicitList ty es) =
liftM2 ExplicitList
(return ty)
- (mapM addTickLHsExpr es)
-addTickHsExpr (ExplicitPArr {}) = error "addTickHsExpr: ExplicitPArr "
+ (mapM (addTickLHsExpr) es)
+addTickHsExpr (ExplicitPArr {}) = error "addTickHsExpr: ExplicitPArr"
addTickHsExpr (ExplicitTuple es box) =
liftM2 ExplicitTuple
- (mapM addTickLHsExpr es)
+ (mapM (addTickLHsExpr) es)
(return box)
addTickHsExpr (RecordCon id ty rec_binds) =
liftM3 RecordCon
addTickHsExpr (ExprWithTySig {}) = error "addTickHsExpr: ExprWithTySig"
addTickHsExpr (ExprWithTySigOut e ty) =
liftM2 ExprWithTySigOut
- (addTickLHsExpr' e) -- No need to tick the inner expression
+ (addTickLHsExprNever e) -- No need to tick the inner expression
-- for expressions with signatures
(return ty)
addTickHsExpr (ArithSeq ty arith_seq) =
liftM2 ArithSeq
(return ty)
(addTickArithSeqInfo arith_seq)
-addTickHsExpr (PArrSeq {}) = error "addTickHsExpr: PArrSeq "
-addTickHsExpr (HsSCC {}) = error "addTickHsExpr: HsSCC "
-addTickHsExpr (HsCoreAnn {}) = error "addTickHsExpr: HsCoreAnn "
+addTickHsExpr (HsTickPragma (file,(l1,c1),(l2,c2)) (L pos e0)) = do
+ e1 <- addTickHsExpr e0
+ fn <- allocTickBox (ExternalBox (unpackFS file) (P l1 c1 l2 c2)) pos
+ let (L _ e2) = fn $ L pos e1
+ return $ e2
+addTickHsExpr (PArrSeq {}) = error "addTickHsExpr: PArrSeq"
+addTickHsExpr (HsSCC {}) = error "addTickHsExpr: HsSCC"
+addTickHsExpr (HsCoreAnn {}) = error "addTickHsExpr: HsCoreAnn"
addTickHsExpr e@(HsBracket {}) = return e
addTickHsExpr e@(HsBracketOut {}) = return e
addTickHsExpr e@(HsSpliceE {}) = return e
addTickHsExpr (HsProc pat cmdtop) =
liftM2 HsProc
(addTickLPat pat)
- (liftL addTickHsCmdTop cmdtop)
+ (liftL (addTickHsCmdTop) cmdtop)
addTickHsExpr (HsWrap w e) =
liftM2 HsWrap
(return w)
liftM3 HsArrForm
(addTickLHsExpr e)
(return fix)
- (mapM (liftL addTickHsCmdTop) cmdtop)
+ (mapM (liftL (addTickHsCmdTop)) cmdtop)
addTickHsExpr e@(HsType ty) = return e
addTickGRHS :: Bool -> GRHS Id -> TM (GRHS Id)
addTickGRHS isOneOfMany (GRHS stmts expr) = do
stmts' <- mapM (liftL (addTickStmt (Just $ GuardBinBox))) stmts
- expr' <- addTickLHsExprOptAlt isOneOfMany expr
+ expr' <- if opt_Hpc then addTickLHsExprOptAlt isOneOfMany expr
+ else addTickLHsExprAlways expr
return $ GRHS stmts' expr'
-
addTickStmt :: (Maybe (Bool -> BoxLabel)) -> Stmt Id -> TM (Stmt Id)
addTickStmt isGuard (BindStmt pat e bind fail) =
liftM4 BindStmt
(addTickLPat pat)
- (addTickLHsExpr e)
+ (addTickLHsExprAlways e)
(addTickSyntaxExpr hpcSrcSpan bind)
(addTickSyntaxExpr hpcSrcSpan fail)
addTickStmt isGuard (ExprStmt e bind' ty) =
(addTickSyntaxExpr hpcSrcSpan bind')
(return ty)
where
- addTick e | Just fn <- isGuard = addBinTickLHsExpr fn e
- | otherwise = addTickLHsExpr e
+ addTick e | Just fn <- isGuard = addBinTickLHsExpr fn e
+ | otherwise = addTickLHsExprAlways e
addTickStmt isGuard (LetStmt binds) =
liftM LetStmt
addTickHsIPBinds (IPBinds ipbinds dictbinds) =
liftM2 IPBinds
- (mapM (liftL addTickIPBind) ipbinds)
+ (mapM (liftL (addTickIPBind)) ipbinds)
(addTickDictBinds dictbinds)
addTickIPBind :: IPBind Id -> TM (IPBind Id)
(return ty)
(return syntaxtable)
-addTickLHsCmd :: LHsCmd Id -> TM (LHsCmd Id)
+addTickLHsCmd :: LHsCmd Id -> TM (LHsCmd Id)
addTickLHsCmd x = addTickLHsExpr x
addTickDictBinds :: DictBinds Id -> TM (DictBinds Id)
addTickDictBinds x = addTickLHsBinds x
addTickHsRecordBinds :: HsRecordBinds Id -> TM (HsRecordBinds Id)
-addTickHsRecordBinds pairs = mapM process pairs
+addTickHsRecordBinds (HsRecordBinds pairs) = liftM HsRecordBinds (mapM process pairs)
where
process (ids,expr) =
liftM2 (,)
\end{code}
\begin{code}
-data TixFlags = TixFlags
-
data TickTransState = TT { modName :: String
, declPath :: [String]
, tickBoxCount:: Int
meE = (hpcPos,ExpBox)
c = tickBoxCount st
mes = mixEntries st
- in ( L pos $ HsTick c $ L pos $ HsBinTick (c+1) (c+2) (L pos e)
- -- notice that F and T are reversed,
- -- because we are building the list in
- -- reverse...
- , st {tickBoxCount=c+3,mixEntries=meF:meT:meE:mes}
- )
+ in
+ if opt_Hpc
+ then ( L pos $ HsTick c $ L pos $ HsBinTick (c+1) (c+2) (L pos e)
+ -- notice that F and T are reversed,
+ -- because we are building the list in
+ -- reverse...
+ , st {tickBoxCount=c+3,mixEntries=meF:meT:meE:mes}
+ )
+ else
+ ( L pos $ HsTick c $ L pos e
+ , st {tickBoxCount=c+1,mixEntries=meE:mes}
+ )
allocBinTickBox boxLabel e = return e
start = srcSpanStart pos
end = srcSpanEnd pos
hpcPos = toHpcPos ( srcLocLine start
- , srcLocCol start + 1
+ , srcLocCol start
, srcLocLine end
, srcLocCol end
)
hpcSrcSpan = mkGeneralSrcSpan (FSLIT("Haskell Program Coverage internals"))
-
--- all newly allocated locations have an HPC tag on them, to help debuging
-hpcLoc :: e -> Located e
-hpcLoc = L hpcSrcSpan
\end{code}
| AltBox
| TopLevelBox [String]
| LocalBox [String]
- -- | UserBox (Maybe String)
| GuardBinBox Bool
| CondBinBox Bool
| QualBinBox Bool
- -- | PreludeBinBox String Bool
- -- | UserBinBox (Maybe String) Bool
+ | ExternalBox String HpcPos
+ -- ^The position was generated from the named file/module,
+ -- with the stated position (inside the named file/module).
+ -- The HpcPos inside this MixEntry refers to the generated Haskell location.
deriving (Read, Show)
mixCreate :: String -> String -> Mix -> IO ()
mixCreate dirName modName mix =
writeFile (mixName dirName modName) (show mix)
-readMix :: FilePath -> String -> IO Mix
-readMix dirName modName = do
- contents <- readFile (mixName dirName modName)
- return (read contents)
-
mixName :: FilePath -> String -> String
mixName dirName name = dirName ++ "/" ++ name ++ ".mix"
(TOD sec _) <- System.Directory.getModificationTime file
return $ sec
-data Tix = Tix [PixEntry] -- The number of tickboxes in each module
- [TixEntry] -- The tick boxes
- deriving (Read, Show,Eq)
-
-type TixEntry = Integer
-
--- always read and write Tix from the current working directory.
-
-readTix :: String -> IO (Maybe Tix)
-readTix pname =
- catch (do contents <- readFile $ tixName pname
- return $ Just $ read contents)
- (\ _ -> return $ Nothing)
-
-writeTix :: String -> Tix -> IO ()
-writeTix pname tix =
- writeFile (tixName pname) (show tix)
-
-tixName :: String -> String
-tixName name = name ++ ".tix"
-
-- a program index records module names and numbers of tick-boxes
-- introduced in each module that has been transformed for coverage
-data Pix = Pix [PixEntry] deriving (Read, Show)
-
-type PixEntry = ( String -- module name
- , Int -- number of boxes
- )
-
-pixUpdate :: FilePath -> String -> String -> Int -> IO ()
-pixUpdate dirName progName modName boxCount = do
- fileUpdate (pixName dirName progName) pixAssign (Pix [])
- where
- pixAssign :: Pix -> Pix
- pixAssign (Pix pes) =
- Pix ((modName,boxCount) : filter ((/=) modName . fst) pes)
-
-readPix :: FilePath -> String -> IO Pix
-readPix dirName pname = do
- contents <- readFile (pixName dirName pname)
- return (read contents)
-
-tickCount :: Pix -> Int
-tickCount (Pix mp) = sum $ map snd mp
-
-pixName :: FilePath -> String -> String
-pixName dirName name = dirName ++ "/" ++ name ++ ".pix"
-
--- updating a value stored in a file via read and show
-fileUpdate :: (Read a, Show a) => String -> (a->a) -> a -> IO()
-fileUpdate fname update init =
- catch
- (do
- valueText <- readFile fname
- ( case finite valueText of
- True ->
- writeFile fname (show (update (read valueText))) ))
- (const (writeFile fname (show (update init))))
-
-finite :: [a] -> Bool
-finite [] = True
-finite (x:xs) = finite xs
-
data HpcPos = P !Int !Int !Int !Int deriving (Eq)
-fromHpcPos :: HpcPos -> (Int,Int,Int,Int)
-fromHpcPos (P l1 c1 l2 c2) = (l1,c1,l2,c2)
-
toHpcPos :: (Int,Int,Int,Int) -> HpcPos
toHpcPos (l1,c1,l2,c2) = P l1 c1 l2 c2