HscMain.hs 64.8 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
    -- * Making an HscEnv
      newHscEnv

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

41 42 43 44 45 46 47 48 49
    , genericHscCompileGetFrontendResult

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

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

    -- * Support for interactive evaluation
    , hscParseIdentifier
    , hscTcRcLookupName
    , hscTcRnGetInfo
62
    , hscCheckSafe
dterei's avatar
dterei committed
63
    , hscGetSafe
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
    , hscCompileCoreExpr
73 74
    -- * Low-level exports for hooks
    , hscCompileCoreExpr'
75
#endif
76 77 78 79
    , hscParse', hscSimplify', hscDesugar', tcRnModule'
    , hscSimpleIface', hscNormalIface'
    , oneShotMsg
    , hscFileFrontEnd, genericHscFrontend, dumpIfaceStats
80
    ) where
81

82
#ifdef GHCI
Simon Marlow's avatar
Simon Marlow committed
83
import Id
84
import BasicTypes       ( HValue )
85
import ByteCodeGen      ( byteCodeGen, coreExprToBCOs )
86
import Linker
87 88
import CoreTidy         ( tidyExpr )
import Type             ( Type )
89
import PrelNames
90
import {- Kind parts of -} Type         ( Kind )
91
import CoreMonad        ( lintInteractiveExpr )
92 93
import DsMeta           ( templateHaskellNames )
import VarEnv           ( emptyTidyEnv )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
94
import Panic
95 96

import GHC.Exts
97 98
#endif

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

140
import DynFlags
141
import ErrUtils
142

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

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

157
import Data.List
Simon Marlow's avatar
Simon Marlow committed
158
import Control.Monad
159
import Data.Maybe
Simon Marlow's avatar
Simon Marlow committed
160
import Data.IORef
161
import System.FilePath as FilePath
162
import System.Directory
dterei's avatar
dterei committed
163

Thomas Schilling's avatar
Thomas Schilling committed
164
#include "HsVersions.h"
165

166

dterei's avatar
dterei committed
167 168 169 170 171
{- **********************************************************************
%*                                                                      *
                Initialisation
%*                                                                      *
%********************************************************************* -}
172

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

191

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

200
-- -----------------------------------------------------------------------------
201

202
getWarnings :: Hsc WarningMessages
dterei's avatar
dterei committed
203
getWarnings = Hsc $ \_ w -> return (w, w)
204 205

clearWarnings :: Hsc ()
dterei's avatar
dterei committed
206
clearWarnings = Hsc $ \_ _ -> return ((), emptyBag)
207 208

logWarnings :: WarningMessages -> Hsc ()
dterei's avatar
dterei committed
209
logWarnings w = Hsc $ \_ w0 -> return ((), w0 `unionBags` w)
210 211

getHscEnv :: Hsc HscEnv
dterei's avatar
dterei committed
212
getHscEnv = Hsc $ \e w -> return (e, w)
213 214 215

handleWarnings :: Hsc ()
handleWarnings = do
dterei's avatar
dterei committed
216 217 218 219
    dflags <- getDynFlags
    w <- getWarnings
    liftIO $ printOrThrowWarnings dflags w
    clearWarnings
220 221 222 223 224

-- | 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
225 226
    logWarnings warns
    when (not $ isEmptyBag errs) $ throwErrors errs
227 228 229 230

-- | Throw some errors.
throwErrors :: ErrorMessages -> Hsc a
throwErrors = liftIO . throwIO . mkSrcErr
231 232 233 234 235

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

-- | 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
260 261 262
    ((warns,_errs), mb_r) <- liftIO $ ioA
    logWarnings warns
    return mb_r
263 264 265 266 267 268

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

#ifdef GHCI
hscTcRnLookupRdrName :: HscEnv -> RdrName -> IO [Name]
269 270 271
hscTcRnLookupRdrName hsc_env0 rdr_name = runInteractiveHsc hsc_env0 $ do
   hsc_env <- getHscEnv
   ioMsgMaybe $ tcRnLookupRdrName hsc_env rdr_name
272 273 274
#endif

hscTcRcLookupName :: HscEnv -> Name -> IO (Maybe TyThing)
275 276 277
hscTcRcLookupName hsc_env0 name = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe' $ tcRnLookupName hsc_env name
dterei's avatar
dterei committed
278 279 280
      -- 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.
281

282
hscTcRnGetInfo :: HscEnv -> Name -> IO (Maybe (TyThing, Fixity, [ClsInst], [FamInst]))
283 284 285
hscTcRnGetInfo hsc_env0 name = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe' $ tcRnGetInfo hsc_env name
286 287

#ifdef GHCI
dterei's avatar
dterei committed
288 289 290 291 292
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

293
hscGetModuleInterface :: HscEnv -> Module -> IO ModIface
294 295 296
hscGetModuleInterface hsc_env0 mod = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe $ getModuleInterface hsc_env mod
297 298 299

-- -----------------------------------------------------------------------------
-- | Rename some import declarations
300
hscRnImportDecls :: HscEnv -> [LImportDecl RdrName] -> IO GlobalRdrEnv
301 302 303
hscRnImportDecls hsc_env0 import_decls = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe $ tcRnImportDecls hsc_env import_decls
304 305
#endif

306
-- -----------------------------------------------------------------------------
Simon Marlow's avatar
Simon Marlow committed
307
-- | parse a file, returning the abstract syntax
308

309
hscParse :: HscEnv -> ModSummary -> IO HsParsedModule
310 311 312
hscParse hsc_env mod_summary = runHsc hsc_env $ hscParse' mod_summary

-- internal version, that doesn't fail due to -Werror
313
hscParse' :: ModSummary -> Hsc HsParsedModule
314
hscParse' mod_summary = do
dterei's avatar
dterei committed
315 316 317
    dflags <- getDynFlags
    let src_filename  = ms_hspp_file mod_summary
        maybe_src_buf = ms_hspp_buf  mod_summary
318

dterei's avatar
dterei committed
319 320 321
    --------------------------  Parser  ----------------
    liftIO $ showPass dflags "Parser"
    {-# SCC "Parser" #-} do
322 323 324 325

    -- 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
326 327 328
    buf <- case maybe_src_buf of
               Just b  -> return b
               Nothing -> liftIO $ hGetStringBuffer src_filename
329

dterei's avatar
dterei committed
330
    let loc = mkRealSrcLoc (mkFastString src_filename) 1 1
331

dterei's avatar
dterei committed
332 333
    case unP parseModule (mkPState dflags buf loc) of
        PFailed span err ->
Ian Lynagh's avatar
Ian Lynagh committed
334
            liftIO $ throwOneError (mkPlainErrMsg dflags span err)
335

dterei's avatar
dterei committed
336 337 338 339 340 341
        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
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356

            -- 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
357
                            $ filter (not . (isPrefixOf "<"))
358 359 360 361 362 363
                            $ map unpackFS
                            $ srcfiles pst
                srcs1 = case ml_hs_file (ms_location mod_summary) of
                          Just f  -> filter (/= FilePath.normalise f) srcs0
                          Nothing -> srcs0

364 365 366 367 368
            -- sometimes we see source files from earlier
            -- preprocessing stages that cannot be found, so just
            -- filter them out:
            srcs2 <- liftIO $ filterM doesFileExist srcs1

369 370
            return HsParsedModule {
                      hpm_module    = rdr_module,
371
                      hpm_src_files = srcs2
372
                   }
Simon Marlow's avatar
Simon Marlow committed
373

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

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

387 388 389 390 391 392
        -- 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
393

394
    return (tc_result, rn_info)
Simon Marlow's avatar
Simon Marlow committed
395

396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
-- 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
418
                     mkPlainWarnMsg dflags (warnSafeOnLoc dflags) $ errSafe tcg_res')
419 420 421
            return tcg_res'
  where
    pprMod t  = ppr $ moduleName $ tcg_mod t
422
    errSafe t = quotes (pprMod t) <+> text "has been inferred as safe!"
423

Simon Marlow's avatar
Simon Marlow committed
424
-- | Convert a typechecked module to Core
425
hscDesugar :: HscEnv -> ModSummary -> TcGblEnv -> IO ModGuts
426
hscDesugar hsc_env mod_summary tc_result =
Ian Lynagh's avatar
Ian Lynagh committed
427
    runHsc hsc_env $ hscDesugar' (ms_location mod_summary) tc_result
428

Ian Lynagh's avatar
Ian Lynagh committed
429 430
hscDesugar' :: ModLocation -> TcGblEnv -> Hsc ModGuts
hscDesugar' mod_location tc_result = do
dterei's avatar
dterei committed
431
    hsc_env <- getHscEnv
Simon Marlow's avatar
Simon Marlow committed
432 433
    r <- ioMsgMaybe $
      {-# SCC "deSugar" #-}
Ian Lynagh's avatar
Ian Lynagh committed
434
      deSugar hsc_env mod_location tc_result
435

dterei's avatar
dterei committed
436 437 438 439
    -- 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
440

dterei's avatar
dterei committed
441
-- | Make a 'ModIface' from the results of typechecking. Used when
Simon Marlow's avatar
Simon Marlow committed
442 443 444 445
-- 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.
446
makeSimpleIface :: HscEnv -> Maybe ModIface -> TcGblEnv -> ModDetails
447
                -> IO (ModIface,Bool)
448 449 450 451 452
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
453

dterei's avatar
dterei committed
454
-- | Make a 'ModDetails' from the results of typechecking. Used when
Simon Marlow's avatar
Simon Marlow committed
455
-- typechecking only, as opposed to full compilation.
456 457
makeSimpleDetails :: HscEnv -> TcGblEnv -> IO ModDetails
makeSimpleDetails hsc_env tc_result = mkBootModDetailsTc hsc_env tc_result
Simon Marlow's avatar
Simon Marlow committed
458

459

dterei's avatar
dterei committed
460 461 462 463 464 465 466
{- **********************************************************************
%*                                                                      *
                The main compiler pipeline
%*                                                                      *
%********************************************************************* -}

{-
467 468 469 470
                   --------------------------------
                        The compilation proper
                   --------------------------------

dterei's avatar
dterei committed
471 472 473 474 475 476
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
477
targets byte-code.
dterei's avatar
dterei committed
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502

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


503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
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))

genericHscCompileGetFrontendResult always_do_basic_recompilation_check m_tc_result
                                   mHscMessage hsc_env mod_summary source_modified mb_old_iface mod_index
    = do

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

524 525 526
        skip iface = do
            msg UpToDate
            return $ Left iface
dterei's avatar
dterei committed
527

528 529 530 531
        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
532 533 534 535

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

537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
    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) ->
                    -- 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.
                    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
576 577 578 579 580
genericHscFrontend mod_summary =
  getHooked hscFrontendHook genericHscFrontend' >>= ($ mod_summary)

genericHscFrontend' :: ModSummary -> Hsc TcGblEnv
genericHscFrontend' mod_summary
dterei's avatar
dterei committed
581 582
    | ExtCoreFile <- ms_hsc_src mod_summary =
        panic "GHC does not currently support reading External Core files"
583
    | otherwise =
584
        hscFileFrontEnd mod_summary
585

586 587 588 589
--------------------------------------------------------------
-- Compilers
--------------------------------------------------------------

590
hscCompileOneShot :: HscEnv
591
                  -> FilePath
592 593
                  -> ModSummary
                  -> SourceModified
594
                  -> IO HscStatus
595 596 597 598 599 600 601 602 603 604
hscCompileOneShot env =
  lookupHook hscCompileOneShotHook hscCompileOneShot' (hsc_dflags env) env

-- Compile Haskell, boot and extCore in OneShot mode.
hscCompileOneShot' :: HscEnv
                   -> FilePath
                   -> ModSummary
                   -> SourceModified
                   -> IO HscStatus
hscCompileOneShot' hsc_env extCore_filename mod_summary src_changed
605
  = do
dterei's avatar
dterei committed
606 607 608 609 610
    -- 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) }
611

612 613 614 615
        msg what = oneShotMsg hsc_env' what

        skip = do msg UpToDate
                  dumpIfaceStats hsc_env'
616
                  return HscUpToDate
617 618 619 620

        compile mb_old_hash reason = runHsc hsc_env' $ do
            liftIO $ msg reason
            tc_result <- genericHscFrontend mod_summary
621
            guts0 <- hscDesugar' (ms_location mod_summary) tc_result
622 623
            dflags <- getDynFlags
            case hscTarget dflags of
624
                HscNothing -> return HscNotGeneratingCode
625 626 627 628 629
                _ ->
                    case ms_hsc_src mod_summary of
                    HsBootFile ->
                        do (iface, changed, _) <- hscSimpleIface' tc_result mb_old_hash
                           liftIO $ hscWriteIface dflags iface changed mod_summary
630
                           return HscUpdateBoot
631
                    _ ->
632
                        do guts <- hscSimplify' guts0
633
                           (iface, changed, _details, cgguts) <- hscNormalIface' extCore_filename guts mb_old_hash
634
                           liftIO $ hscWriteIface dflags iface changed mod_summary
635
                           return $ HscRecomp cgguts mod_summary
636 637 638 639

        stable = case src_changed of
                     SourceUnmodifiedAndStable -> True
                     _                         -> False
640

641 642 643 644 645 646 647
    (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
648

649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
    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
666

667 668 669 670
--------------------------------------------------------------
-- NoRecomp handlers
--------------------------------------------------------------

671 672
genModDetails :: HscEnv -> ModIface -> IO ModDetails
genModDetails hsc_env old_iface
673
  = do
dterei's avatar
dterei committed
674
    new_details <- {-# SCC "tcRnIface" #-}
675 676
                   initIfaceCheck hsc_env (typecheckIface old_iface)
    dumpIfaceStats hsc_env
dterei's avatar
dterei committed
677
    return new_details
678

679 680 681 682
--------------------------------------------------------------
-- Progress displayers.
--------------------------------------------------------------

683 684
oneShotMsg :: HscEnv -> RecompileRequired -> IO ()
oneShotMsg hsc_env recomp =
dterei's avatar
dterei committed
685
    case recomp of
686
        UpToDate ->
687 688
            compilationProgressMsg (hsc_dflags hsc_env) $
                   "compilation IS NOT required"
689
        _ ->
690 691
            return ()

692 693
batchMsg :: Messager
batchMsg hsc_env mod_index recomp mod_summary =
dterei's avatar
dterei committed
694
    case recomp of
695 696 697
        MustCompile -> showMsg "Compiling " ""
        UpToDate
            | verbosity (hsc_dflags hsc_env) >= 2 -> showMsg "Skipping  " ""
dterei's avatar
dterei committed
698
            | otherwise -> return ()
699
        RecompBecause reason -> showMsg "Compiling " (" [" ++ reason ++ "]")
dterei's avatar
dterei committed
700
    where
Ian Lynagh's avatar
Ian Lynagh committed
701
        dflags = hsc_dflags hsc_env
702
        showMsg msg reason =
Ian Lynagh's avatar
Ian Lynagh committed
703
            compilationProgressMsg dflags $
704
            (showModuleIndex mod_index ++
Ian Lynagh's avatar
Ian Lynagh committed
705
            msg ++ showModMsg dflags (hscTarget dflags)
706 707
                              (recompileRequired recomp) mod_summary)
                ++ reason
708

709 710 711
--------------------------------------------------------------
-- FrontEnds
--------------------------------------------------------------
712 713

hscFileFrontEnd :: ModSummary -> Hsc TcGblEnv
714
hscFileFrontEnd mod_summary = do
715
    hpm <- hscParse' mod_summary
716
    hsc_env <- getHscEnv
717 718
    tcg_env <- tcRnModule' hsc_env mod_summary False hpm
    return tcg_env
719 720

--------------------------------------------------------------
721
-- Safe Haskell
722 723
--------------------------------------------------------------

724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
-- 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.


744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
-- 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
764
    tcg_env' <- checkSafeImports dflags tcg_env
765 766 767
    case safeLanguageOn dflags of
        True -> do
            -- we nuke user written RULES in -XSafe
Ian Lynagh's avatar
Ian Lynagh committed
768
            logWarnings $ warns dflags (tcg_rules tcg_env')
769 770 771 772 773
            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
774
            -> wipeTrust tcg_env' $ warns dflags (tcg_rules tcg_env')
775

776
              -- trustworthy OR safe inferred with no RULES
777 778 779
            | otherwise
            -> return tcg_env'

dterei's avatar
dterei committed
780
  where
Ian Lynagh's avatar
Ian Lynagh committed
781 782 783
    warns dflags rules = listToBag $ map (warnRules dflags) rules
    warnRules dflags (L loc (HsRule n _ _ _ _ _ _)) =
        mkPlainWarnMsg dflags loc $
dterei's avatar
dterei committed
784 785
            text "Rule \"" <> ftext n <> text "\" ignored" $+$
            text "User defined rules are disabled under Safe Haskell"
786

787 788 789 790 791 792
-- | 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.
793
--
794 795 796 797 798
-- 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].
799 800
checkSafeImports :: DynFlags -> TcGblEnv -> Hsc TcGblEnv
checkSafeImports dflags tcg_env
801
    = do
802 803 804 805 806
        -- 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

807
        imps <- mapM condense imports'
808
        pkgs <- mapM checkSafe imps
dterei's avatar
dterei committed
809 810 811 812 813 814

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

815
        -- See the Note [Safe Haskell Inference]
dterei's avatar
dterei committed
816 817 818 819 820 821
        case (not $ isEmptyBag errs) of

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

dterei's avatar
dterei committed
825 826
            -- All good matey!
            False -> do
827
                when (packageTrustOn dflags) $ checkPkgTrust dflags pkg_reqs
dterei's avatar
dterei committed
828 829 830
                -- add in trusted package requirements for this module
                let new_trust = emptyImportAvails { imp_trust_pkgs = catMaybes pkgs }
                return tcg_env { tcg_imports = imp_info `plusImportAvails` new_trust }
831

dterei's avatar
dterei committed
832 833 834 835 836 837 838 839 840
  where
    imp_info = tcg_imports tcg_env     -- ImportAvails
    imports  = imp_mods imp_info       -- ImportedMods
    imports' = moduleEnvToList imports -- (Module, [ImportedModsVal])
    pkg_reqs = imp_trust_pkgs imp_info -- [PackageId]

    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
841 842 843 844
                            -- we turn all imports into safe ones when
                            -- inference mode is on.
                            let s' = if safeInferOn dflags then True else s
                            return (m, l, s')
dterei's avatar
dterei committed
845

dterei's avatar
dterei committed
846 847 848 849
    -- 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
850
        = throwErrors $ unitBag $ mkPlainErrMsg dflags l1
dterei's avatar
dterei committed
851 852 853 854
              (text "Module" <+> ppr m1 <+>
              (text $ "is imported both as a safe and unsafe import!"))
        | otherwise
        = return v1
855 856 857
    
    -- easier interface to work with
    checkSafe (_, _, False) = return Nothing
dterei's avatar
dterei committed
858
    checkSafe (m, l, True ) = fst `fmap` hscCheckSafe' dflags m l
dterei's avatar
dterei committed
859

860 861
-- | Check that a module is safe to import.
--
dterei's avatar
dterei committed
862 863 864
-- 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
865 866
hscCheckSafe hsc_env m l = runHsc hsc_env $ do
    dflags <- getDynFlags
dterei's avatar
dterei committed
867 868 869 870
    pkgs <- snd `fmap` hscCheckSafe' dflags m l
    when (packageTrustOn dflags) $ checkPkgTrust dflags pkgs
    errs <- getWarnings
    return $ isEmptyBag errs
871

dterei's avatar
dterei committed
872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
-- | Return if a module is trusted and the pkgs it depends on to be trusted.
hscGetSafe :: HscEnv -> Module -> SrcSpan -> IO (Bool, [PackageId])
hscGetSafe hsc_env m l = runHsc hsc_env $ do
    dflags       <- getDynFlags
    (self, pkgs) <- hscCheckSafe' dflags m l
    good         <- isEmptyBag `fmap` getWarnings
    clearWarnings -- don't want them printed...
    let pkgs' | Just p <- self = p:pkgs
              | otherwise      = pkgs
    return (good, pkgs')
 
-- | Is a module trusted? If not, throw or log errors depending on the type.
-- Return (regardless of trusted or not) if the trust type requires the modules
-- own package be trusted and a list of other packages required to be trusted
-- (these later ones haven't been checked) but the own package trust has been.
dterei's avatar
dterei committed
887
hscCheckSafe' :: DynFlags -> Module -> SrcSpan -> Hsc (Maybe PackageId, [PackageId])
888
hscCheckSafe' dflags m l = do
dterei's avatar
dterei committed
889
    (tw, pkgs) <- isModSafe m l
890
    case tw of
dterei's avatar
dterei committed
891 892 893
        False              -> return (Nothing, pkgs)
        True | isHomePkg m -> return (Nothing, pkgs)
             | otherwise   -> return (Just $ modulePackageId m, pkgs)
894
  where
dterei's avatar
dterei committed
895
    isModSafe :: Module -> SrcSpan -> Hsc (Bool, [PackageId])
dterei's avatar
dterei committed
896 897 898 899
    isModSafe m l = do
        iface <- lookup' m
        case iface of
            -- can't load iface to check trust!
Ian Lynagh's avatar
Ian Lynagh committed
900
            Nothing -> throwErrors $ unitBag $ mkPlainErrMsg dflags l
901 902
                         $ text "Can't load the interface file for" <+> ppr m
                           <> text ", to check that it can be safely imported"
dterei's avatar
dterei committed
903 904

            -- got iface, check trust
905
            Just iface' ->
dterei's avatar
dterei committed
906 907 908
                let trust = getSafeMode $ mi_trust iface'
                    trust_own_pkg = mi_trust_pkg iface'
                    -- check module is trusted
909
                    safeM = trust `elem` [Sf_SafeInferred, Sf_Safe, Sf_Trustworthy]
dterei's avatar
dterei committed
910 911
                    -- check package is trusted
                    safeP = packageTrusted trust trust_own_pkg m
dterei's avatar
dterei committed
912 913
                    -- pkg trust reqs
                    pkgRs = map fst $ filter snd $ dep_pkgs $ mi_deps iface'
dterei's avatar
dterei committed
914
                    -- General errors we throw but Safe errors we log
915 916 917 918 919 920 921
                    errs = case (safeM, safeP) of
                        (True, True ) -> emptyBag
                        (True, False) -> pkgTrustErr
                        (False, _   ) -> modTrustErr
                in do
                    logWarnings errs
                    return (trust == Sf_Trustworthy, pkgRs)
dterei's avatar
dterei committed
922 923

                where
924
                    pkgTrustErr = unitBag $ mkPlainErrMsg dflags l $
925 926
                        sep [ ppr (moduleName m)
                                <> text ": Can't be safely imported!"
927
                            , text "The package (" <> ppr (modulePackageId m)
928
                                <> text ") the module resides in isn't trusted."
929
                            ]
Ian Lynagh's avatar
Ian Lynagh committed
930
                    modTrustErr = unitBag $ mkPlainErrMsg dflags l $
931 932
                        sep [ ppr (moduleName m)
                                <> text ": Can't be safely imported!"
933
                            , text "The module itself isn't safe." ]
dterei's avatar
dterei committed
934

935 936 937 938
    -- | Check the package a module resides in is trusted. Safe compiled
    -- modules are trusted without requiring that their package is trusted. For
    -- trustworthy modules, modules in the home package are trusted but
    -- otherwise we check the package trust flag.
939
    packageTrusted :: SafeHaskellMode -> Bool -> Module -> Bool
dterei's avatar
dterei committed
940 941
    packageTrusted Sf_None             _ _ = False -- shouldn't hit these cases
    packageTrusted Sf_Unsafe           _ _ = False -- prefer for completeness.
942
    packageTrusted _ _ _
943 944 945
        | not (packageTrustOn dflags)      = True
    packageTrusted Sf_Safe         False _ = True
    packageTrusted Sf_SafeInferred False _ = True
946 947 948 949
    packageTrusted _ _ m
        | isHomePkg m = True
        | otherwise   = trusted $ getPackageDetails (pkgState dflags)
                                                    (modulePackageId m)
dterei's avatar
dterei committed
950

951 952 953 954 955 956 957
    lookup' :: Module -> Hsc (Maybe ModIface)
    lookup' m = do
        hsc_env <- getHscEnv
        hsc_eps <- liftIO $ hscEPS hsc_env
        let pkgIfaceT = eps_PIT hsc_eps
            homePkgT  = hsc_HPT hsc_env
            iface     = lookupIfaceByModule dflags homePkgT pkgIfaceT m
dterei's avatar
dterei committed
958 959 960 961 962 963 964 965 966
#ifdef GHCI
        -- the 'lookupIfaceByModule' method will always fail when calling from GHCi
        -- as the compiler hasn't filled in the various module tables
        -- so we need to call 'getModuleInterface' to load from disk
        iface' <- case iface of
            Just _  -> return iface
            Nothing -> snd `fmap` (liftIO $ getModuleInterface hsc_env m)
        return iface'
#else 
967
        return iface
dterei's avatar
dterei committed
968 969
#endif

970 971 972 973 974

    isHomePkg :: Module -> Bool
    isHomePkg m
        | thisPackage dflags == modulePackageId m = True
        | otherwise                               = False
975

976 977 978 979 980 981 982 983 984 985 986 987
-- | Check the list of packages are trusted.
checkPkgTrust :: DynFlags -> [PackageId] -> Hsc ()
checkPkgTrust dflags pkgs =
    case errors of
        [] -> return ()
        _  -> (liftIO . throwIO . mkSrcErr . listToBag) errors
    where
        errors = catMaybes $ map go pkgs
        go pkg
            | trusted $ getPackageDetails (pkgState dflags) pkg
            = Nothing
            | otherwise
Ian Lynagh's avatar
Ian Lynagh committed
988
            = Just $ mkPlainErrMsg dflags noSrcSpan