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,
8 initPersistentCompilerState ) where
10 #include "HsVersions.h"
12 import Maybe ( isJust )
13 import IO ( hPutStrLn, stderr )
16 import StringBuffer ( hGetStringBuffer )
17 import Parser ( parse )
18 import Lex ( PState(..), ParseResult(..) )
19 import SrcLoc ( mkSrcLoc )
21 import Rename ( renameModule, checkOldIface, closeIfaceDecls )
22 import Rules ( emptyRuleBase )
23 import PrelInfo ( wiredInThingEnv, wiredInThings )
24 import PrelNames ( knownKeyNames )
25 import MkIface ( completeIface, mkModDetailsFromIface, mkModDetails,
26 writeIface, pprIface )
27 import TcModule ( TcResults(..), typecheckModule )
28 import InstEnv ( emptyInstEnv )
29 import Desugar ( deSugar )
30 import SimplCore ( core2core )
31 import OccurAnal ( occurAnalyseBinds )
32 import CoreUtils ( coreBindsSize )
33 import CoreTidy ( tidyCorePgm )
34 import CoreToStg ( topCoreBindsToStg )
35 import StgSyn ( collectFinalStgBinders )
36 import SimplStg ( stg2stg )
37 import CodeGen ( codeGen )
38 import CodeOutput ( codeOutput )
40 import Module ( ModuleName, moduleName, mkModuleInThisPackage )
42 import ErrUtils ( dumpIfSet_dyn, showPass )
43 import Util ( unJust )
44 import UniqSupply ( mkSplitUniqSupply )
46 import Bag ( emptyBag )
48 import Interpreter ( UnlinkedIBind, ItblEnv, stgToInterpSyn )
49 import HscStats ( ppSourceStats )
50 import HscTypes ( ModDetails, ModIface(..), PersistentCompilerState(..),
51 PersistentRenamerState(..), ModuleLocation(..),
53 OrigNameEnv(..), PackageRuleBase, HomeIfaceTable,
54 typeEnvClasses, typeEnvTyCons, emptyIfaceTable )
55 import FiniteMap ( FiniteMap, plusFM, emptyFM, addToFM )
56 import OccName ( OccName )
57 import Name ( Name, nameModule, nameOccName, getName )
58 import Name ( emptyNameEnv )
59 import Module ( Module, lookupModuleEnvByName )
65 %************************************************************************
67 \subsection{The main compiler pipeline}
69 %************************************************************************
73 = HscOK ModDetails -- new details (HomeSymbolTable additions)
74 (Maybe ModIface) -- new iface (if any compilation was done)
75 (Maybe String) -- generated stub_h filename (in /tmp)
76 (Maybe String) -- generated stub_c filename (in /tmp)
77 (Maybe ([UnlinkedIBind],ItblEnv)) -- interpreted code, if any
78 PersistentCompilerState -- updated PCS
80 | HscFail PersistentCompilerState -- updated PCS
81 -- no errors or warnings; the individual passes
82 -- (parse/rename/typecheck) print messages themselves
86 -> Bool -- source unchanged?
87 -> ModuleLocation -- location info
88 -> Maybe ModIface -- old interface, if available
89 -> HomeSymbolTable -- for home module ModDetails
91 -> PersistentCompilerState -- IN: persistent compiler state
94 hscMain dflags source_unchanged location maybe_old_iface hst hit pcs
96 putStrLn ("CHECKING OLD IFACE for hs = " ++ show (ml_hs_file location)
97 ++ ", hspp = " ++ show (ml_hspp_file location));
99 (pcs_ch, errs_found, (recomp_reqd, maybe_checked_iface))
100 <- checkOldIface dflags hit hst pcs (unJust (ml_hi_file location) "hscMain")
101 source_unchanged maybe_old_iface;
104 return (HscFail pcs_ch)
107 let no_old_iface = not (isJust maybe_checked_iface)
108 what_next | recomp_reqd || no_old_iface = hscRecomp
109 | otherwise = hscNoRecomp
111 what_next dflags location maybe_checked_iface
116 hscNoRecomp dflags location maybe_checked_iface hst hit pcs_ch
118 hPutStrLn stderr "COMPILATION NOT REQUIRED";
119 -- we definitely expect to have the old interface available
120 let old_iface = case maybe_checked_iface of
121 Just old_if -> old_if
122 Nothing -> panic "hscNoRecomp:old_iface"
123 this_mod = mi_module old_iface
126 (pcs_cl, closure_errs, cl_hs_decls)
127 <- closeIfaceDecls dflags hit hst pcs_ch old_iface ;
129 return (HscFail pcs_cl)
133 maybe_tc_result <- typecheckModule dflags this_mod pcs_cl hst
134 old_iface alwaysQualify cl_hs_decls;
135 case maybe_tc_result of {
136 Nothing -> return (HscFail pcs_cl);
137 Just tc_result -> do {
139 let pcs_tc = tc_pcs tc_result
140 env_tc = tc_env tc_result
141 local_insts = tc_insts tc_result
142 local_rules = tc_rules tc_result
144 -- create a new details from the closed, typechecked, old iface
145 let new_details = mkModDetailsFromIface env_tc local_insts local_rules
147 return (HscOK new_details
148 Nothing -- tells CM to use old iface and linkables
149 Nothing Nothing -- foreign export stuff
155 hscRecomp dflags location maybe_checked_iface hst hit pcs_ch
157 ; hPutStrLn stderr "COMPILATION IS REQUIRED";
159 -- what target are we shooting for?
160 ; let toInterp = dopt_HscLang dflags == HscInterpreted
165 ; maybe_parsed <- myParseModule dflags (unJust (ml_hspp_file location) "hscRecomp:hspp")
166 ; case maybe_parsed of {
167 Nothing -> return (HscFail pcs_ch);
168 Just rdr_module -> do {
169 ; let this_mod = mkModuleInThisPackage (hsModuleName rdr_module)
174 ; (pcs_rn, maybe_rn_result)
175 <- renameModule dflags hit hst pcs_ch this_mod rdr_module
176 ; case maybe_rn_result of {
177 Nothing -> return (HscFail pcs_rn);
178 Just (print_unqualified, is_exported, new_iface, rn_hs_decls) -> do {
183 ; maybe_tc_result <- typecheckModule dflags this_mod pcs_rn hst new_iface
184 print_unqualified rn_hs_decls
185 ; case maybe_tc_result of {
186 Nothing -> do { hPutStrLn stderr "Typecheck failed"
187 ; return (HscFail pcs_rn) } ;
188 Just tc_result -> do {
190 ; let pcs_tc = tc_pcs tc_result
191 env_tc = tc_env tc_result
192 local_insts = tc_insts tc_result
195 -- DESUGAR, SIMPLIFY, TIDY-CORE
197 -- We grab the the unfoldings at this point.
198 ; simpl_result <- dsThenSimplThenTidy dflags (pcs_rules pcs_tc) this_mod
199 print_unqualified is_exported tc_result hst
200 ; let (tidy_binds, orphan_rules, foreign_stuff) = simpl_result
205 ; (stg_binds, oa_tidy_binds, cost_centre_info, top_level_ids)
206 <- myCoreToStg dflags this_mod tidy_binds
210 -- BUILD THE NEW ModDetails AND ModIface
212 ; let new_details = mkModDetails env_tc local_insts tidy_binds
213 top_level_ids orphan_rules
214 ; final_iface <- mkFinalIface dflags location maybe_checked_iface
215 new_iface new_details
218 -- COMPLETE CODE GENERATION
220 ; (maybe_stub_h_filename, maybe_stub_c_filename, maybe_ibinds)
221 <- restOfCodeGeneration dflags toInterp this_mod
222 (map ideclName (hsModuleImports rdr_module))
223 cost_centre_info foreign_stuff env_tc stg_binds oa_tidy_binds
226 -- and the answer is ...
227 ; return (HscOK new_details (Just final_iface)
228 maybe_stub_h_filename maybe_stub_c_filename
234 mkFinalIface dflags location maybe_old_iface new_iface new_details
235 = case completeIface maybe_old_iface new_iface new_details of
236 (new_iface, Nothing) -- no change in the interfacfe
237 -> do when (dopt Opt_D_dump_hi_diffs dflags)
238 (printDump (text "INTERFACE UNCHANGED"))
239 dumpIfSet_dyn dflags Opt_D_dump_hi
240 "UNCHANGED FINAL INTERFACE" (pprIface new_iface)
242 (new_iface, Just sdoc_diffs)
243 -> do dumpIfSet_dyn dflags Opt_D_dump_hi_diffs "INTERFACE HAS CHANGED" sdoc_diffs
244 dumpIfSet_dyn dflags Opt_D_dump_hi "NEW FINAL INTERFACE" (pprIface new_iface)
245 -- Write the interface file
246 writeIface (unJust (ml_hi_file location) "hscRecomp:hi") new_iface
250 myParseModule dflags src_filename
251 = do -------------------------- Parser ----------------
252 showPass dflags "Parser"
255 buf <- hGetStringBuffer True{-expand tabs-} src_filename
257 let glaexts | dopt Opt_GlasgowExts dflags = 1#
260 case parse buf PState{ bol = 0#, atbol = 1#,
261 context = [], glasgow_exts = glaexts,
262 loc = mkSrcLoc (_PK_ src_filename) 1 } of {
264 PFailed err -> do { hPutStrLn stderr (showSDoc err);
266 POk _ rdr_module@(HsModule mod_name _ _ _ _ _ _) -> do {
268 dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr rdr_module) ;
270 dumpIfSet_dyn dflags Opt_D_source_stats "Source Statistics"
271 (ppSourceStats False rdr_module) ;
273 return (Just rdr_module)
277 restOfCodeGeneration dflags toInterp this_mod imported_module_names cost_centre_info
278 foreign_stuff env_tc stg_binds oa_tidy_binds
279 hit pit -- these last two for mapping ModNames to Modules
281 = do (ibinds,itbl_env)
282 <- stgToInterpSyn (map fst stg_binds) local_tycons local_classes
283 return (Nothing, Nothing, Just (ibinds,itbl_env))
286 = do -------------------------- Code generation -------------------------------
288 abstractC <- codeGen dflags this_mod imported_modules
289 cost_centre_info fe_binders
290 local_tycons stg_binds
292 -------------------------- Code output -------------------------------
293 -- _scc_ "CodeOutput"
294 (maybe_stub_h_name, maybe_stub_c_name)
295 <- codeOutput dflags this_mod local_tycons
296 oa_tidy_binds stg_binds
297 c_code h_code abstractC
299 return (maybe_stub_h_name, maybe_stub_c_name, Nothing)
301 local_tycons = typeEnvTyCons env_tc
302 local_classes = typeEnvClasses env_tc
303 imported_modules = map mod_name_to_Module imported_module_names
304 (fe_binders,h_code,c_code) = foreign_stuff
306 mod_name_to_Module :: ModuleName -> Module
307 mod_name_to_Module nm
308 = let str_mi = case lookupModuleEnvByName hit nm of
310 Nothing -> case lookupModuleEnvByName pit nm of
314 barf nm = pprPanic "mod_name_to_Module: no hst or pst mapping for"
318 dsThenSimplThenTidy dflags rule_base this_mod print_unqual is_exported tc_result hst
319 = do -------------------------- Desugaring ----------------
321 (desugared, rules, h_code, c_code, fe_binders)
322 <- deSugar dflags this_mod print_unqual hst tc_result
324 -------------------------- Main Core-language transformations ----------------
326 (simplified, orphan_rules)
327 <- core2core dflags rule_base hst is_exported desugared rules
329 -- Do the final tidy-up
330 (tidy_binds, tidy_orphan_rules)
331 <- tidyCorePgm dflags this_mod simplified orphan_rules
333 return (tidy_binds, tidy_orphan_rules, (fe_binders,h_code,c_code))
336 myCoreToStg dflags this_mod tidy_binds
338 c2s_uniqs <- mkSplitUniqSupply 'c'
339 st_uniqs <- mkSplitUniqSupply 'g'
340 let occ_anal_tidy_binds = occurAnalyseBinds tidy_binds
342 () <- coreBindsSize occ_anal_tidy_binds `seq` return ()
343 -- TEMP: the above call zaps some space usage allocated by the
344 -- simplifier, which for reasons I don't understand, persists
345 -- thoroughout code generation
347 showPass dflags "Core2Stg"
349 let stg_binds = topCoreBindsToStg c2s_uniqs occ_anal_tidy_binds
351 showPass dflags "Stg2Stg"
353 (stg_binds2, cost_centre_info) <- stg2stg dflags this_mod st_uniqs stg_binds
354 let final_ids = collectFinalStgBinders (map fst stg_binds2)
356 return (stg_binds2, occ_anal_tidy_binds, cost_centre_info, final_ids)
360 %************************************************************************
362 \subsection{Compiling an expression}
364 %************************************************************************
370 -> PersistentCompilerState -- IN: persistent compiler state
371 -> Module -- Context for compiling
372 -> String -- The expression
375 hscExpr dflags hst hit pcs this_module expr
377 ; maybe_parsed <- myParseExpr dflags expr
378 ; case maybe_parsed of {
379 Nothing -> return (HscFail pcs_ch);
380 Just parsed_expr -> do {
383 (new_pcs, maybe_renamed_expr) <- renameExpr dflags hit hst pcs this_module parsed_expr ;
384 case maybe_renamed_expr of {
388 %************************************************************************
390 \subsection{Initial persistent state}
392 %************************************************************************
395 initPersistentCompilerState :: IO PersistentCompilerState
396 initPersistentCompilerState
397 = do prs <- initPersistentRenamerState
399 PCS { pcs_PIT = emptyIfaceTable,
400 pcs_PTE = wiredInThingEnv,
401 pcs_insts = emptyInstEnv,
402 pcs_rules = emptyRuleBase,
407 initPersistentRenamerState :: IO PersistentRenamerState
408 = do ns <- mkSplitUniqSupply 'r'
410 PRS { prsOrig = Orig { origNames = initOrigNames,
411 origIParam = emptyFM },
412 prsDecls = (emptyNameEnv, 0),
413 prsInsts = (emptyBag, 0),
414 prsRules = (emptyBag, 0),
419 initOrigNames :: FiniteMap (ModuleName,OccName) Name
421 = grab knownKeyNames `plusFM` grab (map getName wiredInThings)
423 grab names = foldl add emptyFM names
425 = addToFM env (moduleName (nameModule name), nameOccName name) name
428 initRules :: PackageRuleBase
429 initRules = emptyRuleBase
431 foldl add emptyVarEnv builtinRules
434 = extendRuleBase env name rule