HscMain.hs 76.7 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 67
    , hscStmt, hscParseStmtWithLocation, hscStmtWithLocation, hscParsedStmt
    , hscDecls, hscParseDeclsWithLocation, hscDeclsWithLocation, hscParsedDecls
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)
Alec Theriault's avatar
Alec Theriault committed
88
import Data.Maybe       ( fromJust )
Simon Marlow's avatar
Simon Marlow committed
89
import Id
90
import GHCi             ( addSptEntry )
91
import GHCi.RemoteTypes ( ForeignHValue )
92
import ByteCodeGen      ( byteCodeGen, coreExprToBCOs )
93
import Linker
94
import CoreTidy         ( tidyExpr )
95 96
import Type             ( Type )
import {- Kind parts of -} Type         ( Kind )
97
import CoreLint         ( lintInteractiveExpr )
98
import VarEnv           ( emptyTidyEnv )
99
import Panic
100
import ConLike
101
import Control.Concurrent
102

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
import StgSyn
127
import StgFVs           ( annTopBindingsFreeVars )
128
import CostCentre
129
import ProfInit
130 131
import TyCon
import Name
132
import SimplStg         ( stg2stg )
133
import Cmm
134
import CmmParse         ( parseCmmFile )
135
import CmmBuildInfoTables
Edward Z. Yang's avatar
Edward Z. Yang committed
136
import CmmPipeline
137
import CmmInfo
138 139
import CodeOutput
import InstEnv
140
import FamInstEnv
Thomas Schilling's avatar
Thomas Schilling committed
141
import Fingerprint      ( Fingerprint )
142
import Hooks
Edward Z. Yang's avatar
Edward Z. Yang committed
143
import TcEnv
144
import PrelNames
145 146
import Plugins
import DynamicLoading   ( initializePlugins )
147

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

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

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

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

Alec Theriault's avatar
Alec Theriault committed
175 176 177 178 179
import HieAst           ( mkHieFile )
import HieTypes         ( getAsts, hie_asts )
import HieBin           ( readHieFile, writeHieFile )
import HieDebug         ( diffFile, validateScopes )

Thomas Schilling's avatar
Thomas Schilling committed
180
#include "HsVersions.h"
181

182

dterei's avatar
dterei committed
183 184 185 186 187
{- **********************************************************************
%*                                                                      *
                Initialisation
%*                                                                      *
%********************************************************************* -}
188

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

210
-- -----------------------------------------------------------------------------
211

212
getWarnings :: Hsc WarningMessages
dterei's avatar
dterei committed
213
getWarnings = Hsc $ \_ w -> return (w, w)
214 215

clearWarnings :: Hsc ()
dterei's avatar
dterei committed
216
clearWarnings = Hsc $ \_ _ -> return ((), emptyBag)
217 218

logWarnings :: WarningMessages -> Hsc ()
dterei's avatar
dterei committed
219
logWarnings w = Hsc $ \_ w0 -> return ((), w0 `unionBags` w)
220 221

getHscEnv :: Hsc HscEnv
dterei's avatar
dterei committed
222
getHscEnv = Hsc $ \e w -> return (e, w)
223 224 225

handleWarnings :: Hsc ()
handleWarnings = do
dterei's avatar
dterei committed
226 227 228 229
    dflags <- getDynFlags
    w <- getWarnings
    liftIO $ printOrThrowWarnings dflags w
    clearWarnings
230 231 232 233 234

-- | 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
235 236
    logWarnings warns
    when (not $ isEmptyBag errs) $ throwErrors errs
237

238 239 240 241 242 243 244 245 246
-- | Log warnings and throw errors, assuming the messages
-- contain at least one error (e.g. coming from PFailed)
handleWarningsThrowErrors :: Messages -> Hsc a
handleWarningsThrowErrors (warns, errs) = do
    logWarnings warns
    dflags <- getDynFlags
    (wWarns, wErrs) <- warningsToMessages dflags <$> getWarnings
    liftIO $ printBagOfErrors dflags wWarns
    throwErrors (unionBags errs wErrs)
247 248 249 250 251

-- | 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
252
-- and signal success via by wrapping the result in a 'Maybe' type. This
253 254 255 256 257 258 259 260 261
-- 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
262
--     there should be warnings in the first result. That is, if the action
263 264 265
--     failed, it must have been due to the warnings (i.e., @-Werror@).
ioMsgMaybe :: IO (Messages, Maybe a) -> Hsc a
ioMsgMaybe ioA = do
266
    ((warns,errs), mb_r) <- liftIO ioA
dterei's avatar
dterei committed
267 268 269 270
    logWarnings warns
    case mb_r of
        Nothing -> throwErrors errs
        Just r  -> ASSERT( isEmptyBag errs ) return r
271 272 273 274 275

-- | 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
276 277 278
    ((warns,_errs), mb_r) <- liftIO $ ioA
    logWarnings warns
    return mb_r
279 280 281 282

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

283
hscTcRnLookupRdrName :: HscEnv -> Located RdrName -> IO [Name]
284 285
hscTcRnLookupRdrName hsc_env0 rdr_name
  = runInteractiveHsc hsc_env0 $
286 287
    do { hsc_env <- getHscEnv
       ; ioMsgMaybe $ tcRnLookupRdrName hsc_env rdr_name }
288 289

hscTcRcLookupName :: HscEnv -> Name -> IO (Maybe TyThing)
290 291 292
hscTcRcLookupName hsc_env0 name = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe' $ tcRnLookupName hsc_env name
dterei's avatar
dterei committed
293 294 295
      -- 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.
296

297 298
hscTcRnGetInfo :: HscEnv -> Name
               -> IO (Maybe (TyThing, Fixity, [ClsInst], [FamInst], SDoc))
299 300 301 302
hscTcRnGetInfo hsc_env0 name
  = runInteractiveHsc hsc_env0 $
    do { hsc_env <- getHscEnv
       ; ioMsgMaybe' $ tcRnGetInfo hsc_env name }
303

dterei's avatar
dterei committed
304
hscIsGHCiMonad :: HscEnv -> String -> IO Name
Edsko de Vries's avatar
Edsko de Vries committed
305
hscIsGHCiMonad hsc_env name
306
  = runHsc hsc_env $ ioMsgMaybe $ isGHCiMonad hsc_env name
dterei's avatar
dterei committed
307

308
hscGetModuleInterface :: HscEnv -> Module -> IO ModIface
309 310 311
hscGetModuleInterface hsc_env0 mod = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe $ getModuleInterface hsc_env mod
312 313 314

-- -----------------------------------------------------------------------------
-- | Rename some import declarations
315
hscRnImportDecls :: HscEnv -> [LImportDecl GhcPs] -> IO GlobalRdrEnv
316 317 318
hscRnImportDecls hsc_env0 import_decls = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe $ tcRnImportDecls hsc_env import_decls
319

320
-- -----------------------------------------------------------------------------
Simon Marlow's avatar
Simon Marlow committed
321
-- | parse a file, returning the abstract syntax
322

323
hscParse :: HscEnv -> ModSummary -> IO HsParsedModule
324 325 326
hscParse hsc_env mod_summary = runHsc hsc_env $ hscParse' mod_summary

-- internal version, that doesn't fail due to -Werror
327
hscParse' :: ModSummary -> Hsc HsParsedModule
Edward Z. Yang's avatar
Edward Z. Yang committed
328 329 330
hscParse' mod_summary
 | Just r <- ms_parsed_mod mod_summary = return r
 | otherwise = {-# SCC "Parser" #-}
331 332 333
    withTiming getDynFlags
               (text "Parser"<+>brackets (ppr $ ms_mod mod_summary))
               (const ()) $ do
dterei's avatar
dterei committed
334 335 336
    dflags <- getDynFlags
    let src_filename  = ms_hspp_file mod_summary
        maybe_src_buf = ms_hspp_buf  mod_summary
337

dterei's avatar
dterei committed
338
    --------------------------  Parser  ----------------
339 340 341
    -- 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
342 343 344
    buf <- case maybe_src_buf of
               Just b  -> return b
               Nothing -> liftIO $ hGetStringBuffer src_filename
345

dterei's avatar
dterei committed
346
    let loc = mkRealSrcLoc (mkFastString src_filename) 1 1
Edward Z. Yang's avatar
Edward Z. Yang committed
347 348 349
    let parseMod | HsigFile == ms_hsc_src mod_summary
                 = parseSignature
                 | otherwise = parseModule
350

Edward Z. Yang's avatar
Edward Z. Yang committed
351
    case unP parseMod (mkPState dflags buf loc) of
352 353
        PFailed pst ->
            handleWarningsThrowErrors (getMessages pst dflags)
dterei's avatar
dterei committed
354
        POk pst rdr_module -> do
355 356
            let (warns, errs) = getMessages pst dflags
            logWarnings warns
dterei's avatar
dterei committed
357 358
            liftIO $ dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" $
                                   ppr rdr_module
359
            liftIO $ dumpIfSet_dyn dflags Opt_D_dump_parsed_ast "Parser AST" $
360
                                   showAstData NoBlankSrcSpan rdr_module
dterei's avatar
dterei committed
361 362
            liftIO $ dumpIfSet_dyn dflags Opt_D_source_stats "Source Statistics" $
                                   ppSourceStats False rdr_module
363
            when (not $ isEmptyBag errs) $ throwErrors errs
364 365 366 367 368

            -- 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
369
            --   - normalise them (eliminate differences between ./f and f)
370 371 372 373 374 375 376 377 378
            --   - 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
379
                            $ filter (not . isPrefixOf "<")
380 381 382 383 384 385
                            $ map unpackFS
                            $ srcfiles pst
                srcs1 = case ml_hs_file (ms_location mod_summary) of
                          Just f  -> filter (/= FilePath.normalise f) srcs0
                          Nothing -> srcs0

386 387 388 389 390
            -- sometimes we see source files from earlier
            -- preprocessing stages that cannot be found, so just
            -- filter them out:
            srcs2 <- liftIO $ filterM doesFileExist srcs1

391
            let res = HsParsedModule {
392
                      hpm_module    = rdr_module,
Alan Zimmerman's avatar
Alan Zimmerman committed
393 394
                      hpm_src_files = srcs2,
                      hpm_annotations
Alec Theriault's avatar
Alec Theriault committed
395 396
                              = (M.fromListWith (++) $ annotations pst,
                                 M.fromList $ ((noSrcSpan,comment_q pst)
Alan Zimmerman's avatar
Alan Zimmerman committed
397
                                                 :(annotations_comments pst)))
398
                   }
Simon Marlow's avatar
Simon Marlow committed
399

400 401 402 403 404
            -- apply parse transformation of plugins
            let applyPluginAction p opts
                  = parsedResultAction p opts mod_summary
            withPlugins dflags applyPluginAction res

Simon Marlow's avatar
Simon Marlow committed
405

406 407
-- -----------------------------------------------------------------------------
-- | If the renamed source has been kept, extract it. Dump it if requested.
Alec Theriault's avatar
Alec Theriault committed
408 409
extract_renamed_stuff :: ModSummary -> TcGblEnv -> Hsc RenamedStuff
extract_renamed_stuff mod_summary tc_result = do
410
    let rn_info = getRenamedStuff tc_result
Thomas Schilling's avatar
Thomas Schilling committed
411

412 413 414 415
    dflags <- getDynFlags
    liftIO $ dumpIfSet_dyn dflags Opt_D_dump_rn_ast "Renamer" $
                           showAstData NoBlankSrcSpan rn_info

Alec Theriault's avatar
Alec Theriault committed
416 417
    -- Create HIE files
    when (gopt Opt_WriteHie dflags) $ do
418 419 420
        -- I assume this fromJust is safe because `-fwrite-hie-file`
        -- enables the option which keeps the renamed source.
        hieFile <- mkHieFile mod_summary tc_result (fromJust rn_info)
Alec Theriault's avatar
Alec Theriault committed
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
        let out_file = ml_hie_file $ ms_location mod_summary
        liftIO $ writeHieFile out_file hieFile

        -- Validate HIE files
        when (gopt Opt_ValidateHie dflags) $ do
            hs_env <- Hsc $ \e w -> return (e, w)
            liftIO $ do
              -- Validate Scopes
              case validateScopes $ getAsts $ hie_asts hieFile of
                  [] -> putMsg dflags $ text "Got valid scopes"
                  xs -> do
                    putMsg dflags $ text "Got invalid scopes"
                    mapM_ (putMsg dflags) xs
              -- Roundtrip testing
              nc <- readIORef $ hsc_NC hs_env
              (file', _) <- readHieFile nc out_file
              case diffFile hieFile file' of
                [] ->
                  putMsg dflags $ text "Got no roundtrip errors"
                xs -> do
                  putMsg dflags $ text "Got roundtrip errors"
                  mapM_ (putMsg dflags) xs
    return rn_info
Simon Marlow's avatar
Simon Marlow committed
444

445 446 447 448 449 450

-- -----------------------------------------------------------------------------
-- | 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
Alec Theriault's avatar
Alec Theriault committed
451 452 453
    tc_result <- hsc_typecheck True mod_summary (Just rdr_module)
    rn_info <- extract_renamed_stuff mod_summary tc_result
    return (tc_result, rn_info)
454

Alec Theriault's avatar
Alec Theriault committed
455
-- | Rename and typecheck a module, but don't return the renamed syntax
Edward Z. Yang's avatar
Edward Z. Yang committed
456 457 458 459
hscTypecheck :: Bool -- ^ Keep renamed source?
             -> ModSummary -> Maybe HsParsedModule
             -> Hsc TcGblEnv
hscTypecheck keep_rn mod_summary mb_rdr_module = do
Alec Theriault's avatar
Alec Theriault committed
460 461
    tc_result <- hsc_typecheck keep_rn mod_summary mb_rdr_module
    _ <- extract_renamed_stuff mod_summary tc_result
462 463
    return tc_result

Alec Theriault's avatar
Alec Theriault committed
464
hsc_typecheck :: Bool -- ^ Keep renamed source?
465 466
              -> ModSummary -> Maybe HsParsedModule
              -> Hsc TcGblEnv
Alec Theriault's avatar
Alec Theriault committed
467
hsc_typecheck keep_rn mod_summary mb_rdr_module = do
Edward Z. Yang's avatar
Edward Z. Yang committed
468 469 470 471
    hsc_env <- getHscEnv
    let hsc_src = ms_hsc_src mod_summary
        dflags = hsc_dflags hsc_env
        outer_mod = ms_mod mod_summary
472 473 474
        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
475 476
        src_filename  = ms_hspp_file mod_summary
        real_loc = realSrcLocSpan $ mkRealSrcLoc (mkFastString src_filename) 1 1
Alec Theriault's avatar
Alec Theriault committed
477
        keep_rn' = gopt Opt_WriteHie dflags || keep_rn
Edward Z. Yang's avatar
Edward Z. Yang committed
478 479
    MASSERT( moduleUnitId outer_mod == thisPackage dflags )
    if hsc_src == HsigFile && not (isHoleModule inner_mod)
480
        then ioMsgMaybe $ tcRnInstantiateSignature hsc_env outer_mod' real_loc
Edward Z. Yang's avatar
Edward Z. Yang committed
481 482 483 484
        else
         do hpm <- case mb_rdr_module of
                    Just hpm -> return hpm
                    Nothing -> hscParse' mod_summary
Alec Theriault's avatar
Alec Theriault committed
485
            tc_result0 <- tcRnModule' mod_summary keep_rn' hpm
Edward Z. Yang's avatar
Edward Z. Yang committed
486 487 488
            if hsc_src == HsigFile
                then do (iface, _, _) <- liftIO $ hscSimpleIface hsc_env tc_result0 Nothing
                        ioMsgMaybe $
489
                            tcRnMergeSignatures hsc_env hpm tc_result0 iface
Edward Z. Yang's avatar
Edward Z. Yang committed
490 491
                else return tc_result0

492
-- wrapper around tcRnModule to handle safe haskell extras
493
tcRnModule' :: ModSummary -> Bool -> HsParsedModule
494
            -> Hsc TcGblEnv
495 496
tcRnModule' sum save_rn_syntax mod = do
    hsc_env <- getHscEnv
497 498
    dflags   <- getDynFlags

499 500
    tcg_res <- {-# SCC "Typecheck-Rename" #-}
               ioMsgMaybe $
501
                   tcRnModule hsc_env sum
502
                     save_rn_syntax mod
503

504 505 506
    -- 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)
507
    let allSafeOK = safeInferred dflags && tcSafeOK
508

509
    -- end of the safe haskell line, how to respond to user?
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
    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
535 536 537


    return res
538 539
  where
    pprMod t  = ppr $ moduleName $ tcg_mod t
540
    errSafe t = quotes (pprMod t) <+> text "has been inferred as safe!"
541 542
    errTwthySafe t = quotes (pprMod t)
      <+> text "is marked as Trustworthy but has been inferred as safe!"
543

Simon Marlow's avatar
Simon Marlow committed
544
-- | Convert a typechecked module to Core
545
hscDesugar :: HscEnv -> ModSummary -> TcGblEnv -> IO ModGuts
546
hscDesugar hsc_env mod_summary tc_result =
Ian Lynagh's avatar
Ian Lynagh committed
547
    runHsc hsc_env $ hscDesugar' (ms_location mod_summary) tc_result
548

Ian Lynagh's avatar
Ian Lynagh committed
549 550
hscDesugar' :: ModLocation -> TcGblEnv -> Hsc ModGuts
hscDesugar' mod_location tc_result = do
dterei's avatar
dterei committed
551
    hsc_env <- getHscEnv
Simon Marlow's avatar
Simon Marlow committed
552 553
    r <- ioMsgMaybe $
      {-# SCC "deSugar" #-}
Ian Lynagh's avatar
Ian Lynagh committed
554
      deSugar hsc_env mod_location tc_result
555

dterei's avatar
dterei committed
556 557 558 559
    -- 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
560

dterei's avatar
dterei committed
561
-- | Make a 'ModDetails' from the results of typechecking. Used when
Simon Marlow's avatar
Simon Marlow committed
562
-- typechecking only, as opposed to full compilation.
563 564
makeSimpleDetails :: HscEnv -> TcGblEnv -> IO ModDetails
makeSimpleDetails hsc_env tc_result = mkBootModDetailsTc hsc_env tc_result
Simon Marlow's avatar
Simon Marlow committed
565

566

dterei's avatar
dterei committed
567 568 569 570 571 572 573
{- **********************************************************************
%*                                                                      *
                The main compiler pipeline
%*                                                                      *
%********************************************************************* -}

{-
574 575 576 577
                   --------------------------------
                        The compilation proper
                   --------------------------------

dterei's avatar
dterei committed
578
It's the task of the compilation proper to compile Haskell, hs-boot and core
Gabor Greif's avatar
Gabor Greif committed
579
files to either byte-code, hard-code (C, asm, LLVM, etc.) or to nothing at all
dterei's avatar
dterei committed
580 581 582 583
(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
584
targets byte-code.
dterei's avatar
dterei committed
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609

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


610 611
type Messager = HscEnv -> (Int,Int) -> RecompileRequired -> ModSummary -> IO ()

612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
-- | 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
627
  always_do_basic_recompilation_check m_tc_result
628
  mHscMessage mod_summary source_modified mb_old_iface mod_index
629
    = do
630
    hsc_env <- getHscEnv
631 632 633 634

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

636
        skip iface = do
637
            liftIO $ msg UpToDate
638
            return $ Left iface
dterei's avatar
dterei committed
639

640
        compile mb_old_hash reason = do
641 642 643
            liftIO $ msg reason
            result <- genericHscFrontend mod_summary
            return $ Right (result, mb_old_hash)
dterei's avatar
dterei committed
644 645 646 647

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

649 650 651
    case m_tc_result of
         Just tc_result
          | not always_do_basic_recompilation_check ->
652
             return $ Right (FrontendTypecheck tc_result, Nothing)
653 654 655
         _ -> do
            (recomp_reqd, mb_checked_iface)
                <- {-# SCC "checkOldIface" #-}
656
                   liftIO $ checkOldIface hsc_env mod_summary
657 658 659 660 661 662 663 664
                                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
665 666 667 668 669 670 671 672 673 674 675 676 677
                    -- 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.
678 679 680 681 682 683 684 685 686 687
                    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 ->
688
                        return $ Right (FrontendTypecheck tc_result, mb_old_hash)
689

690
genericHscFrontend :: ModSummary -> Hsc FrontendResult
691 692 693
genericHscFrontend mod_summary =
  getHooked hscFrontendHook genericHscFrontend' >>= ($ mod_summary)

694 695 696
genericHscFrontend' :: ModSummary -> Hsc FrontendResult
genericHscFrontend' mod_summary
    = FrontendTypecheck `fmap` hscFileFrontEnd mod_summary
697

698 699 700 701
--------------------------------------------------------------
-- Compilers
--------------------------------------------------------------

Austin Seipp's avatar
Austin Seipp committed
702
-- Compile Haskell/boot in OneShot mode.
703 704 705 706 707 708 709 710 711 712 713 714 715
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
716
  = do
Matthew Pickering's avatar
Matthew Pickering committed
717 718 719
    dflags <- initializePlugins hsc_env' (hsc_dflags hsc_env')
    let hsc_env'' = hsc_env' { hsc_dflags = dflags }

dterei's avatar
dterei committed
720 721
    -- One-shot mode needs a knot-tying mutable variable for interface
    -- files. See TcRnTypes.TcGblEnv.tcg_type_env_var.
722
    -- See also Note [hsc_type_env_var hack]
dterei's avatar
dterei committed
723 724
    type_env_var <- newIORef emptyNameEnv
    let mod = ms_mod mod_summary
Matthew Pickering's avatar
Matthew Pickering committed
725 726
        hsc_env | isOneShot (ghcMode (hsc_dflags hsc_env''))
                = hsc_env'' { hsc_type_env_var = Just (mod, type_env_var) }
727
                | otherwise
Matthew Pickering's avatar
Matthew Pickering committed
728
                = hsc_env''
729

730 731 732 733 734 735 736 737
    -- 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
738 739
        -- We didn't need to do any typechecking; the old interface
        -- file on disk was good enough.
740
        Left iface -> do
741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
            -- 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.)
762
        Right (FrontendTypecheck tc_result, mb_old_hash) ->
763
            finish mod_summary tc_result mb_old_hash
764 765 766 767 768

-- 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
769
-- in the interface file.
770
finish :: ModSummary
771 772
       -> TcGblEnv
       -> Maybe Fingerprint
773
       -> Hsc (HscStatus, HomeModInfo)
774 775
finish summary tc_result mb_old_hash = do
  hsc_env <- getHscEnv
776 777 778 779 780 781 782 783 784 785 786 787
  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"
788
        (iface, no_change, details) <- liftIO $
789
          hscSimpleIface hsc_env tc_result mb_old_hash
790 791
        return (iface, no_change, details, hsc_status)
  (iface, no_change, details, hsc_status) <-
792 793 794 795 796 797 798 799 800 801 802 803
    -- 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
804 805
            plugins <- liftIO $ readIORef (tcg_th_coreplugins tc_result)
            desugared_guts <- hscSimplify' plugins desugared_guts0
806
            (iface, no_change, details, cgguts) <-
807
              liftIO $ hscNormalIface hsc_env desugared_guts mb_old_hash
808
            return (iface, no_change, details, HscRecomp cgguts summary)
809
      else mk_simple_iface
810
  liftIO $ hscMaybeWriteIface dflags iface no_change summary
811 812 813 814
  return
    ( hsc_status
    , HomeModInfo
      {hm_details = details, hm_iface = iface, hm_linkable = Nothing})
815 816

hscMaybeWriteIface :: DynFlags -> ModIface -> Bool -> ModSummary -> IO ()
817
hscMaybeWriteIface dflags iface no_change summary =
818 819 820 821 822 823
    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) $
824
            hscWriteIface dflags iface no_change summary
825

826 827 828 829
--------------------------------------------------------------
-- NoRecomp handlers
--------------------------------------------------------------

830
-- NB: this must be knot-tied appropriately, see hscIncrementalCompile
831 832
genModDetails :: HscEnv -> ModIface -> IO ModDetails
genModDetails hsc_env old_iface
833
  = do
dterei's avatar
dterei committed
834
    new_details <- {-# SCC "tcRnIface" #-}
835
                   initIfaceLoad hsc_env (typecheckIface old_iface)
836
    dumpIfaceStats hsc_env
dterei's avatar
dterei committed
837
    return new_details
838

839 840 841 842
--------------------------------------------------------------
-- Progress displayers.
--------------------------------------------------------------

843 844
oneShotMsg :: HscEnv -> RecompileRequired -> IO ()
oneShotMsg hsc_env recomp =
dterei's avatar
dterei committed
845
    case recomp of
846
        UpToDate ->
847 848
            compilationProgressMsg (hsc_dflags hsc_env) $
                   "compilation IS NOT required"
849
        _ ->
850 851
            return ()

852 853
batchMsg :: Messager
batchMsg hsc_env mod_index recomp mod_summary =
dterei's avatar
dterei committed
854
    case recomp of
855 856 857
        MustCompile -> showMsg "Compiling " ""
        UpToDate
            | verbosity (hsc_dflags hsc_env) >= 2 -> showMsg "Skipping  " ""
dterei's avatar
dterei committed
858
            | otherwise -> return ()
859
        RecompBecause reason -> showMsg "Compiling " (" [" ++ reason ++ "]")
dterei's avatar
dterei committed
860
    where
Ian Lynagh's avatar
Ian Lynagh committed
861
        dflags = hsc_dflags hsc_env
862
        showMsg msg reason =
Ian Lynagh's avatar
Ian Lynagh committed
863
            compilationProgressMsg dflags $
864
            (showModuleIndex mod_index ++
Ian Lynagh's avatar
Ian Lynagh committed
865
            msg ++ showModMsg dflags (hscTarget dflags)
866 867
                              (recompileRequired recomp) mod_summary)
                ++ reason
868

869 870 871
--------------------------------------------------------------
-- FrontEnds
--------------------------------------------------------------
872

873 874
-- | Given a 'ModSummary', parses and typechecks it, returning the
-- 'TcGblEnv' resulting from type-checking.
875
hscFileFrontEnd :: ModSummary -> Hsc TcGblEnv
Edward Z. Yang's avatar
Edward Z. Yang committed
876
hscFileFrontEnd mod_summary = hscTypecheck False mod_summary Nothing
877 878

--------------------------------------------------------------
879
-- Safe Haskell
880 881
--------------------------------------------------------------

882 883 8