X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=compiler%2FdeSugar%2FCoverage.lhs;h=e97ab4252ca3f7d4afa03b2c2085f4f3d27f8b19;hp=2bbf18777dd6348bcae5ce0fb69fd84c09202a00;hb=206b4dec78250efef3cd927d64dc6cbc54a16c3d;hpb=6ebfe518116d1c97a9d46013271f359decea2d15 diff --git a/compiler/deSugar/Coverage.lhs b/compiler/deSugar/Coverage.lhs index 2bbf187..e97ab42 100644 --- a/compiler/deSugar/Coverage.lhs +++ b/compiler/deSugar/Coverage.lhs @@ -24,21 +24,20 @@ import Data.List import FastString import HscTypes import StaticFlags -import UniqFM -import Type import TyCon import FiniteMap import Data.Array -import System.Time (ClockTime(..)) -import System.Directory (getModificationTime) import System.IO (FilePath) -#if __GLASGOW_HASKELL__ < 603 +#if defined(__GLASGOW_HASKELL__) && __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} @@ -55,24 +54,25 @@ addCoverageTicksToBinds :: DynFlags -> Module -> ModLocation -- of the current module - -> [TyCon] -- type constructor in this 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, noHpcInfo, emptyModBreaks) else do + if "boot" `isSuffixOf` orig_file then return (binds, emptyHpcInfo False, emptyModBreaks) else do let mod_name = moduleNameString (moduleName mod) let (binds1,_,st) = unTM (addTickLHsBinds binds) (TTE - { modName = mod_name + { fileName = mkFastString orig_file , declPath = [] , inScope = emptyVarSet , blackList = listToFM [ (getSrcSpan (tyConName tyCon),()) @@ -88,15 +88,21 @@ addCoverageTicksToBinds dflags mod mod_loc tyCons binds = do -- write the mix entries for this module 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_dir - modTime <- getModificationTime' orig_file + 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_dir mod_name (Mix orig_file modTime hashNo tabStop entries') + mixCreate hpc_mod_dir mod_name + $ Mix orig_file modTime (toHash hashNo) tabStop entries' return $ hashNo else do return $ 0 @@ -131,14 +137,14 @@ addTickLHsBinds :: LHsBinds Id -> TM (LHsBinds Id) addTickLHsBinds binds = mapBagM addTickLHsBind binds addTickLHsBind :: LHsBind Id -> TM (LHsBind Id) -addTickLHsBind (L pos t@(AbsBinds abs_tvs abs_dicts abs_exports abs_binds)) = do +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 let name = getOccString id decl_path <- getPathEntry - (fvs, mg@(MatchGroup matches' ty)) <- + (fvs, (MatchGroup matches' ty)) <- getFreeVars $ addPathEntry name $ addTickMatchGroup (fun_matches funBind) @@ -178,12 +184,8 @@ addTickLHsBind (L pos (pat@(PatBind { pat_rhs = rhs }))) = do -} return $ L pos $ pat { pat_rhs = rhs' } -{- only internal stuff, not from source, uses VarBind, so we ignore it. -addTickLHsBind (VarBind var_id var_rhs) = do - var_rhs' <- addTickLHsExpr var_rhs - return $ VarBind var_id var_rhs' --} -addTickLHsBind other = return other +-- Only internal stuff, not from source, uses VarBind, so we ignore it. +addTickLHsBind var_bind@(L _ (VarBind {})) = return var_bind -- 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 @@ -232,7 +234,7 @@ isGoodBreakExpr (RecordCon {}) = True isGoodBreakExpr (RecordUpd {}) = True isGoodBreakExpr (ArithSeq {}) = True isGoodBreakExpr (PArrSeq {}) = True -isGoodBreakExpr other = False +isGoodBreakExpr _other = False addTickLHsExprOptAlt :: Bool -> LHsExpr Id -> TM (LHsExpr Id) addTickLHsExprOptAlt oneOfMany (L pos e0) @@ -251,7 +253,7 @@ 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) = +addTickHsExpr (HsLam matchgroup) = liftM HsLam (addTickMatchGroup matchgroup) addTickHsExpr (HsApp e1 e2) = liftM2 HsApp (addTickLHsExprNever e1) (addTickLHsExpr e2) @@ -300,7 +302,10 @@ addTickHsExpr (ExplicitList ty es) = liftM2 ExplicitList (return ty) (mapM (addTickLHsExpr) es) -addTickHsExpr (ExplicitPArr {}) = error "addTickHsExpr: ExplicitPArr" +addTickHsExpr (ExplicitPArr ty es) = + liftM2 ExplicitPArr + (return ty) + (mapM (addTickLHsExpr) es) addTickHsExpr (ExplicitTuple es box) = liftM2 ExplicitTuple (mapM (addTickLHsExpr) es) @@ -316,7 +321,6 @@ addTickHsExpr (RecordUpd e rec_binds cons tys1 tys2) = (addTickHsRecordBinds rec_binds) (return cons) (return tys1) (return tys2) -addTickHsExpr (ExprWithTySig {}) = error "addTickHsExpr: ExprWithTySig" addTickHsExpr (ExprWithTySigOut e ty) = liftM2 ExprWithTySigOut (addTickLHsExprNever e) -- No need to tick the inner expression @@ -326,13 +330,22 @@ addTickHsExpr (ArithSeq ty arith_seq) = liftM2 ArithSeq (return ty) (addTickArithSeqInfo arith_seq) -addTickHsExpr (HsTickPragma (file,(l1,c1),(l2,c2)) (L pos e0)) = do +addTickHsExpr (HsTickPragma _ (L pos e0)) = do e2 <- allocTickBox (ExpBox False) pos $ addTickHsExpr e0 return $ unLoc e2 -addTickHsExpr (PArrSeq {}) = error "addTickHsExpr: PArrSeq" -addTickHsExpr (HsSCC {}) = error "addTickHsExpr: HsSCC" -addTickHsExpr (HsCoreAnn {}) = error "addTickHsExpr: HsCoreAnn" +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 @@ -357,15 +370,12 @@ addTickHsExpr (HsArrForm e fix cmdtop) = (return fix) (mapM (liftL (addTickHsCmdTop)) cmdtop) -addTickHsExpr e@(HsType ty) = return e +addTickHsExpr e@(HsType _) = return e --- Should never happen in expression content. -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 _ _" +-- Others dhould never happen in expression content. +addTickHsExpr e = pprPanic "addTickHsExpr" (ppr e) +addTickMatchGroup :: MatchGroup Id -> TM (MatchGroup Id) addTickMatchGroup (MatchGroup matches ty) = do let isOneOfMany = matchesOneOfMany matches matches' <- mapM (liftL (addTickMatch isOneOfMany)) matches @@ -409,7 +419,7 @@ addTickLStmts' isGuard lstmts res binders = map unLoc (collectLStmtsBinders lstmts) addTickStmt :: (Maybe (Bool -> BoxLabel)) -> Stmt Id -> TM (Stmt Id) -addTickStmt isGuard (BindStmt pat e bind fail) = do +addTickStmt _isGuard (BindStmt pat e bind fail) = do liftM4 BindStmt (addTickLPat pat) (addTickLHsExprAlways e) @@ -417,23 +427,34 @@ addTickStmt isGuard (BindStmt pat e bind fail) = do (addTickSyntaxExpr hpcSrcSpan fail) addTickStmt isGuard (ExprStmt e bind' ty) = do liftM3 ExprStmt - (addTick e) + (addTick isGuard e) (addTickSyntaxExpr hpcSrcSpan bind') (return ty) - where - addTick e | Just fn <- isGuard = addBinTickLHsExpr fn e - | otherwise = addTickLHsExprAlways e - -addTickStmt isGuard (LetStmt binds) = do +addTickStmt _isGuard (LetStmt binds) = do liftM LetStmt (addTickHsLocalBinds binds) addTickStmt isGuard (ParStmt pairs) = do - liftM ParStmt (mapM process pairs) - where - process (stmts,ids) = - liftM2 (,) - (addTickLStmts isGuard stmts) - (return ids) + liftM ParStmt + (mapM (addTickStmtAndBinders isGuard) pairs) +addTickStmt isGuard (TransformStmt (stmts, ids) usingExpr maybeByExpr) = do + liftM3 TransformStmt + (addTickStmtAndBinders isGuard (stmts, ids)) + (addTickLHsExprAlways usingExpr) + (addTickMaybeByLHsExpr maybeByExpr) +addTickStmt isGuard (GroupStmt (stmts, binderMap) groupByClause) = do + liftM2 GroupStmt + (addTickStmtAndBinders isGuard (stmts, binderMap)) + (case groupByClause of + GroupByNothing usingExpr -> addTickLHsExprAlways usingExpr >>= (return . GroupByNothing) + GroupBySomething eitherUsingExpr byExpr -> do + eitherUsingExpr' <- mapEitherM addTickLHsExprAlways (addTickSyntaxExpr hpcSrcSpan) eitherUsingExpr + byExpr' <- addTickLHsExprAlways byExpr + return $ GroupBySomething eitherUsingExpr' byExpr') + where + mapEitherM f g x = do + case x of + Left a -> f a >>= (return . Left) + Right b -> g b >>= (return . Right) addTickStmt isGuard (RecStmt stmts ids1 ids2 tys dictbinds) = do liftM5 RecStmt (addTickLStmts isGuard stmts) @@ -442,6 +463,23 @@ addTickStmt isGuard (RecStmt stmts ids1 ids2 tys dictbinds) = do (return tys) (addTickDictBinds dictbinds) +addTick :: Maybe (Bool -> BoxLabel) -> LHsExpr Id -> TM (LHsExpr Id) +addTick isGuard e | Just fn <- isGuard = addBinTickLHsExpr fn e + | otherwise = addTickLHsExprAlways e + +addTickStmtAndBinders :: Maybe (Bool -> BoxLabel) -> ([LStmt Id], a) + -> TM ([LStmt Id], a) +addTickStmtAndBinders isGuard (stmts, ids) = + liftM2 (,) + (addTickLStmts isGuard stmts) + (return ids) + +addTickMaybeByLHsExpr :: Maybe (LHsExpr Id) -> TM (Maybe (LHsExpr Id)) +addTickMaybeByLHsExpr maybeByExpr = + case maybeByExpr of + Nothing -> return Nothing + Just byExpr -> addTickLHsExprAlways byExpr >>= (return . Just) + addTickHsLocalBinds :: HsLocalBinds Id -> TM (HsLocalBinds Id) addTickHsLocalBinds (HsValBinds binds) = liftM HsValBinds @@ -451,6 +489,7 @@ addTickHsLocalBinds (HsIPBinds binds) = (addTickHsIPBinds binds) addTickHsLocalBinds (EmptyLocalBinds) = return EmptyLocalBinds +addTickHsValBinds :: HsValBindsLR Id a -> TM (HsValBindsLR Id b) addTickHsValBinds (ValBindsOut binds sigs) = liftM2 ValBindsOut (mapM (\ (rec,binds') -> @@ -459,7 +498,9 @@ addTickHsValBinds (ValBindsOut binds sigs) = (addTickLHsBinds binds')) binds) (return sigs) +addTickHsValBinds _ = panic "addTickHsValBinds" +addTickHsIPBinds :: HsIPBinds Id -> TM (HsIPBinds Id) addTickHsIPBinds (IPBinds ipbinds dictbinds) = liftM2 IPBinds (mapM (liftL (addTickIPBind)) ipbinds) @@ -495,12 +536,13 @@ addTickDictBinds :: DictBinds Id -> TM (DictBinds Id) addTickDictBinds x = addTickLHsBinds x addTickHsRecordBinds :: HsRecordBinds Id -> TM (HsRecordBinds Id) -addTickHsRecordBinds (HsRecordBinds pairs) = liftM HsRecordBinds (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) = @@ -523,10 +565,10 @@ addTickArithSeqInfo (FromThenTo e1 e2 e3) = \begin{code} data TickTransState = TT { tickBoxCount:: Int - , mixEntries :: [MixEntry] + , mixEntries :: [MixEntry_] } -data TickTransEnv = TTE { modName :: String +data TickTransEnv = TTE { fileName :: FastString , declPath :: [String] , inScope :: VarSet , blackList :: FiniteMap SrcSpan () @@ -535,6 +577,7 @@ data TickTransEnv = TTE { modName :: String -- deriving Show type FreeVars = OccEnv Id +noFVs :: FreeVars noFVs = emptyOccEnv -- Note [freevars] @@ -554,7 +597,7 @@ data TM a = TM { unTM :: TickTransEnv -> TickTransState -> (a,FreeVars,TickTrans -- monad (FreeVars). instance Monad TM where - return a = TM $ \ env st -> (a,noFVs,st) + return a = TM $ \ _env st -> (a,noFVs,st) (TM m) >>= k = TM $ \ env st -> case m env st of (r1,fv1,st1) -> @@ -565,8 +608,8 @@ instance Monad TM where -- getState :: TM TickTransState -- getState = TM $ \ env st -> (st, noFVs, st) -setState :: (TickTransState -> TickTransState) -> TM () -setState f = TM $ \ env st -> ((), noFVs, f st) +-- setState :: (TickTransState -> TickTransState) -> TM () +-- setState f = TM $ \ env st -> ((), noFVs, f st) getEnv :: TM TickTransEnv getEnv = TM $ \ env st -> (env, noFVs, st) @@ -592,11 +635,22 @@ addPathEntry nm = withEnv (\ env -> env { declPath = declPath env ++ [nm] }) getPathEntry :: TM [String] 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') + (r, fv, st') -> (r, fv `delListFromOccEnv` occs, st') where occs = [ nameOccName (idName id) | id <- new_ids ] isBlackListed :: SrcSpan -> TM Bool @@ -608,9 +662,11 @@ isBlackListed pos = TM $ \ env st -> -- the tick application inherits the source position of its -- expression argument to support nested box allocations allocTickBox :: BoxLabel -> SrcSpan -> TM (HsExpr Id) -> TM (LHsExpr Id) -allocTickBox boxLabel pos m | isGoodSrcSpan' pos = do +allocTickBox boxLabel pos m | isGoodSrcSpan' pos = + sameFileName pos + (do e <- m; return (L pos e)) $ do (fvs, e) <- getFreeVars m - TM $ \ env st -> + TM $ \ _env st -> let c = tickBoxCount st ids = occEnvElts fvs mes = mixEntries st @@ -620,12 +676,14 @@ allocTickBox boxLabel pos m | isGoodSrcSpan' pos = do , fvs , st {tickBoxCount=c+1,mixEntries=me:mes} ) -allocTickBox boxLabel pos m = do e <- m; return (L pos e) +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 -> FreeVars -> TM (Maybe (Int,[Id])) -allocATickBox boxLabel pos fvs | isGoodSrcSpan' pos = TM $ \ env st -> +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 @@ -634,10 +692,10 @@ allocATickBox boxLabel pos fvs | isGoodSrcSpan' pos = TM $ \ env st -> , noFVs , st {tickBoxCount=c+1, mixEntries=me:mes} ) -allocATickBox boxLabel pos fvs = return Nothing +allocATickBox _boxLabel _pos _fvs = return Nothing allocBinTickBox :: (Bool -> BoxLabel) -> LHsExpr Id -> TM (LHsExpr Id) -allocBinTickBox boxLabel (L pos e) | isGoodSrcSpan' pos = TM $ \ env st -> +allocBinTickBox boxLabel (L pos e) | isGoodSrcSpan' pos = TM $ \ _env st -> let meT = (pos,[],boxLabel True) meF = (pos,[],boxLabel False) meE = (pos,[],ExpBox False) @@ -658,8 +716,9 @@ allocBinTickBox boxLabel (L pos e) | isGoodSrcSpan' pos = TM $ \ env st -> , st {tickBoxCount=c+1,mixEntries=meE:mes} ) -allocBinTickBox boxLabel e = return e +allocBinTickBox _boxLabel e = return e +isGoodSrcSpan' :: SrcSpan -> Bool isGoodSrcSpan' pos | not (isGoodSrcSpan pos) = False | start == end = False @@ -681,8 +740,7 @@ mkHpcPos pos , srcLocCol end ) -noHpcPos = toHpcPos (0,0,0,0) - +hpcSrcSpan :: SrcSpan hpcSrcSpan = mkGeneralSrcSpan (FSLIT("Haskell Program Coverage internals")) \end{code} @@ -696,37 +754,7 @@ matchesOneOfMany lmatches = sum (map matchCount lmatches) > 1 \begin{code} --- | 'Mix' is the information about a modules static properties, like --- location of Tix's in a file. --- tab stops are the size of a tab in the provided line:colunm values. --- * In GHC, this is 1 (a tab is just a character) --- * With hpc-tracer, this is 8 (a tab represents several spaces). - -data Mix = Mix - FilePath -- ^location of original file - Integer -- ^time (in seconds) of original file's last update, since 1970. - Int -- ^hash of mix entry + timestamp - 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 = (SrcSpan, [OccName], BoxLabel) -type MixEntry_ = (HpcPos, BoxLabel) - -data BoxLabel = ExpBox Bool -- isAlt - | TopLevelBox [String] - | LocalBox [String] - | BinBox CondBox Bool - deriving (Read, Show, Eq, Ord) - -data CondBox = GuardBinBox - | CondBinBox - | QualBinBox - deriving (Read, Show, Eq, Ord) +type MixEntry_ = (SrcSpan, [OccName], BoxLabel) -- For the hash value, we hash everything: the file name, -- the timestamp of the original source file, the tab stop, @@ -734,42 +762,7 @@ data CondBox = GuardBinBox -- This hash only has to be hashed at Mix creation time, -- and is for sanity checking only. -mixHash :: FilePath -> Integer -> Int -> [MixEntry_] -> Int +mixHash :: FilePath -> Integer -> Int -> [MixEntry] -> Int mixHash file tm tabstop entries = fromIntegral $ hashString (show $ Mix file tm 0 tabstop entries) - -mixCreate :: String -> String -> Mix -> IO () -mixCreate dirName modName mix = - writeFile (mixName dirName modName) (show mix) - -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 - --- a program index records module names and numbers of tick-boxes --- introduced in each module that has been transformed for coverage - -data HpcPos = P !Int !Int !Int !Int deriving (Eq) - -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 - \end{code} -