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)
200 <- renameModule dflags hit hst pcs_ch this_mod rdr_module
201 ; case maybe_rn_result of {
202 Nothing -> return (HscFail pcs_rn);
203 Just (print_unqualified, (is_exported, new_iface, rn_hs_decls)) -> do {
208 ; maybe_tc_result <- typecheckModule dflags pcs_rn hst new_iface
209 print_unqualified rn_hs_decls
210 ; case maybe_tc_result of {
211 Nothing -> return (HscFail pcs_rn);
212 Just (pcs_tc, tc_result) -> do {
214 ; let env_tc = tc_env tc_result
219 ; (ds_binds, ds_rules, foreign_stuff)
220 <- deSugar dflags pcs_tc hst this_mod print_unqualified tc_result
223 -- SIMPLIFY, TIDY-CORE
225 -- We grab the the unfoldings at this point.
226 ; (pcs_simpl, tidy_binds, orphan_rules)
227 <- simplThenTidy dflags pcs_tc hst this_mod is_exported ds_binds ds_rules
230 -- BUILD THE NEW ModDetails AND ModIface
232 ; let new_details = mkModDetails env_tc tidy_binds orphan_rules
233 ; final_iface <- mkFinalIface ghci_mode dflags location
234 maybe_checked_iface new_iface new_details
237 -- CONVERT TO STG and COMPLETE CODE GENERATION
239 ; (maybe_stub_h_filename, maybe_stub_c_filename, maybe_bcos)
240 <- restOfCodeGeneration dflags toInterp this_mod
241 (map ideclName (hsModuleImports rdr_module))
242 foreign_stuff env_tc 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 simplThenTidy dflags pcs hst this_mod is_exported binds rules
302 = do -- Do main Core-language transformations ---------
304 (simplified, orphan_rules)
305 <- core2core dflags pcs hst is_exported binds rules
307 -- Do saturation and convert to A-normal form
308 -- NOTE: subsequent passes may not transform the syntax, only annotate it
309 saturated <- coreSatPgm dflags simplified
311 -- Do the final tidy-up
312 (pcs', tidy_binds, tidy_orphan_rules)
313 <- tidyCorePgm dflags this_mod pcs saturated orphan_rules
315 return (pcs', tidy_binds, tidy_orphan_rules)
318 restOfCodeGeneration dflags toInterp this_mod imported_module_names
319 foreign_stuff env_tc tidy_binds
320 hit pit -- these last two for mapping ModNames to Modules
323 <- byteCodeGen dflags tidy_binds local_tycons local_classes
324 return (Nothing, Nothing, Just (bcos,itbl_env))
328 -------------------------- Convert to STG -------------------------------
329 (stg_binds, cost_centre_info)
330 <- myCoreToStg dflags this_mod tidy_binds env_tc
332 -------------------------- Code generation -------------------------------
334 abstractC <- codeGen dflags this_mod imported_modules
335 cost_centre_info fe_binders
336 local_tycons stg_binds
338 -------------------------- Code output -------------------------------
339 -- _scc_ "CodeOutput"
340 (maybe_stub_h_name, maybe_stub_c_name)
341 <- codeOutput dflags this_mod local_tycons
343 c_code h_code abstractC
345 return (maybe_stub_h_name, maybe_stub_c_name, Nothing)
347 local_tycons = typeEnvTyCons env_tc
348 local_classes = typeEnvClasses env_tc
349 imported_modules = map mod_name_to_Module imported_module_names
350 (h_code,c_code,fe_binders) = foreign_stuff
352 mod_name_to_Module :: ModuleName -> Module
353 mod_name_to_Module nm
354 = let str_mi = case lookupModuleEnvByName hit nm of
356 Nothing -> case lookupModuleEnvByName pit nm of
360 barf nm = pprPanic "mod_name_to_Module: no hst or pst mapping for"
364 myCoreToStg dflags this_mod tidy_binds env_tc
366 () <- coreBindsSize tidy_binds `seq` return ()
367 -- TEMP: the above call zaps some space usage allocated by the
368 -- simplifier, which for reasons I don't understand, persists
369 -- thoroughout code generation
371 --let bcos = byteCodeGen dflags tidy_binds local_tycons local_classes
374 stg_binds <- coreToStg dflags this_mod tidy_binds
377 (stg_binds2, cost_centre_info) <- stg2stg dflags this_mod stg_binds
379 return (stg_binds2, cost_centre_info)
381 local_tycons = typeEnvTyCons env_tc
382 local_classes = typeEnvClasses env_tc
386 %************************************************************************
388 \subsection{Compiling an expression}
390 %************************************************************************
398 -> PersistentCompilerState -- IN: persistent compiler state
399 -> Module -- Context for compiling
400 -> String -- The expression
401 -> IO ( PersistentCompilerState,
402 Maybe (UnlinkedBCOExpr, PrintUnqualified, Type) )
404 hscExpr dflags hst hit pcs0 this_module expr
406 maybe_parsed <- hscParseExpr dflags expr;
408 Nothing -> return (pcs0, Nothing)
409 Just parsed_expr -> do {
412 (pcs1, maybe_renamed_expr) <-
413 renameExpr dflags hit hst pcs0 this_module parsed_expr;
414 case maybe_renamed_expr of
415 Nothing -> return (pcs1, Nothing)
416 Just (print_unqual, rn_expr) -> do {
420 <- typecheckExpr dflags pcs1 hst print_unqual this_module rn_expr;
421 case maybe_tc_return of {
422 Nothing -> return (pcs1, Nothing);
423 Just (pcs2, tc_expr, ty) -> do
425 -- if it isn't an IO-typed expression,
426 -- wrap "print" around it & recompile...
427 let { is_IO_type = case splitTyConApp_maybe ty of {
428 Just (tycon, _) -> getUnique tycon == ioTyConKey;
433 then do (new_pcs, maybe_stuff)
434 <- hscExpr dflags hst hit pcs2 this_module
435 ("print (" ++ expr ++ ")")
437 Nothing -> return (new_pcs, maybe_stuff)
439 return (new_pcs, Just (bcos, print_unqual, ty))
443 ds_expr <- deSugarExpr dflags pcs2 hst this_module
444 print_unqual tc_expr;
447 simpl_expr <- simplifyExpr dflags pcs2 hst ds_expr;
450 sat_expr <- coreSatExpr dflags simpl_expr;
452 -- ToDo: need to do SRTs?
455 bcos <- coreExprToBCOs dflags sat_expr
457 return (pcs2, Just (bcos, print_unqual, ty));
460 hscParseExpr :: DynFlags -> String -> IO (Maybe RdrNameHsExpr)
461 hscParseExpr dflags str
462 = do -------------------------- Parser ----------------
463 showPass dflags "Parser"
466 buf <- stringToStringBuffer ("__expr " ++ str)
468 -- glaexts is True for now (because of the daft __expr at the front
471 --let glaexts | dopt Opt_GlasgowExts dflags = 1#
474 case parse buf PState{ bol = 0#, atbol = 1#,
475 context = [], glasgow_exts = glaexts,
476 loc = mkSrcLoc SLIT("<no file>") 0 } of {
478 PFailed err -> do { freeStringBuffer buf;
479 hPutStrLn stderr (showSDoc err);
482 POk _ (PExpr rdr_expr) -> do {
484 --ToDo: can't free the string buffer until we've finished this
485 -- compilation sweep and all the identifiers have gone away.
486 --freeStringBuffer buf;
487 dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr rdr_expr);
488 return (Just rdr_expr)
493 %************************************************************************
495 \subsection{Initial persistent state}
497 %************************************************************************
500 initPersistentCompilerState :: IO PersistentCompilerState
501 initPersistentCompilerState
502 = do prs <- initPersistentRenamerState
504 PCS { pcs_PIT = emptyIfaceTable,
505 pcs_PTE = wiredInThingEnv,
506 pcs_insts = emptyInstEnv,
507 pcs_rules = emptyRuleBase,
512 initPersistentRenamerState :: IO PersistentRenamerState
513 = do us <- mkSplitUniqSupply 'r'
515 PRS { prsOrig = NameSupply { nsUniqs = us,
516 nsNames = initOrigNames,
518 prsDecls = (emptyNameEnv, 0),
519 prsInsts = (emptyBag, 0),
520 prsRules = (emptyBag, 0),
525 initOrigNames :: FiniteMap (ModuleName,OccName) Name
527 = grab knownKeyNames `plusFM` grab (map getName wiredInThings)
529 grab names = foldl add emptyFM names
531 = addToFM env (moduleName (nameModule name), nameOccName name) name
534 initRules :: PackageRuleBase
535 initRules = emptyRuleBase
537 foldl add emptyVarEnv builtinRules
540 = extendRuleBase env name rule