HscMain.hs 66.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
dterei's avatar
dterei committed
65
    , hscIsGHCiMonad
66
    , hscGetModuleInterface
67
    , hscRnImportDecls
68
    , hscTcRnLookupRdrName
vivian's avatar
vivian committed
69
    , hscStmt, hscStmtWithLocation
70
    , hscDecls, hscDeclsWithLocation
vivian's avatar
vivian committed
71
    , hscTcExpr, hscImport, hscKcType
72
73
    , hscCompileCoreExpr
#endif
74
    ) where
75

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

import GHC.Exts
90
91
#endif

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

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

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

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

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

160

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

167
newHscEnv :: DynFlags -> IO HscEnv
168
newHscEnv dflags = do
dterei's avatar
dterei committed
169
170
171
172
173
174
    eps_var <- newIORef initExternalPackageState
    us      <- mkSplitUniqSupply 'r'
    nc_var  <- newIORef (initNameCache us knownKeyNames)
    fc_var  <- newIORef emptyUFM
    mlc_var <- newIORef emptyModuleEnv
    optFuel <- initOptFuelState
175
    return HscEnv {  hsc_dflags       = dflags,
dterei's avatar
dterei committed
176
177
                     hsc_targets      = [],
                     hsc_mod_graph    = [],
178
                     hsc_IC           = emptyInteractiveContext dflags,
dterei's avatar
dterei committed
179
180
181
182
183
184
                     hsc_HPT          = emptyHomePackageTable,
                     hsc_EPS          = eps_var,
                     hsc_NC           = nc_var,
                     hsc_FC           = fc_var,
                     hsc_MLC          = mlc_var,
                     hsc_OptFuel      = optFuel,
185
                     hsc_type_env_var = Nothing }
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
220
221
222
223
224
225
-- A variant of runHsc that switches in the DynFlags from the
-- InteractiveContext before running the Hsc computation.
--
runInteractiveHsc :: HscEnv -> Hsc a -> IO a
runInteractiveHsc hsc_env =
  runHsc (hsc_env { hsc_dflags = ic_dflags (hsc_IC hsc_env) })

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

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

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

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

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

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

-- | 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
252
253
    logWarnings warns
    when (not $ isEmptyBag errs) $ throwErrors errs
254
255
256
257

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

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

-- | 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
287
288
289
    ((warns,_errs), mb_r) <- liftIO $ ioA
    logWarnings warns
    return mb_r
290
291
292
293
294
295

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

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

hscTcRcLookupName :: HscEnv -> Name -> IO (Maybe TyThing)
302
303
304
hscTcRcLookupName hsc_env0 name = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe' $ tcRnLookupName hsc_env name
dterei's avatar
dterei committed
305
306
307
      -- 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.
308

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

#ifdef GHCI
dterei's avatar
dterei committed
315
316
317
318
319
hscIsGHCiMonad :: HscEnv -> String -> IO Name
hscIsGHCiMonad hsc_env name =
    let icntxt   = hsc_IC hsc_env
    in runHsc hsc_env $ ioMsgMaybe $ isGHCiMonad hsc_env icntxt name

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

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

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

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

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

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

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

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

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

dterei's avatar
dterei committed
363
364
365
366
367
368
        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
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390

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

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

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

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

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

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

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

423
424
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
-- wrapper around tcRnModule to handle safe haskell extras
tcRnModule' :: HscEnv -> ModSummary -> Bool -> HsParsedModule
            -> Hsc TcGblEnv
tcRnModule' hsc_env sum save_rn_syntax mod = do
    tcg_res <- {-# SCC "Typecheck-Rename" #-}
               ioMsgMaybe $
                   tcRnModule hsc_env (ms_hsc_src sum) save_rn_syntax mod

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

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

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

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

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

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

dterei's avatar
dterei committed
468
-- | Make a 'ModIface' from the results of typechecking. Used when
Simon Marlow's avatar
Simon Marlow committed
469
470
471
472
-- 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.
473
makeSimpleIface :: HscEnv -> Maybe ModIface -> TcGblEnv -> ModDetails
474
                -> IO (ModIface,Bool)
475
476
477
478
479
makeSimpleIface hsc_env maybe_old_iface tc_result details = runHsc hsc_env $ do
    safe_mode <- hscGetSafeMode tc_result
    ioMsgMaybe $ do
        mkIfaceTc hsc_env (fmap mi_iface_hash maybe_old_iface) safe_mode
                  details tc_result
Simon Marlow's avatar
Simon Marlow committed
480

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

486

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

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

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

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

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

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

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

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

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

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

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

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

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

    let skip iface = do
602
            hscMessage hsc_env mb_mod_index UpToDate mod_summary
dterei's avatar
dterei committed
603
604
605
606
607
608
609
610
611
            runHsc hsc_env $ hscNoRecomp compiler iface

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

        stable = case source_modified of
                     SourceUnmodifiedAndStable -> True
                     _                         -> False
612
613
614

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

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

632
hscCheckRecompBackend :: HsCompiler a -> TcGblEnv -> Compiler a
dterei's avatar
dterei committed
633
634
hscCheckRecompBackend compiler tc_result hsc_env mod_summary
                      source_modified mb_old_iface _m_of_n
635
  = do
dterei's avatar
dterei committed
636
637
638
639
640
641
642
    (recomp_reqd, mb_checked_iface)
        <- {-# SCC "checkOldIface" #-}
           checkOldIface hsc_env mod_summary
                         source_modified mb_old_iface

    let mb_old_hash = fmap mi_iface_hash mb_checked_iface
    case mb_checked_iface of
643
        Just iface | not (recompileRequired recomp_reqd)
dterei's avatar
dterei committed
644
            -> runHsc hsc_env $
dterei's avatar
dterei committed
645
646
647
648
649
                   hscNoRecomp compiler
                       iface{ mi_globals = Just (tcg_rdr_env tc_result) }
        _otherwise
            -> runHsc hsc_env $
                   hscBackend compiler tc_result mod_summary mb_old_hash
650

651
genericHscRecompile :: HsCompiler a
652
                    -> ModSummary -> Maybe Fingerprint
653
                    -> Hsc a
654
genericHscRecompile compiler mod_summary mb_old_hash
dterei's avatar
dterei committed
655
656
657
658
659
    | ExtCoreFile <- ms_hsc_src mod_summary =
        panic "GHC does not currently support reading External Core files"
    | otherwise = do
        tc_result <- hscFileFrontEnd mod_summary
        hscBackend compiler tc_result mod_summary mb_old_hash
660

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

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

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

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

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

  , hscRecompile = genericHscRecompile hscOneShotCompiler

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

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

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

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

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

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

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

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

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

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

737
738
  , hscBackend = genericHscBackend hscBatchCompiler

739
  , hscGenBootOutput = \tc_result mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
740
741
742
        (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
743

744
  , hscGenOutput = \guts0 mod_summary mb_old_iface -> do
dterei's avatar
dterei committed
745
746
747
748
749
        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)
750
  }
751

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

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

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

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

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

769
770
771
  , hscBackend = genericHscBackend hscInteractiveCompiler

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

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

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

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

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

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

796
  , hscRecompile = genericHscRecompile hscNothingCompiler
797

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

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

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

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

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

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

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

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

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

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

862
863
864
--------------------------------------------------------------
-- FrontEnds
--------------------------------------------------------------
865
866

hscFileFrontEnd :: ModSummary -> Hsc TcGblEnv
867
hscFileFrontEnd mod_summary = do
868
    hpm <- hscParse' mod_summary
869
    hsc_env <- getHscEnv
870
871
    tcg_env <- tcRnModule' hsc_env mod_summary False hpm
    return tcg_env
872
873

--------------------------------------------------------------
874
-- Safe Haskell
875
876
--------------------------------------------------------------

877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
-- 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.


897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
-- 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
917
    tcg_env' <- checkSafeImports dflags tcg_env
918
919
920
921
922
923
924
925
926
    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
927
            -> wipeTrust tcg_env' $ warns (tcg_rules tcg_env')
928

929
              -- trustworthy OR safe infered with no RULES
930
931
932
            | otherwise
            -> return tcg_env'

dterei's avatar
dterei committed
933
934
935
936
937
938
  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"
939

940
941
942
943
944
945
-- | 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 external pacakge
-- is trusted. See the Note [Safe Haskell Trust Check] above for more
-- information.
946
--
947
948
949
950
951
-- 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].
952
953
checkSafeImports :: DynFlags -> TcGblEnv -> Hsc TcGblEnv
checkSafeImports dflags tcg_env
954
    = do
955
956
957
958
959
        -- 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

960
        imps <- mapM condense imports'
961
        pkgs <- mapM checkSafe imps
dterei's avatar
dterei committed
962
963
964
965
966
967

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

968
        -- See the Note [Safe Haskell Inference]
dterei's avatar
dterei committed
969
970
971
972
973
974
        case (not $ isEmptyBag errs) of

            -- We have errors!
            True ->
                -- did we fail safe inference or fail -XSafe?
                case safeInferOn dflags of
975
                    True  -> wipeTrust tcg_env errs
dterei's avatar