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 Rename ( renameExpr )
18 import StringBuffer ( stringToStringBuffer, freeStringBuffer )
19 import Unique ( Uniquable(..) )
20 import Type ( Type, splitTyConApp_maybe )
21 import PrelNames ( ioTyConKey )
22 import ByteCodeGen ( byteCodeGen )
27 import StringBuffer ( hGetStringBuffer )
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 ( knownKeyNames )
35 import MkIface ( completeIface, mkModDetailsFromIface, mkModDetails,
36 writeIface, pprIface )
38 import InstEnv ( emptyInstEnv )
41 import CoreUtils ( coreBindsSize )
42 import CoreTidy ( tidyCorePgm )
44 import CoreToStg ( coreToStg )
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 NameSupply(..), 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 ([UnlinkedBCO],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 ghci_mode 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
142 hPutStrLn stderr "compilation IS NOT required";
143 let { bomb = panic "hscNoRecomp:OneShot" };
144 return (HscNoRecomp pcs_ch bomb bomb)
148 hPutStr stderr "compilation IS NOT required";
149 when (verbosity dflags /= 1) $ hPutStrLn stderr "";
152 (pcs_cl, closure_errs, cl_hs_decls)
153 <- closeIfaceDecls dflags hit hst pcs_ch old_iface ;
155 return (HscFail pcs_cl)
159 maybe_tc_result <- typecheckModule dflags pcs_cl hst
160 old_iface alwaysQualify cl_hs_decls;
161 case maybe_tc_result of {
162 Nothing -> return (HscFail pcs_cl);
163 Just (pcs_tc, tc_result) -> do {
165 let env_tc = tc_env tc_result
166 local_rules = tc_rules tc_result
168 -- create a new details from the closed, typechecked, old iface
169 let new_details = mkModDetailsFromIface env_tc local_rules
171 return (HscNoRecomp pcs_tc new_details old_iface)
175 hscRecomp ghci_mode dflags location maybe_checked_iface hst hit pcs_ch
177 ; when (verbosity dflags >= 1) $
178 hPutStr stderr "compilation IS required";
179 -- mode -v1 tries to keep everything on one line
180 when (verbosity dflags > 1) $
183 -- what target are we shooting for?
184 ; let toInterp = dopt_HscLang dflags == HscInterpreted
189 ; maybe_parsed <- myParseModule dflags
190 (unJust "hscRecomp:hspp" (ml_hspp_file location))
191 ; case maybe_parsed of {
192 Nothing -> return (HscFail pcs_ch);
193 Just rdr_module -> do {
194 ; let this_mod = mkHomeModule (hsModuleName rdr_module)
199 ; (pcs_rn, maybe_rn_result)
201 renameModule dflags hit hst pcs_ch this_mod rdr_module
202 ; case maybe_rn_result of {
203 Nothing -> return (HscFail pcs_rn);
204 Just (print_unqualified, (is_exported, new_iface, rn_hs_decls)) -> do {
210 <- _scc_ "TypeCheck" typecheckModule dflags pcs_rn hst new_iface
211 print_unqualified rn_hs_decls
212 ; case maybe_tc_result of {
213 Nothing -> return (HscFail pcs_rn);
214 Just (pcs_tc, tc_result) -> do {
216 ; let env_tc = tc_env tc_result
221 ; (ds_binds, ds_rules, foreign_stuff)
223 deSugar dflags pcs_tc hst this_mod print_unqualified tc_result
226 -- SIMPLIFY, TIDY-CORE
228 -- We grab the the unfoldings at this point.
229 ; (pcs_simpl, tidy_binds, orphan_rules)
230 <- simplThenTidy dflags pcs_tc hst this_mod is_exported ds_binds ds_rules
233 -- BUILD THE NEW ModDetails AND ModIface
235 ; let new_details = mkModDetails env_tc tidy_binds orphan_rules
236 ; final_iface <- _scc_ "MkFinalIface"
237 mkFinalIface ghci_mode dflags location
238 maybe_checked_iface new_iface new_details
241 -- CONVERT TO STG and COMPLETE CODE GENERATION
243 ; (maybe_stub_h_filename, maybe_stub_c_filename, maybe_bcos)
244 <- restOfCodeGeneration dflags toInterp this_mod
245 (map ideclName (hsModuleImports rdr_module))
246 foreign_stuff env_tc tidy_binds
247 hit (pcs_PIT pcs_simpl)
249 -- and the answer is ...
250 ; return (HscRecomp pcs_simpl new_details final_iface
251 maybe_stub_h_filename maybe_stub_c_filename
257 mkFinalIface ghci_mode dflags location maybe_old_iface new_iface new_details
258 = case completeIface maybe_old_iface new_iface new_details of
259 (new_iface, Nothing) -- no change in the interfacfe
260 -> do when (dopt Opt_D_dump_hi_diffs dflags)
261 (printDump (text "INTERFACE UNCHANGED"))
262 dumpIfSet_dyn dflags Opt_D_dump_hi
263 "UNCHANGED FINAL INTERFACE" (pprIface new_iface)
265 (new_iface, Just sdoc_diffs)
266 -> do dumpIfSet_dyn dflags Opt_D_dump_hi_diffs "INTERFACE HAS CHANGED"
268 dumpIfSet_dyn dflags Opt_D_dump_hi "NEW FINAL INTERFACE"
270 -- Write the interface file
271 when (ghci_mode /= Interactive)
272 (writeIface (unJust "hscRecomp:hi" (ml_hi_file location))
277 myParseModule dflags src_filename
278 = do -------------------------- Parser ----------------
279 showPass dflags "Parser"
282 buf <- hGetStringBuffer True{-expand tabs-} src_filename
284 let glaexts | dopt Opt_GlasgowExts dflags = 1#
287 case parseModule buf PState{ bol = 0#, atbol = 1#,
288 context = [], glasgow_exts = glaexts,
289 loc = mkSrcLoc (_PK_ src_filename) 1 } of {
291 PFailed err -> do { hPutStrLn stderr (showSDoc err);
294 POk _ rdr_module@(HsModule mod_name _ _ _ _ _ _) -> do {
296 dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr rdr_module) ;
298 dumpIfSet_dyn dflags Opt_D_source_stats "Source Statistics"
299 (ppSourceStats False rdr_module) ;
301 return (Just rdr_module)
305 simplThenTidy dflags pcs hst this_mod is_exported binds rules
306 = do -- Do main Core-language transformations ---------
308 (simplified, orphan_rules)
309 <- core2core dflags pcs hst is_exported binds rules
311 -- Do saturation and convert to A-normal form
312 -- NOTE: subsequent passes may not transform the syntax, only annotate it
313 saturated <- coreSatPgm dflags simplified
315 -- Do the final tidy-up
316 (pcs', tidy_binds, tidy_orphan_rules)
317 <- tidyCorePgm dflags this_mod pcs saturated orphan_rules
319 return (pcs', tidy_binds, tidy_orphan_rules)
322 restOfCodeGeneration dflags toInterp this_mod imported_module_names
323 foreign_stuff env_tc tidy_binds
324 hit pit -- these last two for mapping ModNames to Modules
327 <- byteCodeGen dflags tidy_binds local_tycons local_classes
328 return (Nothing, Nothing, Just (bcos,itbl_env))
332 -------------------------- Convert to STG -------------------------------
333 (stg_binds, cost_centre_info)
335 myCoreToStg dflags this_mod tidy_binds env_tc
337 -------------------------- Code generation ------------------------------
338 abstractC <- _scc_ "CodeGen"
339 codeGen dflags this_mod imported_modules
340 cost_centre_info fe_binders
341 local_tycons stg_binds
343 -------------------------- Code output -------------------------------
344 (maybe_stub_h_name, maybe_stub_c_name)
345 <- codeOutput dflags this_mod local_tycons
347 c_code h_code abstractC
349 return (maybe_stub_h_name, maybe_stub_c_name, Nothing)
351 local_tycons = typeEnvTyCons env_tc
352 local_classes = typeEnvClasses env_tc
353 imported_modules = map mod_name_to_Module imported_module_names
354 (h_code,c_code,fe_binders) = foreign_stuff
356 mod_name_to_Module :: ModuleName -> Module
357 mod_name_to_Module nm
358 = let str_mi = case lookupModuleEnvByName hit nm of
360 Nothing -> case lookupModuleEnvByName pit nm of
364 barf nm = pprPanic "mod_name_to_Module: no hst or pst mapping for"
368 myCoreToStg dflags this_mod tidy_binds env_tc
370 () <- coreBindsSize tidy_binds `seq` return ()
371 -- TEMP: the above call zaps some space usage allocated by the
372 -- simplifier, which for reasons I don't understand, persists
373 -- thoroughout code generation
375 --let bcos = byteCodeGen dflags tidy_binds local_tycons local_classes
378 stg_binds <- _scc_ "Core2Stg" coreToStg dflags this_mod tidy_binds
380 (stg_binds2, cost_centre_info)
381 <- _scc_ "Core2Stg" stg2stg dflags this_mod stg_binds
383 return (stg_binds2, cost_centre_info)
385 local_tycons = typeEnvTyCons env_tc
386 local_classes = typeEnvClasses env_tc
390 %************************************************************************
392 \subsection{Compiling an expression}
394 %************************************************************************
400 -> Bool -- True <=> wrap in 'print' to get a result of IO type
403 -> PersistentCompilerState -- IN: persistent compiler state
404 -> Module -- Context for compiling
405 -> String -- The expression
406 -> IO ( PersistentCompilerState,
407 Maybe (UnlinkedBCOExpr, PrintUnqualified, Type) )
409 hscExpr dflags wrap_io hst hit pcs0 this_module expr
411 maybe_parsed <- hscParseExpr dflags expr;
413 Nothing -> return (pcs0, Nothing)
414 Just parsed_expr -> do {
417 (pcs1, maybe_renamed_expr) <-
418 renameExpr dflags hit hst pcs0 this_module parsed_expr;
419 case maybe_renamed_expr of
420 Nothing -> return ({-WAS:pcs1-} pcs0, Nothing)
421 Just (print_unqual, rn_expr) -> do {
425 <- typecheckExpr dflags wrap_io pcs1 hst print_unqual this_module rn_expr;
426 case maybe_tc_return of {
427 Nothing -> return ({-WAS:pcs1-} pcs0, Nothing);
428 Just (pcs2, tc_expr, ty) -> do
431 ds_expr <- deSugarExpr dflags pcs2 hst this_module
432 print_unqual tc_expr;
435 simpl_expr <- simplifyExpr dflags pcs2 hst ds_expr;
438 sat_expr <- coreSatExpr dflags simpl_expr;
440 -- ToDo: need to do SRTs?
443 bcos <- coreExprToBCOs dflags sat_expr
445 return (pcs2, Just (bcos, print_unqual, ty));
448 hscParseExpr :: DynFlags -> String -> IO (Maybe RdrNameHsExpr)
449 hscParseExpr dflags str
450 = do -------------------------- Parser ----------------
451 showPass dflags "Parser"
454 buf <- stringToStringBuffer str
456 let glaexts | dopt Opt_GlasgowExts dflags = 1#
459 case parseExpr buf PState{ bol = 0#, atbol = 1#,
460 context = [], glasgow_exts = glaexts,
461 loc = mkSrcLoc SLIT("<no file>") 0 } of {
463 PFailed err -> do { hPutStrLn stderr (showSDoc err);
464 freeStringBuffer buf;
467 POk _ rdr_expr -> do {
469 --ToDo: can't free the string buffer until we've finished this
470 -- compilation sweep and all the identifiers have gone away.
471 --freeStringBuffer buf;
472 dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr rdr_expr);
473 return (Just rdr_expr)
478 %************************************************************************
480 \subsection{Initial persistent state}
482 %************************************************************************
485 initPersistentCompilerState :: IO PersistentCompilerState
486 initPersistentCompilerState
487 = do prs <- initPersistentRenamerState
489 PCS { pcs_PIT = emptyIfaceTable,
490 pcs_PTE = wiredInThingEnv,
491 pcs_insts = emptyInstEnv,
492 pcs_rules = emptyRuleBase,
497 initPersistentRenamerState :: IO PersistentRenamerState
498 = do us <- mkSplitUniqSupply 'r'
500 PRS { prsOrig = NameSupply { nsUniqs = us,
501 nsNames = initOrigNames,
503 prsDecls = (emptyNameEnv, 0),
504 prsInsts = (emptyBag, 0),
505 prsRules = (emptyBag, 0),
510 initOrigNames :: FiniteMap (ModuleName,OccName) Name
512 = grab knownKeyNames `plusFM` grab (map getName wiredInThings)
514 grab names = foldl add emptyFM names
516 = addToFM env (moduleName (nameModule name), nameOccName name) name
519 initRules :: PackageRuleBase
520 initRules = emptyRuleBase
522 foldl add emptyVarEnv builtinRules
525 = extendRuleBase env name rule