%
% (c) The GRASP/AQUA Project, Glasgow University, 1993-2000
%
+
\section[GHC_Main]{Main driver for Glasgow Haskell compiler}
\begin{code}
-module HscMain ( hscMain ) where
+module HscMain (
+ HscResult(..), hscMain, newHscEnv, hscCmmFile, hscBufferFrontEnd
+#ifdef GHCI
+ , hscStmt, hscTcExpr, hscKcType, hscThing,
+ , compileExpr
+#endif
+ ) where
#include "HsVersions.h"
-import IO ( hPutStr, stderr )
-import HsSyn
+#ifdef GHCI
+import HsSyn ( Stmt(..), LStmt, LHsExpr, LHsType )
+import IfaceSyn ( IfaceDecl )
+import CodeOutput ( outputForeignStubs )
+import ByteCodeGen ( byteCodeGen, coreExprToBCOs )
+import Linker ( HValue, linkExpr )
+import TidyPgm ( tidyCoreExpr )
+import CorePrep ( corePrepExpr )
+import Flattening ( flattenExpr )
+import TcRnDriver ( tcRnStmt, tcRnExpr, tcRnThing, tcRnType )
+import RdrName ( RdrName )
+import Type ( Type )
+import PrelNames ( iNTERACTIVE )
+import StringBuffer ( stringToStringBuffer )
+import SrcLoc ( SrcLoc, noSrcLoc, Located(..) )
+import Kind ( Kind )
+import Var ( Id )
+import CoreLint ( lintUnfolding )
+import DsMeta ( templateHaskellNames )
+import BasicTypes ( Fixity )
+#endif
-import RdrHsSyn ( RdrNameHsModule )
-import FastString ( unpackFS )
import StringBuffer ( hGetStringBuffer )
-import Parser ( parse )
-import Lex ( PState(..), ParseResult(..) )
+import Parser
+import Lexer ( P(..), ParseResult(..), mkPState )
import SrcLoc ( mkSrcLoc )
-
-import Rename ( renameModule )
-
-import PrelInfo ( wiredInThings )
-import PrelRules ( builtinRules )
-import MkIface ( writeIface )
-import TcModule ( TcResults(..), typecheckModule )
-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 IfaceEnv ( initNameCache )
+import LoadIface ( ifaceStats, initExternalPackageState )
+import PrelInfo ( wiredInThings, basicKnownKeyNames )
+import RdrName ( GlobalRdrEnv )
+import MkIface ( checkOldIface, mkIface )
+import Desugar
+import Flattening ( flatten )
+import SimplCore
+import TidyPgm ( tidyCorePgm )
+import CorePrep ( corePrepPgm )
+import CoreToStg ( coreToStg )
+import Name ( Name, NamedThing(..) )
import SimplStg ( stg2stg )
import CodeGen ( codeGen )
+import CmmParse ( parseCmmFile )
import CodeOutput ( codeOutput )
-import Module ( ModuleName, moduleNameUserString )
import CmdLineOpts
-import ErrUtils ( ghcExit, doIfSet, dumpIfSet )
+import DriverPhases ( isExtCoreFilename )
+import ErrUtils
import UniqSupply ( mkSplitUniqSupply )
import Outputable
-import Char ( isSpace )
-import StgInterp ( runStgI )
import HscStats ( ppSourceStats )
+import HscTypes
+import MkExternalCore ( emitExternalCore )
+import ParserCore
+import ParserCoreUtils
+import Module ( Module, ModLocation(..), showModMsg )
+import FastString
+import Maybes ( expectJust )
+import StringBuffer ( StringBuffer )
+import Bag ( unitBag, emptyBag )
+
+import Monad ( when )
+import Maybe ( isJust, fromJust )
+import IO
+import DATA_IOREF ( newIORef, readIORef )
\end{code}
%************************************************************************
%* *
-\subsection{The main compiler pipeline}
+ Initialisation
%* *
%************************************************************************
\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]) -- interpreted code, if any
- PersistentCompilerState -- updated PCS
- (Bag WarnMsg) -- warnings
-
- | HscErrs PersistentCompilerState -- updated PCS
- (Bag ErrMsg) -- errors
- (Bag WarnMsg) -- warnings
-
-hscMain
- :: DynFlags
- -> ModSummary -- summary, including source filename
- -> Maybe ModIFace -- old interface, if available
- -> String -- file in which to put the output (.s, .hc, .java etc.)
- -> HomeSymbolTable -- for home module ModDetails
- -> PersistentCompilerState -- IN: persistent compiler state
- -> IO HscResult
+newHscEnv :: GhciMode -> DynFlags -> IO HscEnv
+newHscEnv ghci_mode dflags
+ = do { eps_var <- newIORef initExternalPackageState
+ ; us <- mkSplitUniqSupply 'r'
+ ; nc_var <- newIORef (initNameCache us knownKeyNames)
+ ; return (HscEnv { hsc_mode = ghci_mode,
+ hsc_dflags = dflags,
+ hsc_HPT = emptyHomePackageTable,
+ hsc_EPS = eps_var,
+ hsc_NC = nc_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}
-hscMain dflags core_cmds stg_cmds summary maybe_old_iface
- output_filename mod_details pcs1
- = do
- source_unchanged :: Bool -- extracted from summary?
- (pcs2, check_errs, (recomp_reqd, maybe_checked_iface))
- <- checkOldIface dflags finder hit hst pcs1 mod source_unchanged
- maybe_old_iface
+%************************************************************************
+%* *
+ The main compiler pipeline
+%* *
+%************************************************************************
- -- test check_errs and give up if a problem happened
- what_next = if recomp_reqd then hscRecomp else hscNoRecomp
+\begin{code}
+data HscResult
+ -- Compilation failed
+ = HscFail
- return $
- what_next dflags core_cmds stg_cmds summary hit hst
- pcs2 maybe_checked_iface
+ -- In IDE mode: we just do the static/dynamic checks
+ | HscChecked
-hscNoRecomp = panic "hscNoRecomp"
+ -- Concluded that it wasn't necessary
+ | HscNoRecomp ModDetails -- new details (HomeSymbolTable additions)
+ ModIface -- new iface (if any compilation was done)
-hscRecomp dflags core_cmds stg_cmds summary hit hst pcs maybe_old_iface
- = do
- -- parsed :: RdrNameHsModule
- parsed <- parseModule summary
- -- check for parse errors
-
- (pcs_rn, maybe_rn_result)
- <- renameModule dflags finder hit hst pcs mod parsed
-
- -- check maybe_rn_result for failure
-
- (new_iface, rn_hs_decls) = unJust maybe_rn_result
-
- maybe_tc_result
- <- typecheckModule dflags mod pcs hst hit pit rn_hs_decls
-
- -- check maybe_tc_result for failure
- let tc_result = unJust maybe_tc_result
- let tc_pcs = tc_pcs tc_result
- let tc_env = tc_env tc_result
- let tc_binds = tc_binds tc_result
- let local_tycons = tc_tycons tc_result
- let local_classes = tc_classes tc_result
-
- -- desugar, simplify and tidy, to create the unfoldings
- -- why is this IO-typed?
- (tidy_binds, orphan_rules, fe_binders, h_code, c_code) -- return modDetails?
- <- dsThenSimplThenTidy dflags mod tc_result rule_base ds_uniqs
-
- -- convert to Stg; needed for binders
- (stg_binds, cost_centre_info, top_level_ids)
- <- myCoreToStg c2s_uniqs st_uniqs this_mod tidy_binds
-
- -- cook up a new ModDetails now we (finally) have all the bits
- let new_details = completeModDetails tc_env tidy_binds top_level_ids orphan_rules
-
- -- and possibly create a new ModIface
- let maybe_final_iface = completeIface maybe_old_iface new_iface new_details
-
- -- do the rest of code generation/emission
- -- this is obviously nonsensical: FIX
- (unlinkeds, stub_h_filename, stub_c_filename)
- <- restOfCodeGeneration this_mod imported_modules cost_centre_info
- fe_binders local_tycons local_classes stg_binds
-
- -- and the answer is ...
- return (HscOK new_details maybe_final_iface stub_h_filename stub_c_filename
- unlinkeds tc_pcs (unionBags rn_warns tc_warns))
-
-
-restOfCodeGeneration this_mod imported_modules cost_centre_info
- fe_binders local_tycons local_classes stg_binds
- = do -------------------------- Code generation -------------------------------
- show_pass "CodeGen"
- -- _scc_ "CodeGen"
- abstractC <- codeGen this_mod imported_modules
- cost_centre_info fe_binders
- local_tycons local_classes stg_binds
-
- -------------------------- Code output -------------------------------
- show_pass "CodeOutput"
- -- _scc_ "CodeOutput"
- (maybe_stub_h_name, maybe_stub_c_name)
- <- codeOutput this_mod local_tycons local_classes
- occ_anal_tidy_binds stg_binds2
- c_code h_code abstractC ncg_uniqs
-
- -- this is obviously nonsensical: FIX
- return (maybe_stub_h_name, maybe_stub_c_name, [])
-
-
-dsThenSimplThenTidy dflags mod tc_result rule_base ds_uniqs
- = do -------------------------- Desugaring ----------------
- -- _scc_ "DeSugar"
- (desugared, rules, h_code, c_code, fe_binders)
- <- deSugar this_mod ds_uniqs tc_results
-
- -------------------------- Main Core-language transformations ----------------
- -- _scc_ "Core2Core"
- (simplified, orphan_rules) <- core2core core_cmds desugared rules
-
- -- Do the final tidy-up
- (tidy_binds, tidy_orphan_rules)
- <- tidyCorePgm this_mod simplified orphan_rules
-
- return (tidy_binds, tidy_orphan_rules, fe_binders, h_code, c_code)
+ -- Did recompilation
+ | HscRecomp ModDetails -- new details (HomeSymbolTable additions)
+ (Maybe GlobalRdrEnv)
+ ModIface -- new iface (if any compilation was done)
+ Bool -- stub_h exists
+ Bool -- stub_c exists
+ (Maybe CompiledByteCode)
+-- What to do when we have compiler error or warning messages
+type MessageAction = Messages -> IO ()
-myCoreToStg c2s_uniqs st_uniqs this_mod tidy_binds
- = do let occ_anal_tidy_binds = occurAnalyseBinds tidy_binds
+ -- no errors or warnings; the individual passes
+ -- (parse/rename/typecheck) print messages themselves
- () <- 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
-
- show_pass "Core2Stg"
- -- _scc_ "Core2Stg"
- let stg_binds = topCoreBindsToStg c2s_uniqs occ_anal_tidy_binds
+hscMain
+ :: HscEnv
+ -> MessageAction -- what to do with errors/warnings
+ -> Module
+ -> ModLocation -- location info
+ -> Bool -- True <=> source unchanged
+ -> Bool -- True <=> have an object file (for msgs only)
+ -> Maybe ModIface -- old interface, if available
+ -> IO HscResult
- show_pass "Stg2Stg"
- -- _scc_ "Stg2Stg"
- (stg_binds2, cost_centre_info) <- stg2stg stg_cmds this_mod st_uniqs stg_binds
- let final_ids = collectFinalStgBinders (map fst stg_binds2)
+hscMain hsc_env msg_act mod location
+ source_unchanged have_object maybe_old_iface
+ = do {
+ (recomp_reqd, maybe_checked_iface) <-
+ _scc_ "checkOldIface"
+ checkOldIface hsc_env mod
+ (ml_hi_file location)
+ source_unchanged maybe_old_iface;
+
+ let no_old_iface = not (isJust maybe_checked_iface)
+ what_next | recomp_reqd || no_old_iface = hscRecomp
+ | otherwise = hscNoRecomp
+
+ ; what_next hsc_env msg_act have_object
+ mod location maybe_checked_iface
+ }
+
+
+-- hscNoRecomp definitely expects to have the old interface available
+hscNoRecomp hsc_env msg_act have_object
+ mod location (Just old_iface)
+ | hsc_mode hsc_env == OneShot
+ = do {
+ when (verbosity (hsc_dflags hsc_env) > 0) $
+ hPutStrLn stderr "compilation IS NOT required";
+ dumpIfaceStats hsc_env ;
+
+ let { bomb = panic "hscNoRecomp:OneShot" };
+ return (HscNoRecomp bomb bomb)
+ }
+ | otherwise
+ = do {
+ when (verbosity (hsc_dflags hsc_env) >= 1) $
+ hPutStrLn stderr ("Skipping " ++
+ showModMsg have_object mod location);
+
+ new_details <- _scc_ "tcRnIface"
+ typecheckIface hsc_env old_iface ;
+ dumpIfaceStats hsc_env ;
+
+ return (HscNoRecomp new_details old_iface)
+ }
+
+hscRecomp hsc_env msg_act have_object
+ mod location maybe_checked_iface
+ = do {
+ -- what target are we shooting for?
+ ; let one_shot = hsc_mode hsc_env == OneShot
+ ; let dflags = hsc_dflags hsc_env
+ ; let toInterp = dopt_HscLang dflags == HscInterpreted
+ ; let toCore = isJust (ml_hs_file location) &&
+ isExtCoreFilename (fromJust (ml_hs_file location))
+
+ ; when (not one_shot && verbosity dflags >= 1) $
+ hPutStrLn stderr ("Compiling " ++
+ showModMsg (not toInterp) mod location);
+
+ ; front_res <- if toCore then
+ hscCoreFrontEnd hsc_env msg_act location
+ else
+ hscFileFrontEnd hsc_env msg_act location
+
+ ; case front_res of
+ Left flure -> return flure;
+ Right ds_result -> do {
+
+
+ -- OMITTED:
+ -- ; seqList imported_modules (return ())
+
+ -------------------
+ -- 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 ()
+-}
+
+ -- alive at this point:
+ -- pcs_middle
+ -- flat_result
+ -- pkg_rule_base
+
+ -------------------
+ -- SIMPLIFY
+ -------------------
+ ; simpl_result <- _scc_ "Core2Core"
+ core2core hsc_env flat_result
+
+ -------------------
+ -- TIDY
+ -------------------
+ ; tidy_result <- _scc_ "CoreTidy"
+ tidyCorePgm hsc_env simpl_result
+
+ -- Emit external core
+ ; emitExternalCore dflags tidy_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 <- _scc_ "MkFinalIface"
+ mkIface hsc_env location
+ maybe_checked_iface tidy_result
+
+
+ -- Space leak reduction: throw away the new interface if
+ -- we're in one-shot mode; we won't be needing it any
+ -- more.
+ ; final_iface <-
+ if one_shot then return (error "no final iface")
+ else return new_iface
+ ; let { final_globals | one_shot = Nothing
+ | otherwise = Just $! (mg_rdr_env tidy_result) }
+ ; final_globals `seq` return ()
+
+ -- Build the final ModDetails (except in one-shot mode, where
+ -- we won't need this information after compilation).
+ ; final_details <-
+ if one_shot then return (error "no final details")
+ else return $! ModDetails {
+ md_types = mg_types tidy_result,
+ md_insts = mg_insts tidy_result,
+ md_rules = mg_rules tidy_result }
+
+ -------------------
+ -- CONVERT TO STG and COMPLETE CODE GENERATION
+ ; (stub_h_exists, stub_c_exists, maybe_bcos)
+ <- hscBackEnd dflags tidy_result
+
+ -- And the answer is ...
+ ; dumpIfaceStats hsc_env
+
+ ; return (HscRecomp final_details
+ final_globals
+ final_iface
+ stub_h_exists stub_c_exists
+ maybe_bcos)
+ }}
+
+hscCoreFrontEnd hsc_env msg_act location = do {
+ -------------------
+ -- PARSE
+ -------------------
+ ; inp <- readFile (expectJust "hscCoreFrontEnd:hspp" (ml_hspp_file location))
+ ; case parseCore inp 1 of
+ FailP s -> hPutStrLn stderr s >> return (Left HscFail)
+ OkP rdr_module -> do {
+
+ -------------------
+ -- RENAME and TYPECHECK
+ -------------------
+ ; (tc_msgs, maybe_tc_result) <- _scc_ "TypeCheck"
+ tcRnExtCore hsc_env rdr_module
+ ; msg_act tc_msgs
+ ; case maybe_tc_result of {
+ Nothing -> return (Left HscFail);
+ Just mod_guts -> return (Right mod_guts)
+ -- No desugaring to do!
+ }}}
+
+
+hscFileFrontEnd hsc_env msg_act location = do {
+ -------------------
+ -- PARSE
+ -------------------
+ ; maybe_parsed <- myParseModule (hsc_dflags hsc_env)
+ (expectJust "hscFrontEnd:hspp" (ml_hspp_file location))
+
+ ; case maybe_parsed of {
+ Left err -> do { msg_act (unitBag err, emptyBag) ;
+ ; return (Left HscFail) ;
+ };
+ Right rdr_module -> hscFrontEnd hsc_env msg_act rdr_module
+ }}
+
+-- Perform static/dynamic checks on the source code in a StringBuffer
+-- This is a temporary solution: it'll read in interface files lazily, whereas
+-- we probably want to use the compilation manager to load in all the modules
+-- in a project.
+hscBufferFrontEnd :: HscEnv -> StringBuffer -> MessageAction -> IO HscResult
+hscBufferFrontEnd hsc_env buffer msg_act = do
+ let loc = mkSrcLoc (mkFastString "*edit*") 1 0
+ case unP parseModule (mkPState buffer loc (hsc_dflags hsc_env)) of
+ PFailed span err -> do
+ msg_act (emptyBag, unitBag (mkPlainErrMsg span err))
+ return HscFail
+ POk _ rdr_module -> do
+ r <- hscFrontEnd hsc_env msg_act rdr_module
+ case r of
+ Left r -> return r
+ Right _ -> return HscChecked
+
+
+
+hscFrontEnd hsc_env msg_act rdr_module = do {
+ -------------------
+ -- RENAME and TYPECHECK
+ -------------------
+ ; (tc_msgs, maybe_tc_result) <- _scc_ "Typecheck-Rename"
+ tcRnModule hsc_env rdr_module
+ ; msg_act tc_msgs
+ ; case maybe_tc_result of {
+ Nothing -> return (Left HscFail);
+ Just tc_result -> do {
+
+ -------------------
+ -- DESUGAR
+ -------------------
+ ; (warns, maybe_ds_result) <- _scc_ "DeSugar"
+ deSugar hsc_env tc_result
+ ; msg_act (warns, emptyBag)
+ ; case maybe_ds_result of
+ Nothing -> return (Left HscFail);
+ Just ds_result -> return (Right ds_result);
+ }}}
+
+hscBackEnd dflags
+ ModGuts{ -- This is the last use of the ModGuts in a compilation.
+ -- From now on, we just use the bits we need.
+ mg_module = this_mod,
+ mg_binds = core_binds,
+ mg_types = type_env,
+ mg_dir_imps = dir_imps,
+ mg_foreign = foreign_stubs,
+ mg_deps = dependencies } = do {
+
+ -------------------
+ -- PREPARE FOR CODE GENERATION
+ -- Do saturation and convert to A-normal form
+ prepd_binds <- _scc_ "CorePrep"
+ corePrepPgm dflags core_binds type_env;
+
+ case dopt_HscLang dflags of
+ HscNothing -> return (False, False, Nothing)
+
+ HscInterpreted ->
+#ifdef GHCI
+ do ----------------- Generate byte code ------------------
+ comp_bc <- byteCodeGen dflags prepd_binds type_env
+
+ ------------------ Create f-x-dynamic C-side stuff ---
+ (istub_h_exists, istub_c_exists)
+ <- outputForeignStubs dflags foreign_stubs
+
+ return ( istub_h_exists, istub_c_exists, Just comp_bc )
+#else
+ panic "GHC not compiled with interpreter"
+#endif
- return (stg_binds2, cost_centre_info, final_ids)
+ other ->
+ do
+ ----------------- Convert to STG ------------------
+ (stg_binds, cost_centre_info) <- _scc_ "CoreToStg"
+ myCoreToStg dflags this_mod prepd_binds
+
+ ------------------ Code generation ------------------
+ abstractC <- _scc_ "CodeGen"
+ codeGen dflags this_mod type_env foreign_stubs
+ dir_imps cost_centre_info stg_binds
+
+ ------------------ Code output -----------------------
+ (stub_h_exists, stub_c_exists)
+ <- codeOutput dflags this_mod foreign_stubs
+ dependencies abstractC
+
+ return (stub_h_exists, stub_c_exists, Nothing)
+ }
+
+
+hscCmmFile :: DynFlags -> FilePath -> IO Bool
+hscCmmFile dflags filename = do
+ maybe_cmm <- parseCmmFile dflags filename
+ case maybe_cmm of
+ Nothing -> return False
+ Just cmm -> do
+ codeOutput dflags no_mod NoStubs noDependencies [cmm]
+ return True
+ where
+ no_mod = panic "hscCmmFile: no_mod"
-#if 0
--- BEGIN old stuff
- -------------------------- Reader ----------------
- show_pass "Parser" >>
- _scc_ "Parser"
- let src_filename -- name of the preprocessed source file
- = case ms_ppsource summary of
- Just (filename, fingerprint) -> filename
- Nothing -> pprPanic "hscMain:summary is not of a source module"
- (ppr summary)
+myParseModule dflags src_filename
+ = do -------------------------- Parser ----------------
+ showPass dflags "Parser"
+ _scc_ "Parser" do
+ buf <- hGetStringBuffer src_filename
- buf <- hGetStringBuffer True{-expand tabs-} src_filename
+ let loc = mkSrcLoc (mkFastString src_filename) 1 0
- let glaexts | dopt Opt_GlasgowExts dflags = 1#
- | otherwise = 0#
+ case unP parseModule (mkPState buf loc dflags) of {
- case parse buf PState{ bol = 0#, atbol = 1#,
- context = [], glasgow_exts = glaexts,
- loc = mkSrcLoc src_filename 1 } of {
+ PFailed span err -> return (Left (mkPlainErrMsg span err));
- PFailed err -> return (HscErrs pcs (unitBag err) emptyBag)
+ POk _ rdr_module -> do {
- POk _ rdr_module@(HsModule mod_name _ _ _ _ _ _) ->
+ 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.
+ }}
- dumpIfSet (dopt_D_dump_parsed flags) "Parser" (ppr rdr_module) >>
- dumpIfSet (dopt_D_source_stats flags) "Source Statistics"
- (ppSourceStats False rdr_module) >>
+myCoreToStg dflags this_mod prepd_binds
+ = do
+ stg_binds <- _scc_ "Core2Stg"
+ coreToStg dflags prepd_binds
- -- UniqueSupplies for later use (these are the only lower case uniques)
- mkSplitUniqSupply 'd' >>= \ ds_uniqs -> -- desugarer
- mkSplitUniqSupply 'r' >>= \ ru_uniqs -> -- rules
- mkSplitUniqSupply 'c' >>= \ c2s_uniqs -> -- core-to-stg
- mkSplitUniqSupply 'g' >>= \ st_uniqs -> -- stg-to-stg passes
- mkSplitUniqSupply 'n' >>= \ ncg_uniqs -> -- native-code generator
+ (stg_binds2, cost_centre_info) <- _scc_ "Core2Stg"
+ stg2stg dflags this_mod stg_binds
- -------------------------- Rename ----------------
- show_pass "Renamer" >>
- _scc_ "Renamer"
+ return (stg_binds2, cost_centre_info)
+\end{code}
- renameModule dflags finder pcs hst rdr_module
- >>= \ (pcs_rn, maybe_rn_stuff) ->
- case maybe_rn_stuff of {
- Nothing -> -- Hurrah! Renamer reckons that there's no need to
- -- go any further
- reportCompile mod_name "Compilation NOT required!" >>
- return ();
-
- Just (this_mod, rn_mod,
- old_iface, new_iface,
- rn_name_supply, fixity_env,
- imported_modules) ->
- -- Oh well, we've got to recompile for real
+%************************************************************************
+%* *
+\subsection{Compiling a do-statement}
+%* *
+%************************************************************************
- -------------------------- Typechecking ----------------
- show_pass "TypeCheck" >>
- _scc_ "TypeCheck"
- typecheckModule dflags mod pcs hst hit pit rn_mod
- -- tc_uniqs rn_name_supply
- -- fixity_env rn_mod
- >>= \ maybe_tc_stuff ->
- case maybe_tc_stuff of {
- Nothing -> ghcExit 1; -- Type checker failed
+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.
- Just (tc_results@(TcResults {tc_tycons = local_tycons,
- tc_classes = local_classes,
- tc_insts = inst_info })) ->
+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,...]
- -------------------------- Desugaring ----------------
- _scc_ "DeSugar"
- deSugar this_mod ds_uniqs tc_results >>= \ (desugared, rules, h_code, c_code, fe_binders) ->
+ 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]
+
- -------------------------- Main Core-language transformations ----------------
- _scc_ "Core2Core"
- core2core core_cmds desugared rules >>= \ (simplified, orphan_rules) ->
+ expr (of non-IO type,
+ result showable) ==> let v = expr in print v >> return [v]
+ bindings: [it]
- -- Do the final tidy-up
- tidyCorePgm this_mod
- simplified orphan_rules >>= \ (tidy_binds, tidy_orphan_rules) ->
+ expr (of non-IO type,
+ result not showable) ==> error
- -- Run the occurrence analyser one last time, so that
- -- dead binders get dead-binder info. This is exploited by
- -- code generators to avoid spitting out redundant bindings.
- -- The occurrence-zapping in Simplify.simplCaseBinder means
- -- that the Simplifier nukes useful dead-var stuff especially
- -- in case patterns.
- let occ_anal_tidy_binds = occurAnalyseBinds tidy_binds in
+\begin{code}
+#ifdef GHCI
+hscStmt -- Compile a stmt all the way to an HValue, but don't run it
+ :: HscEnv
+ -> InteractiveContext -- Context for compiling
+ -> String -- The statement
+ -> IO (Maybe (InteractiveContext, [Name], HValue))
+
+hscStmt hsc_env icontext 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
+ 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 (new_ic, bound_names, hval))
+ }}}}}
+
+hscTcExpr -- Typecheck an expression (but don't run it)
+ :: HscEnv
+ -> InteractiveContext -- Context for compiling
+ -> String -- The expression
+ -> IO (Maybe Type)
+
+hscTcExpr hsc_env icontext expr
+ = do { maybe_stmt <- hscParseStmt (hsc_dflags hsc_env) expr
+ ; case maybe_stmt of {
+ Nothing -> return Nothing ; -- Parse error
+ Just (Just (L _ (ExprStmt expr _)))
+ -> tcRnExpr hsc_env icontext expr ;
+ Just other -> do { hPutStrLn stderr ("not an expression: `" ++ expr ++ "'") ;
+ return Nothing } ;
+ } }
+
+hscKcType -- Find the kind of a type
+ :: HscEnv
+ -> InteractiveContext -- Context for compiling
+ -> String -- The type
+ -> IO (Maybe Kind)
+
+hscKcType hsc_env icontext str
+ = do { maybe_type <- hscParseType (hsc_dflags hsc_env) str
+ ; case maybe_type of {
+ Just ty -> tcRnType hsc_env icontext ty ;
+ Just other -> do { hPutStrLn stderr ("not an type: `" ++ str ++ "'") ;
+ return Nothing } ;
+ Nothing -> return Nothing } }
+\end{code}
- coreBindsSize occ_anal_tidy_binds `seq`
--- TEMP: the above call zaps some space usage allocated by the
--- simplifier, which for reasons I don't understand, persists
--- thoroughout code generation
+\begin{code}
+hscParseStmt :: DynFlags -> String -> IO (Maybe (Maybe (LStmt RdrName)))
+hscParseStmt = hscParseThing parseStmt
+hscParseType :: DynFlags -> String -> IO (Maybe (LHsType RdrName))
+hscParseType = hscParseThing parseType
+hscParseIdentifier :: DynFlags -> String -> IO (Maybe (Located RdrName))
+hscParseIdentifier = hscParseThing parseIdentifier
- -------------------------- Convert to STG code -------------------------------
- show_pass "Core2Stg" >>
- _scc_ "Core2Stg"
- let
- stg_binds = topCoreBindsToStg c2s_uniqs occ_anal_tidy_binds
- in
+hscParseThing :: Outputable thing
+ => Lexer.P thing
+ -> DynFlags -> String
+ -> IO (Maybe thing)
+ -- Nothing => Parse error (message already printed)
+ -- Just x => success
+hscParseThing parser dflags str
+ = do showPass dflags "Parser"
+ _scc_ "Parser" do
- -------------------------- Simplify STG code -------------------------------
- show_pass "Stg2Stg" >>
- _scc_ "Stg2Stg"
- stg2stg stg_cmds this_mod st_uniqs stg_binds >>= \ (stg_binds2, cost_centre_info) ->
+ buf <- stringToStringBuffer str
-#ifdef GHCI
- runStgI local_tycons local_classes
- (map fst stg_binds2) >>= \ i_result ->
- putStr ("\nANSWER = " ++ show i_result ++ "\n\n")
- >>
+ let loc = mkSrcLoc FSLIT("<interactive>") 1 0
-#else
- -------------------------- Interface file -------------------------------
- -- Dump instance decls and type signatures into the interface file
- _scc_ "Interface"
- let
- final_ids = collectFinalStgBinders (map fst stg_binds2)
- in
- writeIface this_mod old_iface new_iface
- local_tycons local_classes inst_info
- final_ids occ_anal_tidy_binds tidy_orphan_rules >>
-
-
- -------------------------- Code generation -------------------------------
- show_pass "CodeGen" >>
- _scc_ "CodeGen"
- codeGen this_mod imported_modules
- cost_centre_info
- fe_binders
- local_tycons local_classes
- stg_binds2 >>= \ abstractC ->
-
-
- -------------------------- Code output -------------------------------
- show_pass "CodeOutput" >>
- _scc_ "CodeOutput"
- codeOutput this_mod local_tycons local_classes
- occ_anal_tidy_binds stg_binds2
- c_code h_code abstractC
- ncg_uniqs >>
-
-
- -------------------------- Final report -------------------------------
- reportCompile mod_name (showSDoc (ppSourceStats True rdr_module)) >>
+ case unP parser (mkPState buf loc dflags) of {
-#endif
+ PFailed span err -> do { printError span err;
+ return Nothing };
+ POk _ thing -> do {
- ghcExit 0
- } }
- where
- -------------------------------------------------------------
- -- ****** help functions:
-
- show_pass
- = if opt_D_show_passes
- then \ what -> hPutStr stderr ("*** "++what++":\n")
- else \ what -> return ()
--- END old stuff
+ --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)
+ }}
#endif
\end{code}
-
%************************************************************************
%* *
-\subsection{Initial persistent state}
+\subsection{Getting information about an identifer}
%* *
%************************************************************************
\begin{code}
-initPersistentCompilerState :: IO PersistentCompilerState
-initPersistentCompilerState
-<<<<<<< HscMain.lhs
- = do prs <- initPersistentRenamerState
- return (
- PCS { pcs_PST = initPackageDetails,
- pcs_insts = emptyInstEnv,
- pcs_rules = emptyRuleEnv,
- pcs_PRS = initPersistentRenamerState
- }
- )
-=======
- = PCS { pcs_PST = initPackageDetails,
- pcs_insts = emptyInstEnv,
- pcs_rules = initRules,
- pcs_PRS = initPersistentRenamerState }
->>>>>>> 1.12
-
-initPackageDetails :: PackageSymbolTable
-initPackageDetails = extendTypeEnv emptyModuleEnv wiredInThings
-
-initPersistentRenamerState :: IO PersistentRenamerState
- = do ns <- mkSplitUniqSupply 'r'
- return (
- PRS { prsOrig = Orig { origNames = initOrigNames,
- origIParam = emptyFM },
- prsDecls = emptyNameEnv,
- prsInsts = emptyBag,
- prsRules = emptyBag,
- 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 :: RuleEnv
-initRules = foldl add emptyVarEnv builtinRules
- where
- add env (name,rule) = extendNameEnv_C add1 env name [rule]
- add1 rules _ = rule : rules
-\end{code}
-
-
-
-\begin{code}
-writeIface this_mod old_iface new_iface
- local_tycons local_classes inst_info
- final_ids tidy_binds tidy_orphan_rules
- =
- if isNothing opt_HiDir && isNothing opt_HiFile
- then return () -- not producing any .hi file
- else
-
- let
- hi_suf = case opt_HiSuf of { Nothing -> "hi"; Just suf -> suf }
- filename = case opt_HiFile of {
- Just f -> f;
- Nothing ->
- case opt_HiDir of {
- Just dir -> dir ++ '/':moduleUserString this_mod
- ++ '.':hi_suf;
- Nothing -> panic "writeIface"
- }}
- in
-
- do maybe_final_iface <- checkIface old_iface full_new_iface
- case maybe_final_iface of {
- Nothing -> when opt_D_dump_rn_trace $
- putStrLn "Interface file unchanged" ; -- No need to update .hi file
-
- Just final_iface ->
-
- do let mod_vers_unchanged = case old_iface of
- Just iface -> pi_vers iface == pi_vers final_iface
- Nothing -> False
- when (mod_vers_unchanged && opt_D_dump_rn_trace) $
- putStrLn "Module version unchanged, but usages differ; hence need new hi file"
-
- if_hdl <- openFile filename WriteMode
- printForIface if_hdl (pprIface final_iface)
- hClose if_hdl
- }
- where
- full_new_iface = completeIface new_iface local_tycons local_classes
- inst_info final_ids tidy_binds
- tidy_orphan_rules
+#ifdef GHCI
+hscThing -- like hscStmt, but deals with a single identifier
+ :: HscEnv
+ -> InteractiveContext -- Context for compiling
+ -> String -- The identifier
+ -> IO [(IfaceDecl, Fixity, SrcLoc)]
+
+hscThing hsc_env ic str
+ = do maybe_rdr_name <- hscParseIdentifier (hsc_dflags hsc_env) str
+ case maybe_rdr_name of {
+ Nothing -> return [];
+ Just (L _ rdr_name) -> do
+
+ maybe_tc_result <- tcRnThing hsc_env ic rdr_name
+
+ case maybe_tc_result of {
+ Nothing -> return [] ;
+ Just things -> return things
+ }}
+#endif
\end{code}
-
%************************************************************************
-%* *
-\subsection{Printing the interface}
-%* *
+%* *
+ Desugar, simplify, convert to bytecode, and link an expression
+%* *
%************************************************************************
\begin{code}
-pprIface (ParsedIface { pi_mod = mod, pi_vers = mod_vers, pi_orphan = orphan,
- pi_usages = usages, pi_exports = exports,
- pi_fixity = (fix_vers, fixities),
- pi_insts = insts, pi_decls = decls,
- pi_rules = (rule_vers, rules), pi_deprecs = deprecs })
- = vcat [ ptext SLIT("__interface")
- <+> doubleQuotes (ptext opt_InPackage)
- <+> ppr mod <+> ppr mod_vers <+> pp_sub_vers
- <+> (if orphan then char '!' else empty)
- <+> int opt_HiVersion
- <+> ptext SLIT("where")
- , vcat (map pprExport exports)
- , vcat (map pprUsage usages)
- , pprFixities fixities
- , vcat [ppr i <+> semi | i <- insts]
- , vcat [ppr_vers v <+> ppr d <> semi | (v,d) <- decls]
- , pprRules rules
- , pprDeprecs deprecs
- ]
- where
- ppr_vers v | v == initialVersion = empty
- | otherwise = int v
- pp_sub_vers
- | fix_vers == initialVersion && rule_vers == initialVersion = empty
- | otherwise = brackets (ppr fix_vers <+> ppr rule_vers)
-\end{code}
-
-When printing export lists, we print like this:
- Avail f f
- AvailTC C [C, x, y] C(x,y)
- AvailTC C [x, y] C!(x,y) -- Exporting x, y but not C
+#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
-\begin{code}
-pprExport :: ExportItem -> SDoc
-pprExport (mod, items)
- = hsep [ ptext SLIT("__export "), ppr mod, hsep (map upp_avail items) ] <> semi
- where
- upp_avail :: RdrAvailInfo -> SDoc
- upp_avail (Avail name) = pprOccName name
- upp_avail (AvailTC name []) = empty
- upp_avail (AvailTC name ns) = hcat [pprOccName name, bang, upp_export ns']
- where
- bang | name `elem` ns = empty
- | otherwise = char '|'
- ns' = filter (/= name) ns
-
- upp_export [] = empty
- upp_export names = braces (hsep (map pprOccName names))
-\end{code}
+ -- Simplify it
+ ; simpl_expr <- simplifyExpr dflags flat_expr
+ -- Tidy it (temporary, until coreSat does cloning)
+ ; tidy_expr <- tidyCoreExpr simpl_expr
-\begin{code}
-pprUsage :: ImportVersion OccName -> SDoc
-pprUsage (m, has_orphans, is_boot, whats_imported)
- = hsep [ptext SLIT("import"), pprModuleName m,
- pp_orphan, pp_boot,
- upp_import_versions whats_imported
- ] <> semi
- where
- pp_orphan | has_orphans = char '!'
- | otherwise = empty
- pp_boot | is_boot = char '@'
- | otherwise = empty
-
- -- Importing the whole module is indicated by an empty list
- upp_import_versions NothingAtAll = empty
- upp_import_versions (Everything v) = dcolon <+> int v
- upp_import_versions (Specifically vm vf vr nvs)
- = dcolon <+> int vm <+> int vf <+> int vr <+> hsep [ ppr n <+> int v | (n,v) <- nvs ]
-\end{code}
+ -- 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 ()
-\begin{code}
-pprFixities [] = empty
-pprFixities fixes = hsep (map ppr fixes) <> semi
+ -- Convert to BCOs
+ ; bcos <- coreExprToBCOs dflags prepd_expr
-pprRules [] = empty
-pprRules rules = hsep [ptext SLIT("{-## __R"), hsep (map ppr rules), ptext SLIT("##-}")]
+ -- link it
+ ; hval <- linkExpr hsc_env bcos
-pprDeprecs [] = empty
-pprDeprecs deps = hsep [ ptext SLIT("{-## __D"), guts, ptext SLIT("##-}")]
- where
- guts = hsep [ ppr ie <+> doubleQuotes (ppr txt) <> semi
- | Deprecation ie txt _ <- deps ]
+ ; return hval
+ }
+#endif
\end{code}
+%************************************************************************
+%* *
+ Statistics on reading interfaces
+%* *
+%************************************************************************
+
+\begin{code}
+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}