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 ( RdrNameStmt )
17 import Rename ( renameStmt )
18 import ByteCodeGen ( byteCodeGen )
19 import Id ( Id, idName, idFlavour, modifyIdInfo )
20 import IdInfo ( setFlavourInfo, makeConstantFlavour )
21 import HscTypes ( InteractiveContext(..), TyThing(..) )
26 import StringBuffer ( hGetStringBuffer,
27 stringToStringBuffer, freeStringBuffer )
29 import Lex ( PState(..), ParseResult(..) )
30 import SrcLoc ( mkSrcLoc )
31 import Rename ( checkOldIface, renameModule, closeIfaceDecls )
32 import Rules ( emptyRuleBase )
33 import PrelInfo ( wiredInThingEnv, wiredInThings )
34 import PrelNames ( vanillaSyntaxMap, knownKeyNames )
35 import MkIface ( completeIface, mkModDetailsFromIface, mkModDetails,
36 writeIface, pprIface )
38 import InstEnv ( emptyInstEnv )
41 import CoreUtils ( coreBindsSize )
42 import CoreTidy ( tidyCorePgm )
44 import CoreTidy ( tidyCoreExpr )
45 import CoreToStg ( coreToStg )
46 import SimplStg ( stg2stg )
47 import CodeGen ( codeGen )
48 import CodeOutput ( codeOutput )
50 import Module ( ModuleName, moduleName, mkHomeModule,
53 import ErrUtils ( dumpIfSet_dyn, showPass )
54 import Util ( unJust )
55 import UniqSupply ( mkSplitUniqSupply )
57 import Bag ( emptyBag )
60 import CmStaticInfo ( GhciMode(..) )
61 import HscStats ( ppSourceStats )
62 import HscTypes ( ModDetails, ModIface(..), PersistentCompilerState(..),
63 PersistentRenamerState(..), ModuleLocation(..),
65 NameSupply(..), PackageRuleBase, HomeIfaceTable,
66 typeEnvClasses, typeEnvTyCons, emptyIfaceTable
68 import FiniteMap ( FiniteMap, plusFM, emptyFM, addToFM )
69 import OccName ( OccName )
70 import Name ( Name, nameModule, nameOccName, getName, isGlobalName,
73 import Module ( Module, lookupModuleEnvByName )
76 import Maybe ( isJust )
81 %************************************************************************
83 \subsection{The main compiler pipeline}
85 %************************************************************************
90 = HscFail PersistentCompilerState -- updated PCS
91 -- concluded that it wasn't necessary
92 | HscNoRecomp PersistentCompilerState -- updated PCS
93 ModDetails -- new details (HomeSymbolTable additions)
94 ModIface -- new iface (if any compilation was done)
96 | HscRecomp PersistentCompilerState -- updated PCS
97 ModDetails -- new details (HomeSymbolTable additions)
98 ModIface -- new iface (if any compilation was done)
99 (Maybe String) -- generated stub_h filename (in /tmp)
100 (Maybe String) -- generated stub_c filename (in /tmp)
101 (Maybe ([UnlinkedBCO],ItblEnv)) -- interpreted code, if any
104 -- no errors or warnings; the individual passes
105 -- (parse/rename/typecheck) print messages themselves
111 -> ModuleLocation -- location info
112 -> Bool -- source unchanged?
113 -> Maybe ModIface -- old interface, if available
114 -> HomeSymbolTable -- for home module ModDetails
116 -> PersistentCompilerState -- IN: persistent compiler state
119 hscMain ghci_mode dflags mod location source_unchanged maybe_old_iface hst hit pcs
121 showPass dflags ("Checking old interface for hs = "
122 ++ show (ml_hs_file location)
123 ++ ", hspp = " ++ show (ml_hspp_file location));
125 (pcs_ch, errs_found, (recomp_reqd, maybe_checked_iface))
126 <- checkOldIface ghci_mode dflags hit hst pcs
127 (unJust "hscMain" (ml_hi_file location))
128 source_unchanged maybe_old_iface;
131 return (HscFail pcs_ch)
134 let no_old_iface = not (isJust maybe_checked_iface)
135 what_next | recomp_reqd || no_old_iface = hscRecomp
136 | otherwise = hscNoRecomp
138 what_next ghci_mode dflags mod location maybe_checked_iface
143 -- we definitely expect to have the old interface available
144 hscNoRecomp ghci_mode dflags mod location (Just old_iface) hst hit pcs_ch
145 | ghci_mode == OneShot
147 hPutStrLn stderr "compilation IS NOT required";
148 let { bomb = panic "hscNoRecomp:OneShot" };
149 return (HscNoRecomp pcs_ch bomb bomb)
153 when (verbosity dflags >= 1) $
154 hPutStrLn stderr ("Skipping " ++ compMsg mod location);
157 (pcs_cl, closure_errs, cl_hs_decls)
158 <- closeIfaceDecls dflags hit hst pcs_ch old_iface ;
160 return (HscFail pcs_cl)
165 <- typecheckIface dflags pcs_cl hst old_iface (vanillaSyntaxMap, cl_hs_decls);
167 case maybe_tc_result of {
168 Nothing -> return (HscFail pcs_cl);
169 Just (pcs_tc, env_tc, local_rules) -> do {
171 -- create a new details from the closed, typechecked, old iface
172 let new_details = mkModDetailsFromIface env_tc local_rules
174 return (HscNoRecomp pcs_tc new_details old_iface)
177 compMsg mod location =
178 mod_str ++ take (12 - length mod_str) (repeat ' ')
179 ++ " (" ++ unJust "hscRecomp" (ml_hs_file location) ++ ")"
180 where mod_str = moduleUserString mod
183 hscRecomp ghci_mode dflags mod location maybe_checked_iface hst hit pcs_ch
185 ; when (verbosity dflags >= 1) $
186 hPutStrLn stderr ("Compiling " ++ compMsg mod location);
188 -- what target are we shooting for?
189 ; let toInterp = dopt_HscLang dflags == HscInterpreted
194 ; maybe_parsed <- myParseModule dflags
195 (unJust "hscRecomp:hspp" (ml_hspp_file location))
196 ; case maybe_parsed of {
197 Nothing -> return (HscFail pcs_ch);
198 Just rdr_module -> do {
199 ; let this_mod = mkHomeModule (hsModuleName rdr_module)
204 ; (pcs_rn, print_unqualified, maybe_rn_result)
206 renameModule dflags hit hst pcs_ch this_mod rdr_module
207 ; case maybe_rn_result of {
208 Nothing -> return (HscFail pcs_ch{-was: pcs_rn-});
209 Just (is_exported, new_iface, rn_hs_decls) -> do {
211 -- In interactive mode, we don't want to discard any top-level entities at
212 -- all (eg. do not inline them away during simplification), and retain them
213 -- all in the TypeEnv so they are available from the command line.
215 -- isGlobalName separates the user-defined top-level names from those
216 -- introduced by the type checker.
217 ; let dont_discard | ghci_mode == Interactive = isGlobalName
218 | otherwise = is_exported
224 <- _scc_ "TypeCheck" typecheckModule dflags pcs_rn hst new_iface
225 print_unqualified rn_hs_decls
226 ; case maybe_tc_result of {
227 Nothing -> return (HscFail pcs_ch{-was: pcs_rn-});
228 Just (pcs_tc, tc_result) -> do {
230 ; let env_tc = tc_env tc_result
235 ; (ds_binds, ds_rules, foreign_stuff)
237 deSugar dflags pcs_tc hst this_mod print_unqualified tc_result
240 -- SIMPLIFY, TIDY-CORE
242 -- We grab the the unfoldings at this point.
243 ; (pcs_simpl, tidy_binds, orphan_rules)
244 <- simplThenTidy dflags pcs_tc hst this_mod dont_discard ds_binds ds_rules
247 -- BUILD THE NEW ModDetails AND ModIface
249 ; let new_details = mkModDetails env_tc tidy_binds orphan_rules
250 ; final_iface <- _scc_ "MkFinalIface"
251 mkFinalIface ghci_mode dflags location
252 maybe_checked_iface new_iface new_details
255 -- CONVERT TO STG and COMPLETE CODE GENERATION
257 -- Do saturation and convert to A-normal form
258 ; saturated <- coreSatPgm dflags tidy_binds
260 ; (maybe_stub_h_filename, maybe_stub_c_filename, maybe_bcos)
261 <- restOfCodeGeneration dflags toInterp this_mod
262 (map ideclName (hsModuleImports rdr_module))
263 foreign_stuff env_tc saturated
264 hit (pcs_PIT pcs_simpl)
266 -- and the answer is ...
267 ; return (HscRecomp pcs_simpl new_details final_iface
268 maybe_stub_h_filename maybe_stub_c_filename
274 mkFinalIface ghci_mode dflags location maybe_old_iface new_iface new_details
275 = case completeIface maybe_old_iface new_iface new_details of
276 (new_iface, Nothing) -- no change in the interfacfe
277 -> do when (dopt Opt_D_dump_hi_diffs dflags)
278 (printDump (text "INTERFACE UNCHANGED"))
279 dumpIfSet_dyn dflags Opt_D_dump_hi
280 "UNCHANGED FINAL INTERFACE" (pprIface new_iface)
282 (new_iface, Just sdoc_diffs)
283 -> do dumpIfSet_dyn dflags Opt_D_dump_hi_diffs "INTERFACE HAS CHANGED"
285 dumpIfSet_dyn dflags Opt_D_dump_hi "NEW FINAL INTERFACE"
287 -- Write the interface file
288 when (ghci_mode /= Interactive)
289 (writeIface (unJust "hscRecomp:hi" (ml_hi_file location))
294 myParseModule dflags src_filename
295 = do -------------------------- Parser ----------------
296 showPass dflags "Parser"
299 buf <- hGetStringBuffer True{-expand tabs-} src_filename
301 let glaexts | dopt Opt_GlasgowExts dflags = 1#
304 case parseModule buf PState{ bol = 0#, atbol = 1#,
305 context = [], glasgow_exts = glaexts,
306 loc = mkSrcLoc (_PK_ src_filename) 1 } of {
308 PFailed err -> do { hPutStrLn stderr (showSDoc err);
309 freeStringBuffer buf;
312 POk _ rdr_module@(HsModule mod_name _ _ _ _ _ _) -> do {
314 dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr rdr_module) ;
316 dumpIfSet_dyn dflags Opt_D_source_stats "Source Statistics"
317 (ppSourceStats False rdr_module) ;
319 return (Just rdr_module)
320 -- ToDo: free the string buffer later.
324 simplThenTidy dflags pcs hst this_mod dont_discard binds rules
325 = do -- Do main Core-language transformations ---------
327 (simplified, orphan_rules)
328 <- core2core dflags pcs hst dont_discard binds rules
330 -- Do the final tidy-up
331 (pcs', tidy_binds, tidy_orphan_rules)
332 <- tidyCorePgm dflags this_mod pcs simplified orphan_rules
334 return (pcs', tidy_binds, tidy_orphan_rules)
337 restOfCodeGeneration dflags toInterp this_mod imported_module_names
338 foreign_stuff env_tc tidy_binds
339 hit pit -- these last two for mapping ModNames to Modules
342 <- byteCodeGen dflags tidy_binds local_tycons local_classes
343 return (Nothing, Nothing, Just (bcos,itbl_env))
347 -------------------------- Convert to STG -------------------------------
348 (stg_binds, cost_centre_info)
350 myCoreToStg dflags this_mod tidy_binds env_tc
352 -------------------------- Code generation ------------------------------
353 abstractC <- _scc_ "CodeGen"
354 codeGen dflags this_mod imported_modules
355 cost_centre_info fe_binders
356 local_tycons stg_binds
358 -------------------------- Code output -------------------------------
359 (maybe_stub_h_name, maybe_stub_c_name)
360 <- codeOutput dflags this_mod local_tycons
362 c_code h_code abstractC
364 return (maybe_stub_h_name, maybe_stub_c_name, Nothing)
366 local_tycons = typeEnvTyCons env_tc
367 local_classes = typeEnvClasses env_tc
368 imported_modules = map mod_name_to_Module imported_module_names
369 (h_code,c_code,fe_binders) = foreign_stuff
371 mod_name_to_Module :: ModuleName -> Module
372 mod_name_to_Module nm
373 = let str_mi = case lookupModuleEnvByName hit nm of
375 Nothing -> case lookupModuleEnvByName pit nm of
379 barf nm = pprPanic "mod_name_to_Module: no hst or pst mapping for"
383 myCoreToStg dflags this_mod tidy_binds env_tc
385 () <- coreBindsSize tidy_binds `seq` return ()
386 -- TEMP: the above call zaps some space usage allocated by the
387 -- simplifier, which for reasons I don't understand, persists
388 -- thoroughout code generation
390 --let bcos = byteCodeGen dflags tidy_binds local_tycons local_classes
393 stg_binds <- _scc_ "Core2Stg" coreToStg dflags this_mod tidy_binds
395 (stg_binds2, cost_centre_info)
396 <- _scc_ "Core2Stg" stg2stg dflags this_mod stg_binds
398 return (stg_binds2, cost_centre_info)
400 local_tycons = typeEnvTyCons env_tc
401 local_classes = typeEnvClasses env_tc
405 %************************************************************************
407 \subsection{Compiling a do-statement}
409 %************************************************************************
417 -> PersistentCompilerState -- IN: persistent compiler state
418 -> InteractiveContext -- Context for compiling
419 -> String -- The statement
420 -> IO ( PersistentCompilerState,
425 When the UnlinkedBCOExpr is linked you get an HValue of type
427 When you run it you get a list of HValues that should be
428 the same length as the list of names; add them to the ClosureEnv.
430 A naked expression returns a singleton Name [it].
432 What you type The IO [HValue] that hscStmt returns
433 ------------- ------------------------------------
434 let pat = expr ==> let pat = expr in return [coerce HVal x, coerce HVal y, ...]
437 pat <- expr ==> expr >>= \ pat -> return [coerce HVal x, coerce HVal y, ...]
440 expr (of IO type) ==> expr >>= \ v -> return [v]
441 [NB: result not printed] bindings: [it]
444 expr (of non-IO type,
445 result showable) ==> let v = expr in print v >> return [v]
448 expr (of non-IO type,
449 result not showable) ==> error
452 hscStmt dflags hst hit pcs0 icontext stmt
456 ic_type_env = type_env,
457 ic_module = this_mod } = icontext
459 do { maybe_stmt <- hscParseStmt dflags stmt
461 Nothing -> return (pcs0, Nothing)
462 Just parsed_stmt -> do {
465 (pcs1, print_unqual, maybe_renamed_stmt)
466 <- renameStmt dflags hit hst pcs0 this_mod rn_env parsed_stmt
467 ; case maybe_renamed_stmt of
468 Nothing -> return (pcs0, Nothing)
469 Just (bound_names, rn_stmt) -> do {
472 maybe_tc_return <- typecheckStmt dflags pcs1 hst type_env
473 print_unqual this_mod bound_names rn_stmt
474 ; case maybe_tc_return of {
475 Nothing -> return (pcs0, Nothing) ;
476 Just (pcs2, tc_expr, bound_ids) -> do {
479 ds_expr <- deSugarExpr dflags pcs2 hst this_mod print_unqual tc_expr
482 ; simpl_expr <- simplifyExpr dflags pcs2 hst ds_expr
484 -- Tidy it (temporary, until coreSat does cloning)
485 ; tidy_expr <- tidyCoreExpr simpl_expr
488 ; sat_expr <- coreSatExpr dflags tidy_expr
491 ; bcos <- coreExprToBCOs dflags sat_expr
494 -- make all the bound ids "constant" ids, now that
495 -- they're notionally top-level bindings. This is
496 -- important: otherwise when we come to compile an expression
497 -- using these ids later, the byte code generator will consider
498 -- the occurrences to be free rather than global.
499 constant_bound_ids = map constantizeId bound_ids;
502 = modifyIdInfo (`setFlavourInfo` makeConstantFlavour
505 ; return (pcs2, Just (constant_bound_ids, bcos))
508 hscParseStmt :: DynFlags -> String -> IO (Maybe RdrNameStmt)
509 hscParseStmt dflags str
510 = do -------------------------- Parser ----------------
511 showPass dflags "Parser"
514 buf <- stringToStringBuffer str
516 let glaexts | dopt Opt_GlasgowExts dflags = 1#
519 case parseStmt buf PState{ bol = 0#, atbol = 1#,
520 context = [], glasgow_exts = glaexts,
521 loc = mkSrcLoc SLIT("<no file>") 0 } of {
523 PFailed err -> do { hPutStrLn stderr (showSDoc err);
524 -- Not yet implemented in <4.11 freeStringBuffer buf;
527 -- no stmt: the line consisted of just space or comments
528 POk _ Nothing -> return Nothing;
530 POk _ (Just rdr_stmt) -> do {
532 --ToDo: can't free the string buffer until we've finished this
533 -- compilation sweep and all the identifiers have gone away.
534 --freeStringBuffer buf;
535 dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr rdr_stmt);
536 return (Just rdr_stmt)
541 %************************************************************************
543 \subsection{Initial persistent state}
545 %************************************************************************
548 initPersistentCompilerState :: IO PersistentCompilerState
549 initPersistentCompilerState
550 = do prs <- initPersistentRenamerState
552 PCS { pcs_PIT = emptyIfaceTable,
553 pcs_PTE = wiredInThingEnv,
554 pcs_insts = emptyInstEnv,
555 pcs_rules = emptyRuleBase,
560 initPersistentRenamerState :: IO PersistentRenamerState
561 = do us <- mkSplitUniqSupply 'r'
563 PRS { prsOrig = NameSupply { nsUniqs = us,
564 nsNames = initOrigNames,
566 prsDecls = (emptyNameEnv, 0),
567 prsInsts = (emptyBag, 0),
568 prsRules = (emptyBag, 0),
573 initOrigNames :: FiniteMap (ModuleName,OccName) Name
575 = grab knownKeyNames `plusFM` grab (map getName wiredInThings)
577 grab names = foldl add emptyFM names
579 = addToFM env (moduleName (nameModule name), nameOccName name) name
582 initRules :: PackageRuleBase
583 initRules = emptyRuleBase
585 foldl add emptyVarEnv builtinRules
588 = extendRuleBase env name rule