X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=compiler%2FdeSugar%2FCoverage.lhs;h=f2ad77c86aca159236964817118d8694f614fe71;hp=9a53b2bdfcc2480d0d7132fc39a2ff71d74d719b;hb=c1681a73fa4ca4cf8758264ae387ac09a9e900d8;hpb=d5934bbb856aa0aa620c9b2e0fa51c90a1a5a048 diff --git a/compiler/deSugar/Coverage.lhs b/compiler/deSugar/Coverage.lhs index 9a53b2b..f2ad77c 100644 --- a/compiler/deSugar/Coverage.lhs +++ b/compiler/deSugar/Coverage.lhs @@ -1,5 +1,6 @@ % % (c) Galois, 2006 +% (c) University of Glasgow, 2007 % \section[Coverage]{@coverage@: the main function} @@ -9,47 +10,43 @@ module Coverage (addCoverageTicksToBinds) where #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 VarSet +import Data.List +import FastString +import HscTypes +import StaticFlags +import UniqFM +import Type +import TyCon +import FiniteMap +import PackageConfig +import Data.Array import System.Time (ClockTime(..)) -import System.Directory (getModificationTime) import System.IO (FilePath) #if __GLASGOW_HASKELL__ < 603 import Compat.Directory ( createDirectoryIfMissing ) #else import System.Directory ( createDirectoryIfMissing ) #endif + +import Trace.Hpc.Mix +import Trace.Hpc.Util + +import BreakArray +import Data.HashTable ( hashString ) \end{code} + %************************************************************************ %* * %* The main function: addCoverageTicksToBinds @@ -57,41 +54,80 @@ import System.Directory ( createDirectoryIfMissing ) %************************************************************************ \begin{code} -addCoverageTicksToBinds dflags mod mod_loc binds = do - let main_mod = mainModIs dflags - main_is = case mainFunIs dflags of - Nothing -> "main" - Just main -> main +addCoverageTicksToBinds + :: DynFlags + -> Module + -> ModLocation -- of the current module + -> [TyCon] -- type constructor in this module + -> LHsBinds Id + -> IO (LHsBinds Id, HpcInfo, ModBreaks) + +addCoverageTicksToBinds dflags mod mod_loc tyCons binds = do + + 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, emptyHpcInfo False, emptyModBreaks) else do let mod_name = moduleNameString (moduleName mod) - let (binds1,st) + let (binds1,_,st) = unTM (addTickLHsBinds binds) - $ TT { modName = mod_name + (TTE + { fileName = mkFastString orig_file , declPath = [] - , tickBoxCount = 0 + , inScope = emptyVarSet + , blackList = listToFM [ (getSrcSpan (tyConName tyCon),()) + | tyCon <- tyCons ] + }) + (TT + { tickBoxCount = 0 , mixEntries = [] - } + }) - let hpc_dir = hpcDir dflags + let entries = reverse $ mixEntries st -- write the mix entries for this module - let tabStop = 1 -- 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) + hashNo <- if opt_Hpc then do + let hpc_dir = hpcDir dflags + + let hpc_mod_dir = if modulePackageId mod == mainPackageId + then hpc_dir + else hpc_dir ++ "/" ++ packageIdString (modulePackageId mod) + + let tabStop = 1 -- counts as a normal char in GHC's location ranges. + createDirectoryIfMissing True hpc_mod_dir + modTime <- getModificationTime orig_file + let entries' = [ (hpcPos, box) + | (span,_,box) <- entries, hpcPos <- [mkHpcPos span] ] + when (length entries' /= tickBoxCount st) $ do + panic "the number of .mix entries are inconsistent" + let hashNo = mixHash orig_file modTime tabStop entries' + mixCreate hpc_mod_dir mod_name + $ Mix orig_file modTime (toHash hashNo) tabStop entries' + return $ hashNo + else do + return $ 0 + + -- Todo: use proper src span type + breakArray <- newBreakArray $ length entries + + let locsTicks = listArray (0,tickBoxCount st-1) + [ span | (span,_,_) <- entries ] + varsTicks = listArray (0,tickBoxCount st-1) + [ vars | (_,vars,_) <- entries ] + modBreaks = emptyModBreaks + { modBreaks_flags = breakArray + , modBreaks_locs = locsTicks + , modBreaks_vars = varsTicks + } doIfSet_dyn dflags Opt_D_dump_hpc $ do printDump (pprLHsBinds binds1) --- putStrLn (showSDocDebug (pprLHsBinds binds3)) - return (binds1, tickBoxCount st) + + return (binds1, HpcInfo (tickBoxCount st) hashNo, modBreaks) \end{code} @@ -105,26 +141,40 @@ addTickLHsBinds :: LHsBinds Id -> TM (LHsBinds Id) addTickLHsBinds binds = mapBagM addTickLHsBind binds addTickLHsBind :: LHsBind Id -> TM (LHsBind Id) -addTickLHsBind (L pos (AbsBinds abs_tvs abs_dicts abs_exports abs_binds)) = do +addTickLHsBind (L pos t@(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) - $ addTickMatchGroup (fun_matches funBind) - let arg_count = matchGroupArity mg - let (tys,res_ty) = splitFunTysN arg_count ty - - return $ L pos $ funBind { fun_matches = MatchGroup ({-L pos fn_entry:-}matches') ty - , fun_tick = tick_no - } + (fvs, mg@(MatchGroup matches' ty)) <- + getFreeVars $ + addPathEntry name $ + addTickMatchGroup (fun_matches funBind) + + blackListed <- isBlackListed pos + + -- Todo: we don't want redundant ticks on simple pattern bindings + -- We don't want to generate code for blacklisted positions + if blackListed || (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 (decl_path ++ [name])) + pos fvs + + 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 @@ -145,52 +195,87 @@ addTickLHsBind (VarBind var_id var_rhs) = do -} addTickLHsBind other = return other -addTickLHsExpr :: LHsExpr Id -> TM (LHsExpr Id) -addTickLHsExpr (L pos e0) = do - e1 <- addTickHsExpr e0 - fn <- allocTickBox ExpBox pos - return $ fn $ L pos e1 +-- Add a tick to the expression no matter what it is. There is one exception: +-- for the debugger, if the expression is a 'let', then we don't want to add +-- a tick here because there will definititely be a tick on the body anyway. +addTickLHsExprAlways :: LHsExpr Id -> TM (LHsExpr Id) +addTickLHsExprAlways (L pos e0) + | not opt_Hpc, HsLet _ _ <- e0 = addTickLHsExprNever (L pos e0) + | otherwise = allocTickBox (ExpBox False) pos $ addTickHsExpr e0 -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 + if opt_Hpc || isGoodBreakExpr e0 + then do + allocTickBox (ExpBox False) pos $ addTickHsExpr e0 + else do + e1 <- addTickHsExpr e0 + 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 = + allocTickBox (ExpBox oneOfMany) pos $ + addTickHsExpr e0 + 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@(HsVar id) = do freeVar id; return e addTickHsExpr e@(HsIPVar _) = return e addTickHsExpr e@(HsOverLit _) = return e addTickHsExpr e@(HsLit _) = 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) @@ -205,133 +290,175 @@ addTickHsExpr (HsCase e mgs) = (addTickMatchGroup mgs) addTickHsExpr (HsIf e1 e2 e3) = liftM3 HsIf - (addBinTickLHsExpr CondBinBox e1) + (addBinTickLHsExpr (BinBox CondBinBox) e1) (addTickLHsExprOptAlt True e2) (addTickLHsExprOptAlt True e3) addTickHsExpr (HsLet binds e) = + bindLocals (map unLoc $ collectLocalBinders binds) $ liftM2 HsLet - (addTickHsLocalBinds binds) -- to think about: !patterns. - (addTickLHsExpr' e) -addTickHsExpr (HsDo cxt stmts last_exp srcloc) = - liftM4 HsDo - (return cxt) - (mapM (liftL (addTickStmt forQual)) stmts) - (addTickLHsExpr last_exp) - (return srcloc) + (addTickHsLocalBinds binds) -- to think about: !patterns. + (addTickLHsExprNeverOrAlways e) +addTickHsExpr (HsDo cxt stmts last_exp srcloc) = do + (stmts', last_exp') <- addTickLStmts' forQual stmts + (addTickLHsExpr last_exp) + return (HsDo cxt stmts' last_exp' srcloc) where forQual = case cxt of - ListComp -> Just QualBinBox + ListComp -> Just $ BinBox QualBinBox _ -> Nothing addTickHsExpr (ExplicitList ty es) = liftM2 ExplicitList (return ty) - (mapM addTickLHsExpr es) -addTickHsExpr (ExplicitPArr {}) = error "addTickHsExpr: ExplicitPArr " + (mapM (addTickLHsExpr) es) +addTickHsExpr (ExplicitPArr ty es) = + liftM2 ExplicitPArr + (return ty) + (mapM (addTickLHsExpr) es) addTickHsExpr (ExplicitTuple es box) = liftM2 ExplicitTuple - (mapM addTickLHsExpr es) + (mapM (addTickLHsExpr) es) (return box) -addTickHsExpr (RecordCon id ty rec_binds) = +addTickHsExpr (RecordCon id ty rec_binds) = liftM3 RecordCon (return id) (return ty) (addTickHsRecordBinds rec_binds) -addTickHsExpr (RecordUpd e rec_binds ty1 ty2) = - liftM4 RecordUpd +addTickHsExpr (RecordUpd e rec_binds cons tys1 tys2) = + liftM5 RecordUpd (addTickLHsExpr e) (addTickHsRecordBinds rec_binds) - (return ty1) - (return ty2) -addTickHsExpr (ExprWithTySig {}) = error "addTickHsExpr: ExprWithTySig" + (return cons) (return tys1) (return tys2) + 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 + e2 <- allocTickBox (ExpBox False) pos $ + addTickHsExpr e0 + return $ unLoc e2 +addTickHsExpr (PArrSeq ty arith_seq) = + liftM2 PArrSeq + (return ty) + (addTickArithSeqInfo arith_seq) +addTickHsExpr (HsSCC nm e) = + liftM2 HsSCC + (return nm) + (addTickLHsExpr e) +addTickHsExpr (HsCoreAnn nm e) = + liftM2 HsCoreAnn + (return nm) + (addTickLHsExpr e) 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) (addTickHsExpr e) -- explicitly no tick on inside -addTickHsExpr (HsArrApp {}) = error "addTickHsExpr: HsArrApp " -addTickHsExpr (HsArrForm {}) = error "addTickHsExpr: HsArrForm" -addTickHsExpr (EAsPat _ _) = error "addTickHsExpr: EAsPat _ _" -addTickHsExpr (ELazyPat _) = error "addTickHsExpr: ELazyPat _" -addTickHsExpr (EWildPat) = error "addTickHsExpr: EWildPat" -addTickHsExpr (HsBinTick _ _ _) = error "addTickhsExpr: HsBinTick _ _ _" -addTickHsExpr (HsTick _ _) = error "addTickhsExpr: HsTick _ _" +addTickHsExpr (HsArrApp e1 e2 ty1 arr_ty lr) = + liftM5 HsArrApp + (addTickLHsExpr e1) + (addTickLHsExpr e2) + (return ty1) + (return arr_ty) + (return lr) +addTickHsExpr (HsArrForm e fix cmdtop) = + liftM3 HsArrForm + (addTickLHsExpr e) + (return fix) + (mapM (liftL (addTickHsCmdTop)) cmdtop) addTickHsExpr e@(HsType ty) = return e --- catch all, and give an error message. ---addTickHsExpr e = error ("addTickLhsExpr: " ++ showSDoc (ppr e)) - +-- Others dhould never happen in expression content. +addTickHsExpr e@(ExprWithTySig {}) = pprPanic "addTickHsExpr" (ppr e) +addTickHsExpr e@(EAsPat _ _) = pprPanic "addTickHsExpr" (ppr e) +addTickHsExpr e@(ELazyPat _) = pprPanic "addTickHsExpr" (ppr e) +addTickHsExpr e@(EWildPat) = pprPanic "addTickHsExpr" (ppr e) +addTickHsExpr e@(HsBinTick _ _ _) = pprPanic "addTickHsExpr" (ppr e) +addTickHsExpr e@(HsTick _ _ _) = pprPanic "addTickHsExpr" (ppr e) addTickMatchGroup (MatchGroup matches ty) = do - let isOneOfMany = True -- AJG: for now + let isOneOfMany = matchesOneOfMany matches matches' <- mapM (liftL (addTickMatch isOneOfMany)) matches return $ MatchGroup matches' ty addTickMatch :: Bool -> Match Id -> TM (Match Id) -addTickMatch isOneOfMany (Match pats opSig gRHSs) = do - gRHSs' <- addTickGRHSs isOneOfMany gRHSs - return $ Match pats opSig gRHSs' +addTickMatch isOneOfMany (Match pats opSig gRHSs) = + bindLocals (collectPatsBinders pats) $ do + gRHSs' <- addTickGRHSs isOneOfMany gRHSs + return $ Match pats opSig gRHSs' addTickGRHSs :: Bool -> GRHSs Id -> TM (GRHSs Id) addTickGRHSs isOneOfMany (GRHSs guarded local_binds) = do - guarded' <- mapM (liftL (addTickGRHS isOneOfMany)) guarded - local_binds' <- addTickHsLocalBinds local_binds - return $ GRHSs guarded' local_binds' + bindLocals binders $ do + local_binds' <- addTickHsLocalBinds local_binds + guarded' <- mapM (liftL (addTickGRHS isOneOfMany)) guarded + return $ GRHSs guarded' local_binds' + where + binders = map unLoc (collectLocalBinders local_binds) addTickGRHS :: Bool -> GRHS Id -> TM (GRHS Id) addTickGRHS isOneOfMany (GRHS stmts expr) = do - stmts' <- mapM (liftL (addTickStmt (Just $ GuardBinBox))) stmts - expr' <- addTickLHsExprOptAlt isOneOfMany expr + (stmts',expr') <- addTickLStmts' (Just $ BinBox $ GuardBinBox) stmts + (if opt_Hpc then addTickLHsExprOptAlt isOneOfMany expr + else addTickLHsExprAlways expr) return $ GRHS stmts' expr' +addTickLStmts :: (Maybe (Bool -> BoxLabel)) -> [LStmt Id] -> TM [LStmt Id] +addTickLStmts isGuard stmts = do + (stmts, _) <- addTickLStmts' isGuard stmts (return ()) + return stmts + +addTickLStmts' :: (Maybe (Bool -> BoxLabel)) -> [LStmt Id] -> TM a + -> TM ([LStmt Id], a) +addTickLStmts' isGuard lstmts res + = bindLocals binders $ do + lstmts' <- mapM (liftL (addTickStmt isGuard)) lstmts + a <- res + return (lstmts', a) + where + binders = map unLoc (collectLStmtsBinders lstmts) addTickStmt :: (Maybe (Bool -> BoxLabel)) -> Stmt Id -> TM (Stmt Id) -addTickStmt isGuard (BindStmt pat e bind fail) = +addTickStmt isGuard (BindStmt pat e bind fail) = do liftM4 BindStmt (addTickLPat pat) - (addTickLHsExpr e) + (addTickLHsExprAlways e) (addTickSyntaxExpr hpcSrcSpan bind) (addTickSyntaxExpr hpcSrcSpan fail) -addTickStmt isGuard (ExprStmt e bind' ty) = +addTickStmt isGuard (ExprStmt e bind' ty) = do liftM3 ExprStmt (addTick e) (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) = +addTickStmt isGuard (LetStmt binds) = do liftM LetStmt (addTickHsLocalBinds binds) -addTickStmt isGuard (ParStmt pairs) = +addTickStmt isGuard (ParStmt pairs) = do liftM ParStmt (mapM process pairs) where process (stmts,ids) = liftM2 (,) - (mapM (liftL (addTickStmt isGuard)) stmts) + (addTickLStmts isGuard stmts) (return ids) -addTickStmt isGuard (RecStmt stmts ids1 ids2 tys dictbinds) = +addTickStmt isGuard (RecStmt stmts ids1 ids2 tys dictbinds) = do liftM5 RecStmt - (mapM (liftL (addTickStmt isGuard)) stmts) + (addTickLStmts isGuard stmts) (return ids1) (return ids2) (return tys) @@ -357,7 +484,7 @@ addTickHsValBinds (ValBindsOut binds sigs) = addTickHsIPBinds (IPBinds ipbinds dictbinds) = liftM2 IPBinds - (mapM (liftL addTickIPBind) ipbinds) + (mapM (liftL (addTickIPBind)) ipbinds) (addTickDictBinds dictbinds) addTickIPBind :: IPBind Id -> TM (IPBind Id) @@ -383,19 +510,20 @@ addTickHsCmdTop (HsCmdTop cmd tys ty syntaxtable) = (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 - where - process (ids,expr) = - liftM2 (,) - (return ids) - (addTickLHsExpr expr) +addTickHsRecordBinds (HsRecFields fields dd) + = do { fields' <- mapM process fields + ; return (HsRecFields fields' dd) } + where + process (HsRecField ids expr doc) + = do { expr' <- addTickLHsExpr expr + ; return (HsRecField ids expr' doc) } addTickArithSeqInfo :: ArithSeqInfo Id -> TM (ArithSeqInfo Id) addTickArithSeqInfo (From e1) = @@ -417,77 +545,171 @@ addTickArithSeqInfo (FromThenTo e1 e2 e3) = \end{code} \begin{code} -data TixFlags = TixFlags - -data TickTransState = TT { modName :: String - , declPath :: [String] - , tickBoxCount:: Int - , mixEntries :: [MixEntry] +data TickTransState = TT { tickBoxCount:: Int + , mixEntries :: [MixEntry_] } - deriving Show -data TM a = TM { unTM :: TickTransState -> (a,TickTransState) } +data TickTransEnv = TTE { fileName :: FastString + , declPath :: [String] + , inScope :: VarSet + , blackList :: FiniteMap SrcSpan () + } + +-- deriving Show + +type FreeVars = OccEnv Id +noFVs = emptyOccEnv + +-- Note [freevars] +-- For breakpoints we want to collect the free variables of an +-- expression for pinning on the HsTick. We don't want to collect +-- *all* free variables though: in particular there's no point pinning +-- on free variables that are will otherwise be in scope at the GHCi +-- prompt, which means all top-level bindings. Unfortunately detecting +-- top-level bindings isn't easy (collectHsBindsBinders on the top-level +-- bindings doesn't do it), so we keep track of a set of "in-scope" +-- variables in addition to the free variables, and the former is used +-- to filter additions to the latter. This gives us complete control +-- over what free variables we track. + +data TM a = TM { unTM :: TickTransEnv -> TickTransState -> (a,FreeVars,TickTransState) } + -- a combination of a state monad (TickTransState) and a writer + -- monad (FreeVars). instance Monad TM where - return a = TM $ \ st -> (a,st) - (TM m) >>= k = TM $ \ st -> case m st of - (r1,st1) -> unTM (k r1) st1 - ---addTick :: LHsExpr Id -> TM (LHsExpr Id) ---addTick e = TM $ \ uq -> (e,succ uq,[(uq,getLoc e)]) + return a = TM $ \ env st -> (a,noFVs,st) + (TM m) >>= k = TM $ \ env st -> + case m env st of + (r1,fv1,st1) -> + case unTM (k r1) env st1 of + (r2,fv2,st2) -> + (r2, fv1 `plusOccEnv` fv2, st2) + +-- getState :: TM TickTransState +-- getState = TM $ \ env st -> (st, noFVs, st) + +setState :: (TickTransState -> TickTransState) -> TM () +setState f = TM $ \ env st -> ((), noFVs, f st) + +getEnv :: TM TickTransEnv +getEnv = TM $ \ env st -> (env, noFVs, st) + +withEnv :: (TickTransEnv -> TickTransEnv) -> TM a -> TM a +withEnv f (TM m) = TM $ \ env st -> + case m (f env) st of + (a, fvs, st') -> (a, fvs, st') + +getFreeVars :: TM a -> TM (FreeVars, a) +getFreeVars (TM m) + = TM $ \ env st -> case m env st of (a, fv, st') -> ((fv,a), fv, st') + +freeVar :: Id -> TM () +freeVar id = TM $ \ env st -> + if id `elemVarSet` inScope env + then ((), unitOccEnv (nameOccName (idName id)) id, st) + else ((), noFVs, st) addPathEntry :: String -> TM a -> TM a -addPathEntry nm (TM m) = TM $ \ st -> case m (st { declPath = declPath st ++ [nm] }) of - (r,st') -> (r,st' { declPath = declPath st }) +addPathEntry nm = withEnv (\ env -> env { declPath = declPath env ++ [nm] }) getPathEntry :: TM [String] -getPathEntry = TM $ \ st -> (declPath st,st) +getPathEntry = declPath `liftM` getEnv + +getFileName :: TM FastString +getFileName = fileName `liftM` getEnv + +sameFileName :: SrcSpan -> TM a -> TM a -> TM a +sameFileName pos out_of_scope in_scope = do + file_name <- getFileName + case optSrcSpanFileName pos of + Just file_name2 + | file_name == file_name2 -> in_scope + _ -> out_of_scope + +bindLocals :: [Id] -> TM a -> TM a +bindLocals new_ids (TM m) + = TM $ \ env st -> + case m env{ inScope = inScope env `extendVarSetList` new_ids } st of + (r, fv, st') -> (r, fv `delListFromUFM` occs, st') + where occs = [ nameOccName (idName id) | id <- new_ids ] + +isBlackListed :: SrcSpan -> TM Bool +isBlackListed pos = TM $ \ env st -> + case lookupFM (blackList env) pos of + Nothing -> (False,noFVs,st) + Just () -> (True,noFVs,st) -- the tick application inherits the source position of its -- expression argument to support nested box allocations -allocTickBox :: BoxLabel -> SrcSpan -> TM (LHsExpr Id -> LHsExpr Id) -allocTickBox boxLabel pos | Just hpcPos <- mkHpcPos pos = TM $ \ st -> - let me = (hpcPos,boxLabel) - c = tickBoxCount st - mes = mixEntries st - in ( \ (L pos e) -> L pos $ HsTick c (L pos e) - , st {tickBoxCount=c+1,mixEntries=me:mes} - ) -allocTickBox boxLabel e = return id +allocTickBox :: BoxLabel -> SrcSpan -> TM (HsExpr Id) -> TM (LHsExpr Id) +allocTickBox boxLabel pos m | isGoodSrcSpan' pos = + sameFileName pos + (do e <- m; return (L pos e)) $ do + (fvs, e) <- getFreeVars m + TM $ \ env st -> + let c = tickBoxCount st + ids = occEnvElts fvs + mes = mixEntries st + me = (pos, map (nameOccName.idName) ids, boxLabel) + in + ( L pos (HsTick c ids (L pos e)) + , fvs + , st {tickBoxCount=c+1,mixEntries=me:mes} + ) +allocTickBox boxLabel pos m = do e <- m; return (L pos e) -- the tick application inherits the source position of its -- expression argument to support nested box allocations -allocATickBox :: BoxLabel -> SrcSpan -> TM (Maybe Int) -allocATickBox boxLabel pos | Just hpcPos <- mkHpcPos pos = TM $ \ st -> - let me = (hpcPos,boxLabel) +allocATickBox :: BoxLabel -> SrcSpan -> FreeVars -> TM (Maybe (Int,[Id])) +allocATickBox boxLabel pos fvs | isGoodSrcSpan' pos = + sameFileName pos + (return Nothing) $ TM $ \ env st -> + let me = (pos, map (nameOccName.idName) ids, boxLabel) c = tickBoxCount st mes = mixEntries st - in ( Just c - , st {tickBoxCount=c+1,mixEntries=me:mes} + ids = occEnvElts fvs + in ( Just (c, ids) + , noFVs + , st {tickBoxCount=c+1, mixEntries=me:mes} ) -allocATickBox boxLabel e = return Nothing +allocATickBox boxLabel pos fvs = return Nothing allocBinTickBox :: (Bool -> BoxLabel) -> LHsExpr Id -> TM (LHsExpr Id) -allocBinTickBox boxLabel (L pos e) | Just hpcPos <- mkHpcPos pos = TM $ \ st -> - let meT = (hpcPos,boxLabel True) - meF = (hpcPos,boxLabel False) - meE = (hpcPos,ExpBox) +allocBinTickBox boxLabel (L pos e) | isGoodSrcSpan' pos = TM $ \ env st -> + let meT = (pos,[],boxLabel True) + meF = (pos,[],boxLabel False) + meE = (pos,[],ExpBox False) 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... + , noFVs + , st {tickBoxCount=c+3 , mixEntries=meF:meT:meE:mes} + ) + else + ( L pos $ HsTick c [] $ L pos e + , noFVs + , st {tickBoxCount=c+1,mixEntries=meE:mes} + ) allocBinTickBox boxLabel e = return e -mkHpcPos :: SrcSpan -> Maybe HpcPos +isGoodSrcSpan' pos + | not (isGoodSrcSpan pos) = False + | start == end = False + | otherwise = True + where + start = srcSpanStart pos + end = srcSpanEnd pos + +mkHpcPos :: SrcSpan -> HpcPos mkHpcPos pos - | not (isGoodSrcSpan pos) = Nothing - | start == end = Nothing -- no actual location - | otherwise = Just hpcPos + | not (isGoodSrcSpan' pos) = panic "bad source span; expected such spans to be filtered out" + | otherwise = hpcPos where start = srcSpanStart pos end = srcSpanEnd pos @@ -497,151 +719,30 @@ mkHpcPos pos , srcLocCol end ) +noHpcPos = toHpcPos (0,0,0,0) + hpcSrcSpan = mkGeneralSrcSpan (FSLIT("Haskell Program Coverage internals")) +\end{code} + --- all newly allocated locations have an HPC tag on them, to help debuging -hpcLoc :: e -> Located e -hpcLoc = L hpcSrcSpan +\begin{code} +matchesOneOfMany :: [LMatch Id] -> Bool +matchesOneOfMany lmatches = sum (map matchCount lmatches) > 1 + where + matchCount (L _ (Match _pats _ty (GRHSs grhss _binds))) = length grhss \end{code} \begin{code} ---------------------------------------------------------------- --- Datatypes and file-access routines for the per-module (.mix) --- indexes used by Hpc. --- Colin Runciman and Andy Gill, June 2006 ---------------------------------------------------------------- - --- a module index records the attributes of each tick-box that has --- been introduced in that module, accessed by tick-number position --- in the list - -data Mix = Mix - FilePath -- location of original file - Integer -- time (in seconds) of original file's last update, since 1970. - Int -- tab stop value - [MixEntry] -- entries - deriving (Show,Read) - --- We would rather use ClockTime in Mix, but ClockTime has no Read instance in 6.4 and before, --- but does in 6.6. Definining the instance for ClockTime here is the Wrong Thing to do, --- because if some other program also defined that instance, we will not be able to compile. - -type MixEntry = (HpcPos, BoxLabel) - -data BoxLabel = ExpBox - | AltBox - | TopLevelBox [String] - | LocalBox [String] - -- | UserBox (Maybe String) - | GuardBinBox Bool - | CondBinBox Bool - | QualBinBox Bool - -- | PreludeBinBox String Bool - -- | UserBinBox (Maybe String) Bool - 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" - -getModificationTime' :: FilePath -> IO Integer -getModificationTime' file = do - (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 - -instance Show HpcPos where - show (P l1 c1 l2 c2) = show l1 ++ ':' : show c1 ++ '-' : show l2 ++ ':' : show c2 - -instance Read HpcPos where - readsPrec _i pos = [(toHpcPos (read l1,read c1,read l2,read c2),after)] - where - (before,after) = span (/= ',') pos - (lhs,rhs) = case span (/= '-') before of - (lhs,'-':rhs) -> (lhs,rhs) - (lhs,"") -> (lhs,lhs) - (l1,':':c1) = span (/= ':') lhs - (l2,':':c2) = span (/= ':') rhs +type MixEntry_ = (SrcSpan, [OccName], BoxLabel) -\end{code} +-- For the hash value, we hash everything: the file name, +-- the timestamp of the original source file, the tab stop, +-- and the mix entries. We cheat, and hash the show'd string. +-- This hash only has to be hashed at Mix creation time, +-- and is for sanity checking only. +mixHash :: FilePath -> Integer -> Int -> [MixEntry] -> Int +mixHash file tm tabstop entries = fromIntegral $ hashString + (show $ Mix file tm 0 tabstop entries) +\end{code}