HscMain.hs 69.6 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
    , FileOutputStatus
38
    , InteractiveStatus, HscStatus
39 40 41 42 43 44 45 46
    , hscCompileOneShot
    , hscCompileBatch
    , hscCompileNothing
    , hscCompileInteractive
    , hscCompileCmmFile
    , hscCompileCore

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

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

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

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

import GHC.Exts
93 94
#endif

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

135
import DynFlags
136
import ErrUtils
137

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

150
import Util
Simon Marlow's avatar
Simon Marlow committed
151

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

Thomas Schilling's avatar
Thomas Schilling committed
159
#include "HsVersions.h"
160

161

dterei's avatar
dterei committed
162 163 164 165 166
{- **********************************************************************
%*                                                                      *
                Initialisation
%*                                                                      *
%********************************************************************* -}
167

168
newHscEnv :: DynFlags -> IO HscEnv
169
newHscEnv dflags = do
dterei's avatar
dterei committed
170 171 172 173 174
    eps_var <- newIORef initExternalPackageState
    us      <- mkSplitUniqSupply 'r'
    nc_var  <- newIORef (initNameCache us knownKeyNames)
    fc_var  <- newIORef emptyUFM
    mlc_var <- newIORef emptyModuleEnv
175
    return HscEnv {  hsc_dflags       = dflags,
dterei's avatar
dterei committed
176 177
                     hsc_targets      = [],
                     hsc_mod_graph    = [],
178
                     hsc_IC           = emptyInteractiveContext dflags,
dterei's avatar
dterei committed
179 180 181 182 183
                     hsc_HPT          = emptyHomePackageTable,
                     hsc_EPS          = eps_var,
                     hsc_NC           = nc_var,
                     hsc_FC           = fc_var,
                     hsc_MLC          = mlc_var,
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
dterei's avatar
dterei committed
314 315 316 317 318
hscIsGHCiMonad :: HscEnv -> String -> IO Name
hscIsGHCiMonad hsc_env name =
    let icntxt   = hsc_IC hsc_env
    in runHsc hsc_env $ ioMsgMaybe $ isGHCiMonad hsc_env icntxt name

319
hscGetModuleInterface :: HscEnv -> Module -> IO ModIface
320 321 322
hscGetModuleInterface hsc_env0 mod = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe $ getModuleInterface hsc_env mod
323 324 325

-- -----------------------------------------------------------------------------
-- | Rename some import declarations
326
hscRnImportDecls :: HscEnv -> [LImportDecl RdrName] -> IO GlobalRdrEnv
327 328 329
hscRnImportDecls hsc_env0 import_decls = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe $ tcRnImportDecls hsc_env import_decls
330 331
#endif

332
-- -----------------------------------------------------------------------------
Simon Marlow's avatar
Simon Marlow committed
333
-- | parse a file, returning the abstract syntax
334

335
hscParse :: HscEnv -> ModSummary -> IO HsParsedModule
336 337 338
hscParse hsc_env mod_summary = runHsc hsc_env $ hscParse' mod_summary

-- internal version, that doesn't fail due to -Werror
339
hscParse' :: ModSummary -> Hsc HsParsedModule
340
hscParse' mod_summary = do
dterei's avatar
dterei committed
341 342 343
    dflags <- getDynFlags
    let src_filename  = ms_hspp_file mod_summary
        maybe_src_buf = ms_hspp_buf  mod_summary
344

dterei's avatar
dterei committed
345 346 347
    --------------------------  Parser  ----------------
    liftIO $ showPass dflags "Parser"
    {-# SCC "Parser" #-} do
348 349 350 351

    -- 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
352 353 354
    buf <- case maybe_src_buf of
               Just b  -> return b
               Nothing -> liftIO $ hGetStringBuffer src_filename
355

dterei's avatar
dterei committed
356
    let loc = mkRealSrcLoc (mkFastString src_filename) 1 1
357

dterei's avatar
dterei committed
358 359
    case unP parseModule (mkPState dflags buf loc) of
        PFailed span err ->
Ian Lynagh's avatar
Ian Lynagh committed
360
            liftIO $ throwOneError (mkPlainErrMsg dflags span err)
361

dterei's avatar
dterei committed
362 363 364 365 366 367
        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
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382

            -- 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
383
                            $ filter (not . (isPrefixOf "<"))
384 385 386 387 388 389
                            $ map unpackFS
                            $ srcfiles pst
                srcs1 = case ml_hs_file (ms_location mod_summary) of
                          Just f  -> filter (/= FilePath.normalise f) srcs0
                          Nothing -> srcs0

390 391 392 393 394
            -- sometimes we see source files from earlier
            -- preprocessing stages that cannot be found, so just
            -- filter them out:
            srcs2 <- liftIO $ filterM doesFileExist srcs1

395 396
            return HsParsedModule {
                      hpm_module    = rdr_module,
397
                      hpm_src_files = srcs2
398
                   }
Simon Marlow's avatar
Simon Marlow committed
399

Thomas Schilling's avatar
Thomas Schilling committed
400 401 402
-- 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
403
type RenamedStuff =
Simon Marlow's avatar
Simon Marlow committed
404
        (Maybe (HsGroup Name, [LImportDecl Name], Maybe [LIE Name],
405
                Maybe LHsDocString))
Simon Marlow's avatar
Simon Marlow committed
406

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

413 414 415 416 417 418
        -- 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
419

420
    return (tc_result, rn_info)
Simon Marlow's avatar
Simon Marlow committed
421

422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
-- 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 $
Ian Lynagh's avatar
Ian Lynagh committed
444
                     mkPlainWarnMsg dflags (warnSafeOnLoc dflags) $ errSafe tcg_res')
445 446 447
            return tcg_res'
  where
    pprMod t  = ppr $ moduleName $ tcg_mod t
448
    errSafe t = quotes (pprMod t) <+> text "has been inferred as safe!"
449

Simon Marlow's avatar
Simon Marlow committed
450
-- | Convert a typechecked module to Core
451
hscDesugar :: HscEnv -> ModSummary -> TcGblEnv -> IO ModGuts
452
hscDesugar hsc_env mod_summary tc_result =
Ian Lynagh's avatar
Ian Lynagh committed
453
    runHsc hsc_env $ hscDesugar' (ms_location mod_summary) tc_result
454

Ian Lynagh's avatar
Ian Lynagh committed
455 456
hscDesugar' :: ModLocation -> TcGblEnv -> Hsc ModGuts
hscDesugar' mod_location tc_result = do
dterei's avatar
dterei committed
457
    hsc_env <- getHscEnv
Simon Marlow's avatar
Simon Marlow committed
458 459
    r <- ioMsgMaybe $
      {-# SCC "deSugar" #-}
Ian Lynagh's avatar
Ian Lynagh committed
460
      deSugar hsc_env mod_location tc_result
461

dterei's avatar
dterei committed
462 463 464 465
    -- 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
466

dterei's avatar
dterei committed
467
-- | Make a 'ModIface' from the results of typechecking. Used when
Simon Marlow's avatar
Simon Marlow committed
468 469 470 471
-- 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.
472
makeSimpleIface :: HscEnv -> Maybe ModIface -> TcGblEnv -> ModDetails
473
                -> IO (ModIface,Bool)
474 475 476 477 478
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
479

dterei's avatar
dterei committed
480
-- | Make a 'ModDetails' from the results of typechecking. Used when
Simon Marlow's avatar
Simon Marlow committed
481
-- typechecking only, as opposed to full compilation.
482 483
makeSimpleDetails :: HscEnv -> TcGblEnv -> IO ModDetails
makeSimpleDetails hsc_env tc_result = mkBootModDetailsTc hsc_env tc_result
Simon Marlow's avatar
Simon Marlow committed
484

485

dterei's avatar
dterei committed
486 487 488 489 490 491 492
{- **********************************************************************
%*                                                                      *
                The main compiler pipeline
%*                                                                      *
%********************************************************************* -}

{-
493 494 495 496
                   --------------------------------
                        The compilation proper
                   --------------------------------

dterei's avatar
dterei committed
497 498 499 500 501 502
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
503
targets byte-code.
dterei's avatar
dterei committed
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529

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
530
data HscStatus' a
531
    = HscNoRecomp
Thomas Schilling's avatar
Thomas Schilling committed
532
    | HscRecomp
dterei's avatar
dterei committed
533 534 535 536 537
          (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
538

dterei's avatar
dterei committed
539
-- This is a bit ugly. Since we use a typeclass below and would like to avoid
Thomas Schilling's avatar
Thomas Schilling committed
540
-- functional dependencies, we have to parameterise the typeclass over the
dterei's avatar
dterei committed
541 542
-- 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.
543
type HscStatus         = HscStatus' ()
544
type FileOutputStatus  = HscStatus' (Maybe FilePath)
545 546
type InteractiveStatus = HscStatus' (Maybe (CompiledByteCode, ModBreaks))
    -- INVARIANT: result is @Nothing@ <=> input was a boot file
Thomas Schilling's avatar
Thomas Schilling committed
547

548 549
type OneShotResult     = FileOutputStatus
type BatchResult       = (FileOutputStatus, ModIface, ModDetails)
550
type NothingResult     = (HscStatus, ModIface, ModDetails)
Thomas Schilling's avatar
Thomas Schilling committed
551
type InteractiveResult = (InteractiveStatus, ModIface, ModDetails)
552

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

dterei's avatar
dterei committed
562
data HsCompiler a = HsCompiler {
563
    -- | Called when no recompilation is necessary.
564 565
    hscNoRecomp :: ModIface
                -> Hsc a,
566 567

    -- | Called to recompile the module.
568 569
    hscRecompile :: ModSummary -> Maybe Fingerprint
                 -> Hsc a,
570

571 572
    hscBackend :: TcGblEnv -> ModSummary -> Maybe Fingerprint
               -> Hsc a,
573

574
    -- | Code generation for Boot modules.
575 576
    hscGenBootOutput :: TcGblEnv -> ModSummary -> Maybe Fingerprint
                     -> Hsc a,
577 578

    -- | Code generation for normal modules.
579
    hscGenOutput :: ModGuts -> ModSummary -> Maybe Fingerprint
580
                 -> Hsc a
581 582
  }

583
genericHscCompile :: HsCompiler a
584
                  -> (HscEnv -> Maybe (Int,Int) -> RecompileRequired -> ModSummary -> IO ())
585
                  -> HscEnv -> ModSummary -> SourceModified
Thomas Schilling's avatar
Thomas Schilling committed
586
                  -> Maybe ModIface -> Maybe (Int, Int)
587 588
                  -> IO a
genericHscCompile compiler hscMessage hsc_env
589
                  mod_summary source_modified
590
                  mb_old_iface0 mb_mod_index
dterei's avatar
dterei committed
591 592 593
  = do
    (recomp_reqd, mb_checked_iface)
        <- {-# SCC "checkOldIface" #-}
dterei's avatar
dterei committed
594
           checkOldIface hsc_env mod_summary
dterei's avatar
dterei committed
595 596 597 598 599 600 601
                         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
602
            hscMessage hsc_env mb_mod_index UpToDate mod_summary
dterei's avatar
dterei committed
603 604 605 606 607 608 609 610 611
            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
612 613 614

        -- 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
615
        -- and we must ignore it. However, if the module is stable
616
        -- (none of the modules it depends on, directly or indirectly,
dterei's avatar
dterei committed
617
        -- changed), then we *can* skip recompilation. This is why
618 619 620
        -- 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
621
        -- changed. Stability is just the same check that make is
622 623
        -- doing for us in one-shot mode.

dterei's avatar
dterei committed
624
    case mb_checked_iface of
625
        Just iface | not (recompileRequired recomp_reqd) ->
dterei's avatar
dterei committed
626
            if mi_used_th iface && not stable
Simon Marlow's avatar
Simon Marlow committed
627
                then compile (RecompBecause "TH")
dterei's avatar
dterei committed
628 629
                else skip iface
        _otherwise ->
630
            compile recomp_reqd
Thomas Schilling's avatar
Thomas Schilling committed
631

632
hscCheckRecompBackend :: HsCompiler a -> TcGblEnv -> Compiler a
dterei's avatar
dterei committed
633 634
hscCheckRecompBackend compiler tc_result hsc_env mod_summary
                      source_modified mb_old_iface _m_of_n
635
  = do
dterei's avatar
dterei committed
636 637 638 639 640 641 642
    (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
643
        Just iface | not (recompileRequired recomp_reqd)
dterei's avatar
dterei committed
644
            -> runHsc hsc_env $
dterei's avatar
dterei committed
645 646 647 648 649
                   hscNoRecomp compiler
                       iface{ mi_globals = Just (tcg_rdr_env tc_result) }
        _otherwise
            -> runHsc hsc_env $
                   hscBackend compiler tc_result mod_summary mb_old_hash
650

651
genericHscRecompile :: HsCompiler a
652
                    -> ModSummary -> Maybe Fingerprint
653
                    -> Hsc a
654
genericHscRecompile compiler mod_summary mb_old_hash
dterei's avatar
dterei committed
655 656 657 658 659
    | 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
660

661
genericHscBackend :: HsCompiler a
662
                  -> TcGblEnv -> ModSummary -> Maybe Fingerprint
663
                  -> Hsc a
664
genericHscBackend compiler tc_result mod_summary mb_old_hash
dterei's avatar
dterei committed
665 666 667
    | HsBootFile <- ms_hsc_src mod_summary =
        hscGenBootOutput compiler tc_result mod_summary mb_old_hash
    | otherwise = do
Ian Lynagh's avatar
Ian Lynagh committed
668
        guts <- hscDesugar' (ms_location mod_summary) tc_result
dterei's avatar
dterei committed
669
        hscGenOutput compiler guts mod_summary mb_old_hash
Thomas Schilling's avatar
Thomas Schilling committed
670

671 672
compilerBackend :: HsCompiler a -> TcGblEnv -> Compiler a
compilerBackend comp tcg hsc_env ms' _ _mb_old_iface _ =
dterei's avatar
dterei committed
673
    runHsc hsc_env $ hscBackend comp tcg ms' Nothing
674

675 676 677 678
--------------------------------------------------------------
-- Compilers
--------------------------------------------------------------

679
hscOneShotCompiler :: HsCompiler OneShotResult
dterei's avatar
dterei committed
680
hscOneShotCompiler = HsCompiler {
681

682
    hscNoRecomp = \_old_iface -> do
dterei's avatar
dterei committed
683 684 685
        hsc_env <- getHscEnv
        liftIO $ dumpIfaceStats hsc_env
        return HscNoRecomp
686 687 688

  , hscRecompile = genericHscRecompile hscOneShotCompiler

dterei's avatar
dterei committed
689
  , hscBackend = \tc_result mod_summary mb_old_hash -> do
dterei's avatar
dterei committed
690 691
        dflags <- getDynFlags
        case hscTarget dflags of
692
            HscNothing -> return (HscRecomp Nothing Nothing)
dterei's avatar
dterei committed
693 694
            _otherw    -> genericHscBackend hscOneShotCompiler
                              tc_result mod_summary mb_old_hash
695

696
  , hscGenBootOutput = \tc_result mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
697 698
        (iface, changed, _) <- hscSimpleIface tc_result mb_old_iface
        hscWriteIface iface changed mod_summary
699
        return (HscRecomp Nothing Nothing)
700 701

  , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
702 703 704
        guts <- hscSimplify' guts0
        (iface, changed, _details, cgguts) <- hscNormalIface guts mb_old_iface
        hscWriteIface iface changed mod_summary
705 706
        (outputFilename, hasStub) <- hscGenHardCode cgguts mod_summary
        return (HscRecomp hasStub (Just outputFilename))
707
  }
708

Thomas Schilling's avatar
Thomas Schilling committed
709
-- Compile Haskell, boot and extCore in OneShot mode.
710
hscCompileOneShot :: Compiler OneShotResult
711 712
hscCompileOneShot hsc_env mod_summary src_changed mb_old_iface mb_i_of_n
  = do
dterei's avatar
dterei committed
713 714 715 716 717
    -- 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) }
718

dterei's avatar
dterei committed
719 720 721
    genericHscCompile hscOneShotCompiler
                      oneShotMsg hsc_env' mod_summary src_changed
                      mb_old_iface mb_i_of_n
Thomas Schilling's avatar
Thomas Schilling committed
722

723 724 725
hscOneShotBackendOnly :: TcGblEnv -> Compiler OneShotResult
hscOneShotBackendOnly = compilerBackend hscOneShotCompiler

Thomas Schilling's avatar
Thomas Schilling committed
726 727
--------------------------------------------------------------

728
hscBatchCompiler :: HsCompiler BatchResult
dterei's avatar
dterei committed
729
hscBatchCompiler = HsCompiler {
Thomas Schilling's avatar
Thomas Schilling committed
730

731
    hscNoRecomp = \iface -> do
dterei's avatar
dterei committed
732 733
        details <- genModDetails iface
        return (HscNoRecomp, iface, details)
Thomas Schilling's avatar
Thomas Schilling committed
734

735
  , hscRecompile = genericHscRecompile hscBatchCompiler
Thomas Schilling's avatar
Thomas Schilling committed
736

737 738
  , hscBackend = genericHscBackend hscBatchCompiler

739
  , hscGenBootOutput = \tc_result mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
740 741
        (iface, changed, details) <- hscSimpleIface tc_result mb_old_iface
        hscWriteIface iface changed mod_summary
742
        return (HscRecomp Nothing Nothing, iface, details)
Thomas Schilling's avatar
Thomas Schilling committed
743

744
  , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
745 746 747
        guts <- hscSimplify' guts0
        (iface, changed, details, cgguts) <- hscNormalIface guts mb_old_iface
        hscWriteIface iface changed mod_summary
748 749
        (outputFilename, hasStub) <- hscGenHardCode cgguts mod_summary
        return (HscRecomp hasStub (Just outputFilename), iface, details)
750
  }
751

dterei's avatar
dterei committed
752
-- | Compile Haskell, boot and extCore in batch mode.
753
hscCompileBatch :: Compiler (FileOutputStatus, ModIface, ModDetails)
754
hscCompileBatch = genericHscCompile hscBatchCompiler batchMsg
Thomas Schilling's avatar
Thomas Schilling committed
755

756 757 758
hscBatchBackendOnly :: TcGblEnv -> Compiler BatchResult
hscBatchBackendOnly = hscCheckRecompBackend hscBatchCompiler

Thomas Schilling's avatar
Thomas Schilling committed
759 760
--------------------------------------------------------------

761
hscInteractiveCompiler :: HsCompiler InteractiveResult
dterei's avatar
dterei committed
762
hscInteractiveCompiler = HsCompiler {
763
    hscNoRecomp = \iface -> do
dterei's avatar
dterei committed
764 765
        details <- genModDetails iface
        return (HscNoRecomp, iface, details)
Thomas Schilling's avatar
Thomas Schilling committed
766

767
  , hscRecompile = genericHscRecompile hscInteractiveCompiler
Thomas Schilling's avatar
Thomas Schilling committed
768

769 770 771
  , hscBackend = genericHscBackend hscInteractiveCompiler

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

775
  , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
776 777 778
        guts <- hscSimplify' guts0
        (iface, _changed, details, cgguts) <- hscNormalIface guts mb_old_iface
        hscInteractive (iface, details, cgguts) mod_summary
779
  }
780 781 782

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

785 786 787
hscInteractiveBackendOnly :: TcGblEnv -> Compiler InteractiveResult
hscInteractiveBackendOnly = compilerBackend hscInteractiveCompiler

Thomas Schilling's avatar
Thomas Schilling committed
788 789
--------------------------------------------------------------

790
hscNothingCompiler :: HsCompiler NothingResult
dterei's avatar
dterei committed
791
hscNothingCompiler = HsCompiler {
792
    hscNoRecomp = \iface -> do
dterei's avatar
dterei committed
793 794
        details <- genModDetails iface
        return (HscNoRecomp, iface, details)
Simon Marlow's avatar
Simon Marlow committed
795

796
  , hscRecompile = genericHscRecompile hscNothingCompiler
797

798
  , hscBackend = \tc_result _mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
799 800 801
        handleWarnings
        (iface, _changed, details) <- hscSimpleIface tc_result mb_old_iface
        return (HscRecomp Nothing (), iface, details)
802

803 804 805
  , hscGenBootOutput = \_ _ _ ->
        panic "hscCompileNothing: hscGenBootOutput should not be called"

806 807 808
  , hscGenOutput = \_ _ _ ->
        panic "hscCompileNothing: hscGenOutput should not be called"
  }
809

810
-- Type-check Haskell and .hs-boot only (no external core)
811
hscCompileNothing :: Compiler (HscStatus, ModIface, ModDetails)
812
hscCompileNothing = genericHscCompile hscNothingCompiler batchMsg
813

814 815 816
hscNothingBackendOnly :: TcGblEnv -> Compiler NothingResult
hscNothingBackendOnly = compilerBackend hscNothingCompiler

817 818 819 820
--------------------------------------------------------------
-- NoRecomp handlers
--------------------------------------------------------------

821 822 823
genModDetails :: ModIface -> Hsc ModDetails
genModDetails old_iface
  = do
dterei's avatar
dterei committed
824 825 826 827 828
    hsc_env <- getHscEnv
    new_details <- {-# SCC "tcRnIface" #-}
                   liftIO $ initIfaceCheck hsc_env (typecheckIface old_iface)
    liftIO $ dumpIfaceStats hsc_env
    return new_details
829

830 831 832 833
--------------------------------------------------------------
-- Progress displayers.
--------------------------------------------------------------

834 835
oneShotMsg :: HscEnv -> Maybe (Int,Int) -> RecompileRequired -> ModSummary
            -> IO ()
836
oneShotMsg hsc_env _mb_mod_index recomp _mod_summary =
dterei's avatar
dterei committed
837
    case recomp of
838
        UpToDate ->
839 840
            compilationProgressMsg (hsc_dflags hsc_env) $
                   "compilation IS NOT required"
dterei's avatar
dterei committed
841
        _other ->
842 843
            return ()

844 845
batchMsg :: HscEnv -> Maybe (Int,Int) -> RecompileRequired -> ModSummary
         -> IO ()
dterei's avatar
dterei committed
846 847
batchMsg hsc_env mb_mod_index recomp mod_summary =
    case recomp of
848 849 850
        MustCompile -> showMsg "Compiling " ""
        UpToDate
            | verbosity (hsc_dflags hsc_env) >= 2 -> showMsg "Skipping  " ""
dterei's avatar
dterei committed
851
            |