ghc/compiler/main/HscMain.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1993-2000
   3 %
   4 \section[GHC_Main]{Main driver for Glasgow Haskell compiler}
   5
   6 \begin{code}
   7 module HscMain ( HscResult(..), hscMain,
   8 #ifdef GHCI
   9                  hscExpr,
  10 #endif
  11                  initPersistentCompilerState ) where
  12
  13 #include "HsVersions.h"
  14
  15 #ifdef GHCI
  16 import RdrHsSyn         ( RdrNameHsExpr )
  17 import Rename           ( renameExpr )
  18 import StringBuffer     ( stringToStringBuffer, freeStringBuffer )
  19 import Unique           ( Uniquable(..) )
  20 import Type             ( Type, splitTyConApp_maybe )
  21 import PrelNames        ( ioTyConKey )
  22 import ByteCodeGen      ( byteCodeGen )
  23 #endif
  24
  25 import HsSyn
  26
  27 import StringBuffer     ( hGetStringBuffer )
  28 import Parser
  29 import Lex              ( PState(..), ParseResult(..) )
  30 import SrcLoc           ( mkSrcLoc )
  31 import Rename           ( checkOldIface, renameModule, closeIfaceDecls )
  32 import Rules            ( emptyRuleBase )
  33 import PrelInfo         ( wiredInThingEnv, wiredInThings )
  34 import PrelNames        ( knownKeyNames )
  35 import MkIface          ( completeIface, mkModDetailsFromIface, mkModDetails,
  36                           writeIface, pprIface )
  37 import TcModule
  38 import InstEnv          ( emptyInstEnv )
  39 import Desugar
  40 import SimplCore
  41 import CoreUtils        ( coreBindsSize )
  42 import CoreTidy         ( tidyCorePgm )
  43 import CoreSat
  44 import CoreToStg        ( coreToStg )
  45 import SimplStg         ( stg2stg )
  46 import CodeGen          ( codeGen )
  47 import CodeOutput       ( codeOutput )
  48
  49 import Module           ( ModuleName, moduleName, mkHomeModule )
  50 import CmdLineOpts
  51 import ErrUtils         ( dumpIfSet_dyn, showPass )
  52 import Util             ( unJust )
  53 import UniqSupply       ( mkSplitUniqSupply )
  54
  55 import Bag              ( emptyBag )
  56 import Outputable
  57 import Interpreter
  58 import CmStaticInfo     ( GhciMode(..) )
  59 import HscStats         ( ppSourceStats )
  60 import HscTypes         ( ModDetails, ModIface(..), PersistentCompilerState(..),
  61                           PersistentRenamerState(..), ModuleLocation(..),
  62                           HomeSymbolTable,
  63                           NameSupply(..), PackageRuleBase, HomeIfaceTable,
  64                           typeEnvClasses, typeEnvTyCons, emptyIfaceTable )
  65 import FiniteMap        ( FiniteMap, plusFM, emptyFM, addToFM )
  66 import OccName          ( OccName )
  67 import Name             ( Name, nameModule, nameOccName, getName  )
  68 import Name             ( emptyNameEnv )
  69 import Module           ( Module, lookupModuleEnvByName )
  70
  71 import Monad            ( when )
  72 import Maybe            ( isJust )
  73 import IO
  74 \end{code}
  75
  76
  77 %************************************************************************
  78 %*                                                                      *
  79 \subsection{The main compiler pipeline}
  80 %*                                                                      *
  81 %************************************************************************
  82
  83 \begin{code}
  84 data HscResult
  85    -- compilation failed
  86    = HscFail     PersistentCompilerState -- updated PCS
  87    -- concluded that it wasn't necessary
  88    | HscNoRecomp PersistentCompilerState -- updated PCS
  89                  ModDetails              -- new details (HomeSymbolTable additions)
  90                  ModIface                -- new iface (if any compilation was done)
  91    -- did recompilation
  92    | HscRecomp   PersistentCompilerState -- updated PCS
  93                  ModDetails              -- new details (HomeSymbolTable additions)
  94                  ModIface                -- new iface (if any compilation was done)
  95                  (Maybe String)          -- generated stub_h filename (in /tmp)
  96                  (Maybe String)          -- generated stub_c filename (in /tmp)
  97                  (Maybe ([UnlinkedBCO],ItblEnv)) -- interpreted code, if any
  98
  99
 100         -- no errors or warnings; the individual passes
 101         -- (parse/rename/typecheck) print messages themselves
 102
 103 hscMain
 104   :: GhciMode
 105   -> DynFlags
 106   -> Bool                       -- source unchanged?
 107   -> ModuleLocation             -- location info
 108   -> Maybe ModIface             -- old interface, if available
 109   -> HomeSymbolTable            -- for home module ModDetails
 110   -> HomeIfaceTable
 111   -> PersistentCompilerState    -- IN: persistent compiler state
 112   -> IO HscResult
 113
 114 hscMain ghci_mode dflags source_unchanged location maybe_old_iface hst hit pcs
 115  = do {
 116       showPass dflags ("Checking old interface for hs = "
 117                         ++ show (ml_hs_file location)
 118                         ++ ", hspp = " ++ show (ml_hspp_file location));
 119
 120       (pcs_ch, errs_found, (recomp_reqd, maybe_checked_iface))
 121          <- checkOldIface ghci_mode dflags hit hst pcs
 122                 (unJust "hscMain" (ml_hi_file location))
 123                 source_unchanged maybe_old_iface;
 124
 125       if errs_found then
 126          return (HscFail pcs_ch)
 127       else do {
 128
 129       let no_old_iface = not (isJust maybe_checked_iface)
 130           what_next | recomp_reqd || no_old_iface = hscRecomp
 131                     | otherwise                   = hscNoRecomp
 132       ;
 133       what_next ghci_mode dflags location maybe_checked_iface
 134                 hst hit pcs_ch
 135       }}
 136
 137
 138 -- we definitely expect to have the old interface available
 139 hscNoRecomp ghci_mode dflags location (Just old_iface) hst hit pcs_ch
 140  | ghci_mode == OneShot
 141  = do {
 142       hPutStrLn stderr "compilation IS NOT required";
 143       let { bomb = panic "hscNoRecomp:OneShot" };
 144       return (HscNoRecomp pcs_ch bomb bomb)
 145       }
 146  | otherwise
 147  = do {
 148       hPutStr stderr "compilation IS NOT required";
 149       when (verbosity dflags /= 1) $ hPutStrLn stderr "";
 150
 151       -- CLOSURE
 152       (pcs_cl, closure_errs, cl_hs_decls)
 153          <- closeIfaceDecls dflags hit hst pcs_ch old_iface ;
 154       if closure_errs then
 155          return (HscFail pcs_cl)
 156       else do {
 157
 158       -- TYPECHECK
 159       maybe_tc_result <- typecheckModule dflags pcs_cl hst
 160                                          old_iface alwaysQualify cl_hs_decls;
 161       case maybe_tc_result of {
 162          Nothing -> return (HscFail pcs_cl);
 163          Just (pcs_tc, tc_result) -> do {
 164
 165       let env_tc      = tc_env tc_result
 166           local_rules = tc_rules tc_result
 167       ;
 168       -- create a new details from the closed, typechecked, old iface
 169       let new_details = mkModDetailsFromIface env_tc local_rules
 170       ;
 171       return (HscNoRecomp pcs_tc new_details old_iface)
 172       }}}}
 173
 174
 175 hscRecomp ghci_mode dflags location maybe_checked_iface hst hit pcs_ch
 176  = do   {
 177         ; when (verbosity dflags >= 1) $
 178                 hPutStr stderr "compilation IS required";
 179           -- mode -v1 tries to keep everything on one line
 180           when (verbosity dflags > 1) $
 181                 hPutStrLn stderr "";
 182
 183           -- what target are we shooting for?
 184         ; let toInterp = dopt_HscLang dflags == HscInterpreted
 185
 186             -------------------
 187             -- PARSE
 188             -------------------
 189         ; maybe_parsed <- myParseModule dflags
 190                              (unJust "hscRecomp:hspp" (ml_hspp_file location))
 191         ; case maybe_parsed of {
 192              Nothing -> return (HscFail pcs_ch);
 193              Just rdr_module -> do {
 194         ; let this_mod = mkHomeModule (hsModuleName rdr_module)
 195
 196             -------------------
 197             -- RENAME
 198             -------------------
 199         ; (pcs_rn, maybe_rn_result)
 200              <- renameModule dflags hit hst pcs_ch this_mod rdr_module
 201         ; case maybe_rn_result of {
 202              Nothing -> return (HscFail pcs_rn);
 203              Just (print_unqualified, (is_exported, new_iface, rn_hs_decls)) -> do {
 204
 205             -------------------
 206             -- TYPECHECK
 207             -------------------
 208         ; maybe_tc_result <- typecheckModule dflags pcs_rn hst new_iface
 209                                              print_unqualified rn_hs_decls
 210         ; case maybe_tc_result of {
 211              Nothing -> return (HscFail pcs_rn);
 212              Just (pcs_tc, tc_result) -> do {
 213
 214         ; let env_tc = tc_env tc_result
 215
 216             -------------------
 217             -- DESUGAR
 218             -------------------
 219         ; (ds_binds, ds_rules, foreign_stuff)
 220              <- deSugar dflags pcs_tc hst this_mod print_unqualified tc_result
 221
 222             -------------------
 223             -- SIMPLIFY, TIDY-CORE
 224             -------------------
 225           -- We grab the the unfoldings at this point.
 226         ; (pcs_simpl, tidy_binds, orphan_rules)
 227               <- simplThenTidy dflags pcs_tc hst this_mod is_exported ds_binds ds_rules
 228
 229             -------------------
 230             -- BUILD THE NEW ModDetails AND ModIface
 231             -------------------
 232         ; let new_details = mkModDetails env_tc tidy_binds orphan_rules
 233         ; final_iface <- mkFinalIface ghci_mode dflags location
 234                                       maybe_checked_iface new_iface new_details
 235
 236             -------------------
 237             -- CONVERT TO STG and COMPLETE CODE GENERATION
 238             -------------------
 239         ; (maybe_stub_h_filename, maybe_stub_c_filename, maybe_bcos)
 240              <- restOfCodeGeneration dflags toInterp this_mod
 241                    (map ideclName (hsModuleImports rdr_module))
 242                    foreign_stuff env_tc tidy_binds
 243                    hit (pcs_PIT pcs_simpl)
 244
 245           -- and the answer is ...
 246         ; return (HscRecomp pcs_simpl new_details final_iface
 247                             maybe_stub_h_filename maybe_stub_c_filename
 248                             maybe_bcos)
 249           }}}}}}}
 250
 251
 252
 253 mkFinalIface ghci_mode dflags location maybe_old_iface new_iface new_details
 254  = case completeIface maybe_old_iface new_iface new_details of
 255       (new_iface, Nothing) -- no change in the interfacfe
 256          -> do when (dopt Opt_D_dump_hi_diffs dflags)
 257                     (printDump (text "INTERFACE UNCHANGED"))
 258                dumpIfSet_dyn dflags Opt_D_dump_hi
 259                              "UNCHANGED FINAL INTERFACE" (pprIface new_iface)
 260                return new_iface
 261       (new_iface, Just sdoc_diffs)
 262          -> do dumpIfSet_dyn dflags Opt_D_dump_hi_diffs "INTERFACE HAS CHANGED"
 263                                     sdoc_diffs
 264                dumpIfSet_dyn dflags Opt_D_dump_hi "NEW FINAL INTERFACE"
 265                                     (pprIface new_iface)
 266                -- Write the interface file
 267                when (ghci_mode /= Interactive)
 268                     (writeIface (unJust "hscRecomp:hi" (ml_hi_file location))
 269                                 new_iface)
 270                return new_iface
 271
 272
 273 myParseModule dflags src_filename
 274  = do --------------------------  Parser  ----------------
 275       showPass dflags "Parser"
 276       -- _scc_     "Parser"
 277
 278       buf <- hGetStringBuffer True{-expand tabs-} src_filename
 279
 280       let glaexts | dopt Opt_GlasgowExts dflags = 1#
 281                   | otherwise                   = 0#
 282
 283       case parseModule buf PState{ bol = 0#, atbol = 1#,
 284                                    context = [], glasgow_exts = glaexts,
 285                                    loc = mkSrcLoc (_PK_ src_filename) 1 } of {
 286
 287         PFailed err -> do { hPutStrLn stderr (showSDoc err);
 288                             return Nothing };
 289
 290         POk _ rdr_module@(HsModule mod_name _ _ _ _ _ _) -> do {
 291
 292       dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr rdr_module) ;
 293
 294       dumpIfSet_dyn dflags Opt_D_source_stats "Source Statistics"
 295                            (ppSourceStats False rdr_module) ;
 296
 297       return (Just rdr_module)
 298       }}
 299
 300
 301 simplThenTidy dflags pcs hst this_mod is_exported binds rules
 302  = do -- Do main Core-language transformations ---------
 303       -- _scc_     "Core2Core"
 304       (simplified, orphan_rules)
 305          <- core2core dflags pcs hst is_exported binds rules
 306
 307       -- Do saturation and convert to A-normal form
 308       -- NOTE: subsequent passes may not transform the syntax, only annotate it
 309       saturated <- coreSatPgm dflags simplified
 310
 311       -- Do the final tidy-up
 312       (pcs', tidy_binds, tidy_orphan_rules)
 313          <- tidyCorePgm dflags this_mod pcs saturated orphan_rules
 314
 315       return (pcs', tidy_binds, tidy_orphan_rules)
 316
 317
 318 restOfCodeGeneration dflags toInterp this_mod imported_module_names
 319                      foreign_stuff env_tc tidy_binds
 320                      hit pit -- these last two for mapping ModNames to Modules
 321  | toInterp
 322  = do (bcos,itbl_env)
 323          <- byteCodeGen dflags tidy_binds local_tycons local_classes
 324       return (Nothing, Nothing, Just (bcos,itbl_env))
 325
 326  | otherwise
 327  = do
 328       --------------------------  Convert to STG -------------------------------
 329       (stg_binds, cost_centre_info)
 330                 <- myCoreToStg dflags this_mod tidy_binds env_tc
 331
 332       --------------------------  Code generation -------------------------------
 333       -- _scc_     "CodeGen"
 334       abstractC <- codeGen dflags this_mod imported_modules
 335                            cost_centre_info fe_binders
 336                            local_tycons stg_binds
 337
 338       --------------------------  Code output -------------------------------
 339       -- _scc_     "CodeOutput"
 340       (maybe_stub_h_name, maybe_stub_c_name)
 341          <- codeOutput dflags this_mod local_tycons
 342                        tidy_binds stg_binds
 343                        c_code h_code abstractC
 344
 345       return (maybe_stub_h_name, maybe_stub_c_name, Nothing)
 346  where
 347     local_tycons     = typeEnvTyCons env_tc
 348     local_classes    = typeEnvClasses env_tc
 349     imported_modules = map mod_name_to_Module imported_module_names
 350     (h_code,c_code,fe_binders) = foreign_stuff
 351
 352     mod_name_to_Module :: ModuleName -> Module
 353     mod_name_to_Module nm
 354        = let str_mi = case lookupModuleEnvByName hit nm of
 355                           Just mi -> mi
 356                           Nothing -> case lookupModuleEnvByName pit nm of
 357                                         Just mi -> mi
 358                                         Nothing -> barf nm
 359          in  mi_module str_mi
 360     barf nm = pprPanic "mod_name_to_Module: no hst or pst mapping for"
 361                        (ppr nm)
 362
 363
 364 myCoreToStg dflags this_mod tidy_binds env_tc
 365  = do
 366       () <- coreBindsSize tidy_binds `seq` return ()
 367       -- TEMP: the above call zaps some space usage allocated by the
 368       -- simplifier, which for reasons I don't understand, persists
 369       -- thoroughout code generation
 370
 371       --let bcos = byteCodeGen dflags tidy_binds local_tycons local_classes
 372
 373       -- _scc_     "Core2Stg"
 374       stg_binds <- coreToStg dflags this_mod tidy_binds
 375
 376       -- _scc_     "Stg2Stg"
 377       (stg_binds2, cost_centre_info) <- stg2stg dflags this_mod stg_binds
 378
 379       return (stg_binds2, cost_centre_info)
 380    where
 381       local_tycons  = typeEnvTyCons env_tc
 382       local_classes = typeEnvClasses env_tc
 383 \end{code}
 384
 385
 386 %************************************************************************
 387 %*                                                                      *
 388 \subsection{Compiling an expression}
 389 %*                                                                      *
 390 %************************************************************************
 391
 392 \begin{code}
 393 #ifdef GHCI
 394 hscExpr
 395   :: DynFlags
 396   -> HomeSymbolTable
 397   -> HomeIfaceTable
 398   -> PersistentCompilerState    -- IN: persistent compiler state
 399   -> Module                     -- Context for compiling
 400   -> String                     -- The expression
 401   -> Bool                       -- Should we wrap print if not IO-typed?
 402   -> IO ( PersistentCompilerState,
 403           Maybe (UnlinkedBCOExpr, PrintUnqualified, Type) )
 404
 405 hscExpr dflags hst hit pcs0 this_module expr wrap_print
 406    = do {
 407         maybe_parsed <- hscParseExpr dflags expr;
 408         case maybe_parsed of
 409              Nothing -> return (pcs0, Nothing)
 410              Just parsed_expr -> do {
 411
 412                 -- Rename it
 413         (pcs1, maybe_renamed_expr) <-
 414                 renameExpr dflags hit hst pcs0 this_module parsed_expr;
 415         case maybe_renamed_expr of
 416                 Nothing -> return ({-WAS:pcs1-} pcs0, Nothing)
 417                 Just (print_unqual, rn_expr) -> do {
 418
 419                 -- Typecheck it
 420         maybe_tc_return
 421            <- typecheckExpr dflags pcs1 hst print_unqual this_module rn_expr;
 422         case maybe_tc_return of {
 423                 Nothing -> return ({-WAS:pcs1-} pcs0, Nothing);
 424                 Just (pcs2, tc_expr, ty) -> do
 425
 426         -- if it isn't an IO-typed expression,
 427         -- wrap "print" around it & recompile...
 428         let { is_IO_type = case splitTyConApp_maybe ty of {
 429                             Just (tycon, _) -> getUnique tycon == ioTyConKey;
 430                             Nothing -> False }
 431             };
 432
 433         if (wrap_print && not is_IO_type)
 434                 then do (new_pcs, maybe_stuff)
 435                           <- hscExpr dflags hst hit pcs2 this_module
 436                                 ("PrelIO.print (" ++ expr ++ ")") False
 437                         case maybe_stuff of
 438                            Nothing -> return (new_pcs, maybe_stuff)
 439                            Just (bcos, _, _) ->
 440                               return (new_pcs, Just (bcos, print_unqual, ty))
 441                 else do
 442
 443                 -- Desugar it
 444         ds_expr <- deSugarExpr dflags pcs2 hst this_module
 445                         print_unqual tc_expr;
 446
 447                 -- Simplify it
 448         simpl_expr <- simplifyExpr dflags pcs2 hst ds_expr;
 449
 450                 -- Saturate it
 451         sat_expr <- coreSatExpr dflags simpl_expr;
 452
 453                 -- ToDo: need to do SRTs?
 454
 455                 -- Convert to BCOs
 456         bcos <- coreExprToBCOs dflags sat_expr
 457
 458         return (pcs2, Just (bcos, print_unqual, ty));
 459      }}}}
 460
 461 hscParseExpr :: DynFlags -> String -> IO (Maybe RdrNameHsExpr)
 462 hscParseExpr dflags str
 463  = do --------------------------  Parser  ----------------
 464       showPass dflags "Parser"
 465       -- _scc_     "Parser"
 466
 467       buf <- stringToStringBuffer str
 468
 469       let glaexts | dopt Opt_GlasgowExts dflags = 1#
 470                   | otherwise             = 0#
 471
 472       case parseExpr buf PState{ bol = 0#, atbol = 1#,
 473                                  context = [], glasgow_exts = glaexts,
 474                                  loc = mkSrcLoc SLIT("<no file>") 0 } of {
 475
 476         PFailed err -> do { hPutStrLn stderr (showSDoc err);
 477                             freeStringBuffer buf;
 478                             return Nothing };
 479
 480         POk _ rdr_expr -> do {
 481
 482       --ToDo: can't free the string buffer until we've finished this
 483       -- compilation sweep and all the identifiers have gone away.
 484       --freeStringBuffer buf;
 485       dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr rdr_expr);
 486       return (Just rdr_expr)
 487       }}
 488 #endif
 489 \end{code}
 490
 491 %************************************************************************
 492 %*                                                                      *
 493 \subsection{Initial persistent state}
 494 %*                                                                      *
 495 %************************************************************************
 496
 497 \begin{code}
 498 initPersistentCompilerState :: IO PersistentCompilerState
 499 initPersistentCompilerState
 500   = do prs <- initPersistentRenamerState
 501        return (
 502         PCS { pcs_PIT   = emptyIfaceTable,
 503               pcs_PTE   = wiredInThingEnv,
 504               pcs_insts = emptyInstEnv,
 505               pcs_rules = emptyRuleBase,
 506               pcs_PRS   = prs
 507             }
 508         )
 509
 510 initPersistentRenamerState :: IO PersistentRenamerState
 511   = do us <- mkSplitUniqSupply 'r'
 512        return (
 513         PRS { prsOrig  = NameSupply { nsUniqs = us,
 514                                       nsNames = initOrigNames,
 515                                       nsIPs   = emptyFM },
 516               prsDecls   = (emptyNameEnv, 0),
 517               prsInsts   = (emptyBag, 0),
 518               prsRules   = (emptyBag, 0),
 519               prsImpMods = emptyFM
 520             }
 521         )
 522
 523 initOrigNames :: FiniteMap (ModuleName,OccName) Name
 524 initOrigNames
 525    = grab knownKeyNames `plusFM` grab (map getName wiredInThings)
 526      where
 527         grab names = foldl add emptyFM names
 528         add env name
 529            = addToFM env (moduleName (nameModule name), nameOccName name) name
 530
 531
 532 initRules :: PackageRuleBase
 533 initRules = emptyRuleBase
 534 {- SHOULD BE (ish)
 535             foldl add emptyVarEnv builtinRules
 536           where
 537             add env (name,rule)
 538               = extendRuleBase env name rule
 539 -}
 540 \end{code}