2 % (c) The GRASP/AQUA Project, Glasgow University, 1993-2000
4 \section[GHC_Main]{Main driver for Glasgow Haskell compiler}
7 module HscMain ( HscResult(..), hscMain,
11 initPersistentCompilerState ) where
13 #include "HsVersions.h"
16 import RdrHsSyn ( RdrNameHsExpr )
17 import CoreToStg ( coreToStgExpr )
18 import StringBuffer ( stringToStringBuffer, freeStringBuffer )
19 import Unique ( Uniquable(..) )
20 import Type ( splitTyConApp_maybe )
21 import PrelNames ( ioTyConKey )
26 import StringBuffer ( hGetStringBuffer )
28 import Lex ( PState(..), ParseResult(..) )
29 import SrcLoc ( mkSrcLoc )
31 import Rules ( emptyRuleBase )
32 import PrelInfo ( wiredInThingEnv, wiredInThings )
33 import PrelNames ( knownKeyNames )
34 import MkIface ( completeIface, mkModDetailsFromIface, mkModDetails,
35 writeIface, pprIface )
38 import InstEnv ( emptyInstEnv )
41 import CoreUtils ( coreBindsSize )
42 import CoreTidy ( tidyCorePgm )
43 import CoreToStg ( topCoreBindsToStg )
44 import StgSyn ( collectFinalStgBinders )
45 import SimplStg ( stg2stg )
46 import CodeGen ( codeGen )
47 import CodeOutput ( codeOutput )
49 import Module ( ModuleName, moduleName, mkHomeModule )
51 import ErrUtils ( dumpIfSet_dyn, showPass )
52 import Util ( unJust )
53 import UniqSupply ( mkSplitUniqSupply )
55 import Bag ( emptyBag )
58 import CmStaticInfo ( GhciMode(..) )
59 import HscStats ( ppSourceStats )
60 import HscTypes ( ModDetails, ModIface(..), PersistentCompilerState(..),
61 PersistentRenamerState(..), ModuleLocation(..),
63 OrigNameEnv(..), PackageRuleBase, HomeIfaceTable,
64 typeEnvClasses, typeEnvTyCons, emptyIfaceTable )
65 import FiniteMap ( FiniteMap, plusFM, emptyFM, addToFM )
66 import OccName ( OccName )
67 import Name ( Name, nameModule, nameOccName, getName )
68 import Name ( emptyNameEnv )
69 import Module ( Module, lookupModuleEnvByName )
72 import Maybe ( isJust )
77 %************************************************************************
79 \subsection{The main compiler pipeline}
81 %************************************************************************
86 = HscFail PersistentCompilerState -- updated PCS
87 -- concluded that it wasn't necessary
88 | HscNoRecomp PersistentCompilerState -- updated PCS
89 ModDetails -- new details (HomeSymbolTable additions)
90 ModIface -- new iface (if any compilation was done)
92 | HscRecomp PersistentCompilerState -- updated PCS
93 ModDetails -- new details (HomeSymbolTable additions)
94 ModIface -- new iface (if any compilation was done)
95 (Maybe String) -- generated stub_h filename (in /tmp)
96 (Maybe String) -- generated stub_c filename (in /tmp)
97 (Maybe ([UnlinkedIBind],ItblEnv)) -- interpreted code, if any
100 -- no errors or warnings; the individual passes
101 -- (parse/rename/typecheck) print messages themselves
106 -> Bool -- source unchanged?
107 -> ModuleLocation -- location info
108 -> Maybe ModIface -- old interface, if available
109 -> HomeSymbolTable -- for home module ModDetails
111 -> PersistentCompilerState -- IN: persistent compiler state
114 hscMain ghci_mode dflags source_unchanged location maybe_old_iface hst hit pcs
116 showPass dflags ("Checking old interface for hs = "
117 ++ show (ml_hs_file location)
118 ++ ", hspp = " ++ show (ml_hspp_file location));
120 (pcs_ch, errs_found, (recomp_reqd, maybe_checked_iface))
121 <- checkOldIface dflags hit hst pcs
122 (unJust "hscMain" (ml_hi_file location))
123 source_unchanged maybe_old_iface;
126 return (HscFail pcs_ch)
129 let no_old_iface = not (isJust maybe_checked_iface)
130 what_next | recomp_reqd || no_old_iface = hscRecomp
131 | otherwise = hscNoRecomp
133 what_next ghci_mode dflags location maybe_checked_iface
138 -- we definitely expect to have the old interface available
139 hscNoRecomp ghci_mode dflags location (Just old_iface) hst hit pcs_ch
140 | ghci_mode == OneShot
141 = let bomb = panic "hscNoRecomp:OneShot"
142 in return (HscNoRecomp pcs_ch bomb bomb)
145 hPutStr stderr "compilation IS NOT required";
146 when (verbosity dflags /= 1) $ hPutStrLn stderr "";
149 (pcs_cl, closure_errs, cl_hs_decls)
150 <- closeIfaceDecls dflags hit hst pcs_ch old_iface ;
152 return (HscFail pcs_cl)
156 maybe_tc_result <- typecheckModule dflags pcs_cl hst
157 old_iface alwaysQualify cl_hs_decls;
158 case maybe_tc_result of {
159 Nothing -> return (HscFail pcs_cl);
160 Just (pcs_tc, tc_result) -> do {
162 let env_tc = tc_env tc_result
163 local_rules = tc_rules tc_result
165 -- create a new details from the closed, typechecked, old iface
166 let new_details = mkModDetailsFromIface env_tc local_rules
168 return (HscNoRecomp pcs_tc new_details old_iface)
172 hscRecomp ghci_mode dflags location maybe_checked_iface hst hit pcs_ch
174 ; when (verbosity dflags >= 1) $
175 hPutStr stderr "compilation IS required";
176 -- mode -v1 tries to keep everything on one line
177 when (verbosity dflags /= 1) $
180 -- what target are we shooting for?
181 ; let toInterp = dopt_HscLang dflags == HscInterpreted
186 ; maybe_parsed <- myParseModule dflags
187 (unJust "hscRecomp:hspp" (ml_hspp_file location))
188 ; case maybe_parsed of {
189 Nothing -> return (HscFail pcs_ch);
190 Just rdr_module -> do {
191 ; let this_mod = mkHomeModule (hsModuleName rdr_module)
196 ; (pcs_rn, maybe_rn_result)
197 <- renameModule dflags hit hst pcs_ch this_mod rdr_module
198 ; case maybe_rn_result of {
199 Nothing -> return (HscFail pcs_rn);
200 Just (print_unqualified, (is_exported, new_iface, rn_hs_decls)) -> do {
205 ; maybe_tc_result <- typecheckModule dflags pcs_rn hst new_iface
206 print_unqualified rn_hs_decls
207 ; case maybe_tc_result of {
208 Nothing -> return (HscFail pcs_rn);
209 Just (pcs_tc, tc_result) -> do {
211 ; let env_tc = tc_env tc_result
214 -- DESUGAR, SIMPLIFY, TIDY-CORE
216 -- We grab the the unfoldings at this point.
217 ; simpl_result <- dsThenSimplThenTidy dflags pcs_tc hst this_mod
218 print_unqualified is_exported tc_result
219 ; let (pcs_simpl, tidy_binds, orphan_rules, foreign_stuff) = simpl_result
224 ; (stg_binds, cost_centre_info, top_level_ids)
225 <- myCoreToStg dflags this_mod tidy_binds
229 -- BUILD THE NEW ModDetails AND ModIface
231 ; let new_details = mkModDetails env_tc tidy_binds
232 top_level_ids orphan_rules
233 ; final_iface <- mkFinalIface ghci_mode dflags location
234 maybe_checked_iface new_iface new_details
237 -- COMPLETE CODE GENERATION
239 ; (maybe_stub_h_filename, maybe_stub_c_filename, maybe_ibinds)
240 <- restOfCodeGeneration dflags toInterp this_mod
241 (map ideclName (hsModuleImports rdr_module))
242 cost_centre_info foreign_stuff env_tc stg_binds tidy_binds
243 hit (pcs_PIT pcs_simpl)
245 -- and the answer is ...
246 ; return (HscRecomp pcs_simpl new_details final_iface
247 maybe_stub_h_filename maybe_stub_c_filename
253 mkFinalIface ghci_mode dflags location maybe_old_iface new_iface new_details
254 = case completeIface maybe_old_iface new_iface new_details of
255 (new_iface, Nothing) -- no change in the interfacfe
256 -> do when (dopt Opt_D_dump_hi_diffs dflags)
257 (printDump (text "INTERFACE UNCHANGED"))
258 dumpIfSet_dyn dflags Opt_D_dump_hi
259 "UNCHANGED FINAL INTERFACE" (pprIface new_iface)
261 (new_iface, Just sdoc_diffs)
262 -> do dumpIfSet_dyn dflags Opt_D_dump_hi_diffs "INTERFACE HAS CHANGED"
264 dumpIfSet_dyn dflags Opt_D_dump_hi "NEW FINAL INTERFACE"
266 -- Write the interface file
267 when (ghci_mode /= Interactive)
268 (writeIface (unJust "hscRecomp:hi" (ml_hi_file location))
273 myParseModule dflags src_filename
274 = do -------------------------- Parser ----------------
275 showPass dflags "Parser"
278 buf <- hGetStringBuffer True{-expand tabs-} src_filename
280 let glaexts | dopt Opt_GlasgowExts dflags = 1#
283 case parse buf PState{ bol = 0#, atbol = 1#,
284 context = [], glasgow_exts = glaexts,
285 loc = mkSrcLoc (_PK_ src_filename) 1 } of {
287 PFailed err -> do { hPutStrLn stderr (showSDoc err);
290 POk _ (PModule rdr_module@(HsModule mod_name _ _ _ _ _ _)) -> do {
292 dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr rdr_module) ;
294 dumpIfSet_dyn dflags Opt_D_source_stats "Source Statistics"
295 (ppSourceStats False rdr_module) ;
297 return (Just rdr_module)
301 restOfCodeGeneration dflags toInterp this_mod imported_module_names cost_centre_info
302 foreign_stuff env_tc stg_binds tidy_binds
303 hit pit -- these last two for mapping ModNames to Modules
305 = do (ibinds,itbl_env)
306 <- stgBindsToInterpSyn dflags (map fst stg_binds)
307 local_tycons local_classes
308 return (Nothing, Nothing, Just (ibinds,itbl_env))
311 = do -------------------------- Code generation -------------------------------
313 abstractC <- codeGen dflags this_mod imported_modules
314 cost_centre_info fe_binders
315 local_tycons stg_binds
317 -------------------------- Code output -------------------------------
318 -- _scc_ "CodeOutput"
319 (maybe_stub_h_name, maybe_stub_c_name)
320 <- codeOutput dflags this_mod local_tycons
322 c_code h_code abstractC
324 return (maybe_stub_h_name, maybe_stub_c_name, Nothing)
326 local_tycons = typeEnvTyCons env_tc
327 local_classes = typeEnvClasses env_tc
328 imported_modules = map mod_name_to_Module imported_module_names
329 (fe_binders,h_code,c_code) = foreign_stuff
331 mod_name_to_Module :: ModuleName -> Module
332 mod_name_to_Module nm
333 = let str_mi = case lookupModuleEnvByName hit nm of
335 Nothing -> case lookupModuleEnvByName pit nm of
339 barf nm = pprPanic "mod_name_to_Module: no hst or pst mapping for"
343 dsThenSimplThenTidy dflags pcs hst this_mod print_unqual is_exported tc_result
344 = do -------------------------- Desugaring ----------------
346 (desugared, rules, h_code, c_code, fe_binders)
347 <- deSugar dflags pcs hst this_mod print_unqual tc_result
349 -------------------------- Main Core-language transformations ----------------
351 (simplified, orphan_rules)
352 <- core2core dflags pcs hst is_exported desugared rules
354 -- Do the final tidy-up
355 (pcs', tidy_binds, tidy_orphan_rules)
356 <- tidyCorePgm dflags this_mod pcs simplified orphan_rules
358 return (pcs', tidy_binds, tidy_orphan_rules, (fe_binders,h_code,c_code))
361 myCoreToStg dflags this_mod tidy_binds
363 () <- coreBindsSize tidy_binds `seq` return ()
364 -- TEMP: the above call zaps some space usage allocated by the
365 -- simplifier, which for reasons I don't understand, persists
366 -- thoroughout code generation
369 stg_binds <- topCoreBindsToStg dflags this_mod tidy_binds
372 (stg_binds2, cost_centre_info) <- stg2stg dflags this_mod stg_binds
373 let final_ids = collectFinalStgBinders (map fst stg_binds2)
375 return (stg_binds2, cost_centre_info, final_ids)
379 %************************************************************************
381 \subsection{Compiling an expression}
383 %************************************************************************
387 hscExpr dflags hst hit pcs this_module expr
388 = panic "hscExpr: non-interactive build"
389 hscTypeExpr dflags hst hit pcs0 this_module expr
390 = panic "hscTypeExpr: non-interactive build"
397 -> PersistentCompilerState -- IN: persistent compiler state
398 -> Module -- Context for compiling
399 -> String -- The expression
400 -> IO ( PersistentCompilerState,
401 Maybe (UnlinkedIExpr, PrintUnqualified, Type) )
403 hscExpr dflags hst hit pcs0 this_module expr
405 maybe_parsed <- hscParseExpr dflags expr;
407 Nothing -> return (pcs0, Nothing)
408 Just parsed_expr -> do {
411 (pcs1, maybe_renamed_expr) <-
412 renameExpr dflags hit hst pcs0 this_module parsed_expr;
413 case maybe_renamed_expr of
414 Nothing -> return (pcs1, Nothing)
415 Just (print_unqual, rn_expr) -> do {
419 <- typecheckExpr dflags pcs1 hst print_unqual this_module rn_expr;
420 case maybe_tc_return of {
421 Nothing -> return (pcs1, Nothing);
422 Just (pcs2, tc_expr, ty) -> do
424 -- if it isn't an IO-typed expression,
425 -- wrap "print" around it & recompile...
426 let { is_IO_type = case splitTyConApp_maybe ty of {
427 Just (tycon, _) -> getUnique tycon == ioTyConKey;
432 then do (new_pcs, maybe_stuff)
433 <- hscExpr dflags hst hit pcs2 this_module
434 ("print (" ++ expr ++ ")")
436 Nothing -> return (new_pcs, maybe_stuff)
438 return (new_pcs, Just (expr, print_unqual, ty))
442 ds_expr <- deSugarExpr dflags pcs2 hst this_module
443 print_unqual tc_expr;
446 simpl_expr <- simplifyExpr dflags pcs2 hst ds_expr;
449 stg_expr <- coreToStgExpr dflags simpl_expr;
451 -- ToDo: need to do StgVarInfo? or SRTs?
453 -- Convert to InterpSyn
454 unlinked_iexpr <- stgExprToInterpSyn dflags stg_expr;
456 return (pcs2, Just (unlinked_iexpr, print_unqual, ty));
459 hscParseExpr :: DynFlags -> String -> IO (Maybe RdrNameHsExpr)
460 hscParseExpr dflags str
461 = do -------------------------- Parser ----------------
462 showPass dflags "Parser"
465 buf <- stringToStringBuffer ("__expr " ++ str)
467 -- glaexts is True for now (because of the daft __expr at the front
470 --let glaexts | dopt Opt_GlasgowExts dflags = 1#
473 case parse buf PState{ bol = 0#, atbol = 1#,
474 context = [], glasgow_exts = glaexts,
475 loc = mkSrcLoc SLIT("<no file>") 0 } of {
477 PFailed err -> do { freeStringBuffer buf;
478 hPutStrLn stderr (showSDoc err);
481 POk _ (PExpr rdr_expr) -> do {
483 --ToDo: can't free the string buffer until we've finished this
484 -- compilation sweep and all the identifiers have gone away.
485 --freeStringBuffer buf;
486 dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr rdr_expr);
487 return (Just rdr_expr)
492 %************************************************************************
494 \subsection{Initial persistent state}
496 %************************************************************************
499 initPersistentCompilerState :: IO PersistentCompilerState
500 initPersistentCompilerState
501 = do prs <- initPersistentRenamerState
503 PCS { pcs_PIT = emptyIfaceTable,
504 pcs_PTE = wiredInThingEnv,
505 pcs_insts = emptyInstEnv,
506 pcs_rules = emptyRuleBase,
511 initPersistentRenamerState :: IO PersistentRenamerState
512 = do ns <- mkSplitUniqSupply 'r'
514 PRS { prsOrig = Orig { origNames = initOrigNames,
515 origIParam = emptyFM },
516 prsDecls = (emptyNameEnv, 0),
517 prsInsts = (emptyBag, 0),
518 prsRules = (emptyBag, 0),
523 initOrigNames :: FiniteMap (ModuleName,OccName) Name
525 = grab knownKeyNames `plusFM` grab (map getName wiredInThings)
527 grab names = foldl add emptyFM names
529 = addToFM env (moduleName (nameModule name), nameOccName name) name
532 initRules :: PackageRuleBase
533 initRules = emptyRuleBase
535 foldl add emptyVarEnv builtinRules
538 = extendRuleBase env name rule