%
% (c) The GRASP/AQUA Project, Glasgow University, 1993-2000
%
-
-\section[GHC_Main]{Main driver for Glasgow Haskell compiler}
-
\begin{code}
+-- | Main API for compiling plain Haskell source code.
+--
+-- This module implements compilation of a Haskell source. It is
+-- /not/ concerned with preprocessing of source files; this is handled
+-- in "DriverPipeline".
+--
+-- There are various entry points depending on what mode we're in:
+-- "batch" mode (@--make@), "one-shot" mode (@-c@, @-S@ etc.), and
+-- "interactive" mode (GHCi). There are also entry points for
+-- individual passes: parsing, typechecking/renaming, desugaring, and
+-- simplification.
+--
+-- All the functions here take an 'HscEnv' as a parameter, but none of
+-- them return a new one: 'HscEnv' is treated as an immutable value
+-- from here on in (although it has mutable components, for the
+-- caches).
+--
+-- Warning messages are dealt with consistently throughout this API:
+-- during compilation warnings are collected, and before any function
+-- in @HscMain@ returns, the warnings are either printed, or turned
+-- into a real compialtion error if the @-Werror@ flag is enabled.
+--
module HscMain
- ( newHscEnv, hscCmmFile
+ (
+ -- * Making an HscEnv
+ newHscEnv
+
+ -- * Compiling complete source files
+ , Compiler
+ , HscStatus' (..)
+ , InteractiveStatus, HscStatus
+ , hscCompileOneShot
+ , hscCompileBatch
+ , hscCompileNothing
+ , hscCompileInteractive
+ , hscCompileCmmFile
+ , hscCompileCore
+
+ -- * Running passes separately
+ , hscParse
+ , hscTypecheckRename
+ , hscDesugar
+ , makeSimpleIface
+ , makeSimpleDetails
+ , hscSimplify -- ToDo, shouldn't really export this
+
+ -- ** Backends
+ , hscOneShotBackendOnly
+ , hscBatchBackendOnly
+ , hscNothingBackendOnly
+ , hscInteractiveBackendOnly
+
+ -- * Support for interactive evaluation
, hscParseIdentifier
+ , hscTcRcLookupName
+ , hscTcRnGetInfo
#ifdef GHCI
- , hscStmt, hscTcExpr, hscKcType
- , compileExpr
+ , hscRnImportDecls
+ , hscGetModuleExports
+ , hscTcRnLookupRdrName
+ , hscStmt, hscStmtWithLocation
+ , hscTcExpr, hscImport, hscKcType
+ , hscCompileCoreExpr
#endif
- , hscCompileOneShot -- :: Compiler HscStatus
- , hscCompileBatch -- :: Compiler (HscStatus, ModIface, ModDetails)
- , hscCompileNothing -- :: Compiler (HscStatus, ModIface, ModDetails)
- , hscCompileInteractive -- :: Compiler (InteractiveStatus, ModIface, ModDetails)
- , HscStatus (..)
- , InteractiveStatus (..)
-
- -- The new interface
- , parseFile
- , typecheckModule
- , typecheckRenameModule
- , deSugarModule
- , makeSimpleIface
- , makeSimpleDetails
- ) where
-#include "HsVersions.h"
+ ) where
#ifdef GHCI
-import CodeOutput ( outputForeignStubs )
import ByteCodeGen ( byteCodeGen, coreExprToBCOs )
import Linker ( HValue, linkExpr )
import CoreTidy ( tidyExpr )
-import CorePrep ( corePrepExpr )
-import Flattening ( flattenExpr )
-import Desugar ( deSugarExpr )
-import SimplCore ( simplifyExpr )
-import TcRnDriver ( tcRnStmt, tcRnExpr, tcRnType )
import Type ( Type )
+import TcType ( tyVarsOfTypes )
import PrelNames ( iNTERACTIVE )
import {- Kind parts of -} Type ( Kind )
+import Id ( idType )
import CoreLint ( lintUnfolding )
import DsMeta ( templateHaskellNames )
-import SrcLoc ( SrcSpan, noSrcLoc, interactiveSrcLoc, srcLocSpan )
import VarSet
import VarEnv ( emptyTidyEnv )
+import Panic
#endif
-import Var ( Id )
+import Id ( Id )
import Module ( emptyModuleEnv, ModLocation(..), Module )
import RdrName
import HsSyn
import CoreSyn
-import SrcLoc ( Located(..) )
import StringBuffer
import Parser
-import Lexer
-import SrcLoc ( mkSrcLoc )
-import TcRnDriver ( tcRnModule, tcRnExtCore )
+import Lexer hiding (getDynFlags)
+import SrcLoc
+import TcRnDriver
import TcIface ( typecheckIface )
-import TcRnMonad ( initIfaceCheck, TcGblEnv(..) )
+import TcRnMonad
import IfaceEnv ( initNameCache )
import LoadIface ( ifaceStats, initExternalPackageState )
import PrelInfo ( wiredInThings, basicKnownKeyNames )
import MkIface
-import Desugar ( deSugar )
-import SimplCore ( core2core )
+import Desugar
+import SimplCore
import TidyPgm
-import CorePrep ( corePrepPgm )
+import CorePrep
import CoreToStg ( coreToStg )
+import qualified StgCmm ( codeGen )
import StgSyn
import CostCentre
-import TyCon ( isDataTyCon )
+import ProfInit
+import TyCon ( TyCon, isDataTyCon )
import Name ( Name, NamedThing(..) )
import SimplStg ( stg2stg )
import CodeGen ( codeGen )
-import Cmm ( Cmm )
+import OldCmm ( Cmm )
+import PprCmm ( pprCmms )
import CmmParse ( parseCmmFile )
-import CmmCPS
-import CmmCPSZ
+import CmmBuildInfoTables
+import CmmPipeline
import CmmInfo
+import OptimizationFuel ( initOptFuelState )
import CmmCvt
-import CmmTx
-import CmmContFlowOpt
-import CodeOutput ( codeOutput )
+import CmmContFlowOpt ( runCmmContFlowOpts )
+import CodeOutput
import NameEnv ( emptyNameEnv )
+import NameSet ( emptyNameSet )
+import InstEnv
+import FamInstEnv ( emptyFamInstEnv )
+import Fingerprint ( Fingerprint )
import DynFlags
import ErrUtils
import HscStats ( ppSourceStats )
import HscTypes
import MkExternalCore ( emitExternalCore )
-import ParserCore
-import ParserCoreUtils
import FastString
import UniqFM ( emptyUFM )
import UniqSupply ( initUs_ )
-import Bag ( unitBag )
+import Bag
+import Exception
+-- import MonadUtils
import Control.Monad
-import System.Exit
-import System.IO
+-- import System.IO
import Data.IORef
\end{code}
+#include "HsVersions.h"
%************************************************************************
newHscEnv :: DynFlags -> IO HscEnv
newHscEnv dflags
= do { eps_var <- newIORef initExternalPackageState
- ; us <- mkSplitUniqSupply 'r'
- ; nc_var <- newIORef (initNameCache us knownKeyNames)
- ; fc_var <- newIORef emptyUFM
- ; mlc_var <- newIORef emptyModuleEnv
+ ; us <- mkSplitUniqSupply 'r'
+ ; nc_var <- newIORef (initNameCache us knownKeyNames)
+ ; fc_var <- newIORef emptyUFM
+ ; mlc_var <- newIORef emptyModuleEnv
+ ; optFuel <- initOptFuelState
; return (HscEnv { hsc_dflags = dflags,
hsc_targets = [],
hsc_mod_graph = [],
- hsc_IC = emptyInteractiveContext,
- hsc_HPT = emptyHomePackageTable,
- hsc_EPS = eps_var,
- hsc_NC = nc_var,
- hsc_FC = fc_var,
- hsc_MLC = mlc_var,
- hsc_global_rdr_env = emptyGlobalRdrEnv,
- hsc_global_type_env = emptyNameEnv } ) }
-
-
-knownKeyNames :: [Name] -- Put here to avoid loops involving DsMeta,
- -- where templateHaskellNames are defined
-knownKeyNames = map getName wiredInThings
- ++ basicKnownKeyNames
+ hsc_IC = emptyInteractiveContext,
+ hsc_HPT = emptyHomePackageTable,
+ hsc_EPS = eps_var,
+ hsc_NC = nc_var,
+ hsc_FC = fc_var,
+ hsc_MLC = mlc_var,
+ hsc_OptFuel = optFuel,
+ hsc_type_env_var = Nothing } ) }
+
+
+knownKeyNames :: [Name] -- Put here to avoid loops involving DsMeta,
+ -- where templateHaskellNames are defined
+knownKeyNames
+ = map getName wiredInThings
+ ++ basicKnownKeyNames
#ifdef GHCI
- ++ templateHaskellNames
+ ++ templateHaskellNames
#endif
-\end{code}
+-- -----------------------------------------------------------------------------
+-- The Hsc monad: collecting warnings
+
+newtype Hsc a = Hsc (HscEnv -> WarningMessages -> IO (a, WarningMessages))
+
+instance Monad Hsc where
+ return a = Hsc $ \_ w -> return (a, w)
+ Hsc m >>= k = Hsc $ \e w -> do (a, w1) <- m e w
+ case k a of
+ Hsc k' -> k' e w1
+
+instance MonadIO Hsc where
+ liftIO io = Hsc $ \_ w -> do a <- io; return (a, w)
+
+runHsc :: HscEnv -> Hsc a -> IO a
+runHsc hsc_env (Hsc hsc) = do
+ (a, w) <- hsc hsc_env emptyBag
+ printOrThrowWarnings (hsc_dflags hsc_env) w
+ return a
+
+getWarnings :: Hsc WarningMessages
+getWarnings = Hsc $ \_ w -> return (w, w)
+
+clearWarnings :: Hsc ()
+clearWarnings = Hsc $ \_ _w -> return ((), emptyBag)
+
+logWarnings :: WarningMessages -> Hsc ()
+logWarnings w = Hsc $ \_ w0 -> return ((), w0 `unionBags` w)
+
+getHscEnv :: Hsc HscEnv
+getHscEnv = Hsc $ \e w -> return (e, w)
+
+getDynFlags :: Hsc DynFlags
+getDynFlags = Hsc $ \e w -> return (hsc_dflags e, w)
+
+handleWarnings :: Hsc ()
+handleWarnings = do
+ dflags <- getDynFlags
+ w <- getWarnings
+ liftIO $ printOrThrowWarnings dflags w
+ clearWarnings
+
+-- | log warning in the monad, and if there are errors then
+-- throw a SourceError exception.
+logWarningsReportErrors :: Messages -> Hsc ()
+logWarningsReportErrors (warns,errs) = do
+ logWarnings warns
+ when (not (isEmptyBag errs)) $ do
+ liftIO $ throwIO $ mkSrcErr errs
+
+-- | Deal with errors and warnings returned by a compilation step
+--
+-- In order to reduce dependencies to other parts of the compiler, functions
+-- outside the "main" parts of GHC return warnings and errors as a parameter
+-- and signal success via by wrapping the result in a 'Maybe' type. This
+-- function logs the returned warnings and propagates errors as exceptions
+-- (of type 'SourceError').
+--
+-- This function assumes the following invariants:
+--
+-- 1. If the second result indicates success (is of the form 'Just x'),
+-- there must be no error messages in the first result.
+--
+-- 2. If there are no error messages, but the second result indicates failure
+-- there should be warnings in the first result. That is, if the action
+-- failed, it must have been due to the warnings (i.e., @-Werror@).
+ioMsgMaybe :: IO (Messages, Maybe a) -> Hsc a
+ioMsgMaybe ioA = do
+ ((warns,errs), mb_r) <- liftIO $ ioA
+ logWarnings warns
+ case mb_r of
+ Nothing -> liftIO $ throwIO (mkSrcErr errs)
+ Just r -> ASSERT( isEmptyBag errs ) return r
+
+-- | like ioMsgMaybe, except that we ignore error messages and return
+-- 'Nothing' instead.
+ioMsgMaybe' :: IO (Messages, Maybe a) -> Hsc (Maybe a)
+ioMsgMaybe' ioA = do
+ ((warns,_errs), mb_r) <- liftIO $ ioA
+ logWarnings warns
+ return mb_r
+
+-- -----------------------------------------------------------------------------
+-- | Lookup things in the compiler's environment
-\begin{code}
+#ifdef GHCI
+hscTcRnLookupRdrName :: HscEnv -> RdrName -> IO [Name]
+hscTcRnLookupRdrName hsc_env rdr_name =
+ runHsc hsc_env $ ioMsgMaybe $ tcRnLookupRdrName hsc_env rdr_name
+#endif
+
+hscTcRcLookupName :: HscEnv -> Name -> IO (Maybe TyThing)
+hscTcRcLookupName hsc_env name =
+ runHsc hsc_env $ ioMsgMaybe' $ tcRnLookupName hsc_env name
+ -- ignore errors: the only error we're likely to get is
+ -- "name not found", and the Maybe in the return type
+ -- is used to indicate that.
+
+hscTcRnGetInfo :: HscEnv -> Name -> IO (Maybe (TyThing, Fixity, [Instance]))
+hscTcRnGetInfo hsc_env name =
+ runHsc hsc_env $ ioMsgMaybe' $ tcRnGetInfo hsc_env name
+
+#ifdef GHCI
+hscGetModuleExports :: HscEnv -> Module -> IO (Maybe [AvailInfo])
+hscGetModuleExports hsc_env mdl =
+ runHsc hsc_env $ ioMsgMaybe' $ getModuleExports hsc_env mdl
+
+-- -----------------------------------------------------------------------------
+-- | Rename some import declarations
+
+hscRnImportDecls
+ :: HscEnv
+ -> Module
+ -> [LImportDecl RdrName]
+ -> IO GlobalRdrEnv
+
+-- It is important that we use tcRnImports instead of calling rnImports directly
+-- because tcRnImports will force-load any orphan modules necessary, making extra
+-- instances/family instances visible (GHC #4832)
+hscRnImportDecls hsc_env this_mod import_decls
+ = runHsc hsc_env $ ioMsgMaybe $ initTc hsc_env HsSrcFile False this_mod $
+ fmap tcg_rdr_env $ tcRnImports hsc_env this_mod import_decls
+
+#endif
+
+-- -----------------------------------------------------------------------------
-- | parse a file, returning the abstract syntax
-parseFile :: HscEnv -> ModSummary -> IO (Maybe (Located (HsModule RdrName)))
-parseFile hsc_env mod_summary
- = do
- maybe_parsed <- myParseModule dflags hspp_file hspp_buf
- case maybe_parsed of
- Left err
- -> do printBagOfErrors dflags (unitBag err)
- return Nothing
- Right rdr_module
- -> return (Just rdr_module)
- where
- dflags = hsc_dflags hsc_env
- hspp_file = ms_hspp_file mod_summary
- hspp_buf = ms_hspp_buf mod_summary
-
--- | Rename and typecheck a module
-typecheckModule :: HscEnv -> ModSummary -> Located (HsModule RdrName)
- -> IO (Maybe TcGblEnv)
-typecheckModule hsc_env mod_summary rdr_module
- = do
- (tc_msgs, maybe_tc_result)
- <- {-# SCC "Typecheck-Rename" #-}
- tcRnModule hsc_env (ms_hsc_src mod_summary) False rdr_module
- printErrorsAndWarnings dflags tc_msgs
- return maybe_tc_result
- where
- dflags = hsc_dflags hsc_env
+hscParse :: HscEnv -> ModSummary -> IO (Located (HsModule RdrName))
+hscParse hsc_env mod_summary = runHsc hsc_env $ hscParse' mod_summary
+
+-- internal version, that doesn't fail due to -Werror
+hscParse' :: ModSummary -> Hsc (Located (HsModule RdrName))
+hscParse' mod_summary
+ = do
+ dflags <- getDynFlags
+ let
+ src_filename = ms_hspp_file mod_summary
+ maybe_src_buf = ms_hspp_buf mod_summary
+
+ -------------------------- Parser ----------------
+ liftIO $ showPass dflags "Parser"
+ {-# SCC "Parser" #-} do
+
+ -- sometimes we already have the buffer in memory, perhaps
+ -- because we needed to parse the imports out of it, or get the
+ -- module name.
+ buf <- case maybe_src_buf of
+ Just b -> return b
+ Nothing -> liftIO $ hGetStringBuffer src_filename
+
+ let loc = mkRealSrcLoc (mkFastString src_filename) 1 1
+
+ case unP parseModule (mkPState dflags buf loc) of
+ PFailed span err ->
+ liftIO $ throwOneError (mkPlainErrMsg span err)
+
+ POk pst rdr_module -> do
+ logWarningsReportErrors (getMessages pst)
+ liftIO $ dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" $
+ ppr rdr_module
+ liftIO $ dumpIfSet_dyn dflags Opt_D_source_stats "Source Statistics" $
+ ppSourceStats False rdr_module
+ return rdr_module
+ -- ToDo: free the string buffer later.
+
+-- XXX: should this really be a Maybe X? Check under which circumstances this
+-- can become a Nothing and decide whether this should instead throw an
+-- exception/signal an error.
type RenamedStuff =
(Maybe (HsGroup Name, [LImportDecl Name], Maybe [LIE Name],
- Maybe (HsDoc Name), HaddockModInfo Name))
-
--- | Rename and typecheck a module, additinoally returning the renamed syntax
-typecheckRenameModule :: HscEnv -> ModSummary -> Located (HsModule RdrName)
- -> IO (Maybe (TcGblEnv, RenamedStuff))
-typecheckRenameModule hsc_env mod_summary rdr_module
- = do
- (tc_msgs, maybe_tc_result)
- <- {-# SCC "Typecheck-Rename" #-}
- tcRnModule hsc_env (ms_hsc_src mod_summary) True rdr_module
- printErrorsAndWarnings dflags tc_msgs
- case maybe_tc_result of
- Nothing -> return Nothing
- Just tc_result -> do
- let rn_info = do decl <- tcg_rn_decls tc_result
- imports <- tcg_rn_imports tc_result
- let exports = tcg_rn_exports tc_result
- let doc = tcg_doc tc_result
- let hmi = tcg_hmi tc_result
- return (decl,imports,exports,doc,hmi)
- return (Just (tc_result, rn_info))
- where
- dflags = hsc_dflags hsc_env
+ Maybe LHsDocString))
+
+-- | Rename and typecheck a module, additionally returning the renamed syntax
+hscTypecheckRename :: HscEnv -> ModSummary -> Located (HsModule RdrName)
+ -> IO (TcGblEnv, RenamedStuff)
+hscTypecheckRename hsc_env mod_summary rdr_module
+ = runHsc hsc_env $ do
+ tc_result
+ <- {-# SCC "Typecheck-Rename" #-}
+ ioMsgMaybe $
+ tcRnModule hsc_env (ms_hsc_src mod_summary) True rdr_module
+
+ let -- This 'do' is in the Maybe monad!
+ rn_info = do decl <- tcg_rn_decls tc_result
+ let imports = tcg_rn_imports tc_result
+ exports = tcg_rn_exports tc_result
+ doc_hdr = tcg_doc_hdr tc_result
+ return (decl,imports,exports,doc_hdr)
+
+ return (tc_result, rn_info)
-- | Convert a typechecked module to Core
-deSugarModule :: HscEnv -> ModSummary -> TcGblEnv -> IO (Maybe ModGuts)
-deSugarModule hsc_env mod_summary tc_result
- = deSugar hsc_env (ms_location mod_summary) tc_result
+hscDesugar :: HscEnv -> ModSummary -> TcGblEnv -> IO ModGuts
+hscDesugar hsc_env mod_summary tc_result
+ = runHsc hsc_env $ hscDesugar' mod_summary tc_result
+
+hscDesugar' :: ModSummary -> TcGblEnv -> Hsc ModGuts
+hscDesugar' mod_summary tc_result
+ = do
+ hsc_env <- getHscEnv
+ r <- ioMsgMaybe $
+ deSugar hsc_env (ms_location mod_summary) tc_result
+
+ handleWarnings
+ -- always check -Werror after desugaring, this is
+ -- the last opportunity for warnings to arise before
+ -- the backend.
+ return r
-- | Make a 'ModIface' from the results of typechecking. Used when
-- not optimising, and the interface doesn't need to contain any
-- unfoldings or other cross-module optimisation info.
-- ToDo: the old interface is only needed to get the version numbers,
-- we should use fingerprint versions instead.
-makeSimpleIface :: HscEnv -> Maybe ModIface -> TcGblEnv -> ModDetails
+makeSimpleIface :: HscEnv ->
+ Maybe ModIface -> TcGblEnv -> ModDetails
-> IO (ModIface,Bool)
-makeSimpleIface hsc_env maybe_old_iface tc_result details = do
- mkIfaceTc hsc_env maybe_old_iface details tc_result
+makeSimpleIface hsc_env maybe_old_iface tc_result details
+ = runHsc hsc_env $
+ ioMsgMaybe $
+ mkIfaceTc hsc_env (fmap mi_iface_hash maybe_old_iface) details tc_result
-- | Make a 'ModDetails' from the results of typechecking. Used when
-- typechecking only, as opposed to full compilation.
makeSimpleDetails :: HscEnv -> TcGblEnv -> IO ModDetails
makeSimpleDetails hsc_env tc_result = mkBootModDetailsTc hsc_env tc_result
-
--- deSugarModule :: HscEnv -> TcGblEnv -> IO Core
\end{code}
%************************************************************************
It's the task of the compilation proper to compile Haskell, hs-boot and
-core files to either byte-code, hard-code (C, asm, Java, ect) or to
+core files to either byte-code, hard-code (C, asm, LLVM, ect) or to
nothing at all (the module is still parsed and type-checked. This
feature is mostly used by IDE's and the likes).
Compilation can happen in either 'one-shot', 'batch', 'nothing',
\begin{code}
-- Status of a compilation to hard-code or nothing.
-data HscStatus
+data HscStatus' a
= HscNoRecomp
- | HscRecomp Bool -- Has stub files.
- -- This is a hack. We can't compile C files here
- -- since it's done in DriverPipeline. For now we
- -- just return True if we want the caller to compile
- -- them for us.
-
--- Status of a compilation to byte-code.
-data InteractiveStatus
- = InteractiveNoRecomp
- | InteractiveRecomp Bool -- Same as HscStatus
- CompiledByteCode
- ModBreaks
-
-
--- I want Control.Monad.State! --Lemmih 03/07/2006
-newtype Comp a = Comp {runComp :: CompState -> IO (a, CompState)}
-
-instance Monad Comp where
- g >>= fn = Comp $ \s -> runComp g s >>= \(a,s') -> runComp (fn a) s'
- return a = Comp $ \s -> return (a,s)
- fail = error
-
-evalComp :: Comp a -> CompState -> IO a
-evalComp comp st = do (val,_st') <- runComp comp st
- return val
-
-data CompState
- = CompState
- { compHscEnv :: HscEnv
- , compModSummary :: ModSummary
- , compOldIface :: Maybe ModIface
- }
-
-get :: Comp CompState
-get = Comp $ \s -> return (s,s)
-
-modify :: (CompState -> CompState) -> Comp ()
-modify f = Comp $ \s -> return ((), f s)
-
-gets :: (CompState -> a) -> Comp a
-gets getter = do st <- get
- return (getter st)
-
-liftIO :: IO a -> Comp a
-liftIO ioA = Comp $ \s -> do a <- ioA
- return (a,s)
-
-type NoRecomp result = ModIface -> Comp result
+ | HscRecomp
+ (Maybe FilePath)
+ -- Has stub files. This is a hack. We can't compile C files here
+ -- since it's done in DriverPipeline. For now we just return True
+ -- if we want the caller to compile them for us.
+ a
+
+-- This is a bit ugly. Since we use a typeclass below and would like to avoid
+-- functional dependencies, we have to parameterise the typeclass over the
+-- result type. Therefore we need to artificially distinguish some types. We
+-- do this by adding type tags which will simply be ignored by the caller.
+type HscStatus = HscStatus' ()
+type InteractiveStatus = HscStatus' (Maybe (CompiledByteCode, ModBreaks))
+ -- INVARIANT: result is @Nothing@ <=> input was a boot file
+
+type OneShotResult = HscStatus
+type BatchResult = (HscStatus, ModIface, ModDetails)
+type NothingResult = (HscStatus, ModIface, ModDetails)
+type InteractiveResult = (InteractiveStatus, ModIface, ModDetails)
-- FIXME: The old interface and module index are only using in 'batch' and
-- 'interactive' mode. They should be removed from 'oneshot' mode.
-> Bool -- True <=> source unchanged
-> Maybe ModIface -- Old interface, if available
-> Maybe (Int,Int) -- Just (i,n) <=> module i of n (for msgs)
- -> IO (Maybe result)
+ -> IO result
+
+data HsCompiler a
+ = HsCompiler {
+ -- | Called when no recompilation is necessary.
+ hscNoRecomp :: ModIface
+ -> Hsc a,
+
+ -- | Called to recompile the module.
+ hscRecompile :: ModSummary -> Maybe Fingerprint
+ -> Hsc a,
+
+ hscBackend :: TcGblEnv -> ModSummary -> Maybe Fingerprint
+ -> Hsc a,
+
+ -- | Code generation for Boot modules.
+ hscGenBootOutput :: TcGblEnv -> ModSummary -> Maybe Fingerprint
+ -> Hsc a,
+
+ -- | Code generation for normal modules.
+ hscGenOutput :: ModGuts -> ModSummary -> Maybe Fingerprint
+ -> Hsc a
+ }
+
+genericHscCompile :: HsCompiler a
+ -> (HscEnv -> Maybe (Int,Int) -> Bool -> ModSummary -> IO ())
+ -> HscEnv -> ModSummary -> Bool
+ -> Maybe ModIface -> Maybe (Int, Int)
+ -> IO a
+genericHscCompile compiler hscMessage hsc_env
+ mod_summary source_unchanged
+ mb_old_iface0 mb_mod_index
+ = do
+ (recomp_reqd, mb_checked_iface)
+ <- {-# SCC "checkOldIface" #-}
+ checkOldIface hsc_env mod_summary
+ source_unchanged mb_old_iface0
+ -- save the interface that comes back from checkOldIface.
+ -- In one-shot mode we don't have the old iface until this
+ -- point, when checkOldIface reads it from the disk.
+ let mb_old_hash = fmap mi_iface_hash mb_checked_iface
+ case mb_checked_iface of
+ Just iface | not recomp_reqd
+ -> do hscMessage hsc_env mb_mod_index False mod_summary
+ runHsc hsc_env $ hscNoRecomp compiler iface
+ _otherwise
+ -> do hscMessage hsc_env mb_mod_index True mod_summary
+ runHsc hsc_env $ hscRecompile compiler mod_summary mb_old_hash
+
+hscCheckRecompBackend :: HsCompiler a -> TcGblEnv -> Compiler a
+hscCheckRecompBackend compiler tc_result
+ hsc_env mod_summary source_unchanged mb_old_iface _m_of_n
+ = do
+ (recomp_reqd, mb_checked_iface)
+ <- {-# SCC "checkOldIface" #-}
+ checkOldIface hsc_env mod_summary
+ source_unchanged mb_old_iface
+
+ let mb_old_hash = fmap mi_iface_hash mb_checked_iface
+ case mb_checked_iface of
+ Just iface | not recomp_reqd
+ -> runHsc hsc_env $
+ hscNoRecomp compiler
+ iface{ mi_globals = Just (tcg_rdr_env tc_result) }
+ _otherwise
+ -> runHsc hsc_env $
+ hscBackend compiler tc_result mod_summary mb_old_hash
+
+genericHscRecompile :: HsCompiler a
+ -> ModSummary -> Maybe Fingerprint
+ -> Hsc a
+genericHscRecompile compiler mod_summary mb_old_hash
+ | ExtCoreFile <- ms_hsc_src mod_summary =
+ panic "GHC does not currently support reading External Core files"
+ | otherwise = do
+ tc_result <- hscFileFrontEnd mod_summary
+ hscBackend compiler tc_result mod_summary mb_old_hash
+
+genericHscBackend :: HsCompiler a
+ -> TcGblEnv -> ModSummary -> Maybe Fingerprint
+ -> Hsc a
+genericHscBackend compiler tc_result mod_summary mb_old_hash
+ | HsBootFile <- ms_hsc_src mod_summary =
+ hscGenBootOutput compiler tc_result mod_summary mb_old_hash
+ | otherwise = do
+ guts <- hscDesugar' mod_summary tc_result
+ hscGenOutput compiler guts mod_summary mb_old_hash
+
+compilerBackend :: HsCompiler a -> TcGblEnv -> Compiler a
+compilerBackend comp tcg hsc_env ms' _ _mb_old_iface _ =
+ runHsc hsc_env $
+ hscBackend comp tcg ms' Nothing
--------------------------------------------------------------
-- Compilers
--------------------------------------------------------------
+hscOneShotCompiler :: HsCompiler OneShotResult
+hscOneShotCompiler =
+ HsCompiler {
+
+ hscNoRecomp = \_old_iface -> do
+ hsc_env <- getHscEnv
+ liftIO $ dumpIfaceStats hsc_env
+ return HscNoRecomp
+
+ , hscRecompile = genericHscRecompile hscOneShotCompiler
+
+ , hscBackend = \ tc_result mod_summary mb_old_hash -> do
+ dflags <- getDynFlags
+ case hscTarget dflags of
+ HscNothing -> return (HscRecomp Nothing ())
+ _otherw -> genericHscBackend hscOneShotCompiler
+ tc_result mod_summary mb_old_hash
+
+ , hscGenBootOutput = \tc_result mod_summary mb_old_iface -> do
+ (iface, changed, _) <- hscSimpleIface tc_result mb_old_iface
+ hscWriteIface iface changed mod_summary
+ return (HscRecomp Nothing ())
+
+ , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
+ guts <- hscSimplify' guts0
+ (iface, changed, _details, cgguts) <- hscNormalIface guts mb_old_iface
+ hscWriteIface iface changed mod_summary
+ hasStub <- hscGenHardCode cgguts mod_summary
+ return (HscRecomp hasStub ())
+ }
+
-- Compile Haskell, boot and extCore in OneShot mode.
-hscCompileOneShot :: Compiler HscStatus
-hscCompileOneShot
- = hscCompiler norecompOneShot oneShotMsg backend boot_backend
- where
- backend inp = hscSimplify inp >>= hscNormalIface >>= hscWriteIface >>= hscOneShot
- boot_backend inp = hscSimpleIface inp >>= hscWriteIface >> return (HscRecomp False)
+hscCompileOneShot :: Compiler OneShotResult
+hscCompileOneShot hsc_env mod_summary src_changed mb_old_iface mb_i_of_n
+ = do
+ -- One-shot mode needs a knot-tying mutable variable for interface
+ -- files. See TcRnTypes.TcGblEnv.tcg_type_env_var.
+ type_env_var <- newIORef emptyNameEnv
+ let
+ mod = ms_mod mod_summary
+ hsc_env' = hsc_env{ hsc_type_env_var = Just (mod, type_env_var) }
+ ---
+ genericHscCompile hscOneShotCompiler
+ oneShotMsg hsc_env' mod_summary src_changed
+ mb_old_iface mb_i_of_n
+
+
+hscOneShotBackendOnly :: TcGblEnv -> Compiler OneShotResult
+hscOneShotBackendOnly = compilerBackend hscOneShotCompiler
+
+--------------------------------------------------------------
+
+hscBatchCompiler :: HsCompiler BatchResult
+hscBatchCompiler =
+ HsCompiler {
+
+ hscNoRecomp = \iface -> do
+ details <- genModDetails iface
+ return (HscNoRecomp, iface, details)
+
+ , hscRecompile = genericHscRecompile hscBatchCompiler
+
+ , hscBackend = genericHscBackend hscBatchCompiler
+
+ , hscGenBootOutput = \tc_result mod_summary mb_old_iface -> do
+ (iface, changed, details) <- hscSimpleIface tc_result mb_old_iface
+ hscWriteIface iface changed mod_summary
+ return (HscRecomp Nothing (), iface, details)
+
+ , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
+ guts <- hscSimplify' guts0
+ (iface, changed, details, cgguts) <- hscNormalIface guts mb_old_iface
+ hscWriteIface iface changed mod_summary
+ hasStub <- hscGenHardCode cgguts mod_summary
+ return (HscRecomp hasStub (), iface, details)
+ }
-- Compile Haskell, boot and extCore in batch mode.
hscCompileBatch :: Compiler (HscStatus, ModIface, ModDetails)
-hscCompileBatch
- = hscCompiler norecompBatch batchMsg backend boot_backend
- where
- backend inp = hscSimplify inp >>= hscNormalIface >>= hscWriteIface >>= hscBatch
- boot_backend inp = hscSimpleIface inp >>= hscWriteIface >>= hscNothing
-
--- Type-check Haskell, boot and extCore.
--- Does it make sense to compile extCore to nothing?
-hscCompileNothing :: Compiler (HscStatus, ModIface, ModDetails)
-hscCompileNothing
- = hscCompiler norecompBatch batchMsg backend backend
- where
- backend inp = hscSimpleIface inp >>= hscIgnoreIface >>= hscNothing
+hscCompileBatch = genericHscCompile hscBatchCompiler batchMsg
+
+hscBatchBackendOnly :: TcGblEnv -> Compiler BatchResult
+hscBatchBackendOnly = hscCheckRecompBackend hscBatchCompiler
+
+--------------------------------------------------------------
+
+hscInteractiveCompiler :: HsCompiler InteractiveResult
+hscInteractiveCompiler =
+ HsCompiler {
+ hscNoRecomp = \iface -> do
+ details <- genModDetails iface
+ return (HscNoRecomp, iface, details)
+
+ , hscRecompile = genericHscRecompile hscInteractiveCompiler
+
+ , hscBackend = genericHscBackend hscInteractiveCompiler
+
+ , hscGenBootOutput = \tc_result _mod_summary mb_old_iface -> do
+ (iface, _changed, details) <- hscSimpleIface tc_result mb_old_iface
+ return (HscRecomp Nothing Nothing, iface, details)
+
+ , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
+ guts <- hscSimplify' guts0
+ (iface, _changed, details, cgguts) <- hscNormalIface guts mb_old_iface
+ hscInteractive (iface, details, cgguts) mod_summary
+ }
-- Compile Haskell, extCore to bytecode.
hscCompileInteractive :: Compiler (InteractiveStatus, ModIface, ModDetails)
-hscCompileInteractive
- = hscCompiler norecompInteractive batchMsg backend boot_backend
- where
- backend inp = hscSimplify inp >>= hscNormalIface >>= hscIgnoreIface >>= hscInteractive
- boot_backend = panic "hscCompileInteractive: can't do boot files here"
-
-hscCompiler
- :: NoRecomp result -- No recomp necessary
- -> (Maybe (Int,Int) -> Bool -> Comp ()) -- Message callback
- -> (ModGuts -> Comp result) -- Compile normal file
- -> (ModGuts -> Comp result) -- Compile boot file
- -> Compiler result
-hscCompiler norecomp messenger nonBootComp bootComp hsc_env mod_summary
- source_unchanged mbOldIface mbModIndex
- = flip evalComp (CompState hsc_env mod_summary mbOldIface) $
- do (recomp_reqd, mbCheckedIface)
- <- {-# SCC "checkOldIface" #-}
- liftIO $ checkOldIface hsc_env mod_summary
- source_unchanged mbOldIface
- -- save the interface that comes back from checkOldIface.
- -- In one-shot mode we don't have the old iface until this
- -- point, when checkOldIface reads it from the disk.
- modify (\s -> s{ compOldIface = mbCheckedIface })
- case mbCheckedIface of
- Just iface | not recomp_reqd
- -> do messenger mbModIndex False
- result <- norecomp iface
- return (Just result)
- _otherwise
- -> do messenger mbModIndex True
- mb_modguts <- frontend
- case mb_modguts of
- Nothing
- -> return Nothing
- Just core
- -> do result <- backend core
- return (Just result)
- where
- frontend :: Comp (Maybe ModGuts) -- Front end
- -- backend :: (ModGuts -> Comp result) -- Backend.
- (frontend,backend)
- = case ms_hsc_src mod_summary of
- ExtCoreFile -> (hscCoreFrontEnd, nonBootComp)
- HsSrcFile -> (hscFileFrontEnd, nonBootComp)
- HsBootFile -> (hscFileFrontEnd, bootComp)
+hscCompileInteractive = genericHscCompile hscInteractiveCompiler batchMsg
+
+hscInteractiveBackendOnly :: TcGblEnv -> Compiler InteractiveResult
+hscInteractiveBackendOnly = compilerBackend hscInteractiveCompiler
+
+--------------------------------------------------------------
+
+hscNothingCompiler :: HsCompiler NothingResult
+hscNothingCompiler =
+ HsCompiler {
+ hscNoRecomp = \iface -> do
+ details <- genModDetails iface
+ return (HscNoRecomp, iface, details)
+
+ , hscRecompile = genericHscRecompile hscNothingCompiler
+
+ , hscBackend = \tc_result _mod_summary mb_old_iface -> do
+ handleWarnings
+ (iface, _changed, details) <- hscSimpleIface tc_result mb_old_iface
+ return (HscRecomp Nothing (), iface, details)
+
+ , hscGenBootOutput = \_ _ _ ->
+ panic "hscCompileNothing: hscGenBootOutput should not be called"
+
+ , hscGenOutput = \_ _ _ ->
+ panic "hscCompileNothing: hscGenOutput should not be called"
+ }
+
+-- Type-check Haskell and .hs-boot only (no external core)
+hscCompileNothing :: Compiler (HscStatus, ModIface, ModDetails)
+hscCompileNothing = genericHscCompile hscNothingCompiler batchMsg
+
+hscNothingBackendOnly :: TcGblEnv -> Compiler NothingResult
+hscNothingBackendOnly = compilerBackend hscNothingCompiler
--------------------------------------------------------------
-- NoRecomp handlers
--------------------------------------------------------------
-norecompOneShot :: NoRecomp HscStatus
-norecompOneShot _old_iface
- = do hsc_env <- gets compHscEnv
- liftIO $ do
- dumpIfaceStats hsc_env
- return HscNoRecomp
-
-norecompBatch :: NoRecomp (HscStatus, ModIface, ModDetails)
-norecompBatch = norecompWorker HscNoRecomp False
-
-norecompInteractive :: NoRecomp (InteractiveStatus, ModIface, ModDetails)
-norecompInteractive = norecompWorker InteractiveNoRecomp True
-
-norecompWorker :: a -> Bool -> NoRecomp (a, ModIface, ModDetails)
-norecompWorker a _isInterp old_iface
- = do hsc_env <- gets compHscEnv
- _mod_summary <- gets compModSummary
- liftIO $ do
- new_details <- {-# SCC "tcRnIface" #-}
- initIfaceCheck hsc_env $
- typecheckIface old_iface
- dumpIfaceStats hsc_env
- return (a, old_iface, new_details)
+genModDetails :: ModIface -> Hsc ModDetails
+genModDetails old_iface
+ = do
+ hsc_env <- getHscEnv
+ new_details <- {-# SCC "tcRnIface" #-}
+ liftIO $ initIfaceCheck hsc_env $
+ typecheckIface old_iface
+ liftIO $ dumpIfaceStats hsc_env
+ return new_details
--------------------------------------------------------------
-- Progress displayers.
--------------------------------------------------------------
-oneShotMsg :: Maybe (Int,Int) -> Bool -> Comp ()
-oneShotMsg _mb_mod_index recomp
- = do hsc_env <- gets compHscEnv
- liftIO $ do
+oneShotMsg :: HscEnv -> Maybe (Int,Int) -> Bool -> ModSummary -> IO ()
+oneShotMsg hsc_env _mb_mod_index recomp _mod_summary =
if recomp
then return ()
else compilationProgressMsg (hsc_dflags hsc_env) $
"compilation IS NOT required"
-batchMsg :: Maybe (Int,Int) -> Bool -> Comp ()
-batchMsg mb_mod_index recomp
- = do hsc_env <- gets compHscEnv
- mod_summary <- gets compModSummary
+batchMsg :: HscEnv -> Maybe (Int,Int) -> Bool -> ModSummary -> IO ()
+batchMsg hsc_env mb_mod_index recomp mod_summary
+ = do
let showMsg msg = compilationProgressMsg (hsc_dflags hsc_env) $
(showModuleIndex mb_mod_index ++
msg ++ showModMsg (hscTarget (hsc_dflags hsc_env)) recomp mod_summary)
- liftIO $ do
if recomp
then showMsg "Compiling "
else if verbosity (hsc_dflags hsc_env) >= 2
-- FrontEnds
--------------------------------------------------------------
-hscCoreFrontEnd :: Comp (Maybe ModGuts)
-hscCoreFrontEnd =
- do hsc_env <- gets compHscEnv
- mod_summary <- gets compModSummary
- liftIO $ do
- -------------------
- -- PARSE
- -------------------
- inp <- readFile (ms_hspp_file mod_summary)
- case parseCore inp 1 of
- FailP s
- -> do errorMsg (hsc_dflags hsc_env) (text s{-ToDo: wrong-})
- return Nothing
- OkP rdr_module
- -------------------
- -- RENAME and TYPECHECK
- -------------------
- -> do (tc_msgs, maybe_tc_result) <- {-# SCC "TypeCheck" #-}
- tcRnExtCore hsc_env rdr_module
- printErrorsAndWarnings (hsc_dflags hsc_env) tc_msgs
- case maybe_tc_result of
- Nothing -> return Nothing
- Just mod_guts -> return (Just mod_guts) -- No desugaring to do!
-
-
-hscFileFrontEnd :: Comp (Maybe ModGuts)
-hscFileFrontEnd =
- do hsc_env <- gets compHscEnv
- mod_summary <- gets compModSummary
- liftIO $ do
- -------------------
- -- PARSE
- -------------------
- let dflags = hsc_dflags hsc_env
- hspp_file = ms_hspp_file mod_summary
- hspp_buf = ms_hspp_buf mod_summary
- maybe_parsed <- myParseModule dflags hspp_file hspp_buf
- case maybe_parsed of
- Left err
- -> do printBagOfErrors dflags (unitBag err)
- return Nothing
- Right rdr_module
- -------------------
- -- RENAME and TYPECHECK
- -------------------
- -> do (tc_msgs, maybe_tc_result)
- <- {-# SCC "Typecheck-Rename" #-}
- tcRnModule hsc_env (ms_hsc_src mod_summary) False rdr_module
- printErrorsAndWarnings dflags tc_msgs
- case maybe_tc_result of
- Nothing
- -> return Nothing
- Just tc_result
- -------------------
- -- DESUGAR
- -------------------
- -> {-# SCC "DeSugar" #-} deSugar hsc_env (ms_location mod_summary) tc_result
+hscFileFrontEnd :: ModSummary -> Hsc TcGblEnv
+hscFileFrontEnd mod_summary =
+ do rdr_module <- hscParse' mod_summary
+ hsc_env <- getHscEnv
+ {-# SCC "Typecheck-Rename" #-}
+ ioMsgMaybe $
+ tcRnModule hsc_env (ms_hsc_src mod_summary) False rdr_module
--------------------------------------------------------------
-- Simplifiers
--------------------------------------------------------------
-hscSimplify :: ModGuts -> Comp ModGuts
-hscSimplify ds_result
- = do hsc_env <- gets compHscEnv
- liftIO $ do
- -------------------
- -- SIMPLIFY
- -------------------
- simpl_result <- {-# SCC "Core2Core" #-}
- core2core hsc_env ds_result
- return simpl_result
+hscSimplify :: HscEnv -> ModGuts -> IO ModGuts
+hscSimplify hsc_env modguts = runHsc hsc_env $ hscSimplify' modguts
+
+hscSimplify' :: ModGuts -> Hsc ModGuts
+hscSimplify' ds_result
+ = do hsc_env <- getHscEnv
+ {-# SCC "Core2Core" #-}
+ liftIO $ core2core hsc_env ds_result
--------------------------------------------------------------
-- Interface generators
--------------------------------------------------------------
--- HACK: we return ModGuts even though we know it's not gonna be used.
--- We do this because the type signature needs to be identical
--- in structure to the type of 'hscNormalIface'.
-hscSimpleIface :: ModGuts -> Comp (ModIface, Bool, ModDetails, ModGuts)
-hscSimpleIface ds_result
- = do hsc_env <- gets compHscEnv
- _mod_summary <- gets compModSummary
- maybe_old_iface <- gets compOldIface
- liftIO $ do
- details <- mkBootModDetailsDs hsc_env ds_result
- (new_iface, no_change)
+hscSimpleIface :: TcGblEnv
+ -> Maybe Fingerprint
+ -> Hsc (ModIface, Bool, ModDetails)
+hscSimpleIface tc_result mb_old_iface
+ = do
+ hsc_env <- getHscEnv
+ details <- liftIO $ mkBootModDetailsTc hsc_env tc_result
+ (new_iface, no_change)
<- {-# SCC "MkFinalIface" #-}
- mkIface hsc_env maybe_old_iface details ds_result
+ ioMsgMaybe $
+ mkIfaceTc hsc_env mb_old_iface details tc_result
-- And the answer is ...
- dumpIfaceStats hsc_env
- return (new_iface, no_change, details, ds_result)
-
-hscNormalIface :: ModGuts -> Comp (ModIface, Bool, ModDetails, CgGuts)
-hscNormalIface simpl_result
- = do hsc_env <- gets compHscEnv
- _mod_summary <- gets compModSummary
- maybe_old_iface <- gets compOldIface
- liftIO $ do
- -------------------
- -- TIDY
- -------------------
+ liftIO $ dumpIfaceStats hsc_env
+ return (new_iface, no_change, details)
+
+hscNormalIface :: ModGuts
+ -> Maybe Fingerprint
+ -> Hsc (ModIface, Bool, ModDetails, CgGuts)
+hscNormalIface simpl_result mb_old_iface
+ = do
+ hsc_env <- getHscEnv
(cg_guts, details) <- {-# SCC "CoreTidy" #-}
- tidyProgram hsc_env simpl_result
+ liftIO $ tidyProgram hsc_env simpl_result
- -------------------
-- BUILD THE NEW ModIface and ModDetails
-- and emit external core if necessary
-- This has to happen *after* code gen so that the back-end
-- info has been set. Not yet clear if it matters waiting
-- until after code output
(new_iface, no_change)
- <- {-# SCC "MkFinalIface" #-}
- mkIface hsc_env maybe_old_iface details simpl_result
- -- Emit external core
- emitExternalCore (hsc_dflags hsc_env) (availsToNameSet (mg_exports simpl_result)) cg_guts -- Move this? --Lemmih 03/07/2006
- dumpIfaceStats hsc_env
+ <- {-# SCC "MkFinalIface" #-}
+ ioMsgMaybe $
+ mkIface hsc_env mb_old_iface details simpl_result
+
+ -- Emit external core
+ -- This should definitely be here and not after CorePrep,
+ -- because CorePrep produces unqualified constructor wrapper declarations,
+ -- so its output isn't valid External Core (without some preprocessing).
+ liftIO $ emitExternalCore (hsc_dflags hsc_env) cg_guts
+ liftIO $ dumpIfaceStats hsc_env
- -------------------
-- Return the prepared code.
return (new_iface, no_change, details, cg_guts)
-- BackEnd combinators
--------------------------------------------------------------
-hscWriteIface :: (ModIface, Bool, ModDetails, a) -> Comp (ModIface, ModDetails, a)
-hscWriteIface (iface, no_change, details, a)
- = do mod_summary <- gets compModSummary
- hsc_env <- gets compHscEnv
- let dflags = hsc_dflags hsc_env
- liftIO $ do
+hscWriteIface :: ModIface
+ -> Bool
+ -> ModSummary
+ -> Hsc ()
+
+hscWriteIface iface no_change mod_summary
+ = do dflags <- getDynFlags
unless no_change
- $ writeIfaceFile dflags (ms_location mod_summary) iface
- return (iface, details, a)
-
-hscIgnoreIface :: (ModIface, Bool, ModDetails, a) -> Comp (ModIface, ModDetails, a)
-hscIgnoreIface (iface, _no_change, details, a)
- = return (iface, details, a)
-
--- Don't output any code.
-hscNothing :: (ModIface, ModDetails, a) -> Comp (HscStatus, ModIface, ModDetails)
-hscNothing (iface, details, _)
- = return (HscRecomp False, iface, details)
-
--- Generate code and return both the new ModIface and the ModDetails.
-hscBatch :: (ModIface, ModDetails, CgGuts) -> Comp (HscStatus, ModIface, ModDetails)
-hscBatch (iface, details, cgguts)
- = do hasStub <- hscCompile cgguts
- return (HscRecomp hasStub, iface, details)
-
--- Here we don't need the ModIface and ModDetails anymore.
-hscOneShot :: (ModIface, ModDetails, CgGuts) -> Comp HscStatus
-hscOneShot (_, _, cgguts)
- = do hasStub <- hscCompile cgguts
- return (HscRecomp hasStub)
-
--- Compile to hard-code.
-hscCompile :: CgGuts -> Comp Bool
-hscCompile cgguts
- = do hsc_env <- gets compHscEnv
- mod_summary <- gets compModSummary
- liftIO $ do
+ $ liftIO $ writeIfaceFile dflags (ms_location mod_summary) iface
+
+-- | Compile to hard-code.
+hscGenHardCode :: CgGuts -> ModSummary
+ -> Hsc (Maybe FilePath) -- ^ @Just f@ <=> _stub.c is f
+hscGenHardCode cgguts mod_summary
+ = do
+ hsc_env <- getHscEnv
+ liftIO $ do
let CgGuts{ -- This is the last use of the ModGuts in a compilation.
-- From now on, we just use the bits we need.
cg_module = this_mod,
cg_binds = core_binds,
cg_tycons = tycons,
- cg_dir_imps = dir_imps,
- cg_foreign = foreign_stubs,
+ cg_foreign = foreign_stubs0,
cg_dep_pkgs = dependencies,
- cg_hpc_info = hpc_info } = cgguts
+ cg_hpc_info = hpc_info } = cgguts
dflags = hsc_dflags hsc_env
location = ms_location mod_summary
data_tycons = filter isDataTyCon tycons
(stg_binds, cost_centre_info)
<- {-# SCC "CoreToStg" #-}
myCoreToStg dflags this_mod prepd_binds
+
+ let prof_init = profilingInitCode this_mod cost_centre_info
+ foreign_stubs = foreign_stubs0 `appendStubC` prof_init
+
------------------ Code generation ------------------
- cmms <- {-# SCC "CodeGen" #-}
- codeGen dflags this_mod data_tycons
- dir_imps cost_centre_info
- stg_binds hpc_info
+
+ cmms <- if dopt Opt_TryNewCodeGen dflags
+ then do cmms <- tryNewCodeGen hsc_env this_mod data_tycons
+ cost_centre_info
+ stg_binds hpc_info
+ return cmms
+ else {-# SCC "CodeGen" #-}
+ codeGen dflags this_mod data_tycons
+ cost_centre_info
+ stg_binds hpc_info
+
--- Optionally run experimental Cmm transformations ---
- cmms <- optionallyConvertAndOrCPS dflags cmms
- -- ^ unless certain dflags are on, the identity function
+ cmms <- optionallyConvertAndOrCPS hsc_env cmms
+ -- unless certain dflags are on, the identity function
------------------ Code output -----------------------
rawcmms <- cmmToRawCmm cmms
+ dumpIfSet_dyn dflags Opt_D_dump_raw_cmm "Raw Cmm" (ppr rawcmms)
(_stub_h_exists, stub_c_exists)
<- codeOutput dflags this_mod location foreign_stubs
dependencies rawcmms
return stub_c_exists
hscInteractive :: (ModIface, ModDetails, CgGuts)
- -> Comp (InteractiveStatus, ModIface, ModDetails)
+ -> ModSummary
+ -> Hsc (InteractiveStatus, ModIface, ModDetails)
#ifdef GHCI
-hscInteractive (iface, details, cgguts)
- = do hsc_env <- gets compHscEnv
- mod_summary <- gets compModSummary
- liftIO $ do
+hscInteractive (iface, details, cgguts) mod_summary
+ = do
+ dflags <- getDynFlags
let CgGuts{ -- This is the last use of the ModGuts in a compilation.
-- From now on, we just use the bits we need.
cg_module = this_mod,
cg_tycons = tycons,
cg_foreign = foreign_stubs,
cg_modBreaks = mod_breaks } = cgguts
- dflags = hsc_dflags hsc_env
+
location = ms_location mod_summary
data_tycons = filter isDataTyCon tycons
-- cg_tycons includes newtypes, for the benefit of External Core,
-- PREPARE FOR CODE GENERATION
-- Do saturation and convert to A-normal form
prepd_binds <- {-# SCC "CorePrep" #-}
- corePrepPgm dflags core_binds data_tycons ;
+ liftIO $ corePrepPgm dflags core_binds data_tycons ;
----------------- Generate byte code ------------------
- comp_bc <- byteCodeGen dflags prepd_binds data_tycons mod_breaks
+ comp_bc <- liftIO $ byteCodeGen dflags prepd_binds data_tycons mod_breaks
------------------ Create f-x-dynamic C-side stuff ---
(_istub_h_exists, istub_c_exists)
- <- outputForeignStubs dflags this_mod location foreign_stubs
- return (InteractiveRecomp istub_c_exists comp_bc mod_breaks, iface, details)
+ <- liftIO $ outputForeignStubs dflags this_mod
+ location foreign_stubs
+ return (HscRecomp istub_c_exists (Just (comp_bc, mod_breaks))
+ , iface, details)
#else
-hscInteractive _ = panic "GHC not compiled with interpreter"
+hscInteractive _ _ = panic "GHC not compiled with interpreter"
#endif
------------------------------
-hscCmmFile :: DynFlags -> FilePath -> IO Bool
-hscCmmFile dflags filename = do
- maybe_cmm <- parseCmmFile dflags filename
- case maybe_cmm of
- Nothing -> return False
- Just cmm -> do
- cmms <- optionallyConvertAndOrCPS dflags [cmm]
+hscCompileCmmFile :: HscEnv -> FilePath -> IO ()
+hscCompileCmmFile hsc_env filename
+ = runHsc hsc_env $ do
+ let dflags = hsc_dflags hsc_env
+ cmm <- ioMsgMaybe $ parseCmmFile dflags filename
+ liftIO $ do
+ cmms <- optionallyConvertAndOrCPS hsc_env [cmm]
rawCmms <- cmmToRawCmm cmms
- codeOutput dflags no_mod no_loc NoStubs [] rawCmms
- return True
+ _ <- codeOutput dflags no_mod no_loc NoStubs [] rawCmms
+ return ()
where
no_mod = panic "hscCmmFile: no_mod"
no_loc = ModLocation{ ml_hs_file = Just filename,
ml_hi_file = panic "hscCmmFile: no hi file",
ml_obj_file = panic "hscCmmFile: no obj file" }
-optionallyConvertAndOrCPS :: DynFlags -> [Cmm] -> IO [Cmm]
-optionallyConvertAndOrCPS dflags cmms =
- do -------- Optionally convert to and from zipper ------
+-------------------- Stuff for new code gen ---------------------
+
+tryNewCodeGen :: HscEnv -> Module -> [TyCon]
+ -> CollectedCCs
+ -> [(StgBinding,[(Id,[Id])])]
+ -> HpcInfo
+ -> IO [Cmm]
+tryNewCodeGen hsc_env this_mod data_tycons
+ cost_centre_info stg_binds hpc_info =
+ do { let dflags = hsc_dflags hsc_env
+ ; prog <- StgCmm.codeGen dflags this_mod data_tycons
+ cost_centre_info stg_binds hpc_info
+ ; dumpIfSet_dyn dflags Opt_D_dump_cmmz "Cmm produced by new codegen"
+ (pprCmms prog)
+
+ -- We are building a single SRT for the entire module, so
+ -- we must thread it through all the procedures as we cps-convert them.
+ ; us <- mkSplitUniqSupply 'S'
+ ; let initTopSRT = initUs_ us emptySRT
+ ; (topSRT, prog) <- foldM (cmmPipeline hsc_env) (initTopSRT, []) prog
+
+ ; let prog' = map cmmOfZgraph (srtToData topSRT : prog)
+ ; dumpIfSet_dyn dflags Opt_D_dump_cmmz "Output Cmm" (ppr prog')
+ ; return prog' }
+
+
+optionallyConvertAndOrCPS :: HscEnv -> [Cmm] -> IO [Cmm]
+optionallyConvertAndOrCPS hsc_env cmms =
+ do let dflags = hsc_dflags hsc_env
+ -------- Optionally convert to and from zipper ------
cmms <- if dopt Opt_ConvertToZipCfgAndBack dflags
- then mapM (testCmmConversion dflags) cmms
- else return cmms
- --------- Optionally convert to CPS (MDA) -----------
- cmms <- if not (dopt Opt_ConvertToZipCfgAndBack dflags) &&
- dopt Opt_RunCPSZ dflags
- then cmmCPS dflags cmms
+ then mapM (testCmmConversion hsc_env) cmms
else return cmms
return cmms
-testCmmConversion :: DynFlags -> Cmm -> IO Cmm
-testCmmConversion dflags cmm =
- do showPass dflags "CmmToCmm"
+testCmmConversion :: HscEnv -> Cmm -> IO Cmm
+testCmmConversion hsc_env cmm =
+ do let dflags = hsc_dflags hsc_env
+ showPass dflags "CmmToCmm"
dumpIfSet_dyn dflags Opt_D_dump_cvt_cmm "C-- pre-conversion" (ppr cmm)
--continuationC <- cmmCPS dflags abstractC >>= cmmToRawCmm
us <- mkSplitUniqSupply 'C'
- let cfopts = runTx $ runCmmOpts cmmCfgOptsZ
- let cvtm = do g <- cmmToZgraph cmm
- return $ cfopts g
- let zgraph = initUs_ us cvtm
- cps_zgraph <- protoCmmCPSZ dflags zgraph
- let chosen_graph = if dopt Opt_RunCPSZ dflags then cps_zgraph else zgraph
+ let zgraph = initUs_ us (cmmToZgraph cmm)
+ chosen_graph <-
+ if dopt Opt_RunCPSZ dflags
+ then do us <- mkSplitUniqSupply 'S'
+ let topSRT = initUs_ us emptySRT
+ (_, [zgraph]) <- cmmPipeline hsc_env (topSRT, []) zgraph
+ return zgraph
+ else return (runCmmContFlowOpts zgraph)
dumpIfSet_dyn dflags Opt_D_dump_cmmz "C-- Zipper Graph" (ppr chosen_graph)
showPass dflags "Convert from Z back to Cmm"
- let cvt = cmmOfZgraph $ cfopts $ chosen_graph
+ let cvt = cmmOfZgraph chosen_graph
dumpIfSet_dyn dflags Opt_D_dump_cvt_cmm "C-- post-conversion" (ppr cvt)
return cvt
- -- return cmm -- don't use the conversion
-
-myParseModule :: DynFlags -> FilePath -> Maybe StringBuffer
- -> IO (Either ErrMsg (Located (HsModule RdrName)))
-myParseModule dflags src_filename maybe_src_buf
- = -------------------------- Parser ----------------
- showPass dflags "Parser" >>
- {-# SCC "Parser" #-} do
-
- -- sometimes we already have the buffer in memory, perhaps
- -- because we needed to parse the imports out of it, or get the
- -- module name.
- buf <- case maybe_src_buf of
- Just b -> return b
- Nothing -> hGetStringBuffer src_filename
-
- let loc = mkSrcLoc (mkFastString src_filename) 1 0
-
- case unP parseModule (mkPState buf loc dflags) of {
-
- PFailed span err -> return (Left (mkPlainErrMsg span err));
-
- POk pst rdr_module -> do {
-
- let {ms = getMessages pst};
- printErrorsAndWarnings dflags ms;
- when (errorsFound dflags ms) $ exitWith (ExitFailure 1);
-
- dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr rdr_module) ;
-
- dumpIfSet_dyn dflags Opt_D_source_stats "Source Statistics"
- (ppSourceStats False rdr_module) ;
-
- return (Right rdr_module)
- -- ToDo: free the string buffer later.
- }}
-
myCoreToStg :: DynFlags -> Module -> [CoreBind]
-> IO ( [(StgBinding,[(Id,[Id])])] -- output program
:: HscEnv
-> String -- The statement
-> IO (Maybe ([Id], HValue))
+ -- ^ 'Nothing' <==> empty statement (or comment only), but no parse error
+hscStmt hsc_env stmt = hscStmtWithLocation hsc_env stmt "<interactive>" 1
-hscStmt hsc_env stmt
- = do { maybe_stmt <- hscParseStmt (hsc_dflags hsc_env) stmt
- ; case maybe_stmt of {
- Nothing -> return Nothing ; -- Parse error
- Just Nothing -> return Nothing ; -- Empty line
- Just (Just parsed_stmt) -> do { -- The real stuff
-
- -- Rename and typecheck it
- let icontext = hsc_IC hsc_env
- ; maybe_tc_result <- tcRnStmt hsc_env icontext parsed_stmt
-
- ; case maybe_tc_result of {
- Nothing -> return Nothing ;
- Just (ids, tc_expr) -> do {
-
- -- Desugar it
- ; let rdr_env = ic_rn_gbl_env icontext
- type_env = mkTypeEnv (map AnId (ic_tmp_ids icontext))
- ; mb_ds_expr <- deSugarExpr hsc_env iNTERACTIVE rdr_env type_env tc_expr
-
- ; case mb_ds_expr of {
- Nothing -> return Nothing ;
- Just ds_expr -> do {
-
- -- Then desugar, code gen, and link it
- ; let src_span = srcLocSpan interactiveSrcLoc
- ; hval <- compileExpr hsc_env src_span ds_expr
-
- ; return (Just (ids, hval))
- }}}}}}}
+hscStmtWithLocation -- Compile a stmt all the way to an HValue, but don't run it
+ :: HscEnv
+ -> String -- The statement
+ -> String -- the source
+ -> Int -- ^ starting line
+ -> IO (Maybe ([Id], HValue))
+ -- ^ 'Nothing' <==> empty statement (or comment only), but no parse error
+hscStmtWithLocation hsc_env stmt source linenumber = runHsc hsc_env $ do
+ maybe_stmt <- hscParseStmtWithLocation source linenumber stmt
+ case maybe_stmt of
+ Nothing -> return Nothing
+ Just parsed_stmt -> do -- The real stuff
+
+ -- Rename and typecheck it
+ let icontext = hsc_IC hsc_env
+ (ids, tc_expr) <- ioMsgMaybe $
+ tcRnStmt hsc_env icontext parsed_stmt
+ -- Desugar it
+ let rdr_env = ic_rn_gbl_env icontext
+ type_env = mkTypeEnv (map AnId (ic_tmp_ids icontext))
+ ds_expr <- ioMsgMaybe $
+ deSugarExpr hsc_env iNTERACTIVE rdr_env type_env tc_expr
+ handleWarnings
+
+ -- Then desugar, code gen, and link it
+ let src_span = srcLocSpan interactiveSrcLoc
+ hsc_env <- getHscEnv
+ hval <- liftIO $ hscCompileCoreExpr hsc_env src_span ds_expr
+
+ return $ Just (ids, hval)
+
+hscImport :: HscEnv -> String -> IO (ImportDecl RdrName)
+hscImport hsc_env str = runHsc hsc_env $ do
+ (L _ (HsModule{hsmodImports=is})) <-
+ hscParseThing parseModule str
+ case is of
+ [i] -> return (unLoc i)
+ _ -> liftIO $ throwOneError $
+ mkPlainErrMsg noSrcSpan $
+ ptext (sLit "parse error in import declaration")
hscTcExpr -- Typecheck an expression (but don't run it)
:: HscEnv
-> String -- The expression
- -> IO (Maybe Type)
-
-hscTcExpr hsc_env expr
- = do { maybe_stmt <- hscParseStmt (hsc_dflags hsc_env) expr
- ; let icontext = hsc_IC hsc_env
- ; case maybe_stmt of {
- Nothing -> return Nothing ; -- Parse error
- Just (Just (L _ (ExprStmt expr _ _)))
- -> tcRnExpr hsc_env icontext expr ;
- Just _ -> do { errorMsg (hsc_dflags hsc_env) (text "not an expression:" <+> quotes (text expr)) ;
- return Nothing } ;
- } }
-
-hscKcType -- Find the kind of a type
+ -> IO Type
+
+hscTcExpr hsc_env expr = runHsc hsc_env $ do
+ maybe_stmt <- hscParseStmt expr
+ case maybe_stmt of
+ Just (L _ (ExprStmt expr _ _ _)) ->
+ ioMsgMaybe $ tcRnExpr hsc_env (hsc_IC hsc_env) expr
+ _ ->
+ liftIO $ throwIO $ mkSrcErr $ unitBag $ mkPlainErrMsg noSrcSpan
+ (text "not an expression:" <+> quotes (text expr))
+
+-- | Find the kind of a type
+hscKcType
:: HscEnv
- -> String -- The type
- -> IO (Maybe Kind)
-
-hscKcType hsc_env str
- = do { maybe_type <- hscParseType (hsc_dflags hsc_env) str
- ; let icontext = hsc_IC hsc_env
- ; case maybe_type of {
- Just ty -> tcRnType hsc_env icontext ty ;
- Nothing -> return Nothing } }
+ -> String -- ^ The type
+ -> IO Kind
+
+hscKcType hsc_env str = runHsc hsc_env $ do
+ ty <- hscParseType str
+ ioMsgMaybe $ tcRnType hsc_env (hsc_IC hsc_env) ty
+
#endif
\end{code}
\begin{code}
#ifdef GHCI
-hscParseStmt :: DynFlags -> String -> IO (Maybe (Maybe (LStmt RdrName)))
+hscParseStmt :: String -> Hsc (Maybe (LStmt RdrName))
hscParseStmt = hscParseThing parseStmt
-hscParseType :: DynFlags -> String -> IO (Maybe (LHsType RdrName))
+hscParseStmtWithLocation :: String -> Int
+ -> String -> Hsc (Maybe (LStmt RdrName))
+hscParseStmtWithLocation source linenumber stmt =
+ hscParseThingWithLocation source linenumber parseStmt stmt
+
+hscParseType :: String -> Hsc (LHsType RdrName)
hscParseType = hscParseThing parseType
#endif
-hscParseIdentifier :: DynFlags -> String -> IO (Maybe (Located RdrName))
-hscParseIdentifier = hscParseThing parseIdentifier
+hscParseIdentifier :: HscEnv -> String -> IO (Located RdrName)
+hscParseIdentifier hsc_env str = runHsc hsc_env $
+ hscParseThing parseIdentifier str
-hscParseThing :: Outputable thing
+hscParseThing :: (Outputable thing)
=> Lexer.P thing
- -> DynFlags -> String
- -> IO (Maybe thing)
- -- Nothing => Parse error (message already printed)
- -- Just x => success
-hscParseThing parser dflags str
- = showPass dflags "Parser" >>
- {-# SCC "Parser" #-} do
-
- buf <- stringToStringBuffer str
-
- let loc = mkSrcLoc FSLIT("<interactive>") 1 0
-
- case unP parser (mkPState buf loc dflags) of {
-
- PFailed span err -> do { printError span err;
- return Nothing };
-
- POk pst thing -> do {
-
- let {ms = getMessages pst};
- printErrorsAndWarnings dflags ms;
- when (errorsFound dflags ms) $ exitWith (ExitFailure 1);
+ -> String
+ -> Hsc thing
+hscParseThing = hscParseThingWithLocation "<interactive>" 1
+
+hscParseThingWithLocation :: (Outputable thing)
+ => String -> Int
+ -> Lexer.P thing
+ -> String
+ -> Hsc thing
+hscParseThingWithLocation source linenumber parser str
+ = {-# SCC "Parser" #-} do
+ dflags <- getDynFlags
+ liftIO $ showPass dflags "Parser"
+
+ let buf = stringToStringBuffer str
+ loc = mkRealSrcLoc (fsLit source) linenumber 1
+
+ case unP parser (mkPState dflags buf loc) of
+
+ PFailed span err -> do
+ let msg = mkPlainErrMsg span err
+ liftIO $ throwIO (mkSrcErr (unitBag msg))
+
+ POk pst thing -> do
+ logWarningsReportErrors (getMessages pst)
+ liftIO $ dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr thing)
+ return thing
+\end{code}
- --ToDo: can't free the string buffer until we've finished this
- -- compilation sweep and all the identifiers have gone away.
- dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr thing);
- return (Just thing)
- }}
+\begin{code}
+hscCompileCore :: HscEnv
+ -> Bool
+ -> ModSummary
+ -> [CoreBind]
+ -> IO ()
+
+hscCompileCore hsc_env simplify mod_summary binds
+ = runHsc hsc_env $ do
+ let maybe_simplify mod_guts | simplify = hscSimplify' mod_guts
+ | otherwise = return mod_guts
+ guts <- maybe_simplify (mkModGuts (ms_mod mod_summary) binds)
+ (iface, changed, _details, cgguts) <- hscNormalIface guts Nothing
+ hscWriteIface iface changed mod_summary
+ _ <- hscGenHardCode cgguts mod_summary
+ return ()
+
+-- Makes a "vanilla" ModGuts.
+mkModGuts :: Module -> [CoreBind] -> ModGuts
+mkModGuts mod binds = ModGuts {
+ mg_module = mod,
+ mg_boot = False,
+ mg_exports = [],
+ mg_deps = noDependencies,
+ mg_dir_imps = emptyModuleEnv,
+ mg_used_names = emptyNameSet,
+ mg_rdr_env = emptyGlobalRdrEnv,
+ mg_fix_env = emptyFixityEnv,
+ mg_types = emptyTypeEnv,
+ mg_insts = [],
+ mg_fam_insts = [],
+ mg_rules = [],
+ mg_vect_decls = [],
+ mg_binds = binds,
+ mg_foreign = NoStubs,
+ mg_warns = NoWarnings,
+ mg_anns = [],
+ mg_hpc_info = emptyHpcInfo False,
+ mg_modBreaks = emptyModBreaks,
+ mg_vect_info = noVectInfo,
+ mg_inst_env = emptyInstEnv,
+ mg_fam_inst_env = emptyFamInstEnv
+}
\end{code}
%************************************************************************
\begin{code}
#ifdef GHCI
-compileExpr :: HscEnv -> SrcSpan -> CoreExpr -> IO HValue
-
-compileExpr hsc_env srcspan ds_expr
- = do { let { dflags = hsc_dflags hsc_env ;
- lint_on = dopt Opt_DoCoreLinting dflags }
-
- -- Flatten it
- ; flat_expr <- flattenExpr hsc_env ds_expr
-
- -- Simplify it
- ; simpl_expr <- simplifyExpr dflags flat_expr
-
- -- Tidy it (temporary, until coreSat does cloning)
- ; let tidy_expr = tidyExpr emptyTidyEnv simpl_expr
-
- -- Prepare for codegen
- ; prepd_expr <- corePrepExpr dflags tidy_expr
-
- -- Lint if necessary
- -- ToDo: improve SrcLoc
- ; if lint_on then
- let ictxt = hsc_IC hsc_env
- tyvars = varSetElems (ic_tyvars ictxt)
- in
- case lintUnfolding noSrcLoc tyvars prepd_expr of
- Just err -> pprPanic "compileExpr" err
- Nothing -> return ()
- else
- return ()
-
- -- Convert to BCOs
- ; bcos <- coreExprToBCOs dflags prepd_expr
-
- -- link it
- ; hval <- linkExpr hsc_env srcspan bcos
-
- ; return hval
- }
+hscCompileCoreExpr :: HscEnv -> SrcSpan -> CoreExpr -> IO HValue
+hscCompileCoreExpr hsc_env srcspan ds_expr
+ | rtsIsProfiled
+ = throwIO (InstallationError "You can't call hscCompileCoreExpr in a profiled compiler")
+ -- Otherwise you get a seg-fault when you run it
+
+ | otherwise = do
+ let dflags = hsc_dflags hsc_env
+ let lint_on = dopt Opt_DoCoreLinting dflags
+
+ -- Simplify it
+ simpl_expr <- simplifyExpr dflags ds_expr
+
+ -- Tidy it (temporary, until coreSat does cloning)
+ let tidy_expr = tidyExpr emptyTidyEnv simpl_expr
+
+ -- Prepare for codegen
+ prepd_expr <- corePrepExpr dflags tidy_expr
+
+ -- Lint if necessary
+ -- ToDo: improve SrcLoc
+ when lint_on $
+ let ictxt = hsc_IC hsc_env
+ tyvars = varSetElems (tyVarsOfTypes (map idType (ic_tmp_ids ictxt)))
+ in
+ case lintUnfolding noSrcLoc tyvars prepd_expr of
+ Just err -> pprPanic "hscCompileCoreExpr" err
+ Nothing -> return ()
+
+ -- Convert to BCOs
+ bcos <- coreExprToBCOs dflags prepd_expr
+
+ -- link it
+ hval <- linkExpr hsc_env srcspan bcos
+
+ return hval
#endif
\end{code}
i_str = show i
padded = replicate (length n_str - length i_str) ' ' ++ i_str
\end{code}
-
projects / ghc-hetmet.git / blobdiff