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 0
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],
219 Maybe (HsDoc Name), HaddockModInfo 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 = tcg_doc tc_result
237 hmi = tcg_hmi tc_result
238 ; return (decl,imports,exports,doc,hmi) }
240 return (tc_result, rn_info)
242 -- | Convert a typechecked module to Core
243 hscDesugar :: GhcMonad m => ModSummary -> TcGblEnv -> m ModGuts
244 hscDesugar mod_summary tc_result =
245 withSession $ \hsc_env ->
246 ioMsgMaybe $ deSugar hsc_env (ms_location mod_summary) tc_result
248 -- | Make a 'ModIface' from the results of typechecking. Used when
249 -- not optimising, and the interface doesn't need to contain any
250 -- unfoldings or other cross-module optimisation info.
251 -- ToDo: the old interface is only needed to get the version numbers,
252 -- we should use fingerprint versions instead.
253 makeSimpleIface :: GhcMonad m =>
254 Maybe ModIface -> TcGblEnv -> ModDetails
256 makeSimpleIface maybe_old_iface tc_result details =
257 withSession $ \hsc_env ->
258 ioMsgMaybe $ mkIfaceTc hsc_env (fmap mi_iface_hash maybe_old_iface) details tc_result
260 -- | Make a 'ModDetails' from the results of typechecking. Used when
261 -- typechecking only, as opposed to full compilation.
262 makeSimpleDetails :: GhcMonad m => TcGblEnv -> m ModDetails
263 makeSimpleDetails tc_result =
264 withSession $ \hsc_env -> liftIO $ mkBootModDetailsTc hsc_env tc_result
267 %************************************************************************
269 The main compiler pipeline
271 %************************************************************************
273 --------------------------------
274 The compilation proper
275 --------------------------------
278 It's the task of the compilation proper to compile Haskell, hs-boot and
279 core files to either byte-code, hard-code (C, asm, Java, ect) or to
280 nothing at all (the module is still parsed and type-checked. This
281 feature is mostly used by IDE's and the likes).
282 Compilation can happen in either 'one-shot', 'batch', 'nothing',
283 or 'interactive' mode. 'One-shot' mode targets hard-code, 'batch' mode
284 targets hard-code, 'nothing' mode targets nothing and 'interactive' mode
286 The modes are kept separate because of their different types and meanings.
287 In 'one-shot' mode, we're only compiling a single file and can therefore
288 discard the new ModIface and ModDetails. This is also the reason it only
289 targets hard-code; compiling to byte-code or nothing doesn't make sense
290 when we discard the result.
291 'Batch' mode is like 'one-shot' except that we keep the resulting ModIface
292 and ModDetails. 'Batch' mode doesn't target byte-code since that require
293 us to return the newly compiled byte-code.
294 'Nothing' mode has exactly the same type as 'batch' mode but they're still
295 kept separate. This is because compiling to nothing is fairly special: We
296 don't output any interface files, we don't run the simplifier and we don't
298 'Interactive' mode is similar to 'batch' mode except that we return the
299 compiled byte-code together with the ModIface and ModDetails.
301 Trying to compile a hs-boot file to byte-code will result in a run-time
302 error. This is the only thing that isn't caught by the type-system.
306 -- Status of a compilation to hard-code or nothing.
310 Bool -- Has stub files. This is a hack. We can't compile C files here
311 -- since it's done in DriverPipeline. For now we just return True
312 -- if we want the caller to compile them for us.
315 -- This is a bit ugly. Since we use a typeclass below and would like to avoid
316 -- functional dependencies, we have to parameterise the typeclass over the
317 -- result type. Therefore we need to artificially distinguish some types. We
318 -- do this by adding type tags which will simply be ignored by the caller.
319 type HscStatus = HscStatus' ()
320 type InteractiveStatus = HscStatus' (Maybe (CompiledByteCode, ModBreaks))
321 -- INVARIANT: result is @Nothing@ <=> input was a boot file
323 type OneShotResult = HscStatus
324 type BatchResult = (HscStatus, ModIface, ModDetails)
325 type NothingResult = (HscStatus, ModIface, ModDetails)
326 type InteractiveResult = (InteractiveStatus, ModIface, ModDetails)
328 -- FIXME: The old interface and module index are only using in 'batch' and
329 -- 'interactive' mode. They should be removed from 'oneshot' mode.
330 type Compiler result = GhcMonad m =>
333 -> Bool -- True <=> source unchanged
334 -> Maybe ModIface -- Old interface, if available
335 -> Maybe (Int,Int) -- Just (i,n) <=> module i of n (for msgs)
340 -- | The main interface.
341 hscCompile :: GhcMonad m =>
342 HscEnv -> ModSummary -> Bool
343 -> Maybe ModIface -> Maybe (Int, Int)
346 -- | Called when no recompilation is necessary.
347 hscNoRecomp :: GhcMonad m =>
350 -- | Called to recompile the module.
351 hscRecompile :: GhcMonad m =>
352 ModSummary -> Maybe Fingerprint -> m a,
354 hscBackend :: GhcMonad m =>
355 TcGblEnv -> ModSummary -> Maybe Fingerprint -> m a,
357 -- | Code generation for Boot modules.
358 hscGenBootOutput :: GhcMonad m =>
359 TcGblEnv -> ModSummary -> Maybe Fingerprint -> m a,
361 -- | Code generation for normal modules.
362 hscGenOutput :: GhcMonad m =>
363 ModGuts -> ModSummary -> Maybe Fingerprint -> m a
366 genericHscCompile :: GhcMonad m =>
368 -> (Maybe (Int,Int) -> Bool -> ModSummary -> m ())
369 -> HscEnv -> ModSummary -> Bool
370 -> Maybe ModIface -> Maybe (Int, Int)
372 genericHscCompile compiler hscMessage
373 hsc_env mod_summary source_unchanged
374 mb_old_iface0 mb_mod_index =
375 withTempSession (\_ -> hsc_env) $ do
376 (recomp_reqd, mb_checked_iface)
377 <- {-# SCC "checkOldIface" #-}
378 liftIO $ checkOldIface hsc_env mod_summary
379 source_unchanged mb_old_iface0
380 -- save the interface that comes back from checkOldIface.
381 -- In one-shot mode we don't have the old iface until this
382 -- point, when checkOldIface reads it from the disk.
383 let mb_old_hash = fmap mi_iface_hash mb_checked_iface
384 case mb_checked_iface of
385 Just iface | not recomp_reqd
386 -> do hscMessage mb_mod_index False mod_summary
387 hscNoRecomp compiler iface
389 -> do hscMessage mb_mod_index True mod_summary
390 hscRecompile compiler mod_summary mb_old_hash
392 genericHscRecompile :: GhcMonad m =>
394 -> ModSummary -> Maybe Fingerprint
396 genericHscRecompile compiler mod_summary mb_old_hash
397 | ExtCoreFile <- ms_hsc_src mod_summary =
398 panic "GHC does not currently support reading External Core files"
400 tc_result <- hscFileFrontEnd mod_summary
401 hscBackend compiler tc_result mod_summary mb_old_hash
403 genericHscBackend :: GhcMonad m =>
405 -> TcGblEnv -> ModSummary -> Maybe Fingerprint
407 genericHscBackend compiler tc_result mod_summary mb_old_hash
408 | HsBootFile <- ms_hsc_src mod_summary =
409 hscGenBootOutput compiler tc_result mod_summary mb_old_hash
411 guts <- hscDesugar mod_summary tc_result
412 hscGenOutput compiler guts mod_summary mb_old_hash
414 --------------------------------------------------------------
416 --------------------------------------------------------------
418 hscOneShotCompiler :: HsCompiler OneShotResult
422 hscCompile = \hsc_env mod_summary src_changed mb_old_iface mb_i_of_n -> do
423 -- One-shot mode needs a knot-tying mutable variable for interface
424 -- files. See TcRnTypes.TcGblEnv.tcg_type_env_var.
425 type_env_var <- liftIO $ newIORef emptyNameEnv
427 mod = ms_mod mod_summary
428 hsc_env' = hsc_env{ hsc_type_env_var = Just (mod, type_env_var) }
430 genericHscCompile hscOneShotCompiler
431 oneShotMsg hsc_env' mod_summary src_changed
432 mb_old_iface mb_i_of_n
434 , hscNoRecomp = \_old_iface -> do
435 withSession (liftIO . dumpIfaceStats)
438 , hscRecompile = genericHscRecompile hscOneShotCompiler
440 , hscBackend = genericHscBackend hscOneShotCompiler
442 , hscGenBootOutput = \tc_result mod_summary mb_old_iface -> do
443 (iface, changed, _) <- hscSimpleIface tc_result mb_old_iface
444 hscWriteIface iface changed mod_summary
445 return (HscRecomp False ())
447 , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
448 guts <- hscSimplify guts0
449 (iface, changed, _details, cgguts)
450 <- hscNormalIface guts mb_old_iface
451 hscWriteIface iface changed mod_summary
452 hasStub <- hscGenHardCode cgguts mod_summary
453 return (HscRecomp hasStub ())
456 -- Compile Haskell, boot and extCore in OneShot mode.
457 hscCompileOneShot :: Compiler OneShotResult
458 hscCompileOneShot = hscCompile hscOneShotCompiler
460 --------------------------------------------------------------
462 hscBatchCompiler :: HsCompiler BatchResult
466 hscCompile = genericHscCompile hscBatchCompiler batchMsg
468 , hscNoRecomp = \iface -> do
469 details <- genModDetails iface
470 return (HscNoRecomp, iface, details)
472 , hscRecompile = genericHscRecompile hscBatchCompiler
474 , hscBackend = genericHscBackend hscBatchCompiler
476 , hscGenBootOutput = \tc_result mod_summary mb_old_iface -> do
477 (iface, changed, details)
478 <- hscSimpleIface tc_result mb_old_iface
479 hscWriteIface iface changed mod_summary
480 return (HscRecomp False (), iface, details)
482 , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
483 guts <- hscSimplify guts0
484 (iface, changed, details, cgguts)
485 <- hscNormalIface guts mb_old_iface
486 hscWriteIface iface changed mod_summary
487 hasStub <- hscGenHardCode cgguts mod_summary
488 return (HscRecomp hasStub (), iface, details)
491 -- Compile Haskell, boot and extCore in batch mode.
492 hscCompileBatch :: Compiler (HscStatus, ModIface, ModDetails)
493 hscCompileBatch = hscCompile hscBatchCompiler
495 --------------------------------------------------------------
497 hscInteractiveCompiler :: HsCompiler InteractiveResult
498 hscInteractiveCompiler =
500 hscCompile = genericHscCompile hscInteractiveCompiler batchMsg
502 , hscNoRecomp = \iface -> do
503 details <- genModDetails iface
504 return (HscNoRecomp, iface, details)
506 , hscRecompile = genericHscRecompile hscInteractiveCompiler
508 , hscBackend = genericHscBackend hscInteractiveCompiler
510 , hscGenBootOutput = \tc_result _mod_summary mb_old_iface -> do
511 (iface, _changed, details) <- hscSimpleIface tc_result mb_old_iface
512 return (HscRecomp False Nothing, iface, details)
514 , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
515 guts <- hscSimplify guts0
516 (iface, _changed, details, cgguts)
517 <- hscNormalIface guts mb_old_iface
518 hscInteractive (iface, details, cgguts) mod_summary
521 -- Compile Haskell, extCore to bytecode.
522 hscCompileInteractive :: Compiler (InteractiveStatus, ModIface, ModDetails)
523 hscCompileInteractive = hscCompile hscInteractiveCompiler
525 --------------------------------------------------------------
527 hscNothingCompiler :: HsCompiler NothingResult
530 hscCompile = genericHscCompile hscNothingCompiler batchMsg
532 , hscNoRecomp = \iface -> do
533 details <- genModDetails iface
534 return (HscNoRecomp, iface, details)
536 , hscRecompile = \mod_summary mb_old_hash ->
537 case ms_hsc_src mod_summary of
539 panic "hscCompileNothing: cannot do external core"
541 tc_result <- hscFileFrontEnd mod_summary
542 hscBackend hscNothingCompiler tc_result mod_summary mb_old_hash
544 , hscBackend = \tc_result _mod_summary mb_old_iface -> do
545 (iface, _changed, details) <- hscSimpleIface tc_result mb_old_iface
546 return (HscRecomp False (), iface, details)
548 , hscGenBootOutput = \_ _ _ ->
549 panic "hscCompileNothing: hscGenBootOutput should not be called"
551 , hscGenOutput = \_ _ _ ->
552 panic "hscCompileNothing: hscGenOutput should not be called"
554 -- Type-check Haskell and .hs-boot only (no external core)
555 hscCompileNothing :: Compiler (HscStatus, ModIface, ModDetails)
556 hscCompileNothing = hscCompile hscNothingCompiler
558 --------------------------------------------------------------
560 --------------------------------------------------------------
562 genModDetails :: GhcMonad m => ModIface -> m ModDetails
563 genModDetails old_iface =
564 withSession $ \hsc_env -> liftIO $ do
565 new_details <- {-# SCC "tcRnIface" #-}
566 initIfaceCheck hsc_env $
567 typecheckIface old_iface
568 dumpIfaceStats hsc_env
571 --------------------------------------------------------------
572 -- Progress displayers.
573 --------------------------------------------------------------
575 oneShotMsg :: GhcMonad m => Maybe (Int,Int) -> Bool -> ModSummary -> m ()
576 oneShotMsg _mb_mod_index recomp _mod_summary
577 = do hsc_env <- getSession
581 else compilationProgressMsg (hsc_dflags hsc_env) $
582 "compilation IS NOT required"
584 batchMsg :: GhcMonad m => Maybe (Int,Int) -> Bool -> ModSummary -> m ()
585 batchMsg mb_mod_index recomp mod_summary
586 = do hsc_env <- getSession
587 let showMsg msg = compilationProgressMsg (hsc_dflags hsc_env) $
588 (showModuleIndex mb_mod_index ++
589 msg ++ showModMsg (hscTarget (hsc_dflags hsc_env)) recomp mod_summary)
592 then showMsg "Compiling "
593 else if verbosity (hsc_dflags hsc_env) >= 2
594 then showMsg "Skipping "
597 --------------------------------------------------------------
599 --------------------------------------------------------------
600 hscFileFrontEnd :: GhcMonad m => ModSummary -> m TcGblEnv
601 hscFileFrontEnd mod_summary =
602 do rdr_module <- hscParse mod_summary
603 hscTypecheck mod_summary rdr_module
605 --------------------------------------------------------------
607 --------------------------------------------------------------
609 hscSimplify :: GhcMonad m => ModGuts -> m ModGuts
610 hscSimplify ds_result
611 = do hsc_env <- getSession
612 simpl_result <- {-# SCC "Core2Core" #-}
613 liftIO $ core2core hsc_env ds_result
616 --------------------------------------------------------------
617 -- Interface generators
618 --------------------------------------------------------------
620 hscSimpleIface :: GhcMonad m =>
623 -> m (ModIface, Bool, ModDetails)
624 hscSimpleIface tc_result mb_old_iface
625 = do hsc_env <- getSession
626 details <- liftIO $ mkBootModDetailsTc hsc_env tc_result
627 (new_iface, no_change)
628 <- {-# SCC "MkFinalIface" #-}
629 ioMsgMaybe $ mkIfaceTc hsc_env mb_old_iface details tc_result
630 -- And the answer is ...
631 liftIO $ dumpIfaceStats hsc_env
632 return (new_iface, no_change, details)
634 hscNormalIface :: GhcMonad m =>
637 -> m (ModIface, Bool, ModDetails, CgGuts)
638 hscNormalIface simpl_result mb_old_iface
639 = do hsc_env <- getSession
641 (cg_guts, details) <- {-# SCC "CoreTidy" #-}
642 liftIO $ tidyProgram hsc_env simpl_result
644 -- BUILD THE NEW ModIface and ModDetails
645 -- and emit external core if necessary
646 -- This has to happen *after* code gen so that the back-end
647 -- info has been set. Not yet clear if it matters waiting
648 -- until after code output
649 (new_iface, no_change)
650 <- {-# SCC "MkFinalIface" #-}
651 ioMsgMaybe $ mkIface hsc_env mb_old_iface
653 -- Emit external core
654 -- This should definitely be here and not after CorePrep,
655 -- because CorePrep produces unqualified constructor wrapper declarations,
656 -- so its output isn't valid External Core (without some preprocessing).
657 liftIO $ emitExternalCore (hsc_dflags hsc_env) cg_guts
658 liftIO $ dumpIfaceStats hsc_env
660 -- Return the prepared code.
661 return (new_iface, no_change, details, cg_guts)
663 --------------------------------------------------------------
664 -- BackEnd combinators
665 --------------------------------------------------------------
667 hscWriteIface :: GhcMonad m =>
671 hscWriteIface iface no_change mod_summary
672 = do hsc_env <- getSession
673 let dflags = hsc_dflags hsc_env
676 $ writeIfaceFile dflags (ms_location mod_summary) iface
678 -- | Compile to hard-code.
679 hscGenHardCode :: GhcMonad m =>
681 -> m Bool -- ^ @True@ <=> stub.c exists
682 hscGenHardCode cgguts mod_summary
683 = withSession $ \hsc_env -> liftIO $ do
684 let CgGuts{ -- This is the last use of the ModGuts in a compilation.
685 -- From now on, we just use the bits we need.
686 cg_module = this_mod,
687 cg_binds = core_binds,
689 cg_dir_imps = dir_imps,
690 cg_foreign = foreign_stubs,
691 cg_dep_pkgs = dependencies,
692 cg_hpc_info = hpc_info } = cgguts
693 dflags = hsc_dflags hsc_env
694 location = ms_location mod_summary
695 data_tycons = filter isDataTyCon tycons
696 -- cg_tycons includes newtypes, for the benefit of External Core,
697 -- but we don't generate any code for newtypes
700 -- PREPARE FOR CODE GENERATION
701 -- Do saturation and convert to A-normal form
702 prepd_binds <- {-# SCC "CorePrep" #-}
703 corePrepPgm dflags core_binds data_tycons ;
704 ----------------- Convert to STG ------------------
705 (stg_binds, cost_centre_info)
706 <- {-# SCC "CoreToStg" #-}
707 myCoreToStg dflags this_mod prepd_binds
709 ------------------ Code generation ------------------
710 cmms <- if dopt Opt_TryNewCodeGen (hsc_dflags hsc_env)
711 then do cmms <- tryNewCodeGen hsc_env this_mod data_tycons
712 dir_imps cost_centre_info
715 else {-# SCC "CodeGen" #-}
716 codeGen dflags this_mod data_tycons
717 dir_imps cost_centre_info
720 --- Optionally run experimental Cmm transformations ---
721 -- cmms <- optionallyConvertAndOrCPS hsc_env cmms
722 -- unless certain dflags are on, the identity function
723 ------------------ Code output -----------------------
724 rawcmms <- cmmToRawCmm cmms
725 dumpIfSet_dyn dflags Opt_D_dump_cmmz "Raw Cmm" (ppr rawcmms)
726 (_stub_h_exists, stub_c_exists)
727 <- codeOutput dflags this_mod location foreign_stubs
731 hscInteractive :: GhcMonad m =>
732 (ModIface, ModDetails, CgGuts)
734 -> m (InteractiveStatus, ModIface, ModDetails)
736 hscInteractive (iface, details, cgguts) mod_summary
737 = do hsc_env <- getSession
739 let CgGuts{ -- This is the last use of the ModGuts in a compilation.
740 -- From now on, we just use the bits we need.
741 cg_module = this_mod,
742 cg_binds = core_binds,
744 cg_foreign = foreign_stubs,
745 cg_modBreaks = mod_breaks } = cgguts
746 dflags = hsc_dflags hsc_env
747 location = ms_location mod_summary
748 data_tycons = filter isDataTyCon tycons
749 -- cg_tycons includes newtypes, for the benefit of External Core,
750 -- but we don't generate any code for newtypes
753 -- PREPARE FOR CODE GENERATION
754 -- Do saturation and convert to A-normal form
755 prepd_binds <- {-# SCC "CorePrep" #-}
756 corePrepPgm dflags core_binds data_tycons ;
757 ----------------- Generate byte code ------------------
758 comp_bc <- byteCodeGen dflags prepd_binds data_tycons mod_breaks
759 ------------------ Create f-x-dynamic C-side stuff ---
760 (_istub_h_exists, istub_c_exists)
761 <- outputForeignStubs dflags this_mod location foreign_stubs
762 return (HscRecomp istub_c_exists (Just (comp_bc, mod_breaks))
765 hscInteractive _ _ = panic "GHC not compiled with interpreter"
768 ------------------------------
770 hscCmmFile :: GhcMonad m => HscEnv -> FilePath -> m ()
771 hscCmmFile hsc_env filename = do
772 dflags <- return $ hsc_dflags hsc_env
774 parseCmmFile dflags filename
775 cmms <- liftIO $ optionallyConvertAndOrCPS hsc_env [cmm]
776 rawCmms <- liftIO $ cmmToRawCmm cmms
777 _ <- liftIO $ codeOutput dflags no_mod no_loc NoStubs [] rawCmms
780 no_mod = panic "hscCmmFile: no_mod"
781 no_loc = ModLocation{ ml_hs_file = Just filename,
782 ml_hi_file = panic "hscCmmFile: no hi file",
783 ml_obj_file = panic "hscCmmFile: no obj file" }
785 -------------------- Stuff for new code gen ---------------------
787 tryNewCodeGen :: HscEnv -> Module -> [TyCon] -> [Module]
789 -> [(StgBinding,[(Id,[Id])])]
792 tryNewCodeGen hsc_env this_mod data_tycons imported_mods
793 cost_centre_info stg_binds hpc_info
794 | not (dopt Opt_TryNewCodeGen (hsc_dflags hsc_env))
797 = do { let dflags = hsc_dflags hsc_env
798 ; prog <- StgCmm.codeGen dflags this_mod data_tycons imported_mods
799 cost_centre_info stg_binds hpc_info
800 ; dumpIfSet_dyn dflags Opt_D_dump_cmmz "Cmm produced by new codegen"
803 ; prog <- return $ map (runTx $ runCmmOpts cmmCfgOptsZ) prog
804 -- Control flow optimisation
806 -- Note: Have to thread the module's SRT through all the procedures
807 -- because we greedily build it as we go.
808 ; us <- mkSplitUniqSupply 'S'
809 ; let topSRT = initUs_ us emptySRT
810 ; (topSRT, prog) <- foldM (protoCmmCPSZ hsc_env) (topSRT, []) prog
811 -- The main CPS conversion
813 ; prog <- return $ map (runTx $ runCmmOpts cmmCfgOptsZ) (srtToData topSRT : prog)
814 -- Control flow optimisation, again
816 ; let prog' = map cmmOfZgraph prog
817 ; dumpIfSet_dyn dflags Opt_D_dump_cmmz "Output Cmm" (ppr prog')
821 optionallyConvertAndOrCPS :: HscEnv -> [Cmm] -> IO [Cmm]
822 optionallyConvertAndOrCPS hsc_env cmms =
823 do let dflags = hsc_dflags hsc_env
824 -------- Optionally convert to and from zipper ------
825 cmms <- if dopt Opt_ConvertToZipCfgAndBack dflags
826 then mapM (testCmmConversion hsc_env) cmms
828 --------- Optionally convert to CPS (MDA) -----------
829 cmms <- if not (dopt Opt_ConvertToZipCfgAndBack dflags) &&
830 dopt Opt_RunCPS dflags
831 then cmmCPS dflags cmms
836 testCmmConversion :: HscEnv -> Cmm -> IO Cmm
837 testCmmConversion hsc_env cmm =
838 do let dflags = hsc_dflags hsc_env
839 showPass dflags "CmmToCmm"
840 dumpIfSet_dyn dflags Opt_D_dump_cvt_cmm "C-- pre-conversion" (ppr cmm)
841 --continuationC <- cmmCPS dflags abstractC >>= cmmToRawCmm
842 us <- mkSplitUniqSupply 'C'
843 let cfopts = runTx $ runCmmOpts cmmCfgOptsZ
844 let cvtm = do g <- cmmToZgraph cmm
846 let zgraph = initUs_ us cvtm
847 us <- mkSplitUniqSupply 'S'
848 let topSRT = initUs_ us emptySRT
849 (_, [cps_zgraph]) <- protoCmmCPSZ hsc_env (topSRT, []) zgraph
850 let chosen_graph = if dopt Opt_RunCPSZ dflags then cps_zgraph else zgraph
851 dumpIfSet_dyn dflags Opt_D_dump_cmmz "C-- Zipper Graph" (ppr chosen_graph)
852 showPass dflags "Convert from Z back to Cmm"
853 let cvt = cmmOfZgraph $ cfopts $ chosen_graph
854 dumpIfSet_dyn dflags Opt_D_dump_cvt_cmm "C-- post-conversion" (ppr cvt)
857 myCoreToStg :: DynFlags -> Module -> [CoreBind]
858 -> IO ( [(StgBinding,[(Id,[Id])])] -- output program
859 , CollectedCCs) -- cost centre info (declared and used)
861 myCoreToStg dflags this_mod prepd_binds
863 stg_binds <- {-# SCC "Core2Stg" #-}
864 coreToStg (thisPackage dflags) prepd_binds
866 (stg_binds2, cost_centre_info) <- {-# SCC "Stg2Stg" #-}
867 stg2stg dflags this_mod stg_binds
869 return (stg_binds2, cost_centre_info)
873 %************************************************************************
875 \subsection{Compiling a do-statement}
877 %************************************************************************
879 When the UnlinkedBCOExpr is linked you get an HValue of type
881 When you run it you get a list of HValues that should be
882 the same length as the list of names; add them to the ClosureEnv.
884 A naked expression returns a singleton Name [it].
886 What you type The IO [HValue] that hscStmt returns
887 ------------- ------------------------------------
888 let pat = expr ==> let pat = expr in return [coerce HVal x, coerce HVal y, ...]
891 pat <- expr ==> expr >>= \ pat -> return [coerce HVal x, coerce HVal y, ...]
894 expr (of IO type) ==> expr >>= \ v -> return [v]
895 [NB: result not printed] bindings: [it]
898 expr (of non-IO type,
899 result showable) ==> let v = expr in print v >> return [v]
902 expr (of non-IO type,
903 result not showable) ==> error
907 hscStmt -- Compile a stmt all the way to an HValue, but don't run it
910 -> String -- The statement
911 -> m (Maybe ([Id], HValue))
912 -- ^ 'Nothing' <==> empty statement (or comment only), but no parse error
913 hscStmt hsc_env stmt = do
914 maybe_stmt <- hscParseStmt (hsc_dflags hsc_env) stmt
916 Nothing -> return Nothing
917 Just parsed_stmt -> do -- The real stuff
919 -- Rename and typecheck it
920 let icontext = hsc_IC hsc_env
921 (ids, tc_expr) <- ioMsgMaybe $ tcRnStmt hsc_env icontext parsed_stmt
923 let rdr_env = ic_rn_gbl_env icontext
924 type_env = mkTypeEnv (map AnId (ic_tmp_ids icontext))
925 ds_expr <- ioMsgMaybe $
926 deSugarExpr hsc_env iNTERACTIVE rdr_env type_env tc_expr
928 -- Then desugar, code gen, and link it
929 let src_span = srcLocSpan interactiveSrcLoc
930 hval <- liftIO $ compileExpr hsc_env src_span ds_expr
932 return $ Just (ids, hval)
935 hscTcExpr -- Typecheck an expression (but don't run it)
938 -> String -- The expression
941 hscTcExpr hsc_env expr = do
942 maybe_stmt <- hscParseStmt (hsc_dflags hsc_env) expr
943 let icontext = hsc_IC hsc_env
945 Just (L _ (ExprStmt expr _ _)) -> do
946 ty <- ioMsgMaybe $ tcRnExpr hsc_env icontext expr
948 _ -> do throw $ mkSrcErr $ unitBag $ mkPlainErrMsg
950 (text "not an expression:" <+> quotes (text expr))
952 -- | Find the kind of a type
956 -> String -- ^ The type
959 hscKcType hsc_env str = do
960 ty <- hscParseType (hsc_dflags hsc_env) str
961 let icontext = hsc_IC hsc_env
962 ioMsgMaybe $ tcRnType hsc_env icontext ty
969 hscParseStmt :: GhcMonad m => DynFlags -> String -> m (Maybe (LStmt RdrName))
970 hscParseStmt = hscParseThing parseStmt
972 hscParseType :: GhcMonad m => DynFlags -> String -> m (LHsType RdrName)
973 hscParseType = hscParseThing parseType
976 hscParseIdentifier :: GhcMonad m => DynFlags -> String -> m (Located RdrName)
977 hscParseIdentifier = hscParseThing parseIdentifier
979 hscParseThing :: (Outputable thing, GhcMonad m)
981 -> DynFlags -> String
983 -- Nothing => Parse error (message already printed)
985 hscParseThing parser dflags str
986 = (liftIO $ showPass dflags "Parser") >>
987 {-# SCC "Parser" #-} do
989 buf <- liftIO $ stringToStringBuffer str
991 let loc = mkSrcLoc (fsLit "<interactive>") 1 0
993 case unP parser (mkPState buf loc dflags) of
995 PFailed span err -> do
996 let msg = mkPlainErrMsg span err
997 throw (mkSrcErr (unitBag msg))
1001 let ms@(warns, errs) = getMessages pst
1003 when (errorsFound dflags ms) $ -- handle -Werror
1004 throw (mkSrcErr errs)
1006 --ToDo: can't free the string buffer until we've finished this
1007 -- compilation sweep and all the identifiers have gone away.
1008 liftIO $ dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr thing)
1012 %************************************************************************
1014 Desugar, simplify, convert to bytecode, and link an expression
1016 %************************************************************************
1020 compileExpr :: HscEnv -> SrcSpan -> CoreExpr -> IO HValue
1022 compileExpr hsc_env srcspan ds_expr
1023 = do { let { dflags = hsc_dflags hsc_env ;
1024 lint_on = dopt Opt_DoCoreLinting dflags }
1027 ; simpl_expr <- simplifyExpr dflags ds_expr
1029 -- Tidy it (temporary, until coreSat does cloning)
1030 ; let tidy_expr = tidyExpr emptyTidyEnv simpl_expr
1032 -- Prepare for codegen
1033 ; prepd_expr <- corePrepExpr dflags tidy_expr
1035 -- Lint if necessary
1036 -- ToDo: improve SrcLoc
1038 let ictxt = hsc_IC hsc_env
1039 tyvars = varSetElems (ic_tyvars ictxt)
1041 case lintUnfolding noSrcLoc tyvars prepd_expr of
1042 Just err -> pprPanic "compileExpr" err
1043 Nothing -> return ()
1048 ; bcos <- coreExprToBCOs dflags prepd_expr
1051 ; hval <- linkExpr hsc_env srcspan bcos
1059 %************************************************************************
1061 Statistics on reading interfaces
1063 %************************************************************************
1066 dumpIfaceStats :: HscEnv -> IO ()
1067 dumpIfaceStats hsc_env
1068 = do { eps <- readIORef (hsc_EPS hsc_env)
1069 ; dumpIfSet (dump_if_trace || dump_rn_stats)
1070 "Interface statistics"
1073 dflags = hsc_dflags hsc_env
1074 dump_rn_stats = dopt Opt_D_dump_rn_stats dflags
1075 dump_if_trace = dopt Opt_D_dump_if_trace dflags
1078 %************************************************************************
1080 Progress Messages: Module i of n
1082 %************************************************************************
1085 showModuleIndex :: Maybe (Int, Int) -> String
1086 showModuleIndex Nothing = ""
1087 showModuleIndex (Just (i,n)) = "[" ++ padded ++ " of " ++ n_str ++ "] "
1091 padded = replicate (length n_str - length i_str) ' ' ++ i_str