HscMain.hs 69.2 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
71
    , hscStmt, hscStmtWithLocation, hscParsedStmt
72
    , hscDecls, hscDeclsWithLocation
vivian's avatar
vivian committed
73
    , hscTcExpr, hscImport, hscKcType
74
    , hscParseExpr
75
    , hscCompileCoreExpr
76 77
    -- * Low-level exports for hooks
    , hscCompileCoreExpr'
78
#endif
Edsko de Vries's avatar
Edsko de Vries committed
79 80
      -- We want to make sure that we export enough to be able to redefine
      -- hscFileFrontEnd in client code
81
    , hscParse', hscSimplify', hscDesugar', tcRnModule'
Edsko de Vries's avatar
Edsko de Vries committed
82
    , getHscEnv
83 84 85
    , hscSimpleIface', hscNormalIface'
    , oneShotMsg
    , hscFileFrontEnd, genericHscFrontend, dumpIfaceStats
86
    ) where
87

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

import GHC.Exts
101 102
#endif

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

144
import DynFlags
145
import ErrUtils
146

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

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

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

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

169

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

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

192

193
-- -----------------------------------------------------------------------------
194

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

402 403 404
    -- 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)
405
    dflags   <- getDynFlags
406
    let allSafeOK = safeInferred dflags && tcSafeOK
407

408 409 410
    -- 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
411
        then markUnsafeInfer tcg_res whyUnsafe
412

413
        -- module (could be) safe, throw warning if needed
414 415
        else do
            tcg_res' <- hscCheckSafeImports tcg_res
416
            safe <- liftIO $ fst <$> readIORef (tcg_safeInfer tcg_res')
417 418 419 420 421 422 423 424 425
            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 ()
426 427 428
            return tcg_res'
  where
    pprMod t  = ppr $ moduleName $ tcg_mod t
429
    errSafe t = quotes (pprMod t) <+> text "has been inferred as safe!"
430 431
    errTwthySafe t = quotes (pprMod t)
      <+> text "is marked as Trustworthy but has been inferred as safe!"
432

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

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

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

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

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

468

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

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

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

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


512 513 514 515 516 517 518 519 520 521 522 523 524
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
525 526 527
genericHscCompileGetFrontendResult
  always_do_basic_recompilation_check m_tc_result
  mHscMessage hsc_env mod_summary source_modified mb_old_iface mod_index
528 529 530 531 532
    = do

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

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

538 539 540 541
        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
542 543 544 545

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

547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
    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
563 564 565 566 567 568 569 570 571 572 573 574 575
                    -- 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.
576 577 578 579 580 581 582 583 584 585 586 587 588
                    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
589 590 591 592
genericHscFrontend mod_summary =
  getHooked hscFrontendHook genericHscFrontend' >>= ($ mod_summary)

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

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

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

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

619 620 621 622
        msg what = oneShotMsg hsc_env' what

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

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

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

658 659 660 661 662 663 664
    (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
665

666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
    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
683

684 685 686 687
--------------------------------------------------------------
-- NoRecomp handlers
--------------------------------------------------------------

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

696 697 698 699
--------------------------------------------------------------
-- Progress displayers.
--------------------------------------------------------------

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

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

726 727 728
--------------------------------------------------------------
-- FrontEnds
--------------------------------------------------------------
729 730

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

--------------------------------------------------------------
738
-- Safe Haskell
739 740
--------------------------------------------------------------

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


761 762 763 764 765 766 767 768 769 770 771
-- 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.
772 773 774
--
-- 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
775 776
-- to allow users to set the `-fwarn-safe`, `-fwarn-unsafe` and
-- `-fwarn-trustworthy-safe` flags on Trustworthy and Unsafe modules so that a
777 778 779 780 781 782 783
-- 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.
784 785 786 787 788 789 790 791 792


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

dterei's avatar
dterei committed
796
  where
797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
    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
812 813 814
    warns dflags rules = listToBag $ map (warnRules dflags) rules
    warnRules dflags (L loc (HsRule n _ _ _ _ _ _)) =
        mkPlainWarnMsg dflags loc $
815
            text "Rule \"" <> ftext (snd $ unLoc n) <> text "\" ignored" $+$
dterei's avatar
dterei committed
816
            text "User defined rules are disabled under Safe Haskell"
817

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

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

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

846
        -- Check non-safe imports are correct if inferring safety
847
        -- See the Note [Safe Haskell Inference]
848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
        (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 }
871

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

    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
881
                            return (m, l, s)
dterei's avatar
dterei committed
882

dterei's avatar
dterei committed
883 884 885 886
    -- 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
887
        = throwErrors $ unitBag $ mkPlainErrMsg dflags l1
dterei's avatar
dterei committed
888 889 890 891
              (text "Module" <+> ppr m1 <+>
              (text $ "is imported both as a safe and unsafe import!"))
        | otherwise
        = return v1
Jan Stolarek's avatar
Jan Stolarek committed
892

893
    -- easier interface to work with
894 895 896 897 898 899 900 901 902 903 904
    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
905

906 907
-- | Check that a module is safe to import.
--