%
% (c) The GRASP/AQUA Project, Glasgow University, 1993-2000
%
+
\section[GHC_Main]{Main driver for Glasgow Haskell compiler}
\begin{code}
-module HscMain ( HscResult(..), hscMain,
- initPersistentCompilerState ) where
+module HscMain
+ ( newHscEnv, hscCmmFile
+ , hscFileCheck
+ , hscParseIdentifier
+#ifdef GHCI
+ , hscStmt, hscTcExpr, hscKcType
+ , compileExpr
+#endif
+ , hscCompileOneShot -- :: Compiler HscStatus
+ , hscCompileMake -- :: Compiler (HscStatus, ModIface, ModDetails)
+ , hscCompileInteractive -- :: Compiler (InteractiveStatus, ModIface, ModDetails)
+ , HscStatus (..)
+ , InteractiveStatus (..)
+ , HscChecked (..)
+ ) where
#include "HsVersions.h"
-import Maybe ( isJust )
-import IO ( hPutStr, hPutStrLn, stderr )
-import HsSyn
-
-import StringBuffer ( hGetStringBuffer )
-import Parser ( parse )
-import Lex ( PState(..), ParseResult(..) )
+#ifdef GHCI
+import HsSyn ( Stmt(..), LHsExpr, LStmt, LHsType )
+import Module ( Module )
+import CodeOutput ( outputForeignStubs )
+import ByteCodeGen ( byteCodeGen, coreExprToBCOs )
+import Linker ( HValue, linkExpr )
+import CoreTidy ( tidyExpr )
+import CorePrep ( corePrepExpr )
+import Flattening ( flattenExpr )
+import TcRnDriver ( tcRnStmt, tcRnExpr, tcRnType )
+import Type ( Type )
+import PrelNames ( iNTERACTIVE )
+import Kind ( Kind )
+import CoreLint ( lintUnfolding )
+import DsMeta ( templateHaskellNames )
+import SrcLoc ( noSrcLoc )
+import VarEnv ( emptyTidyEnv )
+#endif
+
+import Var ( Id )
+import Module ( emptyModuleEnv, ModLocation(..) )
+import RdrName ( GlobalRdrEnv, RdrName )
+import HsSyn ( HsModule, LHsBinds, HsGroup, LIE, LImportDecl )
+import SrcLoc ( Located(..) )
+import StringBuffer ( hGetStringBuffer, stringToStringBuffer )
+import Parser
+import Lexer ( P(..), ParseResult(..), mkPState )
import SrcLoc ( mkSrcLoc )
-
-import Rename ( renameModule, checkOldIface, closeIfaceDecls )
-import Rules ( emptyRuleBase )
-import PrelInfo ( wiredInThingEnv, wiredInThings )
-import PrelNames ( knownKeyNames )
-import PrelRules ( builtinRules )
-import MkIface ( completeIface, mkModDetailsFromIface, mkModDetails,
- writeIface )
-import TcModule ( TcResults(..), typecheckModule )
-import InstEnv ( emptyInstEnv )
-import Desugar ( deSugar )
-import SimplCore ( core2core )
-import OccurAnal ( occurAnalyseBinds )
-import CoreUtils ( coreBindsSize )
-import CoreTidy ( tidyCorePgm )
-import CoreToStg ( topCoreBindsToStg )
-import StgSyn ( collectFinalStgBinders )
+import TcRnDriver ( tcRnModule, tcRnExtCore )
+import TcIface ( typecheckIface )
+import TcRnMonad ( initIfaceCheck, TcGblEnv(..) )
+import IfaceEnv ( initNameCache )
+import LoadIface ( ifaceStats, initExternalPackageState )
+import PrelInfo ( wiredInThings, basicKnownKeyNames )
+import MkIface ( checkOldIface, mkIface, writeIfaceFile )
+import Desugar ( deSugar )
+import Flattening ( flatten )
+import SimplCore ( core2core )
+import TidyPgm ( tidyProgram, mkBootModDetails )
+import CorePrep ( corePrepPgm )
+import CoreToStg ( coreToStg )
+import TyCon ( isDataTyCon )
+import Packages ( mkHomeModules )
+import Name ( Name, NamedThing(..) )
import SimplStg ( stg2stg )
import CodeGen ( codeGen )
+import CmmParse ( parseCmmFile )
import CodeOutput ( codeOutput )
-import Module ( ModuleName, moduleName, mkModuleInThisPackage )
-import CmdLineOpts
-import ErrUtils ( dumpIfSet_dyn )
-import Util ( unJust )
+import DynFlags
+import ErrUtils
import UniqSupply ( mkSplitUniqSupply )
-import Bag ( emptyBag )
import Outputable
-import Interpreter
import HscStats ( ppSourceStats )
-import HscTypes ( ModDetails, ModIface(..), PersistentCompilerState(..),
- PersistentRenamerState(..), ModuleLocation(..),
- HomeSymbolTable,
- OrigNameEnv(..), PackageRuleBase, HomeIfaceTable,
- typeEnvClasses, typeEnvTyCons, emptyIfaceTable )
-import FiniteMap ( FiniteMap, plusFM, emptyFM, addToFM )
-import OccName ( OccName )
-import Name ( Name, nameModule, nameOccName, getName )
-import Name ( emptyNameEnv )
-import Module ( Module, lookupModuleEnvByName )
+import HscTypes
+import MkExternalCore ( emitExternalCore )
+import ParserCore
+import ParserCoreUtils
+import FastString
+import Maybes ( expectJust )
+import Bag ( unitBag )
+import Monad ( when )
+import IO
+import DATA_IOREF ( newIORef, readIORef )
+\end{code}
+
+%************************************************************************
+%* *
+ Initialisation
+%* *
+%************************************************************************
+
+\begin{code}
+newHscEnv :: DynFlags -> IO HscEnv
+newHscEnv dflags
+ = do { eps_var <- newIORef initExternalPackageState
+ ; us <- mkSplitUniqSupply 'r'
+ ; nc_var <- newIORef (initNameCache us knownKeyNames)
+ ; fc_var <- newIORef emptyModuleEnv
+ ; 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 } ) }
+
+
+knownKeyNames :: [Name] -- Put here to avoid loops involving DsMeta,
+ -- where templateHaskellNames are defined
+knownKeyNames = map getName wiredInThings
+ ++ basicKnownKeyNames
+#ifdef GHCI
+ ++ templateHaskellNames
+#endif
\end{code}
%************************************************************************
%* *
-\subsection{The main compiler pipeline}
+ The main compiler pipeline
%* *
%************************************************************************
+ --------------------------------
+ The compilation proper
+ --------------------------------
+
+
+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
+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', 'make', or 'interactive'
+mode. 'One-shot' mode targets hard-code, 'make' mode targets hard-code
+and nothing, and 'interactive' mode targets byte-code. The modes are
+kept separate because of their different types.
+In 'one-shot' mode, we're only compiling a single file and can therefore
+discard the new ModIface and ModDetails. This is also the reason it only
+targets hard-code; compiling to byte-code or nothing doesn't make sense
+when we discard the result. 'Make' mode is like 'one-shot' except that we
+keep the resulting ModIface and ModDetails. 'Make' mode doesn't target
+byte-code since that require us to return the newly compiled byte-code.
+'Interactive' mode is similar to 'make' mode except that we return
+the compiled byte-code together with the ModIface and ModDetails.
+Trying to compile a hs-boot file to byte-code will result in a run-time
+error. This is the only thing that isn't caught by the type-system.
+
\begin{code}
-data HscResult
- = HscOK ModDetails -- new details (HomeSymbolTable additions)
- (Maybe ModIface) -- new iface (if any compilation was done)
- (Maybe String) -- generated stub_h filename (in /tmp)
- (Maybe String) -- generated stub_c filename (in /tmp)
- (Maybe ([UnlinkedIBind],ItblEnv)) -- interpreted code, if any
- PersistentCompilerState -- updated PCS
-
- | HscFail PersistentCompilerState -- updated PCS
- -- no errors or warnings; the individual passes
- -- (parse/rename/typecheck) print messages themselves
-
-hscMain
- :: DynFlags
- -> Bool -- source unchanged?
- -> ModuleLocation -- location info
- -> Maybe ModIface -- old interface, if available
- -> HomeSymbolTable -- for home module ModDetails
- -> HomeIfaceTable
- -> PersistentCompilerState -- IN: persistent compiler state
- -> IO HscResult
-
-hscMain dflags source_unchanged location maybe_old_iface hst hit pcs
- = do {
- putStrLn "CHECKING OLD IFACE";
- (pcs_ch, check_errs, (recomp_reqd, maybe_checked_iface))
- <- checkOldIface dflags hit hst pcs (unJust (ml_hi_file location) "hscMain")
- source_unchanged maybe_old_iface;
- if check_errs then
- return (HscFail pcs_ch)
- else do {
-
- let no_old_iface = not (isJust maybe_checked_iface)
- what_next | recomp_reqd || no_old_iface = hscRecomp
- | otherwise = hscNoRecomp
- ;
- what_next dflags location maybe_checked_iface
- hst hit pcs_ch
- }}
+data HscChecked
+ = HscChecked
+ -- parsed
+ (Located (HsModule RdrName))
+ -- renamed
+ (Maybe (HsGroup Name,[LImportDecl Name],Maybe [LIE Name]))
+ -- typechecked
+ (Maybe (LHsBinds Id, GlobalRdrEnv, ModDetails))
+
+
+-- Status of a compilation to hard-code or nothing.
+data HscStatus
+ = 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
+ -- it for us.
+
+-- Status of a compilation to byte-code.
+data InteractiveStatus
+ = InteractiveNoRecomp
+ | InteractiveRecomp Bool -- Same as HscStatus
+ CompiledByteCode
+
+type NoRecomp result = HscEnv -> ModSummary -> Bool -> ModIface -> Maybe (Int,Int) -> IO result
+type FrontEnd core = HscEnv -> ModSummary -> Maybe (Int,Int) -> IO (Maybe core)
+type BackEnd core prepCore = HscEnv -> ModSummary -> Maybe ModIface -> core -> IO prepCore
+type CodeGen prepCore result = HscEnv -> ModSummary -> prepCore -> IO result
+
+type Compiler result = HscEnv
+ -> ModSummary
+ -> Bool -- True <=> source unchanged
+ -> Bool -- True <=> have an object file (for msgs only)
+ -> Maybe ModIface -- Old interface, if available
+ -> Maybe (Int,Int) -- Just (i,n) <=> module i of n (for msgs)
+ -> IO (Maybe result)
+
+
+-- This functions checks if recompilation is necessary and
+-- then combines the FrontEnd, BackEnd and CodeGen to a
+-- working compiler.
+hscMkCompiler :: NoRecomp result -- What to do when recompilation isn't required.
+ -> FrontEnd core
+ -> BackEnd core prepCore
+ -> CodeGen prepCore result
+ -> Compiler result
+hscMkCompiler norecomp frontend backend codegen
+ hsc_env mod_summary source_unchanged
+ have_object mbOldIface mbModIndex
+ = do (recomp_reqd, mbCheckedIface)
+ <- {-# SCC "checkOldIface" #-}
+ checkOldIface hsc_env mod_summary
+ source_unchanged mbOldIface
+ case mbCheckedIface of
+ Just iface | not recomp_reqd
+ -> do result <- norecomp hsc_env mod_summary have_object iface mbModIndex
+ return (Just result)
+ _otherwise
+ -> do mbCore <- frontend hsc_env mod_summary mbModIndex
+ case mbCore of
+ Nothing
+ -> return Nothing
+ Just core
+ -> do prepCore <- backend hsc_env mod_summary
+ mbCheckedIface core
+ result <- codegen hsc_env mod_summary prepCore
+ return (Just result)
+
+--------------------------------------------------------------
+-- Compilers
+--------------------------------------------------------------
+
+-- Compile Haskell, boot and extCore in OneShot mode.
+hscCompileOneShot :: Compiler HscStatus
+hscCompileOneShot hsc_env mod_summary =
+ compiler hsc_env mod_summary
+ where mkComp = hscMkCompiler (norecompOneShot HscNoRecomp)
+ compiler
+ = case ms_hsc_src mod_summary of
+ ExtCoreFile
+ -> mkComp hscCoreFrontEnd hscNewBackEnd hscCodeGenOneShot
+-- 1 2 3 4 5 6 7 8 9
+ HsSrcFile
+ -> mkComp hscFileFrontEnd hscNewBackEnd hscCodeGenOneShot
+ HsBootFile
+ -> mkComp hscFileFrontEnd hscNewBootBackEnd
+ (hscCodeGenConst (HscRecomp False))
+
+-- Compile Haskell, boot and extCore in --make mode.
+hscCompileMake :: Compiler (HscStatus, ModIface, ModDetails)
+hscCompileMake hsc_env mod_summary
+ = compiler hsc_env mod_summary
+ where mkComp = hscMkCompiler norecompMake
+ backend = case hscTarget (hsc_dflags hsc_env) of
+ HscNothing -> hscCodeGenNothing
+ _other -> hscCodeGenMake
+ compiler
+ = case ms_hsc_src mod_summary of
+ ExtCoreFile
+ -> mkComp hscCoreFrontEnd hscNewBackEnd backend
+ HsSrcFile
+ -> mkComp hscFileFrontEnd hscNewBackEnd backend
+ HsBootFile
+ -> mkComp hscFileFrontEnd hscNewBootBackEnd hscCodeGenIdentity
+
+
+-- Compile Haskell, extCore to bytecode.
+hscCompileInteractive :: Compiler (InteractiveStatus, ModIface, ModDetails)
+hscCompileInteractive hsc_env mod_summary =
+ hscMkCompiler norecompInteractive frontend hscNewBackEnd hscCodeGenInteractive
+ hsc_env mod_summary
+ where frontend = case ms_hsc_src mod_summary of
+ ExtCoreFile -> hscCoreFrontEnd
+ HsSrcFile -> hscFileFrontEnd
+ HsBootFile -> panic bootErrorMsg
+ bootErrorMsg = "Compiling a HsBootFile to bytecode doesn't make sense. " ++
+ "Use 'hscCompileMake' instead."
+
+--------------------------------------------------------------
+-- NoRecomp handlers
+--------------------------------------------------------------
+
+norecompOneShot :: a -> NoRecomp a
+norecompOneShot a hsc_env mod_summary
+ have_object old_iface
+ mb_mod_index
+ = do compilationProgressMsg (hsc_dflags hsc_env) $
+ "compilation IS NOT required"
+ dumpIfaceStats hsc_env
+ return a
+
+norecompMake :: NoRecomp (HscStatus, ModIface, ModDetails)
+norecompMake = norecompWorker HscNoRecomp
+
+norecompInteractive :: NoRecomp (InteractiveStatus, ModIface, ModDetails)
+norecompInteractive = norecompWorker InteractiveNoRecomp
+
+norecompWorker :: a -> NoRecomp (a, ModIface, ModDetails)
+norecompWorker a hsc_env mod_summary have_object
+ old_iface mb_mod_index
+ = do compilationProgressMsg (hsc_dflags hsc_env) $
+ (showModuleIndex mb_mod_index ++
+ "Skipping " ++ showModMsg have_object mod_summary)
+ new_details <- {-# SCC "tcRnIface" #-}
+ initIfaceCheck hsc_env $
+ typecheckIface old_iface
+ dumpIfaceStats hsc_env
+ return (a, old_iface, new_details)
+
+--------------------------------------------------------------
+-- FrontEnds
+--------------------------------------------------------------
+
+hscCoreFrontEnd :: FrontEnd ModGuts
+hscCoreFrontEnd hsc_env mod_summary mb_mod_index = do {
+ -------------------
+ -- PARSE
+ -------------------
+ ; inp <- readFile (expectJust "hscCoreFrontEnd" (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 -> do {
+
+ -------------------
+ -- RENAME and TYPECHECK
+ -------------------
+ ; (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 :: FrontEnd ModGuts
+hscFileFrontEnd hsc_env mod_summary mb_mod_index = do {
+ -------------------
+ -- DISPLAY PROGRESS MESSAGE
+ -------------------
+ ; let dflags = hsc_dflags hsc_env
+ one_shot = isOneShot (ghcMode dflags)
+ toInterp = hscTarget dflags == HscInterpreted
+ ; when (not one_shot) $
+ compilationProgressMsg dflags $
+ (showModuleIndex mb_mod_index ++
+ "Compiling " ++ showModMsg (not toInterp) mod_summary)
+
+ -------------------
+ -- PARSE
+ -------------------
+ ; let hspp_file = expectJust "hscFileFrontEnd" (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 -> do {
+
+ -------------------
+ -- RENAME and TYPECHECK
+ -------------------
+ (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 -> do {
+
+ -------------------
+ -- DESUGAR
+ -------------------
+ ; (warns, maybe_ds_result) <- {-# SCC "DeSugar" #-}
+ deSugar hsc_env tc_result
+ ; printBagOfWarnings dflags warns
+ ; return maybe_ds_result
+ }}}}}
+
+--------------------------------------------------------------
+-- BackEnds
+--------------------------------------------------------------
+
+hscNewBootBackEnd :: BackEnd ModGuts (HscStatus, ModIface, ModDetails)
+hscNewBootBackEnd hsc_env mod_summary maybe_old_iface ds_result
+ = do details <- mkBootModDetails hsc_env ds_result
+ (new_iface, no_change)
+ <- {-# SCC "MkFinalIface" #-}
+ mkIface hsc_env maybe_old_iface ds_result details
+ writeIfaceFile hsc_env (ms_location mod_summary) new_iface no_change
+ -- And the answer is ...
+ dumpIfaceStats hsc_env
+ return (HscRecomp False, new_iface, details)
+
+hscNewBackEnd :: BackEnd ModGuts (ModIface, ModDetails, CgGuts)
+hscNewBackEnd hsc_env mod_summary maybe_old_iface ds_result
+ = do { -- OMITTED:
+ -- ; seqList imported_modules (return ())
+
+ let dflags = hsc_dflags hsc_env
+
+ -------------------
+ -- FLATTENING
+ -------------------
+ ; flat_result <- {-# SCC "Flattening" #-}
+ flatten hsc_env ds_result
+
+
+{- TEMP: need to review space-leak fixing here
+ NB: even the code generator can force one of the
+ thunks for constructor arguments, for newtypes in particular
+
+ ; let -- Rule-base accumulated from imported packages
+ pkg_rule_base = eps_rule_base (hsc_EPS hsc_env)
+
+ -- In one-shot mode, ZAP the external package state at
+ -- this point, because we aren't going to need it from
+ -- now on. We keep the name cache, however, because
+ -- tidyCore needs it.
+ pcs_middle
+ | one_shot = pcs_tc{ pcs_EPS = error "pcs_EPS missing" }
+ | otherwise = pcs_tc
+
+ ; pkg_rule_base `seq` pcs_middle `seq` return ()
+-}
-hscNoRecomp dflags location maybe_checked_iface hst hit pcs_ch
- = do {
- hPutStrLn stderr "COMPILATION NOT REQUIRED";
- -- we definitely expect to have the old interface available
- let old_iface = case maybe_checked_iface of
- Just old_if -> old_if
- Nothing -> panic "hscNoRecomp:old_iface"
- this_mod = mi_module old_iface
- ;
- -- CLOSURE
- (pcs_cl, closure_errs, cl_hs_decls)
- <- closeIfaceDecls dflags hit hst pcs_ch old_iface ;
- if closure_errs then
- return (HscFail pcs_cl)
- else do {
-
- -- TYPECHECK
- maybe_tc_result
- <- typecheckModule dflags this_mod pcs_cl hst hit cl_hs_decls;
- case maybe_tc_result of {
- Nothing -> return (HscFail pcs_cl);
- Just tc_result -> do {
-
- let pcs_tc = tc_pcs tc_result
- env_tc = tc_env tc_result
- local_insts = tc_insts tc_result
- local_rules = tc_rules tc_result
- ;
- -- create a new details from the closed, typechecked, old iface
- let new_details = mkModDetailsFromIface env_tc local_insts local_rules
- ;
- return (HscOK new_details
- Nothing -- tells CM to use old iface and linkables
- Nothing Nothing -- foreign export stuff
- Nothing -- ibinds
- pcs_tc)
- }}}}
-
-
-hscRecomp dflags location maybe_checked_iface hst hit pcs_ch
- = do {
- hPutStrLn stderr "COMPILATION IS REQUIRED";
-
- -- what target are we shooting for?
- let toInterp = dopt_HscLang dflags == HscInterpreted
- ;
- -- PARSE
- maybe_parsed
- <- myParseModule dflags (unJust (ml_hspp_file location) "hscRecomp:hspp");
- case maybe_parsed of {
- Nothing -> return (HscFail pcs_ch);
- Just rdr_module -> do {
-
- -- RENAME
- let this_mod = mkModuleInThisPackage (hsModuleName rdr_module)
- ;
- show_pass dflags "Renamer";
- (pcs_rn, maybe_rn_result)
- <- renameModule dflags hit hst pcs_ch this_mod rdr_module;
- case maybe_rn_result of {
- Nothing -> return (HscFail pcs_rn);
- Just (new_iface, rn_hs_decls) -> do {
-
- -- TYPECHECK
- show_pass dflags "Typechecker";
- maybe_tc_result
- <- typecheckModule dflags this_mod pcs_rn hst hit rn_hs_decls;
- case maybe_tc_result of {
- Nothing -> do { hPutStrLn stderr "Typechecked failed"
- ; return (HscFail pcs_rn) } ;
- Just tc_result -> do {
-
- let pcs_tc = tc_pcs tc_result
- env_tc = tc_env tc_result
- local_insts = tc_insts tc_result
- ;
- -- DESUGAR, SIMPLIFY, TIDY-CORE
- -- We grab the the unfoldings at this point.
- (tidy_binds, orphan_rules, foreign_stuff)
- <- dsThenSimplThenTidy dflags (pcs_rules pcs_tc) this_mod tc_result hst
- ;
- -- CONVERT TO STG
- (stg_binds, oa_tidy_binds, cost_centre_info, top_level_ids)
- <- myCoreToStg dflags this_mod tidy_binds
- ;
- -- cook up a new ModDetails now we (finally) have all the bits
- let new_details = mkModDetails env_tc local_insts tidy_binds
- top_level_ids orphan_rules
- ;
- -- and the final interface
- final_iface
- <- mkFinalIface dflags location maybe_checked_iface new_iface new_details
- ;
- -- do the rest of code generation/emission
- (maybe_stub_h_filename, maybe_stub_c_filename, maybe_ibinds)
- <- restOfCodeGeneration dflags toInterp this_mod
- (map ideclName (hsModuleImports rdr_module))
- cost_centre_info foreign_stuff env_tc stg_binds oa_tidy_binds
- hit (pcs_PIT pcs_tc)
- ;
- -- and the answer is ...
- return (HscOK new_details (Just final_iface)
- maybe_stub_h_filename maybe_stub_c_filename
- maybe_ibinds pcs_tc)
- }}}}}}}
-
-
-
-mkFinalIface dflags location maybe_old_iface new_iface new_details
- = case completeIface maybe_old_iface new_iface new_details of
- (new_iface, Nothing) -- no change in the interfacfe
- -> do if dopt Opt_D_dump_hi_diffs dflags then
- printDump (text "INTERFACE UNCHANGED")
- else return ()
- return new_iface
- (new_iface, Just sdoc)
- -> do dumpIfSet_dyn dflags Opt_D_dump_hi_diffs "NEW INTERFACE" sdoc
- -- Write the interface file
- writeIface (unJust (ml_hi_file location) "hscRecomp:hi") new_iface
- return new_iface
-
-
-myParseModule dflags src_filename
- = do -------------------------- Parser ----------------
- show_pass dflags "Parser"
- -- _scc_ "Parser"
-
- buf <- hGetStringBuffer True{-expand tabs-} src_filename
-
- let glaexts | dopt Opt_GlasgowExts dflags = 1#
- | otherwise = 0#
-
- case parse buf PState{ bol = 0#, atbol = 1#,
- context = [], glasgow_exts = glaexts,
- loc = mkSrcLoc (_PK_ src_filename) 1 } of {
-
- PFailed err -> do { hPutStrLn stderr (showSDoc err);
- return Nothing };
- POk _ rdr_module@(HsModule mod_name _ _ _ _ _ _) -> do {
+ -- alive at this point:
+ -- pcs_middle
+ -- flat_result
+ -- pkg_rule_base
+
+ -------------------
+ -- SIMPLIFY
+ -------------------
+ ; simpl_result <- {-# SCC "Core2Core" #-}
+ core2core hsc_env flat_result
+
+ -------------------
+ -- TIDY
+ -------------------
+ ; (cg_guts, details) <- {-# SCC "CoreTidy" #-}
+ tidyProgram hsc_env simpl_result
+
+ -- Alive at this point:
+ -- tidy_result, pcs_final
+ -- hsc_env
+
+ -------------------
+ -- 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 simpl_result details
+
+ ; writeIfaceFile hsc_env (ms_location mod_summary) new_iface no_change
+
+ -- Emit external core
+ ; emitExternalCore dflags cg_guts
+
+ -------------------
+ -- Return the prepared code.
+ ; return (new_iface, details, cg_guts)
+ }
+
+--------------------------------------------------------------
+-- Code generators
+--------------------------------------------------------------
+
+-- Don't output any code.
+hscCodeGenNothing :: CodeGen (ModIface, ModDetails, CgGuts) (HscStatus, ModIface, ModDetails)
+hscCodeGenNothing hsc_env mod_summary (iface, details, cgguts)
+ = return (HscRecomp False, iface, details)
+
+-- Generate code and return both the new ModIface and the ModDetails.
+hscCodeGenMake :: CodeGen (ModIface, ModDetails, CgGuts) (HscStatus, ModIface, ModDetails)
+hscCodeGenMake hsc_env mod_summary (iface, details, cgguts)
+ = do hasStub <- hscCodeGenCompile hsc_env mod_summary cgguts
+ return (HscRecomp hasStub, iface, details)
+
+-- Here we don't need the ModIface and ModDetails anymore.
+hscCodeGenOneShot :: CodeGen (ModIface, ModDetails, CgGuts) HscStatus
+hscCodeGenOneShot hsc_env mod_summary (_, _, cgguts)
+ = do hasStub <- hscCodeGenCompile hsc_env mod_summary cgguts
+ return (HscRecomp hasStub)
+
+hscCodeGenCompile :: CodeGen CgGuts Bool
+hscCodeGenCompile hsc_env mod_summary cgguts
+ = 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_home_mods = home_mods,
+ cg_dep_pkgs = dependencies } = 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,
+ -- but we don't generate any code for newtypes
+
+ -------------------
+ -- PREPARE FOR CODE GENERATION
+ -- Do saturation and convert to A-normal form
+ prepd_binds <- {-# SCC "CorePrep" #-}
+ corePrepPgm dflags core_binds data_tycons ;
+ ----------------- Convert to STG ------------------
+ (stg_binds, cost_centre_info)
+ <- {-# SCC "CoreToStg" #-}
+ myCoreToStg dflags home_mods this_mod prepd_binds
+ ------------------ Code generation ------------------
+ abstractC <- {-# SCC "CodeGen" #-}
+ codeGen dflags home_mods this_mod data_tycons
+ foreign_stubs dir_imps cost_centre_info
+ stg_binds
+ ------------------ Code output -----------------------
+ (stub_h_exists,stub_c_exists)
+ <- codeOutput dflags this_mod location foreign_stubs
+ dependencies abstractC
+ return stub_c_exists
+
+hscCodeGenIdentity :: CodeGen a a
+hscCodeGenIdentity hsc_env mod_summary a = return a
+
+hscCodeGenConst :: b -> CodeGen a b
+hscCodeGenConst b hsc_env mod_summary a = return b
+
+hscCodeGenInteractive :: CodeGen (ModIface, ModDetails, CgGuts)
+ (InteractiveStatus, ModIface, ModDetails)
+hscCodeGenInteractive hsc_env mod_summary (iface, details, cgguts)
+#ifdef GHCI
+ = 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_foreign = foreign_stubs,
+ cg_home_mods = home_mods,
+ cg_dep_pkgs = dependencies } = 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,
+ -- but we don't generate any code for newtypes
+
+ -------------------
+ -- PREPARE FOR CODE GENERATION
+ -- Do saturation and convert to A-normal form
+ prepd_binds <- {-# SCC "CorePrep" #-}
+ corePrepPgm dflags core_binds data_tycons ;
+ ----------------- Generate byte code ------------------
+ comp_bc <- byteCodeGen dflags prepd_binds data_tycons
+ ------------------ 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, iface, details)
+#else
+ = panic "GHC not compiled with interpreter"
+#endif
+
+
+------------------------------
+
+hscFileCheck :: HscEnv -> ModSummary -> IO (Maybe HscChecked)
+hscFileCheck hsc_env mod_summary = do {
+ -------------------
+ -- PARSE
+ -------------------
+ ; let dflags = hsc_dflags hsc_env
+ hspp_file = expectJust "hscFileFrontEnd" (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 -> do {
+
+ -------------------
+ -- RENAME and TYPECHECK
+ -------------------
+ (tc_msgs, maybe_tc_result)
+ <- _scc_ "Typecheck-Rename"
+ tcRnModule hsc_env (ms_hsc_src mod_summary)
+ True{-save renamed syntax-}
+ rdr_module
+
+ ; printErrorsAndWarnings dflags tc_msgs
+ ; case maybe_tc_result of {
+ Nothing -> return (Just (HscChecked rdr_module Nothing Nothing));
+ Just tc_result -> do
+ let md = ModDetails {
+ md_types = tcg_type_env tc_result,
+ md_exports = tcg_exports tc_result,
+ md_insts = tcg_insts tc_result,
+ md_rules = [panic "no rules"] }
+ -- Rules are CoreRules, not the
+ -- RuleDecls we get out of the typechecker
+ rnInfo = do decl <- tcg_rn_decls tc_result
+ imports <- tcg_rn_imports tc_result
+ let exports = tcg_rn_exports tc_result
+ return (decl,imports,exports)
+ return (Just (HscChecked rdr_module
+ rnInfo
+ (Just (tcg_binds tc_result,
+ tcg_rdr_env tc_result,
+ md))))
+ }}}}
+
+
+hscCmmFile :: DynFlags -> FilePath -> IO Bool
+hscCmmFile dflags filename = do
+ maybe_cmm <- parseCmmFile dflags (mkHomeModules []) filename
+ case maybe_cmm of
+ Nothing -> return False
+ Just cmm -> do
+ codeOutput dflags no_mod no_loc NoStubs [] [cmm]
+ return True
+ 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" }
+
+
+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 _ rdr_module -> do {
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 (Just rdr_module)
+ return (Right rdr_module)
+ -- ToDo: free the string buffer later.
}}
-restOfCodeGeneration dflags toInterp this_mod imported_module_names cost_centre_info
- foreign_stuff env_tc stg_binds oa_tidy_binds
- hit pit -- these last two for mapping ModNames to Modules
- | toInterp
- = do (ibinds,itbl_env)
- <- stgToInterpSyn (map fst stg_binds) local_tycons local_classes
- return (Nothing, Nothing, Just (ibinds,itbl_env))
-
- | otherwise
- = do -------------------------- Code generation -------------------------------
- show_pass dflags "CodeGen"
- -- _scc_ "CodeGen"
- abstractC <- codeGen dflags this_mod imported_modules
- cost_centre_info fe_binders
- local_tycons stg_binds
-
- -------------------------- Code output -------------------------------
- show_pass dflags "CodeOutput"
- -- _scc_ "CodeOutput"
- (maybe_stub_h_name, maybe_stub_c_name)
- <- codeOutput dflags this_mod local_tycons
- oa_tidy_binds stg_binds
- c_code h_code abstractC
-
- return (maybe_stub_h_name, maybe_stub_c_name, Nothing)
- where
- local_tycons = typeEnvTyCons env_tc
- local_classes = typeEnvClasses env_tc
- imported_modules = map mod_name_to_Module imported_module_names
- (fe_binders,h_code,c_code) = foreign_stuff
-
- mod_name_to_Module :: ModuleName -> Module
- mod_name_to_Module nm
- = let str_mi = case lookupModuleEnvByName hit nm of
- Just mi -> mi
- Nothing -> case lookupModuleEnvByName pit nm of
- Just mi -> mi
- Nothing -> barf nm
- in mi_module str_mi
- barf nm = pprPanic "mod_name_to_Module: no hst or pst mapping for"
- (ppr nm)
-
-
-dsThenSimplThenTidy dflags rule_base this_mod tc_result hst
- = do -------------------------- Desugaring ----------------
- -- _scc_ "DeSugar"
- show_pass dflags "DeSugar"
- ds_uniqs <- mkSplitUniqSupply 'd'
- (desugared, rules, h_code, c_code, fe_binders)
- <- deSugar dflags this_mod ds_uniqs hst tc_result
-
- -------------------------- Main Core-language transformations ----------------
- -- _scc_ "Core2Core"
- show_pass dflags "Core2Core"
- (simplified, orphan_rules)
- <- core2core dflags rule_base hst desugared rules
-
- -- Do the final tidy-up
- show_pass dflags "CoreTidy"
- (tidy_binds, tidy_orphan_rules)
- <- tidyCorePgm dflags this_mod simplified orphan_rules
-
- return (tidy_binds, tidy_orphan_rules, (fe_binders,h_code,c_code))
+myCoreToStg dflags home_mods this_mod prepd_binds
+ = do
+ stg_binds <- {-# SCC "Core2Stg" #-}
+ coreToStg home_mods prepd_binds
+ (stg_binds2, cost_centre_info) <- {-# SCC "Stg2Stg" #-}
+ stg2stg dflags home_mods this_mod stg_binds
-myCoreToStg dflags this_mod tidy_binds
- = do
- c2s_uniqs <- mkSplitUniqSupply 'c'
- st_uniqs <- mkSplitUniqSupply 'g'
- let occ_anal_tidy_binds = occurAnalyseBinds tidy_binds
+ return (stg_binds2, cost_centre_info)
+\end{code}
+
+
+%************************************************************************
+%* *
+\subsection{Compiling a do-statement}
+%* *
+%************************************************************************
+
+When the UnlinkedBCOExpr is linked you get an HValue of type
+ IO [HValue]
+When you run it you get a list of HValues that should be
+the same length as the list of names; add them to the ClosureEnv.
+
+A naked expression returns a singleton Name [it].
+
+ What you type The IO [HValue] that hscStmt returns
+ ------------- ------------------------------------
+ let pat = expr ==> let pat = expr in return [coerce HVal x, coerce HVal y, ...]
+ bindings: [x,y,...]
+
+ pat <- expr ==> expr >>= \ pat -> return [coerce HVal x, coerce HVal y, ...]
+ bindings: [x,y,...]
+
+ expr (of IO type) ==> expr >>= \ v -> return [v]
+ [NB: result not printed] bindings: [it]
+
- () <- coreBindsSize occ_anal_tidy_binds `seq` return ()
- -- TEMP: the above call zaps some space usage allocated by the
- -- simplifier, which for reasons I don't understand, persists
- -- thoroughout code generation
+ expr (of non-IO type,
+ result showable) ==> let v = expr in print v >> return [v]
+ bindings: [it]
- show_pass dflags "Core2Stg"
- -- _scc_ "Core2Stg"
- let stg_binds = topCoreBindsToStg c2s_uniqs occ_anal_tidy_binds
+ expr (of non-IO type,
+ result not showable) ==> error
- show_pass dflags "Stg2Stg"
- -- _scc_ "Stg2Stg"
- (stg_binds2, cost_centre_info) <- stg2stg dflags this_mod st_uniqs stg_binds
- let final_ids = collectFinalStgBinders (map fst stg_binds2)
+\begin{code}
+#ifdef GHCI
+hscStmt -- Compile a stmt all the way to an HValue, but don't run it
+ :: HscEnv
+ -> String -- The statement
+ -> IO (Maybe (HscEnv, [Name], HValue))
+
+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 (new_ic, bound_names, tc_expr) -> do {
+
+ -- Then desugar, code gen, and link it
+ ; hval <- compileExpr hsc_env iNTERACTIVE
+ (ic_rn_gbl_env new_ic)
+ (ic_type_env new_ic)
+ tc_expr
+
+ ; return (Just (hsc_env{ hsc_IC=new_ic }, bound_names, hval))
+ }}}}}
+
+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 other -> do { errorMsg (hsc_dflags hsc_env) (text "not an expression:" <+> quotes (text expr)) ;
+ return Nothing } ;
+ } }
+
+hscKcType -- Find the kind of a type
+ :: 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 ;
+ Just other -> do { errorMsg (hsc_dflags hsc_env) (text "not an type:" <+> quotes (text str)) ;
+ return Nothing } ;
+ Nothing -> return Nothing } }
+#endif
+\end{code}
+
+\begin{code}
+#ifdef GHCI
+hscParseStmt :: DynFlags -> String -> IO (Maybe (Maybe (LStmt RdrName)))
+hscParseStmt = hscParseThing parseStmt
+
+hscParseType :: DynFlags -> String -> IO (Maybe (LHsType RdrName))
+hscParseType = hscParseThing parseType
+#endif
+
+hscParseIdentifier :: DynFlags -> String -> IO (Maybe (Located RdrName))
+hscParseIdentifier = hscParseThing parseIdentifier
+
+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
- return (stg_binds2, occ_anal_tidy_binds, cost_centre_info, final_ids)
+ let loc = mkSrcLoc FSLIT("<interactive>") 1 0
+ case unP parser (mkPState buf loc dflags) of {
-show_pass dflags what
- = if dopt Opt_D_show_passes dflags
- then hPutStr stderr ("*** "++what++":\n")
- else return ()
+ PFailed span err -> do { printError span err;
+ return Nothing };
+
+ POk _ thing -> do {
+
+ --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)
+ }}
+\end{code}
+
+%************************************************************************
+%* *
+ Desugar, simplify, convert to bytecode, and link an expression
+%* *
+%************************************************************************
+
+\begin{code}
+#ifdef GHCI
+compileExpr :: HscEnv
+ -> Module -> GlobalRdrEnv -> TypeEnv
+ -> LHsExpr Id
+ -> IO HValue
+
+compileExpr hsc_env this_mod rdr_env type_env tc_expr
+ = do { let { dflags = hsc_dflags hsc_env ;
+ lint_on = dopt Opt_DoCoreLinting dflags }
+
+ -- Desugar it
+ ; ds_expr <- deSugarExpr hsc_env this_mod rdr_env type_env tc_expr
+
+ -- 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
+ case lintUnfolding noSrcLoc [] 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 bcos
+
+ ; return hval
+ }
+#endif
\end{code}
%************************************************************************
%* *
-\subsection{Initial persistent state}
+ Statistics on reading interfaces
%* *
%************************************************************************
\begin{code}
-initPersistentCompilerState :: IO PersistentCompilerState
-initPersistentCompilerState
- = do prs <- initPersistentRenamerState
- return (
- PCS { pcs_PIT = emptyIfaceTable,
- pcs_PTE = wiredInThingEnv,
- pcs_insts = emptyInstEnv,
- pcs_rules = emptyRuleBase,
- pcs_PRS = prs
- }
- )
-
-initPersistentRenamerState :: IO PersistentRenamerState
- = do ns <- mkSplitUniqSupply 'r'
- return (
- PRS { prsOrig = Orig { origNames = initOrigNames,
- origIParam = emptyFM },
- prsDecls = (emptyNameEnv, 0),
- prsInsts = (emptyBag, 0),
- prsRules = (emptyBag, 0),
- prsNS = ns
- }
- )
-
-initOrigNames :: FiniteMap (ModuleName,OccName) Name
-initOrigNames
- = grab knownKeyNames `plusFM` grab (map getName wiredInThings)
- where
- grab names = foldl add emptyFM names
- add env name
- = addToFM env (moduleName (nameModule name), nameOccName name) name
-
-
-initRules :: PackageRuleBase
-initRules = emptyRuleBase
-{- SHOULD BE (ish)
- foldl add emptyVarEnv builtinRules
- where
- add env (name,rule)
- = extendRuleBase env name rule
--}
+dumpIfaceStats :: HscEnv -> IO ()
+dumpIfaceStats hsc_env
+ = do { eps <- readIORef (hsc_EPS hsc_env)
+ ; dumpIfSet (dump_if_trace || dump_rn_stats)
+ "Interface statistics"
+ (ifaceStats eps) }
+ where
+ dflags = hsc_dflags hsc_env
+ dump_rn_stats = dopt Opt_D_dump_rn_stats dflags
+ dump_if_trace = dopt Opt_D_dump_if_trace dflags
+\end{code}
+
+%************************************************************************
+%* *
+ Progress Messages: Module i of n
+%* *
+%************************************************************************
+
+\begin{code}
+showModuleIndex Nothing = ""
+showModuleIndex (Just (i,n)) = "[" ++ padded ++ " of " ++ n_str ++ "] "
+ where
+ n_str = show n
+ i_str = show i
+ padded = replicate (length n_str - length i_str) ' ' ++ i_str
\end{code}
+
projects / ghc-hetmet.git / blobdiff