2 % (c) The GRASP/AQUA Project, Glasgow University, 1993-2000
5 \section[GHC_Main]{Main driver for Glasgow Haskell compiler}
9 ( newHscEnv, hscCmmFile
13 , hscStmt, hscTcExpr, hscKcType
16 , hscCompileOneShot -- :: Compiler HscStatus
17 , hscCompileBatch -- :: Compiler (HscStatus, ModIface, ModDetails)
18 , hscCompileNothing -- :: Compiler (HscStatus, ModIface, ModDetails)
19 , hscCompileInteractive -- :: Compiler (InteractiveStatus, ModIface, ModDetails)
21 , InteractiveStatus (..)
25 #include "HsVersions.h"
28 import HsSyn ( Stmt(..), LStmt, LHsType )
29 import CodeOutput ( outputForeignStubs )
30 import ByteCodeGen ( byteCodeGen, coreExprToBCOs )
31 import Linker ( HValue, linkExpr )
32 import CoreTidy ( tidyExpr )
33 import CorePrep ( corePrepExpr )
34 import Flattening ( flattenExpr )
35 import Desugar ( deSugarExpr )
36 import SimplCore ( simplifyExpr )
37 import TcRnDriver ( tcRnStmt, tcRnExpr, tcRnType )
39 import PrelNames ( iNTERACTIVE )
40 import {- Kind parts of -} Type ( Kind )
41 import CoreLint ( lintUnfolding )
42 import DsMeta ( templateHaskellNames )
43 import SrcLoc ( SrcSpan, noSrcLoc, interactiveSrcLoc, srcLocSpan )
45 import VarEnv ( emptyTidyEnv )
49 import Module ( emptyModuleEnv, ModLocation(..), Module )
50 import RdrName ( GlobalRdrEnv, RdrName, emptyGlobalRdrEnv )
51 import HsSyn ( HsModule, LHsBinds, HsGroup, LIE, LImportDecl, HsDoc,
54 import SrcLoc ( Located(..) )
58 import SrcLoc ( mkSrcLoc )
59 import TcRnDriver ( tcRnModule, tcRnExtCore )
60 import TcIface ( typecheckIface )
61 import TcRnMonad ( initIfaceCheck, TcGblEnv(..) )
62 import IfaceEnv ( initNameCache )
63 import LoadIface ( ifaceStats, initExternalPackageState )
64 import PrelInfo ( wiredInThings, basicKnownKeyNames )
65 import MkIface ( checkOldIface, mkIface, writeIfaceFile )
66 import Desugar ( deSugar )
67 import SimplCore ( core2core )
68 import TidyPgm ( tidyProgram, mkBootModDetails )
69 import CorePrep ( corePrepPgm )
70 import CoreToStg ( coreToStg )
73 import TyCon ( isDataTyCon )
74 import Name ( Name, NamedThing(..) )
75 import SimplStg ( stg2stg )
76 import CodeGen ( codeGen )
78 import CmmParse ( parseCmmFile )
85 import CodeOutput ( codeOutput )
86 import NameEnv ( emptyNameEnv )
90 import UniqSupply ( mkSplitUniqSupply )
93 import HscStats ( ppSourceStats )
95 import MkExternalCore ( emitExternalCore )
97 import ParserCoreUtils
99 import UniqFM ( emptyUFM )
100 import UniqSupply ( initUs_ )
101 import Bag ( unitBag )
110 %************************************************************************
114 %************************************************************************
117 newHscEnv :: DynFlags -> IO HscEnv
119 = do { eps_var <- newIORef initExternalPackageState
120 ; us <- mkSplitUniqSupply 'r'
121 ; nc_var <- newIORef (initNameCache us knownKeyNames)
122 ; fc_var <- newIORef emptyUFM
123 ; mlc_var <- newIORef emptyModuleEnv
124 ; return (HscEnv { hsc_dflags = dflags,
127 hsc_IC = emptyInteractiveContext,
128 hsc_HPT = emptyHomePackageTable,
133 hsc_global_rdr_env = emptyGlobalRdrEnv,
134 hsc_global_type_env = emptyNameEnv } ) }
137 knownKeyNames :: [Name] -- Put here to avoid loops involving DsMeta,
138 -- where templateHaskellNames are defined
139 knownKeyNames = map getName wiredInThings
140 ++ basicKnownKeyNames
142 ++ templateHaskellNames
147 %************************************************************************
149 The main compiler pipeline
151 %************************************************************************
153 --------------------------------
154 The compilation proper
155 --------------------------------
158 It's the task of the compilation proper to compile Haskell, hs-boot and
159 core files to either byte-code, hard-code (C, asm, Java, ect) or to
160 nothing at all (the module is still parsed and type-checked. This
161 feature is mostly used by IDE's and the likes).
162 Compilation can happen in either 'one-shot', 'batch', 'nothing',
163 or 'interactive' mode. 'One-shot' mode targets hard-code, 'batch' mode
164 targets hard-code, 'nothing' mode targets nothing and 'interactive' mode
166 The modes are kept separate because of their different types and meanings.
167 In 'one-shot' mode, we're only compiling a single file and can therefore
168 discard the new ModIface and ModDetails. This is also the reason it only
169 targets hard-code; compiling to byte-code or nothing doesn't make sense
170 when we discard the result.
171 'Batch' mode is like 'one-shot' except that we keep the resulting ModIface
172 and ModDetails. 'Batch' mode doesn't target byte-code since that require
173 us to return the newly compiled byte-code.
174 'Nothing' mode has exactly the same type as 'batch' mode but they're still
175 kept separate. This is because compiling to nothing is fairly special: We
176 don't output any interface files, we don't run the simplifier and we don't
178 'Interactive' mode is similar to 'batch' mode except that we return the
179 compiled byte-code together with the ModIface and ModDetails.
181 Trying to compile a hs-boot file to byte-code will result in a run-time
182 error. This is the only thing that isn't caught by the type-system.
189 (Located (HsModule RdrName))
191 (Maybe (HsGroup Name, [LImportDecl Name], Maybe [LIE Name],
192 Maybe (HsDoc Name), HaddockModInfo Name))
194 (Maybe (LHsBinds Id, GlobalRdrEnv, ModDetails))
198 -- Status of a compilation to hard-code or nothing.
201 | HscRecomp Bool -- Has stub files.
202 -- This is a hack. We can't compile C files here
203 -- since it's done in DriverPipeline. For now we
204 -- just return True if we want the caller to compile
207 -- Status of a compilation to byte-code.
208 data InteractiveStatus
209 = InteractiveNoRecomp
210 | InteractiveRecomp Bool -- Same as HscStatus
215 -- I want Control.Monad.State! --Lemmih 03/07/2006
216 newtype Comp a = Comp {runComp :: CompState -> IO (a, CompState)}
218 instance Monad Comp where
219 g >>= fn = Comp $ \s -> runComp g s >>= \(a,s') -> runComp (fn a) s'
220 return a = Comp $ \s -> return (a,s)
223 evalComp :: Comp a -> CompState -> IO a
224 evalComp comp st = do (val,_st') <- runComp comp st
229 { compHscEnv :: HscEnv
230 , compModSummary :: ModSummary
231 , compOldIface :: Maybe ModIface
234 get :: Comp CompState
235 get = Comp $ \s -> return (s,s)
237 modify :: (CompState -> CompState) -> Comp ()
238 modify f = Comp $ \s -> return ((), f s)
240 gets :: (CompState -> a) -> Comp a
241 gets getter = do st <- get
244 liftIO :: IO a -> Comp a
245 liftIO ioA = Comp $ \s -> do a <- ioA
248 type NoRecomp result = ModIface -> Comp result
250 -- FIXME: The old interface and module index are only using in 'batch' and
251 -- 'interactive' mode. They should be removed from 'oneshot' mode.
252 type Compiler result = HscEnv
254 -> Bool -- True <=> source unchanged
255 -> Maybe ModIface -- Old interface, if available
256 -> Maybe (Int,Int) -- Just (i,n) <=> module i of n (for msgs)
260 -- This functions checks if recompilation is necessary and
261 -- then combines the FrontEnd and BackEnd to a working compiler.
262 hscMkCompiler :: NoRecomp result -- What to do when recompilation isn't required.
263 -> (Maybe (Int,Int) -> Bool -> Comp ())
264 -> Comp (Maybe ModGuts) -- Front end
265 -> (ModGuts -> Comp result) -- Backend.
267 hscMkCompiler norecomp messenger frontend backend
268 hsc_env mod_summary source_unchanged
269 mbOldIface mbModIndex
270 = flip evalComp (CompState hsc_env mod_summary mbOldIface) $
271 do (recomp_reqd, mbCheckedIface)
272 <- {-# SCC "checkOldIface" #-}
273 liftIO $ checkOldIface hsc_env mod_summary
274 source_unchanged mbOldIface
275 -- save the interface that comes back from checkOldIface.
276 -- In one-shot mode we don't have the old iface until this
277 -- point, when checkOldIface reads it from the disk.
278 modify (\s -> s{ compOldIface = mbCheckedIface })
279 case mbCheckedIface of
280 Just iface | not recomp_reqd
281 -> do messenger mbModIndex False
282 result <- norecomp iface
285 -> do messenger mbModIndex True
291 -> do result <- backend core
294 --------------------------------------------------------------
296 --------------------------------------------------------------
298 -- Compile Haskell, boot and extCore in OneShot mode.
299 hscCompileOneShot :: Compiler HscStatus
301 = hscCompiler norecompOneShot oneShotMsg backend boot_backend
303 backend inp = hscSimplify inp >>= hscNormalIface >>= hscWriteIface >>= hscOneShot
304 boot_backend inp = hscSimpleIface inp >>= hscWriteIface >> return (HscRecomp False)
306 -- Compile Haskell, boot and extCore in batch mode.
307 hscCompileBatch :: Compiler (HscStatus, ModIface, ModDetails)
309 = hscCompiler norecompBatch batchMsg backend boot_backend
311 backend inp = hscSimplify inp >>= hscNormalIface >>= hscWriteIface >>= hscBatch
312 boot_backend inp = hscSimpleIface inp >>= hscWriteIface >>= hscNothing
314 -- Type-check Haskell, boot and extCore.
315 -- Does it make sense to compile extCore to nothing?
316 hscCompileNothing :: Compiler (HscStatus, ModIface, ModDetails)
318 = hscCompiler norecompBatch batchMsg backend backend
320 backend inp = hscSimpleIface inp >>= hscIgnoreIface >>= hscNothing
322 -- Compile Haskell, extCore to bytecode.
323 hscCompileInteractive :: Compiler (InteractiveStatus, ModIface, ModDetails)
324 hscCompileInteractive
325 = hscCompiler norecompInteractive batchMsg backend boot_backend
327 backend inp = hscSimplify inp >>= hscNormalIface >>= hscIgnoreIface >>= hscInteractive
328 boot_backend = panic "hscCompileInteractive: can't do boot files here"
331 :: NoRecomp result -- No recomp necessary
332 -> (Maybe (Int,Int) -> Bool -> Comp ()) -- Message callback
333 -> (ModGuts -> Comp result) -- Compile normal file
334 -> (ModGuts -> Comp result) -- Compile boot file
336 hscCompiler norecomp msg nonBootComp bootComp hsc_env mod_summary =
337 hscMkCompiler norecomp msg frontend backend hsc_env mod_summary
340 = case ms_hsc_src mod_summary of
341 ExtCoreFile -> (hscCoreFrontEnd, nonBootComp)
342 HsSrcFile -> (hscFileFrontEnd, nonBootComp)
343 HsBootFile -> (hscFileFrontEnd, bootComp)
345 --------------------------------------------------------------
347 --------------------------------------------------------------
349 norecompOneShot :: NoRecomp HscStatus
350 norecompOneShot _old_iface
351 = do hsc_env <- gets compHscEnv
353 dumpIfaceStats hsc_env
356 norecompBatch :: NoRecomp (HscStatus, ModIface, ModDetails)
357 norecompBatch = norecompWorker HscNoRecomp False
359 norecompInteractive :: NoRecomp (InteractiveStatus, ModIface, ModDetails)
360 norecompInteractive = norecompWorker InteractiveNoRecomp True
362 norecompWorker :: a -> Bool -> NoRecomp (a, ModIface, ModDetails)
363 norecompWorker a _isInterp old_iface
364 = do hsc_env <- gets compHscEnv
365 _mod_summary <- gets compModSummary
367 new_details <- {-# SCC "tcRnIface" #-}
368 initIfaceCheck hsc_env $
369 typecheckIface old_iface
370 dumpIfaceStats hsc_env
371 return (a, old_iface, new_details)
373 --------------------------------------------------------------
374 -- Progress displayers.
375 --------------------------------------------------------------
377 oneShotMsg :: Maybe (Int,Int) -> Bool -> Comp ()
378 oneShotMsg _mb_mod_index recomp
379 = do hsc_env <- gets compHscEnv
383 else compilationProgressMsg (hsc_dflags hsc_env) $
384 "compilation IS NOT required"
386 batchMsg :: Maybe (Int,Int) -> Bool -> Comp ()
387 batchMsg mb_mod_index recomp
388 = do hsc_env <- gets compHscEnv
389 mod_summary <- gets compModSummary
390 let showMsg msg = compilationProgressMsg (hsc_dflags hsc_env) $
391 (showModuleIndex mb_mod_index ++
392 msg ++ showModMsg (hscTarget (hsc_dflags hsc_env)) recomp mod_summary)
395 then showMsg "Compiling "
396 else if verbosity (hsc_dflags hsc_env) >= 2
397 then showMsg "Skipping "
400 --------------------------------------------------------------
402 --------------------------------------------------------------
404 hscCoreFrontEnd :: Comp (Maybe ModGuts)
406 do hsc_env <- gets compHscEnv
407 mod_summary <- gets compModSummary
412 inp <- readFile (ms_hspp_file mod_summary)
413 case parseCore inp 1 of
415 -> do errorMsg (hsc_dflags hsc_env) (text s{-ToDo: wrong-})
419 -- RENAME and TYPECHECK
421 -> do (tc_msgs, maybe_tc_result) <- {-# SCC "TypeCheck" #-}
422 tcRnExtCore hsc_env rdr_module
423 printErrorsAndWarnings (hsc_dflags hsc_env) tc_msgs
424 case maybe_tc_result of
425 Nothing -> return Nothing
426 Just mod_guts -> return (Just mod_guts) -- No desugaring to do!
429 hscFileFrontEnd :: Comp (Maybe ModGuts)
431 do hsc_env <- gets compHscEnv
432 mod_summary <- gets compModSummary
437 let dflags = hsc_dflags hsc_env
438 hspp_file = ms_hspp_file mod_summary
439 hspp_buf = ms_hspp_buf mod_summary
440 maybe_parsed <- myParseModule dflags hspp_file hspp_buf
443 -> do printBagOfErrors dflags (unitBag err)
447 -- RENAME and TYPECHECK
449 -> do (tc_msgs, maybe_tc_result)
450 <- {-# SCC "Typecheck-Rename" #-}
451 tcRnModule hsc_env (ms_hsc_src mod_summary) False rdr_module
452 printErrorsAndWarnings dflags tc_msgs
453 case maybe_tc_result of
460 -> {-# SCC "DeSugar" #-} deSugar hsc_env (ms_location mod_summary) tc_result
462 --------------------------------------------------------------
464 --------------------------------------------------------------
466 hscSimplify :: ModGuts -> Comp ModGuts
467 hscSimplify ds_result
468 = do hsc_env <- gets compHscEnv
473 simpl_result <- {-# SCC "Core2Core" #-}
474 core2core hsc_env ds_result
477 --------------------------------------------------------------
478 -- Interface generators
479 --------------------------------------------------------------
481 -- HACK: we return ModGuts even though we know it's not gonna be used.
482 -- We do this because the type signature needs to be identical
483 -- in structure to the type of 'hscNormalIface'.
484 hscSimpleIface :: ModGuts -> Comp (ModIface, Bool, ModDetails, ModGuts)
485 hscSimpleIface ds_result
486 = do hsc_env <- gets compHscEnv
487 _mod_summary <- gets compModSummary
488 maybe_old_iface <- gets compOldIface
490 details <- mkBootModDetails hsc_env ds_result
491 (new_iface, no_change)
492 <- {-# SCC "MkFinalIface" #-}
493 mkIface hsc_env maybe_old_iface ds_result details
494 -- And the answer is ...
495 dumpIfaceStats hsc_env
496 return (new_iface, no_change, details, ds_result)
498 hscNormalIface :: ModGuts -> Comp (ModIface, Bool, ModDetails, CgGuts)
499 hscNormalIface simpl_result
500 = do hsc_env <- gets compHscEnv
501 _mod_summary <- gets compModSummary
502 maybe_old_iface <- gets compOldIface
507 (cg_guts, details) <- {-# SCC "CoreTidy" #-}
508 tidyProgram hsc_env simpl_result
511 -- BUILD THE NEW ModIface and ModDetails
512 -- and emit external core if necessary
513 -- This has to happen *after* code gen so that the back-end
514 -- info has been set. Not yet clear if it matters waiting
515 -- until after code output
516 (new_iface, no_change)
517 <- {-# SCC "MkFinalIface" #-}
518 mkIface hsc_env maybe_old_iface simpl_result details
519 -- Emit external core
520 emitExternalCore (hsc_dflags hsc_env) (availsToNameSet (mg_exports simpl_result)) cg_guts -- Move this? --Lemmih 03/07/2006
521 dumpIfaceStats hsc_env
524 -- Return the prepared code.
525 return (new_iface, no_change, details, cg_guts)
527 --------------------------------------------------------------
528 -- BackEnd combinators
529 --------------------------------------------------------------
531 hscWriteIface :: (ModIface, Bool, ModDetails, a) -> Comp (ModIface, ModDetails, a)
532 hscWriteIface (iface, no_change, details, a)
533 = do mod_summary <- gets compModSummary
534 hsc_env <- gets compHscEnv
535 let dflags = hsc_dflags hsc_env
538 $ writeIfaceFile dflags (ms_location mod_summary) iface
539 return (iface, details, a)
541 hscIgnoreIface :: (ModIface, Bool, ModDetails, a) -> Comp (ModIface, ModDetails, a)
542 hscIgnoreIface (iface, _no_change, details, a)
543 = return (iface, details, a)
545 -- Don't output any code.
546 hscNothing :: (ModIface, ModDetails, a) -> Comp (HscStatus, ModIface, ModDetails)
547 hscNothing (iface, details, _)
548 = return (HscRecomp False, iface, details)
550 -- Generate code and return both the new ModIface and the ModDetails.
551 hscBatch :: (ModIface, ModDetails, CgGuts) -> Comp (HscStatus, ModIface, ModDetails)
552 hscBatch (iface, details, cgguts)
553 = do hasStub <- hscCompile cgguts
554 return (HscRecomp hasStub, iface, details)
556 -- Here we don't need the ModIface and ModDetails anymore.
557 hscOneShot :: (ModIface, ModDetails, CgGuts) -> Comp HscStatus
558 hscOneShot (_, _, cgguts)
559 = do hasStub <- hscCompile cgguts
560 return (HscRecomp hasStub)
562 -- Compile to hard-code.
563 hscCompile :: CgGuts -> Comp Bool
565 = do hsc_env <- gets compHscEnv
566 mod_summary <- gets compModSummary
568 let CgGuts{ -- This is the last use of the ModGuts in a compilation.
569 -- From now on, we just use the bits we need.
570 cg_module = this_mod,
571 cg_binds = core_binds,
573 cg_dir_imps = dir_imps,
574 cg_foreign = foreign_stubs,
575 cg_dep_pkgs = dependencies,
576 cg_hpc_info = hpc_info } = cgguts
577 dflags = hsc_dflags hsc_env
578 location = ms_location mod_summary
579 data_tycons = filter isDataTyCon tycons
580 -- cg_tycons includes newtypes, for the benefit of External Core,
581 -- but we don't generate any code for newtypes
584 -- PREPARE FOR CODE GENERATION
585 -- Do saturation and convert to A-normal form
586 prepd_binds <- {-# SCC "CorePrep" #-}
587 corePrepPgm dflags core_binds data_tycons ;
588 ----------------- Convert to STG ------------------
589 (stg_binds, cost_centre_info)
590 <- {-# SCC "CoreToStg" #-}
591 myCoreToStg dflags this_mod prepd_binds
592 ------------------ Code generation ------------------
593 cmms <- {-# SCC "CodeGen" #-}
594 codeGen dflags this_mod data_tycons
595 dir_imps cost_centre_info
597 --- Optionally run experimental Cmm transformations ---
598 cmms <- optionallyConvertAndOrCPS dflags cmms
599 -- ^ unless certain dflags are on, the identity function
600 ------------------ Code output -----------------------
601 rawcmms <- cmmToRawCmm cmms
602 (_stub_h_exists, stub_c_exists)
603 <- codeOutput dflags this_mod location foreign_stubs
607 hscInteractive :: (ModIface, ModDetails, CgGuts)
608 -> Comp (InteractiveStatus, ModIface, ModDetails)
610 hscInteractive (iface, details, cgguts)
611 = do hsc_env <- gets compHscEnv
612 mod_summary <- gets compModSummary
614 let CgGuts{ -- This is the last use of the ModGuts in a compilation.
615 -- From now on, we just use the bits we need.
616 cg_module = this_mod,
617 cg_binds = core_binds,
619 cg_foreign = foreign_stubs,
620 cg_modBreaks = mod_breaks } = cgguts
621 dflags = hsc_dflags hsc_env
622 location = ms_location mod_summary
623 data_tycons = filter isDataTyCon tycons
624 -- cg_tycons includes newtypes, for the benefit of External Core,
625 -- but we don't generate any code for newtypes
628 -- PREPARE FOR CODE GENERATION
629 -- Do saturation and convert to A-normal form
630 prepd_binds <- {-# SCC "CorePrep" #-}
631 corePrepPgm dflags core_binds data_tycons ;
632 ----------------- Generate byte code ------------------
633 comp_bc <- byteCodeGen dflags prepd_binds data_tycons mod_breaks
634 ------------------ Create f-x-dynamic C-side stuff ---
635 (_istub_h_exists, istub_c_exists)
636 <- outputForeignStubs dflags this_mod location foreign_stubs
637 return (InteractiveRecomp istub_c_exists comp_bc mod_breaks, iface, details)
639 hscInteractive _ = panic "GHC not compiled with interpreter"
642 ------------------------------
644 hscFileCheck :: HscEnv -> ModSummary -> Bool -> IO (Maybe HscChecked)
645 hscFileCheck hsc_env mod_summary compileToCore = do {
649 ; let dflags = hsc_dflags hsc_env
650 hspp_file = ms_hspp_file mod_summary
651 hspp_buf = ms_hspp_buf mod_summary
653 ; maybe_parsed <- myParseModule dflags hspp_file hspp_buf
655 ; case maybe_parsed of {
656 Left err -> do { printBagOfErrors dflags (unitBag err)
658 Right rdr_module -> do {
661 -- RENAME and TYPECHECK
663 (tc_msgs, maybe_tc_result)
664 <- {-# SCC "Typecheck-Rename" #-}
665 tcRnModule hsc_env (ms_hsc_src mod_summary)
666 True{-save renamed syntax-}
669 ; printErrorsAndWarnings dflags tc_msgs
670 ; case maybe_tc_result of {
671 Nothing -> return (Just (HscChecked rdr_module Nothing Nothing Nothing));
673 let type_env = tcg_type_env tc_result
676 md_exports = tcg_exports tc_result,
677 md_insts = tcg_insts tc_result,
678 md_fam_insts = tcg_fam_insts tc_result,
679 md_rules = [panic "no rules"],
680 -- Rules are CoreRules, not the
681 -- RuleDecls we get out of the typechecker
682 md_vect_info = noVectInfo
683 -- VectInfo is added by the Core
684 -- vectorisation pass
686 rnInfo = do decl <- tcg_rn_decls tc_result
687 imports <- tcg_rn_imports tc_result
688 let exports = tcg_rn_exports tc_result
689 let doc = tcg_doc tc_result
690 hmi = tcg_hmi tc_result
691 return (decl,imports,exports,doc,hmi)
693 if compileToCore then
694 deSugar hsc_env (ms_location mod_summary) tc_result
697 return (Just (HscChecked rdr_module
699 (Just (tcg_binds tc_result,
700 tcg_rdr_env tc_result,
702 (fmap mg_binds maybeModGuts)))
706 hscCmmFile :: DynFlags -> FilePath -> IO Bool
707 hscCmmFile dflags filename = do
708 maybe_cmm <- parseCmmFile dflags filename
710 Nothing -> return False
712 cmms <- optionallyConvertAndOrCPS dflags [cmm]
713 rawCmms <- cmmToRawCmm cmms
714 codeOutput dflags no_mod no_loc NoStubs [] rawCmms
717 no_mod = panic "hscCmmFile: no_mod"
718 no_loc = ModLocation{ ml_hs_file = Just filename,
719 ml_hi_file = panic "hscCmmFile: no hi file",
720 ml_obj_file = panic "hscCmmFile: no obj file" }
722 optionallyConvertAndOrCPS :: DynFlags -> [Cmm] -> IO [Cmm]
723 optionallyConvertAndOrCPS dflags cmms =
724 do -------- Optionally convert to and from zipper ------
725 cmms <- if dopt Opt_ConvertToZipCfgAndBack dflags
726 then mapM (testCmmConversion dflags) cmms
728 --------- Optionally convert to CPS (MDA) -----------
729 cmms <- if not (dopt Opt_ConvertToZipCfgAndBack dflags) &&
730 dopt Opt_RunCPSZ dflags
731 then cmmCPS dflags cmms
736 testCmmConversion :: DynFlags -> Cmm -> IO Cmm
737 testCmmConversion dflags cmm =
738 do showPass dflags "CmmToCmm"
739 dumpIfSet_dyn dflags Opt_D_dump_cvt_cmm "C-- pre-conversion" (ppr cmm)
740 --continuationC <- cmmCPS dflags abstractC >>= cmmToRawCmm
741 us <- mkSplitUniqSupply 'C'
742 let cfopts = runTx $ runCmmOpts cmmCfgOptsZ
743 let cvtm = do g <- cmmToZgraph cmm
745 let zgraph = initUs_ us cvtm
746 cps_zgraph <- protoCmmCPSZ dflags zgraph
747 let chosen_graph = if dopt Opt_RunCPSZ dflags then cps_zgraph else zgraph
748 dumpIfSet_dyn dflags Opt_D_dump_cmmz "C-- Zipper Graph" (ppr chosen_graph)
749 showPass dflags "Convert from Z back to Cmm"
750 let cvt = cmmOfZgraph $ cfopts $ chosen_graph
751 dumpIfSet_dyn dflags Opt_D_dump_cvt_cmm "C-- post-conversion" (ppr cvt)
753 -- return cmm -- don't use the conversion
755 myParseModule :: DynFlags -> FilePath -> Maybe StringBuffer
756 -> IO (Either ErrMsg (Located (HsModule RdrName)))
757 myParseModule dflags src_filename maybe_src_buf
758 = -------------------------- Parser ----------------
759 showPass dflags "Parser" >>
760 {-# SCC "Parser" #-} do
762 -- sometimes we already have the buffer in memory, perhaps
763 -- because we needed to parse the imports out of it, or get the
765 buf <- case maybe_src_buf of
767 Nothing -> hGetStringBuffer src_filename
769 let loc = mkSrcLoc (mkFastString src_filename) 1 0
771 case unP parseModule (mkPState buf loc dflags) of {
773 PFailed span err -> return (Left (mkPlainErrMsg span err));
775 POk pst rdr_module -> do {
777 let {ms = getMessages pst};
778 printErrorsAndWarnings dflags ms;
779 when (errorsFound dflags ms) $ exitWith (ExitFailure 1);
781 dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr rdr_module) ;
783 dumpIfSet_dyn dflags Opt_D_source_stats "Source Statistics"
784 (ppSourceStats False rdr_module) ;
786 return (Right rdr_module)
787 -- ToDo: free the string buffer later.
791 myCoreToStg :: DynFlags -> Module -> [CoreBind]
792 -> IO ( [(StgBinding,[(Id,[Id])])] -- output program
793 , CollectedCCs) -- cost centre info (declared and used)
795 myCoreToStg dflags this_mod prepd_binds
797 stg_binds <- {-# SCC "Core2Stg" #-}
798 coreToStg (thisPackage dflags) prepd_binds
800 (stg_binds2, cost_centre_info) <- {-# SCC "Stg2Stg" #-}
801 stg2stg dflags this_mod stg_binds
803 return (stg_binds2, cost_centre_info)
807 %************************************************************************
809 \subsection{Compiling a do-statement}
811 %************************************************************************
813 When the UnlinkedBCOExpr is linked you get an HValue of type
815 When you run it you get a list of HValues that should be
816 the same length as the list of names; add them to the ClosureEnv.
818 A naked expression returns a singleton Name [it].
820 What you type The IO [HValue] that hscStmt returns
821 ------------- ------------------------------------
822 let pat = expr ==> let pat = expr in return [coerce HVal x, coerce HVal y, ...]
825 pat <- expr ==> expr >>= \ pat -> return [coerce HVal x, coerce HVal y, ...]
828 expr (of IO type) ==> expr >>= \ v -> return [v]
829 [NB: result not printed] bindings: [it]
832 expr (of non-IO type,
833 result showable) ==> let v = expr in print v >> return [v]
836 expr (of non-IO type,
837 result not showable) ==> error
841 hscStmt -- Compile a stmt all the way to an HValue, but don't run it
843 -> String -- The statement
844 -> IO (Maybe ([Id], HValue))
847 = do { maybe_stmt <- hscParseStmt (hsc_dflags hsc_env) stmt
848 ; case maybe_stmt of {
849 Nothing -> return Nothing ; -- Parse error
850 Just Nothing -> return Nothing ; -- Empty line
851 Just (Just parsed_stmt) -> do { -- The real stuff
853 -- Rename and typecheck it
854 let icontext = hsc_IC hsc_env
855 ; maybe_tc_result <- tcRnStmt hsc_env icontext parsed_stmt
857 ; case maybe_tc_result of {
858 Nothing -> return Nothing ;
859 Just (ids, tc_expr) -> do {
862 ; let rdr_env = ic_rn_gbl_env icontext
863 type_env = mkTypeEnv (map AnId (ic_tmp_ids icontext))
864 ; mb_ds_expr <- deSugarExpr hsc_env iNTERACTIVE rdr_env type_env tc_expr
866 ; case mb_ds_expr of {
867 Nothing -> return Nothing ;
870 -- Then desugar, code gen, and link it
871 ; let src_span = srcLocSpan interactiveSrcLoc
872 ; hval <- compileExpr hsc_env src_span ds_expr
874 ; return (Just (ids, hval))
877 hscTcExpr -- Typecheck an expression (but don't run it)
879 -> String -- The expression
882 hscTcExpr hsc_env expr
883 = do { maybe_stmt <- hscParseStmt (hsc_dflags hsc_env) expr
884 ; let icontext = hsc_IC hsc_env
885 ; case maybe_stmt of {
886 Nothing -> return Nothing ; -- Parse error
887 Just (Just (L _ (ExprStmt expr _ _)))
888 -> tcRnExpr hsc_env icontext expr ;
889 Just _ -> do { errorMsg (hsc_dflags hsc_env) (text "not an expression:" <+> quotes (text expr)) ;
893 hscKcType -- Find the kind of a type
895 -> String -- The type
898 hscKcType hsc_env str
899 = do { maybe_type <- hscParseType (hsc_dflags hsc_env) str
900 ; let icontext = hsc_IC hsc_env
901 ; case maybe_type of {
902 Just ty -> tcRnType hsc_env icontext ty ;
903 Nothing -> return Nothing } }
909 hscParseStmt :: DynFlags -> String -> IO (Maybe (Maybe (LStmt RdrName)))
910 hscParseStmt = hscParseThing parseStmt
912 hscParseType :: DynFlags -> String -> IO (Maybe (LHsType RdrName))
913 hscParseType = hscParseThing parseType
916 hscParseIdentifier :: DynFlags -> String -> IO (Maybe (Located RdrName))
917 hscParseIdentifier = hscParseThing parseIdentifier
919 hscParseThing :: Outputable thing
921 -> DynFlags -> String
923 -- Nothing => Parse error (message already printed)
925 hscParseThing parser dflags str
926 = showPass dflags "Parser" >>
927 {-# SCC "Parser" #-} do
929 buf <- stringToStringBuffer str
931 let loc = mkSrcLoc FSLIT("<interactive>") 1 0
933 case unP parser (mkPState buf loc dflags) of {
935 PFailed span err -> do { printError span err;
938 POk pst thing -> do {
940 let {ms = getMessages pst};
941 printErrorsAndWarnings dflags ms;
942 when (errorsFound dflags ms) $ exitWith (ExitFailure 1);
944 --ToDo: can't free the string buffer until we've finished this
945 -- compilation sweep and all the identifiers have gone away.
946 dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr thing);
951 %************************************************************************
953 Desugar, simplify, convert to bytecode, and link an expression
955 %************************************************************************
959 compileExpr :: HscEnv -> SrcSpan -> CoreExpr -> IO HValue
961 compileExpr hsc_env srcspan ds_expr
962 = do { let { dflags = hsc_dflags hsc_env ;
963 lint_on = dopt Opt_DoCoreLinting dflags }
966 ; flat_expr <- flattenExpr hsc_env ds_expr
969 ; simpl_expr <- simplifyExpr dflags flat_expr
971 -- Tidy it (temporary, until coreSat does cloning)
972 ; let tidy_expr = tidyExpr emptyTidyEnv simpl_expr
974 -- Prepare for codegen
975 ; prepd_expr <- corePrepExpr dflags tidy_expr
978 -- ToDo: improve SrcLoc
980 let ictxt = hsc_IC hsc_env
981 tyvars = varSetElems (ic_tyvars ictxt)
983 case lintUnfolding noSrcLoc tyvars prepd_expr of
984 Just err -> pprPanic "compileExpr" err
990 ; bcos <- coreExprToBCOs dflags prepd_expr
993 ; hval <- linkExpr hsc_env srcspan bcos
1001 %************************************************************************
1003 Statistics on reading interfaces
1005 %************************************************************************
1008 dumpIfaceStats :: HscEnv -> IO ()
1009 dumpIfaceStats hsc_env
1010 = do { eps <- readIORef (hsc_EPS hsc_env)
1011 ; dumpIfSet (dump_if_trace || dump_rn_stats)
1012 "Interface statistics"
1015 dflags = hsc_dflags hsc_env
1016 dump_rn_stats = dopt Opt_D_dump_rn_stats dflags
1017 dump_if_trace = dopt Opt_D_dump_if_trace dflags
1020 %************************************************************************
1022 Progress Messages: Module i of n
1024 %************************************************************************
1027 showModuleIndex :: Maybe (Int, Int) -> String
1028 showModuleIndex Nothing = ""
1029 showModuleIndex (Just (i,n)) = "[" ++ padded ++ " of " ++ n_str ++ "] "
1033 padded = replicate (length n_str - length i_str) ' ' ++ i_str