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

dterei's avatar
dterei committed
4 5
-------------------------------------------------------------------------------
--
6
-- | Main API for compiling plain Haskell source code.
7
--
dterei's avatar
dterei committed
8
-- This module implements compilation of a Haskell source. It is
9 10 11 12 13
-- /not/ concerned with preprocessing of source files; this is handled
-- in "DriverPipeline".
--
-- There are various entry points depending on what mode we're in:
-- "batch" mode (@--make@), "one-shot" mode (@-c@, @-S@ etc.), and
dterei's avatar
dterei committed
14
-- "interactive" mode (GHCi). There are also entry points for
15 16 17 18 19 20 21 22
-- individual passes: parsing, typechecking/renaming, desugaring, and
-- simplification.
--
-- All the functions here take an 'HscEnv' as a parameter, but none of
-- them return a new one: 'HscEnv' is treated as an immutable value
-- from here on in (although it has mutable components, for the
-- caches).
--
23 24 25 26 27
-- We use the Hsc monad to deal with warning messages consistently:
-- specifically, while executing within an Hsc monad, warnings are
-- collected. When a Hsc monad returns to an IO monad, the
-- warnings are printed, or compilation aborts if the @-Werror@
-- flag is enabled.
28
--
dterei's avatar
dterei committed
29 30 31 32
-- (c) The GRASP/AQUA Project, Glasgow University, 1993-2000
--
-------------------------------------------------------------------------------

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

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

45 46 47
    , hscGenHardCode
    , hscInteractive

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

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

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

87 88
import GhcPrelude

89
import Data.Data hiding (Fixity, TyCon)
Alec Theriault's avatar
Alec Theriault committed
90
import Data.Maybe       ( fromJust )
Simon Marlow's avatar
Simon Marlow committed
91
import Id
92
import GHC.Runtime.Interpreter ( addSptEntry )
93
import GHCi.RemoteTypes ( ForeignHValue )
94 95
import GHC.CoreToByteCode ( byteCodeGen, coreExprToBCOs )
import GHC.Runtime.Linker
96
import CoreTidy         ( tidyExpr )
97 98
import Type             ( Type )
import {- Kind parts of -} Type         ( Kind )
99
import CoreLint         ( lintInteractiveExpr )
100
import VarEnv           ( emptyTidyEnv )
101
import Panic
102
import ConLike
103
import Control.Concurrent
104

105
import ApiAnnotation
106 107
import Module
import Packages
Simon Marlow's avatar
Simon Marlow committed
108
import RdrName
Sylvain Henry's avatar
Sylvain Henry committed
109 110
import GHC.Hs
import GHC.Hs.Dump
111
import CoreSyn
Ian Lynagh's avatar
Ian Lynagh committed
112
import StringBuffer
113
import Parser
114
import Lexer
115 116
import SrcLoc
import TcRnDriver
117
import GHC.IfaceToCore  ( typecheckIface )
118
import TcRnMonad
xldenis's avatar
xldenis committed
119
import TcHsSyn          ( ZonkFlexi (DefaultFlexi) )
120
import NameCache        ( initNameCache )
121
import GHC.Iface.Load   ( ifaceStats, initExternalPackageState )
122
import PrelInfo
123
import GHC.Iface.Utils
124
import GHC.HsToCore
125
import SimplCore
126
import GHC.Iface.Tidy
Sylvain Henry's avatar
Sylvain Henry committed
127
import GHC.CoreToStg.Prep
128
import GHC.CoreToStg    ( coreToStg )
Sylvain Henry's avatar
Sylvain Henry committed
129 130 131
import GHC.Stg.Syntax
import GHC.Stg.FVs      ( annTopBindingsFreeVars )
import GHC.Stg.Pipeline ( stg2stg )
132
import qualified GHC.StgToCmm as StgToCmm ( codeGen )
133
import CostCentre
134
import ProfInit
135 136
import TyCon
import Name
137
import NameSet
138 139 140 141 142
import GHC.Cmm
import GHC.Cmm.Parser         ( parseCmmFile )
import GHC.Cmm.Info.Build
import GHC.Cmm.Pipeline
import GHC.Cmm.Info
143 144
import CodeOutput
import InstEnv
145
import FamInstEnv
Thomas Schilling's avatar
Thomas Schilling committed
146
import Fingerprint      ( Fingerprint )
147
import Hooks
Edward Z. Yang's avatar
Edward Z. Yang committed
148
import TcEnv
149
import PrelNames
150
import Plugins
151
import GHC.Runtime.Loader   ( initializePlugins )
152

153
import DynFlags
154
import ErrUtils
155

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

167
import Util
Simon Marlow's avatar
Simon Marlow committed
168

169
import Data.List        ( nub, isPrefixOf, partition )
Simon Marlow's avatar
Simon Marlow committed
170 171
import Control.Monad
import Data.IORef
172
import System.FilePath as FilePath
173
import System.Directory
174
import System.IO (fixIO)
Alec Theriault's avatar
Alec Theriault committed
175
import qualified Data.Map as M
176 177
import qualified Data.Set as S
import Data.Set (Set)
178
import Data.Functor
179
import Control.DeepSeq (force)
dterei's avatar
dterei committed
180

181 182 183 184
import GHC.Iface.Ext.Ast    ( mkHieFile )
import GHC.Iface.Ext.Types  ( getAsts, hie_asts, hie_module )
import GHC.Iface.Ext.Binary ( readHieFile, writeHieFile , hie_file_result)
import GHC.Iface.Ext.Debug  ( diffFile, validateScopes )
Alec Theriault's avatar
Alec Theriault committed
185

Thomas Schilling's avatar
Thomas Schilling committed
186
#include "HsVersions.h"
187

188

dterei's avatar
dterei committed
189 190 191 192 193
{- **********************************************************************
%*                                                                      *
                Initialisation
%*                                                                      *
%********************************************************************* -}
194

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

216
-- -----------------------------------------------------------------------------
217

218
getWarnings :: Hsc WarningMessages
dterei's avatar
dterei committed
219
getWarnings = Hsc $ \_ w -> return (w, w)
220 221

clearWarnings :: Hsc ()
dterei's avatar
dterei committed
222
clearWarnings = Hsc $ \_ _ -> return ((), emptyBag)
223 224

logWarnings :: WarningMessages -> Hsc ()
dterei's avatar
dterei committed
225
logWarnings w = Hsc $ \_ w0 -> return ((), w0 `unionBags` w)
226 227

getHscEnv :: Hsc HscEnv
dterei's avatar
dterei committed
228
getHscEnv = Hsc $ \e w -> return (e, w)
229 230 231

handleWarnings :: Hsc ()
handleWarnings = do
dterei's avatar
dterei committed
232 233 234 235
    dflags <- getDynFlags
    w <- getWarnings
    liftIO $ printOrThrowWarnings dflags w
    clearWarnings
236 237 238 239 240

-- | 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
241 242
    logWarnings warns
    when (not $ isEmptyBag errs) $ throwErrors errs
243

244 245 246 247 248 249 250 251 252
-- | 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)
253 254 255 256 257

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

-- | 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
282 283 284
    ((warns,_errs), mb_r) <- liftIO $ ioA
    logWarnings warns
    return mb_r
285 286 287 288

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

289
hscTcRnLookupRdrName :: HscEnv -> Located RdrName -> IO [Name]
290 291
hscTcRnLookupRdrName hsc_env0 rdr_name
  = runInteractiveHsc hsc_env0 $
292 293
    do { hsc_env <- getHscEnv
       ; ioMsgMaybe $ tcRnLookupRdrName hsc_env rdr_name }
294 295

hscTcRcLookupName :: HscEnv -> Name -> IO (Maybe TyThing)
296 297 298
hscTcRcLookupName hsc_env0 name = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe' $ tcRnLookupName hsc_env name
dterei's avatar
dterei committed
299 300 301
      -- 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.
302

303 304
hscTcRnGetInfo :: HscEnv -> Name
               -> IO (Maybe (TyThing, Fixity, [ClsInst], [FamInst], SDoc))
305 306 307 308
hscTcRnGetInfo hsc_env0 name
  = runInteractiveHsc hsc_env0 $
    do { hsc_env <- getHscEnv
       ; ioMsgMaybe' $ tcRnGetInfo hsc_env name }
309

dterei's avatar
dterei committed
310
hscIsGHCiMonad :: HscEnv -> String -> IO Name
Edsko de Vries's avatar
Edsko de Vries committed
311
hscIsGHCiMonad hsc_env name
312
  = runHsc hsc_env $ ioMsgMaybe $ isGHCiMonad hsc_env name
dterei's avatar
dterei committed
313

314
hscGetModuleInterface :: HscEnv -> Module -> IO ModIface
315 316 317
hscGetModuleInterface hsc_env0 mod = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe $ getModuleInterface hsc_env mod
318 319 320

-- -----------------------------------------------------------------------------
-- | Rename some import declarations
321
hscRnImportDecls :: HscEnv -> [LImportDecl GhcPs] -> IO GlobalRdrEnv
322 323 324
hscRnImportDecls hsc_env0 import_decls = runInteractiveHsc hsc_env0 $ do
  hsc_env <- getHscEnv
  ioMsgMaybe $ tcRnImportDecls hsc_env import_decls
325

326
-- -----------------------------------------------------------------------------
Simon Marlow's avatar
Simon Marlow committed
327
-- | parse a file, returning the abstract syntax
328

329
hscParse :: HscEnv -> ModSummary -> IO HsParsedModule
330 331 332
hscParse hsc_env mod_summary = runHsc hsc_env $ hscParse' mod_summary

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

dterei's avatar
dterei committed
343
    --------------------------  Parser  ----------------
344 345 346
    -- 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
347 348 349
    buf <- case maybe_src_buf of
               Just b  -> return b
               Nothing -> liftIO $ hGetStringBuffer src_filename
350

dterei's avatar
dterei committed
351
    let loc = mkRealSrcLoc (mkFastString src_filename) 1 1
Edward Z. Yang's avatar
Edward Z. Yang committed
352 353 354
    let parseMod | HsigFile == ms_hsc_src mod_summary
                 = parseSignature
                 | otherwise = parseModule
355

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

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

391 392 393 394 395
            -- sometimes we see source files from earlier
            -- preprocessing stages that cannot be found, so just
            -- filter them out:
            srcs2 <- liftIO $ filterM doesFileExist srcs1

396 397 398 399 400 401 402
            let api_anns = ApiAnns {
                      apiAnnItems = M.fromListWith (++) $ annotations pst,
                      apiAnnEofPos = eof_pos pst,
                      apiAnnComments = M.fromList (annotations_comments pst),
                      apiAnnRogueComments = comment_q pst
                   }
                res = HsParsedModule {
403
                      hpm_module    = rdr_module,
Alan Zimmerman's avatar
Alan Zimmerman committed
404
                      hpm_src_files = srcs2,
405
                      hpm_annotations = api_anns
406
                   }
Simon Marlow's avatar
Simon Marlow committed
407

408 409 410 411 412
            -- 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
413

414 415
-- -----------------------------------------------------------------------------
-- | If the renamed source has been kept, extract it. Dump it if requested.
Alec Theriault's avatar
Alec Theriault committed
416 417
extract_renamed_stuff :: ModSummary -> TcGblEnv -> Hsc RenamedStuff
extract_renamed_stuff mod_summary tc_result = do
418
    let rn_info = getRenamedStuff tc_result
Thomas Schilling's avatar
Thomas Schilling committed
419

420
    dflags <- getDynFlags
Sylvain Henry's avatar
Sylvain Henry committed
421 422
    liftIO $ dumpIfSet_dyn dflags Opt_D_dump_rn_ast "Renamer"
                FormatHaskell (showAstData NoBlankSrcSpan rn_info)
423

Alec Theriault's avatar
Alec Theriault committed
424 425
    -- Create HIE files
    when (gopt Opt_WriteHie dflags) $ do
426 427 428
        -- 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
429 430 431 432 433 434 435 436
        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
437 438
              let mdl = hie_module hieFile
              case validateScopes mdl $ getAsts $ hie_asts hieFile of
Alec Theriault's avatar
Alec Theriault committed
439 440 441 442 443 444 445
                  [] -> 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
446
              case diffFile hieFile (hie_file_result file') of
Alec Theriault's avatar
Alec Theriault committed
447 448 449 450 451 452
                [] ->
                  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
453

454 455 456 457 458

-- -----------------------------------------------------------------------------
-- | Rename and typecheck a module, additionally returning the renamed syntax
hscTypecheckRename :: HscEnv -> ModSummary -> HsParsedModule
                   -> IO (TcGblEnv, RenamedStuff)
459 460
hscTypecheckRename hsc_env mod_summary rdr_module = runHsc hsc_env $
    hsc_typecheck True mod_summary (Just rdr_module)
461 462


463 464 465 466
-- | A bunch of logic piled around around @tcRnModule'@, concerning a) backpack
-- b) concerning dumping rename info and hie files. It would be nice to further
-- separate this stuff out, probably in conjunction better separating renaming
-- and type checking (#17781).
Alec Theriault's avatar
Alec Theriault committed
467
hsc_typecheck :: Bool -- ^ Keep renamed source?
468
              -> ModSummary -> Maybe HsParsedModule
469
              -> Hsc (TcGblEnv, RenamedStuff)
Alec Theriault's avatar
Alec Theriault committed
470
hsc_typecheck keep_rn mod_summary mb_rdr_module = do
Edward Z. Yang's avatar
Edward Z. Yang committed
471 472 473 474
    hsc_env <- getHscEnv
    let hsc_src = ms_hsc_src mod_summary
        dflags = hsc_dflags hsc_env
        outer_mod = ms_mod mod_summary
475 476 477
        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
478 479
        src_filename  = ms_hspp_file mod_summary
        real_loc = realSrcLocSpan $ mkRealSrcLoc (mkFastString src_filename) 1 1
Alec Theriault's avatar
Alec Theriault committed
480
        keep_rn' = gopt Opt_WriteHie dflags || keep_rn
Edward Z. Yang's avatar
Edward Z. Yang committed
481
    MASSERT( moduleUnitId outer_mod == thisPackage dflags )
482
    tc_result <- if hsc_src == HsigFile && not (isHoleModule inner_mod)
483
        then ioMsgMaybe $ tcRnInstantiateSignature hsc_env outer_mod' real_loc
Edward Z. Yang's avatar
Edward Z. Yang committed
484 485 486 487
        else
         do hpm <- case mb_rdr_module of
                    Just hpm -> return hpm
                    Nothing -> hscParse' mod_summary
Alec Theriault's avatar
Alec Theriault committed
488
            tc_result0 <- tcRnModule' mod_summary keep_rn' hpm
Edward Z. Yang's avatar
Edward Z. Yang committed
489 490 491
            if hsc_src == HsigFile
                then do (iface, _, _) <- liftIO $ hscSimpleIface hsc_env tc_result0 Nothing
                        ioMsgMaybe $
492
                            tcRnMergeSignatures hsc_env hpm tc_result0 iface
Edward Z. Yang's avatar
Edward Z. Yang committed
493
                else return tc_result0
494 495 496 497
    -- TODO are we extracting anything when we merely instantiate a signature?
    -- If not, try to move this into the "else" case above.
    rn_info <- extract_renamed_stuff mod_summary tc_result
    return (tc_result, rn_info)
Edward Z. Yang's avatar
Edward Z. Yang committed
498

499
-- wrapper around tcRnModule to handle safe haskell extras
500
tcRnModule' :: ModSummary -> Bool -> HsParsedModule
501
            -> Hsc TcGblEnv
502 503
tcRnModule' sum save_rn_syntax mod = do
    hsc_env <- getHscEnv
504 505
    dflags   <- getDynFlags

506 507 508 509 510 511 512 513
    -- -Wmissing-safe-haskell-mode
    when (not (safeHaskellModeEnabled dflags)
          && wopt Opt_WarnMissingSafeHaskellMode dflags) $
        logWarnings $ unitBag $
        makeIntoWarning (Reason Opt_WarnMissingSafeHaskellMode) $
        mkPlainWarnMsg dflags (getLoc (hpm_module mod)) $
        warnMissingSafeHaskellMode

514 515
    tcg_res <- {-# SCC "Typecheck-Rename" #-}
               ioMsgMaybe $
516
                   tcRnModule hsc_env sum
517
                     save_rn_syntax mod
518

519 520 521
    -- 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)
522
    let allSafeOK = safeInferred dflags && tcSafeOK
523

524
    -- end of the safe haskell line, how to respond to user?
525 526 527 528 529 530 531 532 533 534 535
    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
536 537 538
                     True
                       | safeHaskell dflags == Sf_Safe -> return ()
                       | otherwise -> (logWarnings $ unitBag $
539 540 541 542 543 544 545 546 547 548 549 550 551
                              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
552 553 554


    return res
555 556
  where
    pprMod t  = ppr $ moduleName $ tcg_mod t
557
    errSafe t = quotes (pprMod t) <+> text "has been inferred as safe!"
558 559
    errTwthySafe t = quotes (pprMod t)
      <+> text "is marked as Trustworthy but has been inferred as safe!"
560 561
    warnMissingSafeHaskellMode = ppr (moduleName (ms_mod sum))
      <+> text "is missing Safe Haskell mode"
562

Simon Marlow's avatar
Simon Marlow committed
563
-- | Convert a typechecked module to Core
564
hscDesugar :: HscEnv -> ModSummary -> TcGblEnv -> IO ModGuts
565
hscDesugar hsc_env mod_summary tc_result =
Ian Lynagh's avatar
Ian Lynagh committed
566
    runHsc hsc_env $ hscDesugar' (ms_location mod_summary) tc_result
567

Ian Lynagh's avatar
Ian Lynagh committed
568 569
hscDesugar' :: ModLocation -> TcGblEnv -> Hsc ModGuts
hscDesugar' mod_location tc_result = do
dterei's avatar
dterei committed
570
    hsc_env <- getHscEnv
Simon Marlow's avatar
Simon Marlow committed
571 572
    r <- ioMsgMaybe $
      {-# SCC "deSugar" #-}
Ian Lynagh's avatar
Ian Lynagh committed
573
      deSugar hsc_env mod_location tc_result
574

dterei's avatar
dterei committed
575 576 577 578
    -- 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
579

dterei's avatar
dterei committed
580
-- | Make a 'ModDetails' from the results of typechecking. Used when
Simon Marlow's avatar
Simon Marlow committed
581
-- typechecking only, as opposed to full compilation.
582 583
makeSimpleDetails :: HscEnv -> TcGblEnv -> IO ModDetails
makeSimpleDetails hsc_env tc_result = mkBootModDetailsTc hsc_env tc_result
Simon Marlow's avatar
Simon Marlow committed
584

585

dterei's avatar
dterei committed
586 587 588 589 590 591 592
{- **********************************************************************
%*                                                                      *
                The main compiler pipeline
%*                                                                      *
%********************************************************************* -}

{-
593 594 595 596
                   --------------------------------
                        The compilation proper
                   --------------------------------

dterei's avatar
dterei committed
597
It's the task of the compilation proper to compile Haskell, hs-boot and core
Gabor Greif's avatar
Gabor Greif committed
598
files to either byte-code, hard-code (C, asm, LLVM, etc.) or to nothing at all
dterei's avatar
dterei committed
599 600 601 602
(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
603
targets byte-code.
dterei's avatar
dterei committed
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628

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


629 630
type Messager = HscEnv -> (Int,Int) -> RecompileRequired -> ModSummary -> IO ()

631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
-- | 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
646
  always_do_basic_recompilation_check m_tc_result
647
  mHscMessage mod_summary source_modified mb_old_iface mod_index
648
    = do
649
    hsc_env <- getHscEnv
650 651 652 653

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

655
        skip iface = do
656
            liftIO $ msg UpToDate
657
            return $ Left iface
dterei's avatar
dterei committed
658

659
        compile mb_old_hash reason = do
660
            liftIO $ msg reason
661 662
            (tc_result, _) <- hsc_typecheck False mod_summary Nothing
            return $ Right (FrontendTypecheck tc_result, mb_old_hash)
dterei's avatar
dterei committed
663 664 665 666

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

668 669 670
    case m_tc_result of
         Just tc_result
          | not always_do_basic_recompilation_check ->
671
             return $ Right (FrontendTypecheck tc_result, Nothing)
672 673 674
         _ -> do
            (recomp_reqd, mb_checked_iface)
                <- {-# SCC "checkOldIface" #-}
675
                   liftIO $ checkOldIface hsc_env mod_summary
676 677 678 679
                                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.
680
            let mb_old_hash = fmap (mi_iface_hash . mi_final_exts) mb_checked_iface
681 682 683

            case mb_checked_iface of
                Just iface | not (recompileRequired recomp_reqd) ->
Simon Marlow's avatar
Simon Marlow committed
684 685 686 687 688 689 690 691 692 693 694 695 696
                    -- 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.
697 698 699 700 701 702 703 704 705 706
                    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 ->
707
                        return $ Right (FrontendTypecheck tc_result, mb_old_hash)
708

709 710 711 712
--------------------------------------------------------------
-- Compilers
--------------------------------------------------------------

713 714 715 716 717
-- | Used by both OneShot and batch mode. Runs the pipeline HsSyn and Core parts
-- of the pipeline.
-- We return a interface if we already had an old one around and recompilation
-- was not needed. Otherwise it will be created during later passes when we
-- run the compilation pipeline.
718 719 720 721 722 723 724 725
hscIncrementalCompile :: Bool
                      -> Maybe TcGblEnv
                      -> Maybe Messager
                      -> HscEnv
                      -> ModSummary
                      -> SourceModified
                      -> Maybe ModIface
                      -> (Int,Int)
726
                      -> IO (HscStatus, DynFlags)
727 728
hscIncrementalCompile always_do_basic_recompilation_check m_tc_result
    mHscMessage hsc_env' mod_summary source_modified mb_old_iface mod_index
729
  = do
Matthew Pickering's avatar
Matthew Pickering committed
730 731 732
    dflags <- initializePlugins hsc_env' (hsc_dflags hsc_env')
    let hsc_env'' = hsc_env' { hsc_dflags = dflags }

dterei's avatar
dterei committed
733 734
    -- One-shot mode needs a knot-tying mutable variable for interface
    -- files. See TcRnTypes.TcGblEnv.tcg_type_env_var.
735
    -- See also Note [hsc_type_env_var hack]
dterei's avatar
dterei committed
736 737
    type_env_var <- newIORef emptyNameEnv
    let mod = ms_mod mod_summary
Matthew Pickering's avatar
Matthew Pickering committed
738 739
        hsc_env | isOneShot (ghcMode (hsc_dflags hsc_env''))
                = hsc_env'' { hsc_type_env_var = Just (mod, type_env_var) }
740
                | otherwise
Matthew Pickering's avatar
Matthew Pickering committed
741
                = hsc_env''
742

743 744 745 746 747 748 749 750
    -- 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
751 752
        -- We didn't need to do any typechecking; the old interface
        -- file on disk was good enough.
753
        Left iface -> do
754
            -- Knot tying!  See Note [Knot-tying typecheckIface]
755
            details <- liftIO . fixIO $ \details' -> do
756 757 758
                let hsc_env' =
                        hsc_env {
                            hsc_HPT = addToHpt (hsc_HPT hsc_env)
759
                                        (ms_mod_name mod_summary) (HomeModInfo iface details' Nothing)
760 761 762 763 764 765
                        }
                -- 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
766
                return details
767
            return (HscUpToDate iface details, dflags)
768 769 770 771
        -- 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.)
772
        Right (FrontendTypecheck tc_result, mb_old_hash) -> do
773 774
            status <- finish mod_summary tc_result mb_old_hash
            return (status, dflags)
775

776 777 778 779 780 781 782 783 784 785 786 787
-- Runs the post-typechecking frontend (desugar and simplify). We want to
-- generate most of the interface as late as possible. This gets us up-to-date
-- and good unfoldings and other info in the interface file.
--
-- We might create a interface right away, in which case we also return the
-- updated HomeModInfo. But we might also need to run the backend first. In the
-- later case Status will be HscRecomp and we return a function from ModIface ->
-- HomeModInfo.
--
-- HscRecomp in turn will carry the information required to compute a interface
-- when passed the result of the code generator. So all this can and is done at
-- the call site of the backend code gen if it is run.
788
finish :: ModSummary
789 790
       -> TcGblEnv
       -> Maybe Fingerprint
791
       -> Hsc HscStatus
792 793
finish summary tc_result mb_old_hash = do
  hsc_env <- getHscEnv
794 795 796
  let dflags = hsc_dflags hsc_env
      target = hscTarget dflags
      hsc_src = ms_hsc_src summary
797

John Ericson's avatar
John Ericson committed
798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
  -- Desugar, if appropriate
  --
  -- 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.
  mb_desugar <-
      if ms_mod summary /= gHC_PRIM && hsc_src == HsSrcFile
      then Just <$> hscDesugar' (ms_location summary) tc_result
      else pure Nothing

  -- Simplify, if appropriate, and (whether we simplified or not) generate an
  -- interface file.
  case mb_desugar of
      -- Just cause we desugared doesn't mean we are generating code, see above.
      Just desugared_guts | target /= HscNothing -> do
814
          plugins <- liftIO $ readIORef (tcg_th_coreplugins tc_result)
John Ericson's avatar
John Ericson committed
815
          simplified_guts <- hscSimplify' plugins desugared_guts
816 817

          (cg_guts, details) <- {-# SCC "CoreTidy" #-}
John Ericson's avatar
John Ericson committed
818
              liftIO $ tidyProgram hsc_env simplified_guts
819 820 821 822 823

          let !partial_iface =
                {-# SCC "HscMain.mkPartialIface" #-}
                -- This `force` saves 2M residency in test T10370
                -- See Note [Avoiding space leaks in toIface*] for details.
John Ericson's avatar
John Ericson committed
824
                force (mkPartialIface hsc_env details simplified_guts)
825

826 827 828 829 830 831
          return HscRecomp { hscs_guts = cg_guts,
                             hscs_mod_location = ms_location summary,
                             hscs_mod_details = details,
                             hscs_partial_iface = partial_iface,
                             hscs_old_iface_hash = mb_old_hash,
                             hscs_iface_dflags = dflags }
832

John Ericson's avatar
John Ericson committed
833 834 835 836 837 838 839 840 841 842 843 844 845
      -- We are not generating code, so we can skip simplification
      -- and generate a simple interface.
      _ -> do
        (iface, mb_old_iface_hash, details) <- liftIO $
          hscSimpleIface hsc_env tc_result mb_old_hash

        liftIO $ hscMaybeWriteIface dflags iface mb_old_iface_hash (ms_location summary)

        return $ case (target, hsc_src) of
          (HscNothing, _) -> HscNotGeneratingCode iface details
          (_, HsBootFile) -> HscUpdateBoot iface details
          (_, HsigFile) -> HscUpdateSig iface details
          _ -> panic "finish"
846 847 848 849 850 851 852 853 854 855 856 857 858 859 860

{-
Note [Writing interface files]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

We write interface files in HscMain.hs and DriverPipeline.hs using
hscMaybeWriteIface, but only once per compilation (twice with dynamic-too).

* If a compilation does NOT require (re)compilation of the hard code we call
  hscMaybeWriteIface inside HscMain:finish.
* If we run in One Shot mode and target bytecode we write it in compileOne'
* Otherwise we must be compiling to regular hard code and require recompilation.
  In this case we create the interface file inside RunPhase using the interface
  generator contained inside the HscRecomp status.
-}
861 862
hscMaybeWriteIface :: DynFlags -> ModIface -> Maybe Fingerprint -> ModLocation -> IO ()
hscMaybeWriteIface dflags iface old_iface location = do
863 864 865 866 867
    let force_write_interface = gopt Opt_WriteInterface dflags
        write_interface = case hscTarget dflags of
                            HscNothing      -> False
                            HscInterpreted  -> False
                            _               -> True
868 869 870 871
        no_change = old_iface == Just (mi_iface_hash (mi_final_exts iface))

    when (write_interface || force_write_interface) $
          hscWriteIface dflags iface no_change location
872

873 874 875 876
--------------------------------------------------------------
-- NoRecomp handlers
--------------------------------------------------------------

877
-- NB: this must be knot-tied appropriately, see hscIncrementalCompile
878 879
genModDetails :: HscEnv -> ModIface -> IO ModDetails
genModDetails hsc_env old_iface
880
  = do
dterei's avatar
dterei committed
881
    new_details <- {-# SCC "tcRnIface" #-}
882
                   initIfaceLoad hsc_env (typecheckIface old_iface)
883
    dumpIfaceStats hsc_env
dterei's avatar
dterei committed
884
    return new_details
885

886 887 888 889
--------------------------------------------------------------
-- Progress displayers.
--------------------------------------------------------------

890 891
oneShotMsg :: HscEnv -> RecompileRequired -> IO ()
oneShotMsg hsc_env recomp =
dterei's avatar
dterei committed
892
    case recomp of
893
        UpToDate ->
894 895
            compilationProgressMsg (hsc_dflags hsc_env) $
                   "compilation IS NOT required"
896
        _ ->
897 898
            return ()

899 900
batchMsg :: Messager
batchMsg hsc_env mod_index recomp mod_summary =
dterei's avatar
dterei committed
901
    case recomp of
902 903 904
        MustCompile -> showMsg "Compiling " ""
        UpToDate
            | verbosity (hsc_dflags hsc_env) >= 2 -> showMsg "Skipping  " ""
dterei's avatar
dterei committed
905
            | otherwise -> return ()
906
        RecompBecause reason -> showMsg "Compiling " (" [" ++ reason ++ "]")
dterei's avatar
dterei committed
907
    where
Ian Lynagh's avatar
Ian Lynagh committed
908
        dflags = hsc_dflags hsc_env
909
        showMsg msg reason =
Ian Lynagh's avatar
Ian Lynagh committed
910
            compilationProgressMsg dflags $
911
            (showModuleIndex mod_index ++
Ian Lynagh's avatar
Ian Lynagh committed
912
            msg ++ showModMsg dflags (hscTarget dflags)
913 914
                              (recompileRequired recomp) mod_summary)
                ++ reason
915

916
--------------------------------------------------------------