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

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

142
import DynFlags
143
import ErrUtils
144
import Platform ( platformOS, osSubsectionsViaSymbols )
145

146
import Outputable
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
147
import NameEnv
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 161
import Control.Monad
import Data.IORef
162
import System.FilePath as FilePath
163
import System.Directory
164
import System.IO (fixIO)
Alan Zimmerman's avatar
Alan Zimmerman committed
165
import qualified Data.Map as Map
166 167
import qualified Data.Set as S
import Data.Set (Set)
dterei's avatar
dterei committed
168

Thomas Schilling's avatar
Thomas Schilling committed
169
#include "HsVersions.h"
170

171

dterei's avatar
dterei committed
172 173 174 175 176
{- **********************************************************************
%*                                                                      *
                Initialisation
%*                                                                      *
%********************************************************************* -}
177

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

197
-- -----------------------------------------------------------------------------
198

199
getWarnings :: Hsc WarningMessages
dterei's avatar
dterei committed
200
getWarnings = Hsc $ \_ w -> return (w, w)
201 202

clearWarnings :: Hsc ()
dterei's avatar
dterei committed
203
clearWarnings = Hsc $ \_ _ -> return ((), emptyBag)
204 205

logWarnings :: WarningMessages -> Hsc ()
dterei's avatar
dterei committed
206
logWarnings w = Hsc $ \_ w0 -> return ((), w0 `unionBags` w)
207 208

getHscEnv :: Hsc HscEnv
dterei's avatar
dterei committed
209
getHscEnv = Hsc $ \e w -> return (e, w)
210 211 212

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

-- | 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
222 223
    logWarnings warns
    when (not $ isEmptyBag errs) $ throwErrors errs
224 225 226 227

-- | Throw some errors.
throwErrors :: ErrorMessages -> Hsc a
throwErrors = liftIO . throwIO . mkSrcErr
228 229 230 231 232

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

-- | 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
257 258 259
    ((warns,_errs), mb_r) <- liftIO $ ioA
    logWarnings warns
    return mb_r
260 261 262 263

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

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

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

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

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

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

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

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
Edward Z. Yang's avatar
Edward Z. Yang committed
308 309 310
hscParse' mod_summary
 | Just r <- ms_parsed_mod mod_summary = return r
 | otherwise = {-# SCC "Parser" #-}
311 312 313
    withTiming getDynFlags
               (text "Parser"<+>brackets (ppr $ ms_mod mod_summary))
               (const ()) $ do
dterei's avatar
dterei committed
314 315 316
    dflags <- getDynFlags
    let src_filename  = ms_hspp_file mod_summary
        maybe_src_buf = ms_hspp_buf  mod_summary
317

dterei's avatar
dterei committed
318
    --------------------------  Parser  ----------------
319 320 321
    -- 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
322 323 324
    buf <- case maybe_src_buf of
               Just b  -> return b
               Nothing -> liftIO $ hGetStringBuffer src_filename
325

dterei's avatar
dterei committed
326
    let loc = mkRealSrcLoc (mkFastString src_filename) 1 1
Edward Z. Yang's avatar
Edward Z. Yang committed
327 328 329
    let parseMod | HsigFile == ms_hsc_src mod_summary
                 = parseSignature
                 | otherwise = parseModule
330

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

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

            -- To get the list of extra source files, we take the list
            -- that the parser gave us,
            --   - eliminate files beginning with '<'.  gcc likes to use
            --     pseudo-filenames like "<built-in>" and "<command-line>"
Gabor Greif's avatar
Gabor Greif committed
350
            --   - normalise them (eliminate differences between ./f and f)
351 352 353 354 355 356 357 358 359
            --   - 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
360
                            $ filter (not . (isPrefixOf "<"))
361 362 363 364 365 366
                            $ map unpackFS
                            $ srcfiles pst
                srcs1 = case ml_hs_file (ms_location mod_summary) of
                          Just f  -> filter (/= FilePath.normalise f) srcs0
                          Nothing -> srcs0

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

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

Thomas Schilling's avatar
Thomas Schilling committed
381 382 383
-- 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
384
type RenamedStuff =
385
        (Maybe (HsGroup GhcRn, [LImportDecl GhcRn], Maybe [LIE GhcRn],
386
                Maybe LHsDocString))
Simon Marlow's avatar
Simon Marlow committed
387

Thomas Schilling's avatar
Thomas Schilling committed
388
-- | Rename and typecheck a module, additionally returning the renamed syntax
389
hscTypecheckRename :: HscEnv -> ModSummary -> HsParsedModule
390
                   -> IO (TcGblEnv, RenamedStuff)
dterei's avatar
dterei committed
391
hscTypecheckRename hsc_env mod_summary rdr_module = runHsc hsc_env $ do
Edward Z. Yang's avatar
Edward Z. Yang committed
392
    tc_result <- hscTypecheck True mod_summary (Just rdr_module)
Thomas Schilling's avatar
Thomas Schilling committed
393

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

401
    return (tc_result, rn_info)
Simon Marlow's avatar
Simon Marlow committed
402

Edward Z. Yang's avatar
Edward Z. Yang committed
403 404 405 406 407 408 409 410
hscTypecheck :: Bool -- ^ Keep renamed source?
             -> ModSummary -> Maybe HsParsedModule
             -> Hsc TcGblEnv
hscTypecheck keep_rn mod_summary mb_rdr_module = do
    hsc_env <- getHscEnv
    let hsc_src = ms_hsc_src mod_summary
        dflags = hsc_dflags hsc_env
        outer_mod = ms_mod mod_summary
411 412 413
        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
414 415 416 417
        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)
418
        then ioMsgMaybe $ tcRnInstantiateSignature hsc_env outer_mod' real_loc
Edward Z. Yang's avatar
Edward Z. Yang committed
419 420 421 422 423 424 425 426
        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 $
427
                            tcRnMergeSignatures hsc_env hpm tc_result0 iface
Edward Z. Yang's avatar
Edward Z. Yang committed
428 429
                else return tc_result0

430 431 432 433 434 435 436 437
-- 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

438 439 440
    -- 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)
441
    dflags   <- getDynFlags
442
    let allSafeOK = safeInferred dflags && tcSafeOK
443

444 445 446
    -- 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
447
        then markUnsafeInfer tcg_res whyUnsafe
448

449
        -- module (could be) safe, throw warning if needed
450 451
        else do
            tcg_res' <- hscCheckSafeImports tcg_res
452
            safe <- liftIO $ fst <$> readIORef (tcg_safeInfer tcg_res')
453 454
            when safe $ do
              case wopt Opt_WarnSafe dflags of
455 456 457 458
                True -> (logWarnings $ unitBag $
                         makeIntoWarning (Reason Opt_WarnSafe) $
                         mkPlainWarnMsg dflags (warnSafeOnLoc dflags) $
                         errSafe tcg_res')
459 460
                False | safeHaskell dflags == Sf_Trustworthy &&
                        wopt Opt_WarnTrustworthySafe dflags ->
461 462 463 464
                        (logWarnings $ unitBag $
                         makeIntoWarning (Reason Opt_WarnTrustworthySafe) $
                         mkPlainWarnMsg dflags (trustworthyOnLoc dflags) $
                         errTwthySafe tcg_res')
465
                False -> return ()
466 467 468
            return tcg_res'
  where
    pprMod t  = ppr $ moduleName $ tcg_mod t
469
    errSafe t = quotes (pprMod t) <+> text "has been inferred as safe!"
470 471
    errTwthySafe t = quotes (pprMod t)
      <+> text "is marked as Trustworthy but has been inferred as safe!"
472

Simon Marlow's avatar
Simon Marlow committed
473
-- | Convert a typechecked module to Core
474
hscDesugar :: HscEnv -> ModSummary -> TcGblEnv -> IO ModGuts
475
hscDesugar hsc_env mod_summary tc_result =
Ian Lynagh's avatar
Ian Lynagh committed
476
    runHsc hsc_env $ hscDesugar' (ms_location mod_summary) tc_result
477

Ian Lynagh's avatar
Ian Lynagh committed
478 479
hscDesugar' :: ModLocation -> TcGblEnv -> Hsc ModGuts
hscDesugar' mod_location tc_result = do
dterei's avatar
dterei committed
480
    hsc_env <- getHscEnv
Simon Marlow's avatar
Simon Marlow committed
481 482
    r <- ioMsgMaybe $
      {-# SCC "deSugar" #-}
Ian Lynagh's avatar
Ian Lynagh committed
483
      deSugar hsc_env mod_location tc_result
484

dterei's avatar
dterei committed
485 486 487 488
    -- 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
489

dterei's avatar
dterei committed
490
-- | Make a 'ModDetails' from the results of typechecking. Used when
Simon Marlow's avatar
Simon Marlow committed
491
-- typechecking only, as opposed to full compilation.
492 493
makeSimpleDetails :: HscEnv -> TcGblEnv -> IO ModDetails
makeSimpleDetails hsc_env tc_result = mkBootModDetailsTc hsc_env tc_result
Simon Marlow's avatar
Simon Marlow committed
494

495

dterei's avatar
dterei committed
496 497 498 499 500 501 502
{- **********************************************************************
%*                                                                      *
                The main compiler pipeline
%*                                                                      *
%********************************************************************* -}

{-
503 504 505 506
                   --------------------------------
                        The compilation proper
                   --------------------------------

dterei's avatar
dterei committed
507 508 509 510 511 512
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
513
targets byte-code.
dterei's avatar
dterei committed
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538

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


539 540
type Messager = HscEnv -> (Int,Int) -> RecompileRequired -> ModSummary -> IO ()

541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
-- | 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
556
  always_do_basic_recompilation_check m_tc_result
557
  mHscMessage mod_summary source_modified mb_old_iface mod_index
558
    = do
559
    hsc_env <- getHscEnv
560 561 562 563

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

565
        skip iface = do
566
            liftIO $ msg UpToDate
567
            return $ Left iface
dterei's avatar
dterei committed
568

569
        compile mb_old_hash reason = do
570 571 572
            liftIO $ msg reason
            result <- genericHscFrontend mod_summary
            return $ Right (result, mb_old_hash)
dterei's avatar
dterei committed
573 574 575 576

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

578 579 580
    case m_tc_result of
         Just tc_result
          | not always_do_basic_recompilation_check ->
581
             return $ Right (FrontendTypecheck tc_result, Nothing)
582 583 584
         _ -> do
            (recomp_reqd, mb_checked_iface)
                <- {-# SCC "checkOldIface" #-}
585
                   liftIO $ checkOldIface hsc_env mod_summary
586 587 588 589 590 591 592 593
                                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
594 595 596 597 598 599 600 601 602 603 604 605 606
                    -- 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.
607 608 609 610 611 612 613 614 615 616
                    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 ->
617
                        return $ Right (FrontendTypecheck tc_result, mb_old_hash)
618

619
genericHscFrontend :: ModSummary -> Hsc FrontendResult
620 621 622
genericHscFrontend mod_summary =
  getHooked hscFrontendHook genericHscFrontend' >>= ($ mod_summary)

623 624 625
genericHscFrontend' :: ModSummary -> Hsc FrontendResult
genericHscFrontend' mod_summary
    = FrontendTypecheck `fmap` hscFileFrontEnd mod_summary
626

627 628 629 630
--------------------------------------------------------------
-- Compilers
--------------------------------------------------------------

Austin Seipp's avatar
Austin Seipp committed
631
-- Compile Haskell/boot in OneShot mode.
632 633 634 635 636 637 638 639 640 641 642 643 644
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
645
  = do
dterei's avatar
dterei committed
646 647
    -- One-shot mode needs a knot-tying mutable variable for interface
    -- files. See TcRnTypes.TcGblEnv.tcg_type_env_var.
648
    -- See also Note [hsc_type_env_var hack]
dterei's avatar
dterei committed
649 650
    type_env_var <- newIORef emptyNameEnv
    let mod = ms_mod mod_summary
651 652 653 654
        hsc_env | isOneShot (ghcMode (hsc_dflags hsc_env'))
                = hsc_env' { hsc_type_env_var = Just (mod, type_env_var) }
                | otherwise
                = hsc_env'
655

656 657 658 659 660 661 662 663
    -- 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
664 665
        -- We didn't need to do any typechecking; the old interface
        -- file on disk was good enough.
666
        Left iface -> do
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
            -- 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.)
688 689
        Right (FrontendTypecheck tc_result, mb_old_hash) ->
            finish hsc_env mod_summary tc_result mb_old_hash
690 691 692 693 694

-- 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
695
-- in the interface file.
696 697 698 699
finish :: HscEnv
       -> ModSummary
       -> TcGblEnv
       -> Maybe Fingerprint
700
       -> Hsc (HscStatus, HomeModInfo)
701
finish hsc_env summary tc_result mb_old_hash = do
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
  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})
740 741 742 743 744 745 746 747 748 749

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
750

751 752 753 754
--------------------------------------------------------------
-- NoRecomp handlers
--------------------------------------------------------------

755
-- NB: this must be knot-tied appropriately, see hscIncrementalCompile
756 757
genModDetails :: HscEnv -> ModIface -> IO ModDetails
genModDetails hsc_env old_iface
758
  = do
dterei's avatar
dterei committed
759
    new_details <- {-# SCC "tcRnIface" #-}
760
                   initIfaceLoad hsc_env (typecheckIface old_iface)
761
    dumpIfaceStats hsc_env
dterei's avatar
dterei committed
762
    return new_details
763

764 765 766 767
--------------------------------------------------------------
-- Progress displayers.
--------------------------------------------------------------

768 769
oneShotMsg :: HscEnv -> RecompileRequired -> IO ()
oneShotMsg hsc_env recomp =
dterei's avatar
dterei committed
770
    case recomp of
771
        UpToDate ->
772 773
            compilationProgressMsg (hsc_dflags hsc_env) $
                   "compilation IS NOT required"
774
        _ ->
775 776
            return ()

777 778
batchMsg :: Messager
batchMsg hsc_env mod_index recomp mod_summary =
dterei's avatar
dterei committed
779
    case recomp of
780 781 782
        MustCompile -> showMsg "Compiling " ""
        UpToDate
            | verbosity (hsc_dflags hsc_env) >= 2 -> showMsg "Skipping  " ""
dterei's avatar
dterei committed
783
            | otherwise -> return ()
784
        RecompBecause reason -> showMsg "Compiling " (" [" ++ reason ++ "]")
dterei's avatar
dterei committed
785
    where
Ian Lynagh's avatar
Ian Lynagh committed
786
        dflags = hsc_dflags hsc_env
787
        showMsg msg reason =
Ian Lynagh's avatar
Ian Lynagh committed
788
            compilationProgressMsg dflags $
789
            (showModuleIndex mod_index ++
Ian Lynagh's avatar
Ian Lynagh committed
790
            msg ++ showModMsg dflags (hscTarget dflags)
791 792
                              (recompileRequired recomp) mod_summary)
                ++ reason
793

794 795 796
--------------------------------------------------------------
-- FrontEnds
--------------------------------------------------------------
797

798 799
-- | Given a 'ModSummary', parses and typechecks it, returning the
-- 'TcGblEnv' resulting from type-checking.
800
hscFileFrontEnd :: ModSummary -> Hsc TcGblEnv
Edward Z. Yang's avatar
Edward Z. Yang committed
801
hscFileFrontEnd mod_summary = hscTypecheck False mod_summary Nothing
802 803

--------------------------------------------------------------
804
-- Safe Haskell
805 806
--------------------------------------------------------------

807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826
-- 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.


827 828 829
-- Note [Safe Haskell Inference]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- Safe Haskell does Safe inference on modules that don't have any specific
Gabor Greif's avatar
Gabor Greif committed
830
-- safe haskell mode flag. The basic approach to this is:
831 832 833 834 835 836 837
--   * 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.
838 839 840
--
-- 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
841 842
-- to allow users to set the `-Wsafe`, `-Wunsafe` and
-- `-Wtrustworthy-safe` flags on Trustworthy and Unsafe modules so that a
843 844 845 846 847 848 849
-- 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.
850 851 852 853 854 855 856 857 858


-- | 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
859
    tcg_env' <- checkSafeImports dflags tcg_env
860
    checkRULES dflags tcg_env'
861

dterei's avatar
dterei committed
862
  where
863 864 865 866 867 868 869 870 871 872 873 874 875 876 877
    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
878 879 880
    warns dflags rules = listToBag $ map (warnRules dflags) rules
    warnRules dflags (L loc (HsRule n _ _ _ _ _ _)) =
        mkPlainWarnMsg dflags loc $
881
            text "Rule \"" <> ftext (snd $ unLoc n) <> text "\" ignored" $+$
dterei's avatar
dterei committed
882
            text "User defined rules are disabled under Safe Haskell"
883

884 885 886 887 888 889
-- | 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.
890
--
891 892 893 894 895
-- 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].
896 897
checkSafeImports :: DynFlags -> TcGblEnv -> Hsc TcGblEnv
checkSafeImports dflags tcg_env
898
    = do
899 900 901
        imps <- mapM condense imports'
        let (safeImps, regImps) = partition (\(_,_,s) -> s) imps

902 903 904 905 906
        -- 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

907
        -- Check safe imports are correct
908
        safePkgs <- S.fromList <$> mapMaybeM checkSafe safeImps
909
        safeErrs <- getWarnings
dterei's avatar
dterei committed
910 911
        clearWarnings

912
        -- Check non-safe imports are correct if inferring safety
913
        -- See the Note [Safe Haskell Inference]
914
        (infErrs, infPkgs) <- case (safeInferOn dflags) of
915 916
          False -> return (emptyBag, S.empty)
          True -> do infPkgs <- S.fromList <$> mapMaybeM checkSafe regImps
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936
                     infErrs <- getWarnings
                     clearWarnings
                     return (infErrs