HscMain.hs 64.7 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
#endif

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

134
import DynFlags
135
import ErrUtils
136
import UniqSupply       ( mkSplitUniqSupply )
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       ( initUs_ )
145
import Bag
Thomas Schilling's avatar
Thomas Schilling committed
146
import Exception
Simon Marlow's avatar
Simon Marlow committed
147

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

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

158

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

165
newHscEnv :: DynFlags -> IO HscEnv
166
newHscEnv dflags = do
dterei's avatar
dterei committed
167 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
    safe_var <- newIORef True
174
    return HscEnv {  hsc_dflags       = dflags,
dterei's avatar
dterei committed
175 176 177 178 179 180 181 182 183
                     hsc_targets      = [],
                     hsc_mod_graph    = [],
                     hsc_IC           = emptyInteractiveContext,
                     hsc_HPT          = emptyHomePackageTable,
                     hsc_EPS          = eps_var,
                     hsc_NC           = nc_var,
                     hsc_FC           = fc_var,
                     hsc_MLC          = mlc_var,
                     hsc_OptFuel      = optFuel,
dterei's avatar
dterei committed
184
                     hsc_type_env_var = Nothing,
dterei's avatar
dterei committed
185
                     hsc_safeInf      = safe_var }
Thomas Schilling's avatar
Thomas Schilling committed
186

187

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

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

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

instance Monad Hsc where
dterei's avatar
dterei committed
202 203 204 205
    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
206 207

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

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

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

getWarnings :: Hsc WarningMessages
dterei's avatar
dterei committed
220
getWarnings = Hsc $ \_ w -> return (w, w)
221 222

clearWarnings :: Hsc ()
dterei's avatar
dterei committed
223
clearWarnings = Hsc $ \_ _ -> return ((), emptyBag)
224 225

logWarnings :: WarningMessages -> Hsc ()
dterei's avatar
dterei committed
226
logWarnings w = Hsc $ \_ w0 -> return ((), w0 `unionBags` w)
227 228

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

231 232
instance HasDynFlags Hsc where
    getDynFlags = Hsc $ \e w -> return (hsc_dflags e, w)
233 234 235

handleWarnings :: Hsc ()
handleWarnings = do
dterei's avatar
dterei committed
236 237 238 239
    dflags <- getDynFlags
    w <- getWarnings
    liftIO $ printOrThrowWarnings dflags w
    clearWarnings
240 241 242 243 244

-- | 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
245 246
    logWarnings warns
    when (not $ isEmptyBag errs) $ throwErrors errs
247 248 249 250

-- | Throw some errors.
throwErrors :: ErrorMessages -> Hsc a
throwErrors = liftIO . throwIO . mkSrcErr
251 252 253 254 255

-- | 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
256
-- and signal success via by wrapping the result in a 'Maybe' type. This
257 258 259 260 261 262 263 264 265
-- 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
266
--     there should be warnings in the first result. That is, if the action
267 268 269
--     failed, it must have been due to the warnings (i.e., @-Werror@).
ioMsgMaybe :: IO (Messages, Maybe a) -> Hsc a
ioMsgMaybe ioA = do
270
    ((warns,errs), mb_r) <- liftIO ioA
dterei's avatar
dterei committed
271 272 273 274
    logWarnings warns
    case mb_r of
        Nothing -> throwErrors errs
        Just r  -> ASSERT( isEmptyBag errs ) return r
275 276 277 278 279

-- | 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
280 281 282
    ((warns,_errs), mb_r) <- liftIO $ ioA
    logWarnings warns
    return mb_r
283 284 285 286 287 288

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

#ifdef GHCI
hscTcRnLookupRdrName :: HscEnv -> RdrName -> IO [Name]
dterei's avatar
dterei committed
289
hscTcRnLookupRdrName hsc_env rdr_name =
dterei's avatar
dterei committed
290
    runHsc hsc_env $ ioMsgMaybe $ tcRnLookupRdrName hsc_env rdr_name
291 292 293
#endif

hscTcRcLookupName :: HscEnv -> Name -> IO (Maybe TyThing)
dterei's avatar
dterei committed
294
hscTcRcLookupName hsc_env name =
dterei's avatar
dterei committed
295 296 297 298
    runHsc hsc_env $ ioMsgMaybe' $ tcRnLookupName hsc_env name
      -- 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.
299

300
hscTcRnGetInfo :: HscEnv -> Name -> IO (Maybe (TyThing, Fixity, [ClsInst]))
301
hscTcRnGetInfo hsc_env name =
dterei's avatar
dterei committed
302
    runHsc hsc_env $ ioMsgMaybe' $ tcRnGetInfo hsc_env name
303 304

#ifdef GHCI
305
hscGetModuleInterface :: HscEnv -> Module -> IO ModIface
306
hscGetModuleInterface hsc_env mod =
dterei's avatar
dterei committed
307
    runHsc hsc_env $ ioMsgMaybe $ getModuleInterface hsc_env mod
308 309 310

-- -----------------------------------------------------------------------------
-- | Rename some import declarations
311
hscRnImportDecls :: HscEnv -> [LImportDecl RdrName] -> IO GlobalRdrEnv
dterei's avatar
dterei committed
312 313
hscRnImportDecls hsc_env import_decls =
    runHsc hsc_env $ ioMsgMaybe $ tcRnImportDecls hsc_env import_decls
314 315
#endif

316
-- -----------------------------------------------------------------------------
Simon Marlow's avatar
Simon Marlow committed
317
-- | parse a file, returning the abstract syntax
318

319
hscParse :: HscEnv -> ModSummary -> IO HsParsedModule
320 321 322
hscParse hsc_env mod_summary = runHsc hsc_env $ hscParse' mod_summary

-- internal version, that doesn't fail due to -Werror
323
hscParse' :: ModSummary -> Hsc HsParsedModule
324
hscParse' mod_summary = do
dterei's avatar
dterei committed
325 326 327
    dflags <- getDynFlags
    let src_filename  = ms_hspp_file mod_summary
        maybe_src_buf = ms_hspp_buf  mod_summary
328

dterei's avatar
dterei committed
329 330 331
    --------------------------  Parser  ----------------
    liftIO $ showPass dflags "Parser"
    {-# SCC "Parser" #-} do
332 333 334 335

    -- 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
336 337 338
    buf <- case maybe_src_buf of
               Just b  -> return b
               Nothing -> liftIO $ hGetStringBuffer src_filename
339

dterei's avatar
dterei committed
340
    let loc = mkRealSrcLoc (mkFastString src_filename) 1 1
341

dterei's avatar
dterei committed
342 343 344
    case unP parseModule (mkPState dflags buf loc) of
        PFailed span err ->
            liftIO $ throwOneError (mkPlainErrMsg span err)
345

dterei's avatar
dterei committed
346 347 348 349 350 351
        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
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373

            -- 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

374 375 376 377 378
            -- sometimes we see source files from earlier
            -- preprocessing stages that cannot be found, so just
            -- filter them out:
            srcs2 <- liftIO $ filterM doesFileExist srcs1

379 380
            return HsParsedModule {
                      hpm_module    = rdr_module,
381
                      hpm_src_files = srcs2
382
                   }
Simon Marlow's avatar
Simon Marlow committed
383

Thomas Schilling's avatar
Thomas Schilling committed
384 385 386
-- 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
387
type RenamedStuff =
Simon Marlow's avatar
Simon Marlow committed
388
        (Maybe (HsGroup Name, [LImportDecl Name], Maybe [LIE Name],
389
                Maybe LHsDocString))
Simon Marlow's avatar
Simon Marlow committed
390

Thomas Schilling's avatar
Thomas Schilling committed
391
-- | Rename and typecheck a module, additionally returning the renamed syntax
392
hscTypecheckRename :: HscEnv -> ModSummary -> HsParsedModule
393
                   -> IO (TcGblEnv, RenamedStuff)
dterei's avatar
dterei committed
394
hscTypecheckRename hsc_env mod_summary rdr_module = runHsc hsc_env $ do
395
    tc_result <- {-# SCC "Typecheck-Rename" #-}
dterei's avatar
dterei committed
396
                 ioMsgMaybe $
dterei's avatar
dterei committed
397 398
                     tcRnModule hsc_env (ms_hsc_src mod_summary)
                                True rdr_module
Thomas Schilling's avatar
Thomas Schilling committed
399

400 401 402 403 404 405
        -- 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
406

407
    return (tc_result, rn_info)
Simon Marlow's avatar
Simon Marlow committed
408 409

-- | Convert a typechecked module to Core
410
hscDesugar :: HscEnv -> ModSummary -> TcGblEnv -> IO ModGuts
411
hscDesugar hsc_env mod_summary tc_result =
Ian Lynagh's avatar
Ian Lynagh committed
412
    runHsc hsc_env $ hscDesugar' (ms_location mod_summary) tc_result
413

Ian Lynagh's avatar
Ian Lynagh committed
414 415
hscDesugar' :: ModLocation -> TcGblEnv -> Hsc ModGuts
hscDesugar' mod_location tc_result = do
dterei's avatar
dterei committed
416
    hsc_env <- getHscEnv
Simon Marlow's avatar
Simon Marlow committed
417 418
    r <- ioMsgMaybe $
      {-# SCC "deSugar" #-}
Ian Lynagh's avatar
Ian Lynagh committed
419
      deSugar hsc_env mod_location tc_result
420

dterei's avatar
dterei committed
421 422 423 424
    -- 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
425

dterei's avatar
dterei committed
426
-- | Make a 'ModIface' from the results of typechecking. Used when
Simon Marlow's avatar
Simon Marlow committed
427 428 429 430
-- 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.
431
makeSimpleIface :: HscEnv -> Maybe ModIface -> TcGblEnv -> ModDetails
432
                -> IO (ModIface,Bool)
433
makeSimpleIface hsc_env maybe_old_iface tc_result details =
dterei's avatar
dterei committed
434
    runHsc hsc_env $ ioMsgMaybe $
dterei's avatar
dterei committed
435
        mkIfaceTc hsc_env (fmap mi_iface_hash maybe_old_iface) details tc_result
Simon Marlow's avatar
Simon Marlow committed
436

dterei's avatar
dterei committed
437
-- | Make a 'ModDetails' from the results of typechecking. Used when
Simon Marlow's avatar
Simon Marlow committed
438
-- typechecking only, as opposed to full compilation.
439 440
makeSimpleDetails :: HscEnv -> TcGblEnv -> IO ModDetails
makeSimpleDetails hsc_env tc_result = mkBootModDetailsTc hsc_env tc_result
Simon Marlow's avatar
Simon Marlow committed
441

442

dterei's avatar
dterei committed
443 444 445 446 447 448 449
{- **********************************************************************
%*                                                                      *
                The main compiler pipeline
%*                                                                      *
%********************************************************************* -}

{-
450 451 452 453
                   --------------------------------
                        The compilation proper
                   --------------------------------

dterei's avatar
dterei committed
454 455 456 457 458 459
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
460
targets byte-code.
dterei's avatar
dterei committed
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486

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
487
data HscStatus' a
488
    = HscNoRecomp
Thomas Schilling's avatar
Thomas Schilling committed
489
    | HscRecomp
dterei's avatar
dterei committed
490 491 492 493 494
          (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
495

dterei's avatar
dterei committed
496
-- This is a bit ugly. Since we use a typeclass below and would like to avoid
Thomas Schilling's avatar
Thomas Schilling committed
497
-- functional dependencies, we have to parameterise the typeclass over the
dterei's avatar
dterei committed
498 499
-- 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.
500
type HscStatus         = HscStatus' ()
501 502
type InteractiveStatus = HscStatus' (Maybe (CompiledByteCode, ModBreaks))
    -- INVARIANT: result is @Nothing@ <=> input was a boot file
Thomas Schilling's avatar
Thomas Schilling committed
503

504 505 506
type OneShotResult     = HscStatus
type BatchResult       = (HscStatus, ModIface, ModDetails)
type NothingResult     = (HscStatus, ModIface, ModDetails)
Thomas Schilling's avatar
Thomas Schilling committed
507
type InteractiveResult = (InteractiveStatus, ModIface, ModDetails)
508

509 510
-- ToDo: The old interface and module index are only using in 'batch' and
--       'interactive' mode. They should be removed from 'oneshot' mode.
511
type Compiler result =  HscEnv
512
                     -> ModSummary
513
                     -> SourceModified
514 515
                     -> Maybe ModIface  -- Old interface, if available
                     -> Maybe (Int,Int) -- Just (i,n) <=> module i of n (for msgs)
516
                     -> IO result
517

dterei's avatar
dterei committed
518
data HsCompiler a = HsCompiler {
519
    -- | Called when no recompilation is necessary.
520 521
    hscNoRecomp :: ModIface
                -> Hsc a,
522 523

    -- | Called to recompile the module.
524 525
    hscRecompile :: ModSummary -> Maybe Fingerprint
                 -> Hsc a,
526

527 528
    hscBackend :: TcGblEnv -> ModSummary -> Maybe Fingerprint
               -> Hsc a,
529

530
    -- | Code generation for Boot modules.
531 532
    hscGenBootOutput :: TcGblEnv -> ModSummary -> Maybe Fingerprint
                     -> Hsc a,
533 534

    -- | Code generation for normal modules.
535 536
    hscGenOutput :: ModGuts  -> ModSummary -> Maybe Fingerprint
                 -> Hsc a
537 538
  }

539
genericHscCompile :: HsCompiler a
540 541
                  -> (HscEnv -> Maybe (Int,Int) -> RecompReason -> ModSummary -> IO ())
                  -> HscEnv -> ModSummary -> SourceModified
Thomas Schilling's avatar
Thomas Schilling committed
542
                  -> Maybe ModIface -> Maybe (Int, Int)
543 544
                  -> IO a
genericHscCompile compiler hscMessage hsc_env
545
                  mod_summary source_modified
546
                  mb_old_iface0 mb_mod_index
dterei's avatar
dterei committed
547 548 549
  = do
    (recomp_reqd, mb_checked_iface)
        <- {-# SCC "checkOldIface" #-}
dterei's avatar
dterei committed
550
           checkOldIface hsc_env mod_summary
dterei's avatar
dterei committed
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
                         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
            hscMessage hsc_env mb_mod_index RecompNotRequired mod_summary
            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
568 569 570

        -- 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
571
        -- and we must ignore it. However, if the module is stable
572
        -- (none of the modules it depends on, directly or indirectly,
dterei's avatar
dterei committed
573
        -- changed), then we *can* skip recompilation. This is why
574 575 576
        -- 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
577
        -- changed. Stability is just the same check that make is
578 579
        -- doing for us in one-shot mode.

dterei's avatar
dterei committed
580 581 582 583 584 585 586
    case mb_checked_iface of
        Just iface | not recomp_reqd ->
            if mi_used_th iface && not stable
                then compile RecompForcedByTH
                else skip iface
        _otherwise ->
            compile RecompRequired
Thomas Schilling's avatar
Thomas Schilling committed
587

588
hscCheckRecompBackend :: HsCompiler a -> TcGblEnv -> Compiler a
dterei's avatar
dterei committed
589 590
hscCheckRecompBackend compiler tc_result hsc_env mod_summary
                      source_modified mb_old_iface _m_of_n
591
  = do
dterei's avatar
dterei committed
592 593 594 595 596 597 598 599
    (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
        Just iface | not recomp_reqd
dterei's avatar
dterei committed
600
            -> runHsc hsc_env $
dterei's avatar
dterei committed
601 602 603 604 605
                   hscNoRecomp compiler
                       iface{ mi_globals = Just (tcg_rdr_env tc_result) }
        _otherwise
            -> runHsc hsc_env $
                   hscBackend compiler tc_result mod_summary mb_old_hash
606

607
genericHscRecompile :: HsCompiler a
608
                    -> ModSummary -> Maybe Fingerprint
609
                    -> Hsc a
610
genericHscRecompile compiler mod_summary mb_old_hash
dterei's avatar
dterei committed
611 612 613 614 615
    | 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
616

617
genericHscBackend :: HsCompiler a
618
                  -> TcGblEnv -> ModSummary -> Maybe Fingerprint
619
                  -> Hsc a
620
genericHscBackend compiler tc_result mod_summary mb_old_hash
dterei's avatar
dterei committed
621 622 623
    | HsBootFile <- ms_hsc_src mod_summary =
        hscGenBootOutput compiler tc_result mod_summary mb_old_hash
    | otherwise = do
Ian Lynagh's avatar
Ian Lynagh committed
624
        guts <- hscDesugar' (ms_location mod_summary) tc_result
dterei's avatar
dterei committed
625
        hscGenOutput compiler guts mod_summary mb_old_hash
Thomas Schilling's avatar
Thomas Schilling committed
626

627 628
compilerBackend :: HsCompiler a -> TcGblEnv -> Compiler a
compilerBackend comp tcg hsc_env ms' _ _mb_old_iface _ =
dterei's avatar
dterei committed
629
    runHsc hsc_env $ hscBackend comp tcg ms' Nothing
630

631 632 633 634
--------------------------------------------------------------
-- Compilers
--------------------------------------------------------------

635
hscOneShotCompiler :: HsCompiler OneShotResult
dterei's avatar
dterei committed
636
hscOneShotCompiler = HsCompiler {
637

638
    hscNoRecomp = \_old_iface -> do
dterei's avatar
dterei committed
639 640 641
        hsc_env <- getHscEnv
        liftIO $ dumpIfaceStats hsc_env
        return HscNoRecomp
642 643 644

  , hscRecompile = genericHscRecompile hscOneShotCompiler

dterei's avatar
dterei committed
645
  , hscBackend = \tc_result mod_summary mb_old_hash -> do
dterei's avatar
dterei committed
646 647 648 649 650
        dflags <- getDynFlags
        case hscTarget dflags of
            HscNothing -> return (HscRecomp Nothing ())
            _otherw    -> genericHscBackend hscOneShotCompiler
                              tc_result mod_summary mb_old_hash
651

652
  , hscGenBootOutput = \tc_result mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
653 654 655
        (iface, changed, _) <- hscSimpleIface tc_result mb_old_iface
        hscWriteIface iface changed mod_summary
        return (HscRecomp Nothing ())
656 657

  , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
658 659 660 661 662
        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 ())
663
  }
664

Thomas Schilling's avatar
Thomas Schilling committed
665
-- Compile Haskell, boot and extCore in OneShot mode.
666
hscCompileOneShot :: Compiler OneShotResult
667 668
hscCompileOneShot hsc_env mod_summary src_changed mb_old_iface mb_i_of_n
  = do
dterei's avatar
dterei committed
669 670 671 672 673
    -- 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) }
674

dterei's avatar
dterei committed
675 676 677
    genericHscCompile hscOneShotCompiler
                      oneShotMsg hsc_env' mod_summary src_changed
                      mb_old_iface mb_i_of_n
Thomas Schilling's avatar
Thomas Schilling committed
678

679 680 681
hscOneShotBackendOnly :: TcGblEnv -> Compiler OneShotResult
hscOneShotBackendOnly = compilerBackend hscOneShotCompiler

Thomas Schilling's avatar
Thomas Schilling committed
682 683
--------------------------------------------------------------

684
hscBatchCompiler :: HsCompiler BatchResult
dterei's avatar
dterei committed
685
hscBatchCompiler = HsCompiler {
Thomas Schilling's avatar
Thomas Schilling committed
686

687
    hscNoRecomp = \iface -> do
dterei's avatar
dterei committed
688 689
        details <- genModDetails iface
        return (HscNoRecomp, iface, details)
Thomas Schilling's avatar
Thomas Schilling committed
690

691
  , hscRecompile = genericHscRecompile hscBatchCompiler
Thomas Schilling's avatar
Thomas Schilling committed
692

693 694
  , hscBackend = genericHscBackend hscBatchCompiler

695
  , hscGenBootOutput = \tc_result mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
696 697 698
        (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
699

700
  , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
701 702 703 704 705
        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)
706
  }
707

dterei's avatar
dterei committed
708
-- | Compile Haskell, boot and extCore in batch mode.
709
hscCompileBatch :: Compiler (HscStatus, ModIface, ModDetails)
710
hscCompileBatch = genericHscCompile hscBatchCompiler batchMsg
Thomas Schilling's avatar
Thomas Schilling committed
711

712 713 714
hscBatchBackendOnly :: TcGblEnv -> Compiler BatchResult
hscBatchBackendOnly = hscCheckRecompBackend hscBatchCompiler

Thomas Schilling's avatar
Thomas Schilling committed
715 716
--------------------------------------------------------------

717
hscInteractiveCompiler :: HsCompiler InteractiveResult
dterei's avatar
dterei committed
718
hscInteractiveCompiler = HsCompiler {
719
    hscNoRecomp = \iface -> do
dterei's avatar
dterei committed
720 721
        details <- genModDetails iface
        return (HscNoRecomp, iface, details)
Thomas Schilling's avatar
Thomas Schilling committed
722

723
  , hscRecompile = genericHscRecompile hscInteractiveCompiler
Thomas Schilling's avatar
Thomas Schilling committed
724

725 726 727
  , hscBackend = genericHscBackend hscInteractiveCompiler

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

731
  , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
732 733 734
        guts <- hscSimplify' guts0
        (iface, _changed, details, cgguts) <- hscNormalIface guts mb_old_iface
        hscInteractive (iface, details, cgguts) mod_summary
735
  }
736 737 738

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

741 742 743
hscInteractiveBackendOnly :: TcGblEnv -> Compiler InteractiveResult
hscInteractiveBackendOnly = compilerBackend hscInteractiveCompiler

Thomas Schilling's avatar
Thomas Schilling committed
744 745
--------------------------------------------------------------

746
hscNothingCompiler :: HsCompiler NothingResult
dterei's avatar
dterei committed
747
hscNothingCompiler = HsCompiler {
748
    hscNoRecomp = \iface -> do
dterei's avatar
dterei committed
749 750
        details <- genModDetails iface
        return (HscNoRecomp, iface, details)
Simon Marlow's avatar
Simon Marlow committed
751

752
  , hscRecompile = genericHscRecompile hscNothingCompiler
753

754
  , hscBackend = \tc_result _mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
755 756 757
        handleWarnings
        (iface, _changed, details) <- hscSimpleIface tc_result mb_old_iface
        return (HscRecomp Nothing (), iface, details)
758

759 760 761
  , hscGenBootOutput = \_ _ _ ->
        panic "hscCompileNothing: hscGenBootOutput should not be called"

762 763 764
  , hscGenOutput = \_ _ _ ->
        panic "hscCompileNothing: hscGenOutput should not be called"
  }
765

766
-- Type-check Haskell and .hs-boot only (no external core)
767
hscCompileNothing :: Compiler (HscStatus, ModIface, ModDetails)
768
hscCompileNothing = genericHscCompile hscNothingCompiler batchMsg
769

770 771 772
hscNothingBackendOnly :: TcGblEnv -> Compiler NothingResult
hscNothingBackendOnly = compilerBackend hscNothingCompiler

773 774 775 776
--------------------------------------------------------------
-- NoRecomp handlers
--------------------------------------------------------------

777 778 779
genModDetails :: ModIface -> Hsc ModDetails
genModDetails old_iface
  = do
dterei's avatar
dterei committed
780 781 782 783 784
    hsc_env <- getHscEnv
    new_details <- {-# SCC "tcRnIface" #-}
                   liftIO $ initIfaceCheck hsc_env (typecheckIface old_iface)
    liftIO $ dumpIfaceStats hsc_env
    return new_details
785

786 787 788 789
--------------------------------------------------------------
-- Progress displayers.
--------------------------------------------------------------

790
data RecompReason = RecompNotRequired | RecompRequired | RecompForcedByTH
dterei's avatar
dterei committed
791
    deriving Eq
792

793 794
oneShotMsg :: HscEnv -> Maybe (Int,Int) -> RecompReason -> ModSummary -> IO ()
oneShotMsg hsc_env _mb_mod_index recomp _mod_summary =
dterei's avatar
dterei committed
795 796
    case recomp of
        RecompNotRequired ->
797 798
            compilationProgressMsg (hsc_dflags hsc_env) $
                   "compilation IS NOT required"
dterei's avatar
dterei committed
799
        _other ->
800 801 802
            return ()

batchMsg :: HscEnv -> Maybe (Int,Int) -> RecompReason -> ModSummary -> IO ()
dterei's avatar
dterei committed
803 804 805 806 807 808 809 810 811 812 813 814 815
batchMsg hsc_env mb_mod_index recomp mod_summary =
    case recomp of
        RecompRequired -> showMsg "Compiling "
        RecompNotRequired
            | verbosity (hsc_dflags hsc_env) >= 2 -> showMsg "Skipping  "
            | otherwise -> return ()
        RecompForcedByTH -> showMsg "Compiling [TH] "
    where
        showMsg msg =
            compilationProgressMsg (hsc_dflags hsc_env) $
            (showModuleIndex mb_mod_index ++
            msg ++ showModMsg (hscTarget (hsc_dflags hsc_env))
                              (recomp == RecompRequired) mod_summary)
816

817 818 819
--------------------------------------------------------------
-- FrontEnds
--------------------------------------------------------------
820 821

hscFileFrontEnd :: ModSummary -> Hsc TcGblEnv
822
hscFileFrontEnd mod_summary = do
823
    hpm <- hscParse' mod_summary
824
    hsc_env <- getHscEnv
825
    dflags  <- getDynFlags
dterei's avatar
dterei committed
826 827 828
    tcg_env <-
        {-# SCC "Typecheck-Rename" #-}
        ioMsgMaybe $
829
            tcRnModule hsc_env (ms_hsc_src mod_summary) False hpm
830
    tcSafeOK <- liftIO $ readIORef (tcg_safeInfer tcg_env)
831 832

    -- end of the Safe Haskell line, how to respond to user?
833
    if not (safeHaskellOn dflags) || (safeInferOn dflags && not tcSafeOK)
834 835 836 837 838 839 840 841 842 843 844 845 846 847

        -- if safe haskell off or safe infer failed, wipe trust
        then wipeTrust tcg_env emptyBag

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

--------------------------------------------------------------
851
-- Safe Haskell
852 853
--------------------------------------------------------------

854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
-- Note [Safe Haskell Trust Check]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- Safe Haskell checks that an import is trusted according to the following
-- rules for an import of module M that resides in Package P:
--
--   * If M is recorded as Safe and all its trust dependencies are OK
--     then M is considered safe.
--   * If M is recorded as Trustworthy and P is considered trusted and
--     all M's trust dependencies are OK then M is considered safe.
--
-- By trust dependencies we mean that the check is transitive. So if
-- a module M that is Safe relies on a module N that is trustworthy,
-- importing module M will first check (according to the second case)
-- that N is trusted before checking M is trusted.
--
-- This is a minimal description, so please refer to the user guide
-- for more details. The user guide is also considered the authoritative
-- source in this matter, not the comments or code.


874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893
-- Note [Safe Haskell Inference]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- Safe Haskell does Safe inference on modules that don't have any specific
-- safe haskell mode flag. The basic aproach to this is:
--   * When deciding if we need to do a Safe language check, treat
--     an unmarked module as having -XSafe mode specified.
--   * For checks, don't throw errors but return them to the caller.
--   * Caller checks if there are errors:
--     * For modules explicitly marked -XSafe, we throw the errors.
--     * For unmarked modules (inference mode), we drop the errors
--       and mark the module as being Unsafe.


-- | Check that the safe imports of the module being compiled are valid.
-- If not we either issue a compilation error if the module is explicitly
-- using Safe Haskell, or mark the module as unsafe if we're in safe
-- inference mode.
hscCheckSafeImports :: TcGblEnv -> Hsc TcGblEnv
hscCheckSafeImports tcg_env = do
    dflags   <- getDynFlags