HscMain.hs 67.9 KB
Newer Older
1 2
{-# LANGUAGE BangPatterns, CPP, MagicHash, NondecreasingIndentation #-}

dterei's avatar
dterei committed
3 4
-------------------------------------------------------------------------------
--
5
-- | Main API for compiling plain Haskell source code.
6
--
dterei's avatar
dterei committed
7
-- This module implements compilation of a Haskell source. It is
8 9 10 11 12
-- /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
13
-- "interactive" mode (GHCi). There are also entry points for
14 15 16 17 18 19 20 21 22 23 24 25
-- 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.
26
--
dterei's avatar
dterei committed
27 28 29 30
-- (c) The GRASP/AQUA Project, Glasgow University, 1993-2000
--
-------------------------------------------------------------------------------

31
module HscMain
dterei's avatar
dterei committed
32
    (
33 34 35 36
    -- * Making an HscEnv
      newHscEnv

    -- * Compiling complete source files
37 38
    , Messager, batchMsg
    , HscStatus (..)
39 40 41 42
    , hscCompileOneShot
    , hscCompileCmmFile
    , hscCompileCore

43 44 45 46 47 48 49 50 51
    , genericHscCompileGetFrontendResult

    , genModDetails
    , hscSimpleIface
    , hscWriteIface
    , hscNormalIface
    , hscGenHardCode
    , hscInteractive

52
    -- * Running passes separately
Thomas Schilling's avatar
Thomas Schilling committed
53 54 55
    , hscParse
    , hscTypecheckRename
    , hscDesugar
Simon Marlow's avatar
Simon Marlow committed
56 57
    , makeSimpleIface
    , makeSimpleDetails
58 59 60 61 62 63
    , hscSimplify -- ToDo, shouldn't really export this

    -- * Support for interactive evaluation
    , hscParseIdentifier
    , hscTcRcLookupName
    , hscTcRnGetInfo
64
    , hscCheckSafe
dterei's avatar
dterei committed
65
    , hscGetSafe
66
#ifdef GHCI
dterei's avatar
dterei committed
67
    , hscIsGHCiMonad
68
    , hscGetModuleInterface
69
    , hscRnImportDecls
70
    , hscTcRnLookupRdrName
vivian's avatar
vivian committed
71
    , hscStmt, hscStmtWithLocation
72
    , hscDecls, hscDeclsWithLocation
vivian's avatar
vivian committed
73
    , hscTcExpr, hscImport, hscKcType
74
    , hscCompileCoreExpr
75 76
    -- * Low-level exports for hooks
    , hscCompileCoreExpr'
77
#endif
Edsko de Vries's avatar
Edsko de Vries committed
78 79
      -- We want to make sure that we export enough to be able to redefine
      -- hscFileFrontEnd in client code
80
    , hscParse', hscSimplify', hscDesugar', tcRnModule'
Edsko de Vries's avatar
Edsko de Vries committed
81
    , getHscEnv
82 83 84
    , hscSimpleIface', hscNormalIface'
    , oneShotMsg
    , hscFileFrontEnd, genericHscFrontend, dumpIfaceStats
85
    ) where
86

87
#ifdef GHCI
Simon Marlow's avatar
Simon Marlow committed
88
import Id
89
import BasicTypes       ( HValue )
90
import ByteCodeGen      ( byteCodeGen, coreExprToBCOs )
91
import Linker
92
import CoreTidy         ( tidyExpr )
93
import Type             ( Type, Kind )
94
import CoreLint         ( lintInteractiveExpr )
95
import VarEnv           ( emptyTidyEnv )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
96
import Panic
97
import ConLike
98 99

import GHC.Exts
100 101
#endif

102 103
import Module
import Packages
Simon Marlow's avatar
Simon Marlow committed
104 105
import RdrName
import HsSyn
106
import CoreSyn
Ian Lynagh's avatar
Ian Lynagh committed
107
import StringBuffer
108
import Parser
109
import Lexer
110 111
import SrcLoc
import TcRnDriver
112
import TcIface          ( typecheckIface )
113
import TcRnMonad
114 115
import IfaceEnv         ( initNameCache )
import LoadIface        ( ifaceStats, initExternalPackageState )
116
import PrelInfo
Simon Marlow's avatar
Simon Marlow committed
117
import MkIface
118 119
import Desugar
import SimplCore
Simon Marlow's avatar
Simon Marlow committed
120
import TidyPgm
121
import CorePrep
122 123
import CoreToStg        ( coreToStg )
import qualified StgCmm ( codeGen )
124 125
import StgSyn
import CostCentre
126
import ProfInit
127 128
import TyCon
import Name
129
import SimplStg         ( stg2stg )
130
import Cmm
131
import CmmParse         ( parseCmmFile )
132
import CmmBuildInfoTables
Edward Z. Yang's avatar
Edward Z. Yang committed
133
import CmmPipeline
134
import CmmInfo
135
import CodeOutput
136
import NameEnv          ( emptyNameEnv )
137 138
import NameSet          ( emptyNameSet )
import InstEnv
139
import FamInstEnv
Thomas Schilling's avatar
Thomas Schilling committed
140
import Fingerprint      ( Fingerprint )
141
import Hooks
142

143
import DynFlags
144
import ErrUtils
145

146
import Outputable
147
import HscStats         ( ppSourceStats )
148
import HscTypes
149
import FastString
150
import UniqSupply
151
import Bag
Thomas Schilling's avatar
Thomas Schilling committed
152
import Exception
153 154 155
import qualified Stream
import Stream (Stream)

156
import Util
Simon Marlow's avatar
Simon Marlow committed
157

158
import Data.List
Simon Marlow's avatar
Simon Marlow committed
159
import Control.Monad
160
import Data.Maybe
Simon Marlow's avatar
Simon Marlow committed
161
import Data.IORef
162
import System.FilePath as FilePath
163
import System.Directory
Alan Zimmerman's avatar
Alan Zimmerman committed
164
import qualified Data.Map as Map
dterei's avatar
dterei committed
165

Thomas Schilling's avatar
Thomas Schilling committed
166
#include "HsVersions.h"
167

168

dterei's avatar
dterei committed
169 170 171 172 173
{- **********************************************************************
%*                                                                      *
                Initialisation
%*                                                                      *
%********************************************************************* -}
174

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

191

192
-- -----------------------------------------------------------------------------
193

194
getWarnings :: Hsc WarningMessages
dterei's avatar
dterei committed
195
getWarnings = Hsc $ \_ w -> return (w, w)
196 197

clearWarnings :: Hsc ()
dterei's avatar
dterei committed
198
clearWarnings = Hsc $ \_ _ -> return ((), emptyBag)
199 200

logWarnings :: WarningMessages -> Hsc ()
dterei's avatar
dterei committed
201
logWarnings w = Hsc $ \_ w0 -> return ((), w0 `unionBags` w)
202 203

getHscEnv :: Hsc HscEnv
dterei's avatar
dterei committed
204
getHscEnv = Hsc $ \e w -> return (e, w)
205 206 207

handleWarnings :: Hsc ()
handleWarnings = do
dterei's avatar
dterei committed
208 209 210 211
    dflags <- getDynFlags
    w <- getWarnings
    liftIO $ printOrThrowWarnings dflags w
    clearWarnings
212 213 214 215 216

-- | 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
217 218
    logWarnings warns
    when (not $ isEmptyBag errs) $ throwErrors errs
219 220 221 222

-- | Throw some errors.
throwErrors :: ErrorMessages -> Hsc a
throwErrors = liftIO . throwIO . mkSrcErr
223 224 225 226 227

-- | 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
228
-- and signal success via by wrapping the result in a 'Maybe' type. This
229 230 231 232 233 234 235 236 237
-- 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
238
--     there should be warnings in the first result. That is, if the action
239 240 241
--     failed, it must have been due to the warnings (i.e., @-Werror@).
ioMsgMaybe :: IO (Messages, Maybe a) -> Hsc a
ioMsgMaybe ioA = do
242
    ((warns,errs), mb_r) <- liftIO ioA
dterei's avatar
dterei committed
243 244 245 246
    logWarnings warns
    case mb_r of
        Nothing -> throwErrors errs
        Just r  -> ASSERT( isEmptyBag errs ) return r
247 248 249 250 251

-- | 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
252 253 254
    ((warns,_errs), mb_r) <- liftIO $ ioA
    logWarnings warns
    return mb_r
255 256 257 258 259

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

#ifdef GHCI
260 261 262 263 264
hscTcRnLookupRdrName :: HscEnv -> Located RdrName -> IO [Name]
hscTcRnLookupRdrName hsc_env0 rdr_name 
  = runInteractiveHsc hsc_env0 $ 
    do { hsc_env <- getHscEnv
       ; ioMsgMaybe $ tcRnLookupRdrName hsc_env rdr_name }
265 266 267
#endif

hscTcRcLookupName :: HscEnv -> Name -> IO (Maybe TyThing)
268 269 270
hscTcRcLookupName hsc_env0 name = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe' $ tcRnLookupName hsc_env name
dterei's avatar
dterei committed
271 272 273
      -- 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.
274

275
hscTcRnGetInfo :: HscEnv -> Name -> IO (Maybe (TyThing, Fixity, [ClsInst], [FamInst]))
276 277 278 279
hscTcRnGetInfo hsc_env0 name
  = runInteractiveHsc hsc_env0 $
    do { hsc_env <- getHscEnv
       ; ioMsgMaybe' $ tcRnGetInfo hsc_env name }
280 281

#ifdef GHCI
dterei's avatar
dterei committed
282
hscIsGHCiMonad :: HscEnv -> String -> IO Name
Edsko de Vries's avatar
Edsko de Vries committed
283
hscIsGHCiMonad hsc_env name
284
  = runHsc hsc_env $ ioMsgMaybe $ isGHCiMonad hsc_env name
dterei's avatar
dterei committed
285

286
hscGetModuleInterface :: HscEnv -> Module -> IO ModIface
287 288 289
hscGetModuleInterface hsc_env0 mod = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe $ getModuleInterface hsc_env mod
290 291 292

-- -----------------------------------------------------------------------------
-- | Rename some import declarations
293
hscRnImportDecls :: HscEnv -> [LImportDecl RdrName] -> IO GlobalRdrEnv
294 295 296
hscRnImportDecls hsc_env0 import_decls = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe $ tcRnImportDecls hsc_env import_decls
297 298
#endif

299
-- -----------------------------------------------------------------------------
Simon Marlow's avatar
Simon Marlow committed
300
-- | parse a file, returning the abstract syntax
301

302
hscParse :: HscEnv -> ModSummary -> IO HsParsedModule
303 304 305
hscParse hsc_env mod_summary = runHsc hsc_env $ hscParse' mod_summary

-- internal version, that doesn't fail due to -Werror
306
hscParse' :: ModSummary -> Hsc HsParsedModule
307
hscParse' mod_summary = do
dterei's avatar
dterei committed
308 309 310
    dflags <- getDynFlags
    let src_filename  = ms_hspp_file mod_summary
        maybe_src_buf = ms_hspp_buf  mod_summary
311

dterei's avatar
dterei committed
312 313 314
    --------------------------  Parser  ----------------
    liftIO $ showPass dflags "Parser"
    {-# SCC "Parser" #-} do
315 316 317 318

    -- 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
319 320 321
    buf <- case maybe_src_buf of
               Just b  -> return b
               Nothing -> liftIO $ hGetStringBuffer src_filename
322

dterei's avatar
dterei committed
323
    let loc = mkRealSrcLoc (mkFastString src_filename) 1 1
324

dterei's avatar
dterei committed
325 326
    case unP parseModule (mkPState dflags buf loc) of
        PFailed span err ->
Ian Lynagh's avatar
Ian Lynagh committed
327
            liftIO $ throwOneError (mkPlainErrMsg dflags span err)
328

dterei's avatar
dterei committed
329 330 331 332 333 334
        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
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349

            -- 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
350
                            $ filter (not . (isPrefixOf "<"))
351 352 353 354 355 356
                            $ map unpackFS
                            $ srcfiles pst
                srcs1 = case ml_hs_file (ms_location mod_summary) of
                          Just f  -> filter (/= FilePath.normalise f) srcs0
                          Nothing -> srcs0

357 358 359 360 361
            -- sometimes we see source files from earlier
            -- preprocessing stages that cannot be found, so just
            -- filter them out:
            srcs2 <- liftIO $ filterM doesFileExist srcs1

362 363
            return HsParsedModule {
                      hpm_module    = rdr_module,
Alan Zimmerman's avatar
Alan Zimmerman committed
364 365 366 367 368
                      hpm_src_files = srcs2,
                      hpm_annotations
                              = (Map.fromListWith (++) $ annotations pst,
                                 Map.fromList $ ((noSrcSpan,comment_q pst)
                                                 :(annotations_comments pst)))
369
                   }
Simon Marlow's avatar
Simon Marlow committed
370

Thomas Schilling's avatar
Thomas Schilling committed
371 372 373
-- 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
374
type RenamedStuff =
Simon Marlow's avatar
Simon Marlow committed
375
        (Maybe (HsGroup Name, [LImportDecl Name], Maybe [LIE Name],
376
                Maybe LHsDocString))
Simon Marlow's avatar
Simon Marlow committed
377

Thomas Schilling's avatar
Thomas Schilling committed
378
-- | Rename and typecheck a module, additionally returning the renamed syntax
379
hscTypecheckRename :: HscEnv -> ModSummary -> HsParsedModule
380
                   -> IO (TcGblEnv, RenamedStuff)
dterei's avatar
dterei committed
381
hscTypecheckRename hsc_env mod_summary rdr_module = runHsc hsc_env $ do
382
    tc_result <- tcRnModule' hsc_env mod_summary True rdr_module
Thomas Schilling's avatar
Thomas Schilling committed
383

384 385 386 387 388 389
        -- 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
390

391
    return (tc_result, rn_info)
Simon Marlow's avatar
Simon Marlow committed
392

393 394 395 396 397 398 399 400
-- 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

401 402 403
    -- See Note [Safe Haskell Overlapping Instances Implementation]
    -- although this is used for more than just that failure case.
    (tcSafeOK, whyUnsafe) <- liftIO $ readIORef (tcg_safeInfer tcg_res)
404
    dflags   <- getDynFlags
405
    let allSafeOK = safeInferred dflags && tcSafeOK
406

407 408 409
    -- end of the safe haskell line, how to respond to user?
    if not (safeHaskellOn dflags) || (safeInferOn dflags && not allSafeOK)
        -- if safe Haskell off or safe infer failed, mark unsafe
410
        then markUnsafeInfer tcg_res whyUnsafe
411

412
        -- module (could be) safe, throw warning if needed
413 414
        else do
            tcg_res' <- hscCheckSafeImports tcg_res
415
            safe <- liftIO $ fst <$> readIORef (tcg_safeInfer tcg_res')
416 417 418 419 420 421 422 423 424
            when safe $ do
              case wopt Opt_WarnSafe dflags of
                True -> (logWarnings $ unitBag $ mkPlainWarnMsg dflags
                       (warnSafeOnLoc dflags) $ errSafe tcg_res')
                False | safeHaskell dflags == Sf_Trustworthy &&
                        wopt Opt_WarnTrustworthySafe dflags ->
                  (logWarnings $ unitBag $ mkPlainWarnMsg dflags
                    (trustworthyOnLoc dflags) $ errTwthySafe tcg_res')
                False -> return ()
425 426 427
            return tcg_res'
  where
    pprMod t  = ppr $ moduleName $ tcg_mod t
428
    errSafe t = quotes (pprMod t) <+> text "has been inferred as safe!"
429 430
    errTwthySafe t = quotes (pprMod t)
      <+> text "is marked as Trustworthy but has been inferred as safe!"
431

Simon Marlow's avatar
Simon Marlow committed
432
-- | Convert a typechecked module to Core
433
hscDesugar :: HscEnv -> ModSummary -> TcGblEnv -> IO ModGuts
434
hscDesugar hsc_env mod_summary tc_result =
Ian Lynagh's avatar
Ian Lynagh committed
435
    runHsc hsc_env $ hscDesugar' (ms_location mod_summary) tc_result
436

Ian Lynagh's avatar
Ian Lynagh committed
437 438
hscDesugar' :: ModLocation -> TcGblEnv -> Hsc ModGuts
hscDesugar' mod_location tc_result = do
dterei's avatar
dterei committed
439
    hsc_env <- getHscEnv
Simon Marlow's avatar
Simon Marlow committed
440 441
    r <- ioMsgMaybe $
      {-# SCC "deSugar" #-}
Ian Lynagh's avatar
Ian Lynagh committed
442
      deSugar hsc_env mod_location tc_result
443

dterei's avatar
dterei committed
444 445 446 447
    -- 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
448

dterei's avatar
dterei committed
449
-- | Make a 'ModIface' from the results of typechecking. Used when
Simon Marlow's avatar
Simon Marlow committed
450 451 452 453
-- 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.
454
makeSimpleIface :: HscEnv -> Maybe ModIface -> TcGblEnv -> ModDetails
455
                -> IO (ModIface,Bool)
456 457 458 459 460
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
461

dterei's avatar
dterei committed
462
-- | Make a 'ModDetails' from the results of typechecking. Used when
Simon Marlow's avatar
Simon Marlow committed
463
-- typechecking only, as opposed to full compilation.
464 465
makeSimpleDetails :: HscEnv -> TcGblEnv -> IO ModDetails
makeSimpleDetails hsc_env tc_result = mkBootModDetailsTc hsc_env tc_result
Simon Marlow's avatar
Simon Marlow committed
466

467

dterei's avatar
dterei committed
468 469 470 471 472 473 474
{- **********************************************************************
%*                                                                      *
                The main compiler pipeline
%*                                                                      *
%********************************************************************* -}

{-
475 476 477 478
                   --------------------------------
                        The compilation proper
                   --------------------------------

dterei's avatar
dterei committed
479 480 481 482 483 484
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
485
targets byte-code.
dterei's avatar
dterei committed
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510

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


511 512 513 514 515 516 517 518 519 520 521 522 523
type Messager = HscEnv -> (Int,Int) -> RecompileRequired -> ModSummary -> IO ()

genericHscCompileGetFrontendResult ::
                     Bool -- always do basic recompilation check?
                  -> Maybe TcGblEnv
                  -> Maybe Messager
                  -> HscEnv
                  -> ModSummary
                  -> SourceModified
                  -> Maybe ModIface  -- Old interface, if available
                  -> (Int,Int)       -- (i,n) = module i of n (for msgs)
                  -> IO (Either ModIface (TcGblEnv, Maybe Fingerprint))

Simon Marlow's avatar
Simon Marlow committed
524 525 526
genericHscCompileGetFrontendResult
  always_do_basic_recompilation_check m_tc_result
  mHscMessage hsc_env mod_summary source_modified mb_old_iface mod_index
527 528 529 530 531
    = do

    let msg what = case mHscMessage of
                   Just hscMessage -> hscMessage hsc_env mod_index what mod_summary
                   Nothing -> return ()
dterei's avatar
dterei committed
532

533 534 535
        skip iface = do
            msg UpToDate
            return $ Left iface
dterei's avatar
dterei committed
536

537 538 539 540
        compile mb_old_hash reason = do
            msg reason
            tc_result <- runHsc hsc_env $ genericHscFrontend mod_summary
            return $ Right (tc_result, mb_old_hash)
dterei's avatar
dterei committed
541 542 543 544

        stable = case source_modified of
                     SourceUnmodifiedAndStable -> True
                     _                         -> False
545

546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
    case m_tc_result of
         Just tc_result
          | not always_do_basic_recompilation_check ->
             return $ Right (tc_result, Nothing)
         _ -> do
            (recomp_reqd, mb_checked_iface)
                <- {-# SCC "checkOldIface" #-}
                   checkOldIface hsc_env mod_summary
                                source_modified mb_old_iface
            -- 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

            case mb_checked_iface of
                Just iface | not (recompileRequired recomp_reqd) ->
Simon Marlow's avatar
Simon Marlow committed
562 563 564 565 566 567 568 569 570 571 572 573 574
                    -- If the module used TH splices when it was last
                    -- compiled, then the recompilation check is not
                    -- accurate enough (#481) and we must ignore
                    -- it.  However, if the module is stable (none of
                    -- the modules it depends on, directly or
                    -- indirectly, changed), then we *can* skip
                    -- recompilation. This is why the SourceModified
                    -- type contains SourceUnmodifiedAndStable, and
                    -- it's pretty important: otherwise ghc --make
                    -- would always recompile TH modules, even if
                    -- nothing at all has changed. Stability is just
                    -- the same check that make is doing for us in
                    -- one-shot mode.
575 576 577 578 579 580 581 582 583 584 585 586 587
                    case m_tc_result of
                    Nothing
                     | mi_used_th iface && not stable ->
                        compile mb_old_hash (RecompBecause "TH")
                    _ ->
                        skip iface
                _ ->
                    case m_tc_result of
                    Nothing -> compile mb_old_hash recomp_reqd
                    Just tc_result ->
                        return $ Right (tc_result, mb_old_hash)

genericHscFrontend :: ModSummary -> Hsc TcGblEnv
588 589 590 591
genericHscFrontend mod_summary =
  getHooked hscFrontendHook genericHscFrontend' >>= ($ mod_summary)

genericHscFrontend' :: ModSummary -> Hsc TcGblEnv
Austin Seipp's avatar
Austin Seipp committed
592
genericHscFrontend' mod_summary = hscFileFrontEnd mod_summary
593

594 595 596 597
--------------------------------------------------------------
-- Compilers
--------------------------------------------------------------

598 599 600
hscCompileOneShot :: HscEnv
                  -> ModSummary
                  -> SourceModified
601
                  -> IO HscStatus
602 603 604
hscCompileOneShot env =
  lookupHook hscCompileOneShotHook hscCompileOneShot' (hsc_dflags env) env

Austin Seipp's avatar
Austin Seipp committed
605
-- Compile Haskell/boot in OneShot mode.
606 607 608 609
hscCompileOneShot' :: HscEnv
                   -> ModSummary
                   -> SourceModified
                   -> IO HscStatus
Austin Seipp's avatar
Austin Seipp committed
610
hscCompileOneShot' hsc_env mod_summary src_changed
611
  = do
dterei's avatar
dterei committed
612 613 614 615 616
    -- 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) }
617

618 619 620 621
        msg what = oneShotMsg hsc_env' what

        skip = do msg UpToDate
                  dumpIfaceStats hsc_env'
622
                  return HscUpToDate
623 624 625 626

        compile mb_old_hash reason = runHsc hsc_env' $ do
            liftIO $ msg reason
            tc_result <- genericHscFrontend mod_summary
627
            guts0 <- hscDesugar' (ms_location mod_summary) tc_result
628 629
            dflags <- getDynFlags
            case hscTarget dflags of
630
                HscNothing -> do
631 632 633
                    when (gopt Opt_WriteInterface dflags) $ liftIO $ do
                        (iface, changed, _details) <- hscSimpleIface hsc_env tc_result mb_old_hash
                        hscWriteIface dflags iface changed mod_summary
634
                    return HscNotGeneratingCode
635 636
                _ ->
                    case ms_hsc_src mod_summary of
637
                    t | isHsBootOrSig t ->
638 639
                        do (iface, changed, _) <- hscSimpleIface' tc_result mb_old_hash
                           liftIO $ hscWriteIface dflags iface changed mod_summary
640 641 642 643
                           return (case t of
                                    HsBootFile -> HscUpdateBoot
                                    HsigFile -> HscUpdateSig
                                    HsSrcFile -> panic "hscCompileOneShot Src")
644
                    _ ->
645
                        do guts <- hscSimplify' guts0
Austin Seipp's avatar
Austin Seipp committed
646
                           (iface, changed, _details, cgguts) <- hscNormalIface' guts mb_old_hash
647
                           liftIO $ hscWriteIface dflags iface changed mod_summary
648
                           return $ HscRecomp cgguts mod_summary
649

Simon Marlow's avatar
Comment  
Simon Marlow committed
650 651 652
        -- XXX This is always False, because in one-shot mode the
        -- concept of stability does not exist.  The driver never
        -- passes SourceUnmodifiedAndStable in here.
653 654 655
        stable = case src_changed of
                     SourceUnmodifiedAndStable -> True
                     _                         -> False
656

657 658 659 660 661 662 663
    (recomp_reqd, mb_checked_iface)
        <- {-# SCC "checkOldIface" #-}
           checkOldIface hsc_env' mod_summary src_changed Nothing
    -- 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
664

665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
    case mb_checked_iface of
        Just iface | not (recompileRequired recomp_reqd) ->
            -- If the module used TH splices when it was last compiled,
            -- then the recompilation check is not accurate enough (#481)
            -- and we must ignore it. However, if the module is stable
            -- (none of the modules it depends on, directly or indirectly,
            -- changed), then we *can* skip recompilation. This is why
            -- the SourceModified type contains SourceUnmodifiedAndStable,
            -- and it's pretty important: otherwise ghc --make would
            -- always recompile TH modules, even if nothing at all has
            -- changed. Stability is just the same check that make is
            -- doing for us in one-shot mode.
            if mi_used_th iface && not stable
            then compile mb_old_hash (RecompBecause "TH")
            else skip
        _ ->
            compile mb_old_hash recomp_reqd
682

683 684 685 686
--------------------------------------------------------------
-- NoRecomp handlers
--------------------------------------------------------------

687 688
genModDetails :: HscEnv -> ModIface -> IO ModDetails
genModDetails hsc_env old_iface
689
  = do
dterei's avatar
dterei committed
690
    new_details <- {-# SCC "tcRnIface" #-}
691 692
                   initIfaceCheck hsc_env (typecheckIface old_iface)
    dumpIfaceStats hsc_env
dterei's avatar
dterei committed
693
    return new_details
694

695 696 697 698
--------------------------------------------------------------
-- Progress displayers.
--------------------------------------------------------------

699 700
oneShotMsg :: HscEnv -> RecompileRequired -> IO ()
oneShotMsg hsc_env recomp =
dterei's avatar
dterei committed
701
    case recomp of
702
        UpToDate ->
703 704
            compilationProgressMsg (hsc_dflags hsc_env) $
                   "compilation IS NOT required"
705
        _ ->
706 707
            return ()

708 709
batchMsg :: Messager
batchMsg hsc_env mod_index recomp mod_summary =
dterei's avatar
dterei committed
710
    case recomp of
711 712 713
        MustCompile -> showMsg "Compiling " ""
        UpToDate
            | verbosity (hsc_dflags hsc_env) >= 2 -> showMsg "Skipping  " ""
dterei's avatar
dterei committed
714
            | otherwise -> return ()
715
        RecompBecause reason -> showMsg "Compiling " (" [" ++ reason ++ "]")
dterei's avatar
dterei committed
716
    where
Ian Lynagh's avatar
Ian Lynagh committed
717
        dflags = hsc_dflags hsc_env
718
        showMsg msg reason =
Ian Lynagh's avatar
Ian Lynagh committed
719
            compilationProgressMsg dflags $
720
            (showModuleIndex mod_index ++
Ian Lynagh's avatar
Ian Lynagh committed
721
            msg ++ showModMsg dflags (hscTarget dflags)
722 723
                              (recompileRequired recomp) mod_summary)
                ++ reason
724

725 726 727
--------------------------------------------------------------
-- FrontEnds
--------------------------------------------------------------
728 729

hscFileFrontEnd :: ModSummary -> Hsc TcGblEnv
730
hscFileFrontEnd mod_summary = do
731
    hpm <- hscParse' mod_summary
732
    hsc_env <- getHscEnv
733 734
    tcg_env <- tcRnModule' hsc_env mod_summary False hpm
    return tcg_env
735 736

--------------------------------------------------------------
737
-- Safe Haskell
738 739
--------------------------------------------------------------

740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
-- 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.


760 761 762 763 764 765 766 767 768 769 770
-- 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.
771 772 773
--
-- It used to be that we only did safe inference on modules that had no Safe
-- Haskell flags, but now we perform safe inference on all modules as we want
774 775
-- to allow users to set the `-fwarn-safe`, `-fwarn-unsafe` and
-- `-fwarn-trustworthy-safe` flags on Trustworthy and Unsafe modules so that a
776 777 778 779 780 781 782
-- user can ensure their assumptions are correct and see reasons for why a
-- module is safe or unsafe.
--
-- This is tricky as we must be careful when we should throw an error compared
-- to just warnings. For checking safe imports we manage it as two steps. First
-- we check any imports that are required to be safe, then we check all other
-- imports to see if we can infer them to be safe.
783 784 785 786 787 788 789 790 791


-- | 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
792
    tcg_env' <- checkSafeImports dflags tcg_env
793
    checkRULES dflags tcg_env'
794

dterei's avatar
dterei committed
795
  where
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810
    checkRULES dflags tcg_env' = do
      case safeLanguageOn dflags of
          True -> do
              -- XSafe: we nuke user written RULES
              logWarnings $ warns dflags (tcg_rules tcg_env')
              return tcg_env' { tcg_rules = [] }
          False
                -- SafeInferred: user defined RULES, so not safe
              | safeInferOn dflags && not (null $ tcg_rules tcg_env')
              -> markUnsafeInfer tcg_env' $ warns dflags (tcg_rules tcg_env')

                -- Trustworthy OR SafeInferred: with no RULES
              | otherwise
              -> return tcg_env'

Ian Lynagh's avatar
Ian Lynagh committed
811 812 813
    warns dflags rules = listToBag $ map (warnRules dflags) rules
    warnRules dflags (L loc (HsRule n _ _ _ _ _ _)) =
        mkPlainWarnMsg dflags loc $
814
            text "Rule \"" <> ftext (snd $ unLoc n) <> text "\" ignored" $+$
dterei's avatar
dterei committed
815
            text "User defined rules are disabled under Safe Haskell"
816

817 818 819 820 821 822
-- | 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.
823
--
824 825 826 827 828
-- 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].
829 830
checkSafeImports :: DynFlags -> TcGblEnv -> Hsc TcGblEnv
checkSafeImports dflags tcg_env
831
    = do
832 833 834
        imps <- mapM condense imports'
        let (safeImps, regImps) = partition (\(_,_,s) -> s) imps

835 836 837 838 839
        -- 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

840 841 842
        -- Check safe imports are correct
        safePkgs <- mapM checkSafe safeImps
        safeErrs <- getWarnings
dterei's avatar
dterei committed
843 844
        clearWarnings

845
        -- Check non-safe imports are correct if inferring safety
846
        -- See the Note [Safe Haskell Inference]
847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
        (infErrs, infPkgs) <- case (safeInferOn dflags) of
          False -> return (emptyBag, [])
          True -> do infPkgs <- mapM checkSafe regImps
                     infErrs <- getWarnings
                     clearWarnings
                     return (infErrs, infPkgs)

        -- restore old errors
        logWarnings oldErrs

        case (isEmptyBag safeErrs) of
          -- Failed safe check
          False -> liftIO . throwIO . mkSrcErr $ safeErrs

          -- Passed safe check
          True -> do
            let infPassed = isEmptyBag infErrs
            tcg_env' <- case (not infPassed) of
              True  -> markUnsafeInfer tcg_env infErrs
              False -> return tcg_env
            when (packageTrustOn dflags) $ checkPkgTrust dflags pkgReqs
            let newTrust = pkgTrustReqs safePkgs infPkgs infPassed
            return tcg_env' { tcg_imports = impInfo `plusImportAvails` newTrust }
870

dterei's avatar
dterei committed
871
  where
872 873
    impInfo  = tcg_imports tcg_env     -- ImportAvails
    imports  = imp_mods impInfo        -- ImportedMods
dterei's avatar
dterei committed
874
    imports' = moduleEnvToList imports -- (Module, [ImportedModsVal])
875
    pkgReqs  = imp_trust_pkgs impInfo  -- [PackageKey]
dterei's avatar
dterei committed
876 877 878 879

    condense :: (Module, [ImportedModsVal]) -> Hsc (Module, SrcSpan, IsSafeImport)
    condense (_, [])   = panic "HscMain.condense: Pattern match failure!"
    condense (m, x:xs) = do (_,_,l,s) <- foldlM cond' x xs
880
                            return (m, l, s)
dterei's avatar
dterei committed
881

dterei's avatar
dterei committed
882 883 884 885
    -- ImportedModsVal = (ModuleName, Bool, SrcSpan, IsSafeImport)
    cond' :: ImportedModsVal -> ImportedModsVal -> Hsc ImportedModsVal
    cond' v1@(m1,_,l1,s1) (_,_,_,s2)
        | s1 /= s2
Ian Lynagh's avatar
Ian Lynagh committed
886
        = throwErrors $ unitBag $ mkPlainErrMsg dflags l1
dterei's avatar
dterei committed
887 888 889 890
              (text "Module" <+> ppr m1 <+>
              (text $ "is imported both as a safe and unsafe import!"))
        | otherwise
        = return v1
Jan Stolarek's avatar
Jan Stolarek committed
891

892
    -- easier interface to work with
893 894 895 896 897 898 899 900 901 902 903
    checkSafe (m, l, _) = fst `fmap` hscCheckSafe' dflags m l

    -- what pkg's to add to our trust requirements
    pkgTrustReqs req inf infPassed | safeInferOn dflags
                                  && safeHaskell dflags == Sf_None && infPassed
                                   = emptyImportAvails {
                                       imp_trust_pkgs = catMaybes req ++ catMaybes inf
                                   }
    pkgTrustReqs _   _ _ | safeHaskell dflags == Sf_Unsafe
                         = emptyImportAvails
    pkgTrustReqs req _ _ = emptyImportAvails { imp_trust_pkgs = catMaybes req }
dterei's avatar
dterei committed
904

905 906
-- | Check that a module is safe to import.
--
dterei's avatar
dterei committed
907 908 909
-- We return True to indicate the import is safe and False otherwise
-- although in the False case an exception may be thrown first.
hscCheckSafe :: HscEnv -> Module -> SrcSpan -> IO Bool