2 % (c) The GRASP/AQUA Project, Glasgow University, 1993-2000
5 -- | Main driver for the compiling plain Haskell source code.
7 -- This module implements compilation of a Haskell-only source file. It is
8 -- /not/ concerned with preprocessing of source files; this is handled in
12 ( newHscEnv, hscCmmFile
15 , hscNormalIface, hscWriteIface, hscGenHardCode
17 , hscStmt, hscTcExpr, hscKcType
21 , hscOneShotCompiler, hscNothingCompiler
22 , hscInteractiveCompiler, hscBatchCompiler
23 , hscCompileOneShot -- :: Compiler HscStatus
24 , hscCompileBatch -- :: Compiler (HscStatus, ModIface, ModDetails)
25 , hscCompileNothing -- :: Compiler (HscStatus, ModIface, ModDetails)
26 , hscCompileInteractive -- :: Compiler (InteractiveStatus, ModIface, ModDetails)
28 , InteractiveStatus, HscStatus
40 import CodeOutput ( outputForeignStubs )
41 import ByteCodeGen ( byteCodeGen, coreExprToBCOs )
42 import Linker ( HValue, linkExpr )
43 import CoreTidy ( tidyExpr )
44 import CorePrep ( corePrepExpr )
45 import Desugar ( deSugarExpr )
46 import SimplCore ( simplifyExpr )
47 import TcRnDriver ( tcRnStmt, tcRnExpr, tcRnType )
49 import PrelNames ( iNTERACTIVE )
50 import {- Kind parts of -} Type ( Kind )
51 import CoreLint ( lintUnfolding )
52 import DsMeta ( templateHaskellNames )
53 import SrcLoc ( SrcSpan, noSrcLoc, interactiveSrcLoc, srcLocSpan, noSrcSpan )
55 import VarEnv ( emptyTidyEnv )
59 import Module ( emptyModuleEnv, ModLocation(..), Module )
63 import SrcLoc ( Located(..) )
67 import SrcLoc ( mkSrcLoc )
68 import TcRnDriver ( tcRnModule )
69 import TcIface ( typecheckIface )
70 import TcRnMonad ( initIfaceCheck, TcGblEnv(..) )
71 import IfaceEnv ( initNameCache )
72 import LoadIface ( ifaceStats, initExternalPackageState )
73 import PrelInfo ( wiredInThings, basicKnownKeyNames )
75 import Desugar ( deSugar )
76 import SimplCore ( core2core )
78 import CorePrep ( corePrepPgm )
79 import CoreToStg ( coreToStg )
80 import qualified StgCmm ( codeGen )
83 import TyCon ( TyCon, isDataTyCon )
84 import Name ( Name, NamedThing(..) )
85 import SimplStg ( stg2stg )
86 import CodeGen ( codeGen )
88 import PprCmm ( pprCmms )
89 import CmmParse ( parseCmmFile )
90 import CmmBuildInfoTables
94 import OptimizationFuel ( initOptFuelState )
98 import CodeOutput ( codeOutput )
99 import NameEnv ( emptyNameEnv )
100 import Fingerprint ( Fingerprint )
104 import UniqSupply ( mkSplitUniqSupply )
107 import HscStats ( ppSourceStats )
109 import MkExternalCore ( emitExternalCore )
111 import LazyUniqFM ( emptyUFM )
112 import UniqSupply ( initUs_ )
113 import Bag ( unitBag )
121 #include "HsVersions.h"
124 %************************************************************************
128 %************************************************************************
131 newHscEnv :: GhcApiCallbacks -> DynFlags -> IO HscEnv
132 newHscEnv callbacks dflags
133 = do { eps_var <- newIORef initExternalPackageState
134 ; us <- mkSplitUniqSupply 'r'
135 ; nc_var <- newIORef (initNameCache us knownKeyNames)
136 ; fc_var <- newIORef emptyUFM
137 ; mlc_var <- newIORef emptyModuleEnv
138 ; optFuel <- initOptFuelState
139 ; return (HscEnv { hsc_dflags = dflags,
140 hsc_callbacks = callbacks,
143 hsc_IC = emptyInteractiveContext,
144 hsc_HPT = emptyHomePackageTable,
149 hsc_OptFuel = optFuel,
150 hsc_type_env_var = Nothing,
151 hsc_global_rdr_env = emptyGlobalRdrEnv,
152 hsc_global_type_env = emptyNameEnv } ) }
155 knownKeyNames :: [Name] -- Put here to avoid loops involving DsMeta,
156 -- where templateHaskellNames are defined
157 knownKeyNames = map getName wiredInThings
158 ++ basicKnownKeyNames
160 ++ templateHaskellNames
166 -- | parse a file, returning the abstract syntax
167 hscParse :: GhcMonad m =>
169 -> m (Located (HsModule RdrName))
170 hscParse mod_summary = do
171 hsc_env <- getSession
172 let dflags = hsc_dflags hsc_env
173 src_filename = ms_hspp_file mod_summary
174 maybe_src_buf = ms_hspp_buf mod_summary
175 -------------------------- Parser ----------------
176 liftIO $ showPass dflags "Parser"
177 {-# SCC "Parser" #-} do
179 -- sometimes we already have the buffer in memory, perhaps
180 -- because we needed to parse the imports out of it, or get the
182 buf <- case maybe_src_buf of
184 Nothing -> liftIO $ hGetStringBuffer src_filename
186 let loc = mkSrcLoc (mkFastString src_filename) 1 1
188 case unP parseModule (mkPState buf loc dflags) of
190 throwOneError (mkPlainErrMsg span err)
192 POk pst rdr_module -> do
193 let ms@(warns,errs) = getMessages pst
195 if errorsFound dflags ms then
196 liftIO $ throwIO $ mkSrcErr errs
198 dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr rdr_module) ;
199 dumpIfSet_dyn dflags Opt_D_source_stats "Source Statistics"
200 (ppSourceStats False rdr_module) ;
202 -- ToDo: free the string buffer later.
204 -- | Rename and typecheck a module
205 hscTypecheck :: GhcMonad m =>
206 ModSummary -> Located (HsModule RdrName)
208 hscTypecheck mod_summary rdr_module = do
209 hsc_env <- getSession
210 r <- {-# SCC "Typecheck-Rename" #-}
211 ioMsgMaybe $ tcRnModule hsc_env (ms_hsc_src mod_summary) False rdr_module
214 -- XXX: should this really be a Maybe X? Check under which circumstances this
215 -- can become a Nothing and decide whether this should instead throw an
216 -- exception/signal an error.
218 (Maybe (HsGroup Name, [LImportDecl Name], Maybe [LIE Name],
221 -- | Rename and typecheck a module, additionally returning the renamed syntax
222 hscTypecheckRename ::
224 ModSummary -> Located (HsModule RdrName)
225 -> m (TcGblEnv, RenamedStuff)
226 hscTypecheckRename mod_summary rdr_module = do
227 hsc_env <- getSession
229 <- {-# SCC "Typecheck-Rename" #-}
230 ioMsgMaybe $ tcRnModule hsc_env (ms_hsc_src mod_summary) True rdr_module
232 let -- This 'do' is in the Maybe monad!
233 rn_info = do { decl <- tcg_rn_decls tc_result
234 ; let imports = tcg_rn_imports tc_result
235 exports = tcg_rn_exports tc_result
236 doc_hdr = tcg_doc_hdr tc_result
237 ; return (decl,imports,exports,doc_hdr) }
239 return (tc_result, rn_info)
241 -- | Convert a typechecked module to Core
242 hscDesugar :: GhcMonad m => ModSummary -> TcGblEnv -> m ModGuts
243 hscDesugar mod_summary tc_result =
244 withSession $ \hsc_env ->
245 ioMsgMaybe $ deSugar hsc_env (ms_location mod_summary) tc_result
247 -- | Make a 'ModIface' from the results of typechecking. Used when
248 -- not optimising, and the interface doesn't need to contain any
249 -- unfoldings or other cross-module optimisation info.
250 -- ToDo: the old interface is only needed to get the version numbers,
251 -- we should use fingerprint versions instead.
252 makeSimpleIface :: GhcMonad m =>
253 Maybe ModIface -> TcGblEnv -> ModDetails
255 makeSimpleIface maybe_old_iface tc_result details =
256 withSession $ \hsc_env ->
257 ioMsgMaybe $ mkIfaceTc hsc_env (fmap mi_iface_hash maybe_old_iface) details tc_result
259 -- | Make a 'ModDetails' from the results of typechecking. Used when
260 -- typechecking only, as opposed to full compilation.
261 makeSimpleDetails :: GhcMonad m => TcGblEnv -> m ModDetails
262 makeSimpleDetails tc_result =
263 withSession $ \hsc_env -> liftIO $ mkBootModDetailsTc hsc_env tc_result
266 %************************************************************************
268 The main compiler pipeline
270 %************************************************************************
272 --------------------------------
273 The compilation proper
274 --------------------------------
277 It's the task of the compilation proper to compile Haskell, hs-boot and
278 core files to either byte-code, hard-code (C, asm, Java, ect) or to
279 nothing at all (the module is still parsed and type-checked. This
280 feature is mostly used by IDE's and the likes).
281 Compilation can happen in either 'one-shot', 'batch', 'nothing',
282 or 'interactive' mode. 'One-shot' mode targets hard-code, 'batch' mode
283 targets hard-code, 'nothing' mode targets nothing and 'interactive' mode
285 The modes are kept separate because of their different types and meanings.
286 In 'one-shot' mode, we're only compiling a single file and can therefore
287 discard the new ModIface and ModDetails. This is also the reason it only
288 targets hard-code; compiling to byte-code or nothing doesn't make sense
289 when we discard the result.
290 'Batch' mode is like 'one-shot' except that we keep the resulting ModIface
291 and ModDetails. 'Batch' mode doesn't target byte-code since that require
292 us to return the newly compiled byte-code.
293 'Nothing' mode has exactly the same type as 'batch' mode but they're still
294 kept separate. This is because compiling to nothing is fairly special: We
295 don't output any interface files, we don't run the simplifier and we don't
297 'Interactive' mode is similar to 'batch' mode except that we return the
298 compiled byte-code together with the ModIface and ModDetails.
300 Trying to compile a hs-boot file to byte-code will result in a run-time
301 error. This is the only thing that isn't caught by the type-system.
305 -- Status of a compilation to hard-code or nothing.
309 Bool -- Has stub files. This is a hack. We can't compile C files here
310 -- since it's done in DriverPipeline. For now we just return True
311 -- if we want the caller to compile them for us.
314 -- This is a bit ugly. Since we use a typeclass below and would like to avoid
315 -- functional dependencies, we have to parameterise the typeclass over the
316 -- result type. Therefore we need to artificially distinguish some types. We
317 -- do this by adding type tags which will simply be ignored by the caller.
318 type HscStatus = HscStatus' ()
319 type InteractiveStatus = HscStatus' (Maybe (CompiledByteCode, ModBreaks))
320 -- INVARIANT: result is @Nothing@ <=> input was a boot file
322 type OneShotResult = HscStatus
323 type BatchResult = (HscStatus, ModIface, ModDetails)
324 type NothingResult = (HscStatus, ModIface, ModDetails)
325 type InteractiveResult = (InteractiveStatus, ModIface, ModDetails)
327 -- FIXME: The old interface and module index are only using in 'batch' and
328 -- 'interactive' mode. They should be removed from 'oneshot' mode.
329 type Compiler result = GhcMonad m =>
332 -> Bool -- True <=> source unchanged
333 -> Maybe ModIface -- Old interface, if available
334 -> Maybe (Int,Int) -- Just (i,n) <=> module i of n (for msgs)
339 -- | Called when no recompilation is necessary.
340 hscNoRecomp :: GhcMonad m =>
343 -- | Called to recompile the module.
344 hscRecompile :: GhcMonad m =>
345 ModSummary -> Maybe Fingerprint -> m a,
347 hscBackend :: GhcMonad m =>
348 TcGblEnv -> ModSummary -> Maybe Fingerprint -> m a,
350 -- | Code generation for Boot modules.
351 hscGenBootOutput :: GhcMonad m =>
352 TcGblEnv -> ModSummary -> Maybe Fingerprint -> m a,
354 -- | Code generation for normal modules.
355 hscGenOutput :: GhcMonad m =>
356 ModGuts -> ModSummary -> Maybe Fingerprint -> m a
359 genericHscCompile :: GhcMonad m =>
361 -> (Maybe (Int,Int) -> Bool -> ModSummary -> m ())
362 -> HscEnv -> ModSummary -> Bool
363 -> Maybe ModIface -> Maybe (Int, Int)
365 genericHscCompile compiler hscMessage
366 hsc_env mod_summary source_unchanged
367 mb_old_iface0 mb_mod_index =
368 withTempSession (\_ -> hsc_env) $ do
369 (recomp_reqd, mb_checked_iface)
370 <- {-# SCC "checkOldIface" #-}
371 liftIO $ checkOldIface hsc_env mod_summary
372 source_unchanged mb_old_iface0
373 -- save the interface that comes back from checkOldIface.
374 -- In one-shot mode we don't have the old iface until this
375 -- point, when checkOldIface reads it from the disk.
376 let mb_old_hash = fmap mi_iface_hash mb_checked_iface
377 case mb_checked_iface of
378 Just iface | not recomp_reqd
379 -> do hscMessage mb_mod_index False mod_summary
380 hscNoRecomp compiler iface
382 -> do hscMessage mb_mod_index True mod_summary
383 hscRecompile compiler mod_summary mb_old_hash
385 genericHscRecompile :: GhcMonad m =>
387 -> ModSummary -> Maybe Fingerprint
389 genericHscRecompile compiler mod_summary mb_old_hash
390 | ExtCoreFile <- ms_hsc_src mod_summary =
391 panic "GHC does not currently support reading External Core files"
393 tc_result <- hscFileFrontEnd mod_summary
394 hscBackend compiler tc_result mod_summary mb_old_hash
396 genericHscBackend :: GhcMonad m =>
398 -> TcGblEnv -> ModSummary -> Maybe Fingerprint
400 genericHscBackend compiler tc_result mod_summary mb_old_hash
401 | HsBootFile <- ms_hsc_src mod_summary =
402 hscGenBootOutput compiler tc_result mod_summary mb_old_hash
404 guts <- hscDesugar mod_summary tc_result
405 hscGenOutput compiler guts mod_summary mb_old_hash
407 --------------------------------------------------------------
409 --------------------------------------------------------------
411 hscOneShotCompiler :: HsCompiler OneShotResult
415 hscNoRecomp = \_old_iface -> do
416 withSession (liftIO . dumpIfaceStats)
419 , hscRecompile = genericHscRecompile hscOneShotCompiler
421 , hscBackend = genericHscBackend hscOneShotCompiler
423 , hscGenBootOutput = \tc_result mod_summary mb_old_iface -> do
424 (iface, changed, _) <- hscSimpleIface tc_result mb_old_iface
425 hscWriteIface iface changed mod_summary
426 return (HscRecomp False ())
428 , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
429 guts <- hscSimplify guts0
430 (iface, changed, _details, cgguts)
431 <- hscNormalIface guts mb_old_iface
432 hscWriteIface iface changed mod_summary
433 hasStub <- hscGenHardCode cgguts mod_summary
434 return (HscRecomp hasStub ())
437 -- Compile Haskell, boot and extCore in OneShot mode.
438 hscCompileOneShot :: Compiler OneShotResult
439 hscCompileOneShot hsc_env mod_summary src_changed mb_old_iface mb_i_of_n = do
440 -- One-shot mode needs a knot-tying mutable variable for interface
441 -- files. See TcRnTypes.TcGblEnv.tcg_type_env_var.
442 type_env_var <- liftIO $ newIORef emptyNameEnv
444 mod = ms_mod mod_summary
445 hsc_env' = hsc_env{ hsc_type_env_var = Just (mod, type_env_var) }
447 genericHscCompile hscOneShotCompiler
448 oneShotMsg hsc_env' mod_summary src_changed
449 mb_old_iface mb_i_of_n
452 --------------------------------------------------------------
454 hscBatchCompiler :: HsCompiler BatchResult
458 hscNoRecomp = \iface -> do
459 details <- genModDetails iface
460 return (HscNoRecomp, iface, details)
462 , hscRecompile = genericHscRecompile hscBatchCompiler
464 , hscBackend = genericHscBackend hscBatchCompiler
466 , hscGenBootOutput = \tc_result mod_summary mb_old_iface -> do
467 (iface, changed, details)
468 <- hscSimpleIface tc_result mb_old_iface
469 hscWriteIface iface changed mod_summary
470 return (HscRecomp False (), iface, details)
472 , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
473 guts <- hscSimplify guts0
474 (iface, changed, details, cgguts)
475 <- hscNormalIface guts mb_old_iface
476 hscWriteIface iface changed mod_summary
477 hasStub <- hscGenHardCode cgguts mod_summary
478 return (HscRecomp hasStub (), iface, details)
481 -- Compile Haskell, boot and extCore in batch mode.
482 hscCompileBatch :: Compiler (HscStatus, ModIface, ModDetails)
483 hscCompileBatch = genericHscCompile hscBatchCompiler batchMsg
485 --------------------------------------------------------------
487 hscInteractiveCompiler :: HsCompiler InteractiveResult
488 hscInteractiveCompiler =
490 hscNoRecomp = \iface -> do
491 details <- genModDetails iface
492 return (HscNoRecomp, iface, details)
494 , hscRecompile = genericHscRecompile hscInteractiveCompiler
496 , hscBackend = genericHscBackend hscInteractiveCompiler
498 , hscGenBootOutput = \tc_result _mod_summary mb_old_iface -> do
499 (iface, _changed, details) <- hscSimpleIface tc_result mb_old_iface
500 return (HscRecomp False Nothing, iface, details)
502 , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
503 guts <- hscSimplify guts0
504 (iface, _changed, details, cgguts)
505 <- hscNormalIface guts mb_old_iface
506 hscInteractive (iface, details, cgguts) mod_summary
509 -- Compile Haskell, extCore to bytecode.
510 hscCompileInteractive :: Compiler (InteractiveStatus, ModIface, ModDetails)
511 hscCompileInteractive = genericHscCompile hscInteractiveCompiler batchMsg
513 --------------------------------------------------------------
515 hscNothingCompiler :: HsCompiler NothingResult
518 hscNoRecomp = \iface -> do
519 details <- genModDetails iface
520 return (HscNoRecomp, iface, details)
522 , hscRecompile = \mod_summary mb_old_hash ->
523 case ms_hsc_src mod_summary of
525 panic "hscCompileNothing: cannot do external core"
527 tc_result <- hscFileFrontEnd mod_summary
528 hscBackend hscNothingCompiler tc_result mod_summary mb_old_hash
530 , hscBackend = \tc_result _mod_summary mb_old_iface -> do
531 (iface, _changed, details) <- hscSimpleIface tc_result mb_old_iface
532 return (HscRecomp False (), iface, details)
534 , hscGenBootOutput = \_ _ _ ->
535 panic "hscCompileNothing: hscGenBootOutput should not be called"
537 , hscGenOutput = \_ _ _ ->
538 panic "hscCompileNothing: hscGenOutput should not be called"
541 -- Type-check Haskell and .hs-boot only (no external core)
542 hscCompileNothing :: Compiler (HscStatus, ModIface, ModDetails)
543 hscCompileNothing = genericHscCompile hscNothingCompiler batchMsg
545 --------------------------------------------------------------
547 --------------------------------------------------------------
549 genModDetails :: GhcMonad m => ModIface -> m ModDetails
550 genModDetails old_iface =
551 withSession $ \hsc_env -> liftIO $ do
552 new_details <- {-# SCC "tcRnIface" #-}
553 initIfaceCheck hsc_env $
554 typecheckIface old_iface
555 dumpIfaceStats hsc_env
558 --------------------------------------------------------------
559 -- Progress displayers.
560 --------------------------------------------------------------
562 oneShotMsg :: GhcMonad m => Maybe (Int,Int) -> Bool -> ModSummary -> m ()
563 oneShotMsg _mb_mod_index recomp _mod_summary
564 = do hsc_env <- getSession
568 else compilationProgressMsg (hsc_dflags hsc_env) $
569 "compilation IS NOT required"
571 batchMsg :: GhcMonad m => Maybe (Int,Int) -> Bool -> ModSummary -> m ()
572 batchMsg mb_mod_index recomp mod_summary
573 = do hsc_env <- getSession
574 let showMsg msg = compilationProgressMsg (hsc_dflags hsc_env) $
575 (showModuleIndex mb_mod_index ++
576 msg ++ showModMsg (hscTarget (hsc_dflags hsc_env)) recomp mod_summary)
579 then showMsg "Compiling "
580 else if verbosity (hsc_dflags hsc_env) >= 2
581 then showMsg "Skipping "
584 --------------------------------------------------------------
586 --------------------------------------------------------------
587 hscFileFrontEnd :: GhcMonad m => ModSummary -> m TcGblEnv
588 hscFileFrontEnd mod_summary =
589 do rdr_module <- hscParse mod_summary
590 hscTypecheck mod_summary rdr_module
592 --------------------------------------------------------------
594 --------------------------------------------------------------
596 hscSimplify :: GhcMonad m => ModGuts -> m ModGuts
597 hscSimplify ds_result
598 = do hsc_env <- getSession
599 simpl_result <- {-# SCC "Core2Core" #-}
600 liftIO $ core2core hsc_env ds_result
603 --------------------------------------------------------------
604 -- Interface generators
605 --------------------------------------------------------------
607 hscSimpleIface :: GhcMonad m =>
610 -> m (ModIface, Bool, ModDetails)
611 hscSimpleIface tc_result mb_old_iface
612 = do hsc_env <- getSession
613 details <- liftIO $ mkBootModDetailsTc hsc_env tc_result
614 (new_iface, no_change)
615 <- {-# SCC "MkFinalIface" #-}
616 ioMsgMaybe $ mkIfaceTc hsc_env mb_old_iface details tc_result
617 -- And the answer is ...
618 liftIO $ dumpIfaceStats hsc_env
619 return (new_iface, no_change, details)
621 hscNormalIface :: GhcMonad m =>
624 -> m (ModIface, Bool, ModDetails, CgGuts)
625 hscNormalIface simpl_result mb_old_iface
626 = do hsc_env <- getSession
628 (cg_guts, details) <- {-# SCC "CoreTidy" #-}
629 liftIO $ tidyProgram hsc_env simpl_result
631 -- BUILD THE NEW ModIface and ModDetails
632 -- and emit external core if necessary
633 -- This has to happen *after* code gen so that the back-end
634 -- info has been set. Not yet clear if it matters waiting
635 -- until after code output
636 (new_iface, no_change)
637 <- {-# SCC "MkFinalIface" #-}
638 ioMsgMaybe $ mkIface hsc_env mb_old_iface
640 -- Emit external core
641 -- This should definitely be here and not after CorePrep,
642 -- because CorePrep produces unqualified constructor wrapper declarations,
643 -- so its output isn't valid External Core (without some preprocessing).
644 liftIO $ emitExternalCore (hsc_dflags hsc_env) cg_guts
645 liftIO $ dumpIfaceStats hsc_env
647 -- Return the prepared code.
648 return (new_iface, no_change, details, cg_guts)
650 --------------------------------------------------------------
651 -- BackEnd combinators
652 --------------------------------------------------------------
654 hscWriteIface :: GhcMonad m =>
658 hscWriteIface iface no_change mod_summary
659 = do hsc_env <- getSession
660 let dflags = hsc_dflags hsc_env
663 $ writeIfaceFile dflags (ms_location mod_summary) iface
665 -- | Compile to hard-code.
666 hscGenHardCode :: GhcMonad m =>
668 -> m Bool -- ^ @True@ <=> stub.c exists
669 hscGenHardCode cgguts mod_summary
670 = withSession $ \hsc_env -> liftIO $ do
671 let CgGuts{ -- This is the last use of the ModGuts in a compilation.
672 -- From now on, we just use the bits we need.
673 cg_module = this_mod,
674 cg_binds = core_binds,
676 cg_dir_imps = dir_imps,
677 cg_foreign = foreign_stubs,
678 cg_dep_pkgs = dependencies,
679 cg_hpc_info = hpc_info } = cgguts
680 dflags = hsc_dflags hsc_env
681 location = ms_location mod_summary
682 data_tycons = filter isDataTyCon tycons
683 -- cg_tycons includes newtypes, for the benefit of External Core,
684 -- but we don't generate any code for newtypes
687 -- PREPARE FOR CODE GENERATION
688 -- Do saturation and convert to A-normal form
689 prepd_binds <- {-# SCC "CorePrep" #-}
690 corePrepPgm dflags core_binds data_tycons ;
691 ----------------- Convert to STG ------------------
692 (stg_binds, cost_centre_info)
693 <- {-# SCC "CoreToStg" #-}
694 myCoreToStg dflags this_mod prepd_binds
696 ------------------ Code generation ------------------
697 cmms <- if dopt Opt_TryNewCodeGen (hsc_dflags hsc_env)
698 then do cmms <- tryNewCodeGen hsc_env this_mod data_tycons
699 dir_imps cost_centre_info
702 else {-# SCC "CodeGen" #-}
703 codeGen dflags this_mod data_tycons
704 dir_imps cost_centre_info
707 --- Optionally run experimental Cmm transformations ---
708 -- cmms <- optionallyConvertAndOrCPS hsc_env cmms
709 -- unless certain dflags are on, the identity function
710 ------------------ Code output -----------------------
711 rawcmms <- cmmToRawCmm cmms
712 dumpIfSet_dyn dflags Opt_D_dump_cmmz "Raw Cmm" (ppr rawcmms)
713 (_stub_h_exists, stub_c_exists)
714 <- codeOutput dflags this_mod location foreign_stubs
718 hscInteractive :: GhcMonad m =>
719 (ModIface, ModDetails, CgGuts)
721 -> m (InteractiveStatus, ModIface, ModDetails)
723 hscInteractive (iface, details, cgguts) mod_summary
724 = do hsc_env <- getSession
726 let CgGuts{ -- This is the last use of the ModGuts in a compilation.
727 -- From now on, we just use the bits we need.
728 cg_module = this_mod,
729 cg_binds = core_binds,
731 cg_foreign = foreign_stubs,
732 cg_modBreaks = mod_breaks } = cgguts
733 dflags = hsc_dflags hsc_env
734 location = ms_location mod_summary
735 data_tycons = filter isDataTyCon tycons
736 -- cg_tycons includes newtypes, for the benefit of External Core,
737 -- but we don't generate any code for newtypes
740 -- PREPARE FOR CODE GENERATION
741 -- Do saturation and convert to A-normal form
742 prepd_binds <- {-# SCC "CorePrep" #-}
743 corePrepPgm dflags core_binds data_tycons ;
744 ----------------- Generate byte code ------------------
745 comp_bc <- byteCodeGen dflags prepd_binds data_tycons mod_breaks
746 ------------------ Create f-x-dynamic C-side stuff ---
747 (_istub_h_exists, istub_c_exists)
748 <- outputForeignStubs dflags this_mod location foreign_stubs
749 return (HscRecomp istub_c_exists (Just (comp_bc, mod_breaks))
752 hscInteractive _ _ = panic "GHC not compiled with interpreter"
755 ------------------------------
757 hscCmmFile :: GhcMonad m => HscEnv -> FilePath -> m ()
758 hscCmmFile hsc_env filename = do
759 dflags <- return $ hsc_dflags hsc_env
761 parseCmmFile dflags filename
762 cmms <- liftIO $ optionallyConvertAndOrCPS hsc_env [cmm]
763 rawCmms <- liftIO $ cmmToRawCmm cmms
764 _ <- liftIO $ codeOutput dflags no_mod no_loc NoStubs [] rawCmms
767 no_mod = panic "hscCmmFile: no_mod"
768 no_loc = ModLocation{ ml_hs_file = Just filename,
769 ml_hi_file = panic "hscCmmFile: no hi file",
770 ml_obj_file = panic "hscCmmFile: no obj file" }
772 -------------------- Stuff for new code gen ---------------------
774 tryNewCodeGen :: HscEnv -> Module -> [TyCon] -> [Module]
776 -> [(StgBinding,[(Id,[Id])])]
779 tryNewCodeGen hsc_env this_mod data_tycons imported_mods
780 cost_centre_info stg_binds hpc_info =
781 do { let dflags = hsc_dflags hsc_env
782 ; prog <- StgCmm.codeGen dflags this_mod data_tycons imported_mods
783 cost_centre_info stg_binds hpc_info
784 ; dumpIfSet_dyn dflags Opt_D_dump_cmmz "Cmm produced by new codegen"
787 ; prog <- return $ map (runTx $ runCmmOpts cmmCfgOptsZ) prog
788 -- Control flow optimisation
790 -- We are building a single SRT for the entire module, so
791 -- we must thread it through all the procedures as we cps-convert them.
792 ; us <- mkSplitUniqSupply 'S'
793 ; let topSRT = initUs_ us emptySRT
794 ; (topSRT, prog) <- foldM (protoCmmCPSZ hsc_env) (topSRT, []) prog
795 -- The main CPS conversion
797 ; prog <- return $ map (runTx $ runCmmOpts cmmCfgOptsZ) (srtToData topSRT : prog)
798 -- Control flow optimisation, again
800 ; let prog' = map cmmOfZgraph prog
801 ; dumpIfSet_dyn dflags Opt_D_dump_cmmz "Output Cmm" (ppr prog')
805 optionallyConvertAndOrCPS :: HscEnv -> [Cmm] -> IO [Cmm]
806 optionallyConvertAndOrCPS hsc_env cmms =
807 do let dflags = hsc_dflags hsc_env
808 -------- Optionally convert to and from zipper ------
809 cmms <- if dopt Opt_ConvertToZipCfgAndBack dflags
810 then mapM (testCmmConversion hsc_env) cmms
812 --------- Optionally convert to CPS (MDA) -----------
813 cmms <- if not (dopt Opt_ConvertToZipCfgAndBack dflags) &&
814 dopt Opt_RunCPS dflags
815 then cmmCPS dflags cmms
820 testCmmConversion :: HscEnv -> Cmm -> IO Cmm
821 testCmmConversion hsc_env cmm =
822 do let dflags = hsc_dflags hsc_env
823 showPass dflags "CmmToCmm"
824 dumpIfSet_dyn dflags Opt_D_dump_cvt_cmm "C-- pre-conversion" (ppr cmm)
825 --continuationC <- cmmCPS dflags abstractC >>= cmmToRawCmm
826 us <- mkSplitUniqSupply 'C'
827 let cfopts = runTx $ runCmmOpts cmmCfgOptsZ
828 let cvtm = do g <- cmmToZgraph cmm
830 let zgraph = initUs_ us cvtm
831 us <- mkSplitUniqSupply 'S'
832 let topSRT = initUs_ us emptySRT
833 (_, [cps_zgraph]) <- protoCmmCPSZ hsc_env (topSRT, []) zgraph
834 let chosen_graph = if dopt Opt_RunCPSZ dflags then cps_zgraph else zgraph
835 dumpIfSet_dyn dflags Opt_D_dump_cmmz "C-- Zipper Graph" (ppr chosen_graph)
836 showPass dflags "Convert from Z back to Cmm"
837 let cvt = cmmOfZgraph $ cfopts $ chosen_graph
838 dumpIfSet_dyn dflags Opt_D_dump_cvt_cmm "C-- post-conversion" (ppr cvt)
841 myCoreToStg :: DynFlags -> Module -> [CoreBind]
842 -> IO ( [(StgBinding,[(Id,[Id])])] -- output program
843 , CollectedCCs) -- cost centre info (declared and used)
845 myCoreToStg dflags this_mod prepd_binds
847 stg_binds <- {-# SCC "Core2Stg" #-}
848 coreToStg (thisPackage dflags) prepd_binds
850 (stg_binds2, cost_centre_info) <- {-# SCC "Stg2Stg" #-}
851 stg2stg dflags this_mod stg_binds
853 return (stg_binds2, cost_centre_info)
857 %************************************************************************
859 \subsection{Compiling a do-statement}
861 %************************************************************************
863 When the UnlinkedBCOExpr is linked you get an HValue of type
865 When you run it you get a list of HValues that should be
866 the same length as the list of names; add them to the ClosureEnv.
868 A naked expression returns a singleton Name [it].
870 What you type The IO [HValue] that hscStmt returns
871 ------------- ------------------------------------
872 let pat = expr ==> let pat = expr in return [coerce HVal x, coerce HVal y, ...]
875 pat <- expr ==> expr >>= \ pat -> return [coerce HVal x, coerce HVal y, ...]
878 expr (of IO type) ==> expr >>= \ v -> return [v]
879 [NB: result not printed] bindings: [it]
882 expr (of non-IO type,
883 result showable) ==> let v = expr in print v >> return [v]
886 expr (of non-IO type,
887 result not showable) ==> error
891 hscStmt -- Compile a stmt all the way to an HValue, but don't run it
894 -> String -- The statement
895 -> m (Maybe ([Id], HValue))
896 -- ^ 'Nothing' <==> empty statement (or comment only), but no parse error
897 hscStmt hsc_env stmt = do
898 maybe_stmt <- hscParseStmt (hsc_dflags hsc_env) stmt
900 Nothing -> return Nothing
901 Just parsed_stmt -> do -- The real stuff
903 -- Rename and typecheck it
904 let icontext = hsc_IC hsc_env
905 (ids, tc_expr) <- ioMsgMaybe $ tcRnStmt hsc_env icontext parsed_stmt
907 let rdr_env = ic_rn_gbl_env icontext
908 type_env = mkTypeEnv (map AnId (ic_tmp_ids icontext))
909 ds_expr <- ioMsgMaybe $
910 deSugarExpr hsc_env iNTERACTIVE rdr_env type_env tc_expr
912 -- Then desugar, code gen, and link it
913 let src_span = srcLocSpan interactiveSrcLoc
914 hval <- liftIO $ compileExpr hsc_env src_span ds_expr
916 return $ Just (ids, hval)
919 hscTcExpr -- Typecheck an expression (but don't run it)
922 -> String -- The expression
925 hscTcExpr hsc_env expr = do
926 maybe_stmt <- hscParseStmt (hsc_dflags hsc_env) expr
927 let icontext = hsc_IC hsc_env
929 Just (L _ (ExprStmt expr _ _)) -> do
930 ty <- ioMsgMaybe $ tcRnExpr hsc_env icontext expr
932 _ -> do throw $ mkSrcErr $ unitBag $ mkPlainErrMsg
934 (text "not an expression:" <+> quotes (text expr))
936 -- | Find the kind of a type
940 -> String -- ^ The type
943 hscKcType hsc_env str = do
944 ty <- hscParseType (hsc_dflags hsc_env) str
945 let icontext = hsc_IC hsc_env
946 ioMsgMaybe $ tcRnType hsc_env icontext ty
953 hscParseStmt :: GhcMonad m => DynFlags -> String -> m (Maybe (LStmt RdrName))
954 hscParseStmt = hscParseThing parseStmt
956 hscParseType :: GhcMonad m => DynFlags -> String -> m (LHsType RdrName)
957 hscParseType = hscParseThing parseType
960 hscParseIdentifier :: GhcMonad m => DynFlags -> String -> m (Located RdrName)
961 hscParseIdentifier = hscParseThing parseIdentifier
963 hscParseThing :: (Outputable thing, GhcMonad m)
965 -> DynFlags -> String
967 -- Nothing => Parse error (message already printed)
969 hscParseThing parser dflags str
970 = (liftIO $ showPass dflags "Parser") >>
971 {-# SCC "Parser" #-} do
973 buf <- liftIO $ stringToStringBuffer str
975 let loc = mkSrcLoc (fsLit "<interactive>") 1 1
977 case unP parser (mkPState buf loc dflags) of
979 PFailed span err -> do
980 let msg = mkPlainErrMsg span err
981 throw (mkSrcErr (unitBag msg))
985 let ms@(warns, errs) = getMessages pst
987 when (errorsFound dflags ms) $ -- handle -Werror
988 throw (mkSrcErr errs)
990 --ToDo: can't free the string buffer until we've finished this
991 -- compilation sweep and all the identifiers have gone away.
992 liftIO $ dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr thing)
996 %************************************************************************
998 Desugar, simplify, convert to bytecode, and link an expression
1000 %************************************************************************
1004 compileExpr :: HscEnv -> SrcSpan -> CoreExpr -> IO HValue
1006 compileExpr hsc_env srcspan ds_expr
1007 = do { let { dflags = hsc_dflags hsc_env ;
1008 lint_on = dopt Opt_DoCoreLinting dflags }
1011 ; simpl_expr <- simplifyExpr dflags ds_expr
1013 -- Tidy it (temporary, until coreSat does cloning)
1014 ; let tidy_expr = tidyExpr emptyTidyEnv simpl_expr
1016 -- Prepare for codegen
1017 ; prepd_expr <- corePrepExpr dflags tidy_expr
1019 -- Lint if necessary
1020 -- ToDo: improve SrcLoc
1022 let ictxt = hsc_IC hsc_env
1023 tyvars = varSetElems (ic_tyvars ictxt)
1025 case lintUnfolding noSrcLoc tyvars prepd_expr of
1026 Just err -> pprPanic "compileExpr" err
1027 Nothing -> return ()
1032 ; bcos <- coreExprToBCOs dflags prepd_expr
1035 ; hval <- linkExpr hsc_env srcspan bcos
1043 %************************************************************************
1045 Statistics on reading interfaces
1047 %************************************************************************
1050 dumpIfaceStats :: HscEnv -> IO ()
1051 dumpIfaceStats hsc_env
1052 = do { eps <- readIORef (hsc_EPS hsc_env)
1053 ; dumpIfSet (dump_if_trace || dump_rn_stats)
1054 "Interface statistics"
1057 dflags = hsc_dflags hsc_env
1058 dump_rn_stats = dopt Opt_D_dump_rn_stats dflags
1059 dump_if_trace = dopt Opt_D_dump_if_trace dflags
1062 %************************************************************************
1064 Progress Messages: Module i of n
1066 %************************************************************************
1069 showModuleIndex :: Maybe (Int, Int) -> String
1070 showModuleIndex Nothing = ""
1071 showModuleIndex (Just (i,n)) = "[" ++ padded ++ " of " ++ n_str ++ "] "
1075 padded = replicate (length n_str - length i_str) ' ' ++ i_str