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 CoreToStg ( coreExprToStg )
19 import StringBuffer ( stringToStringBuffer, freeStringBuffer )
20 import Unique ( Uniquable(..) )
21 import Type ( Type, splitTyConApp_maybe )
22 import PrelNames ( ioTyConKey )
23 import ByteCodeGen ( byteCodeGen )
28 import StringBuffer ( hGetStringBuffer )
30 import Lex ( PState(..), ParseResult(..) )
31 import SrcLoc ( mkSrcLoc )
32 import Rename ( checkOldIface, renameModule, closeIfaceDecls )
33 import Rules ( emptyRuleBase )
34 import PrelInfo ( wiredInThingEnv, wiredInThings )
35 import PrelNames ( knownKeyNames )
36 import MkIface ( completeIface, mkModDetailsFromIface, mkModDetails,
37 writeIface, pprIface )
39 import InstEnv ( emptyInstEnv )
42 import CoreUtils ( coreBindsSize )
43 import CoreTidy ( tidyCorePgm )
45 import CoreToStg ( coreToStg )
46 import SimplStg ( stg2stg )
47 import CodeGen ( codeGen )
48 import CodeOutput ( codeOutput )
50 import Module ( ModuleName, moduleName, mkHomeModule )
52 import ErrUtils ( dumpIfSet_dyn, showPass )
53 import Util ( unJust )
54 import UniqSupply ( mkSplitUniqSupply )
56 import Bag ( emptyBag )
59 import CmStaticInfo ( GhciMode(..) )
60 import HscStats ( ppSourceStats )
61 import HscTypes ( ModDetails, ModIface(..), PersistentCompilerState(..),
62 PersistentRenamerState(..), ModuleLocation(..),
64 NameSupply(..), PackageRuleBase, HomeIfaceTable,
65 typeEnvClasses, typeEnvTyCons, emptyIfaceTable )
66 import FiniteMap ( FiniteMap, plusFM, emptyFM, addToFM )
67 import OccName ( OccName )
68 import Name ( Name, nameModule, nameOccName, getName )
69 import Name ( emptyNameEnv )
70 import Module ( Module, lookupModuleEnvByName )
73 import Maybe ( isJust )
75 import List ( intersperse )
79 %************************************************************************
81 \subsection{The main compiler pipeline}
83 %************************************************************************
88 = HscFail PersistentCompilerState -- updated PCS
89 -- concluded that it wasn't necessary
90 | HscNoRecomp PersistentCompilerState -- updated PCS
91 ModDetails -- new details (HomeSymbolTable additions)
92 ModIface -- new iface (if any compilation was done)
94 | HscRecomp PersistentCompilerState -- updated PCS
95 ModDetails -- new details (HomeSymbolTable additions)
96 ModIface -- new iface (if any compilation was done)
97 (Maybe String) -- generated stub_h filename (in /tmp)
98 (Maybe String) -- generated stub_c filename (in /tmp)
99 (Maybe ([UnlinkedIBind],ItblEnv)) -- interpreted code, if any
102 -- no errors or warnings; the individual passes
103 -- (parse/rename/typecheck) print messages themselves
108 -> Bool -- source unchanged?
109 -> ModuleLocation -- location info
110 -> Maybe ModIface -- old interface, if available
111 -> HomeSymbolTable -- for home module ModDetails
113 -> PersistentCompilerState -- IN: persistent compiler state
116 hscMain ghci_mode dflags source_unchanged location maybe_old_iface hst hit pcs
118 showPass dflags ("Checking old interface for hs = "
119 ++ show (ml_hs_file location)
120 ++ ", hspp = " ++ show (ml_hspp_file location));
122 (pcs_ch, errs_found, (recomp_reqd, maybe_checked_iface))
123 <- checkOldIface ghci_mode dflags hit hst pcs
124 (unJust "hscMain" (ml_hi_file location))
125 source_unchanged maybe_old_iface;
128 return (HscFail pcs_ch)
131 let no_old_iface = not (isJust maybe_checked_iface)
132 what_next | recomp_reqd || no_old_iface = hscRecomp
133 | otherwise = hscNoRecomp
135 what_next ghci_mode dflags location maybe_checked_iface
140 -- we definitely expect to have the old interface available
141 hscNoRecomp ghci_mode dflags location (Just old_iface) hst hit pcs_ch
142 | ghci_mode == OneShot
144 hPutStrLn stderr "compilation IS NOT required";
145 let { bomb = panic "hscNoRecomp:OneShot" };
146 return (HscNoRecomp pcs_ch bomb bomb)
150 hPutStr stderr "compilation IS NOT required";
151 when (verbosity dflags /= 1) $ hPutStrLn stderr "";
154 (pcs_cl, closure_errs, cl_hs_decls)
155 <- closeIfaceDecls dflags hit hst pcs_ch old_iface ;
157 return (HscFail pcs_cl)
161 maybe_tc_result <- typecheckModule dflags pcs_cl hst
162 old_iface alwaysQualify cl_hs_decls;
163 case maybe_tc_result of {
164 Nothing -> return (HscFail pcs_cl);
165 Just (pcs_tc, tc_result) -> do {
167 let env_tc = tc_env tc_result
168 local_rules = tc_rules tc_result
170 -- create a new details from the closed, typechecked, old iface
171 let new_details = mkModDetailsFromIface env_tc local_rules
173 return (HscNoRecomp pcs_tc new_details old_iface)
177 hscRecomp ghci_mode dflags location maybe_checked_iface hst hit pcs_ch
179 ; when (verbosity dflags >= 1) $
180 hPutStr stderr "compilation IS required";
181 -- mode -v1 tries to keep everything on one line
182 when (verbosity dflags > 1) $
185 -- what target are we shooting for?
186 ; let toInterp = dopt_HscLang dflags == HscInterpreted
191 ; maybe_parsed <- myParseModule dflags
192 (unJust "hscRecomp:hspp" (ml_hspp_file location))
193 ; case maybe_parsed of {
194 Nothing -> return (HscFail pcs_ch);
195 Just rdr_module -> do {
196 ; let this_mod = mkHomeModule (hsModuleName rdr_module)
201 ; (pcs_rn, maybe_rn_result)
202 <- renameModule dflags hit hst pcs_ch this_mod rdr_module
203 ; case maybe_rn_result of {
204 Nothing -> return (HscFail pcs_rn);
205 Just (print_unqualified, (is_exported, new_iface, rn_hs_decls)) -> do {
210 ; maybe_tc_result <- 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)
222 <- deSugar dflags pcs_tc hst this_mod print_unqualified tc_result
225 -- SIMPLIFY, TIDY-CORE
227 -- We grab the the unfoldings at this point.
228 ; (pcs_simpl, tidy_binds, orphan_rules)
229 <- simplThenTidy dflags pcs_tc hst this_mod is_exported ds_binds ds_rules
232 -- BUILD THE NEW ModDetails AND ModIface
234 ; let new_details = mkModDetails env_tc tidy_binds orphan_rules
235 ; final_iface <- mkFinalIface ghci_mode dflags location
236 maybe_checked_iface new_iface new_details
241 ; (stg_binds, cost_centre_info)
242 <- myCoreToStg dflags this_mod tidy_binds
245 -- COMPLETE CODE GENERATION
247 ; (maybe_stub_h_filename, maybe_stub_c_filename, maybe_ibinds)
248 <- restOfCodeGeneration dflags toInterp this_mod
249 (map ideclName (hsModuleImports rdr_module))
250 cost_centre_info foreign_stuff env_tc stg_binds tidy_binds
251 hit (pcs_PIT pcs_simpl)
253 -- and the answer is ...
254 ; return (HscRecomp pcs_simpl new_details final_iface
255 maybe_stub_h_filename maybe_stub_c_filename
261 mkFinalIface ghci_mode dflags location maybe_old_iface new_iface new_details
262 = case completeIface maybe_old_iface new_iface new_details of
263 (new_iface, Nothing) -- no change in the interfacfe
264 -> do when (dopt Opt_D_dump_hi_diffs dflags)
265 (printDump (text "INTERFACE UNCHANGED"))
266 dumpIfSet_dyn dflags Opt_D_dump_hi
267 "UNCHANGED FINAL INTERFACE" (pprIface new_iface)
269 (new_iface, Just sdoc_diffs)
270 -> do dumpIfSet_dyn dflags Opt_D_dump_hi_diffs "INTERFACE HAS CHANGED"
272 dumpIfSet_dyn dflags Opt_D_dump_hi "NEW FINAL INTERFACE"
274 -- Write the interface file
275 when (ghci_mode /= Interactive)
276 (writeIface (unJust "hscRecomp:hi" (ml_hi_file location))
281 myParseModule dflags src_filename
282 = do -------------------------- Parser ----------------
283 showPass dflags "Parser"
286 buf <- hGetStringBuffer True{-expand tabs-} src_filename
288 let glaexts | dopt Opt_GlasgowExts dflags = 1#
291 case parse buf PState{ bol = 0#, atbol = 1#,
292 context = [], glasgow_exts = glaexts,
293 loc = mkSrcLoc (_PK_ src_filename) 1 } of {
295 PFailed err -> do { hPutStrLn stderr (showSDoc err);
298 POk _ (PModule rdr_module@(HsModule mod_name _ _ _ _ _ _)) -> do {
300 dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr rdr_module) ;
302 dumpIfSet_dyn dflags Opt_D_source_stats "Source Statistics"
303 (ppSourceStats False rdr_module) ;
305 return (Just rdr_module)
309 simplThenTidy dflags pcs hst this_mod is_exported binds rules
310 = do -- Do main Core-language transformations ---------
312 (simplified, orphan_rules)
313 <- core2core dflags pcs hst is_exported binds rules
315 -- Do saturation and convert to A-normal form
316 -- NOTE: future passes cannot transform the syntax, only annotate it
317 saturated <- coreSatPgm dflags simplified
319 -- Do the final tidy-up
320 (pcs', tidy_binds, tidy_orphan_rules)
321 <- tidyCorePgm dflags this_mod pcs saturated orphan_rules
323 return (pcs', tidy_binds, tidy_orphan_rules)
326 restOfCodeGeneration dflags toInterp this_mod imported_module_names cost_centre_info
327 foreign_stuff env_tc stg_binds tidy_binds
328 hit pit -- these last two for mapping ModNames to Modules
330 = do (ibinds,itbl_env)
331 <- stgBindsToInterpSyn dflags (map fst stg_binds)
332 local_tycons local_classes
333 return (Nothing, Nothing, Just (ibinds,itbl_env))
336 = do -------------------------- Code generation -------------------------------
338 abstractC <- codeGen dflags this_mod imported_modules
339 cost_centre_info fe_binders
340 local_tycons stg_binds
342 -------------------------- Code output -------------------------------
343 -- _scc_ "CodeOutput"
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
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 tidy_binds
376 --putStrLn ("\n\n" ++ showSDocDebug (vcat (intersperse (char ' ') (map ppr bcos))))
379 stg_binds <- coreToStg dflags this_mod tidy_binds
382 (stg_binds2, cost_centre_info) <- stg2stg dflags this_mod stg_binds
384 return (stg_binds2, cost_centre_info)
388 %************************************************************************
390 \subsection{Compiling an expression}
392 %************************************************************************
400 -> PersistentCompilerState -- IN: persistent compiler state
401 -> Module -- Context for compiling
402 -> String -- The expression
403 -> IO ( PersistentCompilerState,
404 Maybe (UnlinkedIExpr, PrintUnqualified, Type) )
406 hscExpr dflags hst hit pcs0 this_module expr
408 maybe_parsed <- hscParseExpr dflags expr;
410 Nothing -> return (pcs0, Nothing)
411 Just parsed_expr -> do {
414 (pcs1, maybe_renamed_expr) <-
415 renameExpr dflags hit hst pcs0 this_module parsed_expr;
416 case maybe_renamed_expr of
417 Nothing -> return (pcs1, Nothing)
418 Just (print_unqual, rn_expr) -> do {
422 <- typecheckExpr dflags pcs1 hst print_unqual this_module rn_expr;
423 case maybe_tc_return of {
424 Nothing -> return (pcs1, Nothing);
425 Just (pcs2, tc_expr, ty) -> do
427 -- if it isn't an IO-typed expression,
428 -- wrap "print" around it & recompile...
429 let { is_IO_type = case splitTyConApp_maybe ty of {
430 Just (tycon, _) -> getUnique tycon == ioTyConKey;
435 then do (new_pcs, maybe_stuff)
436 <- hscExpr dflags hst hit pcs2 this_module
437 ("print (" ++ expr ++ ")")
439 Nothing -> return (new_pcs, maybe_stuff)
441 return (new_pcs, Just (expr, print_unqual, ty))
445 ds_expr <- deSugarExpr dflags pcs2 hst this_module
446 print_unqual tc_expr;
449 simpl_expr <- simplifyExpr dflags pcs2 hst ds_expr;
452 sat_expr <- coreSatExpr dflags simpl_expr;
455 let stg_expr = coreExprToStg sat_expr;
457 -- ToDo: need to do SRTs?
459 -- Convert to InterpSyn
460 unlinked_iexpr <- stgExprToInterpSyn dflags stg_expr;
462 return (pcs2, Just (unlinked_iexpr, print_unqual, ty));
465 hscParseExpr :: DynFlags -> String -> IO (Maybe RdrNameHsExpr)
466 hscParseExpr dflags str
467 = do -------------------------- Parser ----------------
468 showPass dflags "Parser"
471 buf <- stringToStringBuffer ("__expr " ++ str)
473 -- glaexts is True for now (because of the daft __expr at the front
476 --let glaexts | dopt Opt_GlasgowExts dflags = 1#
479 case parse buf PState{ bol = 0#, atbol = 1#,
480 context = [], glasgow_exts = glaexts,
481 loc = mkSrcLoc SLIT("<no file>") 0 } of {
483 PFailed err -> do { freeStringBuffer buf;
484 hPutStrLn stderr (showSDoc err);
487 POk _ (PExpr rdr_expr) -> do {
489 --ToDo: can't free the string buffer until we've finished this
490 -- compilation sweep and all the identifiers have gone away.
491 --freeStringBuffer buf;
492 dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr rdr_expr);
493 return (Just rdr_expr)
498 %************************************************************************
500 \subsection{Initial persistent state}
502 %************************************************************************
505 initPersistentCompilerState :: IO PersistentCompilerState
506 initPersistentCompilerState
507 = do prs <- initPersistentRenamerState
509 PCS { pcs_PIT = emptyIfaceTable,
510 pcs_PTE = wiredInThingEnv,
511 pcs_insts = emptyInstEnv,
512 pcs_rules = emptyRuleBase,
517 initPersistentRenamerState :: IO PersistentRenamerState
518 = do us <- mkSplitUniqSupply 'r'
520 PRS { prsOrig = NameSupply { nsUniqs = us,
521 nsNames = initOrigNames,
523 prsDecls = (emptyNameEnv, 0),
524 prsInsts = (emptyBag, 0),
525 prsRules = (emptyBag, 0)
529 initOrigNames :: FiniteMap (ModuleName,OccName) Name
531 = grab knownKeyNames `plusFM` grab (map getName wiredInThings)
533 grab names = foldl add emptyFM names
535 = addToFM env (moduleName (nameModule name), nameOccName name) name
538 initRules :: PackageRuleBase
539 initRules = emptyRuleBase
541 foldl add emptyVarEnv builtinRules
544 = extendRuleBase env name rule