GHC.hs 81.4 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,
ei@vuokko.info's avatar
ei@vuokko.info committed
85
	compileExpr, HValue, dynCompileExpr,
86
	lookupName,
mnislaih's avatar
mnislaih committed
87

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

	-- * Abstract syntax elements
93

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

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

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

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

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

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

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

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

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

	-- ** Entities
151
152
	TyThing(..), 

153
154
155
	-- ** Syntax
	module HsSyn, -- ToDo: remove extraneous bits

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

	-- ** Source locations
	SrcLoc, pprDefnLoc,

165
166
167
168
	-- * Exceptions
	GhcException(..), showGhcException,

	-- * Miscellaneous
169
170
	sessionHscEnv,
	cyclicModuleErr,
171
172
  ) where

173
174
175
{-
 ToDo:

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

#include "HsVersions.h"

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

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

import Control.Concurrent
import System.Directory ( getModificationTime, doesFileExist )
275
import Data.Maybe	( isJust, isNothing )
276
277
278
279
280
281
282
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
mnislaih's avatar
mnislaih committed
283
import Data.Traversable ( traverse )
284
import System.IO
285
import System.IO.Error	( isDoesNotExistError )
286
import Prelude hiding (init)
287

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

294
-- -----------------------------------------------------------------------------
295
-- Exception handlers
296
297
298
299
300

-- | 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.
301
302
defaultErrorHandler :: DynFlags -> IO a -> IO a
defaultErrorHandler dflags inner = 
303
304
305
306
307
  -- 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
308
309
		IOException _ ->
		  fatalErrorMsg dflags (text (show exception))
310
		AsyncException StackOverflow ->
311
312
313
		  fatalErrorMsg dflags (text "stack overflow: use +RTS -K<size> to increase it")
		_other ->
		  fatalErrorMsg dflags (text (show (Panic (show exception))))
314
315
316
	   exitWith (ExitFailure 1)
         ) $

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

  -- error messages propagated as exceptions
323
324
325
326
327
  handleDyn (\dyn -> do
  		hFlush stdout
  		case dyn of
		     PhaseFailed _ code -> exitWith code
		     Interrupted -> exitWith (ExitFailure 1)
328
		     _ -> do fatalErrorMsg dflags (text (show (dyn :: GhcException)))
329
330
331
332
333
334
335
336
			     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.
337
338
defaultCleanupHandler :: DynFlags -> IO a -> IO a
defaultCleanupHandler dflags inner = 
339
340
341
342
343
344
345
346
347
    -- make sure we clean up after ourselves
    later (unless (dopt Opt_KeepTmpFiles dflags) $
               do cleanTempFiles dflags
                  cleanTempDirs dflags
          )
          -- exceptions will be blocked while we clean the temporary files,
          -- so there shouldn't be any difficulty if we receive further
          -- signals.
    inner
348
349


350
351
352
353
354
355
#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

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

  dflags0 <- initSysTools mb_top_dir defaultDynFlags
  dflags  <- initDynFlags dflags0
369
  env <- newHscEnv dflags{ ghcMode=mode }
370
  ref <- newIORef env
371
372
373
374
375
376
377
378
379
380
381
382
  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
383
384
385
386
387
388

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

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

391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
-- | 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
408

409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
-- | 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 } }

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

-- 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
434
-- the program\/library.  Unloading the current program is achieved by
435
-- setting the current set of targets to be empty, followed by load.
436
setTargets :: Session -> [Target] -> IO ()
437
setTargets s targets = modifySession s (\h -> h{ hsc_targets = targets })
438
439

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

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

448
449
450
451
452
453
-- | 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 ]
454

455
456
457
458
459
460
461
462
463
-- 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
--
464
465
466
467
guessTarget :: String -> Maybe Phase -> IO Target
guessTarget file (Just phase)
   = return (Target (TargetFile file (Just phase)) Nothing)
guessTarget file Nothing
468
   | isHaskellSrcFilename file
469
   = return (Target (TargetFile file Nothing) Nothing)
470
471
   | otherwise
   = do exists <- doesFileExist hs_file
472
473
474
	if exists
	   then return (Target (TargetFile hs_file Nothing) Nothing)
	   else do
475
	exists <- doesFileExist lhs_file
476
477
478
	if exists
	   then return (Target (TargetFile lhs_file Nothing) Nothing)
	   else do
Simon Marlow's avatar
Simon Marlow committed
479
	return (Target (TargetModule (mkModuleName file)) Nothing)
480
     where 
481
482
	 hs_file  = file `joinFileExt` "hs"
	 lhs_file = file `joinFileExt` "lhs"
483

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

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

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

515
516
-- -----------------------------------------------------------------------------
-- Loading the program
517

518
519
-- 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
520
depanal :: Session -> [ModuleName] -> Bool -> IO (Maybe ModuleGraph)
521
depanal (Session ref) excluded_mods allow_dup_roots = do
522
523
524
525
526
527
528
529
  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"
530
  when (gmode == BatchCompile) $
531
	debugTraceMsg dflags 2 (hcat [
532
		     text "Chasing modules from: ",
533
	     		hcat (punctuate comma (map pprTarget targets))])
534

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

541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
{-
-- | 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
559
560
   | LoadUpTo ModuleName
   | LoadDependenciesOf ModuleName
561
562
563
564

-- | 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.
565
load :: Session -> LoadHowMuch -> IO SuccessFlag
566
load s@(Session ref) how_much
567
   = do 
568
569
570
571
	-- 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.
572
	mb_graph <- depanal s [] False
573
574
575
	case mb_graph of	   
	   Just mod_graph -> load2 s how_much mod_graph 
	   Nothing        -> return Failed
576

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

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

	-- 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
589
590
        let all_home_mods = [ms_mod_name s 
			    | s <- mod_graph, not (isBootSummary s)]
591
#ifdef DEBUG
592
	    bad_boot_mods = [s 	      | s <- mod_graph, isBootSummary s,
Simon Marlow's avatar
Simon Marlow committed
593
					not (ms_mod_name s `elem` all_home_mods)]
594
#endif
595
596
597
598
599
600
601
602
	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]
603
	    mg2_with_srcimps = topSortModuleGraph True mod_graph Nothing
604

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

 	let
610
611
612
613
614
615
616
617
618
619
620
621
622
	    -- 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

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

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

643
644
645
646
647
648
        -- 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.
649
        let full_mg :: [SCC ModSummary]
650
	    full_mg    = topSortModuleGraph False mod_graph Nothing
651
652
653

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

657
658
659
660
661
662
663
664
665
	    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
666
			    AcyclicSCC ms -> ms_mod_name ms == mod; _ -> False )
667
668
669
670
		  List.init partial_mg0
		| otherwise
		= partial_mg0
  
671
672
673
	    stable_mg = 
		[ AcyclicSCC ms
	        | AcyclicSCC ms <- full_mg,
Simon Marlow's avatar
Simon Marlow committed
674
675
676
		  ms_mod_name ms `elem` stable_obj++stable_bco,
		  ms_mod_name ms `notElem` [ ms_mod_name ms' | 
						AcyclicSCC ms' <- partial_mg ] ]
677
678
679

	    mg = stable_mg ++ partial_mg

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

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

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

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

        -- 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.
703
           do debugTraceMsg dflags 2 (text "Upsweep completely successful.")
704
705
706
707
708
709
710
711
712
713
714
715
716

	      -- 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 
717
718
	 	main_mod = mainModIs dflags
		a_root_is_Main = any ((==main_mod).ms_mod) mod_graph
719
720
		do_linking = a_root_is_Main || no_hs_main

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

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

729
	      loadFinish Succeeded linkresult ref hsc_env1
730
731
732
733
734

         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.
735
           do debugTraceMsg dflags 2 (text "Upsweep partially successful.")
736
737
738
739
740
741
742
743
744
745

              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
746
              let hpt4 = retainInTopLevelEnvs (map ms_mod_name mods_to_keep) 
747
					      (hsc_HPT hsc_env1)
748
749
750
751

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

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

759
	      let hsc_env4 = hsc_env1{ hsc_HPT = hpt4 }
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
	      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

776

777
778
779
780
781
782
783
784
785
786
-- 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.
787
ppFilesFromSummaries summaries = map ms_hspp_file summaries
788

789
790
791
792
793
-- -----------------------------------------------------------------------------
-- Check module

data CheckedModule = 
  CheckedModule { parsedSource      :: ParsedSource,
794
		  renamedSource     :: Maybe RenamedSource,
795
796
797
		  typecheckedSource :: Maybe TypecheckedSource,
		  checkedModuleInfo :: Maybe ModuleInfo
	        }
798
799
800
801
802
	-- 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.
803

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

809
810
811
812
813
814
815
816
817
818
819
820
821
-- 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


822
823
824
825
-- | 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
826
checkModule :: Session -> ModuleName -> IO (Maybe CheckedModule)
827
checkModule session@(Session ref) mod = do
828
	-- load up the dependencies first
829
   r <- load session (LoadDependenciesOf mod)
830
831
832
833
834
   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
835
   case [ ms | ms <- mg, ms_mod_name ms == mod ] of
836
837
	[] -> return Nothing
	(ms:_) -> do 
838
	   mbChecked <- hscFileCheck hsc_env{hsc_dflags=ms_hspp_opts ms} ms
839
840
841
	   case mbChecked of
             Nothing -> return Nothing
             Just (HscChecked parsed renamed Nothing) ->
842
843
844
845
846
		   return (Just (CheckedModule {
					parsedSource = parsed,
					renamedSource = renamed,
					typecheckedSource = Nothing,
					checkedModuleInfo = Nothing }))
847
848
             Just (HscChecked parsed renamed
			   (Just (tc_binds, rdr_env, details))) -> do
849
		   let minf = ModuleInfo {
850
				minf_type_env  = md_types details,
851
852
				minf_exports   = availsToNameSet $
                                                     md_exports details,
853
854
				minf_rdr_env   = Just rdr_env,
				minf_instances = md_insts details
mnislaih's avatar
mnislaih committed
855
856
857
#ifdef GHCI
                               ,minf_dbg_sites = noDbgSites
#endif
858
859
860
			      }
		   return (Just (CheckedModule {
					parsedSource = parsed,
861
					renamedSource = renamed,
862
863
864
865
					typecheckedSource = Just tc_binds,
					checkedModuleInfo = Just minf }))

-- ---------------------------------------------------------------------------
866
867
868
869
870
-- Unloading

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

880
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
-- -----------------------------------------------------------------------------
-- 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
935
936
937
	-> [ModuleName]			-- all home modules
	-> ([ModuleName],		-- stableObject
	    [ModuleName])		-- stableBCO
938
939
940
941
942
943
944
945
946

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
947
	scc_mods = map ms_mod_name scc
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
	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
969
	     same_as_prev t = case lookupUFM hpt (ms_mod_name ms) of
970
971
				Just hmi  | Just l <- hm_linkable hmi
				 -> isObjectLinkable l && t == linkableTime l
972
				_other  -> True
973
		-- why '>=' rather than '>' above?  If the filesystem stores
974
975
976
977
978
979
		-- 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.

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

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

990
991
-- -----------------------------------------------------------------------------
-- Prune the HomePackageTable
992

993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
-- 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
--
-- This is VERY IMPORTANT otherwise we'll end up requiring 2x the
-- space at the end of the upsweep, because the topmost ModDetails of the
-- old HPT holds on to the entire type environment from the previous
-- compilation.

pruneHomePackageTable
   :: HomePackageTable
   -> [ModSummary]
Simon Marlow's avatar
Simon Marlow committed
1008
   -> ([ModuleName],[ModuleName])
1009
1010
1011
   -> HomePackageTable

pruneHomePackageTable hpt summ (stable_obj, stable_bco)
Simon Marlow's avatar
Simon Marlow committed
1012
  = mapUFM prune hpt
1013
1014
1015
1016
  where prune hmi
	  | is_stable modl = hmi'
	  | otherwise      = hmi'{ hm_details = emptyModDetails }
	  where
Simon Marlow's avatar
Simon Marlow committed
1017
	   modl = moduleName (mi_module (hm_iface hmi))
1018
1019
1020
1021
	   hmi' | Just l <- hm_linkable hmi, linkableTime l < ms_hs_date ms
		= hmi{ hm_linkable = Nothing }
		| otherwise
		= hmi
Simon Marlow's avatar
Simon Marlow committed
1022
		where ms = expectJust "prune" (lookupUFM ms_map modl)
1023

Simon Marlow's avatar
Simon Marlow committed
1024
        ms_map = listToUFM [(ms_mod_name ms, ms) | ms <- summ]
1025

1026
1027
1028
	is_stable m = m `elem` stable_obj || m `elem` stable_bco

-- -----------------------------------------------------------------------------
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049

-- Return (names of) all those in modsDone who are part of a cycle
-- as defined by theGraph.
findPartiallyCompletedCycles :: [Module] -> [SCC ModSummary] -> [Module]
findPartiallyCompletedCycles modsDone theGraph
   = chew theGraph
     where
        chew [] = []
        chew ((AcyclicSCC v):rest) = chew rest    -- acyclic?  not interesting.
        chew ((CyclicSCC vs):rest)
           = let names_in_this_cycle = nub (map ms_mod vs)
                 mods_in_this_cycle  
                    = nub ([done | done <- modsDone, 
                                   done `elem` names_in_this_cycle])
                 chewed_rest = chew rest
             in 
             if   notNull mods_in_this_cycle
                  && length mods_in_this_cycle < length names_in_this_cycle
             then mods_in_this_cycle ++ chewed_rest
             else chewed_rest

1050
1051
1052
1053
1054
-- -----------------------------------------------------------------------------
-- The upsweep

-- This is where we compile each module in the module graph, in a pass
-- from the bottom to the top of the graph.
1055
1056

-- There better had not be any cyclic groups here -- we check for them.
1057
1058
1059
1060

upsweep
    :: HscEnv			-- Includes initially-empty HPT
    -> HomePackageTable		-- HPT from last time round (pruned)
Simon Marlow's avatar
Simon Marlow committed
1061
    -> ([ModuleName],[ModuleName]) -- stable modules (see checkStability)
1062
1063
1064
1065
1066
1067
    -> IO ()			-- How to clean up unwanted tmp files
    -> [SCC ModSummary]		-- Mods to do (the worklist)
    -> IO (SuccessFlag,
           HscEnv,		-- With an updated HPT
           [ModSummary])	-- Mods which succeeded

1068
1069
upsweep hsc_env old_hpt stable_mods cleanup mods
   = upsweep' hsc_env old_hpt stable_mods cleanup mods 1 (length mods)
1070

1071
upsweep' hsc_env old_hpt stable_mods cleanup
1072
     [] _ _
1073
1074
   = return (Succeeded, hsc_env, [])

1075
upsweep' hsc_env old_hpt stable_mods cleanup
1076
     (CyclicSCC ms:_) _ _
1077
   = do fatalErrorMsg (hsc_dflags hsc_env) (cyclicModuleErr ms)
1078
1079
        return (Failed, hsc_env, [])

1080
upsweep' hsc_env old_hpt stable_mods cleanup
1081
     (AcyclicSCC mod:mods) mod_index nmods
1082
1083
1084
1085
   = do -- putStrLn ("UPSWEEP_MOD: hpt = " ++ 
	--	     show (map (moduleUserString.moduleName.mi_module.hm_iface) 
	--		       (moduleEnvElts (hsc_HPT hsc_env)))

1086
        mb_mod_info <- upsweep_mod hsc_env old_hpt stable_mods mod 
1087
                       mod_index nmods
1088
1089
1090
1091
1092
1093

	cleanup		-- Remove unwanted tmp files between compilations

        case mb_mod_info of
	    Nothing -> return (Failed, hsc_env, [])
	    Just mod_info -> do 
Simon Marlow's avatar
Simon Marlow committed
1094
		{ let this_mod = ms_mod_name mod
1095
1096

			-- Add new info to hsc_env
Simon Marlow's avatar
Simon Marlow committed
1097
		      hpt1     = addToUFM (hsc_HPT hsc_env) this_mod mod_info
1098
		      hsc_env1 = hsc_env { hsc_HPT = hpt1 }
1099
1100
1101
1102

			-- Space-saving: delete the old HPT entry
			-- for mod BUT if mod is a hs-boot
			-- node, don't delete it.  For the
1103
1104
1105
			-- interface, the HPT entry is probaby for the
			-- main Haskell source file.  Deleting it
			-- would force .. (what?? --SDM)
1106
		      old_hpt1 | isBootSummary mod = old_hpt
Simon Marlow's avatar
Simon Marlow committed
1107
			       | otherwise = delFromUFM old_hpt this_mod
1108

1109
		; (restOK, hsc_env2, modOKs) 
1110
			<- upsweep' hsc_env1 old_hpt1 stable_mods cleanup 
1111
				mods (mod_index+1) nmods
1112
1113
		; return (restOK, hsc_env2, mod:modOKs)
		}
1114
1115
1116
1117
1118


-- Compile a single module.  Always produce a Linkable for it if 
-- successful.  If no compilation happened, return the old Linkable.
upsweep_mod :: HscEnv
1119
            -> HomePackageTable
Simon Marlow's avatar
Simon Marlow committed
1120
	    -> ([ModuleName],[ModuleName])
1121
            -> ModSummary
1122
1123
            -> Int  -- index of module
            -> Int  -- total number of modules
1124
1125
            -> IO (Maybe HomeModInfo)	-- Nothing => Failed

1126
upsweep_mod hsc_env old_hpt (stable_obj, stable_bco) summary mod_index nmods
1127
   = do 
1128
        let 
Simon Marlow's avatar
Simon Marlow committed
1129
	    this_mod_name = ms_mod_name summary
1130
1131
1132
1133
1134
1135
	    this_mod    = ms_mod summary
	    mb_obj_date = ms_obj_date summary
	    obj_fn	= ml_obj_file (ms_location summary)
	    hs_date     = ms_hs_date summary

	    compile_it :: Maybe Linkable -> IO (Maybe HomeModInfo)
Simon Marlow's avatar
Simon Marlow committed
1136
	    compile_it  = upsweep_compile hsc_env old_hpt this_mod_name 
1137
				summary mod_index nmods
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183

	case ghcMode (hsc_dflags hsc_env) of
	    BatchCompile ->
		case () of
		   -- Batch-compilating is easy: just check whether we have
		   -- an up-to-date object file.  If we do, then the compiler
		   -- needs to do a recompilation check.
		   _ | Just obj_date <- mb_obj_date, obj_date >= hs_date -> do
		           linkable <- 
				findObjectLinkable this_mod obj_fn obj_date
			   compile_it (Just linkable)

		     | otherwise ->
		           compile_it Nothing

	    interactive ->
		case () of
		    _ | is_stable_obj, isJust old_hmi ->
			   return old_hmi
			-- object is stable, and we have an entry in the
			-- old HPT: nothing to do

		      | is_stable_obj, isNothing old_hmi -> do
		           linkable <-
				findObjectLinkable this_mod obj_fn 
					(expectJust "upseep1" mb_obj_date)
			   compile_it (Just linkable)
			-- object is stable, but we need to load the interface
			-- off disk to make a HMI.

		      | is_stable_bco -> 
			   ASSERT(isJust old_hmi) -- must be in the old_hpt
			   return old_hmi
			-- BCO is stable: nothing to do

		      | Just hmi <- old_hmi,
			Just l <- hm_l