X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=compiler%2FdeSugar%2FCoverage.lhs;h=4feb4f4737f9495f98db11d0b53d153166074fdc;hb=61b0ea8101e1128e6b0e59476a220c99e3d4f211;hp=5fb1fa5f8f32ef236bedd19706b88d05ee5ace77;hpb=d0b1049f85fab857ec1dc12d1c20d5ea9a5a854a;p=ghc-hetmet.git diff --git a/compiler/deSugar/Coverage.lhs b/compiler/deSugar/Coverage.lhs index 5fb1fa5..4feb4f4 100644 --- a/compiler/deSugar/Coverage.lhs +++ b/compiler/deSugar/Coverage.lhs @@ -19,9 +19,11 @@ import ErrUtils import Name import Bag import Var +import VarSet import Data.List import FastString import StaticFlags +import UniqFM import Data.Array import System.Time (ClockTime(..)) @@ -61,12 +63,13 @@ addCoverageTicksToBinds dflags mod mod_loc binds = do let mod_name = moduleNameString (moduleName mod) - let (binds1,st) + let (binds1,_,st) = unTM (addTickLHsBinds binds) - $ TT { modName = mod_name + TT { modName = mod_name , declPath = [] , tickBoxCount = 0 , mixEntries = [] + , inScope = emptyVarSet } let entries = reverse $ mixEntries st @@ -77,18 +80,21 @@ addCoverageTicksToBinds dflags mod mod_loc binds = do let tabStop = 1 -- 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) + let entries' = [ (hpcPos, box) + | (span,_,box) <- entries, Just hpcPos <- [mkHpcPos span] ] + 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 + 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 @@ -116,8 +122,10 @@ addTickLHsBind (L pos (funBind@(FunBind { fun_id = (L _ id) }))) = do let name = getOccString id decl_path <- getPathEntry - mg@(MatchGroup matches' ty) <- addPathEntry name - $ addTickMatchGroup (fun_matches funBind) + (fvs, mg@(MatchGroup matches' ty)) <- + getFreeVars $ + addPathEntry name $ + addTickMatchGroup (fun_matches funBind) -- Todo: we don't want redundant ticks on simple pattern bindings if not opt_Hpc && isSimplePatBind funBind @@ -128,7 +136,8 @@ addTickLHsBind (L pos (funBind@(FunBind { fun_id = (L _ id) }))) = do else do tick_no <- allocATickBox (if null decl_path then TopLevelBox [name] - else LocalBox (name : decl_path)) pos + else LocalBox (name : decl_path)) + pos fvs return $ L pos $ funBind { fun_matches = MatchGroup matches' ty , fun_tick = tick_no @@ -160,9 +169,7 @@ addTickLHsBind other = return other -- 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 + allocTickBox ExpBox pos $ addTickHsExpr e0 addTickLHsExprNeverOrAlways :: LHsExpr Id -> TM (LHsExpr Id) addTickLHsExprNeverOrAlways e @@ -185,12 +192,11 @@ addTickLHsExprNever (L pos e0) = do -- 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 + allocTickBox ExpBox pos $ addTickHsExpr e0 + else do + e1 <- addTickHsExpr e0 return $ L pos e1 -- general heuristic: expressions which do not denote values are good break points @@ -209,10 +215,9 @@ 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 + | otherwise = + allocTickBox (if oneOfMany then AltBox else ExpBox) pos $ + addTickHsExpr e0 addBinTickLHsExpr :: (Bool -> BoxLabel) -> LHsExpr Id -> TM (LHsExpr Id) addBinTickLHsExpr boxLabel (L pos e0) = do @@ -220,7 +225,7 @@ addBinTickLHsExpr boxLabel (L pos e0) = do 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 @@ -259,11 +264,12 @@ addTickHsExpr (HsIf e1 e2 e3) = addTickHsExpr (HsLet binds e) = liftM2 HsLet (addTickHsLocalBinds binds) -- to think about: !patterns. - (addTickLHsExprNeverOrAlways e) + (bindLocals (map unLoc $ collectLocalBinders binds) $ + addTickLHsExprNeverOrAlways e) addTickHsExpr (HsDo cxt stmts last_exp srcloc) = liftM4 HsDo (return cxt) - (mapM (liftL (addTickStmt forQual)) stmts) + (addTickLStmts forQual stmts) (addTickLHsExpr last_exp) (return srcloc) where @@ -301,10 +307,9 @@ addTickHsExpr (ArithSeq ty arith_seq) = (return ty) (addTickArithSeqInfo arith_seq) 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 + e2 <- allocTickBox (ExternalBox (unpackFS file) (P l1 c1 l2 c2)) pos $ + addTickHsExpr e0 + return $ unLoc e2 addTickHsExpr (PArrSeq {}) = error "addTickHsExpr: PArrSeq" addTickHsExpr (HsSCC {}) = error "addTickHsExpr: HsSCC" addTickHsExpr (HsCoreAnn {}) = error "addTickHsExpr: HsCoreAnn" @@ -339,7 +344,7 @@ 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 (HsTick _ _ _) = error "addTickhsExpr: HsTick _ _" addTickMatchGroup (MatchGroup matches ty) = do let isOneOfMany = matchesOneOfMany matches @@ -347,56 +352,84 @@ addTickMatchGroup (MatchGroup matches ty) = do 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' <- if opt_Hpc then addTickLHsExprOptAlt isOneOfMany expr - else addTickLHsExprAlways expr + (stmts',expr') <- addTickLStmts' (Just $ GuardBinBox) stmts [] + (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 +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] + -> [LStmt Id] -> TM a -> TM ([LStmt Id], a) +addTickLStmts' isGuard [] acc do_rhs = do + rhs <- do_rhs + return (reverse acc, rhs) +addTickLStmts' isGuard (s:ss) acc do_rhs = do + (s', binders) <- addTickLStmt isGuard s + bindLocals binders $ addTickLStmts' isGuard ss (s':acc) do_rhs + +addTickLStmt isGuard (L pos stmt) = do + (stmt',vars) <- addTickStmt isGuard stmt + return (L pos stmt', vars) + +addTickStmt :: (Maybe (Bool -> BoxLabel)) -> Stmt Id -> TM (Stmt Id, [Id]) +addTickStmt isGuard (BindStmt pat e bind fail) = do + e <- liftM4 BindStmt (addTickLPat pat) (addTickLHsExprAlways e) (addTickSyntaxExpr hpcSrcSpan bind) (addTickSyntaxExpr hpcSrcSpan fail) -addTickStmt isGuard (ExprStmt e bind' ty) = - liftM3 ExprStmt + return (e, collectPatBinders pat) +addTickStmt isGuard (ExprStmt e bind' ty) = do + e <- liftM3 ExprStmt (addTick e) (addTickSyntaxExpr hpcSrcSpan bind') (return ty) + return (e, []) where addTick e | Just fn <- isGuard = addBinTickLHsExpr fn e | otherwise = addTickLHsExprAlways e -addTickStmt isGuard (LetStmt binds) = - liftM LetStmt - (addTickHsLocalBinds binds) -addTickStmt isGuard (ParStmt pairs) = - liftM ParStmt (mapM process pairs) +addTickStmt isGuard (LetStmt binds) = do + let binders = map unLoc (collectLocalBinders binds) + e <- liftM LetStmt + (bindLocals binders $ addTickHsLocalBinds binds) + return (e, binders) +addTickStmt isGuard (ParStmt pairs) = do + e <- liftM ParStmt (mapM process pairs) + return (e, []) where process (stmts,ids) = liftM2 (,) - (mapM (liftL (addTickStmt isGuard)) stmts) + (addTickLStmts isGuard stmts) (return ids) -addTickStmt isGuard (RecStmt stmts ids1 ids2 tys dictbinds) = - liftM5 RecStmt - (mapM (liftL (addTickStmt isGuard)) stmts) +addTickStmt isGuard (RecStmt stmts ids1 ids2 tys dictbinds) = do + e <- liftM5 RecStmt + (addTickLStmts isGuard stmts) (return ids1) (return ids2) (return tys) (addTickDictBinds dictbinds) + return (e,[]) addTickHsLocalBinds :: HsLocalBinds Id -> TM (HsLocalBinds Id) addTickHsLocalBinds (HsValBinds binds) = @@ -482,67 +515,119 @@ data TickTransState = TT { modName :: String , declPath :: [String] , tickBoxCount:: Int , mixEntries :: [MixEntry] + , inScope :: VarSet } - deriving Show - -data TM a = TM { unTM :: TickTransState -> (a,TickTransState) } +-- 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 :: 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) + return a = TM $ \ st -> (a,noFVs,st) (TM m) >>= k = TM $ \ st -> case m st of - (r1,st1) -> unTM (k r1) st1 + (r1,fv1,st1) -> + case unTM (k r1) st1 of + (r2,fv2,st2) -> + (r2, fv1 `plusOccEnv` fv2, st2) + +getState :: TM TickTransState +getState = TM $ \st -> (st, noFVs, st) ---addTick :: LHsExpr Id -> TM (LHsExpr Id) ---addTick e = TM $ \ uq -> (e,succ uq,[(uq,getLoc e)]) +setState :: (TickTransState -> TickTransState) -> TM () +setState f = TM $ \st -> ((), noFVs, f st) + +withState :: (TickTransState -> TickTransState) -> TM a -> TM a +withState f (TM m) = TM $ \st -> case m (f st) of + (a, fvs, st') -> (a, fvs, st') + +getFreeVars :: TM a -> TM (FreeVars, a) +getFreeVars (TM m) + = TM $ \st -> case m st of (a, fv, st') -> ((fv,a), fv, st') + +freeVar :: Id -> TM () +freeVar id = TM $ \st -> + if id `elemVarSet` inScope st + 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 = withState (\st -> st { declPath = declPath st ++ [nm] }) getPathEntry :: TM [String] -getPathEntry = TM $ \ st -> (declPath st,st) +getPathEntry = declPath `liftM` getState + +bindLocals :: [Id] -> TM a -> TM a +bindLocals new_ids (TM m) + = TM $ \ st -> case m st{ inScope = inScope st `extendVarSetList` new_ids } of + (r, fv, st') -> (r, fv `delListFromUFM` occs, st') + where occs = [ nameOccName (idName id) | id <- new_ids ] -- 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 = do + (fvs, e) <- getFreeVars m + TM $ \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 = TM $ \ 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 $ \ st -> + let meT = (pos,[],boxLabel True) + meF = (pos,[],boxLabel False) + meE = (pos,[],ExpBox) c = tickBoxCount st mes = mixEntries st in if opt_Hpc - then ( L pos $ HsTick c $ L pos $ HsBinTick (c+1) (c+2) (L pos e) + 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} + , noFVs + , st {tickBoxCount=c+3 , mixEntries=meF:meT:meE:mes} ) else - ( L pos $ HsTick c $ L pos e + ( L pos $ HsTick c [] $ L pos e + , noFVs , st {tickBoxCount=c+1,mixEntries=meE:mes} ) @@ -589,14 +674,15 @@ 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) + [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) +type MixEntry = (SrcSpan, [OccName], BoxLabel) +type MixEntry_ = (HpcPos, BoxLabel) data BoxLabel = ExpBox | AltBox