Add API Annotations
[ghc.git] / compiler / main / HscMain.hs
1 {-# LANGUAGE BangPatterns, CPP, MagicHash, NondecreasingIndentation #-}
2
3 -------------------------------------------------------------------------------
4 --
5 -- | Main API for compiling plain Haskell source code.
6 --
7 -- This module implements compilation of a Haskell source. It is
8 -- /not/ concerned with preprocessing of source files; this is handled
9 -- in "DriverPipeline".
10 --
11 -- There are various entry points depending on what mode we're in:
12 -- "batch" mode (@--make@), "one-shot" mode (@-c@, @-S@ etc.), and
13 -- "interactive" mode (GHCi). There are also entry points for
14 -- individual passes: parsing, typechecking/renaming, desugaring, and
15 -- simplification.
16 --
17 -- All the functions here take an 'HscEnv' as a parameter, but none of
18 -- them return a new one: 'HscEnv' is treated as an immutable value
19 -- from here on in (although it has mutable components, for the
20 -- caches).
21 --
22 -- Warning messages are dealt with consistently throughout this API:
23 -- during compilation warnings are collected, and before any function
24 -- in @HscMain@ returns, the warnings are either printed, or turned
25 -- into a real compialtion error if the @-Werror@ flag is enabled.
26 --
27 -- (c) The GRASP/AQUA Project, Glasgow University, 1993-2000
28 --
29 -------------------------------------------------------------------------------
30
31 module HscMain
32 (
33 -- * Making an HscEnv
34 newHscEnv
35
36 -- * Compiling complete source files
37 , Messager, batchMsg
38 , HscStatus (..)
39 , hscCompileOneShot
40 , hscCompileCmmFile
41 , hscCompileCore
42
43 , genericHscCompileGetFrontendResult
44
45 , genModDetails
46 , hscSimpleIface
47 , hscWriteIface
48 , hscNormalIface
49 , hscGenHardCode
50 , hscInteractive
51
52 -- * Running passes separately
53 , hscParse
54 , hscTypecheckRename
55 , hscDesugar
56 , makeSimpleIface
57 , makeSimpleDetails
58 , hscSimplify -- ToDo, shouldn't really export this
59
60 -- * Support for interactive evaluation
61 , hscParseIdentifier
62 , hscTcRcLookupName
63 , hscTcRnGetInfo
64 , hscCheckSafe
65 , hscGetSafe
66 #ifdef GHCI
67 , hscIsGHCiMonad
68 , hscGetModuleInterface
69 , hscRnImportDecls
70 , hscTcRnLookupRdrName
71 , hscStmt, hscStmtWithLocation
72 , hscDecls, hscDeclsWithLocation
73 , hscTcExpr, hscImport, hscKcType
74 , hscCompileCoreExpr
75 -- * Low-level exports for hooks
76 , hscCompileCoreExpr'
77 #endif
78 -- We want to make sure that we export enough to be able to redefine
79 -- hscFileFrontEnd in client code
80 , hscParse', hscSimplify', hscDesugar', tcRnModule'
81 , getHscEnv
82 , hscSimpleIface', hscNormalIface'
83 , oneShotMsg
84 , hscFileFrontEnd, genericHscFrontend, dumpIfaceStats
85 ) where
86
87 #ifdef GHCI
88 import Id
89 import BasicTypes ( HValue )
90 import ByteCodeGen ( byteCodeGen, coreExprToBCOs )
91 import Linker
92 import CoreTidy ( tidyExpr )
93 import Type ( Type )
94 import PrelNames
95 import {- Kind parts of -} Type ( Kind )
96 import CoreMonad ( lintInteractiveExpr )
97 import DsMeta ( templateHaskellNames )
98 import VarEnv ( emptyTidyEnv )
99 import Panic
100
101 import GHC.Exts
102 #endif
103
104 import Module
105 import Packages
106 import RdrName
107 import HsSyn
108 import CoreSyn
109 import StringBuffer
110 import Parser
111 import Lexer
112 import SrcLoc
113 import TcRnDriver
114 import TcIface ( typecheckIface )
115 import TcRnMonad
116 import IfaceEnv ( initNameCache )
117 import LoadIface ( ifaceStats, initExternalPackageState )
118 import PrelInfo
119 import MkIface
120 import Desugar
121 import SimplCore
122 import TidyPgm
123 import CorePrep
124 import CoreToStg ( coreToStg )
125 import qualified StgCmm ( codeGen )
126 import StgSyn
127 import CostCentre
128 import ProfInit
129 import TyCon
130 import Name
131 import SimplStg ( stg2stg )
132 import Cmm
133 import CmmParse ( parseCmmFile )
134 import CmmBuildInfoTables
135 import CmmPipeline
136 import CmmInfo
137 import CodeOutput
138 import NameEnv ( emptyNameEnv )
139 import NameSet ( emptyNameSet )
140 import InstEnv
141 import FamInstEnv
142 import Fingerprint ( Fingerprint )
143 import Hooks
144
145 import DynFlags
146 import ErrUtils
147
148 import Outputable
149 import HscStats ( ppSourceStats )
150 import HscTypes
151 import FastString
152 import UniqFM ( emptyUFM )
153 import UniqSupply
154 import Bag
155 import Exception
156 import qualified Stream
157 import Stream (Stream)
158
159 import Util
160
161 import Data.List
162 import Control.Monad
163 import Data.Maybe
164 import Data.IORef
165 import System.FilePath as FilePath
166 import System.Directory
167 import qualified Data.Map as Map
168
169 #include "HsVersions.h"
170
171
172 {- **********************************************************************
173 %* *
174 Initialisation
175 %* *
176 %********************************************************************* -}
177
178 newHscEnv :: DynFlags -> IO HscEnv
179 newHscEnv dflags = do
180 eps_var <- newIORef initExternalPackageState
181 us <- mkSplitUniqSupply 'r'
182 nc_var <- newIORef (initNameCache us knownKeyNames)
183 fc_var <- newIORef emptyUFM
184 mlc_var <- newIORef emptyModuleEnv
185 return HscEnv { hsc_dflags = dflags,
186 hsc_targets = [],
187 hsc_mod_graph = [],
188 hsc_IC = emptyInteractiveContext dflags,
189 hsc_HPT = emptyHomePackageTable,
190 hsc_EPS = eps_var,
191 hsc_NC = nc_var,
192 hsc_FC = fc_var,
193 hsc_MLC = mlc_var,
194 hsc_type_env_var = Nothing }
195
196
197 knownKeyNames :: [Name] -- Put here to avoid loops involving DsMeta,
198 knownKeyNames = -- where templateHaskellNames are defined
199 map getName wiredInThings
200 ++ basicKnownKeyNames
201 #ifdef GHCI
202 ++ templateHaskellNames
203 #endif
204
205 -- -----------------------------------------------------------------------------
206
207 getWarnings :: Hsc WarningMessages
208 getWarnings = Hsc $ \_ w -> return (w, w)
209
210 clearWarnings :: Hsc ()
211 clearWarnings = Hsc $ \_ _ -> return ((), emptyBag)
212
213 logWarnings :: WarningMessages -> Hsc ()
214 logWarnings w = Hsc $ \_ w0 -> return ((), w0 `unionBags` w)
215
216 getHscEnv :: Hsc HscEnv
217 getHscEnv = Hsc $ \e w -> return (e, w)
218
219 handleWarnings :: Hsc ()
220 handleWarnings = do
221 dflags <- getDynFlags
222 w <- getWarnings
223 liftIO $ printOrThrowWarnings dflags w
224 clearWarnings
225
226 -- | log warning in the monad, and if there are errors then
227 -- throw a SourceError exception.
228 logWarningsReportErrors :: Messages -> Hsc ()
229 logWarningsReportErrors (warns,errs) = do
230 logWarnings warns
231 when (not $ isEmptyBag errs) $ throwErrors errs
232
233 -- | Throw some errors.
234 throwErrors :: ErrorMessages -> Hsc a
235 throwErrors = liftIO . throwIO . mkSrcErr
236
237 -- | Deal with errors and warnings returned by a compilation step
238 --
239 -- In order to reduce dependencies to other parts of the compiler, functions
240 -- outside the "main" parts of GHC return warnings and errors as a parameter
241 -- and signal success via by wrapping the result in a 'Maybe' type. This
242 -- function logs the returned warnings and propagates errors as exceptions
243 -- (of type 'SourceError').
244 --
245 -- This function assumes the following invariants:
246 --
247 -- 1. If the second result indicates success (is of the form 'Just x'),
248 -- there must be no error messages in the first result.
249 --
250 -- 2. If there are no error messages, but the second result indicates failure
251 -- there should be warnings in the first result. That is, if the action
252 -- failed, it must have been due to the warnings (i.e., @-Werror@).
253 ioMsgMaybe :: IO (Messages, Maybe a) -> Hsc a
254 ioMsgMaybe ioA = do
255 ((warns,errs), mb_r) <- liftIO ioA
256 logWarnings warns
257 case mb_r of
258 Nothing -> throwErrors errs
259 Just r -> ASSERT( isEmptyBag errs ) return r
260
261 -- | like ioMsgMaybe, except that we ignore error messages and return
262 -- 'Nothing' instead.
263 ioMsgMaybe' :: IO (Messages, Maybe a) -> Hsc (Maybe a)
264 ioMsgMaybe' ioA = do
265 ((warns,_errs), mb_r) <- liftIO $ ioA
266 logWarnings warns
267 return mb_r
268
269 -- -----------------------------------------------------------------------------
270 -- | Lookup things in the compiler's environment
271
272 #ifdef GHCI
273 hscTcRnLookupRdrName :: HscEnv -> RdrName -> IO [Name]
274 hscTcRnLookupRdrName hsc_env0 rdr_name = runInteractiveHsc hsc_env0 $ do
275 hsc_env <- getHscEnv
276 ioMsgMaybe $ tcRnLookupRdrName hsc_env rdr_name
277 #endif
278
279 hscTcRcLookupName :: HscEnv -> Name -> IO (Maybe TyThing)
280 hscTcRcLookupName hsc_env0 name = runInteractiveHsc hsc_env0 $ do
281 hsc_env <- getHscEnv
282 ioMsgMaybe' $ tcRnLookupName hsc_env name
283 -- ignore errors: the only error we're likely to get is
284 -- "name not found", and the Maybe in the return type
285 -- is used to indicate that.
286
287 hscTcRnGetInfo :: HscEnv -> Name -> IO (Maybe (TyThing, Fixity, [ClsInst], [FamInst]))
288 hscTcRnGetInfo hsc_env0 name
289 = runInteractiveHsc hsc_env0 $
290 do { hsc_env <- getHscEnv
291 ; ioMsgMaybe' $ tcRnGetInfo hsc_env name }
292
293 #ifdef GHCI
294 hscIsGHCiMonad :: HscEnv -> String -> IO Name
295 hscIsGHCiMonad hsc_env name
296 = runHsc hsc_env $ ioMsgMaybe $ isGHCiMonad hsc_env name
297
298 hscGetModuleInterface :: HscEnv -> Module -> IO ModIface
299 hscGetModuleInterface hsc_env0 mod = runInteractiveHsc hsc_env0 $ do
300 hsc_env <- getHscEnv
301 ioMsgMaybe $ getModuleInterface hsc_env mod
302
303 -- -----------------------------------------------------------------------------
304 -- | Rename some import declarations
305 hscRnImportDecls :: HscEnv -> [LImportDecl RdrName] -> IO GlobalRdrEnv
306 hscRnImportDecls hsc_env0 import_decls = runInteractiveHsc hsc_env0 $ do
307 hsc_env <- getHscEnv
308 ioMsgMaybe $ tcRnImportDecls hsc_env import_decls
309 #endif
310
311 -- -----------------------------------------------------------------------------
312 -- | parse a file, returning the abstract syntax
313
314 hscParse :: HscEnv -> ModSummary -> IO HsParsedModule
315 hscParse hsc_env mod_summary = runHsc hsc_env $ hscParse' mod_summary
316
317 -- internal version, that doesn't fail due to -Werror
318 hscParse' :: ModSummary -> Hsc HsParsedModule
319 hscParse' mod_summary = do
320 dflags <- getDynFlags
321 let src_filename = ms_hspp_file mod_summary
322 maybe_src_buf = ms_hspp_buf mod_summary
323
324 -------------------------- Parser ----------------
325 liftIO $ showPass dflags "Parser"
326 {-# SCC "Parser" #-} do
327
328 -- sometimes we already have the buffer in memory, perhaps
329 -- because we needed to parse the imports out of it, or get the
330 -- module name.
331 buf <- case maybe_src_buf of
332 Just b -> return b
333 Nothing -> liftIO $ hGetStringBuffer src_filename
334
335 let loc = mkRealSrcLoc (mkFastString src_filename) 1 1
336
337 case unP parseModule (mkPState dflags buf loc) of
338 PFailed span err ->
339 liftIO $ throwOneError (mkPlainErrMsg dflags span err)
340
341 POk pst rdr_module -> do
342 logWarningsReportErrors (getMessages pst)
343 liftIO $ dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" $
344 ppr rdr_module
345 liftIO $ dumpIfSet_dyn dflags Opt_D_source_stats "Source Statistics" $
346 ppSourceStats False rdr_module
347
348 -- To get the list of extra source files, we take the list
349 -- that the parser gave us,
350 -- - eliminate files beginning with '<'. gcc likes to use
351 -- pseudo-filenames like "<built-in>" and "<command-line>"
352 -- - normalise them (elimiante differences between ./f and f)
353 -- - filter out the preprocessed source file
354 -- - filter out anything beginning with tmpdir
355 -- - remove duplicates
356 -- - filter out the .hs/.lhs source filename if we have one
357 --
358 let n_hspp = FilePath.normalise src_filename
359 srcs0 = nub $ filter (not . (tmpDir dflags `isPrefixOf`))
360 $ filter (not . (== n_hspp))
361 $ map FilePath.normalise
362 $ filter (not . (isPrefixOf "<"))
363 $ map unpackFS
364 $ srcfiles pst
365 srcs1 = case ml_hs_file (ms_location mod_summary) of
366 Just f -> filter (/= FilePath.normalise f) srcs0
367 Nothing -> srcs0
368
369 -- sometimes we see source files from earlier
370 -- preprocessing stages that cannot be found, so just
371 -- filter them out:
372 srcs2 <- liftIO $ filterM doesFileExist srcs1
373
374 return HsParsedModule {
375 hpm_module = rdr_module,
376 hpm_src_files = srcs2,
377 hpm_annotations
378 = (Map.fromListWith (++) $ annotations pst,
379 Map.fromList $ ((noSrcSpan,comment_q pst)
380 :(annotations_comments pst)))
381 }
382
383 -- XXX: should this really be a Maybe X? Check under which circumstances this
384 -- can become a Nothing and decide whether this should instead throw an
385 -- exception/signal an error.
386 type RenamedStuff =
387 (Maybe (HsGroup Name, [LImportDecl Name], Maybe [LIE Name],
388 Maybe LHsDocString))
389
390 -- | Rename and typecheck a module, additionally returning the renamed syntax
391 hscTypecheckRename :: HscEnv -> ModSummary -> HsParsedModule
392 -> IO (TcGblEnv, RenamedStuff)
393 hscTypecheckRename hsc_env mod_summary rdr_module = runHsc hsc_env $ do
394 tc_result <- tcRnModule' hsc_env mod_summary True rdr_module
395
396 -- This 'do' is in the Maybe monad!
397 let rn_info = do decl <- tcg_rn_decls tc_result
398 let imports = tcg_rn_imports tc_result
399 exports = tcg_rn_exports tc_result
400 doc_hdr = tcg_doc_hdr tc_result
401 return (decl,imports,exports,doc_hdr)
402
403 return (tc_result, rn_info)
404
405 -- wrapper around tcRnModule to handle safe haskell extras
406 tcRnModule' :: HscEnv -> ModSummary -> Bool -> HsParsedModule
407 -> Hsc TcGblEnv
408 tcRnModule' hsc_env sum save_rn_syntax mod = do
409 tcg_res <- {-# SCC "Typecheck-Rename" #-}
410 ioMsgMaybe $
411 tcRnModule hsc_env (ms_hsc_src sum) save_rn_syntax mod
412
413 tcSafeOK <- liftIO $ readIORef (tcg_safeInfer tcg_res)
414 dflags <- getDynFlags
415 let allSafeOK = safeInferred dflags && tcSafeOK
416
417 -- end of the safe haskell line, how to respond to user?
418 if not (safeHaskellOn dflags) || (safeInferOn dflags && not allSafeOK)
419 -- if safe Haskell off or safe infer failed, mark unsafe
420 then markUnsafeInfer tcg_res emptyBag
421
422 -- module (could be) safe, throw warning if needed
423 else do
424 tcg_res' <- hscCheckSafeImports tcg_res
425 safe <- liftIO $ readIORef (tcg_safeInfer tcg_res')
426 when safe $ do
427 case wopt Opt_WarnSafe dflags of
428 True -> (logWarnings $ unitBag $ mkPlainWarnMsg dflags
429 (warnSafeOnLoc dflags) $ errSafe tcg_res')
430 False | safeHaskell dflags == Sf_Trustworthy &&
431 wopt Opt_WarnTrustworthySafe dflags ->
432 (logWarnings $ unitBag $ mkPlainWarnMsg dflags
433 (trustworthyOnLoc dflags) $ errTwthySafe tcg_res')
434 False -> return ()
435 return tcg_res'
436 where
437 pprMod t = ppr $ moduleName $ tcg_mod t
438 errSafe t = quotes (pprMod t) <+> text "has been inferred as safe!"
439 errTwthySafe t = quotes (pprMod t)
440 <+> text "is marked as Trustworthy but has been inferred as safe!"
441
442 -- | Convert a typechecked module to Core
443 hscDesugar :: HscEnv -> ModSummary -> TcGblEnv -> IO ModGuts
444 hscDesugar hsc_env mod_summary tc_result =
445 runHsc hsc_env $ hscDesugar' (ms_location mod_summary) tc_result
446
447 hscDesugar' :: ModLocation -> TcGblEnv -> Hsc ModGuts
448 hscDesugar' mod_location tc_result = do
449 hsc_env <- getHscEnv
450 r <- ioMsgMaybe $
451 {-# SCC "deSugar" #-}
452 deSugar hsc_env mod_location tc_result
453
454 -- always check -Werror after desugaring, this is the last opportunity for
455 -- warnings to arise before the backend.
456 handleWarnings
457 return r
458
459 -- | Make a 'ModIface' from the results of typechecking. Used when
460 -- not optimising, and the interface doesn't need to contain any
461 -- unfoldings or other cross-module optimisation info.
462 -- ToDo: the old interface is only needed to get the version numbers,
463 -- we should use fingerprint versions instead.
464 makeSimpleIface :: HscEnv -> Maybe ModIface -> TcGblEnv -> ModDetails
465 -> IO (ModIface,Bool)
466 makeSimpleIface hsc_env maybe_old_iface tc_result details = runHsc hsc_env $ do
467 safe_mode <- hscGetSafeMode tc_result
468 ioMsgMaybe $ do
469 mkIfaceTc hsc_env (fmap mi_iface_hash maybe_old_iface) safe_mode
470 details tc_result
471
472 -- | Make a 'ModDetails' from the results of typechecking. Used when
473 -- typechecking only, as opposed to full compilation.
474 makeSimpleDetails :: HscEnv -> TcGblEnv -> IO ModDetails
475 makeSimpleDetails hsc_env tc_result = mkBootModDetailsTc hsc_env tc_result
476
477
478 {- **********************************************************************
479 %* *
480 The main compiler pipeline
481 %* *
482 %********************************************************************* -}
483
484 {-
485 --------------------------------
486 The compilation proper
487 --------------------------------
488
489 It's the task of the compilation proper to compile Haskell, hs-boot and core
490 files to either byte-code, hard-code (C, asm, LLVM, ect) or to nothing at all
491 (the module is still parsed and type-checked. This feature is mostly used by
492 IDE's and the likes). Compilation can happen in either 'one-shot', 'batch',
493 'nothing', or 'interactive' mode. 'One-shot' mode targets hard-code, 'batch'
494 mode targets hard-code, 'nothing' mode targets nothing and 'interactive' mode
495 targets byte-code.
496
497 The modes are kept separate because of their different types and meanings:
498
499 * In 'one-shot' mode, we're only compiling a single file and can therefore
500 discard the new ModIface and ModDetails. This is also the reason it only
501 targets hard-code; compiling to byte-code or nothing doesn't make sense when
502 we discard the result.
503
504 * 'Batch' mode is like 'one-shot' except that we keep the resulting ModIface
505 and ModDetails. 'Batch' mode doesn't target byte-code since that require us to
506 return the newly compiled byte-code.
507
508 * 'Nothing' mode has exactly the same type as 'batch' mode but they're still
509 kept separate. This is because compiling to nothing is fairly special: We
510 don't output any interface files, we don't run the simplifier and we don't
511 generate any code.
512
513 * 'Interactive' mode is similar to 'batch' mode except that we return the
514 compiled byte-code together with the ModIface and ModDetails.
515
516 Trying to compile a hs-boot file to byte-code will result in a run-time error.
517 This is the only thing that isn't caught by the type-system.
518 -}
519
520
521 type Messager = HscEnv -> (Int,Int) -> RecompileRequired -> ModSummary -> IO ()
522
523 genericHscCompileGetFrontendResult ::
524 Bool -- always do basic recompilation check?
525 -> Maybe TcGblEnv
526 -> Maybe Messager
527 -> HscEnv
528 -> ModSummary
529 -> SourceModified
530 -> Maybe ModIface -- Old interface, if available
531 -> (Int,Int) -- (i,n) = module i of n (for msgs)
532 -> IO (Either ModIface (TcGblEnv, Maybe Fingerprint))
533
534 genericHscCompileGetFrontendResult
535 always_do_basic_recompilation_check m_tc_result
536 mHscMessage hsc_env mod_summary source_modified mb_old_iface mod_index
537 = do
538
539 let msg what = case mHscMessage of
540 Just hscMessage -> hscMessage hsc_env mod_index what mod_summary
541 Nothing -> return ()
542
543 skip iface = do
544 msg UpToDate
545 return $ Left iface
546
547 compile mb_old_hash reason = do
548 msg reason
549 tc_result <- runHsc hsc_env $ genericHscFrontend mod_summary
550 return $ Right (tc_result, mb_old_hash)
551
552 stable = case source_modified of
553 SourceUnmodifiedAndStable -> True
554 _ -> False
555
556 case m_tc_result of
557 Just tc_result
558 | not always_do_basic_recompilation_check ->
559 return $ Right (tc_result, Nothing)
560 _ -> do
561 (recomp_reqd, mb_checked_iface)
562 <- {-# SCC "checkOldIface" #-}
563 checkOldIface hsc_env mod_summary
564 source_modified mb_old_iface
565 -- save the interface that comes back from checkOldIface.
566 -- In one-shot mode we don't have the old iface until this
567 -- point, when checkOldIface reads it from the disk.
568 let mb_old_hash = fmap mi_iface_hash mb_checked_iface
569
570 case mb_checked_iface of
571 Just iface | not (recompileRequired recomp_reqd) ->
572 -- If the module used TH splices when it was last
573 -- compiled, then the recompilation check is not
574 -- accurate enough (#481) and we must ignore
575 -- it. However, if the module is stable (none of
576 -- the modules it depends on, directly or
577 -- indirectly, changed), then we *can* skip
578 -- recompilation. This is why the SourceModified
579 -- type contains SourceUnmodifiedAndStable, and
580 -- it's pretty important: otherwise ghc --make
581 -- would always recompile TH modules, even if
582 -- nothing at all has changed. Stability is just
583 -- the same check that make is doing for us in
584 -- one-shot mode.
585 case m_tc_result of
586 Nothing
587 | mi_used_th iface && not stable ->
588 compile mb_old_hash (RecompBecause "TH")
589 _ ->
590 skip iface
591 _ ->
592 case m_tc_result of
593 Nothing -> compile mb_old_hash recomp_reqd
594 Just tc_result ->
595 return $ Right (tc_result, mb_old_hash)
596
597 genericHscFrontend :: ModSummary -> Hsc TcGblEnv
598 genericHscFrontend mod_summary =
599 getHooked hscFrontendHook genericHscFrontend' >>= ($ mod_summary)
600
601 genericHscFrontend' :: ModSummary -> Hsc TcGblEnv
602 genericHscFrontend' mod_summary = hscFileFrontEnd mod_summary
603
604 --------------------------------------------------------------
605 -- Compilers
606 --------------------------------------------------------------
607
608 hscCompileOneShot :: HscEnv
609 -> ModSummary
610 -> SourceModified
611 -> IO HscStatus
612 hscCompileOneShot env =
613 lookupHook hscCompileOneShotHook hscCompileOneShot' (hsc_dflags env) env
614
615 -- Compile Haskell/boot in OneShot mode.
616 hscCompileOneShot' :: HscEnv
617 -> ModSummary
618 -> SourceModified
619 -> IO HscStatus
620 hscCompileOneShot' hsc_env mod_summary src_changed
621 = do
622 -- One-shot mode needs a knot-tying mutable variable for interface
623 -- files. See TcRnTypes.TcGblEnv.tcg_type_env_var.
624 type_env_var <- newIORef emptyNameEnv
625 let mod = ms_mod mod_summary
626 hsc_env' = hsc_env{ hsc_type_env_var = Just (mod, type_env_var) }
627
628 msg what = oneShotMsg hsc_env' what
629
630 skip = do msg UpToDate
631 dumpIfaceStats hsc_env'
632 return HscUpToDate
633
634 compile mb_old_hash reason = runHsc hsc_env' $ do
635 liftIO $ msg reason
636 tc_result <- genericHscFrontend mod_summary
637 guts0 <- hscDesugar' (ms_location mod_summary) tc_result
638 dflags <- getDynFlags
639 case hscTarget dflags of
640 HscNothing -> do
641 when (gopt Opt_WriteInterface dflags) $ liftIO $ do
642 (iface, changed, _details) <- hscSimpleIface hsc_env tc_result mb_old_hash
643 hscWriteIface dflags iface changed mod_summary
644 return HscNotGeneratingCode
645 _ ->
646 case ms_hsc_src mod_summary of
647 t | isHsBootOrSig t ->
648 do (iface, changed, _) <- hscSimpleIface' tc_result mb_old_hash
649 liftIO $ hscWriteIface dflags iface changed mod_summary
650 return HscUpdateBoot
651 _ ->
652 do guts <- hscSimplify' guts0
653 (iface, changed, _details, cgguts) <- hscNormalIface' guts mb_old_hash
654 liftIO $ hscWriteIface dflags iface changed mod_summary
655 return $ HscRecomp cgguts mod_summary
656
657 -- XXX This is always False, because in one-shot mode the
658 -- concept of stability does not exist. The driver never
659 -- passes SourceUnmodifiedAndStable in here.
660 stable = case src_changed of
661 SourceUnmodifiedAndStable -> True
662 _ -> False
663
664 (recomp_reqd, mb_checked_iface)
665 <- {-# SCC "checkOldIface" #-}
666 checkOldIface hsc_env' mod_summary src_changed Nothing
667 -- save the interface that comes back from checkOldIface.
668 -- In one-shot mode we don't have the old iface until this
669 -- point, when checkOldIface reads it from the disk.
670 let mb_old_hash = fmap mi_iface_hash mb_checked_iface
671
672 case mb_checked_iface of
673 Just iface | not (recompileRequired recomp_reqd) ->
674 -- If the module used TH splices when it was last compiled,
675 -- then the recompilation check is not accurate enough (#481)
676 -- and we must ignore it. However, if the module is stable
677 -- (none of the modules it depends on, directly or indirectly,
678 -- changed), then we *can* skip recompilation. This is why
679 -- the SourceModified type contains SourceUnmodifiedAndStable,
680 -- and it's pretty important: otherwise ghc --make would
681 -- always recompile TH modules, even if nothing at all has
682 -- changed. Stability is just the same check that make is
683 -- doing for us in one-shot mode.
684 if mi_used_th iface && not stable
685 then compile mb_old_hash (RecompBecause "TH")
686 else skip
687 _ ->
688 compile mb_old_hash recomp_reqd
689
690 --------------------------------------------------------------
691 -- NoRecomp handlers
692 --------------------------------------------------------------
693
694 genModDetails :: HscEnv -> ModIface -> IO ModDetails
695 genModDetails hsc_env old_iface
696 = do
697 new_details <- {-# SCC "tcRnIface" #-}
698 initIfaceCheck hsc_env (typecheckIface old_iface)
699 dumpIfaceStats hsc_env
700 return new_details
701
702 --------------------------------------------------------------
703 -- Progress displayers.
704 --------------------------------------------------------------
705
706 oneShotMsg :: HscEnv -> RecompileRequired -> IO ()
707 oneShotMsg hsc_env recomp =
708 case recomp of
709 UpToDate ->
710 compilationProgressMsg (hsc_dflags hsc_env) $
711 "compilation IS NOT required"
712 _ ->
713 return ()
714
715 batchMsg :: Messager
716 batchMsg hsc_env mod_index recomp mod_summary =
717 case recomp of
718 MustCompile -> showMsg "Compiling " ""
719 UpToDate
720 | verbosity (hsc_dflags hsc_env) >= 2 -> showMsg "Skipping " ""
721 | otherwise -> return ()
722 RecompBecause reason -> showMsg "Compiling " (" [" ++ reason ++ "]")
723 where
724 dflags = hsc_dflags hsc_env
725 showMsg msg reason =
726 compilationProgressMsg dflags $
727 (showModuleIndex mod_index ++
728 msg ++ showModMsg dflags (hscTarget dflags)
729 (recompileRequired recomp) mod_summary)
730 ++ reason
731
732 --------------------------------------------------------------
733 -- FrontEnds
734 --------------------------------------------------------------
735
736 hscFileFrontEnd :: ModSummary -> Hsc TcGblEnv
737 hscFileFrontEnd mod_summary = do
738 hpm <- hscParse' mod_summary
739 hsc_env <- getHscEnv
740 tcg_env <- tcRnModule' hsc_env mod_summary False hpm
741 return tcg_env
742
743 --------------------------------------------------------------
744 -- Safe Haskell
745 --------------------------------------------------------------
746
747 -- Note [Safe Haskell Trust Check]
748 -- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
749 -- Safe Haskell checks that an import is trusted according to the following
750 -- rules for an import of module M that resides in Package P:
751 --
752 -- * If M is recorded as Safe and all its trust dependencies are OK
753 -- then M is considered safe.
754 -- * If M is recorded as Trustworthy and P is considered trusted and
755 -- all M's trust dependencies are OK then M is considered safe.
756 --
757 -- By trust dependencies we mean that the check is transitive. So if
758 -- a module M that is Safe relies on a module N that is trustworthy,
759 -- importing module M will first check (according to the second case)
760 -- that N is trusted before checking M is trusted.
761 --
762 -- This is a minimal description, so please refer to the user guide
763 -- for more details. The user guide is also considered the authoritative
764 -- source in this matter, not the comments or code.
765
766
767 -- Note [Safe Haskell Inference]
768 -- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
769 -- Safe Haskell does Safe inference on modules that don't have any specific
770 -- safe haskell mode flag. The basic aproach to this is:
771 -- * When deciding if we need to do a Safe language check, treat
772 -- an unmarked module as having -XSafe mode specified.
773 -- * For checks, don't throw errors but return them to the caller.
774 -- * Caller checks if there are errors:
775 -- * For modules explicitly marked -XSafe, we throw the errors.
776 -- * For unmarked modules (inference mode), we drop the errors
777 -- and mark the module as being Unsafe.
778 --
779 -- It used to be that we only did safe inference on modules that had no Safe
780 -- Haskell flags, but now we perform safe inference on all modules as we want
781 -- to allow users to set the `--fwarn-safe`, `--fwarn-unsafe` and
782 -- `--fwarn-trustworthy-safe` flags on Trustworthy and Unsafe modules so that a
783 -- user can ensure their assumptions are correct and see reasons for why a
784 -- module is safe or unsafe.
785 --
786 -- This is tricky as we must be careful when we should throw an error compared
787 -- to just warnings. For checking safe imports we manage it as two steps. First
788 -- we check any imports that are required to be safe, then we check all other
789 -- imports to see if we can infer them to be safe.
790
791
792 -- | Check that the safe imports of the module being compiled are valid.
793 -- If not we either issue a compilation error if the module is explicitly
794 -- using Safe Haskell, or mark the module as unsafe if we're in safe
795 -- inference mode.
796 hscCheckSafeImports :: TcGblEnv -> Hsc TcGblEnv
797 hscCheckSafeImports tcg_env = do
798 dflags <- getDynFlags
799 tcg_env' <- checkSafeImports dflags tcg_env
800 checkRULES dflags tcg_env'
801
802 where
803 checkRULES dflags tcg_env' = do
804 case safeLanguageOn dflags of
805 True -> do
806 -- XSafe: we nuke user written RULES
807 logWarnings $ warns dflags (tcg_rules tcg_env')
808 return tcg_env' { tcg_rules = [] }
809 False
810 -- SafeInferred: user defined RULES, so not safe
811 | safeInferOn dflags && not (null $ tcg_rules tcg_env')
812 -> markUnsafeInfer tcg_env' $ warns dflags (tcg_rules tcg_env')
813
814 -- Trustworthy OR SafeInferred: with no RULES
815 | otherwise
816 -> return tcg_env'
817
818 warns dflags rules = listToBag $ map (warnRules dflags) rules
819 warnRules dflags (L loc (HsRule n _ _ _ _ _ _)) =
820 mkPlainWarnMsg dflags loc $
821 text "Rule \"" <> ftext (unLoc n) <> text "\" ignored" $+$
822 text "User defined rules are disabled under Safe Haskell"
823
824 -- | Validate that safe imported modules are actually safe. For modules in the
825 -- HomePackage (the package the module we are compiling in resides) this just
826 -- involves checking its trust type is 'Safe' or 'Trustworthy'. For modules
827 -- that reside in another package we also must check that the external pacakge
828 -- is trusted. See the Note [Safe Haskell Trust Check] above for more
829 -- information.
830 --
831 -- The code for this is quite tricky as the whole algorithm is done in a few
832 -- distinct phases in different parts of the code base. See
833 -- RnNames.rnImportDecl for where package trust dependencies for a module are
834 -- collected and unioned. Specifically see the Note [RnNames . Tracking Trust
835 -- Transitively] and the Note [RnNames . Trust Own Package].
836 checkSafeImports :: DynFlags -> TcGblEnv -> Hsc TcGblEnv
837 checkSafeImports dflags tcg_env
838 = do
839 imps <- mapM condense imports'
840 let (safeImps, regImps) = partition (\(_,_,s) -> s) imps
841
842 -- We want to use the warning state specifically for detecting if safe
843 -- inference has failed, so store and clear any existing warnings.
844 oldErrs <- getWarnings
845 clearWarnings
846
847 -- Check safe imports are correct
848 safePkgs <- mapM checkSafe safeImps
849 safeErrs <- getWarnings
850 clearWarnings
851
852 -- Check non-safe imports are correct if inferring safety
853 -- See the Note [Safe Haskell Inference]
854 (infErrs, infPkgs) <- case (safeInferOn dflags) of
855 False -> return (emptyBag, [])
856 True -> do infPkgs <- mapM checkSafe regImps
857 infErrs <- getWarnings
858 clearWarnings
859 return (infErrs, infPkgs)
860
861 -- restore old errors
862 logWarnings oldErrs
863
864 case (isEmptyBag safeErrs) of
865 -- Failed safe check
866 False -> liftIO . throwIO . mkSrcErr $ safeErrs
867
868 -- Passed safe check
869 True -> do
870 let infPassed = isEmptyBag infErrs
871 tcg_env' <- case (not infPassed) of
872 True -> markUnsafeInfer tcg_env infErrs
873 False -> return tcg_env
874 when (packageTrustOn dflags) $ checkPkgTrust dflags pkgReqs
875 let newTrust = pkgTrustReqs safePkgs infPkgs infPassed
876 return tcg_env' { tcg_imports = impInfo `plusImportAvails` newTrust }
877
878 where
879 impInfo = tcg_imports tcg_env -- ImportAvails
880 imports = imp_mods impInfo -- ImportedMods
881 imports' = moduleEnvToList imports -- (Module, [ImportedModsVal])
882 pkgReqs = imp_trust_pkgs impInfo -- [PackageKey]
883
884 condense :: (Module, [ImportedModsVal]) -> Hsc (Module, SrcSpan, IsSafeImport)
885 condense (_, []) = panic "HscMain.condense: Pattern match failure!"
886 condense (m, x:xs) = do (_,_,l,s) <- foldlM cond' x xs
887 return (m, l, s)
888
889 -- ImportedModsVal = (ModuleName, Bool, SrcSpan, IsSafeImport)
890 cond' :: ImportedModsVal -> ImportedModsVal -> Hsc ImportedModsVal
891 cond' v1@(m1,_,l1,s1) (_,_,_,s2)
892 | s1 /= s2
893 = throwErrors $ unitBag $ mkPlainErrMsg dflags l1
894 (text "Module" <+> ppr m1 <+>
895 (text $ "is imported both as a safe and unsafe import!"))
896 | otherwise
897 = return v1
898
899 -- easier interface to work with
900 checkSafe (m, l, _) = fst `fmap` hscCheckSafe' dflags m l
901
902 -- what pkg's to add to our trust requirements
903 pkgTrustReqs req inf infPassed | safeInferOn dflags
904 && safeHaskell dflags == Sf_None && infPassed
905 = emptyImportAvails {
906 imp_trust_pkgs = catMaybes req ++ catMaybes inf
907 }
908 pkgTrustReqs _ _ _ | safeHaskell dflags == Sf_Unsafe
909 = emptyImportAvails
910 pkgTrustReqs req _ _ = emptyImportAvails { imp_trust_pkgs = catMaybes req }
911
912 -- | Check that a module is safe to import.
913 --
914 -- We return True to indicate the import is safe and False otherwise
915 -- although in the False case an exception may be thrown first.
916 hscCheckSafe :: HscEnv -> Module -> SrcSpan -> IO Bool
917 hscCheckSafe hsc_env m l = runHsc hsc_env $ do
918 dflags <- getDynFlags
919 pkgs <- snd `fmap` hscCheckSafe' dflags m l
920 when (packageTrustOn dflags) $ checkPkgTrust dflags pkgs
921 errs <- getWarnings
922 return $ isEmptyBag errs
923
924 -- | Return if a module is trusted and the pkgs it depends on to be trusted.
925 hscGetSafe :: HscEnv -> Module -> SrcSpan -> IO (Bool, [PackageKey])
926 hscGetSafe hsc_env m l = runHsc hsc_env $ do
927 dflags <- getDynFlags
928 (self, pkgs) <- hscCheckSafe' dflags m l
929 good <- isEmptyBag `fmap` getWarnings
930 clearWarnings -- don't want them printed...
931 let pkgs' | Just p <- self = p:pkgs
932 | otherwise = pkgs
933 return (good, pkgs')
934
935 -- | Is a module trusted? If not, throw or log errors depending on the type.
936 -- Return (regardless of trusted or not) if the trust type requires the modules
937 -- own package be trusted and a list of other packages required to be trusted
938 -- (these later ones haven't been checked) but the own package trust has been.
939 hscCheckSafe' :: DynFlags -> Module -> SrcSpan -> Hsc (Maybe PackageKey, [PackageKey])
940 hscCheckSafe' dflags m l = do
941 (tw, pkgs) <- isModSafe m l
942 case tw of
943 False -> return (Nothing, pkgs)
944 True | isHomePkg m -> return (Nothing, pkgs)
945 | otherwise -> return (Just $ modulePackageKey m, pkgs)
946 where
947 isModSafe :: Module -> SrcSpan -> Hsc (Bool, [PackageKey])
948 isModSafe m l = do
949 iface <- lookup' m
950 case iface of
951 -- can't load iface to check trust!
952 Nothing -> throwErrors $ unitBag $ mkPlainErrMsg dflags l
953 $ text "Can't load the interface file for" <+> ppr m
954 <> text ", to check that it can be safely imported"
955
956 -- got iface, check trust
957 Just iface' ->
958 let trust = getSafeMode $ mi_trust iface'
959 trust_own_pkg = mi_trust_pkg iface'
960 -- check module is trusted
961 safeM = trust `elem` [Sf_Safe, Sf_Trustworthy]
962 -- check package is trusted
963 safeP = packageTrusted trust trust_own_pkg m
964 -- pkg trust reqs
965 pkgRs = map fst $ filter snd $ dep_pkgs $ mi_deps iface'
966 -- General errors we throw but Safe errors we log
967 errs = case (safeM, safeP) of
968 (True, True ) -> emptyBag
969 (True, False) -> pkgTrustErr
970 (False, _ ) -> modTrustErr
971 in do
972 logWarnings errs
973 return (trust == Sf_Trustworthy, pkgRs)
974
975 where
976 pkgTrustErr = unitBag $ mkErrMsg dflags l (pkgQual dflags) $
977 sep [ ppr (moduleName m)
978 <> text ": Can't be safely imported!"
979 , text "The package (" <> ppr (modulePackageKey m)
980 <> text ") the module resides in isn't trusted."
981 ]
982 modTrustErr = unitBag $ mkErrMsg dflags l (pkgQual dflags) $
983 sep [ ppr (moduleName m)
984 <> text ": Can't be safely imported!"
985 , text "The module itself isn't safe." ]
986
987 -- | Check the package a module resides in is trusted. Safe compiled
988 -- modules are trusted without requiring that their package is trusted. For
989 -- trustworthy modules, modules in the home package are trusted but
990 -- otherwise we check the package trust flag.
991 packageTrusted :: SafeHaskellMode -> Bool -> Module -> Bool
992 packageTrusted Sf_None _ _ = False -- shouldn't hit these cases
993 packageTrusted Sf_Unsafe _ _ = False -- prefer for completeness.
994 packageTrusted _ _ _
995 | not (packageTrustOn dflags) = True
996 packageTrusted Sf_Safe False _ = True
997 packageTrusted _ _ m
998 | isHomePkg m = True
999 | otherwise = trusted $ getPackageDetails dflags (modulePackageKey m)
1000
1001 lookup' :: Module -> Hsc (Maybe ModIface)
1002 lookup' m = do
1003 hsc_env <- getHscEnv
1004 hsc_eps <- liftIO $ hscEPS hsc_env
1005 let pkgIfaceT = eps_PIT hsc_eps
1006 homePkgT = hsc_HPT hsc_env
1007 iface = lookupIfaceByModule dflags homePkgT pkgIfaceT m
1008 #ifdef GHCI
1009 -- the 'lookupIfaceByModule' method will always fail when calling from GHCi
1010 -- as the compiler hasn't filled in the various module tables
1011 -- so we need to call 'getModuleInterface' to load from disk
1012 iface' <- case iface of
1013 Just _ -> return iface
1014 Nothing -> snd `fmap` (liftIO $ getModuleInterface hsc_env m)
1015 return iface'
1016 #else
1017 return iface
1018 #endif
1019
1020
1021 isHomePkg :: Module -> Bool
1022 isHomePkg m
1023 | thisPackage dflags == modulePackageKey m = True
1024 | otherwise = False
1025
1026 -- | Check the list of packages are trusted.
1027 checkPkgTrust :: DynFlags -> [PackageKey] -> Hsc ()
1028 checkPkgTrust dflags pkgs =
1029 case errors of
1030 [] -> return ()
1031 _ -> (liftIO . throwIO . mkSrcErr . listToBag) errors
1032 where
1033 errors = catMaybes $ map go pkgs
1034 go pkg
1035 | trusted $ getPackageDetails dflags pkg
1036 = Nothing
1037 | otherwise
1038 = Just $ mkErrMsg dflags noSrcSpan (pkgQual dflags)
1039 $ text "The package (" <> ppr pkg <> text ") is required" <>
1040 text " to be trusted but it isn't!"
1041
1042 -- | Set module to unsafe and (potentially) wipe trust information.
1043 --
1044 -- Make sure to call this method to set a module to inferred unsafe, it should
1045 -- be a central and single failure method. We only wipe the trust information
1046 -- when we aren't in a specific Safe Haskell mode.
1047 --
1048 -- While we only use this for recording that a module was inferred unsafe, we
1049 -- may call it on modules using Trustworthy or Unsafe flags so as to allow
1050 -- warning flags for safety to function correctly. See Note [Safe Haskell
1051 -- Inference].
1052 markUnsafeInfer :: TcGblEnv -> WarningMessages -> Hsc TcGblEnv
1053 markUnsafeInfer tcg_env whyUnsafe = do
1054 dflags <- getDynFlags
1055
1056 when (wopt Opt_WarnUnsafe dflags)
1057 (logWarnings $ unitBag $
1058 mkPlainWarnMsg dflags (warnUnsafeOnLoc dflags) (whyUnsafe' dflags))
1059
1060 liftIO $ writeIORef (tcg_safeInfer tcg_env) False
1061 -- NOTE: Only wipe trust when not in an explicity safe haskell mode. Other
1062 -- times inference may be on but we are in Trustworthy mode -- so we want
1063 -- to record safe-inference failed but not wipe the trust dependencies.
1064 case safeHaskell dflags == Sf_None of
1065 True -> return $ tcg_env { tcg_imports = wiped_trust }
1066 False -> return tcg_env
1067
1068 where
1069 wiped_trust = (tcg_imports tcg_env) { imp_trust_pkgs = [] }
1070 pprMod = ppr $ moduleName $ tcg_mod tcg_env
1071 whyUnsafe' df = vcat [ quotes pprMod <+> text "has been inferred as unsafe!"
1072 , text "Reason:"
1073 , nest 4 $ (vcat $ badFlags df) $+$
1074 (vcat $ pprErrMsgBagWithLoc whyUnsafe) $+$
1075 (vcat $ badInsts $ tcg_insts tcg_env)
1076 ]
1077 badFlags df = concat $ map (badFlag df) unsafeFlagsForInfer
1078 badFlag df (str,loc,on,_)
1079 | on df = [mkLocMessage SevOutput (loc df) $
1080 text str <+> text "is not allowed in Safe Haskell"]
1081 | otherwise = []
1082 badInsts insts = concat $ map badInst insts
1083 badInst ins | overlapMode (is_flag ins) /= NoOverlap
1084 = [mkLocMessage SevOutput (nameSrcSpan $ getName $ is_dfun ins) $
1085 ppr (overlapMode $ is_flag ins) <+>
1086 text "overlap mode isn't allowed in Safe Haskell"]
1087 | otherwise = []
1088
1089
1090 -- | Figure out the final correct safe haskell mode
1091 hscGetSafeMode :: TcGblEnv -> Hsc SafeHaskellMode
1092 hscGetSafeMode tcg_env = do
1093 dflags <- getDynFlags
1094 liftIO $ finalSafeMode dflags tcg_env
1095
1096 --------------------------------------------------------------
1097 -- Simplifiers
1098 --------------------------------------------------------------
1099
1100 hscSimplify :: HscEnv -> ModGuts -> IO ModGuts
1101 hscSimplify hsc_env modguts = runHsc hsc_env $ hscSimplify' modguts
1102
1103 hscSimplify' :: ModGuts -> Hsc ModGuts
1104 hscSimplify' ds_result = do
1105 hsc_env <- getHscEnv
1106 {-# SCC "Core2Core" #-}
1107 liftIO $ core2core hsc_env ds_result
1108
1109 --------------------------------------------------------------
1110 -- Interface generators
1111 --------------------------------------------------------------
1112
1113 hscSimpleIface :: HscEnv
1114 -> TcGblEnv
1115 -> Maybe Fingerprint
1116 -> IO (ModIface, Bool, ModDetails)
1117 hscSimpleIface hsc_env tc_result mb_old_iface
1118 = runHsc hsc_env $ hscSimpleIface' tc_result mb_old_iface
1119
1120 hscSimpleIface' :: TcGblEnv
1121 -> Maybe Fingerprint
1122 -> Hsc (ModIface, Bool, ModDetails)
1123 hscSimpleIface' tc_result mb_old_iface = do
1124 hsc_env <- getHscEnv
1125 details <- liftIO $ mkBootModDetailsTc hsc_env tc_result
1126 safe_mode <- hscGetSafeMode tc_result
1127 (new_iface, no_change)
1128 <- {-# SCC "MkFinalIface" #-}
1129 ioMsgMaybe $
1130 mkIfaceTc hsc_env mb_old_iface safe_mode details tc_result
1131 -- And the answer is ...
1132 liftIO $ dumpIfaceStats hsc_env
1133 return (new_iface, no_change, details)
1134
1135 hscNormalIface :: HscEnv
1136 -> ModGuts
1137 -> Maybe Fingerprint
1138 -> IO (ModIface, Bool, ModDetails, CgGuts)
1139 hscNormalIface hsc_env simpl_result mb_old_iface =
1140 runHsc hsc_env $ hscNormalIface' simpl_result mb_old_iface
1141
1142 hscNormalIface' :: ModGuts
1143 -> Maybe Fingerprint
1144 -> Hsc (ModIface, Bool, ModDetails, CgGuts)
1145 hscNormalIface' simpl_result mb_old_iface = do
1146 hsc_env <- getHscEnv
1147 (cg_guts, details) <- {-# SCC "CoreTidy" #-}
1148 liftIO $ tidyProgram hsc_env simpl_result
1149
1150 -- BUILD THE NEW ModIface and ModDetails
1151 -- and emit external core if necessary
1152 -- This has to happen *after* code gen so that the back-end
1153 -- info has been set. Not yet clear if it matters waiting
1154 -- until after code output
1155 (new_iface, no_change)
1156 <- {-# SCC "MkFinalIface" #-}
1157 ioMsgMaybe $
1158 mkIface hsc_env mb_old_iface details simpl_result
1159
1160 liftIO $ dumpIfaceStats hsc_env
1161
1162 -- Return the prepared code.
1163 return (new_iface, no_change, details, cg_guts)
1164
1165 --------------------------------------------------------------
1166 -- BackEnd combinators
1167 --------------------------------------------------------------
1168
1169 hscWriteIface :: DynFlags -> ModIface -> Bool -> ModSummary -> IO ()
1170 hscWriteIface dflags iface no_change mod_summary = do
1171 let ifaceFile = ml_hi_file (ms_location mod_summary)
1172 unless no_change $
1173 {-# SCC "writeIface" #-}
1174 writeIfaceFile dflags ifaceFile iface
1175 whenGeneratingDynamicToo dflags $ do
1176 -- TODO: We should do a no_change check for the dynamic
1177 -- interface file too
1178 -- TODO: Should handle the dynamic hi filename properly
1179 let dynIfaceFile = replaceExtension ifaceFile (dynHiSuf dflags)
1180 dynIfaceFile' = addBootSuffix_maybe (mi_boot iface) dynIfaceFile
1181 dynDflags = dynamicTooMkDynamicDynFlags dflags
1182 writeIfaceFile dynDflags dynIfaceFile' iface
1183
1184 -- | Compile to hard-code.
1185 hscGenHardCode :: HscEnv -> CgGuts -> ModSummary -> FilePath
1186 -> IO (FilePath, Maybe FilePath) -- ^ @Just f@ <=> _stub.c is f
1187 hscGenHardCode hsc_env cgguts mod_summary output_filename = do
1188 let CgGuts{ -- This is the last use of the ModGuts in a compilation.
1189 -- From now on, we just use the bits we need.
1190 cg_module = this_mod,
1191 cg_binds = core_binds,
1192 cg_tycons = tycons,
1193 cg_foreign = foreign_stubs0,
1194 cg_dep_pkgs = dependencies,
1195 cg_hpc_info = hpc_info } = cgguts
1196 dflags = hsc_dflags hsc_env
1197 location = ms_location mod_summary
1198 data_tycons = filter isDataTyCon tycons
1199 -- cg_tycons includes newtypes, for the benefit of External Core,
1200 -- but we don't generate any code for newtypes
1201
1202 -------------------
1203 -- PREPARE FOR CODE GENERATION
1204 -- Do saturation and convert to A-normal form
1205 prepd_binds <- {-# SCC "CorePrep" #-}
1206 corePrepPgm dflags hsc_env core_binds data_tycons ;
1207 ----------------- Convert to STG ------------------
1208 (stg_binds, cost_centre_info)
1209 <- {-# SCC "CoreToStg" #-}
1210 myCoreToStg dflags this_mod prepd_binds
1211
1212 let prof_init = profilingInitCode this_mod cost_centre_info
1213 foreign_stubs = foreign_stubs0 `appendStubC` prof_init
1214
1215 ------------------ Code generation ------------------
1216
1217 -- The back-end is streamed: each top-level function goes
1218 -- from Stg all the way to asm before dealing with the next
1219 -- top-level function, so showPass isn't very useful here.
1220 -- Hence we have one showPass for the whole backend, the
1221 -- next showPass after this will be "Assembler".
1222 showPass dflags "CodeGen"
1223
1224 cmms <- {-# SCC "StgCmm" #-}
1225 doCodeGen hsc_env this_mod data_tycons
1226 cost_centre_info
1227 stg_binds hpc_info
1228
1229 ------------------ Code output -----------------------
1230 rawcmms0 <- {-# SCC "cmmToRawCmm" #-}
1231 cmmToRawCmm dflags cmms
1232
1233 let dump a = do dumpIfSet_dyn dflags Opt_D_dump_cmm_raw "Raw Cmm"
1234 (ppr a)
1235 return a
1236 rawcmms1 = Stream.mapM dump rawcmms0
1237
1238 (output_filename, (_stub_h_exists, stub_c_exists))
1239 <- {-# SCC "codeOutput" #-}
1240 codeOutput dflags this_mod output_filename location
1241 foreign_stubs dependencies rawcmms1
1242 return (output_filename, stub_c_exists)
1243
1244
1245 hscInteractive :: HscEnv
1246 -> CgGuts
1247 -> ModSummary
1248 -> IO (Maybe FilePath, CompiledByteCode, ModBreaks)
1249 #ifdef GHCI
1250 hscInteractive hsc_env cgguts mod_summary = do
1251 let dflags = hsc_dflags hsc_env
1252 let CgGuts{ -- This is the last use of the ModGuts in a compilation.
1253 -- From now on, we just use the bits we need.
1254 cg_module = this_mod,
1255 cg_binds = core_binds,
1256 cg_tycons = tycons,
1257 cg_foreign = foreign_stubs,
1258 cg_modBreaks = mod_breaks } = cgguts
1259
1260 location = ms_location mod_summary
1261 data_tycons = filter isDataTyCon tycons
1262 -- cg_tycons includes newtypes, for the benefit of External Core,
1263 -- but we don't generate any code for newtypes
1264
1265 -------------------
1266 -- PREPARE FOR CODE GENERATION
1267 -- Do saturation and convert to A-normal form
1268 prepd_binds <- {-# SCC "CorePrep" #-}
1269 corePrepPgm dflags hsc_env core_binds data_tycons
1270 ----------------- Generate byte code ------------------
1271 comp_bc <- byteCodeGen dflags this_mod prepd_binds data_tycons mod_breaks
1272 ------------------ Create f-x-dynamic C-side stuff ---
1273 (_istub_h_exists, istub_c_exists)
1274 <- outputForeignStubs dflags this_mod location foreign_stubs
1275 return (istub_c_exists, comp_bc, mod_breaks)
1276 #else
1277 hscInteractive _ _ = panic "GHC not compiled with interpreter"
1278 #endif
1279
1280 ------------------------------
1281
1282 hscCompileCmmFile :: HscEnv -> FilePath -> FilePath -> IO ()
1283 hscCompileCmmFile hsc_env filename output_filename = runHsc hsc_env $ do
1284 let dflags = hsc_dflags hsc_env
1285 cmm <- ioMsgMaybe $ parseCmmFile dflags filename
1286 liftIO $ do
1287 us <- mkSplitUniqSupply 'S'
1288 let initTopSRT = initUs_ us emptySRT
1289 dumpIfSet_dyn dflags Opt_D_dump_cmm "Parsed Cmm" (ppr cmm)
1290 (_, cmmgroup) <- cmmPipeline hsc_env initTopSRT cmm
1291 rawCmms <- cmmToRawCmm dflags (Stream.yield cmmgroup)
1292 _ <- codeOutput dflags no_mod output_filename no_loc NoStubs [] rawCmms
1293 return ()
1294 where
1295 no_mod = panic "hscCmmFile: no_mod"
1296 no_loc = ModLocation{ ml_hs_file = Just filename,
1297 ml_hi_file = panic "hscCmmFile: no hi file",
1298 ml_obj_file = panic "hscCmmFile: no obj file" }
1299
1300 -------------------- Stuff for new code gen ---------------------
1301
1302 doCodeGen :: HscEnv -> Module -> [TyCon]
1303 -> CollectedCCs
1304 -> [StgBinding]
1305 -> HpcInfo
1306 -> IO (Stream IO CmmGroup ())
1307 -- Note we produce a 'Stream' of CmmGroups, so that the
1308 -- backend can be run incrementally. Otherwise it generates all
1309 -- the C-- up front, which has a significant space cost.
1310 doCodeGen hsc_env this_mod data_tycons
1311 cost_centre_info stg_binds hpc_info = do
1312 let dflags = hsc_dflags hsc_env
1313
1314 let cmm_stream :: Stream IO CmmGroup ()
1315 cmm_stream = {-# SCC "StgCmm" #-}
1316 StgCmm.codeGen dflags this_mod data_tycons
1317 cost_centre_info stg_binds hpc_info
1318
1319 -- codegen consumes a stream of CmmGroup, and produces a new
1320 -- stream of CmmGroup (not necessarily synchronised: one
1321 -- CmmGroup on input may produce many CmmGroups on output due
1322 -- to proc-point splitting).
1323
1324 let dump1 a = do dumpIfSet_dyn dflags Opt_D_dump_cmm
1325 "Cmm produced by new codegen" (ppr a)
1326 return a
1327
1328 ppr_stream1 = Stream.mapM dump1 cmm_stream
1329
1330 -- We are building a single SRT for the entire module, so
1331 -- we must thread it through all the procedures as we cps-convert them.
1332 us <- mkSplitUniqSupply 'S'
1333
1334 -- When splitting, we generate one SRT per split chunk, otherwise
1335 -- we generate one SRT for the whole module.
1336 let
1337 pipeline_stream
1338 | gopt Opt_SplitObjs dflags
1339 = {-# SCC "cmmPipeline" #-}
1340 let run_pipeline us cmmgroup = do
1341 let (topSRT', us') = initUs us emptySRT
1342 (topSRT, cmmgroup) <- cmmPipeline hsc_env topSRT' cmmgroup
1343 let srt | isEmptySRT topSRT = []
1344 | otherwise = srtToData topSRT
1345 return (us', srt ++ cmmgroup)
1346
1347 in do _ <- Stream.mapAccumL run_pipeline us ppr_stream1
1348 return ()
1349
1350 | otherwise
1351 = {-# SCC "cmmPipeline" #-}
1352 let initTopSRT = initUs_ us emptySRT
1353 run_pipeline = cmmPipeline hsc_env
1354 in do topSRT <- Stream.mapAccumL run_pipeline initTopSRT ppr_stream1
1355 Stream.yield (srtToData topSRT)
1356
1357 let
1358 dump2 a = do dumpIfSet_dyn dflags Opt_D_dump_cmm "Output Cmm" $ ppr a
1359 return a
1360
1361 ppr_stream2 = Stream.mapM dump2 pipeline_stream
1362
1363 return ppr_stream2
1364
1365
1366
1367 myCoreToStg :: DynFlags -> Module -> CoreProgram
1368 -> IO ( [StgBinding] -- output program
1369 , CollectedCCs) -- cost centre info (declared and used)
1370 myCoreToStg dflags this_mod prepd_binds = do
1371 stg_binds
1372 <- {-# SCC "Core2Stg" #-}
1373 coreToStg dflags this_mod prepd_binds
1374
1375 (stg_binds2, cost_centre_info)
1376 <- {-# SCC "Stg2Stg" #-}
1377 stg2stg dflags this_mod stg_binds
1378
1379 return (stg_binds2, cost_centre_info)
1380
1381
1382 {- **********************************************************************
1383 %* *
1384 \subsection{Compiling a do-statement}
1385 %* *
1386 %********************************************************************* -}
1387
1388 {-
1389 When the UnlinkedBCOExpr is linked you get an HValue of type *IO [HValue]* When
1390 you run it you get a list of HValues that should be the same length as the list
1391 of names; add them to the ClosureEnv.
1392
1393 A naked expression returns a singleton Name [it]. The stmt is lifted into the
1394 IO monad as explained in Note [Interactively-bound Ids in GHCi] in HscTypes
1395 -}
1396
1397 #ifdef GHCI
1398 -- | Compile a stmt all the way to an HValue, but don't run it
1399 --
1400 -- We return Nothing to indicate an empty statement (or comment only), not a
1401 -- parse error.
1402 hscStmt :: HscEnv -> String -> IO (Maybe ([Id], IO [HValue], FixityEnv))
1403 hscStmt hsc_env stmt = hscStmtWithLocation hsc_env stmt "<interactive>" 1
1404
1405 -- | Compile a stmt all the way to an HValue, but don't run it
1406 --
1407 -- We return Nothing to indicate an empty statement (or comment only), not a
1408 -- parse error.
1409 hscStmtWithLocation :: HscEnv
1410 -> String -- ^ The statement
1411 -> String -- ^ The source
1412 -> Int -- ^ Starting line
1413 -> IO (Maybe ([Id], IO [HValue], FixityEnv))
1414 hscStmtWithLocation hsc_env0 stmt source linenumber =
1415 runInteractiveHsc hsc_env0 $ do
1416 maybe_stmt <- hscParseStmtWithLocation source linenumber stmt
1417 case maybe_stmt of
1418 Nothing -> return Nothing
1419
1420 Just parsed_stmt -> do
1421 -- Rename and typecheck it
1422 hsc_env <- getHscEnv
1423 (ids, tc_expr, fix_env) <- ioMsgMaybe $ tcRnStmt hsc_env parsed_stmt
1424
1425 -- Desugar it
1426 ds_expr <- ioMsgMaybe $ deSugarExpr hsc_env tc_expr
1427 liftIO (lintInteractiveExpr "desugar expression" hsc_env ds_expr)
1428 handleWarnings
1429
1430 -- Then code-gen, and link it
1431 -- It's important NOT to have package 'interactive' as thisPackageKey
1432 -- for linking, else we try to link 'main' and can't find it.
1433 -- Whereas the linker already knows to ignore 'interactive'
1434 let src_span = srcLocSpan interactiveSrcLoc
1435 hval <- liftIO $ hscCompileCoreExpr hsc_env src_span ds_expr
1436 let hval_io = unsafeCoerce# hval :: IO [HValue]
1437
1438 return $ Just (ids, hval_io, fix_env)
1439
1440 -- | Compile a decls
1441 hscDecls :: HscEnv
1442 -> String -- ^ The statement
1443 -> IO ([TyThing], InteractiveContext)
1444 hscDecls hsc_env str = hscDeclsWithLocation hsc_env str "<interactive>" 1
1445
1446 -- | Compile a decls
1447 hscDeclsWithLocation :: HscEnv
1448 -> String -- ^ The statement
1449 -> String -- ^ The source
1450 -> Int -- ^ Starting line
1451 -> IO ([TyThing], InteractiveContext)
1452 hscDeclsWithLocation hsc_env0 str source linenumber =
1453 runInteractiveHsc hsc_env0 $ do
1454 L _ (HsModule{ hsmodDecls = decls }) <-
1455 hscParseThingWithLocation source linenumber parseModule str
1456
1457 {- Rename and typecheck it -}
1458 hsc_env <- getHscEnv
1459 tc_gblenv <- ioMsgMaybe $ tcRnDeclsi hsc_env decls
1460
1461 {- Grab the new instances -}
1462 -- We grab the whole environment because of the overlapping that may have
1463 -- been done. See the notes at the definition of InteractiveContext
1464 -- (ic_instances) for more details.
1465 let finsts = tcg_fam_insts tc_gblenv
1466 insts = tcg_insts tc_gblenv
1467
1468 let defaults = tcg_default tc_gblenv
1469
1470 {- Desugar it -}
1471 -- We use a basically null location for iNTERACTIVE
1472 let iNTERACTIVELoc = ModLocation{ ml_hs_file = Nothing,
1473 ml_hi_file = panic "hsDeclsWithLocation:ml_hi_file",
1474 ml_obj_file = panic "hsDeclsWithLocation:ml_hi_file"}
1475 ds_result <- hscDesugar' iNTERACTIVELoc tc_gblenv
1476
1477 {- Simplify -}
1478 simpl_mg <- liftIO $ hscSimplify hsc_env ds_result
1479
1480 {- Tidy -}
1481 (tidy_cg, _mod_details) <- liftIO $ tidyProgram hsc_env simpl_mg
1482
1483 let dflags = hsc_dflags hsc_env
1484 !CgGuts{ cg_module = this_mod,
1485 cg_binds = core_binds,
1486 cg_tycons = tycons,
1487 cg_modBreaks = mod_breaks } = tidy_cg
1488 data_tycons = filter isDataTyCon tycons
1489
1490 {- Prepare For Code Generation -}
1491 -- Do saturation and convert to A-normal form
1492 prepd_binds <- {-# SCC "CorePrep" #-}
1493 liftIO $ corePrepPgm dflags hsc_env core_binds data_tycons
1494
1495 {- Generate byte code -}
1496 cbc <- liftIO $ byteCodeGen dflags this_mod
1497 prepd_binds data_tycons mod_breaks
1498
1499 let src_span = srcLocSpan interactiveSrcLoc
1500 liftIO $ linkDecls hsc_env src_span cbc
1501
1502 let tcs = filterOut isImplicitTyCon (mg_tcs simpl_mg)
1503
1504 ext_ids = [ id | id <- bindersOfBinds core_binds
1505 , isExternalName (idName id)
1506 , not (isDFunId id || isImplicitId id) ]
1507 -- We only need to keep around the external bindings
1508 -- (as decided by TidyPgm), since those are the only ones
1509 -- that might be referenced elsewhere.
1510 -- The DFunIds are in 'insts' (see Note [ic_tythings] in HscTypes
1511 -- Implicit Ids are implicit in tcs
1512
1513 tythings = map AnId ext_ids ++ map ATyCon tcs
1514
1515 let icontext = hsc_IC hsc_env
1516 ictxt1 = extendInteractiveContext icontext tythings
1517 ictxt = ictxt1 { ic_instances = (insts, finsts)
1518 , ic_default = defaults }
1519
1520 return (tythings, ictxt)
1521
1522 hscImport :: HscEnv -> String -> IO (ImportDecl RdrName)
1523 hscImport hsc_env str = runInteractiveHsc hsc_env $ do
1524 (L _ (HsModule{hsmodImports=is})) <-
1525 hscParseThing parseModule str
1526 case is of
1527 [L _ i] -> return i
1528 _ -> liftIO $ throwOneError $
1529 mkPlainErrMsg (hsc_dflags hsc_env) noSrcSpan $
1530 ptext (sLit "parse error in import declaration")
1531
1532 -- | Typecheck an expression (but don't run it)
1533 -- Returns its most general type
1534 hscTcExpr :: HscEnv
1535 -> String -- ^ The expression
1536 -> IO Type
1537 hscTcExpr hsc_env0 expr = runInteractiveHsc hsc_env0 $ do
1538 hsc_env <- getHscEnv
1539 maybe_stmt <- hscParseStmt expr
1540 case maybe_stmt of
1541 Just (L _ (BodyStmt expr _ _ _)) ->
1542 ioMsgMaybe $ tcRnExpr hsc_env expr
1543 _ ->
1544 throwErrors $ unitBag $ mkPlainErrMsg (hsc_dflags hsc_env) noSrcSpan
1545 (text "not an expression:" <+> quotes (text expr))
1546
1547 -- | Find the kind of a type
1548 -- Currently this does *not* generalise the kinds of the type
1549 hscKcType
1550 :: HscEnv
1551 -> Bool -- ^ Normalise the type
1552 -> String -- ^ The type as a string
1553 -> IO (Type, Kind) -- ^ Resulting type (possibly normalised) and kind
1554 hscKcType hsc_env0 normalise str = runInteractiveHsc hsc_env0 $ do
1555 hsc_env <- getHscEnv
1556 ty <- hscParseType str
1557 ioMsgMaybe $ tcRnType hsc_env normalise ty
1558
1559 hscParseStmt :: String -> Hsc (Maybe (GhciLStmt RdrName))
1560 hscParseStmt = hscParseThing parseStmt
1561
1562 hscParseStmtWithLocation :: String -> Int -> String
1563 -> Hsc (Maybe (GhciLStmt RdrName))
1564 hscParseStmtWithLocation source linenumber stmt =
1565 hscParseThingWithLocation source linenumber parseStmt stmt
1566
1567 hscParseType :: String -> Hsc (LHsType RdrName)
1568 hscParseType = hscParseThing parseType
1569 #endif
1570
1571 hscParseIdentifier :: HscEnv -> String -> IO (Located RdrName)
1572 hscParseIdentifier hsc_env str =
1573 runInteractiveHsc hsc_env $ hscParseThing parseIdentifier str
1574
1575 hscParseThing :: (Outputable thing) => Lexer.P thing -> String -> Hsc thing
1576 hscParseThing = hscParseThingWithLocation "<interactive>" 1
1577
1578 hscParseThingWithLocation :: (Outputable thing) => String -> Int
1579 -> Lexer.P thing -> String -> Hsc thing
1580 hscParseThingWithLocation source linenumber parser str
1581 = {-# SCC "Parser" #-} do
1582 dflags <- getDynFlags
1583 liftIO $ showPass dflags "Parser"
1584
1585 let buf = stringToStringBuffer str
1586 loc = mkRealSrcLoc (fsLit source) linenumber 1
1587
1588 case unP parser (mkPState dflags buf loc) of
1589 PFailed span err -> do
1590 let msg = mkPlainErrMsg dflags span err
1591 throwErrors $ unitBag msg
1592
1593 POk pst thing -> do
1594 logWarningsReportErrors (getMessages pst)
1595 liftIO $ dumpIfSet_dyn dflags Opt_D_dump_parsed "Parser" (ppr thing)
1596 return thing
1597
1598 hscCompileCore :: HscEnv -> Bool -> SafeHaskellMode -> ModSummary
1599 -> CoreProgram -> FilePath -> IO ()
1600 hscCompileCore hsc_env simplify safe_mode mod_summary binds output_filename
1601 = runHsc hsc_env $ do
1602 guts <- maybe_simplify (mkModGuts (ms_mod mod_summary) safe_mode binds)
1603 (iface, changed, _details, cgguts) <- hscNormalIface' guts Nothing
1604 liftIO $ hscWriteIface (hsc_dflags hsc_env) iface changed mod_summary
1605 _ <- liftIO $ hscGenHardCode hsc_env cgguts mod_summary output_filename
1606 return ()
1607
1608 where
1609 maybe_simplify mod_guts | simplify = hscSimplify' mod_guts
1610 | otherwise = return mod_guts
1611
1612 -- Makes a "vanilla" ModGuts.
1613 mkModGuts :: Module -> SafeHaskellMode -> CoreProgram -> ModGuts
1614 mkModGuts mod safe binds =
1615 ModGuts {
1616 mg_module = mod,
1617 mg_boot = False,
1618 mg_exports = [],
1619 mg_deps = noDependencies,
1620 mg_dir_imps = emptyModuleEnv,
1621 mg_used_names = emptyNameSet,
1622 mg_used_th = False,
1623 mg_rdr_env = emptyGlobalRdrEnv,
1624 mg_fix_env = emptyFixityEnv,
1625 mg_tcs = [],
1626 mg_insts = [],
1627 mg_fam_insts = [],
1628 mg_patsyns = [],
1629 mg_rules = [],
1630 mg_vect_decls = [],
1631 mg_binds = binds,
1632 mg_foreign = NoStubs,
1633 mg_warns = NoWarnings,
1634 mg_anns = [],
1635 mg_hpc_info = emptyHpcInfo False,
1636 mg_modBreaks = emptyModBreaks,
1637 mg_vect_info = noVectInfo,
1638 mg_inst_env = emptyInstEnv,
1639 mg_fam_inst_env = emptyFamInstEnv,
1640 mg_safe_haskell = safe,
1641 mg_trust_pkg = False,
1642 mg_dependent_files = []
1643 }
1644
1645
1646 {- **********************************************************************
1647 %* *
1648 Desugar, simplify, convert to bytecode, and link an expression
1649 %* *
1650 %********************************************************************* -}
1651
1652 #ifdef GHCI
1653 hscCompileCoreExpr :: HscEnv -> SrcSpan -> CoreExpr -> IO HValue
1654 hscCompileCoreExpr hsc_env =
1655 lookupHook hscCompileCoreExprHook hscCompileCoreExpr' (hsc_dflags hsc_env) hsc_env
1656
1657 hscCompileCoreExpr' :: HscEnv -> SrcSpan -> CoreExpr -> IO HValue
1658 hscCompileCoreExpr' hsc_env srcspan ds_expr
1659 | rtsIsProfiled
1660 = throwIO (InstallationError "You can't call hscCompileCoreExpr in a profiled compiler")
1661 -- Otherwise you get a seg-fault when you run it
1662
1663 | otherwise
1664 = do { let dflags = hsc_dflags hsc_env
1665
1666 {- Simplify it -}
1667 ; simpl_expr <- simplifyExpr dflags ds_expr
1668
1669 {- Tidy it (temporary, until coreSat does cloning) -}
1670 ; let tidy_expr = tidyExpr emptyTidyEnv simpl_expr
1671
1672 {- Prepare for codegen -}
1673 ; prepd_expr <- corePrepExpr dflags hsc_env tidy_expr
1674
1675 {- Lint if necessary -}
1676 ; lintInteractiveExpr "hscCompileExpr" hsc_env prepd_expr
1677
1678 {- Convert to BCOs -}
1679 ; bcos <- coreExprToBCOs dflags (icInteractiveModule (hsc_IC hsc_env)) prepd_expr
1680
1681 {- link it -}
1682 ; hval <- linkExpr hsc_env srcspan bcos
1683
1684 ; return hval }
1685 #endif
1686
1687
1688 {- **********************************************************************
1689 %* *
1690 Statistics on reading interfaces
1691 %* *
1692 %********************************************************************* -}
1693
1694 dumpIfaceStats :: HscEnv -> IO ()
1695 dumpIfaceStats hsc_env = do
1696 eps <- readIORef (hsc_EPS hsc_env)
1697 dumpIfSet dflags (dump_if_trace || dump_rn_stats)
1698 "Interface statistics"
1699 (ifaceStats eps)
1700 where
1701 dflags = hsc_dflags hsc_env
1702 dump_rn_stats = dopt Opt_D_dump_rn_stats dflags
1703 dump_if_trace = dopt Opt_D_dump_if_trace dflags
1704
1705
1706 {- **********************************************************************
1707 %* *
1708 Progress Messages: Module i of n
1709 %* *
1710 %********************************************************************* -}
1711
1712 showModuleIndex :: (Int, Int) -> String
1713 showModuleIndex (i,n) = "[" ++ padded ++ " of " ++ n_str ++ "] "
1714 where
1715 n_str = show n
1716 i_str = show i
1717 padded = replicate (length n_str - length i_str) ' ' ++ i_str