GHC.hs 81.8 KB
Newer Older
1
-- -----------------------------------------------------------------------------
2
--
3
-- (c) The University of Glasgow, 2005
4
5
6
--
-- The GHC API
--
7
-- -----------------------------------------------------------------------------
8
9
10

module GHC (
	-- * Initialisation
11
	Session,
12
13
14
15
16
	defaultErrorHandler,
	defaultCleanupHandler,
	newSession,

	-- * Flags and settings
17
	DynFlags(..), DynFlag(..), Severity(..), GhcMode(..), HscTarget(..), dopt,
18
	parseDynamicFlags,
19
20
	getSessionDynFlags,
	setSessionDynFlags,
21
22

	-- * Targets
23
	Target(..), TargetId(..), Phase,
24
25
26
	setTargets,
	getTargets,
	addTarget,
27
	removeTarget,
28
29
	guessTarget,
	
30
31
32
33
34
35
        -- * Extending the program scope 
        extendGlobalRdrScope,  -- :: Session -> [GlobalRdrElt] -> IO ()
        setGlobalRdrScope,     -- :: Session -> [GlobalRdrElt] -> IO ()
        extendGlobalTypeScope, -- :: Session -> [Id] -> IO ()
        setGlobalTypeScope,    -- :: Session -> [Id] -> IO ()

36
	-- * Loading\/compiling the program
37
	depanal,
38
	load, LoadHowMuch(..), SuccessFlag(..),	-- also does depanal
39
	workingDirectoryChanged,
40
	checkModule, CheckedModule(..),
41
	TypecheckedSource, ParsedSource, RenamedSource,
42

43
44
45
	-- * Parsing Haddock comments
	parseHaddockComment,

46
	-- * Inspecting the module structure of the program
Simon Marlow's avatar
Simon Marlow committed
47
	ModuleGraph, ModSummary(..), ms_mod_name, ModLocation(..),
48
	getModuleGraph,
49
	isLoaded,
50
51
	topSortModuleGraph,

52
53
54
55
	-- * Inspecting modules
	ModuleInfo,
	getModuleInfo,
	modInfoTyThings,
56
	modInfoTopLevelScope,
57
58
	modInfoPrintUnqualified,
	modInfoExports,
59
	modInfoInstances,
60
61
	modInfoIsExportedName,
	modInfoLookupName,
mnislaih's avatar
mnislaih committed
62
63
64
#if defined(GHCI)
        modInfoBkptSites,
#endif
65
	lookupGlobalName,
66

67
68
69
	-- * Printing
	PrintUnqualified, alwaysQualify,

70
71
	-- * Interactive evaluation
	getBindings, getPrintUnqual,
Simon Marlow's avatar
Simon Marlow committed
72
        findModule,
73
74
#ifdef GHCI
	setContext, getContext,	
75
	getNamesInScope,
Simon Marlow's avatar
Simon Marlow committed
76
	getRdrNamesInScope,
77
	moduleIsInterpreted,
78
	getInfo,
79
80
	exprType,
	typeKind,
81
	parseName,
82
83
84
	RunResult(..),
	runStmt,
	showModule,
85
        isModuleInterpreted,
ei@vuokko.info's avatar
ei@vuokko.info committed
86
	compileExpr, HValue, dynCompileExpr,
87
	lookupName,
mnislaih's avatar
mnislaih committed
88

89
        getBreakpointHandler, setBreakpointHandler, 
mnislaih's avatar
mnislaih committed
90
        obtainTerm, obtainTerm1,
91
92
93
#endif

	-- * Abstract syntax elements
94

Simon Marlow's avatar
Simon Marlow committed
95
96
97
        -- ** Packages
        PackageId,

98
	-- ** Modules
Simon Marlow's avatar
Simon Marlow committed
99
100
	Module, mkModule, pprModule, moduleName, modulePackageId,
        ModuleName, mkModuleName, moduleNameString,
101

102
	-- ** Names
103
	Name, 
104
	nameModule, pprParenSymName, nameSrcLoc,
105
	NamedThing(..),
Simon Marlow's avatar
Simon Marlow committed
106
	RdrName(Qual,Unqual),
107
108
	
	-- ** Identifiers
109
	Id, idType,
110
	isImplicitId, isDeadBinder,
111
	isExportedId, isLocalId, isGlobalId,
112
	isRecordSelector,
113
	isPrimOpId, isFCallId, isClassOpId_maybe,
114
115
	isDataConWorkId, idDataCon,
	isBottomingId, isDictonaryId,
116
	recordSelectorFieldLabel,
117
118
119

	-- ** Type constructors
	TyCon, 
120
	tyConTyVars, tyConDataCons, tyConArity,
121
	isClassTyCon, isSynTyCon, isNewTyCon, isPrimTyCon, isFunTyCon,
122
123
	isOpenTyCon,
	synTyConDefn, synTyConType, synTyConResKind,
124

125
126
127
128
	-- ** Type variables
	TyVar,
	alphaTyVars,

129
130
	-- ** Data constructors
	DataCon,
131
132
133
134
	dataConSig, dataConType, dataConTyCon, dataConFieldLabels,
	dataConIsInfix, isVanillaDataCon,
	dataConStrictMarks,  
	StrictnessMark(..), isMarkedStrict,
135
136
137

	-- ** Classes
	Class, 
138
139
	classMethods, classSCTheta, classTvsFds,
	pprFundeps,
140

141
	-- ** Instances
142
	Instance, 
143
	instanceDFunId, pprInstance, pprInstanceHdr,
144

145
	-- ** Types and Kinds
146
147
	Type, dropForAlls, splitForAllTys, funResultTy, 
	pprParendType, pprTypeApp,
148
	Kind,
149
150
	PredType,
	ThetaType, pprThetaArrow,
151
152

	-- ** Entities
153
154
	TyThing(..), 

155
156
157
	-- ** Syntax
	module HsSyn, -- ToDo: remove extraneous bits

158
159
160
161
162
163
164
165
166
	-- ** Fixities
	FixityDirection(..), 
	defaultFixity, maxPrecedence, 
	negateFixity,
	compareFixity,

	-- ** Source locations
	SrcLoc, pprDefnLoc,

167
168
169
170
	-- * Exceptions
	GhcException(..), showGhcException,

	-- * Miscellaneous
171
172
	sessionHscEnv,
	cyclicModuleErr,
173
174
  ) where

175
176
177
{-
 ToDo:

178
  * inline bits of HscMain here to simplify layering: hscTcExpr, hscStmt.
179
180
181
182
183
184
  * what StaticFlags should we expose, if any?
-}

#include "HsVersions.h"

#ifdef GHCI
mnislaih's avatar
mnislaih committed
185
import RtClosureInspect ( cvObtainTerm, Term )
186
187
import TcRnDriver	( tcRnLookupRdrName, tcRnGetInfo,
			  tcRnLookupName, getModuleExports )
188
189
import RdrName		( plusGlobalRdrEnv, Provenance(..), 
			  ImportSpec(..), ImpDeclSpec(..), ImpItemSpec(..),
190
			  mkGlobalRdrEnv )
191
import HscMain		( hscParseIdentifier, hscStmt, hscTcExpr, hscKcType )
Simon Marlow's avatar
Simon Marlow committed
192
import Name		( nameOccName )
193
import Type		( tidyType )
194
import Var		( varName )
195
import VarEnv		( emptyTidyEnv )
mnislaih's avatar
mnislaih committed
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
import GHC.Exts         ( unsafeCoerce# )

-- For breakpoints
import Breakpoints      ( SiteNumber, Coord, nullBkptHandler, 
                          BkptHandler(..), BkptLocation, noDbgSites )
import Linker           ( initDynLinker )
import PrelNames        ( breakpointJumpName, breakpointCondJumpName, 
                          breakpointAutoJumpName )

import GHC.Exts         ( Int(..), Ptr(..), int2Addr#, indexArray# )
import GHC.Base         ( Opaque(..) )
import Foreign.StablePtr( deRefStablePtr, castPtrToStablePtr )
import Foreign          ( unsafePerformIO )
import Data.Maybe       ( fromMaybe)
import qualified Linker

import Data.Dynamic     ( Dynamic )
import Linker		( HValue, getHValue, extendLinkEnv )
214
215
#endif

216
import Packages		( initPackages )
217
import NameSet		( NameSet, nameSetToList, elemNameSet )
Simon Marlow's avatar
Simon Marlow committed
218
import RdrName		( GlobalRdrEnv, GlobalRdrElt(..), RdrName(..), 
219
220
			  globalRdrEnvElts, extendGlobalRdrEnv,
                          emptyGlobalRdrEnv )
221
import HsSyn 
222
223
import Type		( Kind, Type, dropForAlls, PredType, ThetaType,
			  pprThetaArrow, pprParendType, splitForAllTys,
224
			  pprTypeApp, funResultTy )
225
import Id		( Id, idType, isImplicitId, isDeadBinder,
226
                          isExportedId, isLocalId, isGlobalId,
227
228
                          isRecordSelector, recordSelectorFieldLabel,
                          isPrimOpId, isFCallId, isClassOpId_maybe,
229
230
                          isDataConWorkId, idDataCon,
                          isBottomingId )
231
import Var		( TyVar )
232
import TysPrim		( alphaTyVars )
233
import TyCon		( TyCon, isClassTyCon, isSynTyCon, isNewTyCon,
234
235
236
			  isPrimTyCon, isFunTyCon, isOpenTyCon, tyConArity,
			  tyConTyVars, tyConDataCons, synTyConDefn,
			  synTyConType, synTyConResKind )
237
238
239
240
241
import Class		( Class, classSCTheta, classTvsFds, classMethods )
import FunDeps		( pprFundeps )
import DataCon		( DataCon, dataConWrapId, dataConSig, dataConTyCon,
			  dataConFieldLabels, dataConStrictMarks, 
			  dataConIsInfix, isVanillaDataCon )
242
import Name		( Name, nameModule, NamedThing(..), nameSrcLoc )
243
import OccName		( parenSymOcc )
244
import NameEnv		( nameEnvElts )
245
import InstEnv		( Instance, instanceDFunId, pprInstance, pprInstanceHdr )
246
import SrcLoc
247
248
import DriverPipeline
import DriverPhases	( Phase(..), isHaskellSrcFilename, startPhase )
249
import HeaderInfo	( getImports, getOptions )
250
import Finder
251
import HscMain		( newHscEnv, hscFileCheck, HscChecked(..) )
252
253
import HscTypes
import DynFlags
254
255
import SysTools     ( initSysTools, cleanTempFiles, cleanTempFilesExcept,
                      cleanTempDirs )
256
import Module
Simon Marlow's avatar
Simon Marlow committed
257
import UniqFM
258
import PackageConfig    ( PackageId, stringToPackageId, mainPackageId )
259
260
import FiniteMap
import Panic
261
import Digraph
262
import Bag		( unitBag, listToBag )
263
import ErrUtils		( Severity(..), showPass, fatalErrorMsg, debugTraceMsg,
264
265
			  mkPlainErrMsg, printBagOfErrors, printBagOfWarnings,
			  WarnMsg )
266
import qualified ErrUtils
267
import Util
268
import StringBuffer	( StringBuffer, hGetStringBuffer )
269
import Outputable
270
import BasicTypes
271
import TcType           ( tcSplitSigmaTy, isDictTy )
272
import Maybes		( expectJust, mapCatMaybes )
273
274
import HaddockParse     ( parseHaddockParagraphs, parseHaddockString )
import HaddockLex       ( tokenise )
275
276
277

import Control.Concurrent
import System.Directory ( getModificationTime, doesFileExist )
278
import Data.Maybe	( isJust, isNothing )
279
280
281
282
283
284
285
286
import Data.List	( partition, nub )
import qualified Data.List as List
import Control.Monad	( unless, when )
import System.Exit	( exitWith, ExitCode(..) )
import System.Time	( ClockTime )
import Control.Exception as Exception hiding (handle)
import Data.IORef
import System.IO
287
import System.IO.Error	( isDoesNotExistError )
288
import Prelude hiding (init)
289

290
291
292
293
294
295
#if __GLASGOW_HASKELL__ < 600
import System.IO as System.IO.Error ( try )
#else
import System.IO.Error	( try )
#endif

296
-- -----------------------------------------------------------------------------
297
-- Exception handlers
298
299
300
301
302

-- | Install some default exception handlers and run the inner computation.
-- Unless you want to handle exceptions yourself, you should wrap this around
-- the top level of your program.  The default handlers output the error
-- message(s) to stderr and exit cleanly.
303
304
defaultErrorHandler :: DynFlags -> IO a -> IO a
defaultErrorHandler dflags inner = 
305
306
307
308
309
  -- top-level exception handler: any unrecognised exception is a compiler bug.
  handle (\exception -> do
  	   hFlush stdout
	   case exception of
		-- an IO exception probably isn't our fault, so don't panic
310
311
		IOException _ ->
		  fatalErrorMsg dflags (text (show exception))
312
		AsyncException StackOverflow ->
313
314
315
		  fatalErrorMsg dflags (text "stack overflow: use +RTS -K<size> to increase it")
		_other ->
		  fatalErrorMsg dflags (text (show (Panic (show exception))))
316
317
318
	   exitWith (ExitFailure 1)
         ) $

319
320
  -- program errors: messages with locations attached.  Sometimes it is
  -- convenient to just throw these as exceptions.
321
  handleDyn (\dyn -> do printBagOfErrors dflags (unitBag dyn)
322
323
324
			exitWith (ExitFailure 1)) $

  -- error messages propagated as exceptions
325
326
327
328
329
  handleDyn (\dyn -> do
  		hFlush stdout
  		case dyn of
		     PhaseFailed _ code -> exitWith code
		     Interrupted -> exitWith (ExitFailure 1)
330
		     _ -> do fatalErrorMsg dflags (text (show (dyn :: GhcException)))
331
332
333
334
335
336
337
338
			     exitWith (ExitFailure 1)
	    ) $
  inner

-- | Install a default cleanup handler to remove temporary files
-- deposited by a GHC run.  This is seperate from
-- 'defaultErrorHandler', because you might want to override the error
-- handling, but still get the ordinary cleanup behaviour.
339
340
defaultCleanupHandler :: DynFlags -> IO a -> IO a
defaultCleanupHandler dflags inner = 
341
    -- make sure we clean up after ourselves
342
343
    later (do cleanTempFiles dflags
              cleanTempDirs dflags
344
345
346
347
348
          )
          -- exceptions will be blocked while we clean the temporary files,
          -- so there shouldn't be any difficulty if we receive further
          -- signals.
    inner
349
350


351
352
353
354
355
356
#if defined(GHCI) 
GLOBAL_VAR(v_bkptLinkEnv, [], [(Name, HValue)])
        -- stores the current breakpoint handler to help setContext to
        -- restore it after a context change
#endif

357
358
-- | Starts a new session.  A session consists of a set of loaded
-- modules, a set of options (DynFlags), and an interactive context.
359
-- ToDo: GhcMode should say "keep typechecked code" and\/or "keep renamed
360
-- code".
361
362
363
364
newSession :: GhcMode -> Maybe FilePath -> IO Session
newSession mode mb_top_dir = do
  -- catch ^C
  main_thread <- myThreadId
365
  modifyMVar_ interruptTargetThread (return . (main_thread :))
366
367
368
369
  installSignalHandlers

  dflags0 <- initSysTools mb_top_dir defaultDynFlags
  dflags  <- initDynFlags dflags0
370
  env <- newHscEnv dflags{ ghcMode=mode }
371
  ref <- newIORef env
372
373
374
375
376
377
378
379
380
381
382
383
  return (Session ref)

-- tmp: this breaks the abstraction, but required because DriverMkDepend
-- needs to call the Finder.  ToDo: untangle this.
sessionHscEnv :: Session -> IO HscEnv
sessionHscEnv (Session ref) = readIORef ref

withSession :: Session -> (HscEnv -> IO a) -> IO a
withSession (Session ref) f = do h <- readIORef ref; f h

modifySession :: Session -> (HscEnv -> HscEnv) -> IO ()
modifySession (Session ref) f = do h <- readIORef ref; writeIORef ref $! f h
384
385
386
387
388
389

-- -----------------------------------------------------------------------------
-- Flags & settings

-- | Grabs the DynFlags from the Session
getSessionDynFlags :: Session -> IO DynFlags
390
getSessionDynFlags s = withSession s (return . hsc_dflags)
391

392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
-- | Updates the DynFlags in a Session.  This also reads
-- the package database (unless it has already been read),
-- and prepares the compilers knowledge about packages.  It
-- can be called again to load new packages: just add new
-- package flags to (packageFlags dflags).
--
-- Returns a list of new packages that may need to be linked in using
-- the dynamic linker (see 'linkPackages') as a result of new package
-- flags.  If you are not doing linking or doing static linking, you
-- can ignore the list of packages returned.
--
setSessionDynFlags :: Session -> DynFlags -> IO [PackageId]
setSessionDynFlags (Session ref) dflags = do
  hsc_env <- readIORef ref
  (dflags', preload) <- initPackages dflags
  writeIORef ref $! hsc_env{ hsc_dflags = dflags' }
  return preload
409

410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
-- | If there is no -o option, guess the name of target executable
-- by using top-level source file name as a base.
guessOutputFile :: Session -> IO ()
guessOutputFile s = modifySession s $ \env ->
    let dflags = hsc_dflags env
        mod_graph = hsc_mod_graph env
        mainModuleSrcPath, guessedName :: Maybe String
        mainModuleSrcPath = do
            let isMain = (== mainModIs dflags) . ms_mod
            [ms] <- return (filter isMain mod_graph)
            ml_hs_file (ms_location ms)
        guessedName = fmap basenameOf mainModuleSrcPath
    in
    case outputFile dflags of
        Just _ -> env
        Nothing -> env { hsc_dflags = dflags { outputFile = guessedName } }

427
-- -----------------------------------------------------------------------------
428
-- Targets
429
430
431
432
433
434

-- ToDo: think about relative vs. absolute file paths. And what
-- happens when the current directory changes.

-- | Sets the targets for this session.  Each target may be a module name
-- or a filename.  The targets correspond to the set of root modules for
435
-- the program\/library.  Unloading the current program is achieved by
436
-- setting the current set of targets to be empty, followed by load.
437
setTargets :: Session -> [Target] -> IO ()
438
setTargets s targets = modifySession s (\h -> h{ hsc_targets = targets })
439
440

-- | returns the current set of targets
441
442
getTargets :: Session -> IO [Target]
getTargets s = withSession s (return . hsc_targets)
443

444
-- | Add another target
445
446
447
addTarget :: Session -> Target -> IO ()
addTarget s target
  = modifySession s (\h -> h{ hsc_targets = target : hsc_targets h })
448

449
450
451
452
453
454
-- | Remove a target
removeTarget :: Session -> TargetId -> IO ()
removeTarget s target_id
  = modifySession s (\h -> h{ hsc_targets = filter (hsc_targets h) })
  where
   filter targets = [ t | t@(Target id _) <- targets, id /= target_id ]
455

456
457
458
459
460
461
462
463
464
-- Attempts to guess what Target a string refers to.  This function implements
-- the --make/GHCi command-line syntax for filenames: 
--
-- 	- if the string looks like a Haskell source filename, then interpret
--	  it as such
--	- if adding a .hs or .lhs suffix yields the name of an existing file,
--	  then use that
-- 	- otherwise interpret the string as a module name
--
465
466
467
468
guessTarget :: String -> Maybe Phase -> IO Target
guessTarget file (Just phase)
   = return (Target (TargetFile file (Just phase)) Nothing)
guessTarget file Nothing
469
   | isHaskellSrcFilename file
470
   = return (Target (TargetFile file Nothing) Nothing)
471
472
   | otherwise
   = do exists <- doesFileExist hs_file
473
474
475
	if exists
	   then return (Target (TargetFile hs_file Nothing) Nothing)
	   else do
476
	exists <- doesFileExist lhs_file
477
478
479
	if exists
	   then return (Target (TargetFile lhs_file Nothing) Nothing)
	   else do
Simon Marlow's avatar
Simon Marlow committed
480
	return (Target (TargetModule (mkModuleName file)) Nothing)
481
     where 
482
483
	 hs_file  = file `joinFileExt` "hs"
	 lhs_file = file `joinFileExt` "lhs"
484

485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
-- -----------------------------------------------------------------------------
-- Extending the program scope

extendGlobalRdrScope :: Session -> [GlobalRdrElt] -> IO ()
extendGlobalRdrScope session rdrElts
    = modifySession session $ \hscEnv ->
      let global_rdr = hsc_global_rdr_env hscEnv
      in hscEnv{ hsc_global_rdr_env = foldl extendGlobalRdrEnv global_rdr rdrElts }

setGlobalRdrScope :: Session -> [GlobalRdrElt] -> IO ()
setGlobalRdrScope session rdrElts
    = modifySession session $ \hscEnv ->
      hscEnv{ hsc_global_rdr_env = foldl extendGlobalRdrEnv emptyGlobalRdrEnv rdrElts }

extendGlobalTypeScope :: Session -> [Id] -> IO ()
extendGlobalTypeScope session ids
    = modifySession session $ \hscEnv ->
      let global_type = hsc_global_type_env hscEnv
      in hscEnv{ hsc_global_type_env = extendTypeEnvWithIds global_type ids }

setGlobalTypeScope :: Session -> [Id] -> IO ()
setGlobalTypeScope session ids
    = modifySession session $ \hscEnv ->
      hscEnv{ hsc_global_type_env = extendTypeEnvWithIds emptyTypeEnv ids }

510
511
512
513
514
515
-- -----------------------------------------------------------------------------
-- Parsing Haddock comments

parseHaddockComment :: String -> Either String (HsDoc RdrName)
parseHaddockComment string = parseHaddockParagraphs (tokenise string)

516
517
-- -----------------------------------------------------------------------------
-- Loading the program
518

519
520
-- Perform a dependency analysis starting from the current targets
-- and update the session with the new module graph.
Simon Marlow's avatar
Simon Marlow committed
521
depanal :: Session -> [ModuleName] -> Bool -> IO (Maybe ModuleGraph)
522
depanal (Session ref) excluded_mods allow_dup_roots = do
523
524
525
526
527
528
529
530
  hsc_env <- readIORef ref
  let
	 dflags  = hsc_dflags hsc_env
	 gmode   = ghcMode (hsc_dflags hsc_env)
	 targets = hsc_targets hsc_env
	 old_graph = hsc_mod_graph hsc_env
	
  showPass dflags "Chasing dependencies"
531
  when (gmode == BatchCompile) $
532
	debugTraceMsg dflags 2 (hcat [
533
		     text "Chasing modules from: ",
534
	     		hcat (punctuate comma (map pprTarget targets))])
535

536
  r <- downsweep hsc_env old_graph excluded_mods allow_dup_roots
537
  case r of
538
    Just mod_graph -> writeIORef ref hsc_env{ hsc_mod_graph = mod_graph }
539
540
    _ -> return ()
  return r
541

542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
{-
-- | The result of load.
data LoadResult
  = LoadOk	Errors	-- ^ all specified targets were loaded successfully.
  | LoadFailed  Errors	-- ^ not all modules were loaded.

type Errors = [String]

data ErrMsg = ErrMsg { 
	errMsgSeverity  :: Severity,  -- warning, error, etc.
	errMsgSpans     :: [SrcSpan],
	errMsgShortDoc  :: Doc,
	errMsgExtraInfo :: Doc
	}
-}

data LoadHowMuch
   = LoadAllTargets
Simon Marlow's avatar
Simon Marlow committed
560
561
   | LoadUpTo ModuleName
   | LoadDependenciesOf ModuleName
562
563
564
565

-- | Try to load the program.  If a Module is supplied, then just
-- attempt to load up to this target.  If no Module is supplied,
-- then try to load all targets.
566
load :: Session -> LoadHowMuch -> IO SuccessFlag
567
load s@(Session ref) how_much
568
   = do 
569
570
571
572
	-- Dependency analysis first.  Note that this fixes the module graph:
	-- even if we don't get a fully successful upsweep, the full module
	-- graph is still retained in the Session.  We can tell which modules
	-- were successfully loaded by inspecting the Session's HPT.
573
	mb_graph <- depanal s [] False
574
575
576
	case mb_graph of	   
	   Just mod_graph -> load2 s how_much mod_graph 
	   Nothing        -> return Failed
577

578
load2 s@(Session ref) how_much mod_graph = do
579
        guessOutputFile s
580
581
582
583
	hsc_env <- readIORef ref

        let hpt1      = hsc_HPT hsc_env
        let dflags    = hsc_dflags hsc_env
584
        let ghci_mode = ghcMode dflags -- this never changes
585
586
587
588
589

	-- The "bad" boot modules are the ones for which we have
	-- B.hs-boot in the module graph, but no B.hs
	-- The downsweep should have ensured this does not happen
	-- (see msDeps)
Simon Marlow's avatar
Simon Marlow committed
590
591
        let all_home_mods = [ms_mod_name s 
			    | s <- mod_graph, not (isBootSummary s)]
592
#ifdef DEBUG
593
	    bad_boot_mods = [s 	      | s <- mod_graph, isBootSummary s,
Simon Marlow's avatar
Simon Marlow committed
594
					not (ms_mod_name s `elem` all_home_mods)]
595
#endif
596
597
598
599
600
601
602
603
	ASSERT( null bad_boot_mods ) return ()

        -- mg2_with_srcimps drops the hi-boot nodes, returning a 
	-- graph with cycles.  Among other things, it is used for
        -- backing out partially complete cycles following a failed
        -- upsweep, and for removing from hpt all the modules
        -- not in strict downwards closure, during calls to compile.
        let mg2_with_srcimps :: [SCC ModSummary]
604
	    mg2_with_srcimps = topSortModuleGraph True mod_graph Nothing
605

606
607
608
609
610
	-- If we can determine that any of the {-# SOURCE #-} imports
	-- are definitely unnecessary, then emit a warning.
	warnUnnecessarySourceImports dflags mg2_with_srcimps

 	let
611
612
613
614
615
616
617
618
619
620
621
622
623
	    -- check the stability property for each module.
	    stable_mods@(stable_obj,stable_bco)
		| BatchCompile <- ghci_mode = ([],[])
	        | otherwise = checkStability hpt1 mg2_with_srcimps all_home_mods

	    -- prune bits of the HPT which are definitely redundant now,
	    -- to save space.
	    pruned_hpt = pruneHomePackageTable hpt1 
				(flattenSCCs mg2_with_srcimps)
				stable_mods

	evaluate pruned_hpt

624
625
	debugTraceMsg dflags 2 (text "Stable obj:" <+> ppr stable_obj $$
				text "Stable BCO:" <+> ppr stable_bco)
626
627

	-- Unload any modules which are going to be re-linked this time around.
628
629
	let stable_linkables = [ linkable
			       | m <- stable_obj++stable_bco,
Simon Marlow's avatar
Simon Marlow committed
630
				 Just hmi <- [lookupUFM pruned_hpt m],
631
				 Just linkable <- [hm_linkable hmi] ]
632
633
634
635
636
637
638
639
640
641
642
643
	unload hsc_env stable_linkables

        -- We could at this point detect cycles which aren't broken by
        -- a source-import, and complain immediately, but it seems better
        -- to let upsweep_mods do this, so at least some useful work gets
        -- done before the upsweep is abandoned.
        --hPutStrLn stderr "after tsort:\n"
        --hPutStrLn stderr (showSDoc (vcat (map ppr mg2)))

        -- Now do the upsweep, calling compile for each module in
        -- turn.  Final result is version 3 of everything.

644
645
646
647
648
649
        -- Topologically sort the module graph, this time including hi-boot
	-- nodes, and possibly just including the portion of the graph
	-- reachable from the module specified in the 2nd argument to load.
	-- This graph should be cycle-free.
	-- If we're restricting the upsweep to a portion of the graph, we
	-- also want to retain everything that is still stable.
650
        let full_mg :: [SCC ModSummary]
651
	    full_mg    = topSortModuleGraph False mod_graph Nothing
652
653
654

	    maybe_top_mod = case how_much of
				LoadUpTo m           -> Just m
655
			  	LoadDependenciesOf m -> Just m
656
657
			  	_		     -> Nothing

658
659
660
661
662
663
664
665
666
	    partial_mg0 :: [SCC ModSummary]
	    partial_mg0 = topSortModuleGraph False mod_graph maybe_top_mod

	    -- LoadDependenciesOf m: we want the upsweep to stop just
	    -- short of the specified module (unless the specified module
	    -- is stable).
	    partial_mg
		| LoadDependenciesOf mod <- how_much
		= ASSERT( case last partial_mg0 of 
Simon Marlow's avatar
Simon Marlow committed
667
			    AcyclicSCC ms -> ms_mod_name ms == mod; _ -> False )
668
669
670
671
		  List.init partial_mg0
		| otherwise
		= partial_mg0
  
672
673
674
	    stable_mg = 
		[ AcyclicSCC ms
	        | AcyclicSCC ms <- full_mg,
Simon Marlow's avatar
Simon Marlow committed
675
676
677
		  ms_mod_name ms `elem` stable_obj++stable_bco,
		  ms_mod_name ms `notElem` [ ms_mod_name ms' | 
						AcyclicSCC ms' <- partial_mg ] ]
678
679
680

	    mg = stable_mg ++ partial_mg

681
682
	-- clean up between compilations
	let cleanup = cleanTempFilesExcept dflags
683
			  (ppFilesFromSummaries (flattenSCCs mg2_with_srcimps))
684

685
686
	debugTraceMsg dflags 2 (hang (text "Ready for upsweep") 
				   2 (ppr mg))
687
688
        (upsweep_ok, hsc_env1, modsUpswept)
           <- upsweep (hsc_env { hsc_HPT = emptyHomePackageTable })
689
			   pruned_hpt stable_mods cleanup mg
690
691
692
693
694

	-- Make modsDone be the summaries for each home module now
	-- available; this should equal the domain of hpt3.
        -- Get in in a roughly top .. bottom order (hence reverse).

695
        let modsDone = reverse modsUpswept
696
697
698
699
700
701
702
703

        -- Try and do linking in some form, depending on whether the
        -- upsweep was completely or only partially successful.

        if succeeded upsweep_ok

         then 
           -- Easy; just relink it all.
704
           do debugTraceMsg dflags 2 (text "Upsweep completely successful.")
705
706
707
708
709
710
711
712
713
714
715
716
717

	      -- Clean up after ourselves
	      cleanTempFilesExcept dflags (ppFilesFromSummaries modsDone)

	      -- Issue a warning for the confusing case where the user
	      -- said '-o foo' but we're not going to do any linking.
	      -- We attempt linking if either (a) one of the modules is
	      -- called Main, or (b) the user said -no-hs-main, indicating
	      -- that main() is going to come from somewhere else.
	      --
	      let ofile = outputFile dflags
	      let no_hs_main = dopt Opt_NoHsMain dflags
	      let 
718
719
	 	main_mod = mainModIs dflags
		a_root_is_Main = any ((==main_mod).ms_mod) mod_graph
720
721
		do_linking = a_root_is_Main || no_hs_main

722
	      when (ghci_mode == BatchCompile && isJust ofile && not do_linking) $
723
724
	        debugTraceMsg dflags 1 (text ("Warning: output was redirected with -o, " ++
				              "but no output will be generated\n" ++
Simon Marlow's avatar
Simon Marlow committed
725
				              "because there is no " ++ moduleNameString (moduleName main_mod) ++ " module."))
726
727

	      -- link everything together
728
              linkresult <- link ghci_mode dflags do_linking (hsc_HPT hsc_env1)
729

730
	      loadFinish Succeeded linkresult ref hsc_env1
731
732
733
734
735

         else 
           -- Tricky.  We need to back out the effects of compiling any
           -- half-done cycles, both so as to clean up the top level envs
           -- and to avoid telling the interactive linker to link them.
736
           do debugTraceMsg dflags 2 (text "Upsweep partially successful.")
737
738
739
740
741
742
743
744
745
746

              let modsDone_names
                     = map ms_mod modsDone
              let mods_to_zap_names 
                     = findPartiallyCompletedCycles modsDone_names 
			  mg2_with_srcimps
              let mods_to_keep
                     = filter ((`notElem` mods_to_zap_names).ms_mod) 
			  modsDone

Simon Marlow's avatar
Simon Marlow committed
747
              let hpt4 = retainInTopLevelEnvs (map ms_mod_name mods_to_keep) 
748
					      (hsc_HPT hsc_env1)
749
750
751
752

	      -- Clean up after ourselves
	      cleanTempFilesExcept dflags (ppFilesFromSummaries mods_to_keep)

753
754
	      -- there should be no Nothings where linkables should be, now
	      ASSERT(all (isJust.hm_linkable) 
Simon Marlow's avatar
Simon Marlow committed
755
			(eltsUFM (hsc_HPT hsc_env))) do
756
	
757
758
759
	      -- Link everything together
              linkresult <- link ghci_mode dflags False hpt4

760
	      let hsc_env4 = hsc_env1{ hsc_HPT = hpt4 }
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
	      loadFinish Failed linkresult ref hsc_env4

-- Finish up after a load.

-- If the link failed, unload everything and return.
loadFinish all_ok Failed ref hsc_env
  = do unload hsc_env []
       writeIORef ref $! discardProg hsc_env
       return Failed

-- Empty the interactive context and set the module context to the topmost
-- newly loaded module, or the Prelude if none were loaded.
loadFinish all_ok Succeeded ref hsc_env
  = do writeIORef ref $! hsc_env{ hsc_IC = emptyInteractiveContext }
       return all_ok

777

778
779
780
781
782
783
784
785
786
787
-- Forget the current program, but retain the persistent info in HscEnv
discardProg :: HscEnv -> HscEnv
discardProg hsc_env
  = hsc_env { hsc_mod_graph = emptyMG, 
	      hsc_IC = emptyInteractiveContext,
	      hsc_HPT = emptyHomePackageTable }

-- used to fish out the preprocess output files for the purposes of
-- cleaning up.  The preprocessed file *might* be the same as the
-- source file, but that doesn't do any harm.
788
ppFilesFromSummaries summaries = map ms_hspp_file summaries
789

790
791
792
793
794
-- -----------------------------------------------------------------------------
-- Check module

data CheckedModule = 
  CheckedModule { parsedSource      :: ParsedSource,
795
		  renamedSource     :: Maybe RenamedSource,
796
797
798
		  typecheckedSource :: Maybe TypecheckedSource,
		  checkedModuleInfo :: Maybe ModuleInfo
	        }
799
800
801
802
803
	-- ToDo: improvements that could be made here:
	--  if the module succeeded renaming but not typechecking,
	--  we can still get back the GlobalRdrEnv and exports, so
	--  perhaps the ModuleInfo should be split up into separate
	--  fields within CheckedModule.
804

805
type ParsedSource      = Located (HsModule RdrName)
806
807
type RenamedSource     = (HsGroup Name, [LImportDecl Name], Maybe [LIE Name],
                          Maybe (HsDoc Name), HaddockModInfo Name)
808
809
type TypecheckedSource = LHsBinds Id

810
811
812
813
814
815
816
817
818
819
820
821
822
-- NOTE:
--   - things that aren't in the output of the typechecker right now:
--     - the export list
--     - the imports
--     - type signatures
--     - type/data/newtype declarations
--     - class declarations
--     - instances
--   - extra things in the typechecker's output:
--     - default methods are turned into top-level decls.
--     - dictionary bindings


823
824
825
826
-- | This is the way to get access to parsed and typechecked source code
-- for a module.  'checkModule' loads all the dependencies of the specified
-- module in the Session, and then attempts to typecheck the module.  If
-- successful, it returns the abstract syntax for the module.
Simon Marlow's avatar
Simon Marlow committed
827
checkModule :: Session -> ModuleName -> IO (Maybe CheckedModule)
828
checkModule session@(Session ref) mod = do
829
	-- load up the dependencies first
830
   r <- load session (LoadDependenciesOf mod)
831
832
833
834
835
   if (failed r) then return Nothing else do

	-- now parse & typecheck the module
   hsc_env <- readIORef ref   
   let mg  = hsc_mod_graph hsc_env
Simon Marlow's avatar
Simon Marlow committed
836
   case [ ms | ms <- mg, ms_mod_name ms == mod ] of
837
838
	[] -> return Nothing
	(ms:_) -> do 
839
	   mbChecked <- hscFileCheck hsc_env{hsc_dflags=ms_hspp_opts ms} ms
840
841
842
	   case mbChecked of
             Nothing -> return Nothing
             Just (HscChecked parsed renamed Nothing) ->
843
844
845
846
847
		   return (Just (CheckedModule {
					parsedSource = parsed,
					renamedSource = renamed,
					typecheckedSource = Nothing,
					checkedModuleInfo = Nothing }))
848
849
             Just (HscChecked parsed renamed
			   (Just (tc_binds, rdr_env, details))) -> do
850
		   let minf = ModuleInfo {
851
				minf_type_env  = md_types details,
852
853
				minf_exports   = availsToNameSet $
                                                     md_exports details,
854
855
				minf_rdr_env   = Just rdr_env,
				minf_instances = md_insts details
mnislaih's avatar
mnislaih committed
856
857
858
#ifdef GHCI
                               ,minf_dbg_sites = noDbgSites
#endif
859
860
861
			      }
		   return (Just (CheckedModule {
					parsedSource = parsed,
862
					renamedSource = renamed,
863
864
865
866
					typecheckedSource = Just tc_binds,
					checkedModuleInfo = Just minf }))

-- ---------------------------------------------------------------------------
867
868
869
870
871
-- Unloading

unload :: HscEnv -> [Linkable] -> IO ()
unload hsc_env stable_linkables	-- Unload everthing *except* 'stable_linkables'
  = case ghcMode (hsc_dflags hsc_env) of
872
873
	BatchCompile  -> return ()
	JustTypecheck -> return ()
874
875
876
877
878
879
880
#ifdef GHCI
	Interactive -> Linker.unload (hsc_dflags hsc_env) stable_linkables
#else
	Interactive -> panic "unload: no interpreter"
#endif
	other -> panic "unload: strange mode"

881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
-- -----------------------------------------------------------------------------
-- checkStability

{-
  Stability tells us which modules definitely do not need to be recompiled.
  There are two main reasons for having stability:
  
   - avoid doing a complete upsweep of the module graph in GHCi when
     modules near the bottom of the tree have not changed.

   - to tell GHCi when it can load object code: we can only load object code
     for a module when we also load object code fo  all of the imports of the
     module.  So we need to know that we will definitely not be recompiling
     any of these modules, and we can use the object code.

  NB. stability is of no importance to BatchCompile at all, only Interactive.
  (ToDo: what about JustTypecheck?)

  The stability check is as follows.  Both stableObject and
  stableBCO are used during the upsweep phase later.

  -------------------
  stable m = stableObject m || stableBCO m

  stableObject m = 
	all stableObject (imports m)
	&& old linkable does not exist, or is == on-disk .o
	&& date(on-disk .o) > date(.hs)

  stableBCO m =
	all stable (imports m)
	&& date(BCO) > date(.hs)
  -------------------    

  These properties embody the following ideas:

    - if a module is stable:
	- if it has been compiled in a previous pass (present in HPT)
	  then it does not need to be compiled or re-linked.
        - if it has not been compiled in a previous pass,
	  then we only need to read its .hi file from disk and
	  link it to produce a ModDetails.

    - if a modules is not stable, we will definitely be at least
      re-linking, and possibly re-compiling it during the upsweep.
      All non-stable modules can (and should) therefore be unlinked
      before the upsweep.

    - Note that objects are only considered stable if they only depend
      on other objects.  We can't link object code against byte code.
-}

checkStability
	:: HomePackageTable		-- HPT from last compilation
	-> [SCC ModSummary]		-- current module graph (cyclic)
Simon Marlow's avatar
Simon Marlow committed
936
937
938
	-> [ModuleName]			-- all home modules
	-> ([ModuleName],		-- stableObject
	    [ModuleName])		-- stableBCO
939
940
941
942
943
944
945
946
947

checkStability hpt sccs all_home_mods = foldl checkSCC ([],[]) sccs
  where
   checkSCC (stable_obj, stable_bco) scc0
     | stableObjects = (scc_mods ++ stable_obj, stable_bco)
     | stableBCOs    = (stable_obj, scc_mods ++ stable_bco)
     | otherwise     = (stable_obj, stable_bco)
     where
	scc = flattenSCC scc0
Simon Marlow's avatar
Simon Marlow committed
948
	scc_mods = map ms_mod_name scc
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
	home_module m   = m `elem` all_home_mods && m `notElem` scc_mods

        scc_allimps = nub (filter home_module (concatMap ms_allimps scc))
	    -- all imports outside the current SCC, but in the home pkg
	
	stable_obj_imps = map (`elem` stable_obj) scc_allimps
	stable_bco_imps = map (`elem` stable_bco) scc_allimps

	stableObjects = 
	   and stable_obj_imps
	   && all object_ok scc

	stableBCOs = 
	   and (zipWith (||) stable_obj_imps stable_bco_imps)
	   && all bco_ok scc

	object_ok ms
	  | Just t <- ms_obj_date ms  =  t >= ms_hs_date ms 
					 && same_as_prev t
	  | otherwise = False
	  where
Simon Marlow's avatar
Simon Marlow committed
970
	     same_as_prev t = case lookupUFM hpt (ms_mod_name ms) of
971
972
				Just hmi  | Just l <- hm_linkable hmi
				 -> isObjectLinkable l && t == linkableTime l
973
				_other  -> True
974
		-- why '>=' rather than '>' above?  If the filesystem stores
975
976
977
978
979
980
		-- times to the nearset second, we may occasionally find that
		-- the object & source have the same modification time, 
		-- especially if the source was automatically generated
		-- and compiled.  Using >= is slightly unsafe, but it matches
		-- make's behaviour.

981
	bco_ok ms
Simon Marlow's avatar
Simon Marlow committed
982
	  = case lookupUFM hpt (ms_mod_name ms) of
983
984
985
		Just hmi  | Just l <- hm_linkable hmi ->
			not (isObjectLinkable l) && 
			linkableTime l >= ms_hs_date ms
986
		_other  -> False
987

Simon Marlow's avatar
Simon Marlow committed
988
ms_allimps :: ModSummary -> [ModuleName]
989
ms_allimps ms = map unLoc (ms_srcimps ms ++ ms_imps ms)
990

991
992
-- -----------------------------------------------------------------------------
-- Prune the HomePackageTable
993

994
995
996
997
998
999
1000
-- Before doing an upsweep, we can throw away:
--
--   - For non-stable modules:
--	- all ModDetails, all linked code
--   - all unlinked code that is out of date with respect to
--     the source file
--
For faster browsing, not all history is shown. View entire blame