X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=compiler%2Fghci%2FDebugger.hs;h=141a513f4514d6031d4697e67ff82c91ca2a6cc8;hp=f0f89730339ce8fbb9e86a5fb670622db5506d08;hb=b2524b3960999fffdb3767900f58825903f6560f;hpb=cdce647711c0f46f5799b24de087622cb77e647f diff --git a/compiler/ghci/Debugger.hs b/compiler/ghci/Debugger.hs index f0f8973..141a513 100644 --- a/compiler/ghci/Debugger.hs +++ b/compiler/ghci/Debugger.hs @@ -4,37 +4,31 @@ -- -- Pepe Iborra (supported by Google SoC) 2006 -- +-- ToDo: lots of violation of layering here. This module should +-- decide whether it is above the GHC API (import GHC and nothing +-- else) or below it. +-- ----------------------------------------------------------------------------- -module Debugger (pprintClosureCommand, instantiateTyVarsToUnknown) where +module Debugger (pprintClosureCommand, showTerm, pprTypeAndContents) where import Linker import RtClosureInspect -import PrelNames +import GhcMonad import HscTypes -import IdInfo ---import Id +import Id +import Name import Var hiding ( varName ) import VarSet -import VarEnv -import Name -import NameEnv -import RdrName import UniqSupply -import Type -import TyCon -import DataCon -import TcGadt +import TcType import GHC -import GhciMonad - +import InteractiveEval import Outputable -import Pretty ( Mode(..), showDocWith ) -import FastString -import SrcLoc +import PprTyThing +import MonadUtils -import Control.Exception import Control.Monad import Data.List import Data.Maybe @@ -43,249 +37,192 @@ import Data.IORef import System.IO import GHC.Exts -#include "HsVersions.h" - ------------------------------------- -- | The :print & friends commands ------------------------------------- -pprintClosureCommand :: Bool -> Bool -> String -> GHCi () -pprintClosureCommand bindThings force str = do - cms <- getSession - newvarsNames <- io$ do - uniques <- liftM uniqsFromSupply (mkSplitUniqSupply 'q') - return$ map (\u-> (mkSysTvName u (mkFastString "a"))) uniques - mb_ids <- io$ mapM (cleanUp cms newvarsNames) (words str) - mb_new_ids <- mapM (io . go cms) (catMaybes mb_ids) - io$ updateIds cms (catMaybes mb_new_ids) - where - -- Find the Id, clean up 'Unknowns' - cleanUp :: Session -> [Name] -> String -> IO (Maybe Id) - cleanUp cms newNames str = do - tythings <- GHC.parseName cms str >>= mapM (GHC.lookupName cms) - return$ listToMaybe (map (stripUnknowns newNames) - [ i | Just (AnId i) <- tythings]) - - -- Do the obtainTerm--bindSuspensions-refineIdType dance - -- Warning! This function got a good deal of side-effects - go :: Session -> Id -> IO (Maybe Id) - go cms id = do - mb_term <- obtainTerm cms force id - maybe (return Nothing) `flip` mb_term $ \term -> do - term' <- if not bindThings then return term - else bindSuspensions cms term - showterm <- pprTerm cms term' - unqual <- GHC.getPrintUnqual cms - let showSDocForUserOneLine unqual doc = - showDocWith LeftMode (doc (mkErrStyle unqual)) - (putStrLn . showSDocForUserOneLine unqual) (ppr id <+> char '=' <+> showterm) +pprintClosureCommand :: GhcMonad m => Bool -> Bool -> String -> m () +pprintClosureCommand bindThings force str = do + tythings <- (catMaybes . concat) `liftM` + mapM (\w -> GHC.parseName w >>= + mapM GHC.lookupName) + (words str) + let ids = [id | AnId id <- tythings] + + -- Obtain the terms and the recovered type information + (subst, terms) <- mapAccumLM go emptyTvSubst ids + + -- Apply the substitutions obtained after recovering the types + modifySession $ \hsc_env -> + hsc_env{hsc_IC = substInteractiveContext (hsc_IC hsc_env) subst} + + -- Finally, print the Terms + unqual <- GHC.getPrintUnqual + docterms <- mapM showTerm terms + liftIO $ (printForUser stdout unqual . vcat) + (zipWith (\id docterm -> ppr id <+> char '=' <+> docterm) + ids + docterms) + where + -- Do the obtainTerm--bindSuspensions-computeSubstitution dance + go :: GhcMonad m => TvSubst -> Id -> m (TvSubst, Term) + go subst id = do + let id' = id `setIdType` substTy subst (idType id) + term_ <- GHC.obtainTermFromId maxBound force id' + term <- tidyTermTyVars term_ + term' <- if bindThings && + False == isUnliftedTypeKind (termType term) + then bindSuspensions term + else return term -- Before leaving, we compare the type obtained to see if it's more specific - -- Note how we need the Unknown-clear type returned by obtainTerm - let Just reconstructedType = termType term - new_type <- instantiateTyVarsToUnknown cms - (mostSpecificType (idType id) reconstructedType) - return . Just $ setIdType id new_type - - updateIds :: Session -> [Id] -> IO () - updateIds (Session ref) new_ids = do - hsc_env <- readIORef ref - let ictxt = hsc_IC hsc_env - type_env = ic_type_env ictxt - filtered_type_env = delListFromNameEnv type_env (map idName new_ids) - new_type_env = extendTypeEnvWithIds filtered_type_env new_ids - new_ic = ictxt {ic_type_env = new_type_env } - writeIORef ref (hsc_env {hsc_IC = new_ic }) - -isMoreSpecificThan :: Type -> Type -> Bool -ty `isMoreSpecificThan` ty1 - | Just subst <- tcUnifyTys bindOnlyTy1 [repType' ty] [repType' ty1] - , substFiltered <- filter (not.isTyVarTy) . varEnvElts . getTvSubstEnv $ subst - , not . null $ substFiltered - , all (flip notElemTvSubst subst) ty_vars - = True - | otherwise = False - where bindOnlyTy1 tyv | tyv `elem` ty_vars = AvoidMe - | otherwise = BindMe - ty_vars = varSetElems$ tyVarsOfType ty - -mostSpecificType ty1 ty2 | ty1 `isMoreSpecificThan` ty2 = ty1 - | otherwise = ty2 + -- Then, we extract a substitution, + -- mapping the old tyvars to the reconstructed types. + let reconstructed_type = termType term + hsc_env <- getSession + case (improveRTTIType hsc_env (idType id) (reconstructed_type)) of + Nothing -> return (subst, term') + Just subst' -> do { traceOptIf Opt_D_dump_rtti + (fsep $ [text "RTTI Improvement for", ppr id, + text "is the substitution:" , ppr subst']) + ; return (subst `unionTvSubst` subst', term')} + + tidyTermTyVars :: GhcMonad m => Term -> m Term + tidyTermTyVars t = + withSession $ \hsc_env -> do + let env_tvs = tyVarsOfTypes (map idType (ic_tmp_ids (hsc_IC hsc_env))) + my_tvs = termTyVars t + tvs = env_tvs `minusVarSet` my_tvs + tyvarOccName = nameOccName . tyVarName + tidyEnv = (initTidyOccEnv (map tyvarOccName (varSetElems tvs)) + , env_tvs `intersectVarSet` my_tvs) + return$ mapTermType (snd . tidyOpenType tidyEnv) t -- | Give names, and bind in the interactive environment, to all the suspensions -- included (inductively) in a term -bindSuspensions :: Session -> Term -> IO Term -bindSuspensions cms@(Session ref) t = do - hsc_env <- readIORef ref - inScope <- GHC.getBindings cms +bindSuspensions :: GhcMonad m => Term -> m Term +bindSuspensions t = do + hsc_env <- getSession + inScope <- GHC.getBindings let ictxt = hsc_IC hsc_env - rn_env = ic_rn_local_env ictxt - type_env = ic_type_env ictxt prefix = "_t" alreadyUsedNames = map (occNameString . nameOccName . getName) inScope - availNames = map ((prefix++) . show) [1..] \\ alreadyUsedNames - availNames_var <- newIORef availNames - (t', stuff) <- foldTerm (nameSuspensionsAndGetInfos availNames_var) t + availNames = map ((prefix++) . show) [(1::Int)..] \\ alreadyUsedNames + availNames_var <- liftIO $ newIORef availNames + (t', stuff) <- liftIO $ foldTerm (nameSuspensionsAndGetInfos availNames_var) t let (names, tys, hvals) = unzip3 stuff - concrete_tys <- mapM (instantiateTyVarsToUnknown cms) tys - let ids = [ mkGlobalId VanillaGlobal name ty vanillaIdInfo - | (name,ty) <- zip names concrete_tys] - new_type_env = extendTypeEnvWithIds type_env ids - new_rn_env = extendLocalRdrEnv rn_env names - new_ic = ictxt { ic_rn_local_env = new_rn_env, - ic_type_env = new_type_env } - extendLinkEnv (zip names hvals) - writeIORef ref (hsc_env {hsc_IC = new_ic }) + let ids = [ mkVanillaGlobal name ty + | (name,ty) <- zip names tys] + new_ic = extendInteractiveContext ictxt ids + liftIO $ extendLinkEnv (zip names hvals) + modifySession $ \_ -> hsc_env {hsc_IC = new_ic } return t' - where + where -- Processing suspensions. Give names and recopilate info - nameSuspensionsAndGetInfos :: IORef [String] -> TermFold (IO (Term, [(Name,Type,HValue)])) - nameSuspensionsAndGetInfos freeNames = TermFold + nameSuspensionsAndGetInfos :: IORef [String] -> + TermFold (IO (Term, [(Name,Type,HValue)])) + nameSuspensionsAndGetInfos freeNames = TermFold { fSuspension = doSuspension freeNames - , fTerm = \ty dc v tt -> do - tt' <- sequence tt - let (terms,names) = unzip tt' + , fTerm = \ty dc v tt -> do + tt' <- sequence tt + let (terms,names) = unzip tt' return (Term ty dc v terms, concat names) , fPrim = \ty n ->return (Prim ty n,[]) + , fNewtypeWrap = + \ty dc t -> do + (term, names) <- t + return (NewtypeWrap ty dc term, names) + , fRefWrap = \ty t -> do + (term, names) <- t + return (RefWrap ty term, names) } - doSuspension freeNames ct mb_ty hval Nothing = do + doSuspension freeNames ct ty hval _name = do name <- atomicModifyIORef freeNames (\x->(tail x, head x)) - n <- newGrimName cms name - let ty' = fromMaybe (error "unexpected") mb_ty - return (Suspension ct mb_ty hval (Just n), [(n,ty',hval)]) + n <- newGrimName name + return (Suspension ct ty hval (Just n), [(n,ty,hval)]) -- A custom Term printer to enable the use of Show instances -pprTerm cms@(Session ref) = customPrintTerm customPrint +showTerm :: GhcMonad m => Term -> m SDoc +showTerm term = do + dflags <- GHC.getSessionDynFlags + if dopt Opt_PrintEvldWithShow dflags + then cPprTerm (liftM2 (++) (\_y->[cPprShowable]) cPprTermBase) term + else cPprTerm cPprTermBase term where - customPrint = \p-> customPrintShowable : customPrintTermBase p - customPrintShowable t@Term{ty=ty, dc=dc, val=val} = do - let hasType = isEmptyVarSet (tyVarsOfType ty) -- redundant - isEvaled = isFullyEvaluatedTerm t - if not isEvaled -- || not hasType + cPprShowable prec t@Term{ty=ty, val=val} = + if not (isFullyEvaluatedTerm t) then return Nothing - else do - hsc_env <- readIORef ref - dflags <- GHC.getSessionDynFlags cms + else do + hsc_env <- getSession + dflags <- GHC.getSessionDynFlags do (new_env, bname) <- bindToFreshName hsc_env ty "showme" - writeIORef ref (new_env) - let noop_log _ _ _ _ = return () + setSession new_env + -- XXX: this tries to disable logging of errors + -- does this still do what it is intended to do + -- with the changed error handling and logging? + let noop_log _ _ _ _ = return () expr = "show " ++ showSDoc (ppr bname) - GHC.setSessionDynFlags cms dflags{log_action=noop_log} - mb_txt <- withExtendedLinkEnv [(bname, val)] - (GHC.compileExpr cms expr) - case mb_txt of - Just txt -> return . Just . text . unsafeCoerce# $ txt - Nothing -> return Nothing - `finally` do - writeIORef ref hsc_env - GHC.setSessionDynFlags cms dflags - + _ <- GHC.setSessionDynFlags dflags{log_action=noop_log} + txt_ <- withExtendedLinkEnv [(bname, val)] + (GHC.compileExpr expr) + let myprec = 10 -- application precedence. TODO Infix constructors + let txt = unsafeCoerce# txt_ + if not (null txt) then + return $ Just$ cparen (prec >= myprec && + needsParens txt) + (text txt) + else return Nothing + `gfinally` do + setSession hsc_env + GHC.setSessionDynFlags dflags + cPprShowable prec NewtypeWrap{ty=new_ty,wrapped_term=t} = + cPprShowable prec t{ty=new_ty} + cPprShowable _ _ = return Nothing + + needsParens ('"':_) = False -- some simple heuristics to see whether parens + -- are redundant in an arbitrary Show output + needsParens ('(':_) = False + needsParens txt = ' ' `elem` txt + + bindToFreshName hsc_env ty userName = do - name <- newGrimName cms userName + name <- newGrimName userName let ictxt = hsc_IC hsc_env - rn_env = ic_rn_local_env ictxt - type_env = ic_type_env ictxt - id = mkGlobalId VanillaGlobal name ty vanillaIdInfo - new_type_env = extendTypeEnv type_env (AnId id) - new_rn_env = extendLocalRdrEnv rn_env [name] - new_ic = ictxt { ic_rn_local_env = new_rn_env, - ic_type_env = new_type_env } + tmp_ids = ic_tmp_ids ictxt + id = mkVanillaGlobal name ty + new_ic = ictxt { ic_tmp_ids = id : tmp_ids } return (hsc_env {hsc_IC = new_ic }, name) -- Create new uniques and give them sequentially numbered names --- newGrimName :: Session -> String -> IO Name -newGrimName cms userName = do - us <- mkSplitUniqSupply 'b' +newGrimName :: MonadIO m => String -> m Name +newGrimName userName = do + us <- liftIO $ mkSplitUniqSupply 'b' let unique = uniqFromSupply us occname = mkOccName varName userName - name = mkInternalName unique occname noSrcLoc + name = mkInternalName unique occname noSrcSpan return name ----------------------------------------------------------------------------- --- | Replace all the tyvars in a Term with the opaque type GHC.Base.Unknown ----------------------------------------------------------------------------- -instantiateTyVarsToUnknown :: Session -> Type -> IO Type -instantiateTyVarsToUnknown cms ty --- We have a GADT, so just fix its tyvars - | Just (tycon, args) <- splitTyConApp_maybe ty - , tycon /= funTyCon - , isGADT tycon - = mapM fixTyVars args >>= return . mkTyConApp tycon --- We have a regular TyCon, so map recursively to its args - | Just (tycon, args) <- splitTyConApp_maybe ty - , tycon /= funTyCon - = do unknownTyVar <- unknownTV - args' <- mapM (instantiateTyVarsToUnknown cms) args - return$ mkTyConApp tycon args' --- we have a tyvar of kind * - | Just tyvar <- getTyVar_maybe ty - , ([],_) <- splitKindFunTys (tyVarKind tyvar) - = unknownTV --- we have a higher kind tyvar, so insert an unknown of the appropriate kind - | Just tyvar <- getTyVar_maybe ty - , (args,_) <- splitKindFunTys (tyVarKind tyvar) - = liftM mkTyConTy $ unknownTC !! length args --- Base case - | otherwise = return ty - - where unknownTV = do - Just (ATyCon unknown_tc) <- lookupName cms unknownTyConName - return$ mkTyConTy unknown_tc - unknownTC = [undefined, unknownTC1, unknownTC2, unknownTC3] - unknownTC1 = do - Just (ATyCon unknown_tc) <- lookupName cms unknown1TyConName - return unknown_tc - unknownTC2 = do - Just (ATyCon unknown_tc) <- lookupName cms unknown2TyConName - return unknown_tc - unknownTC3 = do - Just (ATyCon unknown_tc) <- lookupName cms unknown3TyConName - return unknown_tc --- isGADT ty | pprTrace' "isGADT" (ppr ty <> colon <> ppr(isGadtSyntaxTyCon ty)) False = undefined - isGADT tc | Just dcs <- tyConDataCons_maybe tc = any (not . null . dataConEqSpec) dcs - | otherwise = False - fixTyVars ty - | Just (tycon, args) <- splitTyConApp_maybe ty - = mapM fixTyVars args >>= return . mkTyConApp tycon --- Fix the tyvar so that the interactive environment doesn't choke on it TODO - | Just tv <- getTyVar_maybe ty = return ty --TODO - | otherwise = return ty - --- | The inverse function. Strip the GHC.Base.Unknowns in the type of the id, they correspond to tyvars. The caller must provide an infinite list of fresh names -stripUnknowns :: [Name] -> Id -> Id -stripUnknowns names id = setIdType id . fst . go names . idType - $ id - where - go tyvarsNames@(v:vv) ty - | Just (ty1,ty2) <- splitFunTy_maybe ty = let - (ty1',vv') = go tyvarsNames ty1 - (ty2',vv'')= go vv' ty2 - in (mkFunTy ty1' ty2', vv'') - | Just (ty1,ty2) <- splitAppTy_maybe ty = let - (ty1',vv') = go tyvarsNames ty1 - (ty2',vv'')= go vv' ty2 - in (mkAppTy ty1' ty2', vv'') - | Just (tycon, args) <- splitTyConApp_maybe ty - , Just (tycon', vv') <- (fixTycon tycon tyvarsNames) - , (args',vv'') <- foldr (\arg (aa,vv) -> let (arg',vv') = go vv' arg - in (arg':aa,vv')) - ([],vv') args - = (mkAppTys tycon' args',vv'') - | Just (tycon, args) <- splitTyConApp_maybe ty - , (args',vv') <- foldr (\arg (aa,vv) -> let (arg',vv') = go vv' arg - in (arg':aa,vv')) - ([],tyvarsNames) args - = (mkTyConApp tycon args',vv') - | otherwise = (ty, tyvarsNames) - where fixTycon tycon (v:vv) = do - k <- lookup (tyConName tycon) kinds - return (mkTyVarTy$ mkTyVar v k, vv) - kinds = [ (unknownTyConName, liftedTypeKind) - , (unknown1TyConName, kind1) - , (unknown2TyConName, kind2) - , (unknown3TyConName, kind3)] - kind1 = mkArrowKind liftedTypeKind liftedTypeKind - kind2 = mkArrowKind kind1 liftedTypeKind - kind3 = mkArrowKind kind2 liftedTypeKind +pprTypeAndContents :: GhcMonad m => [Id] -> m SDoc +pprTypeAndContents ids = do + dflags <- GHC.getSessionDynFlags + let pefas = dopt Opt_PrintExplicitForalls dflags + pcontents = dopt Opt_PrintBindContents dflags + if pcontents + then do + let depthBound = 100 + terms <- mapM (GHC.obtainTermFromId depthBound False) ids + docs_terms <- mapM showTerm terms + return $ vcat $ zipWith (\ty cts -> ty <+> equals <+> cts) + (map (pprTyThing pefas . AnId) ids) + docs_terms + else return $ vcat $ map (pprTyThing pefas . AnId) ids + +-------------------------------------------------------------- +-- Utils + +traceOptIf :: GhcMonad m => DynFlag -> SDoc -> m () +traceOptIf flag doc = do + dflags <- GHC.getSessionDynFlags + when (dopt flag dflags) $ liftIO $ printForUser stderr alwaysQualify doc