[project @ 2000-10-31 12:07:43 by simonpj]
[ghc-hetmet.git] / ghc / compiler / main / HscMain.lhs
index 63dabf0..8d09e72 100644 (file)
@@ -4,26 +4,29 @@
 \section[GHC_Main]{Main driver for Glasgow Haskell compiler}
 
 \begin{code}
-module HscMain ( hscMain ) where
+module HscMain ( HscResult(..), hscMain, 
+                initPersistentCompilerState ) where
 
 #include "HsVersions.h"
 
-import IO              ( hPutStr, stderr )
+import Maybe           ( isJust )
+import IO              ( hPutStr, hPutStrLn, stderr )
 import HsSyn
 
-import RdrHsSyn                ( RdrNameHsModule )
-import FastString      ( unpackFS )
 import StringBuffer    ( hGetStringBuffer )
 import Parser          ( parse )
 import Lex             ( PState(..), ParseResult(..) )
 import SrcLoc          ( mkSrcLoc )
 
-import Rename          ( renameModule )
-
-import PrelInfo                ( wiredInThings )
+import Rename          ( renameModule, checkOldIface, closeIfaceDecls )
+import Rules           ( emptyRuleBase )
+import PrelInfo                ( wiredInThingEnv, wiredInThings )
+import PrelNames       ( knownKeyNames )
 import PrelRules       ( builtinRules )
-import MkIface         ( writeIface )
+import MkIface         ( completeIface, mkModDetailsFromIface, mkModDetails,
+                         writeIface )
 import TcModule                ( TcResults(..), typecheckModule )
+import InstEnv         ( emptyInstEnv )
 import Desugar         ( deSugar )
 import SimplCore       ( core2core )
 import OccurAnal       ( occurAnalyseBinds )
@@ -35,15 +38,29 @@ import SimplStg             ( stg2stg )
 import CodeGen         ( codeGen )
 import CodeOutput      ( codeOutput )
 
-import Module          ( ModuleName, moduleNameUserString )
+import Module          ( ModuleName, moduleName, mkModuleInThisPackage )
 import CmdLineOpts
-import ErrUtils                ( ghcExit, doIfSet, dumpIfSet )
+import ErrUtils                ( dumpIfSet_dyn )
+import Util            ( unJust )
 import UniqSupply      ( mkSplitUniqSupply )
 
+import Bag             ( emptyBag )
 import Outputable
-import Char            ( isSpace )
-import StgInterp       ( runStgI )
+import StgInterp       ( stgToInterpSyn )
 import HscStats                ( ppSourceStats )
+import HscTypes                ( ModDetails, ModIface(..), PersistentCompilerState(..),
+                         PersistentRenamerState(..), ModuleLocation(..),
+                         HomeSymbolTable, 
+                         OrigNameEnv(..), PackageRuleBase, HomeIfaceTable, 
+                         typeEnvClasses, typeEnvTyCons, emptyIfaceTable )
+import InterpSyn       ( UnlinkedIBind )
+import StgInterp       ( ItblEnv )
+import FiniteMap       ( FiniteMap, plusFM, emptyFM, addToFM )
+import OccName         ( OccName )
+import Name            ( Name, nameModule, nameOccName, getName  )
+import Name            ( emptyNameEnv )
+import Module          ( Module, lookupModuleEnvByName )
+
 \end{code}
 
 
@@ -59,188 +76,274 @@ data HscResult
             (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
+            (Maybe ([UnlinkedIBind],ItblEnv)) -- interpreted code, if any
              PersistentCompilerState -- updated PCS
-             (Bag WarnMsg)             -- warnings
 
-   | HscErrs PersistentCompilerState -- updated PCS
-             (Bag ErrMsg)              -- errors
-             (Bag WarnMsg)             -- warnings
+   | HscFail PersistentCompilerState -- updated PCS
+       -- no errors or warnings; the individual passes
+       -- (parse/rename/typecheck) print messages themselves
 
 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.)
+  :: 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 flags core_cmds stg_cmds summary maybe_old_iface
-       output_filename mod_details pcs1 =
-
-       --------------------------  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)
-
-    buf <- hGetStringBuffer True{-expand tabs-} src_filename
-
-    let glaexts | opt_GlasgowExts = 1#
-               | otherwise       = 0#
-
-    case parse buf PState{ bol = 0#, atbol = 1#,
-                          context = [], glasgow_exts = glaexts,
-                          loc = mkSrcLoc src_filename 1 } of {
-
-       PFailed err -> return (CompErrs pcs err)
-
-       POk _ rdr_module@(HsModule mod_name _ _ _ _ _ _) ->
-
-    dumpIfSet (dopt_D_dump_parsed flags) "Parser" (ppr rdr_module) >>
-
-    dumpIfSet (dopt_D_source_stats flags) "Source Statistics"
-       (ppSourceStats False rdr_module)                >>
-
-    -- 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 'u'      >>= \ tidy_uniqs -> -- tidy up
-    mkSplitUniqSupply 'g'      >>= \ st_uniqs  -> -- stg-to-stg passes
-    mkSplitUniqSupply 'n'      >>= \ ncg_uniqs -> -- native-code generator
-
-       --------------------------  Rename  ----------------
-    show_pass "Renamer"                        >>
-    _scc_     "Renamer"
-
-    renameModule rn_uniqs rdr_module           >>= \ 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
-
-
-       --------------------------  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
-
-       Just (tc_results@(TcResults {tc_tycons  = local_tycons, 
-                                    tc_classes = local_classes, 
-                                    tc_insts   = inst_info })) ->
-
-
-       --------------------------  Desugaring ----------------
-    _scc_     "DeSugar"
-    deSugar this_mod ds_uniqs tc_results       >>= \ (desugared, rules, h_code, c_code, fe_binders) ->
-
-
-       --------------------------  Main Core-language transformations ----------------
-    _scc_     "Core2Core"
-    core2core core_cmds desugared rules                >>= \ (simplified, orphan_rules) ->
-
-       -- Do the final tidy-up
-    tidyCorePgm tidy_uniqs this_mod
-               simplified orphan_rules         >>= \ (tidy_binds, tidy_orphan_rules) -> 
-
-       -- 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
-
-    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
-
-
-
-       --------------------------  Convert to STG code -------------------------------
-    show_pass "Core2Stg"                       >>
-    _scc_     "Core2Stg"
-    let
-       stg_binds   = topCoreBindsToStg c2s_uniqs occ_anal_tidy_binds
-    in
-
-       --------------------------  Simplify STG code -------------------------------
-    show_pass "Stg2Stg"                         >>
-    _scc_     "Stg2Stg"
-    stg2stg stg_cmds this_mod st_uniqs stg_binds >>= \ (stg_binds2, cost_centre_info) ->
-
-#ifdef GHCI
-    runStgI local_tycons local_classes 
-                         (map fst stg_binds2)    >>= \ i_result ->
-    putStr ("\nANSWER = " ++ show i_result ++ "\n\n")
-    >>
-
-#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)) >>
-
-#endif
-
-
-    ghcExit 0
-    } }
-  where
-    -------------------------------------------------------------
-    -- ****** help functions:
-
-    show_pass
-      = if opt_D_show_passes
-       then \ what -> hPutStr stderr ("*** "++what++":\n")
-       else \ what -> return ()
+hscMain dflags source_unchanged location maybe_old_iface hst hit pcs
+ = do {
+      putStrLn ( "hscMain: location =\n" ++ show location);
+      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
+      ;
+      putStrLn "doing what_next ...";
+      what_next dflags location maybe_checked_iface
+                hst hit pcs_ch
+      }}
+
+
+hscNoRecomp dflags location maybe_checked_iface hst hit pcs_ch
+ = do {
+      -- 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 {
+      -- what target are we shooting for?
+      let toInterp = dopt_HscLang dflags == HscInterpreted
+      ;
+--      putStrLn ("toInterp = " ++ show toInterp);
+      -- 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 possibly create a new ModIface
+      let maybe_final_iface_and_sdoc 
+             = completeIface maybe_checked_iface new_iface new_details 
+          maybe_final_iface
+             = case maybe_final_iface_and_sdoc of 
+                  Just (fif, sdoc) -> Just fif; Nothing -> Nothing
+      ;
+      -- Write the interface file
+      writeIface (unJust (ml_hi_file location) "hscRecomp:hi") maybe_final_iface
+      ;
+      -- 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 maybe_final_iface 
+                   maybe_stub_h_filename maybe_stub_c_filename
+                    maybe_ibinds pcs_tc)
+      }}}}}}}
+
+
+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 {
+
+      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)
+      }}
+
+
+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 this_mod tidy_binds
+ = do 
+      c2s_uniqs <- mkSplitUniqSupply 'c'
+      st_uniqs  <- mkSplitUniqSupply 'g'
+      let occ_anal_tidy_binds = occurAnalyseBinds tidy_binds
+
+      () <- 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 dflags "Core2Stg"
+      -- _scc_     "Core2Stg"
+      let stg_binds   = topCoreBindsToStg c2s_uniqs occ_anal_tidy_binds
+
+      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)
+
+      return (stg_binds2, occ_anal_tidy_binds, cost_centre_info, final_ids)
+
+
+show_pass dflags what
+  = if   dopt Opt_D_show_passes dflags
+    then hPutStr stderr ("*** "++what++":\n")
+    else return ()
 \end{code}
 
 
@@ -251,34 +354,45 @@ hscMain flags core_cmds stg_cmds summary maybe_old_iface
 %************************************************************************
 
 \begin{code}
-initPersistentCompilerState :: PersistentCompilerState
+initPersistentCompilerState :: IO PersistentCompilerState
 initPersistentCompilerState 
-  = PCS { pcs_PST   = initPackageDetails,
-         pcs_insts = emptyInstEnv,
-         pcs_rules = initRules,
-         pcs_PRS   = initPersistentRenamerState }
-
-initPackageDetails :: PackageSymbolTable
-initPackageDetails = extendTypeEnv emptyModuleEnv wiredInThings
-
-initPersistentRenamerState :: PersistentRenamerState
-  = PRS { prsOrig  = Orig { origNames  = initOrigNames,
-                           origIParam = emptyFM },
-         prsDecls = emptyNameEnv,
-         prsInsts = emptyBag,
-         prsRules = emptyBag
-    }
+  = 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,
+             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
+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) = extendNameEnv_C add1 env name [rule]
-           add1 rules _        = rule : rules
+           add env (name,rule) 
+              = extendRuleBase env name rule
+-}
 \end{code}