[project @ 2001-05-01 09:10:32 by simonmar]
[ghc-hetmet.git] / ghc / compiler / main / HscMain.lhs
1 %
2 % (c) The GRASP/AQUA Project, Glasgow University, 1993-2000
3 %
4
5 \section[GHC_Main]{Main driver for Glasgow Haskell compiler}
6
7 \begin{code}
8 module HscMain ( HscResult(..), hscMain, 
9 #ifdef GHCI
10                  hscStmt,
11 #endif
12                  initPersistentCompilerState ) where
13
14 #include "HsVersions.h"
15
16 #ifdef GHCI
17 import ByteCodeGen      ( byteCodeGen )
18 import CoreTidy         ( tidyCoreExpr )
19 import CorePrep         ( corePrepExpr )
20 import Rename           ( renameStmt )
21 import RdrHsSyn         ( RdrNameStmt )
22 import Type             ( Type )
23 import Id               ( Id, idName, setGlobalIdDetails )
24 import IdInfo           ( GlobalIdDetails(VanillaGlobal) )
25 import HscTypes         ( InteractiveContext(..), TyThing(..) )
26 import PrelNames        ( iNTERACTIVE )
27 import StringBuffer     ( stringToStringBuffer )
28 #endif
29
30 import HsSyn
31
32 import Id               ( idName )
33 import IdInfo           ( CafInfo(..), CgInfoEnv, CgInfo(..) )
34 import StringBuffer     ( hGetStringBuffer, freeStringBuffer )
35 import Parser
36 import Lex              ( PState(..), ParseResult(..) )
37 import SrcLoc           ( mkSrcLoc )
38 import Finder           ( findModule )
39 import Rename           ( checkOldIface, renameModule, closeIfaceDecls )
40 import Rules            ( emptyRuleBase )
41 import PrelInfo         ( wiredInThingEnv, wiredInThings )
42 import PrelNames        ( vanillaSyntaxMap, knownKeyNames )
43 import MkIface          ( mkFinalIface )
44 import TcModule
45 import InstEnv          ( emptyInstEnv )
46 import Desugar
47 import SimplCore
48 import CoreUtils        ( coreBindsSize )
49 import CoreTidy         ( tidyCorePgm )
50 import CorePrep         ( corePrepPgm )
51 import StgSyn
52 import CoreToStg        ( coreToStg )
53 import SimplStg         ( stg2stg )
54 import CodeGen          ( codeGen )
55 import CodeOutput       ( codeOutput )
56
57 import Module           ( ModuleName, moduleName, mkHomeModule, 
58                           moduleUserString )
59 import CmdLineOpts
60 import ErrUtils         ( dumpIfSet_dyn, showPass, printError )
61 import Util             ( unJust )
62 import UniqSupply       ( mkSplitUniqSupply )
63
64 import Bag              ( emptyBag )
65 import Outputable
66 import Interpreter
67 import CmStaticInfo     ( GhciMode(..) )
68 import HscStats         ( ppSourceStats )
69 import HscTypes
70 import FiniteMap        ( FiniteMap, plusFM, emptyFM, addToFM )
71 import OccName          ( OccName )
72 import Name             ( Name, nameModule, nameOccName, getName, isGlobalName )
73 import NameEnv          ( emptyNameEnv, mkNameEnv )
74 import Module           ( Module, lookupModuleEnvByName )
75 import Maybes           ( orElse )
76
77 import IOExts           ( newIORef, readIORef, writeIORef, unsafePerformIO )
78
79 import Monad            ( when )
80 import Maybe            ( isJust, fromJust )
81 import IO
82 \end{code}
83
84
85 %************************************************************************
86 %*                                                                      *
87 \subsection{The main compiler pipeline}
88 %*                                                                      *
89 %************************************************************************
90
91 \begin{code}
92 data HscResult
93    -- compilation failed
94    = HscFail     PersistentCompilerState -- updated PCS
95    -- concluded that it wasn't necessary
96    | HscNoRecomp PersistentCompilerState -- updated PCS
97                  ModDetails              -- new details (HomeSymbolTable additions)
98                  ModIface                -- new iface (if any compilation was done)
99    -- did recompilation
100    | HscRecomp   PersistentCompilerState -- updated PCS
101                  ModDetails              -- new details (HomeSymbolTable additions)
102                  ModIface                -- new iface (if any compilation was done)
103                  Bool                   -- stub_h exists
104                  Bool                   -- stub_c exists
105                  (Maybe ([UnlinkedBCO],ItblEnv)) -- interpreted code, if any
106              
107
108         -- no errors or warnings; the individual passes
109         -- (parse/rename/typecheck) print messages themselves
110
111 hscMain
112   :: GhciMode
113   -> DynFlags
114   -> Module
115   -> ModuleLocation             -- location info
116   -> Bool                       -- True <=> source unchanged
117   -> Bool                       -- True <=> have an object file (for msgs only)
118   -> Maybe ModIface             -- old interface, if available
119   -> HomeSymbolTable            -- for home module ModDetails
120   -> HomeIfaceTable
121   -> PersistentCompilerState    -- IN: persistent compiler state
122   -> IO HscResult
123
124 hscMain ghci_mode dflags mod location source_unchanged have_object 
125         maybe_old_iface hst hit pcs
126  = do {
127       showPass dflags ("Checking old interface for hs = " 
128                         ++ show (ml_hs_file location)
129                         ++ ", hspp = " ++ show (ml_hspp_file location));
130
131       (pcs_ch, errs_found, (recomp_reqd, maybe_checked_iface))
132          <- _scc_ "checkOldIface"
133             checkOldIface ghci_mode dflags hit hst pcs 
134                 (unJust "hscMain" (ml_hi_file location))
135                 source_unchanged maybe_old_iface;
136
137       if errs_found then
138          return (HscFail pcs_ch)
139       else do {
140
141       let no_old_iface = not (isJust maybe_checked_iface)
142           what_next | recomp_reqd || no_old_iface = hscRecomp 
143                     | otherwise                   = hscNoRecomp
144       ;
145       what_next ghci_mode dflags have_object mod location 
146                 maybe_checked_iface hst hit pcs_ch
147       }}
148
149
150 -- we definitely expect to have the old interface available
151 hscNoRecomp ghci_mode dflags have_object 
152             mod location (Just old_iface) hst hit pcs_ch
153  | ghci_mode == OneShot
154  = do {
155       hPutStrLn stderr "compilation IS NOT required";
156       let { bomb = panic "hscNoRecomp:OneShot" };
157       return (HscNoRecomp pcs_ch bomb bomb)
158       }
159  | otherwise
160  = do {
161       when (verbosity dflags >= 1) $
162                 hPutStrLn stderr ("Skipping  " ++ 
163                         compMsg have_object mod location);
164
165       -- CLOSURE
166       (pcs_cl, closure_errs, cl_hs_decls) 
167          <- closeIfaceDecls dflags hit hst pcs_ch old_iface ;
168       if closure_errs then 
169          return (HscFail pcs_cl) 
170       else do {
171
172       -- TYPECHECK
173       maybe_tc_result 
174         <- typecheckIface dflags pcs_cl hst old_iface (vanillaSyntaxMap, cl_hs_decls);
175
176       case maybe_tc_result of {
177          Nothing -> return (HscFail pcs_cl);
178          Just (pcs_tc, new_details) ->
179
180       return (HscNoRecomp pcs_tc new_details old_iface)
181       }}}
182
183 compMsg use_object mod location =
184     mod_str ++ take (max 0 (16 - length mod_str)) (repeat ' ')
185     ++" ( " ++ unJust "hscRecomp" (ml_hs_file location) ++ ", "
186     ++ (if use_object
187           then unJust "hscRecomp" (ml_obj_file location)
188           else "interpreted")
189     ++ " )"
190  where mod_str = moduleUserString mod
191
192
193 hscRecomp ghci_mode dflags have_object 
194           mod location maybe_checked_iface hst hit pcs_ch
195  = do   {
196           -- what target are we shooting for?
197         ; let toInterp = dopt_HscLang dflags == HscInterpreted
198
199         ; when (verbosity dflags >= 1) $
200                 hPutStrLn stderr ("Compiling " ++ 
201                         compMsg (not toInterp) mod location);
202
203             -------------------
204             -- PARSE
205             -------------------
206         ; maybe_parsed <- myParseModule dflags 
207                              (unJust "hscRecomp:hspp" (ml_hspp_file location))
208         ; case maybe_parsed of {
209              Nothing -> return (HscFail pcs_ch);
210              Just rdr_module -> do {
211         ; let this_mod = mkHomeModule (hsModuleName rdr_module)
212     
213             -------------------
214             -- RENAME
215             -------------------
216         ; (pcs_rn, print_unqualified, maybe_rn_result) 
217              <- _scc_ "Rename" 
218                  renameModule dflags hit hst pcs_ch this_mod rdr_module
219         ; case maybe_rn_result of {
220              Nothing -> return (HscFail pcs_ch{-was: pcs_rn-});
221              Just (is_exported, new_iface, rn_hs_decls) -> do {
222     
223             -- In interactive mode, we don't want to discard any top-level entities at
224             -- all (eg. do not inline them away during simplification), and retain them
225             -- all in the TypeEnv so they are available from the command line.
226             --
227             -- isGlobalName separates the user-defined top-level names from those
228             -- introduced by the type checker.
229         ; let dont_discard | ghci_mode == Interactive = isGlobalName
230                            | otherwise = is_exported
231
232             -------------------
233             -- TYPECHECK
234             -------------------
235         ; maybe_tc_result 
236             <- _scc_ "TypeCheck" typecheckModule dflags pcs_rn hst new_iface 
237                                              print_unqualified rn_hs_decls 
238         ; case maybe_tc_result of {
239              Nothing -> return (HscFail pcs_ch{-was: pcs_rn-});
240              Just (pcs_tc, tc_result) -> do {
241     
242             -------------------
243             -- DESUGAR
244             -------------------
245         ; (ds_details, foreign_stuff) 
246              <- _scc_ "DeSugar" 
247                 deSugar dflags pcs_tc hst this_mod print_unqualified tc_result
248
249         ; pcs_middle
250             <- if ghci_mode == OneShot 
251                   then do init_pcs <- initPersistentCompilerState
252                           init_prs <- initPersistentRenamerState
253                           let 
254                               rules   = pcs_rules pcs_tc        
255                               orig_tc = prsOrig (pcs_PRS pcs_tc)
256                               new_prs = init_prs{ prsOrig=orig_tc }
257
258                           orig_tc `seq` rules `seq` new_prs `seq`
259                             return init_pcs{ pcs_PRS = new_prs,
260                                              pcs_rules = rules }
261                   else return pcs_tc
262
263             -------------------
264             -- SIMPLIFY
265             -------------------
266         ; simpl_details
267              <- _scc_     "Core2Core"
268                 core2core dflags pcs_middle hst dont_discard ds_details
269
270             -------------------
271             -- TIDY
272             -------------------
273         ; cg_info_ref <- newIORef Nothing ;
274         ; let cg_info :: CgInfoEnv
275               cg_info = unsafePerformIO $ do {
276                            maybe_cg_env <- readIORef cg_info_ref ;
277                            case maybe_cg_env of
278                              Just env -> return env
279                              Nothing  -> do { printError "Urk! Looked at CgInfo too early!";
280                                               return emptyNameEnv } }
281                 -- cg_info_ref will be filled in just after restOfCodeGeneration
282                 -- Meanwhile, tidyCorePgm is careful not to look at cg_info!
283
284         ; (pcs_simpl, tidy_details) 
285              <- _scc_ "CoreTidy"
286                 tidyCorePgm dflags this_mod pcs_middle cg_info simpl_details
287       
288         ; pcs_final <- if ghci_mode == OneShot then initPersistentCompilerState
289                                                else return pcs_simpl
290
291         -- alive at this point:  
292         --      tidy_details
293         --      new_iface               
294
295             -------------------
296             -- PREPARE FOR CODE GENERATION
297             -------------------
298               -- Do saturation and convert to A-normal form
299         ; prepd_details <- _scc_ "CorePrep" corePrepPgm dflags tidy_details
300
301             -------------------
302             -- CONVERT TO STG and COMPLETE CODE GENERATION
303             -------------------
304         ; let
305             ModDetails{md_binds=binds, md_types=env_tc} = prepd_details
306
307             local_tycons     = typeEnvTyCons  env_tc
308             local_classes    = typeEnvClasses env_tc
309
310             imported_module_names = map ideclName (hsModuleImports rdr_module)
311
312             mod_name_to_Module nm
313                  = do m <- findModule nm ; return (fst (fromJust m))
314
315             (h_code,c_code,fe_binders) = foreign_stuff
316
317         ; imported_modules <- mapM mod_name_to_Module imported_module_names
318
319         ; (stub_h_exists, stub_c_exists, maybe_bcos, final_iface )
320            <- if toInterp
321                 then do 
322                     -----------------  Generate byte code ------------------
323                     (bcos,itbl_env) <- byteCodeGen dflags binds 
324                                         local_tycons local_classes
325
326                     -- Fill in the code-gen info
327                     writeIORef cg_info_ref (Just emptyNameEnv)
328
329                     ------------------ BUILD THE NEW ModIface ------------
330                     final_iface <- _scc_ "MkFinalIface" 
331                           mkFinalIface ghci_mode dflags location 
332                                    maybe_checked_iface new_iface tidy_details
333
334                     return ( False, False, Just (bcos,itbl_env), final_iface )
335
336                 else do
337                     -----------------  Convert to STG ------------------
338                     (stg_binds, cost_centre_info, stg_back_end_info) 
339                               <- _scc_ "CoreToStg"
340                                   myCoreToStg dflags this_mod binds
341                     
342                     -- Fill in the code-gen info for the earlier tidyCorePgm
343                     writeIORef cg_info_ref (Just stg_back_end_info)
344
345                     ------------------ BUILD THE NEW ModIface ------------
346                     final_iface <- _scc_ "MkFinalIface" 
347                           mkFinalIface ghci_mode dflags location 
348                                    maybe_checked_iface new_iface tidy_details
349
350                     ------------------  Code generation ------------------
351                     abstractC <- _scc_ "CodeGen"
352                                   codeGen dflags this_mod imported_modules
353                                          cost_centre_info fe_binders
354                                          local_tycons stg_binds
355                     
356                     ------------------  Code output -----------------------
357                     (stub_h_exists, stub_c_exists)
358                        <- codeOutput dflags this_mod local_tycons
359                              binds stg_binds
360                              c_code h_code abstractC
361                         
362                     return (stub_h_exists, stub_c_exists, Nothing, final_iface)
363
364         ; let final_details = tidy_details {md_binds = []} 
365
366
367           -- and the answer is ...
368         ; return (HscRecomp pcs_final
369                             final_details
370                             final_iface
371                             stub_h_exists stub_c_exists
372                             maybe_bcos)
373           }}}}}}}
374
375 myParseModule dflags src_filename
376  = do --------------------------  Parser  ----------------
377       showPass dflags "Parser"
378       _scc_  "Parser" do
379
380       buf <- hGetStringBuffer True{-expand tabs-} src_filename
381
382       let glaexts | dopt Opt_GlasgowExts dflags = 1#
383                   | otherwise                   = 0#
384
385       case parseModule buf PState{ bol = 0#, atbol = 1#,
386                                    context = [], glasgow_exts = glaexts,
387                                    loc = mkSrcLoc (_PK_ src_filename) 1 } of {
388
389         PFailed err -> do { hPutStrLn stderr (showSDoc err);
390                             freeStringBuffer buf;
391                             return Nothing };
392
393         POk _ rdr_module@(HsModule mod_name _ _ _ _ _ _) -> do {
394
395       dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr rdr_module) ;
396       
397       dumpIfSet_dyn dflags Opt_D_source_stats "Source Statistics"
398                            (ppSourceStats False rdr_module) ;
399       
400       return (Just rdr_module)
401         -- ToDo: free the string buffer later.
402       }}
403
404
405 myCoreToStg dflags this_mod tidy_binds
406  = do 
407       () <- coreBindsSize tidy_binds `seq` return ()
408       -- TEMP: the above call zaps some space usage allocated by the
409       -- simplifier, which for reasons I don't understand, persists
410       -- thoroughout code generation
411
412       stg_binds <- _scc_ "Core2Stg" coreToStg dflags tidy_binds
413
414       (stg_binds2, cost_centre_info)
415            <- _scc_ "Core2Stg" stg2stg dflags this_mod stg_binds
416
417       let env_rhs :: CgInfoEnv
418           env_rhs = mkNameEnv [ (idName bndr, CgInfo (stgRhsArity rhs) caf_info)
419                               | (bind,_) <- stg_binds2, 
420                                 let caf_info 
421                                      | stgBindHasCafRefs bind = MayHaveCafRefs
422                                      | otherwise = NoCafRefs,
423                                 (bndr,rhs) <- stgBindPairs bind ]
424
425       return (stg_binds2, cost_centre_info, env_rhs)
426    where
427       stgBindPairs (StgNonRec _ b r) = [(b,r)]
428       stgBindPairs (StgRec    _ prs) = prs
429 \end{code}
430
431
432 %************************************************************************
433 %*                                                                      *
434 \subsection{Compiling a do-statement}
435 %*                                                                      *
436 %************************************************************************
437
438 \begin{code}
439 #ifdef GHCI
440 hscStmt
441   :: DynFlags
442   -> HomeSymbolTable    
443   -> HomeIfaceTable
444   -> PersistentCompilerState    -- IN: persistent compiler state
445   -> InteractiveContext         -- Context for compiling
446   -> String                     -- The statement
447   -> Bool                       -- just treat it as an expression
448   -> IO ( PersistentCompilerState, 
449           Maybe ( [Id], 
450                   Type, 
451                   UnlinkedBCOExpr) )
452 \end{code}
453
454 When the UnlinkedBCOExpr is linked you get an HValue of type
455         IO [HValue]
456 When you run it you get a list of HValues that should be 
457 the same length as the list of names; add them to the ClosureEnv.
458
459 A naked expression returns a singleton Name [it].
460
461         What you type                   The IO [HValue] that hscStmt returns
462         -------------                   ------------------------------------
463         let pat = expr          ==>     let pat = expr in return [coerce HVal x, coerce HVal y, ...]
464                                         bindings: [x,y,...]
465
466         pat <- expr             ==>     expr >>= \ pat -> return [coerce HVal x, coerce HVal y, ...]
467                                         bindings: [x,y,...]
468
469         expr (of IO type)       ==>     expr >>= \ v -> return [v]
470           [NB: result not printed]      bindings: [it]
471           
472
473         expr (of non-IO type, 
474           result showable)      ==>     let v = expr in print v >> return [v]
475                                         bindings: [it]
476
477         expr (of non-IO type, 
478           result not showable)  ==>     error
479
480 \begin{code}
481 hscStmt dflags hst hit pcs0 icontext stmt just_expr
482    = let 
483         InteractiveContext { 
484              ic_rn_env   = rn_env, 
485              ic_type_env = type_env,
486              ic_module   = scope_mod } = icontext
487      in
488      do { maybe_stmt <- hscParseStmt dflags stmt
489         ; case maybe_stmt of
490              Nothing -> return (pcs0, Nothing)
491              Just parsed_stmt -> do {
492
493            let { notExprStmt (ExprStmt _ _) = False;
494                  notExprStmt _              = True 
495                };
496
497            if (just_expr && notExprStmt parsed_stmt)
498                 then do hPutStrLn stderr ("not an expression: `" ++ stmt ++ "'")
499                         return (pcs0, Nothing)
500                 else do {
501
502                 -- Rename it
503           (pcs1, print_unqual, maybe_renamed_stmt)
504                  <- renameStmt dflags hit hst pcs0 scope_mod 
505                                 iNTERACTIVE rn_env parsed_stmt
506
507         ; case maybe_renamed_stmt of
508                 Nothing -> return (pcs0, Nothing)
509                 Just (bound_names, rn_stmt) -> do {
510
511                 -- Typecheck it
512           maybe_tc_return <- 
513             if just_expr 
514                 then case rn_stmt of { (syn, ExprStmt e _, decls) -> 
515                      typecheckExpr dflags pcs1 hst type_env
516                            print_unqual iNTERACTIVE (syn,e,decls) }
517                 else typecheckStmt dflags pcs1 hst type_env
518                            print_unqual iNTERACTIVE bound_names rn_stmt
519
520         ; case maybe_tc_return of
521                 Nothing -> return (pcs0, Nothing)
522                 Just (pcs2, tc_expr, bound_ids, ty) ->  do {
523
524                 -- Desugar it
525           ds_expr <- deSugarExpr dflags pcs2 hst iNTERACTIVE print_unqual tc_expr
526         
527                 -- Simplify it
528         ; simpl_expr <- simplifyExpr dflags pcs2 hst ds_expr
529
530                 -- Tidy it (temporary, until coreSat does cloning)
531         ; tidy_expr <- tidyCoreExpr simpl_expr
532
533                 -- Prepare for codegen
534         ; prepd_expr <- corePrepExpr dflags tidy_expr
535
536                 -- Convert to BCOs
537         ; bcos <- coreExprToBCOs dflags prepd_expr
538
539         ; let
540                 -- Make all the bound ids "global" ids, now that
541                 -- they're notionally top-level bindings.  This is
542                 -- important: otherwise when we come to compile an expression
543                 -- using these ids later, the byte code generator will consider
544                 -- the occurrences to be free rather than global.
545              global_bound_ids = map globaliseId bound_ids;
546              globaliseId id   = setGlobalIdDetails id VanillaGlobal
547
548         ; return (pcs2, Just (global_bound_ids, ty, bcos))
549
550      }}}}}
551
552 hscParseStmt :: DynFlags -> String -> IO (Maybe RdrNameStmt)
553 hscParseStmt dflags str
554  = do --------------------------  Parser  ----------------
555       showPass dflags "Parser"
556       _scc_ "Parser" do
557
558       buf <- stringToStringBuffer str
559
560       let glaexts | dopt Opt_GlasgowExts dflags = 1#
561                   | otherwise                   = 0#
562
563       case parseStmt buf PState{ bol = 0#, atbol = 1#,
564                                  context = [], glasgow_exts = glaexts,
565                                  loc = mkSrcLoc SLIT("<no file>") 0 } of {
566
567         PFailed err -> do { hPutStrLn stderr (showSDoc err);
568 --      Not yet implemented in <4.11    freeStringBuffer buf;
569                             return Nothing };
570
571         -- no stmt: the line consisted of just space or comments
572         POk _ Nothing -> return Nothing;
573
574         POk _ (Just rdr_stmt) -> do {
575
576       --ToDo: can't free the string buffer until we've finished this
577       -- compilation sweep and all the identifiers have gone away.
578       --freeStringBuffer buf;
579       dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr rdr_stmt);
580       return (Just rdr_stmt)
581       }}
582 #endif
583 \end{code}
584
585 %************************************************************************
586 %*                                                                      *
587 \subsection{Initial persistent state}
588 %*                                                                      *
589 %************************************************************************
590
591 \begin{code}
592 initPersistentCompilerState :: IO PersistentCompilerState
593 initPersistentCompilerState 
594   = do prs <- initPersistentRenamerState
595        return (
596         PCS { pcs_PIT   = emptyIfaceTable,
597               pcs_PTE   = wiredInThingEnv,
598               pcs_insts = emptyInstEnv,
599               pcs_rules = emptyRuleBase,
600               pcs_PRS   = prs
601             }
602         )
603
604 initPersistentRenamerState :: IO PersistentRenamerState
605   = do us <- mkSplitUniqSupply 'r'
606        return (
607         PRS { prsOrig  = NameSupply { nsUniqs = us,
608                                       nsNames = initOrigNames,
609                                       nsIPs   = emptyFM },
610               prsDecls   = (emptyNameEnv, 0),
611               prsInsts   = (emptyBag, 0),
612               prsRules   = (emptyBag, 0),
613               prsImpMods = emptyFM
614             }
615         )
616
617 initOrigNames :: FiniteMap (ModuleName,OccName) Name
618 initOrigNames 
619    = grab knownKeyNames `plusFM` grab (map getName wiredInThings)
620      where
621         grab names = foldl add emptyFM names
622         add env name 
623            = addToFM env (moduleName (nameModule name), nameOccName name) name
624
625
626 initRules :: PackageRuleBase
627 initRules = emptyRuleBase
628 {- SHOULD BE (ish)
629             foldl add emptyVarEnv builtinRules
630           where
631             add env (name,rule) 
632               = extendRuleBase env name rule
633 -}
634 \end{code}