HscMain.hs 73.5 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)
Simon Marlow's avatar
Simon Marlow committed
88
import Id
89
import GHCi             ( addSptEntry )
90
import GHCi.RemoteTypes ( ForeignHValue )
91
import ByteCodeGen      ( byteCodeGen, coreExprToBCOs )
92
import Linker
93
import CoreTidy         ( tidyExpr )
94 95
import Type             ( Type )
import {- Kind parts of -} Type         ( Kind )
96
import CoreLint         ( lintInteractiveExpr )
97
import VarEnv           ( emptyTidyEnv )
98
import Panic
99
import ConLike
100
import Control.Concurrent
101

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

145
import DynFlags
146
import ErrUtils
147
import Platform ( platformOS, osSubsectionsViaSymbols )
148

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

160
import Util
Simon Marlow's avatar
Simon Marlow committed
161

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

Thomas Schilling's avatar
Thomas Schilling committed
172
#include "HsVersions.h"
173

174

dterei's avatar
dterei committed
175 176 177 178 179
{- **********************************************************************
%*                                                                      *
                Initialisation
%*                                                                      *
%********************************************************************* -}
180

181
newHscEnv :: DynFlags -> IO HscEnv
182
newHscEnv dflags = do
dterei's avatar
dterei committed
183 184
    eps_var <- newIORef initExternalPackageState
    us      <- mkSplitUniqSupply 'r'
185
    nc_var  <- newIORef (initNameCache us knownKeyNames)
186
    fc_var  <- newIORef emptyInstalledModuleEnv
187 188 189
    iserv_mvar <- newMVar Nothing
    return HscEnv {  hsc_dflags       = dflags
                  ,  hsc_targets      = []
190
                  ,  hsc_mod_graph    = emptyMG
191 192 193 194 195 196 197 198
                  ,  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
199

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

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

267
hscTcRnLookupRdrName :: HscEnv -> Located RdrName -> IO [Name]
268 269
hscTcRnLookupRdrName hsc_env0 rdr_name
  = runInteractiveHsc hsc_env0 $
270 271
    do { hsc_env <- getHscEnv
       ; ioMsgMaybe $ tcRnLookupRdrName hsc_env rdr_name }
272 273

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

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

dterei's avatar
dterei committed
288
hscIsGHCiMonad :: HscEnv -> String -> IO Name
Edsko de Vries's avatar
Edsko de Vries committed
289
hscIsGHCiMonad hsc_env name
290
  = runHsc hsc_env $ ioMsgMaybe $ isGHCiMonad hsc_env name
dterei's avatar
dterei committed
291

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

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

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

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

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

dterei's avatar
dterei committed
322
    --------------------------  Parser  ----------------
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
Edward Z. Yang's avatar
Edward Z. Yang committed
331 332 333
    let parseMod | HsigFile == ms_hsc_src mod_summary
                 = parseSignature
                 | otherwise = parseModule
334

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

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

            -- 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
354
            --   - normalise them (eliminate differences between ./f and f)
355 356 357 358 359 360 361 362 363
            --   - 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
364
                            $ filter (not . (isPrefixOf "<"))
365 366 367 368 369 370
                            $ map unpackFS
                            $ srcfiles pst
                srcs1 = case ml_hs_file (ms_location mod_summary) of
                          Just f  -> filter (/= FilePath.normalise f) srcs0
                          Nothing -> srcs0

371 372 373 374 375
            -- sometimes we see source files from earlier
            -- preprocessing stages that cannot be found, so just
            -- filter them out:
            srcs2 <- liftIO $ filterM doesFileExist srcs1

376 377
            return HsParsedModule {
                      hpm_module    = rdr_module,
Alan Zimmerman's avatar
Alan Zimmerman committed
378 379 380 381 382
                      hpm_src_files = srcs2,
                      hpm_annotations
                              = (Map.fromListWith (++) $ annotations pst,
                                 Map.fromList $ ((noSrcSpan,comment_q pst)
                                                 :(annotations_comments pst)))
383
                   }
Simon Marlow's avatar
Simon Marlow committed
384

Thomas Schilling's avatar
Thomas Schilling committed
385 386 387
-- 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
388
type RenamedStuff =
alexbiehl's avatar
alexbiehl committed
389
        (Maybe (HsGroup GhcRn, [LImportDecl GhcRn], Maybe [(LIE GhcRn, Avails)],
390
                Maybe LHsDocString))
Simon Marlow's avatar
Simon Marlow committed
391

392 393 394 395
-- -----------------------------------------------------------------------------
-- | 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
Thomas Schilling's avatar
Thomas Schilling committed
396

397
    -- This 'do' is in the Maybe monad!
398 399 400 401 402
    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
403

404 405 406 407
    dflags <- getDynFlags
    liftIO $ dumpIfSet_dyn dflags Opt_D_dump_rn_ast "Renamer" $
                           showAstData NoBlankSrcSpan rn_info

408
    return (tc_result, rn_info)
Simon Marlow's avatar
Simon Marlow committed
409

410 411 412 413 414 415 416 417 418 419

-- -----------------------------------------------------------------------------
-- | 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
    tc_result <- hscTypecheck True mod_summary (Just rdr_module)
    extract_renamed_stuff tc_result


Edward Z. Yang's avatar
Edward Z. Yang committed
420 421 422 423
hscTypecheck :: Bool -- ^ Keep renamed source?
             -> ModSummary -> Maybe HsParsedModule
             -> Hsc TcGblEnv
hscTypecheck keep_rn mod_summary mb_rdr_module = do
424 425 426 427 428 429 430 431 432
    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
433 434 435 436
    hsc_env <- getHscEnv
    let hsc_src = ms_hsc_src mod_summary
        dflags = hsc_dflags hsc_env
        outer_mod = ms_mod mod_summary
437 438 439
        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
440 441 442 443
        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)
444
        then ioMsgMaybe $ tcRnInstantiateSignature hsc_env outer_mod' real_loc
Edward Z. Yang's avatar
Edward Z. Yang committed
445 446 447 448 449 450 451 452
        else
         do hpm <- case mb_rdr_module of
                    Just hpm -> return hpm
                    Nothing -> hscParse' mod_summary
            tc_result0 <- tcRnModule' hsc_env mod_summary keep_rn hpm
            if hsc_src == HsigFile
                then do (iface, _, _) <- liftIO $ hscSimpleIface hsc_env tc_result0 Nothing
                        ioMsgMaybe $
453
                            tcRnMergeSignatures hsc_env hpm tc_result0 iface
Edward Z. Yang's avatar
Edward Z. Yang committed
454 455
                else return tc_result0

456 457 458 459 460 461 462 463
-- 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

464 465 466
    -- 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)
467
    dflags   <- getDynFlags
468
    let allSafeOK = safeInferred dflags && tcSafeOK
469

470 471 472
    -- 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
473
        then markUnsafeInfer tcg_res whyUnsafe
474

475
        -- module (could be) safe, throw warning if needed
476 477
        else do
            tcg_res' <- hscCheckSafeImports tcg_res
478
            safe <- liftIO $ fst <$> readIORef (tcg_safeInfer tcg_res')
479 480
            when safe $ do
              case wopt Opt_WarnSafe dflags of
481 482 483 484
                True -> (logWarnings $ unitBag $
                         makeIntoWarning (Reason Opt_WarnSafe) $
                         mkPlainWarnMsg dflags (warnSafeOnLoc dflags) $
                         errSafe tcg_res')
485 486
                False | safeHaskell dflags == Sf_Trustworthy &&
                        wopt Opt_WarnTrustworthySafe dflags ->
487 488 489 490
                        (logWarnings $ unitBag $
                         makeIntoWarning (Reason Opt_WarnTrustworthySafe) $
                         mkPlainWarnMsg dflags (trustworthyOnLoc dflags) $
                         errTwthySafe tcg_res')
491
                False -> return ()
492 493 494
            return tcg_res'
  where
    pprMod t  = ppr $ moduleName $ tcg_mod t
495
    errSafe t = quotes (pprMod t) <+> text "has been inferred as safe!"
496 497
    errTwthySafe t = quotes (pprMod t)
      <+> text "is marked as Trustworthy but has been inferred as safe!"
498

Simon Marlow's avatar
Simon Marlow committed
499
-- | Convert a typechecked module to Core
500
hscDesugar :: HscEnv -> ModSummary -> TcGblEnv -> IO ModGuts
501
hscDesugar hsc_env mod_summary tc_result =
Ian Lynagh's avatar
Ian Lynagh committed
502
    runHsc hsc_env $ hscDesugar' (ms_location mod_summary) tc_result
503

Ian Lynagh's avatar
Ian Lynagh committed
504 505
hscDesugar' :: ModLocation -> TcGblEnv -> Hsc ModGuts
hscDesugar' mod_location tc_result = do
dterei's avatar
dterei committed
506
    hsc_env <- getHscEnv
Simon Marlow's avatar
Simon Marlow committed
507 508
    r <- ioMsgMaybe $
      {-# SCC "deSugar" #-}
Ian Lynagh's avatar
Ian Lynagh committed
509
      deSugar hsc_env mod_location tc_result
510

dterei's avatar
dterei committed
511 512 513 514
    -- 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
515

dterei's avatar
dterei committed
516
-- | Make a 'ModDetails' from the results of typechecking. Used when
Simon Marlow's avatar
Simon Marlow committed
517
-- typechecking only, as opposed to full compilation.
518 519
makeSimpleDetails :: HscEnv -> TcGblEnv -> IO ModDetails
makeSimpleDetails hsc_env tc_result = mkBootModDetailsTc hsc_env tc_result
Simon Marlow's avatar
Simon Marlow committed
520

521

dterei's avatar
dterei committed
522 523 524 525 526 527 528
{- **********************************************************************
%*                                                                      *
                The main compiler pipeline
%*                                                                      *
%********************************************************************* -}

{-
529 530 531 532
                   --------------------------------
                        The compilation proper
                   --------------------------------

dterei's avatar
dterei committed
533 534 535 536 537 538
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
539
targets byte-code.
dterei's avatar
dterei committed
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

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


565 566
type Messager = HscEnv -> (Int,Int) -> RecompileRequired -> ModSummary -> IO ()

567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
-- | 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
582
  always_do_basic_recompilation_check m_tc_result
583
  mHscMessage mod_summary source_modified mb_old_iface mod_index
584
    = do
585
    hsc_env <- getHscEnv
586 587 588 589

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

591
        skip iface = do
592
            liftIO $ msg UpToDate
593
            return $ Left iface
dterei's avatar
dterei committed
594

595
        compile mb_old_hash reason = do
596 597 598
            liftIO $ msg reason
            result <- genericHscFrontend mod_summary
            return $ Right (result, mb_old_hash)
dterei's avatar
dterei committed
599 600 601 602

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

604 605 606
    case m_tc_result of
         Just tc_result
          | not always_do_basic_recompilation_check ->
607
             return $ Right (FrontendTypecheck tc_result, Nothing)
608 609 610
         _ -> do
            (recomp_reqd, mb_checked_iface)
                <- {-# SCC "checkOldIface" #-}
611
                   liftIO $ checkOldIface hsc_env mod_summary
612 613 614 615 616 617 618 619
                                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
620 621 622 623 624 625 626 627 628 629 630 631 632
                    -- 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.
633 634 635 636 637 638 639 640 641 642
                    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 ->
643
                        return $ Right (FrontendTypecheck tc_result, mb_old_hash)
644

645
genericHscFrontend :: ModSummary -> Hsc FrontendResult
646 647 648
genericHscFrontend mod_summary =
  getHooked hscFrontendHook genericHscFrontend' >>= ($ mod_summary)

649 650 651
genericHscFrontend' :: ModSummary -> Hsc FrontendResult
genericHscFrontend' mod_summary
    = FrontendTypecheck `fmap` hscFileFrontEnd mod_summary
652

653 654 655 656
--------------------------------------------------------------
-- Compilers
--------------------------------------------------------------

Austin Seipp's avatar
Austin Seipp committed
657
-- Compile Haskell/boot in OneShot mode.
658 659 660 661 662 663 664 665 666 667 668 669 670
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
671
  = do
dterei's avatar
dterei committed
672 673
    -- One-shot mode needs a knot-tying mutable variable for interface
    -- files. See TcRnTypes.TcGblEnv.tcg_type_env_var.
674
    -- See also Note [hsc_type_env_var hack]
dterei's avatar
dterei committed
675 676
    type_env_var <- newIORef emptyNameEnv
    let mod = ms_mod mod_summary
677 678 679 680
        hsc_env | isOneShot (ghcMode (hsc_dflags hsc_env'))
                = hsc_env' { hsc_type_env_var = Just (mod, type_env_var) }
                | otherwise
                = hsc_env'
681

682 683 684 685 686 687 688 689
    -- 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
690 691
        -- We didn't need to do any typechecking; the old interface
        -- file on disk was good enough.
692
        Left iface -> do
693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713
            -- 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.)
714 715
        Right (FrontendTypecheck tc_result, mb_old_hash) ->
            finish hsc_env mod_summary tc_result mb_old_hash
716 717 718 719 720

-- 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
721
-- in the interface file.
722 723 724 725
finish :: HscEnv
       -> ModSummary
       -> TcGblEnv
       -> Maybe Fingerprint
726
       -> Hsc (HscStatus, HomeModInfo)
727
finish hsc_env summary tc_result mb_old_hash = do
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
  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
            desugared_guts <- hscSimplify' desugared_guts0
            (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})
766 767 768 769 770 771 772 773 774 775

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
776

777 778 779 780
--------------------------------------------------------------
-- NoRecomp handlers
--------------------------------------------------------------

781
-- NB: this must be knot-tied appropriately, see hscIncrementalCompile
782 783
genModDetails :: HscEnv -> ModIface -> IO ModDetails
genModDetails hsc_env old_iface
784
  = do
dterei's avatar
dterei committed
785
    new_details <- {-# SCC "tcRnIface" #-}
786
                   initIfaceLoad hsc_env (typecheckIface old_iface)
787
    dumpIfaceStats hsc_env
dterei's avatar
dterei committed
788
    return new_details
789

790 791 792 793
--------------------------------------------------------------
-- Progress displayers.
--------------------------------------------------------------

794 795
oneShotMsg :: HscEnv -> RecompileRequired -> IO ()
oneShotMsg hsc_env recomp =
dterei's avatar
dterei committed
796
    case recomp of
797
        UpToDate ->
798 799
            compilationProgressMsg (hsc_dflags hsc_env) $
                   "compilation IS NOT required"
800
        _ ->
801 802
            return ()

803 804
batchMsg :: Messager
batchMsg hsc_env mod_index recomp mod_summary =
dterei's avatar
dterei committed
805
    case recomp of
806 807 808
        MustCompile -> showMsg "Compiling " ""
        UpToDate
            | verbosity (hsc_dflags hsc_env) >= 2 -> showMsg "Skipping  " ""
dterei's avatar
dterei committed
809
            | otherwise -> return ()
810
        RecompBecause reason -> showMsg "Compiling " (" [" ++ reason ++ "]")
dterei's avatar
dterei committed
811
    where
Ian Lynagh's avatar
Ian Lynagh committed
812
        dflags = hsc_dflags hsc_env
813
        showMsg msg reason =
Ian Lynagh's avatar
Ian Lynagh committed
814
            compilationProgressMsg dflags $
815
            (showModuleIndex mod_index ++
Ian Lynagh's avatar
Ian Lynagh committed
816
            msg ++ showModMsg dflags (hscTarget dflags)
817 818
                              (recompileRequired recomp) mod_summary)
                ++ reason
819

820 821 822
--------------------------------------------------------------
-- FrontEnds
--------------------------------------------------------------
823

824 825
-- | Given a 'ModSummary', parses and typechecks it, returning the
-- 'TcGblEnv' resulting from type-checking.
826
hscFileFrontEnd :: ModSummary -> Hsc TcGblEnv
Edward Z. Yang's avatar
Edward Z. Yang committed
827
hscFileFrontEnd mod_summary = hscTypecheck False mod_summary Nothing
828 829

--------------------------------------------------------------
830
-- Safe Haskell
831 832
--------------------------------------------------------------

833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852
-- 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.


853 854 855
-- Note [Safe Haskell Inference]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- Safe Haskell does Safe inference on modules that don't have any specific
Gabor Greif's avatar
Gabor Greif committed
856
-- safe haskell mode flag. The basic approach to this is:
857 858 859 860 861 862 863
--   * 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.
864 865 866
--
-- 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
867 868
-- to allow users to set the `-Wsafe`, `-Wunsafe` and
-- `-Wtrustworthy-safe` flags on Trustworthy and Unsafe modules so that a
869 870 871 872 873 874 875
-- 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.
876 877 878 879 880 881 882 883 884


-- | 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
885
    tcg_env' <- checkSafeImports dflags tcg_env
886
    checkRULES dflags tcg_env'
887

dterei's avatar
dterei committed
888
  where
889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
    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
904 905 906
    warns dflags rules = listToBag $ map (warnRules dflags) rules
    warnRules dflags (L loc (HsRule n _ _ _ _ _ _)) =
        mkPlainWarnMsg dflags loc $
907
            text "Rule \"" <> ftext (snd $ unLoc n) <> text "\" ignored" $+$
dterei's avatar
dterei committed
908
            text "User defined rules are disabled under Safe Haskell"
909

910 911 912 913 914 915
-- | 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.
916
--
917 918 919 920 921
-- 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].
922 923
checkSafeImports :: DynFlags -> TcGblEnv -> Hsc TcGblEnv
checkSafeImports dflags tcg_env
924
    = do
925 926 927
        imps <- mapM condense imports'
        let (safeImps, regImps) = partition (\(_,_,s) -> s) imps

928 929 930 931 932
        -- 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

933
        -- Check safe imports are correct
934
        safePkgs <- S.fromList <$> mapMaybeM checkSafe safeImps
935
        safeErrs <- getWarnings