2 % (c) The GRASP/AQUA Project, Glasgow University, 1993-2000
5 -- | Main API for compiling plain Haskell source code.
7 -- This module implements compilation of a Haskell source. It is
8 -- /not/ concerned with preprocessing of source files; this is handled
9 -- in "DriverPipeline".
11 -- There are various entry points depending on what mode we're in:
12 -- "batch" mode (@--make@), "one-shot" mode (@-c@, @-S@ etc.), and
13 -- "interactive" mode (GHCi). There are also entry points for
14 -- individual passes: parsing, typechecking/renaming, desugaring, and
17 -- All the functions here take an 'HscEnv' as a parameter, but none of
18 -- them return a new one: 'HscEnv' is treated as an immutable value
19 -- from here on in (although it has mutable components, for the
22 -- Warning messages are dealt with consistently throughout this API:
23 -- during compilation warnings are collected, and before any function
24 -- in @HscMain@ returns, the warnings are either printed, or turned
25 -- into a real compialtion error if the @-Werror@ flag is enabled.
32 -- * Compiling complete source files
35 , InteractiveStatus, HscStatus
39 , hscCompileInteractive
43 -- * Running passes separately
49 , hscSimplify -- ToDo, shouldn't really export this
52 , hscOneShotBackendOnly
54 , hscNothingBackendOnly
55 , hscInteractiveBackendOnly
57 -- * Support for interactive evaluation
64 , hscTcRnLookupRdrName
65 , hscStmt, hscTcExpr, hscImport, hscKcType
72 import ByteCodeGen ( byteCodeGen, coreExprToBCOs )
73 import Linker ( HValue, linkExpr )
74 import CoreTidy ( tidyExpr )
76 import TcType ( tyVarsOfTypes )
77 import PrelNames ( iNTERACTIVE )
78 import {- Kind parts of -} Type ( Kind )
80 import CoreLint ( lintUnfolding )
81 import DsMeta ( templateHaskellNames )
83 import VarEnv ( emptyTidyEnv )
88 import Module ( emptyModuleEnv, ModLocation(..), Module )
94 import Lexer hiding (getDynFlags)
97 import TcIface ( typecheckIface )
99 import RnNames ( rnImports )
100 import IfaceEnv ( initNameCache )
101 import LoadIface ( ifaceStats, initExternalPackageState )
102 import PrelInfo ( wiredInThings, basicKnownKeyNames )
108 import CoreToStg ( coreToStg )
109 import qualified StgCmm ( codeGen )
112 import TyCon ( TyCon, isDataTyCon )
113 import Name ( Name, NamedThing(..) )
114 import SimplStg ( stg2stg )
115 import CodeGen ( codeGen )
117 import PprCmm ( pprCmms )
118 import CmmParse ( parseCmmFile )
119 import CmmBuildInfoTables
123 import OptimizationFuel ( initOptFuelState )
126 import CmmContFlowOpt
128 import NameEnv ( emptyNameEnv )
129 import NameSet ( emptyNameSet )
131 import FamInstEnv ( emptyFamInstEnv )
132 import Fingerprint ( Fingerprint )
136 import UniqSupply ( mkSplitUniqSupply )
139 import HscStats ( ppSourceStats )
141 import MkExternalCore ( emitExternalCore )
143 import UniqFM ( emptyUFM )
144 import UniqSupply ( initUs_ )
153 #include "HsVersions.h"
156 %************************************************************************
160 %************************************************************************
163 newHscEnv :: DynFlags -> IO HscEnv
165 = do { eps_var <- newIORef initExternalPackageState
166 ; us <- mkSplitUniqSupply 'r'
167 ; nc_var <- newIORef (initNameCache us knownKeyNames)
168 ; fc_var <- newIORef emptyUFM
169 ; mlc_var <- newIORef emptyModuleEnv
170 ; optFuel <- initOptFuelState
171 ; return (HscEnv { hsc_dflags = dflags,
174 hsc_IC = emptyInteractiveContext,
175 hsc_HPT = emptyHomePackageTable,
180 hsc_OptFuel = optFuel,
181 hsc_type_env_var = Nothing } ) }
184 knownKeyNames :: [Name] -- Put here to avoid loops involving DsMeta,
185 -- where templateHaskellNames are defined
186 knownKeyNames = map getName wiredInThings
187 ++ basicKnownKeyNames
189 ++ templateHaskellNames
192 -- -----------------------------------------------------------------------------
193 -- The Hsc monad: collecting warnings
195 newtype Hsc a = Hsc (HscEnv -> WarningMessages -> IO (a, WarningMessages))
197 instance Monad Hsc where
198 return a = Hsc $ \_ w -> return (a, w)
199 Hsc m >>= k = Hsc $ \e w -> do (a, w1) <- m e w
203 instance MonadIO Hsc where
204 liftIO io = Hsc $ \_ w -> do a <- io; return (a, w)
206 runHsc :: HscEnv -> Hsc a -> IO a
207 runHsc hsc_env (Hsc hsc) = do
208 (a, w) <- hsc hsc_env emptyBag
209 printOrThrowWarnings (hsc_dflags hsc_env) w
212 getWarnings :: Hsc WarningMessages
213 getWarnings = Hsc $ \_ w -> return (w, w)
215 clearWarnings :: Hsc ()
216 clearWarnings = Hsc $ \_ _w -> return ((), emptyBag)
218 logWarnings :: WarningMessages -> Hsc ()
219 logWarnings w = Hsc $ \_ w0 -> return ((), w0 `unionBags` w)
221 getHscEnv :: Hsc HscEnv
222 getHscEnv = Hsc $ \e w -> return (e, w)
224 getDynFlags :: Hsc DynFlags
225 getDynFlags = Hsc $ \e w -> return (hsc_dflags e, w)
227 handleWarnings :: Hsc ()
229 dflags <- getDynFlags
231 liftIO $ printOrThrowWarnings dflags w
234 -- | log warning in the monad, and if there are errors then
235 -- throw a SourceError exception.
236 logWarningsReportErrors :: Messages -> Hsc ()
237 logWarningsReportErrors (warns,errs) = do
239 when (not (isEmptyBag errs)) $ do
240 liftIO $ throwIO $ mkSrcErr errs
242 -- | Deal with errors and warnings returned by a compilation step
244 -- In order to reduce dependencies to other parts of the compiler, functions
245 -- outside the "main" parts of GHC return warnings and errors as a parameter
246 -- and signal success via by wrapping the result in a 'Maybe' type. This
247 -- function logs the returned warnings and propagates errors as exceptions
248 -- (of type 'SourceError').
250 -- This function assumes the following invariants:
252 -- 1. If the second result indicates success (is of the form 'Just x'),
253 -- there must be no error messages in the first result.
255 -- 2. If there are no error messages, but the second result indicates failure
256 -- there should be warnings in the first result. That is, if the action
257 -- failed, it must have been due to the warnings (i.e., @-Werror@).
258 ioMsgMaybe :: IO (Messages, Maybe a) -> Hsc a
260 ((warns,errs), mb_r) <- liftIO $ ioA
263 Nothing -> liftIO $ throwIO (mkSrcErr errs)
264 Just r -> ASSERT( isEmptyBag errs ) return r
266 -- | like ioMsgMaybe, except that we ignore error messages and return
267 -- 'Nothing' instead.
268 ioMsgMaybe' :: IO (Messages, Maybe a) -> Hsc (Maybe a)
270 ((warns,_errs), mb_r) <- liftIO $ ioA
274 -- -----------------------------------------------------------------------------
275 -- | Lookup things in the compiler's environment
278 hscTcRnLookupRdrName :: HscEnv -> RdrName -> IO [Name]
279 hscTcRnLookupRdrName hsc_env rdr_name =
280 runHsc hsc_env $ ioMsgMaybe $ tcRnLookupRdrName hsc_env rdr_name
283 hscTcRcLookupName :: HscEnv -> Name -> IO (Maybe TyThing)
284 hscTcRcLookupName hsc_env name =
285 runHsc hsc_env $ ioMsgMaybe' $ tcRnLookupName hsc_env name
286 -- ignore errors: the only error we're likely to get is
287 -- "name not found", and the Maybe in the return type
288 -- is used to indicate that.
290 hscTcRnGetInfo :: HscEnv -> Name -> IO (Maybe (TyThing, Fixity, [Instance]))
291 hscTcRnGetInfo hsc_env name =
292 runHsc hsc_env $ ioMsgMaybe' $ tcRnGetInfo hsc_env name
295 hscGetModuleExports :: HscEnv -> Module -> IO (Maybe [AvailInfo])
296 hscGetModuleExports hsc_env mdl =
297 runHsc hsc_env $ ioMsgMaybe' $ getModuleExports hsc_env mdl
300 -- -----------------------------------------------------------------------------
301 -- | Rename some import declarations
306 -> [LImportDecl RdrName]
309 hscRnImportDecls hsc_env this_mod import_decls = runHsc hsc_env $ do
311 ioMsgMaybe $ initTc hsc_env HsSrcFile False this_mod $
312 rnImports import_decls
315 -- -----------------------------------------------------------------------------
316 -- | parse a file, returning the abstract syntax
318 hscParse :: HscEnv -> ModSummary -> IO (Located (HsModule RdrName))
319 hscParse hsc_env mod_summary = runHsc hsc_env $ hscParse' mod_summary
321 -- internal version, that doesn't fail due to -Werror
322 hscParse' :: ModSummary -> Hsc (Located (HsModule RdrName))
323 hscParse' mod_summary
325 dflags <- getDynFlags
327 src_filename = ms_hspp_file mod_summary
328 maybe_src_buf = ms_hspp_buf mod_summary
330 -------------------------- Parser ----------------
331 liftIO $ showPass dflags "Parser"
332 {-# SCC "Parser" #-} do
334 -- sometimes we already have the buffer in memory, perhaps
335 -- because we needed to parse the imports out of it, or get the
337 buf <- case maybe_src_buf of
339 Nothing -> liftIO $ hGetStringBuffer src_filename
341 let loc = mkSrcLoc (mkFastString src_filename) 1 1
343 case unP parseModule (mkPState dflags buf loc) of
345 liftIO $ throwOneError (mkPlainErrMsg span err)
347 POk pst rdr_module -> do
348 logWarningsReportErrors (getMessages pst)
349 liftIO $ dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" $
351 liftIO $ dumpIfSet_dyn dflags Opt_D_source_stats "Source Statistics" $
352 ppSourceStats False rdr_module
354 -- ToDo: free the string buffer later.
356 -- XXX: should this really be a Maybe X? Check under which circumstances this
357 -- can become a Nothing and decide whether this should instead throw an
358 -- exception/signal an error.
360 (Maybe (HsGroup Name, [LImportDecl Name], Maybe [LIE Name],
363 -- | Rename and typecheck a module, additionally returning the renamed syntax
364 hscTypecheckRename :: HscEnv -> ModSummary -> Located (HsModule RdrName)
365 -> IO (TcGblEnv, RenamedStuff)
366 hscTypecheckRename hsc_env mod_summary rdr_module
367 = runHsc hsc_env $ do
369 <- {-# SCC "Typecheck-Rename" #-}
371 tcRnModule hsc_env (ms_hsc_src mod_summary) True rdr_module
373 let -- This 'do' is in the Maybe monad!
374 rn_info = do decl <- tcg_rn_decls tc_result
375 let imports = tcg_rn_imports tc_result
376 exports = tcg_rn_exports tc_result
377 doc_hdr = tcg_doc_hdr tc_result
378 return (decl,imports,exports,doc_hdr)
380 return (tc_result, rn_info)
382 -- | Convert a typechecked module to Core
383 hscDesugar :: HscEnv -> ModSummary -> TcGblEnv -> IO ModGuts
384 hscDesugar hsc_env mod_summary tc_result
385 = runHsc hsc_env $ hscDesugar' mod_summary tc_result
387 hscDesugar' :: ModSummary -> TcGblEnv -> Hsc ModGuts
388 hscDesugar' mod_summary tc_result
392 deSugar hsc_env (ms_location mod_summary) tc_result
395 -- always check -Werror after desugaring, this is
396 -- the last opportunity for warnings to arise before
400 -- | Make a 'ModIface' from the results of typechecking. Used when
401 -- not optimising, and the interface doesn't need to contain any
402 -- unfoldings or other cross-module optimisation info.
403 -- ToDo: the old interface is only needed to get the version numbers,
404 -- we should use fingerprint versions instead.
405 makeSimpleIface :: HscEnv ->
406 Maybe ModIface -> TcGblEnv -> ModDetails
407 -> IO (ModIface,Bool)
408 makeSimpleIface hsc_env maybe_old_iface tc_result details
411 mkIfaceTc hsc_env (fmap mi_iface_hash maybe_old_iface) details tc_result
413 -- | Make a 'ModDetails' from the results of typechecking. Used when
414 -- typechecking only, as opposed to full compilation.
415 makeSimpleDetails :: HscEnv -> TcGblEnv -> IO ModDetails
416 makeSimpleDetails hsc_env tc_result = mkBootModDetailsTc hsc_env tc_result
419 %************************************************************************
421 The main compiler pipeline
423 %************************************************************************
425 --------------------------------
426 The compilation proper
427 --------------------------------
430 It's the task of the compilation proper to compile Haskell, hs-boot and
431 core files to either byte-code, hard-code (C, asm, Java, ect) or to
432 nothing at all (the module is still parsed and type-checked. This
433 feature is mostly used by IDE's and the likes).
434 Compilation can happen in either 'one-shot', 'batch', 'nothing',
435 or 'interactive' mode. 'One-shot' mode targets hard-code, 'batch' mode
436 targets hard-code, 'nothing' mode targets nothing and 'interactive' mode
438 The modes are kept separate because of their different types and meanings.
439 In 'one-shot' mode, we're only compiling a single file and can therefore
440 discard the new ModIface and ModDetails. This is also the reason it only
441 targets hard-code; compiling to byte-code or nothing doesn't make sense
442 when we discard the result.
443 'Batch' mode is like 'one-shot' except that we keep the resulting ModIface
444 and ModDetails. 'Batch' mode doesn't target byte-code since that require
445 us to return the newly compiled byte-code.
446 'Nothing' mode has exactly the same type as 'batch' mode but they're still
447 kept separate. This is because compiling to nothing is fairly special: We
448 don't output any interface files, we don't run the simplifier and we don't
450 'Interactive' mode is similar to 'batch' mode except that we return the
451 compiled byte-code together with the ModIface and ModDetails.
453 Trying to compile a hs-boot file to byte-code will result in a run-time
454 error. This is the only thing that isn't caught by the type-system.
458 -- Status of a compilation to hard-code or nothing.
462 Bool -- Has stub files. This is a hack. We can't compile C files here
463 -- since it's done in DriverPipeline. For now we just return True
464 -- if we want the caller to compile them for us.
467 -- This is a bit ugly. Since we use a typeclass below and would like to avoid
468 -- functional dependencies, we have to parameterise the typeclass over the
469 -- result type. Therefore we need to artificially distinguish some types. We
470 -- do this by adding type tags which will simply be ignored by the caller.
471 type HscStatus = HscStatus' ()
472 type InteractiveStatus = HscStatus' (Maybe (CompiledByteCode, ModBreaks))
473 -- INVARIANT: result is @Nothing@ <=> input was a boot file
475 type OneShotResult = HscStatus
476 type BatchResult = (HscStatus, ModIface, ModDetails)
477 type NothingResult = (HscStatus, ModIface, ModDetails)
478 type InteractiveResult = (InteractiveStatus, ModIface, ModDetails)
480 -- FIXME: The old interface and module index are only using in 'batch' and
481 -- 'interactive' mode. They should be removed from 'oneshot' mode.
482 type Compiler result = HscEnv
484 -> Bool -- True <=> source unchanged
485 -> Maybe ModIface -- Old interface, if available
486 -> Maybe (Int,Int) -- Just (i,n) <=> module i of n (for msgs)
491 -- | Called when no recompilation is necessary.
492 hscNoRecomp :: ModIface
495 -- | Called to recompile the module.
496 hscRecompile :: ModSummary -> Maybe Fingerprint
499 hscBackend :: TcGblEnv -> ModSummary -> Maybe Fingerprint
502 -- | Code generation for Boot modules.
503 hscGenBootOutput :: TcGblEnv -> ModSummary -> Maybe Fingerprint
506 -- | Code generation for normal modules.
507 hscGenOutput :: ModGuts -> ModSummary -> Maybe Fingerprint
511 genericHscCompile :: HsCompiler a
512 -> (HscEnv -> Maybe (Int,Int) -> Bool -> ModSummary -> IO ())
513 -> HscEnv -> ModSummary -> Bool
514 -> Maybe ModIface -> Maybe (Int, Int)
516 genericHscCompile compiler hscMessage hsc_env
517 mod_summary source_unchanged
518 mb_old_iface0 mb_mod_index
520 (recomp_reqd, mb_checked_iface)
521 <- {-# SCC "checkOldIface" #-}
522 checkOldIface hsc_env mod_summary
523 source_unchanged mb_old_iface0
524 -- save the interface that comes back from checkOldIface.
525 -- In one-shot mode we don't have the old iface until this
526 -- point, when checkOldIface reads it from the disk.
527 let mb_old_hash = fmap mi_iface_hash mb_checked_iface
528 case mb_checked_iface of
529 Just iface | not recomp_reqd
530 -> do hscMessage hsc_env mb_mod_index False mod_summary
531 runHsc hsc_env $ hscNoRecomp compiler iface
533 -> do hscMessage hsc_env mb_mod_index True mod_summary
534 runHsc hsc_env $ hscRecompile compiler mod_summary mb_old_hash
536 hscCheckRecompBackend :: HsCompiler a -> TcGblEnv -> Compiler a
537 hscCheckRecompBackend compiler tc_result
538 hsc_env mod_summary source_unchanged mb_old_iface _m_of_n
540 (recomp_reqd, mb_checked_iface)
541 <- {-# SCC "checkOldIface" #-}
542 checkOldIface hsc_env mod_summary
543 source_unchanged mb_old_iface
545 let mb_old_hash = fmap mi_iface_hash mb_checked_iface
546 case mb_checked_iface of
547 Just iface | not recomp_reqd
550 iface{ mi_globals = Just (tcg_rdr_env tc_result) }
553 hscBackend compiler tc_result mod_summary mb_old_hash
555 genericHscRecompile :: HsCompiler a
556 -> ModSummary -> Maybe Fingerprint
558 genericHscRecompile compiler mod_summary mb_old_hash
559 | ExtCoreFile <- ms_hsc_src mod_summary =
560 panic "GHC does not currently support reading External Core files"
562 tc_result <- hscFileFrontEnd mod_summary
563 hscBackend compiler tc_result mod_summary mb_old_hash
565 genericHscBackend :: HsCompiler a
566 -> TcGblEnv -> ModSummary -> Maybe Fingerprint
568 genericHscBackend compiler tc_result mod_summary mb_old_hash
569 | HsBootFile <- ms_hsc_src mod_summary =
570 hscGenBootOutput compiler tc_result mod_summary mb_old_hash
572 guts <- hscDesugar' mod_summary tc_result
573 hscGenOutput compiler guts mod_summary mb_old_hash
575 compilerBackend :: HsCompiler a -> TcGblEnv -> Compiler a
576 compilerBackend comp tcg hsc_env ms' _ _mb_old_iface _ =
578 hscBackend comp tcg ms' Nothing
580 --------------------------------------------------------------
582 --------------------------------------------------------------
584 hscOneShotCompiler :: HsCompiler OneShotResult
588 hscNoRecomp = \_old_iface -> do
590 liftIO $ dumpIfaceStats hsc_env
593 , hscRecompile = genericHscRecompile hscOneShotCompiler
595 , hscBackend = \ tc_result mod_summary mb_old_hash -> do
596 dflags <- getDynFlags
597 case hscTarget dflags of
598 HscNothing -> return (HscRecomp False ())
599 _otherw -> genericHscBackend hscOneShotCompiler
600 tc_result mod_summary mb_old_hash
602 , hscGenBootOutput = \tc_result mod_summary mb_old_iface -> do
603 (iface, changed, _) <- hscSimpleIface tc_result mb_old_iface
604 hscWriteIface iface changed mod_summary
605 return (HscRecomp False ())
607 , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
608 guts <- hscSimplify' guts0
609 (iface, changed, _details, cgguts) <- hscNormalIface guts mb_old_iface
610 hscWriteIface iface changed mod_summary
611 hasStub <- hscGenHardCode cgguts mod_summary
612 return (HscRecomp hasStub ())
615 -- Compile Haskell, boot and extCore in OneShot mode.
616 hscCompileOneShot :: Compiler OneShotResult
617 hscCompileOneShot hsc_env mod_summary src_changed mb_old_iface mb_i_of_n
619 -- One-shot mode needs a knot-tying mutable variable for interface
620 -- files. See TcRnTypes.TcGblEnv.tcg_type_env_var.
621 type_env_var <- newIORef emptyNameEnv
623 mod = ms_mod mod_summary
624 hsc_env' = hsc_env{ hsc_type_env_var = Just (mod, type_env_var) }
626 genericHscCompile hscOneShotCompiler
627 oneShotMsg hsc_env' mod_summary src_changed
628 mb_old_iface mb_i_of_n
631 hscOneShotBackendOnly :: TcGblEnv -> Compiler OneShotResult
632 hscOneShotBackendOnly = compilerBackend hscOneShotCompiler
634 --------------------------------------------------------------
636 hscBatchCompiler :: HsCompiler BatchResult
640 hscNoRecomp = \iface -> do
641 details <- genModDetails iface
642 return (HscNoRecomp, iface, details)
644 , hscRecompile = genericHscRecompile hscBatchCompiler
646 , hscBackend = genericHscBackend hscBatchCompiler
648 , hscGenBootOutput = \tc_result mod_summary mb_old_iface -> do
649 (iface, changed, details) <- hscSimpleIface tc_result mb_old_iface
650 hscWriteIface iface changed mod_summary
651 return (HscRecomp False (), iface, details)
653 , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
654 guts <- hscSimplify' guts0
655 (iface, changed, details, cgguts) <- hscNormalIface guts mb_old_iface
656 hscWriteIface iface changed mod_summary
657 hasStub <- hscGenHardCode cgguts mod_summary
658 return (HscRecomp hasStub (), iface, details)
661 -- Compile Haskell, boot and extCore in batch mode.
662 hscCompileBatch :: Compiler (HscStatus, ModIface, ModDetails)
663 hscCompileBatch = genericHscCompile hscBatchCompiler batchMsg
665 hscBatchBackendOnly :: TcGblEnv -> Compiler BatchResult
666 hscBatchBackendOnly = hscCheckRecompBackend hscBatchCompiler
668 --------------------------------------------------------------
670 hscInteractiveCompiler :: HsCompiler InteractiveResult
671 hscInteractiveCompiler =
673 hscNoRecomp = \iface -> do
674 details <- genModDetails iface
675 return (HscNoRecomp, iface, details)
677 , hscRecompile = genericHscRecompile hscInteractiveCompiler
679 , hscBackend = genericHscBackend hscInteractiveCompiler
681 , hscGenBootOutput = \tc_result _mod_summary mb_old_iface -> do
682 (iface, _changed, details) <- hscSimpleIface tc_result mb_old_iface
683 return (HscRecomp False Nothing, iface, details)
685 , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
686 guts <- hscSimplify' guts0
687 (iface, _changed, details, cgguts) <- hscNormalIface guts mb_old_iface
688 hscInteractive (iface, details, cgguts) mod_summary
691 -- Compile Haskell, extCore to bytecode.
692 hscCompileInteractive :: Compiler (InteractiveStatus, ModIface, ModDetails)
693 hscCompileInteractive = genericHscCompile hscInteractiveCompiler batchMsg
695 hscInteractiveBackendOnly :: TcGblEnv -> Compiler InteractiveResult
696 hscInteractiveBackendOnly = compilerBackend hscInteractiveCompiler
698 --------------------------------------------------------------
700 hscNothingCompiler :: HsCompiler NothingResult
703 hscNoRecomp = \iface -> do
704 details <- genModDetails iface
705 return (HscNoRecomp, iface, details)
707 , hscRecompile = genericHscRecompile hscNothingCompiler
709 , hscBackend = \tc_result _mod_summary mb_old_iface -> do
711 (iface, _changed, details) <- hscSimpleIface tc_result mb_old_iface
712 return (HscRecomp False (), iface, details)
714 , hscGenBootOutput = \_ _ _ ->
715 panic "hscCompileNothing: hscGenBootOutput should not be called"
717 , hscGenOutput = \_ _ _ ->
718 panic "hscCompileNothing: hscGenOutput should not be called"
721 -- Type-check Haskell and .hs-boot only (no external core)
722 hscCompileNothing :: Compiler (HscStatus, ModIface, ModDetails)
723 hscCompileNothing = genericHscCompile hscNothingCompiler batchMsg
725 hscNothingBackendOnly :: TcGblEnv -> Compiler NothingResult
726 hscNothingBackendOnly = compilerBackend hscNothingCompiler
728 --------------------------------------------------------------
730 --------------------------------------------------------------
732 genModDetails :: ModIface -> Hsc ModDetails
733 genModDetails old_iface
736 new_details <- {-# SCC "tcRnIface" #-}
737 liftIO $ initIfaceCheck hsc_env $
738 typecheckIface old_iface
739 liftIO $ dumpIfaceStats hsc_env
742 --------------------------------------------------------------
743 -- Progress displayers.
744 --------------------------------------------------------------
746 oneShotMsg :: HscEnv -> Maybe (Int,Int) -> Bool -> ModSummary -> IO ()
747 oneShotMsg hsc_env _mb_mod_index recomp _mod_summary =
750 else compilationProgressMsg (hsc_dflags hsc_env) $
751 "compilation IS NOT required"
753 batchMsg :: HscEnv -> Maybe (Int,Int) -> Bool -> ModSummary -> IO ()
754 batchMsg hsc_env mb_mod_index recomp mod_summary
756 let showMsg msg = compilationProgressMsg (hsc_dflags hsc_env) $
757 (showModuleIndex mb_mod_index ++
758 msg ++ showModMsg (hscTarget (hsc_dflags hsc_env)) recomp mod_summary)
760 then showMsg "Compiling "
761 else if verbosity (hsc_dflags hsc_env) >= 2
762 then showMsg "Skipping "
765 --------------------------------------------------------------
767 --------------------------------------------------------------
769 hscFileFrontEnd :: ModSummary -> Hsc TcGblEnv
770 hscFileFrontEnd mod_summary =
771 do rdr_module <- hscParse' mod_summary
773 {-# SCC "Typecheck-Rename" #-}
775 tcRnModule hsc_env (ms_hsc_src mod_summary) False rdr_module
777 --------------------------------------------------------------
779 --------------------------------------------------------------
781 hscSimplify :: HscEnv -> ModGuts -> IO ModGuts
782 hscSimplify hsc_env modguts = runHsc hsc_env $ hscSimplify' modguts
784 hscSimplify' :: ModGuts -> Hsc ModGuts
785 hscSimplify' ds_result
786 = do hsc_env <- getHscEnv
787 {-# SCC "Core2Core" #-}
788 liftIO $ core2core hsc_env ds_result
790 --------------------------------------------------------------
791 -- Interface generators
792 --------------------------------------------------------------
794 hscSimpleIface :: TcGblEnv
796 -> Hsc (ModIface, Bool, ModDetails)
797 hscSimpleIface tc_result mb_old_iface
800 details <- liftIO $ mkBootModDetailsTc hsc_env tc_result
801 (new_iface, no_change)
802 <- {-# SCC "MkFinalIface" #-}
804 mkIfaceTc hsc_env mb_old_iface details tc_result
805 -- And the answer is ...
806 liftIO $ dumpIfaceStats hsc_env
807 return (new_iface, no_change, details)
809 hscNormalIface :: ModGuts
811 -> Hsc (ModIface, Bool, ModDetails, CgGuts)
812 hscNormalIface simpl_result mb_old_iface
815 (cg_guts, details) <- {-# SCC "CoreTidy" #-}
816 liftIO $ tidyProgram hsc_env simpl_result
818 -- BUILD THE NEW ModIface and ModDetails
819 -- and emit external core if necessary
820 -- This has to happen *after* code gen so that the back-end
821 -- info has been set. Not yet clear if it matters waiting
822 -- until after code output
823 (new_iface, no_change)
824 <- {-# SCC "MkFinalIface" #-}
826 mkIface hsc_env mb_old_iface details simpl_result
828 -- Emit external core
829 -- This should definitely be here and not after CorePrep,
830 -- because CorePrep produces unqualified constructor wrapper declarations,
831 -- so its output isn't valid External Core (without some preprocessing).
832 liftIO $ emitExternalCore (hsc_dflags hsc_env) cg_guts
833 liftIO $ dumpIfaceStats hsc_env
835 -- Return the prepared code.
836 return (new_iface, no_change, details, cg_guts)
838 --------------------------------------------------------------
839 -- BackEnd combinators
840 --------------------------------------------------------------
842 hscWriteIface :: ModIface
847 hscWriteIface iface no_change mod_summary
848 = do dflags <- getDynFlags
850 $ liftIO $ writeIfaceFile dflags (ms_location mod_summary) iface
852 -- | Compile to hard-code.
853 hscGenHardCode :: CgGuts -> ModSummary
854 -> Hsc Bool -- ^ @True@ <=> stub.c exists
855 hscGenHardCode cgguts mod_summary
859 let CgGuts{ -- This is the last use of the ModGuts in a compilation.
860 -- From now on, we just use the bits we need.
861 cg_module = this_mod,
862 cg_binds = core_binds,
864 cg_dir_imps = dir_imps,
865 cg_foreign = foreign_stubs,
866 cg_dep_pkgs = dependencies,
867 cg_hpc_info = hpc_info } = cgguts
868 dflags = hsc_dflags hsc_env
869 location = ms_location mod_summary
870 data_tycons = filter isDataTyCon tycons
871 -- cg_tycons includes newtypes, for the benefit of External Core,
872 -- but we don't generate any code for newtypes
875 -- PREPARE FOR CODE GENERATION
876 -- Do saturation and convert to A-normal form
877 prepd_binds <- {-# SCC "CorePrep" #-}
878 corePrepPgm dflags core_binds data_tycons ;
879 ----------------- Convert to STG ------------------
880 (stg_binds, cost_centre_info)
881 <- {-# SCC "CoreToStg" #-}
882 myCoreToStg dflags this_mod prepd_binds
884 ------------------ Code generation ------------------
886 cmms <- if dopt Opt_TryNewCodeGen dflags
887 then do cmms <- tryNewCodeGen hsc_env this_mod data_tycons
888 dir_imps cost_centre_info
891 else {-# SCC "CodeGen" #-}
892 codeGen dflags this_mod data_tycons
893 dir_imps cost_centre_info
896 --- Optionally run experimental Cmm transformations ---
897 -- cmms <- optionallyConvertAndOrCPS hsc_env cmms
898 -- unless certain dflags are on, the identity function
899 ------------------ Code output -----------------------
900 rawcmms <- cmmToRawCmm cmms
901 dumpIfSet_dyn dflags Opt_D_dump_cmmz "Raw Cmm" (ppr rawcmms)
902 (_stub_h_exists, stub_c_exists)
903 <- codeOutput dflags this_mod location foreign_stubs
907 hscInteractive :: (ModIface, ModDetails, CgGuts)
909 -> Hsc (InteractiveStatus, ModIface, ModDetails)
911 hscInteractive (iface, details, cgguts) mod_summary
913 dflags <- getDynFlags
914 let CgGuts{ -- This is the last use of the ModGuts in a compilation.
915 -- From now on, we just use the bits we need.
916 cg_module = this_mod,
917 cg_binds = core_binds,
919 cg_foreign = foreign_stubs,
920 cg_modBreaks = mod_breaks } = cgguts
922 location = ms_location mod_summary
923 data_tycons = filter isDataTyCon tycons
924 -- cg_tycons includes newtypes, for the benefit of External Core,
925 -- but we don't generate any code for newtypes
928 -- PREPARE FOR CODE GENERATION
929 -- Do saturation and convert to A-normal form
930 prepd_binds <- {-# SCC "CorePrep" #-}
931 liftIO $ corePrepPgm dflags core_binds data_tycons ;
932 ----------------- Generate byte code ------------------
933 comp_bc <- liftIO $ byteCodeGen dflags prepd_binds data_tycons mod_breaks
934 ------------------ Create f-x-dynamic C-side stuff ---
935 (_istub_h_exists, istub_c_exists)
936 <- liftIO $ outputForeignStubs dflags this_mod
937 location foreign_stubs
938 return (HscRecomp istub_c_exists (Just (comp_bc, mod_breaks))
941 hscInteractive _ _ = panic "GHC not compiled with interpreter"
944 ------------------------------
946 hscCompileCmmFile :: HscEnv -> FilePath -> IO ()
947 hscCompileCmmFile hsc_env filename
948 = runHsc hsc_env $ do
949 let dflags = hsc_dflags hsc_env
950 cmm <- ioMsgMaybe $ parseCmmFile dflags filename
952 cmms <- optionallyConvertAndOrCPS hsc_env [cmm]
953 rawCmms <- cmmToRawCmm cmms
954 _ <- codeOutput dflags no_mod no_loc NoStubs [] rawCmms
957 no_mod = panic "hscCmmFile: no_mod"
958 no_loc = ModLocation{ ml_hs_file = Just filename,
959 ml_hi_file = panic "hscCmmFile: no hi file",
960 ml_obj_file = panic "hscCmmFile: no obj file" }
962 -------------------- Stuff for new code gen ---------------------
964 tryNewCodeGen :: HscEnv -> Module -> [TyCon] -> [Module]
966 -> [(StgBinding,[(Id,[Id])])]
969 tryNewCodeGen hsc_env this_mod data_tycons imported_mods
970 cost_centre_info stg_binds hpc_info =
971 do { let dflags = hsc_dflags hsc_env
972 ; prog <- StgCmm.codeGen dflags this_mod data_tycons imported_mods
973 cost_centre_info stg_binds hpc_info
974 ; dumpIfSet_dyn dflags Opt_D_dump_cmmz "Cmm produced by new codegen"
977 ; prog <- return $ map (runTx $ runCmmOpts cmmCfgOptsZ) prog
978 -- Control flow optimisation
980 -- We are building a single SRT for the entire module, so
981 -- we must thread it through all the procedures as we cps-convert them.
982 ; us <- mkSplitUniqSupply 'S'
983 ; let topSRT = initUs_ us emptySRT
984 ; (topSRT, prog) <- foldM (protoCmmCPSZ hsc_env) (topSRT, []) prog
985 -- The main CPS conversion
987 ; prog <- return $ map (runTx $ runCmmOpts cmmCfgOptsZ) (srtToData topSRT : prog)
988 -- Control flow optimisation, again
990 ; let prog' = map cmmOfZgraph prog
991 ; dumpIfSet_dyn dflags Opt_D_dump_cmmz "Output Cmm" (ppr prog')
995 optionallyConvertAndOrCPS :: HscEnv -> [Cmm] -> IO [Cmm]
996 optionallyConvertAndOrCPS hsc_env cmms =
997 do let dflags = hsc_dflags hsc_env
998 -------- Optionally convert to and from zipper ------
999 cmms <- if dopt Opt_ConvertToZipCfgAndBack dflags
1000 then mapM (testCmmConversion hsc_env) cmms
1002 --------- Optionally convert to CPS (MDA) -----------
1003 cmms <- if not (dopt Opt_ConvertToZipCfgAndBack dflags) &&
1004 dopt Opt_RunCPS dflags
1005 then cmmCPS dflags cmms
1010 testCmmConversion :: HscEnv -> Cmm -> IO Cmm
1011 testCmmConversion hsc_env cmm =
1012 do let dflags = hsc_dflags hsc_env
1013 showPass dflags "CmmToCmm"
1014 dumpIfSet_dyn dflags Opt_D_dump_cvt_cmm "C-- pre-conversion" (ppr cmm)
1015 --continuationC <- cmmCPS dflags abstractC >>= cmmToRawCmm
1016 us <- mkSplitUniqSupply 'C'
1017 let cfopts = runTx $ runCmmOpts cmmCfgOptsZ
1018 let cvtm = do g <- cmmToZgraph cmm
1020 let zgraph = initUs_ us cvtm
1021 us <- mkSplitUniqSupply 'S'
1022 let topSRT = initUs_ us emptySRT
1023 (_, [cps_zgraph]) <- protoCmmCPSZ hsc_env (topSRT, []) zgraph
1024 let chosen_graph = if dopt Opt_RunCPSZ dflags then cps_zgraph else zgraph
1025 dumpIfSet_dyn dflags Opt_D_dump_cmmz "C-- Zipper Graph" (ppr chosen_graph)
1026 showPass dflags "Convert from Z back to Cmm"
1027 let cvt = cmmOfZgraph $ cfopts $ chosen_graph
1028 dumpIfSet_dyn dflags Opt_D_dump_cvt_cmm "C-- post-conversion" (ppr cvt)
1031 myCoreToStg :: DynFlags -> Module -> [CoreBind]
1032 -> IO ( [(StgBinding,[(Id,[Id])])] -- output program
1033 , CollectedCCs) -- cost centre info (declared and used)
1035 myCoreToStg dflags this_mod prepd_binds
1037 stg_binds <- {-# SCC "Core2Stg" #-}
1038 coreToStg (thisPackage dflags) prepd_binds
1040 (stg_binds2, cost_centre_info) <- {-# SCC "Stg2Stg" #-}
1041 stg2stg dflags this_mod stg_binds
1043 return (stg_binds2, cost_centre_info)
1047 %************************************************************************
1049 \subsection{Compiling a do-statement}
1051 %************************************************************************
1053 When the UnlinkedBCOExpr is linked you get an HValue of type
1055 When you run it you get a list of HValues that should be
1056 the same length as the list of names; add them to the ClosureEnv.
1058 A naked expression returns a singleton Name [it].
1060 What you type The IO [HValue] that hscStmt returns
1061 ------------- ------------------------------------
1062 let pat = expr ==> let pat = expr in return [coerce HVal x, coerce HVal y, ...]
1065 pat <- expr ==> expr >>= \ pat -> return [coerce HVal x, coerce HVal y, ...]
1068 expr (of IO type) ==> expr >>= \ v -> return [v]
1069 [NB: result not printed] bindings: [it]
1072 expr (of non-IO type,
1073 result showable) ==> let v = expr in print v >> return [v]
1076 expr (of non-IO type,
1077 result not showable) ==> error
1081 hscStmt -- Compile a stmt all the way to an HValue, but don't run it
1083 -> String -- The statement
1084 -> IO (Maybe ([Id], HValue))
1085 -- ^ 'Nothing' <==> empty statement (or comment only), but no parse error
1086 hscStmt hsc_env stmt = runHsc hsc_env $ do
1087 maybe_stmt <- hscParseStmt stmt
1089 Nothing -> return Nothing
1090 Just parsed_stmt -> do -- The real stuff
1092 -- Rename and typecheck it
1093 let icontext = hsc_IC hsc_env
1094 (ids, tc_expr) <- ioMsgMaybe $
1095 tcRnStmt hsc_env icontext parsed_stmt
1097 let rdr_env = ic_rn_gbl_env icontext
1098 type_env = mkTypeEnv (map AnId (ic_tmp_ids icontext))
1099 ds_expr <- ioMsgMaybe $
1100 deSugarExpr hsc_env iNTERACTIVE rdr_env type_env tc_expr
1103 -- Then desugar, code gen, and link it
1104 let src_span = srcLocSpan interactiveSrcLoc
1105 hsc_env <- getHscEnv
1106 hval <- liftIO $ hscCompileCoreExpr hsc_env src_span ds_expr
1108 return $ Just (ids, hval)
1110 hscImport :: HscEnv -> String -> IO (ImportDecl RdrName)
1111 hscImport hsc_env str = runHsc hsc_env $ do
1112 (L _ (HsModule{hsmodImports=is})) <-
1113 hscParseThing parseModule str
1115 [i] -> return (unLoc i)
1116 _ -> liftIO $ throwOneError $
1117 mkPlainErrMsg noSrcSpan $
1118 ptext (sLit "parse error in import declaration")
1120 hscTcExpr -- Typecheck an expression (but don't run it)
1122 -> String -- The expression
1125 hscTcExpr hsc_env expr = runHsc hsc_env $ do
1126 maybe_stmt <- hscParseStmt expr
1128 Just (L _ (ExprStmt expr _ _)) ->
1129 ioMsgMaybe $ tcRnExpr hsc_env (hsc_IC hsc_env) expr
1131 liftIO $ throwIO $ mkSrcErr $ unitBag $
1132 mkPlainErrMsg noSrcSpan
1133 (text "not an expression:" <+> quotes (text expr))
1135 -- | Find the kind of a type
1138 -> String -- ^ The type
1141 hscKcType hsc_env str = runHsc hsc_env $ do
1142 ty <- hscParseType str
1143 ioMsgMaybe $ tcRnType hsc_env (hsc_IC hsc_env) ty
1150 hscParseStmt :: String -> Hsc (Maybe (LStmt RdrName))
1151 hscParseStmt = hscParseThing parseStmt
1153 hscParseType :: String -> Hsc (LHsType RdrName)
1154 hscParseType = hscParseThing parseType
1157 hscParseIdentifier :: HscEnv -> String -> IO (Located RdrName)
1158 hscParseIdentifier hsc_env str = runHsc hsc_env $
1159 hscParseThing parseIdentifier str
1162 hscParseThing :: (Outputable thing)
1167 hscParseThing parser str
1168 = {-# SCC "Parser" #-} do
1169 dflags <- getDynFlags
1170 liftIO $ showPass dflags "Parser"
1172 let buf = stringToStringBuffer str
1173 loc = mkSrcLoc (fsLit "<interactive>") 1 1
1175 case unP parser (mkPState dflags buf loc) of
1177 PFailed span err -> do
1178 let msg = mkPlainErrMsg span err
1179 liftIO $ throwIO (mkSrcErr (unitBag msg))
1182 logWarningsReportErrors (getMessages pst)
1183 liftIO $ dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr thing)
1188 hscCompileCore :: HscEnv
1194 hscCompileCore hsc_env simplify mod_summary binds
1195 = runHsc hsc_env $ do
1196 let maybe_simplify mod_guts | simplify = hscSimplify' mod_guts
1197 | otherwise = return mod_guts
1198 guts <- maybe_simplify (mkModGuts (ms_mod mod_summary) binds)
1199 (iface, changed, _details, cgguts) <- hscNormalIface guts Nothing
1200 hscWriteIface iface changed mod_summary
1201 _ <- hscGenHardCode cgguts mod_summary
1204 -- Makes a "vanilla" ModGuts.
1205 mkModGuts :: Module -> [CoreBind] -> ModGuts
1206 mkModGuts mod binds = ModGuts {
1210 mg_deps = noDependencies,
1211 mg_dir_imps = emptyModuleEnv,
1212 mg_used_names = emptyNameSet,
1213 mg_rdr_env = emptyGlobalRdrEnv,
1214 mg_fix_env = emptyFixityEnv,
1215 mg_types = emptyTypeEnv,
1220 mg_foreign = NoStubs,
1221 mg_warns = NoWarnings,
1223 mg_hpc_info = emptyHpcInfo False,
1224 mg_modBreaks = emptyModBreaks,
1225 mg_vect_info = noVectInfo,
1226 mg_inst_env = emptyInstEnv,
1227 mg_fam_inst_env = emptyFamInstEnv
1231 %************************************************************************
1233 Desugar, simplify, convert to bytecode, and link an expression
1235 %************************************************************************
1239 hscCompileCoreExpr :: HscEnv -> SrcSpan -> CoreExpr -> IO HValue
1240 hscCompileCoreExpr hsc_env srcspan ds_expr
1242 = throwIO (InstallationError "You can't call hscCompileCoreExpr in a profiled compiler")
1243 -- Otherwise you get a seg-fault when you run it
1246 let dflags = hsc_dflags hsc_env
1247 let lint_on = dopt Opt_DoCoreLinting dflags
1250 simpl_expr <- simplifyExpr dflags ds_expr
1252 -- Tidy it (temporary, until coreSat does cloning)
1253 let tidy_expr = tidyExpr emptyTidyEnv simpl_expr
1255 -- Prepare for codegen
1256 prepd_expr <- corePrepExpr dflags tidy_expr
1258 -- Lint if necessary
1259 -- ToDo: improve SrcLoc
1261 let ictxt = hsc_IC hsc_env
1262 tyvars = varSetElems (tyVarsOfTypes (map idType (ic_tmp_ids ictxt)))
1264 case lintUnfolding noSrcLoc tyvars prepd_expr of
1265 Just err -> pprPanic "hscCompileCoreExpr" err
1266 Nothing -> return ()
1271 bcos <- coreExprToBCOs dflags prepd_expr
1274 hval <- linkExpr hsc_env srcspan bcos
1281 %************************************************************************
1283 Statistics on reading interfaces
1285 %************************************************************************
1288 dumpIfaceStats :: HscEnv -> IO ()
1289 dumpIfaceStats hsc_env
1290 = do { eps <- readIORef (hsc_EPS hsc_env)
1291 ; dumpIfSet (dump_if_trace || dump_rn_stats)
1292 "Interface statistics"
1295 dflags = hsc_dflags hsc_env
1296 dump_rn_stats = dopt Opt_D_dump_rn_stats dflags
1297 dump_if_trace = dopt Opt_D_dump_if_trace dflags
1300 %************************************************************************
1302 Progress Messages: Module i of n
1304 %************************************************************************
1307 showModuleIndex :: Maybe (Int, Int) -> String
1308 showModuleIndex Nothing = ""
1309 showModuleIndex (Just (i,n)) = "[" ++ padded ++ " of " ++ n_str ++ "] "
1313 padded = replicate (length n_str - length i_str) ' ' ++ i_str