1 -----------------------------------------------------------------------------
3 -- GHCi Interactive debugging commands
5 -- Pepe Iborra (supported by Google SoC) 2006
7 -- ToDo: lots of violation of layering here. This module should
8 -- decide whether it is above the GHC API (import GHC and nothing
11 -----------------------------------------------------------------------------
13 module Debugger (pprintClosureCommand) where
16 import RtClosureInspect
22 import Var hiding ( varName )
33 import Pretty ( Mode(..), showDocWith )
37 import Control.Exception
46 #include "HsVersions.h"
48 -------------------------------------
49 -- | The :print & friends commands
50 -------------------------------------
51 pprintClosureCommand :: Session -> Bool -> Bool -> String -> IO ()
52 pprintClosureCommand session bindThings force str = do
53 tythings <- (catMaybes . concat) `liftM`
54 mapM (\w -> GHC.parseName session w >>=
55 mapM (GHC.lookupName session))
57 substs <- catMaybes `liftM` mapM (go session)
58 [id | AnId id <- tythings]
59 mapM (applySubstToEnv session . skolemSubst) substs
63 -- Do the obtainTerm--bindSuspensions-computeSubstitution dance
64 go :: Session -> Id -> IO (Maybe TvSubst)
66 mb_term <- obtainTerm cms force id
67 maybe (return Nothing) `flip` mb_term $ \term_ -> do
68 term <- tidyTermTyVars cms term_
69 term' <- if not bindThings then return term
70 else bindSuspensions cms term
71 showterm <- printTerm cms term'
72 unqual <- GHC.getPrintUnqual cms
73 let showSDocForUserOneLine unqual doc =
74 showDocWith LeftMode (doc (mkErrStyle unqual))
75 (putStrLn . showSDocForUserOneLine unqual) (ppr id <+> char '=' <+> showterm)
76 -- Before leaving, we compare the type obtained to see if it's more specific
77 -- Then, we extract a substitution,
78 -- mapping the old tyvars to the reconstructed types.
79 let Just reconstructed_type = termType term
81 -- tcUnifyTys doesn't look through forall's, so we drop them from
82 -- the original type, instead of sigma-typing the reconstructed type
83 -- In addition, we strip newtypes too, since the reconstructed type might
84 -- not have recovered them all
85 mb_subst = tcUnifyTys (const BindMe)
86 [repType' $ dropForAlls$ idType id]
87 [repType' $ reconstructed_type]
89 ASSERT2 (isJust mb_subst, ppr reconstructed_type $$ (ppr$ idType id))
92 applySubstToEnv :: Session -> TvSubst -> IO ()
93 applySubstToEnv cms subst | isEmptyTvSubst subst = return ()
94 applySubstToEnv cms@(Session ref) subst = do
95 hsc_env <- readIORef ref
96 inScope <- GHC.getBindings cms
97 let ictxt = hsc_IC hsc_env
98 type_env = ic_type_env ictxt
99 ids = typeEnvIds type_env
100 ids' = map (\id -> id `setIdType` substTy subst (idType id)) ids
101 type_env'= extendTypeEnvWithIds type_env ids'
102 subst_dom= varEnvKeys$ getTvSubstEnv subst
103 ictxt' = ictxt { ic_type_env = type_env'
104 , ic_tyvars = foldl' delVarSetByKey
107 writeIORef ref (hsc_env {hsc_IC = ictxt'})
109 tidyTermTyVars :: Session -> Term -> IO Term
110 tidyTermTyVars (Session ref) t = do
111 hsc_env <- readIORef ref
112 let env_tvs = ic_tyvars (hsc_IC hsc_env)
113 my_tvs = termTyVars t
114 tvs = env_tvs `minusVarSet` my_tvs
115 tyvarOccName = nameOccName . tyVarName
116 tidyEnv = (initTidyOccEnv (map tyvarOccName (varSetElems tvs))
117 , env_tvs `intersectVarSet` my_tvs)
118 return$ mapTermType (snd . tidyOpenType tidyEnv) t
120 -- | Give names, and bind in the interactive environment, to all the suspensions
121 -- included (inductively) in a term
122 bindSuspensions :: Session -> Term -> IO Term
123 bindSuspensions cms@(Session ref) t = do
124 hsc_env <- readIORef ref
125 inScope <- GHC.getBindings cms
126 let ictxt = hsc_IC hsc_env
127 type_env = ic_type_env ictxt
129 alreadyUsedNames = map (occNameString . nameOccName . getName) inScope
130 availNames = map ((prefix++) . show) [1..] \\ alreadyUsedNames
131 availNames_var <- newIORef availNames
132 (t', stuff) <- foldTerm (nameSuspensionsAndGetInfos availNames_var) t
133 let (names, tys, hvals) = unzip3 stuff
134 let tys' = map mk_skol_ty tys
135 let ids = [ mkGlobalId VanillaGlobal name ty vanillaIdInfo
136 | (name,ty) <- zip names tys']
137 new_tyvars = tyVarsOfTypes tys'
138 new_type_env = extendTypeEnvWithIds type_env ids
139 old_tyvars = ic_tyvars ictxt
140 new_ic = ictxt { ic_type_env = new_type_env,
141 ic_tyvars = old_tyvars `unionVarSet` new_tyvars }
142 extendLinkEnv (zip names hvals)
143 writeIORef ref (hsc_env {hsc_IC = new_ic })
147 -- Processing suspensions. Give names and recopilate info
148 nameSuspensionsAndGetInfos :: IORef [String] -> TermFold (IO (Term, [(Name,Type,HValue)]))
149 nameSuspensionsAndGetInfos freeNames = TermFold
151 fSuspension = doSuspension freeNames
152 , fTerm = \ty dc v tt -> do
154 let (terms,names) = unzip tt'
155 return (Term ty dc v terms, concat names)
156 , fPrim = \ty n ->return (Prim ty n,[])
158 doSuspension freeNames ct mb_ty hval Nothing = do
159 name <- atomicModifyIORef freeNames (\x->(tail x, head x))
160 n <- newGrimName cms name
161 let ty' = fromMaybe (error "unexpected") mb_ty
162 return (Suspension ct mb_ty hval (Just n), [(n,ty',hval)])
165 -- A custom Term printer to enable the use of Show instances
166 printTerm cms@(Session ref) = cPprTerm cPpr
168 cPpr = \p-> cPprShowable : cPprTermBase p
169 cPprShowable prec t@Term{ty=ty, dc=dc, val=val} = do
170 let hasType = isEmptyVarSet (tyVarsOfType ty) -- redundant
171 isEvaled = isFullyEvaluatedTerm t
172 if not isEvaled -- || not hasType
175 hsc_env <- readIORef ref
176 dflags <- GHC.getSessionDynFlags cms
178 (new_env, bname) <- bindToFreshName hsc_env ty "showme"
179 writeIORef ref (new_env)
180 let noop_log _ _ _ _ = return ()
181 expr = "show " ++ showSDoc (ppr bname)
182 GHC.setSessionDynFlags cms dflags{log_action=noop_log}
183 mb_txt <- withExtendedLinkEnv [(bname, val)]
184 (GHC.compileExpr cms expr)
185 let myprec = 9 -- TODO Infix constructors
187 Just txt -> return . Just . text . unsafeCoerce#
189 Nothing -> return Nothing
191 writeIORef ref hsc_env
192 GHC.setSessionDynFlags cms dflags
194 bindToFreshName hsc_env ty userName = do
195 name <- newGrimName cms userName
196 let ictxt = hsc_IC hsc_env
197 type_env = ic_type_env ictxt
198 id = mkGlobalId VanillaGlobal name ty vanillaIdInfo
199 new_type_env = extendTypeEnv type_env (AnId id)
200 new_ic = ictxt { ic_type_env = new_type_env }
201 return (hsc_env {hsc_IC = new_ic }, name)
203 -- Create new uniques and give them sequentially numbered names
204 -- newGrimName :: Session -> String -> IO Name
205 newGrimName cms userName = do
206 us <- mkSplitUniqSupply 'b'
207 let unique = uniqFromSupply us
208 occname = mkOccName varName userName
209 name = mkInternalName unique occname noSrcLoc
212 skolemSubst subst = subst `setTvSubstEnv`
213 mapVarEnv mk_skol_ty (getTvSubstEnv subst)
214 mk_skol_ty ty | tyvars <- varSetElems (tyVarsOfType ty)
215 , tyvars' <- map (mkTyVarTy . mk_skol_tv) tyvars
216 = substTyWith tyvars tyvars' ty
217 mk_skol_tv tv = mkTcTyVar (tyVarName tv) (tyVarKind tv)
218 (SkolemTv RuntimeUnkSkol)