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