HscMain.hs 62.9 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 63
    , hscSimplify -- ToDo, shouldn't really export this

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

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

74
#ifdef GHCI
75
import ByteCodeGen      ( byteCodeGen, coreExprToBCOs )
76
import Linker
77 78
import CoreTidy         ( tidyExpr )
import Type             ( Type )
79
import PrelNames
80 81 82
import {- Kind parts of -} Type         ( Kind )
import CoreLint         ( lintUnfolding )
import DsMeta           ( templateHaskellNames )
83
import VarSet
84
import VarEnv           ( emptyTidyEnv )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
85
import Panic
86
import Data.List
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 98 99
import Lexer hiding (getDynFlags)
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 Control.Monad
149
import Data.Maybe
Simon Marlow's avatar
Simon Marlow committed
150
import Data.IORef
dterei's avatar
dterei committed
151

Thomas Schilling's avatar
Thomas Schilling committed
152
#include "HsVersions.h"
153

154

dterei's avatar
dterei committed
155 156 157 158 159
{- **********************************************************************
%*                                                                      *
                Initialisation
%*                                                                      *
%********************************************************************* -}
160

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

183

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

192
-- -----------------------------------------------------------------------------
193
-- The Hsc monad: Passing an enviornment and warning state
194

dterei's avatar
dterei committed
195
newtype Hsc a = Hsc (HscEnv -> WarningMessages -> IO (a, WarningMessages))
196 197

instance Monad Hsc where
dterei's avatar
dterei committed
198 199 200 201
    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
202 203

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

runHsc :: HscEnv -> Hsc a -> IO a
runHsc hsc_env (Hsc hsc) = do
dterei's avatar
dterei committed
208 209 210
    (a, w) <- hsc hsc_env emptyBag
    printOrThrowWarnings (hsc_dflags hsc_env) w
    return a
211 212

getWarnings :: Hsc WarningMessages
dterei's avatar
dterei committed
213
getWarnings = Hsc $ \_ w -> return (w, w)
214 215

clearWarnings :: Hsc ()
dterei's avatar
dterei committed
216
clearWarnings = Hsc $ \_ _ -> return ((), emptyBag)
217 218

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

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

getDynFlags :: Hsc DynFlags
dterei's avatar
dterei committed
225
getDynFlags = Hsc $ \e w -> return (hsc_dflags e, w)
226 227 228

handleWarnings :: Hsc ()
handleWarnings = do
dterei's avatar
dterei committed
229 230 231 232
    dflags <- getDynFlags
    w <- getWarnings
    liftIO $ printOrThrowWarnings dflags w
    clearWarnings
233 234 235 236 237

-- | 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
238 239
    logWarnings warns
    when (not $ isEmptyBag errs) $ throwErrors errs
240 241 242 243

-- | Throw some errors.
throwErrors :: ErrorMessages -> Hsc a
throwErrors = liftIO . throwIO . mkSrcErr
244 245 246 247 248

-- | 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
249
-- and signal success via by wrapping the result in a 'Maybe' type. This
250 251 252 253 254 255 256 257 258
-- 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
259
--     there should be warnings in the first result. That is, if the action
260 261 262
--     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
263 264 265 266 267
    ((warns,errs), mb_r) <- liftIO $ ioA
    logWarnings warns
    case mb_r of
        Nothing -> throwErrors errs
        Just r  -> ASSERT( isEmptyBag errs ) return r
268 269 270 271 272

-- | 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
273 274 275
    ((warns,_errs), mb_r) <- liftIO $ ioA
    logWarnings warns
    return mb_r
276 277 278 279 280 281

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

#ifdef GHCI
hscTcRnLookupRdrName :: HscEnv -> RdrName -> IO [Name]
dterei's avatar
dterei committed
282
hscTcRnLookupRdrName hsc_env rdr_name =
dterei's avatar
dterei committed
283
    runHsc hsc_env $ ioMsgMaybe $ tcRnLookupRdrName hsc_env rdr_name
284 285 286
#endif

hscTcRcLookupName :: HscEnv -> Name -> IO (Maybe TyThing)
dterei's avatar
dterei committed
287
hscTcRcLookupName hsc_env name =
dterei's avatar
dterei committed
288 289 290 291
    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.
292 293 294

hscTcRnGetInfo :: HscEnv -> Name -> IO (Maybe (TyThing, Fixity, [Instance]))
hscTcRnGetInfo hsc_env name =
dterei's avatar
dterei committed
295
    runHsc hsc_env $ ioMsgMaybe' $ tcRnGetInfo hsc_env name
296 297

#ifdef GHCI
298
hscGetModuleInterface :: HscEnv -> Module -> IO ModIface
299
hscGetModuleInterface hsc_env mod =
dterei's avatar
dterei committed
300
    runHsc hsc_env $ ioMsgMaybe $ getModuleInterface hsc_env mod
301 302 303

-- -----------------------------------------------------------------------------
-- | Rename some import declarations
304
hscRnImportDecls :: HscEnv -> [LImportDecl RdrName] -> IO GlobalRdrEnv
dterei's avatar
dterei committed
305 306
hscRnImportDecls hsc_env import_decls =
    runHsc hsc_env $ ioMsgMaybe $ tcRnImportDecls hsc_env import_decls
307 308
#endif

309
-- -----------------------------------------------------------------------------
Simon Marlow's avatar
Simon Marlow committed
310
-- | parse a file, returning the abstract syntax
311 312 313 314 315 316

hscParse :: HscEnv -> ModSummary -> IO (Located (HsModule RdrName))
hscParse hsc_env mod_summary = runHsc hsc_env $ hscParse' mod_summary

-- internal version, that doesn't fail due to -Werror
hscParse' :: ModSummary -> Hsc (Located (HsModule RdrName))
317
hscParse' mod_summary = do
dterei's avatar
dterei committed
318 319 320
    dflags <- getDynFlags
    let src_filename  = ms_hspp_file mod_summary
        maybe_src_buf = ms_hspp_buf  mod_summary
321

dterei's avatar
dterei committed
322 323 324
    --------------------------  Parser  ----------------
    liftIO $ showPass dflags "Parser"
    {-# SCC "Parser" #-} do
325 326 327 328

    -- 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
329 330 331
    buf <- case maybe_src_buf of
               Just b  -> return b
               Nothing -> liftIO $ hGetStringBuffer src_filename
332

dterei's avatar
dterei committed
333
    let loc = mkRealSrcLoc (mkFastString src_filename) 1 1
334

dterei's avatar
dterei committed
335 336 337
    case unP parseModule (mkPState dflags buf loc) of
        PFailed span err ->
            liftIO $ throwOneError (mkPlainErrMsg span err)
338

dterei's avatar
dterei committed
339 340 341 342 343 344 345 346
        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
            return rdr_module
                -- ToDo: free the string buffer later.
Simon Marlow's avatar
Simon Marlow committed
347

Thomas Schilling's avatar
Thomas Schilling committed
348 349 350
-- 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
351
type RenamedStuff =
Simon Marlow's avatar
Simon Marlow committed
352
        (Maybe (HsGroup Name, [LImportDecl Name], Maybe [LIE Name],
353
                Maybe LHsDocString))
Simon Marlow's avatar
Simon Marlow committed
354

Thomas Schilling's avatar
Thomas Schilling committed
355
-- | Rename and typecheck a module, additionally returning the renamed syntax
356 357
hscTypecheckRename :: HscEnv -> ModSummary -> Located (HsModule RdrName)
                   -> IO (TcGblEnv, RenamedStuff)
dterei's avatar
dterei committed
358
hscTypecheckRename hsc_env mod_summary rdr_module = runHsc hsc_env $ do
359
    tc_result <- {-# SCC "Typecheck-Rename" #-}
dterei's avatar
dterei committed
360
                 ioMsgMaybe $
dterei's avatar
dterei committed
361 362
                     tcRnModule hsc_env (ms_hsc_src mod_summary)
                                True rdr_module
Thomas Schilling's avatar
Thomas Schilling committed
363

364 365 366 367 368 369
        -- 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
370

371
    return (tc_result, rn_info)
Simon Marlow's avatar
Simon Marlow committed
372 373

-- | Convert a typechecked module to Core
374
hscDesugar :: HscEnv -> ModSummary -> TcGblEnv -> IO ModGuts
375
hscDesugar hsc_env mod_summary tc_result =
dterei's avatar
dterei committed
376
    runHsc hsc_env $ hscDesugar' mod_summary tc_result
377 378

hscDesugar' :: ModSummary -> TcGblEnv -> Hsc ModGuts
379
hscDesugar' mod_summary tc_result = do
dterei's avatar
dterei committed
380
    hsc_env <- getHscEnv
Simon Marlow's avatar
Simon Marlow committed
381 382 383
    r <- ioMsgMaybe $
      {-# SCC "deSugar" #-}
      deSugar hsc_env (ms_location mod_summary) tc_result
384

dterei's avatar
dterei committed
385 386 387 388
    -- 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
389

dterei's avatar
dterei committed
390
-- | Make a 'ModIface' from the results of typechecking. Used when
Simon Marlow's avatar
Simon Marlow committed
391 392 393 394
-- 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.
395
makeSimpleIface :: HscEnv -> Maybe ModIface -> TcGblEnv -> ModDetails
396
                -> IO (ModIface,Bool)
397
makeSimpleIface hsc_env maybe_old_iface tc_result details =
dterei's avatar
dterei committed
398
    runHsc hsc_env $ ioMsgMaybe $
dterei's avatar
dterei committed
399
        mkIfaceTc hsc_env (fmap mi_iface_hash maybe_old_iface) details tc_result
Simon Marlow's avatar
Simon Marlow committed
400

dterei's avatar
dterei committed
401
-- | Make a 'ModDetails' from the results of typechecking. Used when
Simon Marlow's avatar
Simon Marlow committed
402
-- typechecking only, as opposed to full compilation.
403 404
makeSimpleDetails :: HscEnv -> TcGblEnv -> IO ModDetails
makeSimpleDetails hsc_env tc_result = mkBootModDetailsTc hsc_env tc_result
Simon Marlow's avatar
Simon Marlow committed
405

406

dterei's avatar
dterei committed
407 408 409 410 411 412 413
{- **********************************************************************
%*                                                                      *
                The main compiler pipeline
%*                                                                      *
%********************************************************************* -}

{-
414 415 416 417
                   --------------------------------
                        The compilation proper
                   --------------------------------

dterei's avatar
dterei committed
418 419 420 421 422 423
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
424
targets byte-code.
dterei's avatar
dterei committed
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450

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
451
data HscStatus' a
452
    = HscNoRecomp
Thomas Schilling's avatar
Thomas Schilling committed
453
    | HscRecomp
dterei's avatar
dterei committed
454 455 456 457 458
          (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
459

dterei's avatar
dterei committed
460
-- This is a bit ugly. Since we use a typeclass below and would like to avoid
Thomas Schilling's avatar
Thomas Schilling committed
461
-- functional dependencies, we have to parameterise the typeclass over the
dterei's avatar
dterei committed
462 463
-- 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.
464
type HscStatus         = HscStatus' ()
465 466
type InteractiveStatus = HscStatus' (Maybe (CompiledByteCode, ModBreaks))
    -- INVARIANT: result is @Nothing@ <=> input was a boot file
Thomas Schilling's avatar
Thomas Schilling committed
467

468 469 470
type OneShotResult     = HscStatus
type BatchResult       = (HscStatus, ModIface, ModDetails)
type NothingResult     = (HscStatus, ModIface, ModDetails)
Thomas Schilling's avatar
Thomas Schilling committed
471
type InteractiveResult = (InteractiveStatus, ModIface, ModDetails)
472

473 474
-- ToDo: The old interface and module index are only using in 'batch' and
--       'interactive' mode. They should be removed from 'oneshot' mode.
475
type Compiler result =  HscEnv
476
                     -> ModSummary
477
                     -> SourceModified
478 479
                     -> Maybe ModIface  -- Old interface, if available
                     -> Maybe (Int,Int) -- Just (i,n) <=> module i of n (for msgs)
480
                     -> IO result
481

dterei's avatar
dterei committed
482
data HsCompiler a = HsCompiler {
483
    -- | Called when no recompilation is necessary.
484 485
    hscNoRecomp :: ModIface
                -> Hsc a,
486 487

    -- | Called to recompile the module.
488 489
    hscRecompile :: ModSummary -> Maybe Fingerprint
                 -> Hsc a,
490

491 492
    hscBackend :: TcGblEnv -> ModSummary -> Maybe Fingerprint
               -> Hsc a,
493

494
    -- | Code generation for Boot modules.
495 496
    hscGenBootOutput :: TcGblEnv -> ModSummary -> Maybe Fingerprint
                     -> Hsc a,
497 498

    -- | Code generation for normal modules.
499 500
    hscGenOutput :: ModGuts  -> ModSummary -> Maybe Fingerprint
                 -> Hsc a
501 502
  }

503
genericHscCompile :: HsCompiler a
504 505
                  -> (HscEnv -> Maybe (Int,Int) -> RecompReason -> ModSummary -> IO ())
                  -> HscEnv -> ModSummary -> SourceModified
Thomas Schilling's avatar
Thomas Schilling committed
506
                  -> Maybe ModIface -> Maybe (Int, Int)
507 508
                  -> IO a
genericHscCompile compiler hscMessage hsc_env
509
                  mod_summary source_modified
510
                  mb_old_iface0 mb_mod_index
dterei's avatar
dterei committed
511 512 513
  = do
    (recomp_reqd, mb_checked_iface)
        <- {-# SCC "checkOldIface" #-}
dterei's avatar
dterei committed
514
           checkOldIface hsc_env mod_summary
dterei's avatar
dterei committed
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
                         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
532 533 534

        -- 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
535
        -- and we must ignore it. However, if the module is stable
536
        -- (none of the modules it depends on, directly or indirectly,
dterei's avatar
dterei committed
537
        -- changed), then we *can* skip recompilation. This is why
538 539 540
        -- 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
541
        -- changed. Stability is just the same check that make is
542 543
        -- doing for us in one-shot mode.

dterei's avatar
dterei committed
544 545 546 547 548 549 550
    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
551

552
hscCheckRecompBackend :: HsCompiler a -> TcGblEnv -> Compiler a
dterei's avatar
dterei committed
553 554
hscCheckRecompBackend compiler tc_result hsc_env mod_summary
                      source_modified mb_old_iface _m_of_n
555
  = do
dterei's avatar
dterei committed
556 557 558 559 560 561 562 563
    (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
564
            -> runHsc hsc_env $
dterei's avatar
dterei committed
565 566 567 568 569
                   hscNoRecomp compiler
                       iface{ mi_globals = Just (tcg_rdr_env tc_result) }
        _otherwise
            -> runHsc hsc_env $
                   hscBackend compiler tc_result mod_summary mb_old_hash
570

571
genericHscRecompile :: HsCompiler a
572
                    -> ModSummary -> Maybe Fingerprint
573
                    -> Hsc a
574
genericHscRecompile compiler mod_summary mb_old_hash
dterei's avatar
dterei committed
575 576 577 578 579
    | 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
580

581
genericHscBackend :: HsCompiler a
582
                  -> TcGblEnv -> ModSummary -> Maybe Fingerprint
583
                  -> Hsc a
584
genericHscBackend compiler tc_result mod_summary mb_old_hash
dterei's avatar
dterei committed
585 586 587 588 589
    | HsBootFile <- ms_hsc_src mod_summary =
        hscGenBootOutput compiler tc_result mod_summary mb_old_hash
    | otherwise = do
        guts <- hscDesugar' mod_summary tc_result
        hscGenOutput compiler guts mod_summary mb_old_hash
Thomas Schilling's avatar
Thomas Schilling committed
590

591 592
compilerBackend :: HsCompiler a -> TcGblEnv -> Compiler a
compilerBackend comp tcg hsc_env ms' _ _mb_old_iface _ =
dterei's avatar
dterei committed
593
    runHsc hsc_env $ hscBackend comp tcg ms' Nothing
594

595 596 597 598
--------------------------------------------------------------
-- Compilers
--------------------------------------------------------------

599
hscOneShotCompiler :: HsCompiler OneShotResult
dterei's avatar
dterei committed
600
hscOneShotCompiler = HsCompiler {
601

602
    hscNoRecomp = \_old_iface -> do
dterei's avatar
dterei committed
603 604 605
        hsc_env <- getHscEnv
        liftIO $ dumpIfaceStats hsc_env
        return HscNoRecomp
606 607 608

  , hscRecompile = genericHscRecompile hscOneShotCompiler

dterei's avatar
dterei committed
609
  , hscBackend = \tc_result mod_summary mb_old_hash -> do
dterei's avatar
dterei committed
610 611 612 613 614
        dflags <- getDynFlags
        case hscTarget dflags of
            HscNothing -> return (HscRecomp Nothing ())
            _otherw    -> genericHscBackend hscOneShotCompiler
                              tc_result mod_summary mb_old_hash
615

616
  , hscGenBootOutput = \tc_result mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
617 618 619
        (iface, changed, _) <- hscSimpleIface tc_result mb_old_iface
        hscWriteIface iface changed mod_summary
        return (HscRecomp Nothing ())
620 621

  , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
622 623 624 625 626
        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 ())
627
  }
628

Thomas Schilling's avatar
Thomas Schilling committed
629
-- Compile Haskell, boot and extCore in OneShot mode.
630
hscCompileOneShot :: Compiler OneShotResult
631 632
hscCompileOneShot hsc_env mod_summary src_changed mb_old_iface mb_i_of_n
  = do
dterei's avatar
dterei committed
633 634 635 636 637
    -- 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) }
638

dterei's avatar
dterei committed
639 640 641
    genericHscCompile hscOneShotCompiler
                      oneShotMsg hsc_env' mod_summary src_changed
                      mb_old_iface mb_i_of_n
Thomas Schilling's avatar
Thomas Schilling committed
642

643 644 645
hscOneShotBackendOnly :: TcGblEnv -> Compiler OneShotResult
hscOneShotBackendOnly = compilerBackend hscOneShotCompiler

Thomas Schilling's avatar
Thomas Schilling committed
646 647
--------------------------------------------------------------

648
hscBatchCompiler :: HsCompiler BatchResult
dterei's avatar
dterei committed
649
hscBatchCompiler = HsCompiler {
Thomas Schilling's avatar
Thomas Schilling committed
650

651
    hscNoRecomp = \iface -> do
dterei's avatar
dterei committed
652 653
        details <- genModDetails iface
        return (HscNoRecomp, iface, details)
Thomas Schilling's avatar
Thomas Schilling committed
654

655
  , hscRecompile = genericHscRecompile hscBatchCompiler
Thomas Schilling's avatar
Thomas Schilling committed
656

657 658
  , hscBackend = genericHscBackend hscBatchCompiler

659
  , hscGenBootOutput = \tc_result mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
660 661 662
        (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
663

664
  , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
665 666 667 668 669
        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)
670
  }
671

dterei's avatar
dterei committed
672
-- | Compile Haskell, boot and extCore in batch mode.
673
hscCompileBatch :: Compiler (HscStatus, ModIface, ModDetails)
674
hscCompileBatch = genericHscCompile hscBatchCompiler batchMsg
Thomas Schilling's avatar
Thomas Schilling committed
675

676 677 678
hscBatchBackendOnly :: TcGblEnv -> Compiler BatchResult
hscBatchBackendOnly = hscCheckRecompBackend hscBatchCompiler

Thomas Schilling's avatar
Thomas Schilling committed
679 680
--------------------------------------------------------------

681
hscInteractiveCompiler :: HsCompiler InteractiveResult
dterei's avatar
dterei committed
682
hscInteractiveCompiler = HsCompiler {
683
    hscNoRecomp = \iface -> do
dterei's avatar
dterei committed
684 685
        details <- genModDetails iface
        return (HscNoRecomp, iface, details)
Thomas Schilling's avatar
Thomas Schilling committed
686

687
  , hscRecompile = genericHscRecompile hscInteractiveCompiler
Thomas Schilling's avatar
Thomas Schilling committed
688

689 690 691
  , hscBackend = genericHscBackend hscInteractiveCompiler

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

695
  , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
696 697 698
        guts <- hscSimplify' guts0
        (iface, _changed, details, cgguts) <- hscNormalIface guts mb_old_iface
        hscInteractive (iface, details, cgguts) mod_summary
699
  }
700 701 702

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

705 706 707
hscInteractiveBackendOnly :: TcGblEnv -> Compiler InteractiveResult
hscInteractiveBackendOnly = compilerBackend hscInteractiveCompiler

Thomas Schilling's avatar
Thomas Schilling committed
708 709
--------------------------------------------------------------

710
hscNothingCompiler :: HsCompiler NothingResult
dterei's avatar
dterei committed
711
hscNothingCompiler = HsCompiler {
712
    hscNoRecomp = \iface -> do
dterei's avatar
dterei committed
713 714
        details <- genModDetails iface
        return (HscNoRecomp, iface, details)
Simon Marlow's avatar
Simon Marlow committed
715

716
  , hscRecompile = genericHscRecompile hscNothingCompiler
717

718
  , hscBackend = \tc_result _mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
719 720 721
        handleWarnings
        (iface, _changed, details) <- hscSimpleIface tc_result mb_old_iface
        return (HscRecomp Nothing (), iface, details)
722

723 724 725
  , hscGenBootOutput = \_ _ _ ->
        panic "hscCompileNothing: hscGenBootOutput should not be called"

726 727 728
  , hscGenOutput = \_ _ _ ->
        panic "hscCompileNothing: hscGenOutput should not be called"
  }
729

730
-- Type-check Haskell and .hs-boot only (no external core)
731
hscCompileNothing :: Compiler (HscStatus, ModIface, ModDetails)
732
hscCompileNothing = genericHscCompile hscNothingCompiler batchMsg
733

734 735 736
hscNothingBackendOnly :: TcGblEnv -> Compiler NothingResult
hscNothingBackendOnly = compilerBackend hscNothingCompiler

737 738 739 740
--------------------------------------------------------------
-- NoRecomp handlers
--------------------------------------------------------------

741 742 743
genModDetails :: ModIface -> Hsc ModDetails
genModDetails old_iface
  = do
dterei's avatar
dterei committed
744 745 746 747 748
    hsc_env <- getHscEnv
    new_details <- {-# SCC "tcRnIface" #-}
                   liftIO $ initIfaceCheck hsc_env (typecheckIface old_iface)
    liftIO $ dumpIfaceStats hsc_env
    return new_details
749

750 751 752 753
--------------------------------------------------------------
-- Progress displayers.
--------------------------------------------------------------

754
data RecompReason = RecompNotRequired | RecompRequired | RecompForcedByTH
dterei's avatar
dterei committed
755
    deriving Eq
756

757 758
oneShotMsg :: HscEnv -> Maybe (Int,Int) -> RecompReason -> ModSummary -> IO ()
oneShotMsg hsc_env _mb_mod_index recomp _mod_summary =
dterei's avatar
dterei committed
759 760
    case recomp of
        RecompNotRequired ->
761 762
            compilationProgressMsg (hsc_dflags hsc_env) $
                   "compilation IS NOT required"
dterei's avatar
dterei committed
763
        _other ->
764 765 766
            return ()

batchMsg :: HscEnv -> Maybe (Int,Int) -> RecompReason -> ModSummary -> IO ()
dterei's avatar
dterei committed
767 768 769 770 771 772 773 774 775 776 777 778 779
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)
780

781 782 783
--------------------------------------------------------------
-- FrontEnds
--------------------------------------------------------------
784 785

hscFileFrontEnd :: ModSummary -> Hsc TcGblEnv
786 787 788
hscFileFrontEnd mod_summary = do
    rdr_module <- hscParse' mod_summary
    hsc_env <- getHscEnv
789
    dflags  <- getDynFlags
dterei's avatar
dterei committed
790 791 792
    tcg_env <-
        {-# SCC "Typecheck-Rename" #-}
        ioMsgMaybe $
793
            tcRnModule hsc_env (ms_hsc_src mod_summary) False rdr_module
794
    tcSafeOK <- liftIO $ readIORef (tcg_safeInfer tcg_env)
795 796

    -- end of the Safe Haskell line, how to respond to user?
797
    if not (safeHaskellOn dflags) || (safeInferOn dflags && not tcSafeOK)
798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813

        -- 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!"
814 815

--------------------------------------------------------------
816
-- Safe Haskell
817 818
--------------------------------------------------------------

819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
-- 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.


839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
-- 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
    hsc_env  <- getHscEnv
    dflags   <- getDynFlags
    tcg_env' <- checkSafeImports dflags hsc_env tcg_env
    case safeLanguageOn dflags of
        True -> do
            -- we nuke user written RULES in -XSafe
            logWarnings $ warns (tcg_rules tcg_env')
            return tcg_env' { tcg_rules = [] }
        False
              -- user defined RULES, so not safe or already unsafe
            | safeInferOn dflags && not (null $ tcg_rules tcg_env') ||
              safeHaskell dflags == Sf_None
870
            -> wipeTrust tcg_env' $ warns (tcg_rules tcg_env')
871

872
              -- trustworthy OR safe infered with no RULES
873 874 875
            | otherwise
            -> return tcg_env'

dterei's avatar
dterei committed
876 877 878 879 880 881
  where
    warns rules = listToBag $ map warnRules rules
    warnRules (L loc (HsRule n _ _ _ _ _ _)) =
        mkPlainWarnMsg loc $
            text "Rule \"" <> ftext n <> text "\" ignored" $+$
            text "User defined rules are disabled under Safe Haskell"
882

883 884 885 886 887
-- | Validate that safe imported modules are actually safe.
-- For modules in the HomePackage (the package the module we
-- are compiling in resides) this just involves checking its
-- trust type is 'Safe' or 'Trustworthy'. For modules that
-- reside in another package we also must check that the
888 889
-- external pacakge is trusted. See the Note [Safe Haskell
-- Trust Check] above for more information.
890
--
891 892 893 894 895 896
-- The code for this is quite tricky as the whole algorithm
-- is done in a few distinct phases in different parts of the
-- code base. See RnNames.rnImportDecl for where package trust
-- dependencies for a module are collected and unioned.
-- Specifically see the Note [RnNames . Tracking Trust Transitively]
-- and the Note [RnNames . Trust Own Package].
897 898 899
checkSafeImports :: DynFlags -> HscEnv -> TcGblEnv -> Hsc TcGblEnv
checkSafeImports dflags hsc_env tcg_env
    = do
900 901 902 903 904
        -- We want to use the warning state specifically for detecting if safe
        -- inference has failed, so store and clear any existing warnings.
        oldErrs <- getWarnings
        clearWarnings

905
        imps <- mapM condense imports'
906
        pkgs <- mapM checkSafe imps
dterei's avatar
dterei committed
907 908 909 910 911 912 913

        -- grab any safe haskell specific errors and restore old warnings
        errs <- getWarnings
        clearWarnings
        logWarnings oldErrs

        -- See the Note [ Safe Haskell Inference]
dterei's avatar
dterei committed
914 915 916 917 918 919
        case (not $ isEmptyBag errs) of

            -- We have errors!
            True ->
                -- did we fail safe inference or fail -XSafe?
                case safeInferOn dflags of
920
                    True  -> wipeTrust tcg_env errs
dterei's avatar
dterei committed
921
                    False -> liftIO . throwIO . mkSrcErr $ errs
dterei's avatar
dterei committed
922

dterei's avatar
dterei committed