HscMain.hs 66.4 KB
Newer Older
dterei's avatar
dterei committed
1 2
-------------------------------------------------------------------------------
--
3
-- | Main API for compiling plain Haskell source code.
4
--
dterei's avatar
dterei committed
5
-- This module implements compilation of a Haskell source. It is
6 7 8 9 10
-- /not/ concerned with preprocessing of source files; this is handled
-- in "DriverPipeline".
--
-- There are various entry points depending on what mode we're in:
-- "batch" mode (@--make@), "one-shot" mode (@-c@, @-S@ etc.), and
dterei's avatar
dterei committed
11
-- "interactive" mode (GHCi). There are also entry points for
12 13 14 15 16 17 18 19 20 21 22 23
-- individual passes: parsing, typechecking/renaming, desugaring, and
-- simplification.
--
-- All the functions here take an 'HscEnv' as a parameter, but none of
-- them return a new one: 'HscEnv' is treated as an immutable value
-- from here on in (although it has mutable components, for the
-- caches).
--
-- Warning messages are dealt with consistently throughout this API:
-- during compilation warnings are collected, and before any function
-- in @HscMain@ returns, the warnings are either printed, or turned
-- into a real compialtion error if the @-Werror@ flag is enabled.
24
--
dterei's avatar
dterei committed
25 26 27 28
-- (c) The GRASP/AQUA Project, Glasgow University, 1993-2000
--
-------------------------------------------------------------------------------

29
module HscMain
dterei's avatar
dterei committed
30
    (
31 32 33 34 35
    -- * Making an HscEnv
      newHscEnv

    -- * Compiling complete source files
    , Compiler
Thomas Schilling's avatar
Thomas Schilling committed
36
    , HscStatus' (..)
37
    , InteractiveStatus, HscStatus
38 39 40 41 42 43 44 45
    , hscCompileOneShot
    , hscCompileBatch
    , hscCompileNothing
    , hscCompileInteractive
    , hscCompileCmmFile
    , hscCompileCore

    -- * Running passes separately
Thomas Schilling's avatar
Thomas Schilling committed
46 47 48
    , hscParse
    , hscTypecheckRename
    , hscDesugar
Simon Marlow's avatar
Simon Marlow committed
49 50
    , makeSimpleIface
    , makeSimpleDetails
51 52 53 54 55 56 57 58 59 60 61 62
    , hscSimplify -- ToDo, shouldn't really export this

    -- ** Backends
    , hscOneShotBackendOnly
    , hscBatchBackendOnly
    , hscNothingBackendOnly
    , hscInteractiveBackendOnly

    -- * Support for interactive evaluation
    , hscParseIdentifier
    , hscTcRcLookupName
    , hscTcRnGetInfo
63
    , hscCheckSafe
64
#ifdef GHCI
65
    , hscGetModuleInterface
66
    , hscRnImportDecls
67
    , hscTcRnLookupRdrName
vivian's avatar
vivian committed
68
    , hscStmt, hscStmtWithLocation
69
    , hscDecls, hscDeclsWithLocation
vivian's avatar
vivian committed
70
    , hscTcExpr, hscImport, hscKcType
71 72
    , hscCompileCoreExpr
#endif
73
    ) where
74

75
#ifdef GHCI
76
import ByteCodeGen      ( byteCodeGen, coreExprToBCOs )
77
import Linker
78 79
import CoreTidy         ( tidyExpr )
import Type             ( Type )
80
import PrelNames
81 82 83
import {- Kind parts of -} Type         ( Kind )
import CoreLint         ( lintUnfolding )
import DsMeta           ( templateHaskellNames )
84
import VarSet
85
import VarEnv           ( emptyTidyEnv )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
86
import Panic
87 88

import GHC.Exts
89 90
#endif

91
import Id
92 93
import Module
import Packages
Simon Marlow's avatar
Simon Marlow committed
94 95
import RdrName
import HsSyn
96
import CoreSyn
Ian Lynagh's avatar
Ian Lynagh committed
97
import StringBuffer
98
import Parser
99
import Lexer
100 101
import SrcLoc
import TcRnDriver
102
import TcIface          ( typecheckIface )
103
import TcRnMonad
104 105
import IfaceEnv         ( initNameCache )
import LoadIface        ( ifaceStats, initExternalPackageState )
106
import PrelInfo
Simon Marlow's avatar
Simon Marlow committed
107
import MkIface
108 109
import Desugar
import SimplCore
Simon Marlow's avatar
Simon Marlow committed
110
import TidyPgm
111
import CorePrep
112 113
import CoreToStg        ( coreToStg )
import qualified StgCmm ( codeGen )
114 115
import StgSyn
import CostCentre
116
import ProfInit
117 118
import TyCon
import Name
119 120
import SimplStg         ( stg2stg )
import CodeGen          ( codeGen )
Simon Peyton Jones's avatar
Simon Peyton Jones committed
121
import OldCmm as Old    ( CmmGroup )
122 123
import PprCmm           ( pprCmms )
import CmmParse         ( parseCmmFile )
124
import CmmBuildInfoTables
Edward Z. Yang's avatar
Edward Z. Yang committed
125
import CmmPipeline
126
import CmmInfo
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
127
import OptimizationFuel ( initOptFuelState )
128
import CmmCvt
129
import CodeOutput
130
import NameEnv          ( emptyNameEnv )
131 132
import NameSet          ( emptyNameSet )
import InstEnv
133
import FamInstEnv
Thomas Schilling's avatar
Thomas Schilling committed
134
import Fingerprint      ( Fingerprint )
135

136
import DynFlags
137
import ErrUtils
138
import UniqSupply       ( mkSplitUniqSupply )
139

140
import Outputable
141
import HscStats         ( ppSourceStats )
142
import HscTypes
143
import MkExternalCore   ( emitExternalCore )
144
import FastString
145
import UniqFM           ( emptyUFM )
146
import UniqSupply       ( initUs_ )
147
import Bag
Thomas Schilling's avatar
Thomas Schilling committed
148
import Exception
Simon Marlow's avatar
Simon Marlow committed
149

150
import Data.List
Simon Marlow's avatar
Simon Marlow committed
151
import Control.Monad
152
import Data.Maybe
Simon Marlow's avatar
Simon Marlow committed
153
import Data.IORef
154
import System.FilePath as FilePath
155
import System.Directory
dterei's avatar
dterei committed
156

Thomas Schilling's avatar
Thomas Schilling committed
157
#include "HsVersions.h"
158

159

dterei's avatar
dterei committed
160 161 162 163 164
{- **********************************************************************
%*                                                                      *
                Initialisation
%*                                                                      *
%********************************************************************* -}
165

166
newHscEnv :: DynFlags -> IO HscEnv
167
newHscEnv dflags = do
dterei's avatar
dterei committed
168 169 170 171 172 173
    eps_var <- newIORef initExternalPackageState
    us      <- mkSplitUniqSupply 'r'
    nc_var  <- newIORef (initNameCache us knownKeyNames)
    fc_var  <- newIORef emptyUFM
    mlc_var <- newIORef emptyModuleEnv
    optFuel <- initOptFuelState
174
    return HscEnv {  hsc_dflags       = dflags,
dterei's avatar
dterei committed
175 176
                     hsc_targets      = [],
                     hsc_mod_graph    = [],
177
                     hsc_IC           = emptyInteractiveContext dflags,
dterei's avatar
dterei committed
178 179 180 181 182 183
                     hsc_HPT          = emptyHomePackageTable,
                     hsc_EPS          = eps_var,
                     hsc_NC           = nc_var,
                     hsc_FC           = fc_var,
                     hsc_MLC          = mlc_var,
                     hsc_OptFuel      = optFuel,
184
                     hsc_type_env_var = Nothing }
Thomas Schilling's avatar
Thomas Schilling committed
185

186

187
knownKeyNames :: [Name]      -- Put here to avoid loops involving DsMeta,
188
knownKeyNames =              -- where templateHaskellNames are defined
dterei's avatar
dterei committed
189
    map getName wiredInThings
dterei's avatar
dterei committed
190
        ++ basicKnownKeyNames
191
#ifdef GHCI
dterei's avatar
dterei committed
192
        ++ templateHaskellNames
193 194
#endif

195
-- -----------------------------------------------------------------------------
196
-- The Hsc monad: Passing an enviornment and warning state
197

dterei's avatar
dterei committed
198
newtype Hsc a = Hsc (HscEnv -> WarningMessages -> IO (a, WarningMessages))
199 200

instance Monad Hsc where
dterei's avatar
dterei committed
201 202 203 204
    return a    = Hsc $ \_ w -> return (a, w)
    Hsc m >>= k = Hsc $ \e w -> do (a, w1) <- m e w
                                   case k a of
                                       Hsc k' -> k' e w1
205 206

instance MonadIO Hsc where
dterei's avatar
dterei committed
207
    liftIO io = Hsc $ \_ w -> do a <- io; return (a, w)
208

dterei's avatar
dterei committed
209 210 211
instance Functor Hsc where
    fmap f m = m >>= \a -> return $ f a

212 213
runHsc :: HscEnv -> Hsc a -> IO a
runHsc hsc_env (Hsc hsc) = do
dterei's avatar
dterei committed
214 215 216
    (a, w) <- hsc hsc_env emptyBag
    printOrThrowWarnings (hsc_dflags hsc_env) w
    return a
217

218 219 220 221 222 223 224
-- A variant of runHsc that switches in the DynFlags from the
-- InteractiveContext before running the Hsc computation.
--
runInteractiveHsc :: HscEnv -> Hsc a -> IO a
runInteractiveHsc hsc_env =
  runHsc (hsc_env { hsc_dflags = ic_dflags (hsc_IC hsc_env) })

225
getWarnings :: Hsc WarningMessages
dterei's avatar
dterei committed
226
getWarnings = Hsc $ \_ w -> return (w, w)
227 228

clearWarnings :: Hsc ()
dterei's avatar
dterei committed
229
clearWarnings = Hsc $ \_ _ -> return ((), emptyBag)
230 231

logWarnings :: WarningMessages -> Hsc ()
dterei's avatar
dterei committed
232
logWarnings w = Hsc $ \_ w0 -> return ((), w0 `unionBags` w)
233 234

getHscEnv :: Hsc HscEnv
dterei's avatar
dterei committed
235
getHscEnv = Hsc $ \e w -> return (e, w)
236

237 238
instance HasDynFlags Hsc where
    getDynFlags = Hsc $ \e w -> return (hsc_dflags e, w)
239 240 241

handleWarnings :: Hsc ()
handleWarnings = do
dterei's avatar
dterei committed
242 243 244 245
    dflags <- getDynFlags
    w <- getWarnings
    liftIO $ printOrThrowWarnings dflags w
    clearWarnings
246 247 248 249 250

-- | log warning in the monad, and if there are errors then
-- throw a SourceError exception.
logWarningsReportErrors :: Messages -> Hsc ()
logWarningsReportErrors (warns,errs) = do
dterei's avatar
dterei committed
251 252
    logWarnings warns
    when (not $ isEmptyBag errs) $ throwErrors errs
253 254 255 256

-- | Throw some errors.
throwErrors :: ErrorMessages -> Hsc a
throwErrors = liftIO . throwIO . mkSrcErr
257 258 259 260 261

-- | Deal with errors and warnings returned by a compilation step
--
-- In order to reduce dependencies to other parts of the compiler, functions
-- outside the "main" parts of GHC return warnings and errors as a parameter
dterei's avatar
dterei committed
262
-- and signal success via by wrapping the result in a 'Maybe' type. This
263 264 265 266 267 268 269 270 271
-- function logs the returned warnings and propagates errors as exceptions
-- (of type 'SourceError').
--
-- This function assumes the following invariants:
--
--  1. If the second result indicates success (is of the form 'Just x'),
--     there must be no error messages in the first result.
--
--  2. If there are no error messages, but the second result indicates failure
dterei's avatar
dterei committed
272
--     there should be warnings in the first result. That is, if the action
273 274 275
--     failed, it must have been due to the warnings (i.e., @-Werror@).
ioMsgMaybe :: IO (Messages, Maybe a) -> Hsc a
ioMsgMaybe ioA = do
276
    ((warns,errs), mb_r) <- liftIO ioA
dterei's avatar
dterei committed
277 278 279 280
    logWarnings warns
    case mb_r of
        Nothing -> throwErrors errs
        Just r  -> ASSERT( isEmptyBag errs ) return r
281 282 283 284 285

-- | like ioMsgMaybe, except that we ignore error messages and return
-- 'Nothing' instead.
ioMsgMaybe' :: IO (Messages, Maybe a) -> Hsc (Maybe a)
ioMsgMaybe' ioA = do
dterei's avatar
dterei committed
286 287 288
    ((warns,_errs), mb_r) <- liftIO $ ioA
    logWarnings warns
    return mb_r
289 290 291 292 293 294

-- -----------------------------------------------------------------------------
-- | Lookup things in the compiler's environment

#ifdef GHCI
hscTcRnLookupRdrName :: HscEnv -> RdrName -> IO [Name]
295 296 297
hscTcRnLookupRdrName hsc_env0 rdr_name = runInteractiveHsc hsc_env0 $ do
   hsc_env <- getHscEnv
   ioMsgMaybe $ tcRnLookupRdrName hsc_env rdr_name
298 299 300
#endif

hscTcRcLookupName :: HscEnv -> Name -> IO (Maybe TyThing)
301 302 303
hscTcRcLookupName hsc_env0 name = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe' $ tcRnLookupName hsc_env name
dterei's avatar
dterei committed
304 305 306
      -- ignore errors: the only error we're likely to get is
      -- "name not found", and the Maybe in the return type
      -- is used to indicate that.
307

308
hscTcRnGetInfo :: HscEnv -> Name -> IO (Maybe (TyThing, Fixity, [ClsInst]))
309 310 311
hscTcRnGetInfo hsc_env0 name = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe' $ tcRnGetInfo hsc_env name
312 313

#ifdef GHCI
314
hscGetModuleInterface :: HscEnv -> Module -> IO ModIface
315 316 317
hscGetModuleInterface hsc_env0 mod = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe $ getModuleInterface hsc_env mod
318 319 320

-- -----------------------------------------------------------------------------
-- | Rename some import declarations
321
hscRnImportDecls :: HscEnv -> [LImportDecl RdrName] -> IO GlobalRdrEnv
322 323 324
hscRnImportDecls hsc_env0 import_decls = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe $ tcRnImportDecls hsc_env import_decls
325 326
#endif

327
-- -----------------------------------------------------------------------------
Simon Marlow's avatar
Simon Marlow committed
328
-- | parse a file, returning the abstract syntax
329

330
hscParse :: HscEnv -> ModSummary -> IO HsParsedModule
331 332 333
hscParse hsc_env mod_summary = runHsc hsc_env $ hscParse' mod_summary

-- internal version, that doesn't fail due to -Werror
334
hscParse' :: ModSummary -> Hsc HsParsedModule
335
hscParse' mod_summary = do
dterei's avatar
dterei committed
336 337 338
    dflags <- getDynFlags
    let src_filename  = ms_hspp_file mod_summary
        maybe_src_buf = ms_hspp_buf  mod_summary
339

dterei's avatar
dterei committed
340 341 342
    --------------------------  Parser  ----------------
    liftIO $ showPass dflags "Parser"
    {-# SCC "Parser" #-} do
343 344 345 346

    -- sometimes we already have the buffer in memory, perhaps
    -- because we needed to parse the imports out of it, or get the
    -- module name.
dterei's avatar
dterei committed
347 348 349
    buf <- case maybe_src_buf of
               Just b  -> return b
               Nothing -> liftIO $ hGetStringBuffer src_filename
350

dterei's avatar
dterei committed
351
    let loc = mkRealSrcLoc (mkFastString src_filename) 1 1
352

dterei's avatar
dterei committed
353 354 355
    case unP parseModule (mkPState dflags buf loc) of
        PFailed span err ->
            liftIO $ throwOneError (mkPlainErrMsg span err)
356

dterei's avatar
dterei committed
357 358 359 360 361 362
        POk pst rdr_module -> do
            logWarningsReportErrors (getMessages pst)
            liftIO $ dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" $
                                   ppr rdr_module
            liftIO $ dumpIfSet_dyn dflags Opt_D_source_stats "Source Statistics" $
                                   ppSourceStats False rdr_module
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384

            -- To get the list of extra source files, we take the list
            -- that the parser gave us,
            --   - eliminate files beginning with '<'.  gcc likes to use
            --     pseudo-filenames like "<built-in>" and "<command-line>"
            --   - normalise them (elimiante differences between ./f and f)
            --   - filter out the preprocessed source file
            --   - filter out anything beginning with tmpdir
            --   - remove duplicates
            --   - filter out the .hs/.lhs source filename if we have one
            --
            let n_hspp  = FilePath.normalise src_filename
                srcs0 = nub $ filter (not . (tmpDir dflags `isPrefixOf`))
                            $ filter (not . (== n_hspp))
                            $ map FilePath.normalise
                            $ filter (not . (== '<') . head)
                            $ map unpackFS
                            $ srcfiles pst
                srcs1 = case ml_hs_file (ms_location mod_summary) of
                          Just f  -> filter (/= FilePath.normalise f) srcs0
                          Nothing -> srcs0

385 386 387 388 389
            -- sometimes we see source files from earlier
            -- preprocessing stages that cannot be found, so just
            -- filter them out:
            srcs2 <- liftIO $ filterM doesFileExist srcs1

390 391
            return HsParsedModule {
                      hpm_module    = rdr_module,
392
                      hpm_src_files = srcs2
393
                   }
Simon Marlow's avatar
Simon Marlow committed
394

Thomas Schilling's avatar
Thomas Schilling committed
395 396 397
-- XXX: should this really be a Maybe X?  Check under which circumstances this
-- can become a Nothing and decide whether this should instead throw an
-- exception/signal an error.
dterei's avatar
dterei committed
398
type RenamedStuff =
Simon Marlow's avatar
Simon Marlow committed
399
        (Maybe (HsGroup Name, [LImportDecl Name], Maybe [LIE Name],
400
                Maybe LHsDocString))
Simon Marlow's avatar
Simon Marlow committed
401

Thomas Schilling's avatar
Thomas Schilling committed
402
-- | Rename and typecheck a module, additionally returning the renamed syntax
403
hscTypecheckRename :: HscEnv -> ModSummary -> HsParsedModule
404
                   -> IO (TcGblEnv, RenamedStuff)
dterei's avatar
dterei committed
405
hscTypecheckRename hsc_env mod_summary rdr_module = runHsc hsc_env $ do
406
    tc_result <- tcRnModule' hsc_env mod_summary True rdr_module
Thomas Schilling's avatar
Thomas Schilling committed
407

408 409 410 411 412 413
        -- This 'do' is in the Maybe monad!
    let rn_info = do decl <- tcg_rn_decls tc_result
                     let imports = tcg_rn_imports tc_result
                         exports = tcg_rn_exports tc_result
                         doc_hdr = tcg_doc_hdr tc_result
                     return (decl,imports,exports,doc_hdr)
Thomas Schilling's avatar
Thomas Schilling committed
414

415
    return (tc_result, rn_info)
Simon Marlow's avatar
Simon Marlow committed
416

417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
-- wrapper around tcRnModule to handle safe haskell extras
tcRnModule' :: HscEnv -> ModSummary -> Bool -> HsParsedModule
            -> Hsc TcGblEnv
tcRnModule' hsc_env sum save_rn_syntax mod = do
    tcg_res <- {-# SCC "Typecheck-Rename" #-}
               ioMsgMaybe $
                   tcRnModule hsc_env (ms_hsc_src sum) save_rn_syntax mod

    tcSafeOK <- liftIO $ readIORef (tcg_safeInfer tcg_res)
    dflags   <- getDynFlags

    -- end of the Safe Haskell line, how to respond to user?
    if not (safeHaskellOn dflags) || (safeInferOn dflags && not tcSafeOK)
        -- if safe haskell off or safe infer failed, wipe trust
        then wipeTrust tcg_res emptyBag

        -- module safe, throw warning if needed
        else do
            tcg_res' <- hscCheckSafeImports tcg_res
            safe <- liftIO $ readIORef (tcg_safeInfer tcg_res')
            when (safe && wopt Opt_WarnSafe dflags)
                 (logWarnings $ unitBag $
                     mkPlainWarnMsg (warnSafeOnLoc dflags) $ errSafe tcg_res')
            return tcg_res'
  where
    pprMod t  = ppr $ moduleName $ tcg_mod t
    errSafe t = quotes (pprMod t) <+> text "has been infered as safe!"

Simon Marlow's avatar
Simon Marlow committed
445
-- | Convert a typechecked module to Core
446
hscDesugar :: HscEnv -> ModSummary -> TcGblEnv -> IO ModGuts
447
hscDesugar hsc_env mod_summary tc_result =
Ian Lynagh's avatar
Ian Lynagh committed
448
    runHsc hsc_env $ hscDesugar' (ms_location mod_summary) tc_result
449

Ian Lynagh's avatar
Ian Lynagh committed
450 451
hscDesugar' :: ModLocation -> TcGblEnv -> Hsc ModGuts
hscDesugar' mod_location tc_result = do
dterei's avatar
dterei committed
452
    hsc_env <- getHscEnv
Simon Marlow's avatar
Simon Marlow committed
453 454
    r <- ioMsgMaybe $
      {-# SCC "deSugar" #-}
Ian Lynagh's avatar
Ian Lynagh committed
455
      deSugar hsc_env mod_location tc_result
456

dterei's avatar
dterei committed
457 458 459 460
    -- always check -Werror after desugaring, this is the last opportunity for
    -- warnings to arise before the backend.
    handleWarnings
    return r
Simon Marlow's avatar
Simon Marlow committed
461

dterei's avatar
dterei committed
462
-- | Make a 'ModIface' from the results of typechecking. Used when
Simon Marlow's avatar
Simon Marlow committed
463 464 465 466
-- not optimising, and the interface doesn't need to contain any
-- unfoldings or other cross-module optimisation info.
-- ToDo: the old interface is only needed to get the version numbers,
-- we should use fingerprint versions instead.
467
makeSimpleIface :: HscEnv -> Maybe ModIface -> TcGblEnv -> ModDetails
468
                -> IO (ModIface,Bool)
469 470 471 472 473
makeSimpleIface hsc_env maybe_old_iface tc_result details = runHsc hsc_env $ do
    safe_mode <- hscGetSafeMode tc_result
    ioMsgMaybe $ do
        mkIfaceTc hsc_env (fmap mi_iface_hash maybe_old_iface) safe_mode
                  details tc_result
Simon Marlow's avatar
Simon Marlow committed
474

dterei's avatar
dterei committed
475
-- | Make a 'ModDetails' from the results of typechecking. Used when
Simon Marlow's avatar
Simon Marlow committed
476
-- typechecking only, as opposed to full compilation.
477 478
makeSimpleDetails :: HscEnv -> TcGblEnv -> IO ModDetails
makeSimpleDetails hsc_env tc_result = mkBootModDetailsTc hsc_env tc_result
Simon Marlow's avatar
Simon Marlow committed
479

480

dterei's avatar
dterei committed
481 482 483 484 485 486 487
{- **********************************************************************
%*                                                                      *
                The main compiler pipeline
%*                                                                      *
%********************************************************************* -}

{-
488 489 490 491
                   --------------------------------
                        The compilation proper
                   --------------------------------

dterei's avatar
dterei committed
492 493 494 495 496 497
It's the task of the compilation proper to compile Haskell, hs-boot and core
files to either byte-code, hard-code (C, asm, LLVM, ect) or to nothing at all
(the module is still parsed and type-checked. This feature is mostly used by
IDE's and the likes). Compilation can happen in either 'one-shot', 'batch',
'nothing', or 'interactive' mode. 'One-shot' mode targets hard-code, 'batch'
mode targets hard-code, 'nothing' mode targets nothing and 'interactive' mode
498
targets byte-code.
dterei's avatar
dterei committed
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524

The modes are kept separate because of their different types and meanings:

 * In 'one-shot' mode, we're only compiling a single file and can therefore
 discard the new ModIface and ModDetails. This is also the reason it only
 targets hard-code; compiling to byte-code or nothing doesn't make sense when
 we discard the result.

 * 'Batch' mode is like 'one-shot' except that we keep the resulting ModIface
 and ModDetails. 'Batch' mode doesn't target byte-code since that require us to
 return the newly compiled byte-code.

 * 'Nothing' mode has exactly the same type as 'batch' mode but they're still
 kept separate. This is because compiling to nothing is fairly special: We
 don't output any interface files, we don't run the simplifier and we don't
 generate any code.

 * 'Interactive' mode is similar to 'batch' mode except that we return the
 compiled byte-code together with the ModIface and ModDetails.

Trying to compile a hs-boot file to byte-code will result in a run-time error.
This is the only thing that isn't caught by the type-system.
-}


-- | Status of a compilation to hard-code or nothing.
Thomas Schilling's avatar
Thomas Schilling committed
525
data HscStatus' a
526
    = HscNoRecomp
Thomas Schilling's avatar
Thomas Schilling committed
527
    | HscRecomp
dterei's avatar
dterei committed
528 529 530 531 532
          (Maybe FilePath) -- Has stub files. This is a hack. We can't compile
                           -- C files here since it's done in DriverPipeline.
                           -- For now we just return True if we want the caller
                           -- to compile them for us.
          a
Thomas Schilling's avatar
Thomas Schilling committed
533

dterei's avatar
dterei committed
534
-- This is a bit ugly. Since we use a typeclass below and would like to avoid
Thomas Schilling's avatar
Thomas Schilling committed
535
-- functional dependencies, we have to parameterise the typeclass over the
dterei's avatar
dterei committed
536 537
-- result type. Therefore we need to artificially distinguish some types. We do
-- this by adding type tags which will simply be ignored by the caller.
538
type HscStatus         = HscStatus' ()
539 540
type InteractiveStatus = HscStatus' (Maybe (CompiledByteCode, ModBreaks))
    -- INVARIANT: result is @Nothing@ <=> input was a boot file
Thomas Schilling's avatar
Thomas Schilling committed
541

542 543 544
type OneShotResult     = HscStatus
type BatchResult       = (HscStatus, ModIface, ModDetails)
type NothingResult     = (HscStatus, ModIface, ModDetails)
Thomas Schilling's avatar
Thomas Schilling committed
545
type InteractiveResult = (InteractiveStatus, ModIface, ModDetails)
546

547 548
-- ToDo: The old interface and module index are only using in 'batch' and
--       'interactive' mode. They should be removed from 'oneshot' mode.
549
type Compiler result =  HscEnv
550
                     -> ModSummary
551
                     -> SourceModified
552 553
                     -> Maybe ModIface  -- Old interface, if available
                     -> Maybe (Int,Int) -- Just (i,n) <=> module i of n (for msgs)
554
                     -> IO result
555

dterei's avatar
dterei committed
556
data HsCompiler a = HsCompiler {
557
    -- | Called when no recompilation is necessary.
558 559
    hscNoRecomp :: ModIface
                -> Hsc a,
560 561

    -- | Called to recompile the module.
562 563
    hscRecompile :: ModSummary -> Maybe Fingerprint
                 -> Hsc a,
564

565 566
    hscBackend :: TcGblEnv -> ModSummary -> Maybe Fingerprint
               -> Hsc a,
567

568
    -- | Code generation for Boot modules.
569 570
    hscGenBootOutput :: TcGblEnv -> ModSummary -> Maybe Fingerprint
                     -> Hsc a,
571 572

    -- | Code generation for normal modules.
573
    hscGenOutput :: ModGuts -> ModSummary -> Maybe Fingerprint
574
                 -> Hsc a
575 576
  }

577
genericHscCompile :: HsCompiler a
578
                  -> (HscEnv -> Maybe (Int,Int) -> RecompileRequired -> ModSummary -> IO ())
579
                  -> HscEnv -> ModSummary -> SourceModified
Thomas Schilling's avatar
Thomas Schilling committed
580
                  -> Maybe ModIface -> Maybe (Int, Int)
581 582
                  -> IO a
genericHscCompile compiler hscMessage hsc_env
583
                  mod_summary source_modified
584
                  mb_old_iface0 mb_mod_index
dterei's avatar
dterei committed
585 586 587
  = do
    (recomp_reqd, mb_checked_iface)
        <- {-# SCC "checkOldIface" #-}
dterei's avatar
dterei committed
588
           checkOldIface hsc_env mod_summary
dterei's avatar
dterei committed
589 590 591 592 593 594 595
                         source_modified mb_old_iface0
    -- save the interface that comes back from checkOldIface.
    -- In one-shot mode we don't have the old iface until this
    -- point, when checkOldIface reads it from the disk.
    let mb_old_hash = fmap mi_iface_hash mb_checked_iface

    let skip iface = do
596
            hscMessage hsc_env mb_mod_index UpToDate mod_summary
dterei's avatar
dterei committed
597 598 599 600 601 602 603 604 605
            runHsc hsc_env $ hscNoRecomp compiler iface

        compile reason = do
            hscMessage hsc_env mb_mod_index reason mod_summary
            runHsc hsc_env $ hscRecompile compiler mod_summary mb_old_hash

        stable = case source_modified of
                     SourceUnmodifiedAndStable -> True
                     _                         -> False
606 607 608

        -- If the module used TH splices when it was last compiled,
        -- then the recompilation check is not accurate enough (#481)
dterei's avatar
dterei committed
609
        -- and we must ignore it. However, if the module is stable
610
        -- (none of the modules it depends on, directly or indirectly,
dterei's avatar
dterei committed
611
        -- changed), then we *can* skip recompilation. This is why
612 613 614
        -- the SourceModified type contains SourceUnmodifiedAndStable,
        -- and it's pretty important: otherwise ghc --make would
        -- always recompile TH modules, even if nothing at all has
dterei's avatar
dterei committed
615
        -- changed. Stability is just the same check that make is
616 617
        -- doing for us in one-shot mode.

dterei's avatar
dterei committed
618
    case mb_checked_iface of
619
        Just iface | not (recompileRequired recomp_reqd) ->
dterei's avatar
dterei committed
620 621 622 623
            if mi_used_th iface && not stable
                then compile RecompForcedByTH
                else skip iface
        _otherwise ->
624
            compile recomp_reqd
Thomas Schilling's avatar
Thomas Schilling committed
625

626
hscCheckRecompBackend :: HsCompiler a -> TcGblEnv -> Compiler a
dterei's avatar
dterei committed
627 628
hscCheckRecompBackend compiler tc_result hsc_env mod_summary
                      source_modified mb_old_iface _m_of_n
629
  = do
dterei's avatar
dterei committed
630 631 632 633 634 635 636
    (recomp_reqd, mb_checked_iface)
        <- {-# SCC "checkOldIface" #-}
           checkOldIface hsc_env mod_summary
                         source_modified mb_old_iface

    let mb_old_hash = fmap mi_iface_hash mb_checked_iface
    case mb_checked_iface of
637
        Just iface | not (recompileRequired recomp_reqd)
dterei's avatar
dterei committed
638
            -> runHsc hsc_env $
dterei's avatar
dterei committed
639 640 641 642 643
                   hscNoRecomp compiler
                       iface{ mi_globals = Just (tcg_rdr_env tc_result) }
        _otherwise
            -> runHsc hsc_env $
                   hscBackend compiler tc_result mod_summary mb_old_hash
644

645
genericHscRecompile :: HsCompiler a
646
                    -> ModSummary -> Maybe Fingerprint
647
                    -> Hsc a
648
genericHscRecompile compiler mod_summary mb_old_hash
dterei's avatar
dterei committed
649 650 651 652 653
    | ExtCoreFile <- ms_hsc_src mod_summary =
        panic "GHC does not currently support reading External Core files"
    | otherwise = do
        tc_result <- hscFileFrontEnd mod_summary
        hscBackend compiler tc_result mod_summary mb_old_hash
654

655
genericHscBackend :: HsCompiler a
656
                  -> TcGblEnv -> ModSummary -> Maybe Fingerprint
657
                  -> Hsc a
658
genericHscBackend compiler tc_result mod_summary mb_old_hash
dterei's avatar
dterei committed
659 660 661
    | HsBootFile <- ms_hsc_src mod_summary =
        hscGenBootOutput compiler tc_result mod_summary mb_old_hash
    | otherwise = do
Ian Lynagh's avatar
Ian Lynagh committed
662
        guts <- hscDesugar' (ms_location mod_summary) tc_result
dterei's avatar
dterei committed
663
        hscGenOutput compiler guts mod_summary mb_old_hash
Thomas Schilling's avatar
Thomas Schilling committed
664

665 666
compilerBackend :: HsCompiler a -> TcGblEnv -> Compiler a
compilerBackend comp tcg hsc_env ms' _ _mb_old_iface _ =
dterei's avatar
dterei committed
667
    runHsc hsc_env $ hscBackend comp tcg ms' Nothing
668

669 670 671 672
--------------------------------------------------------------
-- Compilers
--------------------------------------------------------------

673
hscOneShotCompiler :: HsCompiler OneShotResult
dterei's avatar
dterei committed
674
hscOneShotCompiler = HsCompiler {
675

676
    hscNoRecomp = \_old_iface -> do
dterei's avatar
dterei committed
677 678 679
        hsc_env <- getHscEnv
        liftIO $ dumpIfaceStats hsc_env
        return HscNoRecomp
680 681 682

  , hscRecompile = genericHscRecompile hscOneShotCompiler

dterei's avatar
dterei committed
683
  , hscBackend = \tc_result mod_summary mb_old_hash -> do
dterei's avatar
dterei committed
684 685 686 687 688
        dflags <- getDynFlags
        case hscTarget dflags of
            HscNothing -> return (HscRecomp Nothing ())
            _otherw    -> genericHscBackend hscOneShotCompiler
                              tc_result mod_summary mb_old_hash
689

690
  , hscGenBootOutput = \tc_result mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
691 692 693
        (iface, changed, _) <- hscSimpleIface tc_result mb_old_iface
        hscWriteIface iface changed mod_summary
        return (HscRecomp Nothing ())
694 695

  , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
696 697 698 699 700
        guts <- hscSimplify' guts0
        (iface, changed, _details, cgguts) <- hscNormalIface guts mb_old_iface
        hscWriteIface iface changed mod_summary
        hasStub <- hscGenHardCode cgguts mod_summary
        return (HscRecomp hasStub ())
701
  }
702

Thomas Schilling's avatar
Thomas Schilling committed
703
-- Compile Haskell, boot and extCore in OneShot mode.
704
hscCompileOneShot :: Compiler OneShotResult
705 706
hscCompileOneShot hsc_env mod_summary src_changed mb_old_iface mb_i_of_n
  = do
dterei's avatar
dterei committed
707 708 709 710 711
    -- One-shot mode needs a knot-tying mutable variable for interface
    -- files. See TcRnTypes.TcGblEnv.tcg_type_env_var.
    type_env_var <- newIORef emptyNameEnv
    let mod = ms_mod mod_summary
        hsc_env' = hsc_env{ hsc_type_env_var = Just (mod, type_env_var) }
712

dterei's avatar
dterei committed
713 714 715
    genericHscCompile hscOneShotCompiler
                      oneShotMsg hsc_env' mod_summary src_changed
                      mb_old_iface mb_i_of_n
Thomas Schilling's avatar
Thomas Schilling committed
716

717 718 719
hscOneShotBackendOnly :: TcGblEnv -> Compiler OneShotResult
hscOneShotBackendOnly = compilerBackend hscOneShotCompiler

Thomas Schilling's avatar
Thomas Schilling committed
720 721
--------------------------------------------------------------

722
hscBatchCompiler :: HsCompiler BatchResult
dterei's avatar
dterei committed
723
hscBatchCompiler = HsCompiler {
Thomas Schilling's avatar
Thomas Schilling committed
724

725
    hscNoRecomp = \iface -> do
dterei's avatar
dterei committed
726 727
        details <- genModDetails iface
        return (HscNoRecomp, iface, details)
Thomas Schilling's avatar
Thomas Schilling committed
728

729
  , hscRecompile = genericHscRecompile hscBatchCompiler
Thomas Schilling's avatar
Thomas Schilling committed
730

731 732
  , hscBackend = genericHscBackend hscBatchCompiler

733
  , hscGenBootOutput = \tc_result mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
734 735 736
        (iface, changed, details) <- hscSimpleIface tc_result mb_old_iface
        hscWriteIface iface changed mod_summary
        return (HscRecomp Nothing (), iface, details)
Thomas Schilling's avatar
Thomas Schilling committed
737

738
  , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
739 740 741 742 743
        guts <- hscSimplify' guts0
        (iface, changed, details, cgguts) <- hscNormalIface guts mb_old_iface
        hscWriteIface iface changed mod_summary
        hasStub <- hscGenHardCode cgguts mod_summary
        return (HscRecomp hasStub (), iface, details)
744
  }
745

dterei's avatar
dterei committed
746
-- | Compile Haskell, boot and extCore in batch mode.
747
hscCompileBatch :: Compiler (HscStatus, ModIface, ModDetails)
748
hscCompileBatch = genericHscCompile hscBatchCompiler batchMsg
Thomas Schilling's avatar
Thomas Schilling committed
749

750 751 752
hscBatchBackendOnly :: TcGblEnv -> Compiler BatchResult
hscBatchBackendOnly = hscCheckRecompBackend hscBatchCompiler

Thomas Schilling's avatar
Thomas Schilling committed
753 754
--------------------------------------------------------------

755
hscInteractiveCompiler :: HsCompiler InteractiveResult
dterei's avatar
dterei committed
756
hscInteractiveCompiler = HsCompiler {
757
    hscNoRecomp = \iface -> do
dterei's avatar
dterei committed
758 759
        details <- genModDetails iface
        return (HscNoRecomp, iface, details)
Thomas Schilling's avatar
Thomas Schilling committed
760

761
  , hscRecompile = genericHscRecompile hscInteractiveCompiler
Thomas Schilling's avatar
Thomas Schilling committed
762

763 764 765
  , hscBackend = genericHscBackend hscInteractiveCompiler

  , hscGenBootOutput = \tc_result _mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
766 767
        (iface, _changed, details) <- hscSimpleIface tc_result mb_old_iface
        return (HscRecomp Nothing Nothing, iface, details)
Thomas Schilling's avatar
Thomas Schilling committed
768

769
  , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
770 771 772
        guts <- hscSimplify' guts0
        (iface, _changed, details, cgguts) <- hscNormalIface guts mb_old_iface
        hscInteractive (iface, details, cgguts) mod_summary
773
  }
774 775 776

-- Compile Haskell, extCore to bytecode.
hscCompileInteractive :: Compiler (InteractiveStatus, ModIface, ModDetails)
777
hscCompileInteractive = genericHscCompile hscInteractiveCompiler batchMsg
Thomas Schilling's avatar
Thomas Schilling committed
778

779 780 781
hscInteractiveBackendOnly :: TcGblEnv -> Compiler InteractiveResult
hscInteractiveBackendOnly = compilerBackend hscInteractiveCompiler

Thomas Schilling's avatar
Thomas Schilling committed
782 783
--------------------------------------------------------------

784
hscNothingCompiler :: HsCompiler NothingResult
dterei's avatar
dterei committed
785
hscNothingCompiler = HsCompiler {
786
    hscNoRecomp = \iface -> do
dterei's avatar
dterei committed
787 788
        details <- genModDetails iface
        return (HscNoRecomp, iface, details)
Simon Marlow's avatar
Simon Marlow committed
789

790
  , hscRecompile = genericHscRecompile hscNothingCompiler
791

792
  , hscBackend = \tc_result _mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
793 794 795
        handleWarnings
        (iface, _changed, details) <- hscSimpleIface tc_result mb_old_iface
        return (HscRecomp Nothing (), iface, details)
796

797 798 799
  , hscGenBootOutput = \_ _ _ ->
        panic "hscCompileNothing: hscGenBootOutput should not be called"

800 801 802
  , hscGenOutput = \_ _ _ ->
        panic "hscCompileNothing: hscGenOutput should not be called"
  }
803

804
-- Type-check Haskell and .hs-boot only (no external core)
805
hscCompileNothing :: Compiler (HscStatus, ModIface, ModDetails)
806
hscCompileNothing = genericHscCompile hscNothingCompiler batchMsg
807

808 809 810
hscNothingBackendOnly :: TcGblEnv -> Compiler NothingResult
hscNothingBackendOnly = compilerBackend hscNothingCompiler

811 812 813 814
--------------------------------------------------------------
-- NoRecomp handlers
--------------------------------------------------------------

815 816 817
genModDetails :: ModIface -> Hsc ModDetails
genModDetails old_iface
  = do
dterei's avatar
dterei committed
818 819 820 821 822
    hsc_env <- getHscEnv
    new_details <- {-# SCC "tcRnIface" #-}
                   liftIO $ initIfaceCheck hsc_env (typecheckIface old_iface)
    liftIO $ dumpIfaceStats hsc_env
    return new_details
823

824 825 826 827
--------------------------------------------------------------
-- Progress displayers.
--------------------------------------------------------------

828 829
oneShotMsg :: HscEnv -> Maybe (Int,Int) -> RecompileRequired -> ModSummary
            -> IO ()
830
oneShotMsg hsc_env _mb_mod_index recomp _mod_summary =
dterei's avatar
dterei committed
831
    case recomp of
832
        UpToDate ->
833 834
            compilationProgressMsg (hsc_dflags hsc_env) $
                   "compilation IS NOT required"
dterei's avatar
dterei committed
835
        _other ->
836 837
            return ()

838 839
batchMsg :: HscEnv -> Maybe (Int,Int) -> RecompileRequired -> ModSummary
         -> IO ()
dterei's avatar
dterei committed
840 841
batchMsg hsc_env mb_mod_index recomp mod_summary =
    case recomp of
842 843 844
        MustCompile -> showMsg "Compiling " ""
        UpToDate
            | verbosity (hsc_dflags hsc_env) >= 2 -> showMsg "Skipping  " ""
dterei's avatar
dterei committed
845
            | otherwise -> return ()
846 847
        RecompBecause reason -> showMsg "Compiling " (" [" ++ reason ++ "]")
        RecompForcedByTH -> showMsg "Compiling " " [TH]"
dterei's avatar
dterei committed
848
    where
849
        showMsg msg reason =
dterei's avatar
dterei committed
850 851 852
            compilationProgressMsg (hsc_dflags hsc_env) $
            (showModuleIndex mb_mod_index ++
            msg ++ showModMsg (hscTarget (hsc_dflags hsc_env))
853 854
                              (recompileRequired recomp) mod_summary)
                ++ reason
855

856 857 858
--------------------------------------------------------------
-- FrontEnds
--------------------------------------------------------------
859 860

hscFileFrontEnd :: ModSummary -> Hsc TcGblEnv
861
hscFileFrontEnd mod_summary = do
862
    hpm <- hscParse' mod_summary
863
    hsc_env <- getHscEnv
864 865
    tcg_env <- tcRnModule' hsc_env mod_summary False hpm
    return tcg_env
866 867

--------------------------------------------------------------
868
-- Safe Haskell
869 870
----------------------------------------