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 ( StmtLR(..), 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)
259 --------------------------------------------------------------
261 --------------------------------------------------------------
263 -- Compile Haskell, boot and extCore in OneShot mode.
264 hscCompileOneShot :: Compiler HscStatus
266 = hscCompiler norecompOneShot oneShotMsg backend boot_backend
268 backend inp = hscSimplify inp >>= hscNormalIface >>= hscWriteIface >>= hscOneShot
269 boot_backend inp = hscSimpleIface inp >>= hscWriteIface >> return (HscRecomp False)
271 -- Compile Haskell, boot and extCore in batch mode.
272 hscCompileBatch :: Compiler (HscStatus, ModIface, ModDetails)
274 = hscCompiler norecompBatch batchMsg backend boot_backend
276 backend inp = hscSimplify inp >>= hscNormalIface >>= hscWriteIface >>= hscBatch
277 boot_backend inp = hscSimpleIface inp >>= hscWriteIface >>= hscNothing
279 -- Type-check Haskell, boot and extCore.
280 -- Does it make sense to compile extCore to nothing?
281 hscCompileNothing :: Compiler (HscStatus, ModIface, ModDetails)
283 = hscCompiler norecompBatch batchMsg backend backend
285 backend inp = hscSimpleIface inp >>= hscIgnoreIface >>= hscNothing
287 -- Compile Haskell, extCore to bytecode.
288 hscCompileInteractive :: Compiler (InteractiveStatus, ModIface, ModDetails)
289 hscCompileInteractive
290 = hscCompiler norecompInteractive batchMsg backend boot_backend
292 backend inp = hscSimplify inp >>= hscNormalIface >>= hscIgnoreIface >>= hscInteractive
293 boot_backend = panic "hscCompileInteractive: can't do boot files here"
296 :: NoRecomp result -- No recomp necessary
297 -> (Maybe (Int,Int) -> Bool -> Comp ()) -- Message callback
298 -> (ModGuts -> Comp result) -- Compile normal file
299 -> (ModGuts -> Comp result) -- Compile boot file
301 hscCompiler norecomp messenger nonBootComp bootComp hsc_env mod_summary
302 source_unchanged mbOldIface mbModIndex
303 = flip evalComp (CompState hsc_env mod_summary mbOldIface) $
304 do (recomp_reqd, mbCheckedIface)
305 <- {-# SCC "checkOldIface" #-}
306 liftIO $ checkOldIface hsc_env mod_summary
307 source_unchanged mbOldIface
308 -- save the interface that comes back from checkOldIface.
309 -- In one-shot mode we don't have the old iface until this
310 -- point, when checkOldIface reads it from the disk.
311 modify (\s -> s{ compOldIface = mbCheckedIface })
312 case mbCheckedIface of
313 Just iface | not recomp_reqd
314 -> do messenger mbModIndex False
315 result <- norecomp iface
318 -> do messenger mbModIndex True
319 mb_modguts <- frontend
324 -> do result <- backend core
327 frontend :: Comp (Maybe ModGuts) -- Front end
328 -- backend :: (ModGuts -> Comp result) -- Backend.
330 = case ms_hsc_src mod_summary of
331 ExtCoreFile -> (hscCoreFrontEnd, nonBootComp)
332 HsSrcFile -> (hscFileFrontEnd, nonBootComp)
333 HsBootFile -> (hscFileFrontEnd, bootComp)
335 --------------------------------------------------------------
337 --------------------------------------------------------------
339 norecompOneShot :: NoRecomp HscStatus
340 norecompOneShot _old_iface
341 = do hsc_env <- gets compHscEnv
343 dumpIfaceStats hsc_env
346 norecompBatch :: NoRecomp (HscStatus, ModIface, ModDetails)
347 norecompBatch = norecompWorker HscNoRecomp False
349 norecompInteractive :: NoRecomp (InteractiveStatus, ModIface, ModDetails)
350 norecompInteractive = norecompWorker InteractiveNoRecomp True
352 norecompWorker :: a -> Bool -> NoRecomp (a, ModIface, ModDetails)
353 norecompWorker a _isInterp old_iface
354 = do hsc_env <- gets compHscEnv
355 _mod_summary <- gets compModSummary
357 new_details <- {-# SCC "tcRnIface" #-}
358 initIfaceCheck hsc_env $
359 typecheckIface old_iface
360 dumpIfaceStats hsc_env
361 return (a, old_iface, new_details)
363 --------------------------------------------------------------
364 -- Progress displayers.
365 --------------------------------------------------------------
367 oneShotMsg :: Maybe (Int,Int) -> Bool -> Comp ()
368 oneShotMsg _mb_mod_index recomp
369 = do hsc_env <- gets compHscEnv
373 else compilationProgressMsg (hsc_dflags hsc_env) $
374 "compilation IS NOT required"
376 batchMsg :: Maybe (Int,Int) -> Bool -> Comp ()
377 batchMsg mb_mod_index recomp
378 = do hsc_env <- gets compHscEnv
379 mod_summary <- gets compModSummary
380 let showMsg msg = compilationProgressMsg (hsc_dflags hsc_env) $
381 (showModuleIndex mb_mod_index ++
382 msg ++ showModMsg (hscTarget (hsc_dflags hsc_env)) recomp mod_summary)
385 then showMsg "Compiling "
386 else if verbosity (hsc_dflags hsc_env) >= 2
387 then showMsg "Skipping "
390 --------------------------------------------------------------
392 --------------------------------------------------------------
394 hscCoreFrontEnd :: Comp (Maybe ModGuts)
396 do hsc_env <- gets compHscEnv
397 mod_summary <- gets compModSummary
402 inp <- readFile (ms_hspp_file mod_summary)
403 case parseCore inp 1 of
405 -> do errorMsg (hsc_dflags hsc_env) (text s{-ToDo: wrong-})
409 -- RENAME and TYPECHECK
411 -> do (tc_msgs, maybe_tc_result) <- {-# SCC "TypeCheck" #-}
412 tcRnExtCore hsc_env rdr_module
413 printErrorsAndWarnings (hsc_dflags hsc_env) tc_msgs
414 case maybe_tc_result of
415 Nothing -> return Nothing
416 Just mod_guts -> return (Just mod_guts) -- No desugaring to do!
419 hscFileFrontEnd :: Comp (Maybe ModGuts)
421 do hsc_env <- gets compHscEnv
422 mod_summary <- gets compModSummary
427 let dflags = hsc_dflags hsc_env
428 hspp_file = ms_hspp_file mod_summary
429 hspp_buf = ms_hspp_buf mod_summary
430 maybe_parsed <- myParseModule dflags hspp_file hspp_buf
433 -> do printBagOfErrors dflags (unitBag err)
437 -- RENAME and TYPECHECK
439 -> do (tc_msgs, maybe_tc_result)
440 <- {-# SCC "Typecheck-Rename" #-}
441 tcRnModule hsc_env (ms_hsc_src mod_summary) False rdr_module
442 printErrorsAndWarnings dflags tc_msgs
443 case maybe_tc_result of
450 -> {-# SCC "DeSugar" #-} deSugar hsc_env (ms_location mod_summary) tc_result
452 --------------------------------------------------------------
454 --------------------------------------------------------------
456 hscSimplify :: ModGuts -> Comp ModGuts
457 hscSimplify ds_result
458 = do hsc_env <- gets compHscEnv
463 simpl_result <- {-# SCC "Core2Core" #-}
464 core2core hsc_env ds_result
467 --------------------------------------------------------------
468 -- Interface generators
469 --------------------------------------------------------------
471 -- HACK: we return ModGuts even though we know it's not gonna be used.
472 -- We do this because the type signature needs to be identical
473 -- in structure to the type of 'hscNormalIface'.
474 hscSimpleIface :: ModGuts -> Comp (ModIface, Bool, ModDetails, ModGuts)
475 hscSimpleIface ds_result
476 = do hsc_env <- gets compHscEnv
477 _mod_summary <- gets compModSummary
478 maybe_old_iface <- gets compOldIface
480 details <- mkBootModDetails hsc_env ds_result
481 (new_iface, no_change)
482 <- {-# SCC "MkFinalIface" #-}
483 mkIface hsc_env maybe_old_iface ds_result details
484 -- And the answer is ...
485 dumpIfaceStats hsc_env
486 return (new_iface, no_change, details, ds_result)
488 hscNormalIface :: ModGuts -> Comp (ModIface, Bool, ModDetails, CgGuts)
489 hscNormalIface simpl_result
490 = do hsc_env <- gets compHscEnv
491 _mod_summary <- gets compModSummary
492 maybe_old_iface <- gets compOldIface
497 (cg_guts, details) <- {-# SCC "CoreTidy" #-}
498 tidyProgram hsc_env simpl_result
501 -- BUILD THE NEW ModIface and ModDetails
502 -- and emit external core if necessary
503 -- This has to happen *after* code gen so that the back-end
504 -- info has been set. Not yet clear if it matters waiting
505 -- until after code output
506 (new_iface, no_change)
507 <- {-# SCC "MkFinalIface" #-}
508 mkIface hsc_env maybe_old_iface simpl_result details
509 -- Emit external core
510 emitExternalCore (hsc_dflags hsc_env) (availsToNameSet (mg_exports simpl_result)) cg_guts -- Move this? --Lemmih 03/07/2006
511 dumpIfaceStats hsc_env
514 -- Return the prepared code.
515 return (new_iface, no_change, details, cg_guts)
517 --------------------------------------------------------------
518 -- BackEnd combinators
519 --------------------------------------------------------------
521 hscWriteIface :: (ModIface, Bool, ModDetails, a) -> Comp (ModIface, ModDetails, a)
522 hscWriteIface (iface, no_change, details, a)
523 = do mod_summary <- gets compModSummary
524 hsc_env <- gets compHscEnv
525 let dflags = hsc_dflags hsc_env
528 $ writeIfaceFile dflags (ms_location mod_summary) iface
529 return (iface, details, a)
531 hscIgnoreIface :: (ModIface, Bool, ModDetails, a) -> Comp (ModIface, ModDetails, a)
532 hscIgnoreIface (iface, _no_change, details, a)
533 = return (iface, details, a)
535 -- Don't output any code.
536 hscNothing :: (ModIface, ModDetails, a) -> Comp (HscStatus, ModIface, ModDetails)
537 hscNothing (iface, details, _)
538 = return (HscRecomp False, iface, details)
540 -- Generate code and return both the new ModIface and the ModDetails.
541 hscBatch :: (ModIface, ModDetails, CgGuts) -> Comp (HscStatus, ModIface, ModDetails)
542 hscBatch (iface, details, cgguts)
543 = do hasStub <- hscCompile cgguts
544 return (HscRecomp hasStub, iface, details)
546 -- Here we don't need the ModIface and ModDetails anymore.
547 hscOneShot :: (ModIface, ModDetails, CgGuts) -> Comp HscStatus
548 hscOneShot (_, _, cgguts)
549 = do hasStub <- hscCompile cgguts
550 return (HscRecomp hasStub)
552 -- Compile to hard-code.
553 hscCompile :: CgGuts -> Comp Bool
555 = do hsc_env <- gets compHscEnv
556 mod_summary <- gets compModSummary
558 let CgGuts{ -- This is the last use of the ModGuts in a compilation.
559 -- From now on, we just use the bits we need.
560 cg_module = this_mod,
561 cg_binds = core_binds,
563 cg_dir_imps = dir_imps,
564 cg_foreign = foreign_stubs,
565 cg_dep_pkgs = dependencies,
566 cg_hpc_info = hpc_info } = cgguts
567 dflags = hsc_dflags hsc_env
568 location = ms_location mod_summary
569 data_tycons = filter isDataTyCon tycons
570 -- cg_tycons includes newtypes, for the benefit of External Core,
571 -- but we don't generate any code for newtypes
574 -- PREPARE FOR CODE GENERATION
575 -- Do saturation and convert to A-normal form
576 prepd_binds <- {-# SCC "CorePrep" #-}
577 corePrepPgm dflags core_binds data_tycons ;
578 ----------------- Convert to STG ------------------
579 (stg_binds, cost_centre_info)
580 <- {-# SCC "CoreToStg" #-}
581 myCoreToStg dflags this_mod prepd_binds
582 ------------------ Code generation ------------------
583 cmms <- {-# SCC "CodeGen" #-}
584 codeGen dflags this_mod data_tycons
585 dir_imps cost_centre_info
587 --- Optionally run experimental Cmm transformations ---
588 cmms <- optionallyConvertAndOrCPS dflags cmms
589 -- ^ unless certain dflags are on, the identity function
590 ------------------ Code output -----------------------
591 rawcmms <- cmmToRawCmm cmms
592 (_stub_h_exists, stub_c_exists)
593 <- codeOutput dflags this_mod location foreign_stubs
597 hscInteractive :: (ModIface, ModDetails, CgGuts)
598 -> Comp (InteractiveStatus, ModIface, ModDetails)
600 hscInteractive (iface, details, cgguts)
601 = do hsc_env <- gets compHscEnv
602 mod_summary <- gets compModSummary
604 let CgGuts{ -- This is the last use of the ModGuts in a compilation.
605 -- From now on, we just use the bits we need.
606 cg_module = this_mod,
607 cg_binds = core_binds,
609 cg_foreign = foreign_stubs,
610 cg_modBreaks = mod_breaks } = cgguts
611 dflags = hsc_dflags hsc_env
612 location = ms_location mod_summary
613 data_tycons = filter isDataTyCon tycons
614 -- cg_tycons includes newtypes, for the benefit of External Core,
615 -- but we don't generate any code for newtypes
618 -- PREPARE FOR CODE GENERATION
619 -- Do saturation and convert to A-normal form
620 prepd_binds <- {-# SCC "CorePrep" #-}
621 corePrepPgm dflags core_binds data_tycons ;
622 ----------------- Generate byte code ------------------
623 comp_bc <- byteCodeGen dflags prepd_binds data_tycons mod_breaks
624 ------------------ Create f-x-dynamic C-side stuff ---
625 (_istub_h_exists, istub_c_exists)
626 <- outputForeignStubs dflags this_mod location foreign_stubs
627 return (InteractiveRecomp istub_c_exists comp_bc mod_breaks, iface, details)
629 hscInteractive _ = panic "GHC not compiled with interpreter"
632 ------------------------------
634 hscFileCheck :: HscEnv -> ModSummary -> Bool -> IO (Maybe HscChecked)
635 hscFileCheck hsc_env mod_summary compileToCore = do {
639 ; let dflags = hsc_dflags hsc_env
640 hspp_file = ms_hspp_file mod_summary
641 hspp_buf = ms_hspp_buf mod_summary
643 ; maybe_parsed <- myParseModule dflags hspp_file hspp_buf
645 ; case maybe_parsed of {
646 Left err -> do { printBagOfErrors dflags (unitBag err)
648 Right rdr_module -> do {
651 -- RENAME and TYPECHECK
653 (tc_msgs, maybe_tc_result)
654 <- {-# SCC "Typecheck-Rename" #-}
655 tcRnModule hsc_env (ms_hsc_src mod_summary)
656 True{-save renamed syntax-}
659 ; printErrorsAndWarnings dflags tc_msgs
660 ; case maybe_tc_result of {
661 Nothing -> return (Just (HscChecked rdr_module Nothing Nothing Nothing));
663 let type_env = tcg_type_env tc_result
666 md_exports = tcg_exports tc_result,
667 md_insts = tcg_insts tc_result,
668 md_fam_insts = tcg_fam_insts tc_result,
669 md_rules = [panic "no rules"],
670 -- Rules are CoreRules, not the
671 -- RuleDecls we get out of the typechecker
672 md_vect_info = noVectInfo
673 -- VectInfo is added by the Core
674 -- vectorisation pass
676 rnInfo = do decl <- tcg_rn_decls tc_result
677 imports <- tcg_rn_imports tc_result
678 let exports = tcg_rn_exports tc_result
679 let doc = tcg_doc tc_result
680 hmi = tcg_hmi tc_result
681 return (decl,imports,exports,doc,hmi)
683 if compileToCore then
684 deSugar hsc_env (ms_location mod_summary) tc_result
687 return (Just (HscChecked rdr_module
689 (Just (tcg_binds tc_result,
690 tcg_rdr_env tc_result,
693 (CoreModule { cm_module = mg_module mg,
694 cm_types = mg_types mg,
695 cm_binds = mg_binds mg}))
700 hscCmmFile :: DynFlags -> FilePath -> IO Bool
701 hscCmmFile dflags filename = do
702 maybe_cmm <- parseCmmFile dflags filename
704 Nothing -> return False
706 cmms <- optionallyConvertAndOrCPS dflags [cmm]
707 rawCmms <- cmmToRawCmm cmms
708 codeOutput dflags no_mod no_loc NoStubs [] rawCmms
711 no_mod = panic "hscCmmFile: no_mod"
712 no_loc = ModLocation{ ml_hs_file = Just filename,
713 ml_hi_file = panic "hscCmmFile: no hi file",
714 ml_obj_file = panic "hscCmmFile: no obj file" }
716 optionallyConvertAndOrCPS :: DynFlags -> [Cmm] -> IO [Cmm]
717 optionallyConvertAndOrCPS dflags cmms =
718 do -------- Optionally convert to and from zipper ------
719 cmms <- if dopt Opt_ConvertToZipCfgAndBack dflags
720 then mapM (testCmmConversion dflags) cmms
722 --------- Optionally convert to CPS (MDA) -----------
723 cmms <- if not (dopt Opt_ConvertToZipCfgAndBack dflags) &&
724 dopt Opt_RunCPSZ dflags
725 then cmmCPS dflags cmms
730 testCmmConversion :: DynFlags -> Cmm -> IO Cmm
731 testCmmConversion dflags cmm =
732 do showPass dflags "CmmToCmm"
733 dumpIfSet_dyn dflags Opt_D_dump_cvt_cmm "C-- pre-conversion" (ppr cmm)
734 --continuationC <- cmmCPS dflags abstractC >>= cmmToRawCmm
735 us <- mkSplitUniqSupply 'C'
736 let cfopts = runTx $ runCmmOpts cmmCfgOptsZ
737 let cvtm = do g <- cmmToZgraph cmm
739 let zgraph = initUs_ us cvtm
740 cps_zgraph <- protoCmmCPSZ dflags zgraph
741 let chosen_graph = if dopt Opt_RunCPSZ dflags then cps_zgraph else zgraph
742 dumpIfSet_dyn dflags Opt_D_dump_cmmz "C-- Zipper Graph" (ppr chosen_graph)
743 showPass dflags "Convert from Z back to Cmm"
744 let cvt = cmmOfZgraph $ cfopts $ chosen_graph
745 dumpIfSet_dyn dflags Opt_D_dump_cvt_cmm "C-- post-conversion" (ppr cvt)
747 -- return cmm -- don't use the conversion
749 myParseModule :: DynFlags -> FilePath -> Maybe StringBuffer
750 -> IO (Either ErrMsg (Located (HsModule RdrName)))
751 myParseModule dflags src_filename maybe_src_buf
752 = -------------------------- Parser ----------------
753 showPass dflags "Parser" >>
754 {-# SCC "Parser" #-} do
756 -- sometimes we already have the buffer in memory, perhaps
757 -- because we needed to parse the imports out of it, or get the
759 buf <- case maybe_src_buf of
761 Nothing -> hGetStringBuffer src_filename
763 let loc = mkSrcLoc (mkFastString src_filename) 1 0
765 case unP parseModule (mkPState buf loc dflags) of {
767 PFailed span err -> return (Left (mkPlainErrMsg span err));
769 POk pst rdr_module -> do {
771 let {ms = getMessages pst};
772 printErrorsAndWarnings dflags ms;
773 when (errorsFound dflags ms) $ exitWith (ExitFailure 1);
775 dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr rdr_module) ;
777 dumpIfSet_dyn dflags Opt_D_source_stats "Source Statistics"
778 (ppSourceStats False rdr_module) ;
780 return (Right rdr_module)
781 -- ToDo: free the string buffer later.
785 myCoreToStg :: DynFlags -> Module -> [CoreBind]
786 -> IO ( [(StgBinding,[(Id,[Id])])] -- output program
787 , CollectedCCs) -- cost centre info (declared and used)
789 myCoreToStg dflags this_mod prepd_binds
791 stg_binds <- {-# SCC "Core2Stg" #-}
792 coreToStg (thisPackage dflags) prepd_binds
794 (stg_binds2, cost_centre_info) <- {-# SCC "Stg2Stg" #-}
795 stg2stg dflags this_mod stg_binds
797 return (stg_binds2, cost_centre_info)
801 %************************************************************************
803 \subsection{Compiling a do-statement}
805 %************************************************************************
807 When the UnlinkedBCOExpr is linked you get an HValue of type
809 When you run it you get a list of HValues that should be
810 the same length as the list of names; add them to the ClosureEnv.
812 A naked expression returns a singleton Name [it].
814 What you type The IO [HValue] that hscStmt returns
815 ------------- ------------------------------------
816 let pat = expr ==> let pat = expr in return [coerce HVal x, coerce HVal y, ...]
819 pat <- expr ==> expr >>= \ pat -> return [coerce HVal x, coerce HVal y, ...]
822 expr (of IO type) ==> expr >>= \ v -> return [v]
823 [NB: result not printed] bindings: [it]
826 expr (of non-IO type,
827 result showable) ==> let v = expr in print v >> return [v]
830 expr (of non-IO type,
831 result not showable) ==> error
835 hscStmt -- Compile a stmt all the way to an HValue, but don't run it
837 -> String -- The statement
838 -> IO (Maybe ([Id], HValue))
841 = do { maybe_stmt <- hscParseStmt (hsc_dflags hsc_env) stmt
842 ; case maybe_stmt of {
843 Nothing -> return Nothing ; -- Parse error
844 Just Nothing -> return Nothing ; -- Empty line
845 Just (Just parsed_stmt) -> do { -- The real stuff
847 -- Rename and typecheck it
848 let icontext = hsc_IC hsc_env
849 ; maybe_tc_result <- tcRnStmt hsc_env icontext parsed_stmt
851 ; case maybe_tc_result of {
852 Nothing -> return Nothing ;
853 Just (ids, tc_expr) -> do {
856 ; let rdr_env = ic_rn_gbl_env icontext
857 type_env = mkTypeEnv (map AnId (ic_tmp_ids icontext))
858 ; mb_ds_expr <- deSugarExpr hsc_env iNTERACTIVE rdr_env type_env tc_expr
860 ; case mb_ds_expr of {
861 Nothing -> return Nothing ;
864 -- Then desugar, code gen, and link it
865 ; let src_span = srcLocSpan interactiveSrcLoc
866 ; hval <- compileExpr hsc_env src_span ds_expr
868 ; return (Just (ids, hval))
871 hscTcExpr -- Typecheck an expression (but don't run it)
873 -> String -- The expression
876 hscTcExpr hsc_env expr
877 = do { maybe_stmt <- hscParseStmt (hsc_dflags hsc_env) expr
878 ; let icontext = hsc_IC hsc_env
879 ; case maybe_stmt of {
880 Nothing -> return Nothing ; -- Parse error
881 Just (Just (L _ (ExprStmt expr _ _)))
882 -> tcRnExpr hsc_env icontext expr ;
883 Just _ -> do { errorMsg (hsc_dflags hsc_env) (text "not an expression:" <+> quotes (text expr)) ;
887 hscKcType -- Find the kind of a type
889 -> String -- The type
892 hscKcType hsc_env str
893 = do { maybe_type <- hscParseType (hsc_dflags hsc_env) str
894 ; let icontext = hsc_IC hsc_env
895 ; case maybe_type of {
896 Just ty -> tcRnType hsc_env icontext ty ;
897 Nothing -> return Nothing } }
903 hscParseStmt :: DynFlags -> String -> IO (Maybe (Maybe (LStmt RdrName)))
904 hscParseStmt = hscParseThing parseStmt
906 hscParseType :: DynFlags -> String -> IO (Maybe (LHsType RdrName))
907 hscParseType = hscParseThing parseType
910 hscParseIdentifier :: DynFlags -> String -> IO (Maybe (Located RdrName))
911 hscParseIdentifier = hscParseThing parseIdentifier
913 hscParseThing :: Outputable thing
915 -> DynFlags -> String
917 -- Nothing => Parse error (message already printed)
919 hscParseThing parser dflags str
920 = showPass dflags "Parser" >>
921 {-# SCC "Parser" #-} do
923 buf <- stringToStringBuffer str
925 let loc = mkSrcLoc FSLIT("<interactive>") 1 0
927 case unP parser (mkPState buf loc dflags) of {
929 PFailed span err -> do { printError span err;
932 POk pst thing -> do {
934 let {ms = getMessages pst};
935 printErrorsAndWarnings dflags ms;
936 when (errorsFound dflags ms) $ exitWith (ExitFailure 1);
938 --ToDo: can't free the string buffer until we've finished this
939 -- compilation sweep and all the identifiers have gone away.
940 dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr thing);
945 %************************************************************************
947 Desugar, simplify, convert to bytecode, and link an expression
949 %************************************************************************
953 compileExpr :: HscEnv -> SrcSpan -> CoreExpr -> IO HValue
955 compileExpr hsc_env srcspan ds_expr
956 = do { let { dflags = hsc_dflags hsc_env ;
957 lint_on = dopt Opt_DoCoreLinting dflags }
960 ; flat_expr <- flattenExpr hsc_env ds_expr
963 ; simpl_expr <- simplifyExpr dflags flat_expr
965 -- Tidy it (temporary, until coreSat does cloning)
966 ; let tidy_expr = tidyExpr emptyTidyEnv simpl_expr
968 -- Prepare for codegen
969 ; prepd_expr <- corePrepExpr dflags tidy_expr
972 -- ToDo: improve SrcLoc
974 let ictxt = hsc_IC hsc_env
975 tyvars = varSetElems (ic_tyvars ictxt)
977 case lintUnfolding noSrcLoc tyvars prepd_expr of
978 Just err -> pprPanic "compileExpr" err
984 ; bcos <- coreExprToBCOs dflags prepd_expr
987 ; hval <- linkExpr hsc_env srcspan bcos
995 %************************************************************************
997 Statistics on reading interfaces
999 %************************************************************************
1002 dumpIfaceStats :: HscEnv -> IO ()
1003 dumpIfaceStats hsc_env
1004 = do { eps <- readIORef (hsc_EPS hsc_env)
1005 ; dumpIfSet (dump_if_trace || dump_rn_stats)
1006 "Interface statistics"
1009 dflags = hsc_dflags hsc_env
1010 dump_rn_stats = dopt Opt_D_dump_rn_stats dflags
1011 dump_if_trace = dopt Opt_D_dump_if_trace dflags
1014 %************************************************************************
1016 Progress Messages: Module i of n
1018 %************************************************************************
1021 showModuleIndex :: Maybe (Int, Int) -> String
1022 showModuleIndex Nothing = ""
1023 showModuleIndex (Just (i,n)) = "[" ++ padded ++ " of " ++ n_str ++ "] "
1027 padded = replicate (length n_str - length i_str) ' ' ++ i_str