HscMain.hs 75.4 KB
Newer Older
1
{-# LANGUAGE BangPatterns, CPP, MagicHash, NondecreasingIndentation #-}
Simon Marlow's avatar
Simon Marlow committed
2
{-# OPTIONS_GHC -fprof-auto-top #-}
3

dterei's avatar
dterei committed
4 5
-------------------------------------------------------------------------------
--
6
-- | Main API for compiling plain Haskell source code.
7
--
dterei's avatar
dterei committed
8
-- This module implements compilation of a Haskell source. It is
9 10 11 12 13
-- /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
14
-- "interactive" mode (GHCi). There are also entry points for
15 16 17 18 19 20 21 22
-- 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).
--
23 24 25 26 27
-- We use the Hsc monad to deal with warning messages consistently:
-- specifically, while executing within an Hsc monad, warnings are
-- collected. When a Hsc monad returns to an IO monad, the
-- warnings are printed, or compilation aborts if the @-Werror@
-- flag is enabled.
28
--
dterei's avatar
dterei committed
29 30 31 32
-- (c) The GRASP/AQUA Project, Glasgow University, 1993-2000
--
-------------------------------------------------------------------------------

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

    -- * Compiling complete source files
39 40
    , Messager, batchMsg
    , HscStatus (..)
41
    , hscIncrementalCompile
42 43
    , hscCompileCmmFile

44 45 46
    , hscGenHardCode
    , hscInteractive

47
    -- * Running passes separately
Thomas Schilling's avatar
Thomas Schilling committed
48 49 50
    , hscParse
    , hscTypecheckRename
    , hscDesugar
Simon Marlow's avatar
Simon Marlow committed
51
    , makeSimpleDetails
52 53
    , hscSimplify -- ToDo, shouldn't really export this

54 55 56 57
    -- * Safe Haskell
    , hscCheckSafe
    , hscGetSafe

58 59 60 61
    -- * Support for interactive evaluation
    , hscParseIdentifier
    , hscTcRcLookupName
    , hscTcRnGetInfo
dterei's avatar
dterei committed
62
    , hscIsGHCiMonad
63
    , hscGetModuleInterface
64
    , hscRnImportDecls
65
    , hscTcRnLookupRdrName
66
    , hscStmt, hscStmtWithLocation, hscParsedStmt
67
    , hscDecls, hscDeclsWithLocation
68
    , hscTcExpr, TcRnExprMode(..), hscImport, hscKcType
69
    , hscParseExpr
70
    , hscCompileCoreExpr
71 72
    -- * Low-level exports for hooks
    , hscCompileCoreExpr'
Edsko de Vries's avatar
Edsko de Vries committed
73 74
      -- We want to make sure that we export enough to be able to redefine
      -- hscFileFrontEnd in client code
75
    , hscParse', hscSimplify', hscDesugar', tcRnModule'
Edsko de Vries's avatar
Edsko de Vries committed
76
    , getHscEnv
77 78 79
    , hscSimpleIface', hscNormalIface'
    , oneShotMsg
    , hscFileFrontEnd, genericHscFrontend, dumpIfaceStats
Edward Z. Yang's avatar
Edward Z. Yang committed
80 81
    , ioMsgMaybe
    , showModuleIndex
82
    , hscAddSptEntries
83
    ) where
84

85 86
import GhcPrelude

87
import Data.Data hiding (Fixity, TyCon)
88
import Data.Maybe       ( isJust, fromMaybe )
89
import DynFlags         (addPluginModuleName)
Simon Marlow's avatar
Simon Marlow committed
90
import Id
91
import GHCi             ( addSptEntry )
92
import GHCi.RemoteTypes ( ForeignHValue )
93
import ByteCodeGen      ( byteCodeGen, coreExprToBCOs )
94
import Linker
95
import CoreTidy         ( tidyExpr )
96 97
import Type             ( Type )
import {- Kind parts of -} Type         ( Kind )
98
import CoreLint         ( lintInteractiveExpr )
99
import VarEnv           ( emptyTidyEnv )
100
import Panic
101
import ConLike
102
import Control.Concurrent
103

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

149
import DynFlags
150
import ErrUtils
151
import Platform ( platformOS, osSubsectionsViaSymbols )
152

153
import Outputable
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
154
import NameEnv
155
import HscStats         ( ppSourceStats )
156
import HscTypes
157
import FastString
158
import UniqSupply
159
import Bag
Thomas Schilling's avatar
Thomas Schilling committed
160
import Exception
161 162 163
import qualified Stream
import Stream (Stream)

164
import Util
Simon Marlow's avatar
Simon Marlow committed
165

166
import Data.List
Simon Marlow's avatar
Simon Marlow committed
167 168
import Control.Monad
import Data.IORef
169
import System.FilePath as FilePath
170
import System.Directory
171
import System.IO (fixIO)
Alan Zimmerman's avatar
Alan Zimmerman committed
172
import qualified Data.Map as Map
173 174
import qualified Data.Set as S
import Data.Set (Set)
dterei's avatar
dterei committed
175

Thomas Schilling's avatar
Thomas Schilling committed
176
#include "HsVersions.h"
177

178

dterei's avatar
dterei committed
179 180 181 182 183
{- **********************************************************************
%*                                                                      *
                Initialisation
%*                                                                      *
%********************************************************************* -}
184

185
newHscEnv :: DynFlags -> IO HscEnv
186
newHscEnv dflags = do
dterei's avatar
dterei committed
187 188
    eps_var <- newIORef initExternalPackageState
    us      <- mkSplitUniqSupply 'r'
189
    nc_var  <- newIORef (initNameCache us knownKeyNames)
190
    fc_var  <- newIORef emptyInstalledModuleEnv
191 192 193
    iserv_mvar <- newMVar Nothing
    return HscEnv {  hsc_dflags       = dflags
                  ,  hsc_targets      = []
194
                  ,  hsc_mod_graph    = emptyMG
195 196 197 198 199 200 201 202
                  ,  hsc_IC           = emptyInteractiveContext dflags
                  ,  hsc_HPT          = emptyHomePackageTable
                  ,  hsc_EPS          = eps_var
                  ,  hsc_NC           = nc_var
                  ,  hsc_FC           = fc_var
                  ,  hsc_type_env_var = Nothing
                  , hsc_iserv        = iserv_mvar
                  }
Thomas Schilling's avatar
Thomas Schilling committed
203

204
-- -----------------------------------------------------------------------------
205

206
getWarnings :: Hsc WarningMessages
dterei's avatar
dterei committed
207
getWarnings = Hsc $ \_ w -> return (w, w)
208 209

clearWarnings :: Hsc ()
dterei's avatar
dterei committed
210
clearWarnings = Hsc $ \_ _ -> return ((), emptyBag)
211 212

logWarnings :: WarningMessages -> Hsc ()
dterei's avatar
dterei committed
213
logWarnings w = Hsc $ \_ w0 -> return ((), w0 `unionBags` w)
214 215

getHscEnv :: Hsc HscEnv
dterei's avatar
dterei committed
216
getHscEnv = Hsc $ \e w -> return (e, w)
217 218 219

handleWarnings :: Hsc ()
handleWarnings = do
dterei's avatar
dterei committed
220 221 222 223
    dflags <- getDynFlags
    w <- getWarnings
    liftIO $ printOrThrowWarnings dflags w
    clearWarnings
224 225 226 227 228

-- | 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
229 230
    logWarnings warns
    when (not $ isEmptyBag errs) $ throwErrors errs
231 232 233 234

-- | Throw some errors.
throwErrors :: ErrorMessages -> Hsc a
throwErrors = liftIO . throwIO . mkSrcErr
235 236 237 238 239

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

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

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

271
hscTcRnLookupRdrName :: HscEnv -> Located RdrName -> IO [Name]
272 273
hscTcRnLookupRdrName hsc_env0 rdr_name
  = runInteractiveHsc hsc_env0 $
274 275
    do { hsc_env <- getHscEnv
       ; ioMsgMaybe $ tcRnLookupRdrName hsc_env rdr_name }
276 277

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

285 286
hscTcRnGetInfo :: HscEnv -> Name
               -> IO (Maybe (TyThing, Fixity, [ClsInst], [FamInst], SDoc))
287 288 289 290
hscTcRnGetInfo hsc_env0 name
  = runInteractiveHsc hsc_env0 $
    do { hsc_env <- getHscEnv
       ; ioMsgMaybe' $ tcRnGetInfo hsc_env name }
291

dterei's avatar
dterei committed
292
hscIsGHCiMonad :: HscEnv -> String -> IO Name
Edsko de Vries's avatar
Edsko de Vries committed
293
hscIsGHCiMonad hsc_env name
294
  = runHsc hsc_env $ ioMsgMaybe $ isGHCiMonad hsc_env name
dterei's avatar
dterei committed
295

296
hscGetModuleInterface :: HscEnv -> Module -> IO ModIface
297 298 299
hscGetModuleInterface hsc_env0 mod = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe $ getModuleInterface hsc_env mod
300 301 302

-- -----------------------------------------------------------------------------
-- | Rename some import declarations
303
hscRnImportDecls :: HscEnv -> [LImportDecl GhcPs] -> IO GlobalRdrEnv
304 305 306
hscRnImportDecls hsc_env0 import_decls = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe $ tcRnImportDecls hsc_env import_decls
307

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

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

-- internal version, that doesn't fail due to -Werror
315
hscParse' :: ModSummary -> Hsc HsParsedModule
Edward Z. Yang's avatar
Edward Z. Yang committed
316 317 318
hscParse' mod_summary
 | Just r <- ms_parsed_mod mod_summary = return r
 | otherwise = {-# SCC "Parser" #-}
319 320 321
    withTiming getDynFlags
               (text "Parser"<+>brackets (ppr $ ms_mod mod_summary))
               (const ()) $ do
dterei's avatar
dterei committed
322 323 324
    dflags <- getDynFlags
    let src_filename  = ms_hspp_file mod_summary
        maybe_src_buf = ms_hspp_buf  mod_summary
325

dterei's avatar
dterei committed
326
    --------------------------  Parser  ----------------
327 328 329
    -- 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
330 331 332
    buf <- case maybe_src_buf of
               Just b  -> return b
               Nothing -> liftIO $ hGetStringBuffer src_filename
333

dterei's avatar
dterei committed
334
    let loc = mkRealSrcLoc (mkFastString src_filename) 1 1
Edward Z. Yang's avatar
Edward Z. Yang committed
335 336 337
    let parseMod | HsigFile == ms_hsc_src mod_summary
                 = parseSignature
                 | otherwise = parseModule
338

Edward Z. Yang's avatar
Edward Z. Yang committed
339
    case unP parseMod (mkPState dflags buf loc) of
340 341 342
        PFailed warnFn span err -> do
            logWarningsReportErrors (warnFn dflags)
            handleWarnings
Ian Lynagh's avatar
Ian Lynagh committed
343
            liftIO $ throwOneError (mkPlainErrMsg dflags span err)
344

dterei's avatar
dterei committed
345
        POk pst rdr_module -> do
346
            logWarningsReportErrors (getMessages pst dflags)
dterei's avatar
dterei committed
347 348
            liftIO $ dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" $
                                   ppr rdr_module
349
            liftIO $ dumpIfSet_dyn dflags Opt_D_dump_parsed_ast "Parser AST" $
350
                                   showAstData NoBlankSrcSpan rdr_module
dterei's avatar
dterei committed
351 352
            liftIO $ dumpIfSet_dyn dflags Opt_D_source_stats "Source Statistics" $
                                   ppSourceStats False rdr_module
353 354 355 356 357

            -- 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>"
Gabor Greif's avatar
Gabor Greif committed
358
            --   - normalise them (eliminate differences between ./f and f)
359 360 361 362 363 364 365 366 367
            --   - 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
Gabor Greif's avatar
Gabor Greif committed
368
                            $ filter (not . isPrefixOf "<")
369 370 371 372 373 374
                            $ map unpackFS
                            $ srcfiles pst
                srcs1 = case ml_hs_file (ms_location mod_summary) of
                          Just f  -> filter (/= FilePath.normalise f) srcs0
                          Nothing -> srcs0

375 376 377 378 379
            -- sometimes we see source files from earlier
            -- preprocessing stages that cannot be found, so just
            -- filter them out:
            srcs2 <- liftIO $ filterM doesFileExist srcs1

380
            let res = HsParsedModule {
381
                      hpm_module    = rdr_module,
Alan Zimmerman's avatar
Alan Zimmerman committed
382 383 384 385 386
                      hpm_src_files = srcs2,
                      hpm_annotations
                              = (Map.fromListWith (++) $ annotations pst,
                                 Map.fromList $ ((noSrcSpan,comment_q pst)
                                                 :(annotations_comments pst)))
387
                   }
Simon Marlow's avatar
Simon Marlow committed
388

389 390 391 392 393
            -- apply parse transformation of plugins
            let applyPluginAction p opts
                  = parsedResultAction p opts mod_summary
            withPlugins dflags applyPluginAction res

Thomas Schilling's avatar
Thomas Schilling committed
394 395 396
-- 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
397
type RenamedStuff =
alexbiehl's avatar
alexbiehl committed
398
        (Maybe (HsGroup GhcRn, [LImportDecl GhcRn], Maybe [(LIE GhcRn, Avails)],
399
                Maybe LHsDocString))
Simon Marlow's avatar
Simon Marlow committed
400

401 402 403 404
-- -----------------------------------------------------------------------------
-- | If the renamed source has been kept, extract it. Dump it if requested.
extract_renamed_stuff :: TcGblEnv -> Hsc (TcGblEnv, RenamedStuff)
extract_renamed_stuff tc_result = do
405
    let rn_info = get_renamed_stuff tc_result
Thomas Schilling's avatar
Thomas Schilling committed
406

407 408 409 410
    dflags <- getDynFlags
    liftIO $ dumpIfSet_dyn dflags Opt_D_dump_rn_ast "Renamer" $
                           showAstData NoBlankSrcSpan rn_info

411
    return (tc_result, rn_info)
Simon Marlow's avatar
Simon Marlow committed
412

413 414 415 416 417 418
-- | Extract the renamed information from TcGblEnv.
get_renamed_stuff :: TcGblEnv -> RenamedStuff
get_renamed_stuff tc_result
  = fmap (\decls -> ( decls, tcg_rn_imports tc_result
                    , tcg_rn_exports tc_result, tcg_doc_hdr tc_result ) )
         (tcg_rn_decls tc_result)
419 420 421 422 423 424

-- -----------------------------------------------------------------------------
-- | Rename and typecheck a module, additionally returning the renamed syntax
hscTypecheckRename :: HscEnv -> ModSummary -> HsParsedModule
                   -> IO (TcGblEnv, RenamedStuff)
hscTypecheckRename hsc_env mod_summary rdr_module = runHsc hsc_env $ do
425 426
      tc_result <- hscTypecheck True mod_summary (Just rdr_module)
      extract_renamed_stuff tc_result
427

Edward Z. Yang's avatar
Edward Z. Yang committed
428 429 430 431
hscTypecheck :: Bool -- ^ Keep renamed source?
             -> ModSummary -> Maybe HsParsedModule
             -> Hsc TcGblEnv
hscTypecheck keep_rn mod_summary mb_rdr_module = do
432 433 434 435 436 437 438 439 440
    tc_result <- hscTypecheck' keep_rn mod_summary mb_rdr_module
    _ <- extract_renamed_stuff tc_result
    return tc_result


hscTypecheck' :: Bool -- ^ Keep renamed source?
              -> ModSummary -> Maybe HsParsedModule
              -> Hsc TcGblEnv
hscTypecheck' keep_rn mod_summary mb_rdr_module = do
Edward Z. Yang's avatar
Edward Z. Yang committed
441 442 443 444
    hsc_env <- getHscEnv
    let hsc_src = ms_hsc_src mod_summary
        dflags = hsc_dflags hsc_env
        outer_mod = ms_mod mod_summary
445 446 447
        mod_name = moduleName outer_mod
        outer_mod' = mkModule (thisPackage dflags) mod_name
        inner_mod = canonicalizeHomeModule dflags mod_name
Edward Z. Yang's avatar
Edward Z. Yang committed
448 449 450 451
        src_filename  = ms_hspp_file mod_summary
        real_loc = realSrcLocSpan $ mkRealSrcLoc (mkFastString src_filename) 1 1
    MASSERT( moduleUnitId outer_mod == thisPackage dflags )
    if hsc_src == HsigFile && not (isHoleModule inner_mod)
452
        then ioMsgMaybe $ tcRnInstantiateSignature hsc_env outer_mod' real_loc
Edward Z. Yang's avatar
Edward Z. Yang committed
453 454 455 456
        else
         do hpm <- case mb_rdr_module of
                    Just hpm -> return hpm
                    Nothing -> hscParse' mod_summary
457
            tc_result0 <- tcRnModule' mod_summary keep_rn hpm
Edward Z. Yang's avatar
Edward Z. Yang committed
458 459 460
            if hsc_src == HsigFile
                then do (iface, _, _) <- liftIO $ hscSimpleIface hsc_env tc_result0 Nothing
                        ioMsgMaybe $
461
                            tcRnMergeSignatures hsc_env hpm tc_result0 iface
Edward Z. Yang's avatar
Edward Z. Yang committed
462 463
                else return tc_result0

464
-- wrapper around tcRnModule to handle safe haskell extras
465
tcRnModule' :: ModSummary -> Bool -> HsParsedModule
466
            -> Hsc TcGblEnv
467 468
tcRnModule' sum save_rn_syntax mod = do
    hsc_env <- getHscEnv
469 470 471 472 473 474
    dflags   <- getDynFlags

    -- check if plugins need the renamed syntax
    let plugin_needs_rn = any (isJust . renamedResultAction . lpPlugin)
                              (plugins dflags)

475 476
    tcg_res <- {-# SCC "Typecheck-Rename" #-}
               ioMsgMaybe $
477 478
                   tcRnModule hsc_env (ms_hsc_src sum)
                     (save_rn_syntax || plugin_needs_rn) mod
479

480 481 482
    -- 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)
483
    let allSafeOK = safeInferred dflags && tcSafeOK
484

485
    -- end of the safe haskell line, how to respond to user?
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
    res <- if not (safeHaskellOn dflags)
                || (safeInferOn dflags && not allSafeOK)
             -- if safe Haskell off or safe infer failed, mark unsafe
             then markUnsafeInfer tcg_res whyUnsafe

             -- module (could be) safe, throw warning if needed
             else do
                 tcg_res' <- hscCheckSafeImports tcg_res
                 safe <- liftIO $ fst <$> readIORef (tcg_safeInfer tcg_res')
                 when safe $ do
                   case wopt Opt_WarnSafe dflags of
                     True -> (logWarnings $ unitBag $
                              makeIntoWarning (Reason Opt_WarnSafe) $
                              mkPlainWarnMsg dflags (warnSafeOnLoc dflags) $
                              errSafe tcg_res')
                     False | safeHaskell dflags == Sf_Trustworthy &&
                             wopt Opt_WarnTrustworthySafe dflags ->
                             (logWarnings $ unitBag $
                              makeIntoWarning (Reason Opt_WarnTrustworthySafe) $
                              mkPlainWarnMsg dflags (trustworthyOnLoc dflags) $
                              errTwthySafe tcg_res')
                     False -> return ()
                 return tcg_res'

    -- apply plugins to the type checking result
    let unsafeText = "Use of plugins makes the module unsafe"
        pluginUnsafe = unitBag ( mkPlainWarnMsg dflags noSrcSpan
                                   (Outputable.text unsafeText) )

    case get_renamed_stuff res of
      Just rn ->
        withPlugins_ dflags
                     (\p opts -> (fromMaybe (\_ _ _ -> return ())
                                            (renamedResultAction p)) opts sum)
                     rn
      Nothing -> return ()

    res' <- withPlugins dflags
                        (\p opts -> typeCheckResultAction p opts sum
                                      >=> flip markUnsafeInfer pluginUnsafe)
                        res
    return res'
528 529
  where
    pprMod t  = ppr $ moduleName $ tcg_mod t
530
    errSafe t = quotes (pprMod t) <+> text "has been inferred as safe!"
531 532
    errTwthySafe t = quotes (pprMod t)
      <+> text "is marked as Trustworthy but has been inferred as safe!"
533

Simon Marlow's avatar
Simon Marlow committed
534
-- | Convert a typechecked module to Core
535
hscDesugar :: HscEnv -> ModSummary -> TcGblEnv -> IO ModGuts
536
hscDesugar hsc_env mod_summary tc_result =
Ian Lynagh's avatar
Ian Lynagh committed
537
    runHsc hsc_env $ hscDesugar' (ms_location mod_summary) tc_result
538

Ian Lynagh's avatar
Ian Lynagh committed
539 540
hscDesugar' :: ModLocation -> TcGblEnv -> Hsc ModGuts
hscDesugar' mod_location tc_result = do
dterei's avatar
dterei committed
541
    hsc_env <- getHscEnv
Simon Marlow's avatar
Simon Marlow committed
542 543
    r <- ioMsgMaybe $
      {-# SCC "deSugar" #-}
Ian Lynagh's avatar
Ian Lynagh committed
544
      deSugar hsc_env mod_location tc_result
545

dterei's avatar
dterei committed
546 547 548 549
    -- 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
550

dterei's avatar
dterei committed
551
-- | Make a 'ModDetails' from the results of typechecking. Used when
Simon Marlow's avatar
Simon Marlow committed
552
-- typechecking only, as opposed to full compilation.
553 554
makeSimpleDetails :: HscEnv -> TcGblEnv -> IO ModDetails
makeSimpleDetails hsc_env tc_result = mkBootModDetailsTc hsc_env tc_result
Simon Marlow's avatar
Simon Marlow committed
555

556

dterei's avatar
dterei committed
557 558 559 560 561 562 563
{- **********************************************************************
%*                                                                      *
                The main compiler pipeline
%*                                                                      *
%********************************************************************* -}

{-
564 565 566 567
                   --------------------------------
                        The compilation proper
                   --------------------------------

dterei's avatar
dterei committed
568
It's the task of the compilation proper to compile Haskell, hs-boot and core
Gabor Greif's avatar
Gabor Greif committed
569
files to either byte-code, hard-code (C, asm, LLVM, etc.) or to nothing at all
dterei's avatar
dterei committed
570 571 572 573
(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
574
targets byte-code.
dterei's avatar
dterei committed
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599

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


600 601
type Messager = HscEnv -> (Int,Int) -> RecompileRequired -> ModSummary -> IO ()

602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
-- | This function runs GHC's frontend with recompilation
-- avoidance. Specifically, it checks if recompilation is needed,
-- and if it is, it parses and typechecks the input module.
-- It does not write out the results of typechecking (See
-- compileOne and hscIncrementalCompile).
hscIncrementalFrontend :: Bool -- always do basic recompilation check?
                       -> Maybe TcGblEnv
                       -> Maybe Messager
                       -> ModSummary
                       -> SourceModified
                       -> Maybe ModIface  -- Old interface, if available
                       -> (Int,Int)       -- (i,n) = module i of n (for msgs)
                       -> Hsc (Either ModIface (FrontendResult, Maybe Fingerprint))

hscIncrementalFrontend
Simon Marlow's avatar
Simon Marlow committed
617
  always_do_basic_recompilation_check m_tc_result
618
  mHscMessage mod_summary source_modified mb_old_iface mod_index
619
    = do
620
    hsc_env <- getHscEnv
621 622 623 624

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

626
        skip iface = do
627
            liftIO $ msg UpToDate
628
            return $ Left iface
dterei's avatar
dterei committed
629

630
        compile mb_old_hash reason = do
631 632 633
            liftIO $ msg reason
            result <- genericHscFrontend mod_summary
            return $ Right (result, mb_old_hash)
dterei's avatar
dterei committed
634 635 636 637

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

639 640 641
    case m_tc_result of
         Just tc_result
          | not always_do_basic_recompilation_check ->
642
             return $ Right (FrontendTypecheck tc_result, Nothing)
643 644 645
         _ -> do
            (recomp_reqd, mb_checked_iface)
                <- {-# SCC "checkOldIface" #-}
646
                   liftIO $ checkOldIface hsc_env mod_summary
647 648 649 650 651 652 653 654
                                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
655 656 657 658 659 660 661 662 663 664 665 666 667
                    -- 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.
668 669 670 671 672 673 674 675 676 677
                    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 ->
678
                        return $ Right (FrontendTypecheck tc_result, mb_old_hash)
679

680
genericHscFrontend :: ModSummary -> Hsc FrontendResult
681 682 683
genericHscFrontend mod_summary =
  getHooked hscFrontendHook genericHscFrontend' >>= ($ mod_summary)

684 685 686
genericHscFrontend' :: ModSummary -> Hsc FrontendResult
genericHscFrontend' mod_summary
    = FrontendTypecheck `fmap` hscFileFrontEnd mod_summary
687

688 689 690 691
--------------------------------------------------------------
-- Compilers
--------------------------------------------------------------

Austin Seipp's avatar
Austin Seipp committed
692
-- Compile Haskell/boot in OneShot mode.
693 694 695 696 697 698 699 700 701 702 703 704 705
hscIncrementalCompile :: Bool
                      -> Maybe TcGblEnv
                      -> Maybe Messager
                      -> HscEnv
                      -> ModSummary
                      -> SourceModified
                      -> Maybe ModIface
                      -> (Int,Int)
                      -- HomeModInfo does not contain linkable, since we haven't
                      -- code-genned yet
                      -> IO (HscStatus, HomeModInfo)
hscIncrementalCompile always_do_basic_recompilation_check m_tc_result
    mHscMessage hsc_env' mod_summary source_modified mb_old_iface mod_index
706
  = do
Matthew Pickering's avatar
Matthew Pickering committed
707 708 709
    dflags <- initializePlugins hsc_env' (hsc_dflags hsc_env')
    let hsc_env'' = hsc_env' { hsc_dflags = dflags }

dterei's avatar
dterei committed
710 711
    -- One-shot mode needs a knot-tying mutable variable for interface
    -- files. See TcRnTypes.TcGblEnv.tcg_type_env_var.
712
    -- See also Note [hsc_type_env_var hack]
dterei's avatar
dterei committed
713 714
    type_env_var <- newIORef emptyNameEnv
    let mod = ms_mod mod_summary
Matthew Pickering's avatar
Matthew Pickering committed
715 716
        hsc_env | isOneShot (ghcMode (hsc_dflags hsc_env''))
                = hsc_env'' { hsc_type_env_var = Just (mod, type_env_var) }
717
                | otherwise
Matthew Pickering's avatar
Matthew Pickering committed
718
                = hsc_env''
719

720 721 722 723 724 725 726 727
    -- NB: enter Hsc monad here so that we don't bail out early with
    -- -Werror on typechecker warnings; we also want to run the desugarer
    -- to get those warnings too. (But we'll always exit at that point
    -- because the desugarer runs ioMsgMaybe.)
    runHsc hsc_env $ do
    e <- hscIncrementalFrontend always_do_basic_recompilation_check m_tc_result mHscMessage
            mod_summary source_modified mb_old_iface mod_index
    case e of
728 729
        -- We didn't need to do any typechecking; the old interface
        -- file on disk was good enough.
730
        Left iface -> do
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
            -- Knot tying!  See Note [Knot-tying typecheckIface]
            hmi <- liftIO . fixIO $ \hmi' -> do
                let hsc_env' =
                        hsc_env {
                            hsc_HPT = addToHpt (hsc_HPT hsc_env)
                                        (ms_mod_name mod_summary) hmi'
                        }
                -- NB: This result is actually not that useful
                -- in one-shot mode, since we're not going to do
                -- any further typechecking.  It's much more useful
                -- in make mode, since this HMI will go into the HPT.
                details <- genModDetails hsc_env' iface
                return HomeModInfo{
                    hm_details = details,
                    hm_iface = iface,
                    hm_linkable = Nothing }
            return (HscUpToDate, hmi)
        -- We finished type checking.  (mb_old_hash is the hash of
        -- the interface that existed on disk; it's possible we had
        -- to retypecheck but the resulting interface is exactly
        -- the same.)
752
        Right (FrontendTypecheck tc_result, mb_old_hash) ->
753
            finish mod_summary tc_result mb_old_hash
754 755 756 757 758

-- Runs the post-typechecking frontend (desugar and simplify),
-- and then generates and writes out the final interface. We want
-- to write the interface AFTER simplification so we can get
-- as up-to-date and good unfoldings and other info as possible
759
-- in the interface file.
760
finish :: ModSummary
761 762
       -> TcGblEnv
       -> Maybe Fingerprint
763
       -> Hsc (HscStatus, HomeModInfo)
764 765
finish summary tc_result mb_old_hash = do
  hsc_env <- getHscEnv
766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
  let dflags = hsc_dflags hsc_env
      target = hscTarget dflags
      hsc_src = ms_hsc_src summary
      should_desugar =
        ms_mod summary /= gHC_PRIM && hsc_src == HsSrcFile
      mk_simple_iface = do
        let hsc_status =
              case (target, hsc_src) of
                (HscNothing, _) -> HscNotGeneratingCode
                (_, HsBootFile) -> HscUpdateBoot
                (_, HsigFile) -> HscUpdateSig
                _ -> panic "finish"
        (iface, changed, details) <- liftIO $
          hscSimpleIface hsc_env tc_result mb_old_hash
        return (iface, changed, details, hsc_status)
  (iface, changed, details, hsc_status) <-
    -- we usually desugar even when we are not generating code, otherwise
    -- we would miss errors thrown by the desugaring (see #10600). The only
    -- exceptions are when the Module is Ghc.Prim or when
    -- it is not a HsSrcFile Module.
    if should_desugar
      then do
        desugared_guts0 <- hscDesugar' (ms_location summary) tc_result
        if target == HscNothing
          -- We are not generating code, so we can skip simplification
          -- and generate a simple interface.
          then mk_simple_iface
          else do
794 795
            plugins <- liftIO $ readIORef (tcg_th_coreplugins tc_result)
            desugared_guts <- hscSimplify' plugins desugared_guts0
796 797 798 799 800 801 802 803 804
            (iface, changed, details, cgguts) <-
              liftIO $ hscNormalIface hsc_env desugared_guts mb_old_hash
            return (iface, changed, details, HscRecomp cgguts summary)
      else mk_simple_iface
  liftIO $ hscMaybeWriteIface dflags iface changed summary
  return
    ( hsc_status
    , HomeModInfo
      {hm_details = details, hm_iface = iface, hm_linkable = Nothing})
805 806 807 808 809 810 811 812 813 814

hscMaybeWriteIface :: DynFlags -> ModIface -> Bool -> ModSummary -> IO ()
hscMaybeWriteIface dflags iface changed summary =
    let force_write_interface = gopt Opt_WriteInterface dflags
        write_interface = case hscTarget dflags of
                            HscNothing      -> False
                            HscInterpreted  -> False
                            _               -> True
    in when (write_interface || force_write_interface) $
            hscWriteIface dflags iface changed summary
815

816 817 818 819
--------------------------------------------------------------
-- NoRecomp handlers
--------------------------------------------------------------

820
-- NB: this must be knot-tied appropriately, see hscIncrementalCompile
821 822
genModDetails :: HscEnv -> ModIface -> IO ModDetails
genModDetails hsc_env old_iface
823
  = do
dterei's avatar
dterei committed
824
    new_details <- {-# SCC "tcRnIface" #-}
825
                   initIfaceLoad hsc_env (typecheckIface old_iface)
826
    dumpIfaceStats hsc_env
dterei's avatar
dterei committed
827
    return new_details
828

829 830 831 832
--------------------------------------------------------------
-- Progress displayers.
--------------------------------------------------------------

833 834
oneShotMsg :: HscEnv -> RecompileRequired -> IO ()
oneShotMsg hsc_env recomp =
dterei's avatar
dterei committed
835
    case recomp of
836
        UpToDate ->
837 838
            compilationProgressMsg (hsc_dflags hsc_env) $
                   "compilation IS NOT required"
839
        _ ->
840 841
            return ()

842 843
batchMsg :: Messager
batchMsg hsc_env mod_index recomp mod_summary =
dterei's avatar
dterei committed
844
    case recomp of
845 846 847
        MustCompile -> showMsg "Compiling " ""
        UpToDate
            | verbosity (hsc_dflags hsc_env) >= 2 -> showMsg "Skipping  " ""
dterei's avatar
dterei committed
848
            | otherwise -> return ()
849
        RecompBecause reason -> showMsg "Compiling " (" [" ++ reason ++ "]")
dterei's avatar
dterei committed
850
    where
Ian Lynagh's avatar
Ian Lynagh committed
851
        dflags = hsc_dflags hsc_env
852
        showMsg msg reason =
Ian Lynagh's avatar
Ian Lynagh committed
853
            compilationProgressMsg dflags $
854
            (showModuleIndex mod_index ++
Ian Lynagh's avatar
Ian Lynagh committed
855
            msg ++ showModMsg dflags (hscTarget dflags)
856 857
                              (recompileRequired recomp) mod_summary)
                ++ reason
858

859 860 861
--------------------------------------------------------------
-- FrontEnds
--------------------------------------------------------------
862

863 864
-- | Given a 'ModSummary', parses and typechecks it, returning the
-- 'TcGblEnv' resulting from type-checking.
865
hscFileFrontEnd :: ModSummary -> Hsc TcGblEnv
Edward Z. Yang's avatar
Edward Z. Yang committed
866
hscFileFrontEnd mod_summary = hscTypecheck False mod_summary Nothing
867 868

--------------------------------------------------------------
869
-- Safe Haskell
870 871
--------------------------------------------------------------

872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891
-- 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.


892 893 894
-- Note [Safe Haskell Inference]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- Safe Haskell does Safe inference on modules that don't have any specific
Gabor Greif's avatar
Gabor Greif committed
895
-- safe haskell mode flag. The basic approach to this is:
896 897 898 899 900 901 902
--   * 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.
903 904 905
--
-- 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
906 907
-- to allow users to set the `-Wsafe`, `-Wunsafe` and
-- `-Wtrustworthy-safe` flags on Trustworthy and Unsafe modules so that a
908 909 910 911 912 913 914
-- 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.
915 916 917 918 919 920 921 922 923


-- | 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
924
    tcg_env' <- checkSafeImports tcg_env
925
    checkRULES dflags tcg_env'
926

dterei's avatar
dterei committed
927
  where
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942
    checkRULES dflags tcg_env' = do
      case safeLanguageOn dflags of
          True -> do
              -- XSafe: we nuke user written RULES
              logWarnings $ warns dflags (tcg_rules tcg_env')