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

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

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

157

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

164
newHscEnv :: DynFlags -> IO HscEnv
165
newHscEnv dflags = do
dterei's avatar
dterei committed
166 167 168 169 170 171 172
    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
173
    return HscEnv {  hsc_dflags       = dflags,
dterei's avatar
dterei committed
174 175 176 177 178 179 180 181 182
                     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
183
                     hsc_type_env_var = Nothing,
dterei's avatar
dterei committed
184
                     hsc_safeInf      = safe_var }
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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

441

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

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

dterei's avatar
dterei committed
453 454 455 456 457 458
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
459
targets byte-code.
dterei's avatar
dterei committed
460 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

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

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

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

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

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

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

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

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

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

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

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

dterei's avatar
dterei committed
579 580 581 582 583 584 585
    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
586

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

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

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

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

630 631 632 633
--------------------------------------------------------------
-- Compilers
--------------------------------------------------------------

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

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

  , hscRecompile = genericHscRecompile hscOneShotCompiler

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

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

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

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

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

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

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

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

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

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

692 693
  , hscBackend = genericHscBackend hscBatchCompiler

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

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

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

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

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

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

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

724 725 726
  , hscBackend = genericHscBackend hscInteractiveCompiler

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

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

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

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

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

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

751
  , hscRecompile = genericHscRecompile hscNothingCompiler
752

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

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

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

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

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

772 773 774 775
--------------------------------------------------------------
-- NoRecomp handlers
--------------------------------------------------------------

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

785 786 787 788
--------------------------------------------------------------
-- Progress displayers.
--------------------------------------------------------------

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

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

batchMsg :: HscEnv -> Maybe (Int,Int) -> RecompReason -> ModSummary -> IO ()
dterei's avatar
dterei committed
802 803 804 805 806 807 808 809 810 811 812 813 814
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)
815

816 817 818
--------------------------------------------------------------
-- FrontEnds
--------------------------------------------------------------
819 820

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

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

        -- 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
    errSafe t = text "Warning:" <+> 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
894
    tcg_env' <- checkSafeImports dflags tcg_env
895 896