HscMain.hs 67.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
    , 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 )
122
123
import qualified OldCmm as Old
import qualified Cmm as New
124
import CmmParse         ( parseCmmFile )
125
import CmmBuildInfoTables
Edward Z. Yang's avatar
Edward Z. Yang committed
126
import CmmPipeline
127
import CmmInfo
128
import CmmCvt
129
import CodeOutput
130
import NameEnv          ( emptyNameEnv )
131
132
import NameSet          ( emptyNameSet )
import InstEnv
133
import FamInstEnv
Thomas Schilling's avatar
Thomas Schilling committed
134
import Fingerprint      ( Fingerprint )
135

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

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

152
import Util
Simon Marlow's avatar
Simon Marlow committed
153

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

Thomas Schilling's avatar
Thomas Schilling committed
161
#include "HsVersions.h"
162

163

dterei's avatar
dterei committed
164
165
166
167
168
{- **********************************************************************
%*                                                                      *
                Initialisation
%*                                                                      *
%********************************************************************* -}
169

170
newHscEnv :: DynFlags -> IO HscEnv
171
newHscEnv dflags = do
dterei's avatar
dterei committed
172
173
174
175
176
    eps_var <- newIORef initExternalPackageState
    us      <- mkSplitUniqSupply 'r'
    nc_var  <- newIORef (initNameCache us knownKeyNames)
    fc_var  <- newIORef emptyUFM
    mlc_var <- newIORef emptyModuleEnv
177
    return HscEnv {  hsc_dflags       = dflags,
dterei's avatar
dterei committed
178
179
                     hsc_targets      = [],
                     hsc_mod_graph    = [],
180
                     hsc_IC           = emptyInteractiveContext dflags,
dterei's avatar
dterei committed
181
182
183
184
185
                     hsc_HPT          = emptyHomePackageTable,
                     hsc_EPS          = eps_var,
                     hsc_NC           = nc_var,
                     hsc_FC           = fc_var,
                     hsc_MLC          = mlc_var,
186
                     hsc_type_env_var = Nothing }
Thomas Schilling's avatar
Thomas Schilling committed
187

188

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

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

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

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

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

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

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

220
221
222
223
224
225
226
-- 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) })

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

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

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

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

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

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

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

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

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

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

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

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

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

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

#ifdef GHCI
dterei's avatar
dterei committed
316
317
318
319
320
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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
-- wrapper around tcRnModule to handle safe haskell extras
tcRnModule' :: HscEnv -> ModSummary -> Bool -> HsParsedModule
            -> Hsc TcGblEnv
tcRnModule' hsc_env sum save_rn_syntax mod = do
    tcg_res <- {-# SCC "Typecheck-Rename" #-}
               ioMsgMaybe $
                   tcRnModule hsc_env (ms_hsc_src sum) save_rn_syntax mod

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

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

        -- module safe, throw warning if needed
        else do
            tcg_res' <- hscCheckSafeImports tcg_res
            safe <- liftIO $ readIORef (tcg_safeInfer tcg_res')
            when (safe && wopt Opt_WarnSafe dflags)
                 (logWarnings $ unitBag $
Ian Lynagh's avatar
Ian Lynagh committed
446
                     mkPlainWarnMsg dflags (warnSafeOnLoc dflags) $ errSafe tcg_res')
447
448
449
            return tcg_res'
  where
    pprMod t  = ppr $ moduleName $ tcg_mod t
450
    errSafe t = quotes (pprMod t) <+> text "has been inferred as safe!"
451

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

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

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

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

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

487

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

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

dterei's avatar
dterei committed
499
500
501
502
503
504
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
505
targets byte-code.
dterei's avatar
dterei committed
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
531

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

676
677
678
679
--------------------------------------------------------------
-- Compilers
--------------------------------------------------------------

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

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

  , hscRecompile = genericHscRecompile hscOneShotCompiler

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

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

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

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

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

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

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

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

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

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

738
739
  , hscBackend = genericHscBackend hscBatchCompiler

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

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

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

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

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

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

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

770
771
772
  , hscBackend = genericHscBackend hscInteractiveCompiler

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

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

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

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

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

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

797
  , hscRecompile = genericHscRecompile hscNothingCompiler
798

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

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

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

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

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

818
819
820
821
--------------------------------------------------------------
-- NoRecomp handlers
--------------------------------------------------------------

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

831
832
833
834
--------------------------------------------------------------
-- Progress displayers.
--------------------------------------------------------------

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

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

863
864
865
--------------------------------------------------------------
-- FrontEnds
--------------------------------------------------------------
866
867

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

--------------------------------------------------------------
875
-- Safe Haskell
876
877
--------------------------------------------------------------

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


898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
-- 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
918
    tcg_env' <- checkSafeImports dflags tcg_env
919
920
921
    case safeLanguageOn dflags of
        True -> do
            -- we nuke user written RULES in -XSafe
Ian Lynagh's avatar
Ian Lynagh committed
922
            logWarnings $ warns dflags (tcg_rules tcg_env')
923
924
925
926
927
            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
Ian Lynagh's avatar
Ian Lynagh committed
928
            -> wipeTrust tcg_env' $ warns dflags (tcg_rules tcg_env')
929

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

dterei's avatar
dterei committed
934
  where
Ian Lynagh's avatar
Ian Lynagh committed
935
936
937
    warns dflags rules = listToBag $ map (warnRules dflags) rules
    warnRules dflags (L loc (HsRule n _ _ _ _ _ _)) =
        mkPlainWarnMsg dflags loc $
dterei's avatar
dterei committed
938
939
            text "Rule \"" <> ftext n <> text "\" ignored" $+$
            text "User defined rules are disabled under Safe Haskell"
940

941
942
943
944
945
946
-- | 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.
947
--
948
949
950
951
952
-- 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</