GHC.hs 84.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
18
	DynFlags(..), DynFlag(..), Severity(..), HscTarget(..), dopt,
        GhcMode(..), GhcLink(..),
19
	parseDynamicFlags,
20
21
	getSessionDynFlags,
	setSessionDynFlags,
22
23

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

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

44
45
46
	-- * Parsing Haddock comments
	parseHaddockComment,

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

53
54
55
56
	-- * Inspecting modules
	ModuleInfo,
	getModuleInfo,
	modInfoTyThings,
57
	modInfoTopLevelScope,
58
59
	modInfoPrintUnqualified,
	modInfoExports,
60
	modInfoInstances,
61
62
	modInfoIsExportedName,
	modInfoLookupName,
63
	lookupGlobalName,
64

65
66
67
	-- * Printing
	PrintUnqualified, alwaysQualify,

68
69
	-- * Interactive evaluation
	getBindings, getPrintUnqual,
Simon Marlow's avatar
Simon Marlow committed
70
        findModule,
71
72
#ifdef GHCI
	setContext, getContext,	
73
	getNamesInScope,
Simon Marlow's avatar
Simon Marlow committed
74
	getRdrNamesInScope,
75
	moduleIsInterpreted,
76
	getInfo,
77
78
	exprType,
	typeKind,
79
	parseName,
80
	RunResult(..),  ResumeHandle,
81
	runStmt,
82
        resume,
83
	showModule,
84
        isModuleInterpreted,
ei@vuokko.info's avatar
ei@vuokko.info committed
85
	compileExpr, HValue, dynCompileExpr,
86
	lookupName,
mnislaih's avatar
mnislaih committed
87
        obtainTerm, obtainTerm1,
88
89
        ModBreaks(..), BreakIndex,
        BreakInfo(breakInfo_number, breakInfo_module),
90
        modInfoModBreaks, 
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
import VarEnv		( emptyTidyEnv )
189
import GHC.Exts         ( unsafeCoerce#, Ptr )
190
import Foreign.StablePtr( deRefStablePtr, StablePtr, newStablePtr, freeStablePtr )
191
import Foreign          ( poke )
mnislaih's avatar
mnislaih committed
192
import qualified Linker
193
import Linker           ( HValue )
mnislaih's avatar
mnislaih committed
194
195

import Data.Dynamic     ( Dynamic )
196

197
198
199
200
import ByteCodeInstr
import DebuggerTys
import IdInfo
import HscMain          ( hscParseIdentifier, hscTcExpr, hscKcType, hscStmt )
201
202
#endif

203
204
205
import Packages
import NameSet
import RdrName
206
import HsSyn 
207
208
209
import Type             hiding (typeKind)
import Id
import Var              hiding (setIdType)
210
import TysPrim		( alphaTyVars )
211
212
213
214
215
import TyCon
import Class
import FunDeps
import DataCon
import Name             hiding ( varName )
216
import OccName		( parenSymOcc )
217
import NameEnv
218
import InstEnv		( Instance, instanceDFunId, pprInstance, pprInstanceHdr )
219
import SrcLoc
220
221
import DriverPipeline
import DriverPhases	( Phase(..), isHaskellSrcFilename, startPhase )
222
import HeaderInfo	( getImports, getOptions )
223
import Finder
224
import HscMain          ( newHscEnv, hscFileCheck, HscChecked(..) )
225
226
import HscTypes
import DynFlags
227
228
import SysTools     ( initSysTools, cleanTempFiles, cleanTempFilesExcept,
                      cleanTempDirs )
229
import Module
Simon Marlow's avatar
Simon Marlow committed
230
import UniqFM
231
import PackageConfig
232
233
import FiniteMap
import Panic
234
import Digraph
235
import Bag		( unitBag, listToBag )
236
import ErrUtils		( Severity(..), showPass, fatalErrorMsg, debugTraceMsg,
237
238
			  mkPlainErrMsg, printBagOfErrors, printBagOfWarnings,
			  WarnMsg )
239
import qualified ErrUtils
240
import Util
241
import StringBuffer	( StringBuffer, hGetStringBuffer )
242
import Outputable
243
import BasicTypes
244
import TcType           ( tcSplitSigmaTy, isDictTy )
245
import Maybes		( expectJust, mapCatMaybes )
246
import HaddockParse
247
import HaddockLex       ( tokenise )
248
249
250

import Control.Concurrent
import System.Directory ( getModificationTime, doesFileExist )
251
252
import Data.Maybe
import Data.List
253
import qualified Data.List as List
254
import Control.Monad
255
256
257
258
259
import System.Exit	( exitWith, ExitCode(..) )
import System.Time	( ClockTime )
import Control.Exception as Exception hiding (handle)
import Data.IORef
import System.IO
260
import System.IO.Error	( isDoesNotExistError )
261
import Prelude hiding (init)
262

263
264
265
266
267
268
#if __GLASGOW_HASKELL__ < 600
import System.IO as System.IO.Error ( try )
#else
import System.IO.Error	( try )
#endif

269
-- -----------------------------------------------------------------------------
270
-- Exception handlers
271
272
273
274
275

-- | 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.
276
277
defaultErrorHandler :: DynFlags -> IO a -> IO a
defaultErrorHandler dflags inner = 
278
279
280
281
282
  -- 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
283
284
		IOException _ ->
		  fatalErrorMsg dflags (text (show exception))
285
		AsyncException StackOverflow ->
286
287
288
		  fatalErrorMsg dflags (text "stack overflow: use +RTS -K<size> to increase it")
		_other ->
		  fatalErrorMsg dflags (text (show (Panic (show exception))))
289
290
291
	   exitWith (ExitFailure 1)
         ) $

292
293
  -- program errors: messages with locations attached.  Sometimes it is
  -- convenient to just throw these as exceptions.
294
  handleDyn (\dyn -> do printBagOfErrors dflags (unitBag dyn)
295
296
297
			exitWith (ExitFailure 1)) $

  -- error messages propagated as exceptions
298
299
300
301
302
  handleDyn (\dyn -> do
  		hFlush stdout
  		case dyn of
		     PhaseFailed _ code -> exitWith code
		     Interrupted -> exitWith (ExitFailure 1)
303
		     _ -> do fatalErrorMsg dflags (text (show (dyn :: GhcException)))
304
305
306
307
308
309
310
311
			     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.
312
313
defaultCleanupHandler :: DynFlags -> IO a -> IO a
defaultCleanupHandler dflags inner = 
314
    -- make sure we clean up after ourselves
315
316
    later (do cleanTempFiles dflags
              cleanTempDirs dflags
317
318
319
320
321
          )
          -- exceptions will be blocked while we clean the temporary files,
          -- so there shouldn't be any difficulty if we receive further
          -- signals.
    inner
322
323
324
325


-- | Starts a new session.  A session consists of a set of loaded
-- modules, a set of options (DynFlags), and an interactive context.
326
327
newSession :: Maybe FilePath -> IO Session
newSession mb_top_dir = do
328
329
  -- catch ^C
  main_thread <- myThreadId
330
  modifyMVar_ interruptTargetThread (return . (main_thread :))
331
332
333
334
  installSignalHandlers

  dflags0 <- initSysTools mb_top_dir defaultDynFlags
  dflags  <- initDynFlags dflags0
335
  env <- newHscEnv dflags
336
  ref <- newIORef env
337
338
339
340
341
342
343
344
345
346
347
348
  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
349
350
351
352
353
354

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

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

357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
-- | 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
374

375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
-- | 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 } }

392
-- -----------------------------------------------------------------------------
393
-- Targets
394
395
396
397
398
399

-- 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
400
-- the program\/library.  Unloading the current program is achieved by
401
-- setting the current set of targets to be empty, followed by load.
402
setTargets :: Session -> [Target] -> IO ()
403
setTargets s targets = modifySession s (\h -> h{ hsc_targets = targets })
404
405

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

409
-- | Add another target
410
411
412
addTarget :: Session -> Target -> IO ()
addTarget s target
  = modifySession s (\h -> h{ hsc_targets = target : hsc_targets h })
413

414
415
416
417
418
419
-- | 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 ]
420

421
422
423
424
425
426
427
428
429
-- 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
--
430
431
432
433
guessTarget :: String -> Maybe Phase -> IO Target
guessTarget file (Just phase)
   = return (Target (TargetFile file (Just phase)) Nothing)
guessTarget file Nothing
434
   | isHaskellSrcFilename file
435
   = return (Target (TargetFile file Nothing) Nothing)
436
437
   | otherwise
   = do exists <- doesFileExist hs_file
438
439
440
	if exists
	   then return (Target (TargetFile hs_file Nothing) Nothing)
	   else do
441
	exists <- doesFileExist lhs_file
442
443
444
	if exists
	   then return (Target (TargetFile lhs_file Nothing) Nothing)
	   else do
Simon Marlow's avatar
Simon Marlow committed
445
	return (Target (TargetModule (mkModuleName file)) Nothing)
446
     where 
447
448
	 hs_file  = file `joinFileExt` "hs"
	 lhs_file = file `joinFileExt` "lhs"
449

450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
-- -----------------------------------------------------------------------------
-- 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 }

475
476
477
478
479
480
-- -----------------------------------------------------------------------------
-- Parsing Haddock comments

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

481
482
-- -----------------------------------------------------------------------------
-- Loading the program
483

484
485
-- 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
486
depanal :: Session -> [ModuleName] -> Bool -> IO (Maybe ModuleGraph)
487
depanal (Session ref) excluded_mods allow_dup_roots = do
488
489
490
491
492
493
494
  hsc_env <- readIORef ref
  let
	 dflags  = hsc_dflags hsc_env
	 targets = hsc_targets hsc_env
	 old_graph = hsc_mod_graph hsc_env
	
  showPass dflags "Chasing dependencies"
495
496
497
  debugTraceMsg dflags 2 (hcat [
	     text "Chasing modules from: ",
	     hcat (punctuate comma (map pprTarget targets))])
498

499
  r <- downsweep hsc_env old_graph excluded_mods allow_dup_roots
500
  case r of
501
    Just mod_graph -> writeIORef ref hsc_env{ hsc_mod_graph = mod_graph }
502
503
    _ -> return ()
  return r
504

505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
{-
-- | 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
523
524
   | LoadUpTo ModuleName
   | LoadDependenciesOf ModuleName
525
526
527
528

-- | 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.
529
load :: Session -> LoadHowMuch -> IO SuccessFlag
530
load s@(Session ref) how_much
531
   = do 
532
533
534
535
	-- 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.
536
	mb_graph <- depanal s [] False
537
538
539
	case mb_graph of	   
	   Just mod_graph -> load2 s how_much mod_graph 
	   Nothing        -> return Failed
540

541
load2 s@(Session ref) how_much mod_graph = do
542
        guessOutputFile s
543
544
545
546
547
548
549
550
551
	hsc_env <- readIORef ref

        let hpt1      = hsc_HPT hsc_env
        let dflags    = hsc_dflags hsc_env

	-- 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
552
553
        let all_home_mods = [ms_mod_name s 
			    | s <- mod_graph, not (isBootSummary s)]
554
#ifdef DEBUG
555
	    bad_boot_mods = [s 	      | s <- mod_graph, isBootSummary s,
Simon Marlow's avatar
Simon Marlow committed
556
					not (ms_mod_name s `elem` all_home_mods)]
557
#endif
558
559
560
561
562
563
564
565
	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]
566
	    mg2_with_srcimps = topSortModuleGraph True mod_graph Nothing
567

568
569
570
571
572
	-- If we can determine that any of the {-# SOURCE #-} imports
	-- are definitely unnecessary, then emit a warning.
	warnUnnecessarySourceImports dflags mg2_with_srcimps

 	let
573
574
	    -- check the stability property for each module.
	    stable_mods@(stable_obj,stable_bco)
575
	        = checkStability hpt1 mg2_with_srcimps all_home_mods
576
577
578
579
580
581
582
583
584

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

585
586
	debugTraceMsg dflags 2 (text "Stable obj:" <+> ppr stable_obj $$
				text "Stable BCO:" <+> ppr stable_bco)
587
588

	-- Unload any modules which are going to be re-linked this time around.
589
590
	let stable_linkables = [ linkable
			       | m <- stable_obj++stable_bco,
Simon Marlow's avatar
Simon Marlow committed
591
				 Just hmi <- [lookupUFM pruned_hpt m],
592
				 Just linkable <- [hm_linkable hmi] ]
593
594
595
596
597
598
599
600
601
602
603
604
	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.

605
606
607
608
609
610
        -- 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.
611
        let full_mg :: [SCC ModSummary]
612
	    full_mg    = topSortModuleGraph False mod_graph Nothing
613
614
615

	    maybe_top_mod = case how_much of
				LoadUpTo m           -> Just m
616
			  	LoadDependenciesOf m -> Just m
617
618
			  	_		     -> Nothing

619
620
621
622
623
624
625
626
627
	    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
628
			    AcyclicSCC ms -> ms_mod_name ms == mod; _ -> False )
629
630
631
632
		  List.init partial_mg0
		| otherwise
		= partial_mg0
  
633
634
635
	    stable_mg = 
		[ AcyclicSCC ms
	        | AcyclicSCC ms <- full_mg,
Simon Marlow's avatar
Simon Marlow committed
636
637
638
		  ms_mod_name ms `elem` stable_obj++stable_bco,
		  ms_mod_name ms `notElem` [ ms_mod_name ms' | 
						AcyclicSCC ms' <- partial_mg ] ]
639
640
641

	    mg = stable_mg ++ partial_mg

642
643
	-- clean up between compilations
	let cleanup = cleanTempFilesExcept dflags
644
			  (ppFilesFromSummaries (flattenSCCs mg2_with_srcimps))
645

646
647
	debugTraceMsg dflags 2 (hang (text "Ready for upsweep") 
				   2 (ppr mg))
648
649
        (upsweep_ok, hsc_env1, modsUpswept)
           <- upsweep (hsc_env { hsc_HPT = emptyHomePackageTable })
650
			   pruned_hpt stable_mods cleanup mg
651
652
653
654
655

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

656
        let modsDone = reverse modsUpswept
657
658
659
660
661
662
663
664

        -- 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.
665
           do debugTraceMsg dflags 2 (text "Upsweep completely successful.")
666
667
668
669
670
671
672
673
674
675
676
677
678

	      -- 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 
679
680
	 	main_mod = mainModIs dflags
		a_root_is_Main = any ((==main_mod).ms_mod) mod_graph
681
682
		do_linking = a_root_is_Main || no_hs_main

683
684
685
686
687
688
689
	      when (ghcLink dflags == LinkBinary 
                    && isJust ofile && not do_linking) $
	        debugTraceMsg dflags 1 $
                    text ("Warning: output was redirected with -o, " ++
                          "but no output will be generated\n" ++
			  "because there is no " ++ 
                          moduleNameString (moduleName main_mod) ++ " module.")
690
691

	      -- link everything together
692
              linkresult <- link (ghcLink dflags) dflags do_linking (hsc_HPT hsc_env1)
693

694
	      loadFinish Succeeded linkresult ref hsc_env1
695
696
697
698
699

         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.
700
           do debugTraceMsg dflags 2 (text "Upsweep partially successful.")
701
702
703
704
705
706
707
708
709
710

              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
711
              let hpt4 = retainInTopLevelEnvs (map ms_mod_name mods_to_keep) 
712
					      (hsc_HPT hsc_env1)
713
714
715
716

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

717
718
	      -- there should be no Nothings where linkables should be, now
	      ASSERT(all (isJust.hm_linkable) 
Simon Marlow's avatar
Simon Marlow committed
719
			(eltsUFM (hsc_HPT hsc_env))) do
720
	
721
	      -- Link everything together
722
              linkresult <- link (ghcLink dflags) dflags False hpt4
723

724
	      let hsc_env4 = hsc_env1{ hsc_HPT = hpt4 }
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
	      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

741

742
743
744
745
746
747
748
749
750
751
-- 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.
752
ppFilesFromSummaries summaries = map ms_hspp_file summaries
753

754
755
756
757
758
-- -----------------------------------------------------------------------------
-- Check module

data CheckedModule = 
  CheckedModule { parsedSource      :: ParsedSource,
759
		  renamedSource     :: Maybe RenamedSource,
760
761
762
		  typecheckedSource :: Maybe TypecheckedSource,
		  checkedModuleInfo :: Maybe ModuleInfo
	        }
763
764
765
766
767
	-- 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.
768

769
type ParsedSource      = Located (HsModule RdrName)
770
771
type RenamedSource     = (HsGroup Name, [LImportDecl Name], Maybe [LIE Name],
                          Maybe (HsDoc Name), HaddockModInfo Name)
772
773
type TypecheckedSource = LHsBinds Id

774
775
776
777
778
779
780
781
782
783
784
785
786
-- 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


787
788
789
790
-- | 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
791
checkModule :: Session -> ModuleName -> IO (Maybe CheckedModule)
792
checkModule session@(Session ref) mod = do
793
	-- load up the dependencies first
794
   r <- load session (LoadDependenciesOf mod)
795
796
797
798
799
   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
800
   case [ ms | ms <- mg, ms_mod_name ms == mod ] of
801
802
	[] -> return Nothing
	(ms:_) -> do 
803
	   mbChecked <- hscFileCheck hsc_env{hsc_dflags=ms_hspp_opts ms} ms
804
805
806
	   case mbChecked of
             Nothing -> return Nothing
             Just (HscChecked parsed renamed Nothing) ->
807
808
809
810
811
		   return (Just (CheckedModule {
					parsedSource = parsed,
					renamedSource = renamed,
					typecheckedSource = Nothing,
					checkedModuleInfo = Nothing }))
812
813
             Just (HscChecked parsed renamed
			   (Just (tc_binds, rdr_env, details))) -> do
814
		   let minf = ModuleInfo {
815
				minf_type_env  = md_types details,
816
817
				minf_exports   = availsToNameSet $
                                                     md_exports details,
818
819
				minf_rdr_env   = Just rdr_env,
				minf_instances = md_insts details
mnislaih's avatar
mnislaih committed
820
#ifdef GHCI
821
                               ,minf_modBreaks = emptyModBreaks 
mnislaih's avatar
mnislaih committed
822
#endif
823
824
825
			      }
		   return (Just (CheckedModule {
					parsedSource = parsed,
826
					renamedSource = renamed,
827
828
829
830
					typecheckedSource = Just tc_binds,
					checkedModuleInfo = Just minf }))

-- ---------------------------------------------------------------------------
831
832
833
834
-- Unloading

unload :: HscEnv -> [Linkable] -> IO ()
unload hsc_env stable_linkables	-- Unload everthing *except* 'stable_linkables'
835
  = case ghcLink (hsc_dflags hsc_env) of
836
#ifdef GHCI
837
	LinkInMemory -> Linker.unload (hsc_dflags hsc_env) stable_linkables
838
#else
839
	LinkInMemory -> panic "unload: no interpreter"
840
#endif
841
	other -> return ()
842

843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
-- -----------------------------------------------------------------------------
-- 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.

  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:

876
    - if a module is stable, then:
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
	- 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
895
896
897
	-> [ModuleName]			-- all home modules
	-> ([ModuleName],		-- stableObject
	    [ModuleName])		-- stableBCO
898
899
900
901
902
903
904
905
906

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
907
	scc_mods = map ms_mod_name scc
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
	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
929
	     same_as_prev t = case lookupUFM hpt (ms_mod_name ms) of
930
931
				Just hmi  | Just l <- hm_linkable hmi
				 -> isObjectLinkable l && t == linkableTime l
932
				_other  -> True
933
		-- why '>=' rather than '>' above?  If the filesystem stores
934
935
936
937
938
939
		-- 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.

940
	bco_ok ms
Simon Marlow's avatar
Simon Marlow committed
941
	  = case lookupUFM hpt (ms_mod_name ms) of
942
943
944
		Just hmi  | Just l <- hm_linkable hmi ->
			not (isObjectLinkable l) && 
			linkableTime l >= ms_hs_date ms
945
		_other  -> False
946

Simon Marlow's avatar
Simon Marlow committed
947
ms_allimps :: ModSummary -> [ModuleName]
948
ms_allimps ms = map unLoc (ms_srcimps ms ++ ms_imps ms)
949

950
951
-- -----------------------------------------------------------------------------
-- Prune the HomePackageTable
952

953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
-- 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
968
   -> ([ModuleName],[ModuleName])
969
970
971
   -> HomePackageTable

pruneHomePackageTable hpt summ (stable_obj, stable_bco)
Simon Marlow's avatar
Simon Marlow committed
972
  = mapUFM prune hpt
973
974
975
976
  where prune hmi
	  | is_stable modl = hmi'
	  | otherwise      = hmi'{ hm_details = emptyModDetails }
	  where
Simon Marlow's avatar
Simon Marlow committed
977
	   modl = moduleName (mi_module (hm_iface hmi))
978
979
980
981
	   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
982
		where ms = expectJust "prune" (lookupUFM ms_map modl)
983

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

986
987
988
	is_stable m = m `elem` stable_obj || m `elem` stable_bco

-- -----------------------------------------------------------------------------
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009

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

1010
1011
1012
1013
1014
-- -----------------------------------------------------------------------------
-- 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.
1015
1016

-- There better had not be any cyclic groups here -- we check for them.
1017
1018
1019
1020

upsweep
    :: HscEnv			-- Includes initially-empty HPT
    -> HomePackageTable		-- HPT from last time round (pruned)
Simon Marlow's avatar
Simon Marlow committed
1021
    -> ([ModuleName],[ModuleName]) -- stable modules (see checkStability)
1022
1023
1024
1025
1026
1027
    -> 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

1028
1029
upsweep hsc_env old_hpt stable_mods cleanup mods
   = upsweep' hsc_env old_hpt stable_mods cleanup mods 1 (length mods)
1030

1031
upsweep' hsc_env old_hpt stable_mods cleanup
1032
     [] _ _
1033
1034
   = return (Succeeded, hsc_env, [])

1035
upsweep' hsc_env old_hpt stable_mods cleanup
1036
     (CyclicSCC ms:_) _ _
1037
   = do fatalErrorMsg (hsc_dflags hsc_env) (cyclicModuleErr ms)
1038
1039
        return (Failed, hsc_env, [])

1040
upsweep' hsc_env old_hpt stable_mods cleanup
1041
     (AcyclicSCC mod:mods) mod_index nmods
1042
1043
1044
1045
   = do -- putStrLn ("UPSWEEP_MOD: hpt = " ++ 
	--	     show (map (moduleUserString.moduleName.mi_module.hm_iface) 
	--		       (moduleEnvElts (hsc_HPT hsc_env)))

1046
        mb_mod_info <- upsweep_mod hsc_env old_hpt stable_mods mod 
1047
                       mod_index nmods
1048
1049
1050
1051
1052
1053

	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
1054
		{ let this_mod = ms_mod_name mod
1055
1056

			-- Add new info to hsc_env
Simon Marlow's avatar
Simon Marlow committed
1057
		      hpt1     = addToUFM (hsc_HPT hsc_env) this_mod mod_info
1058
		      hsc_env1 = hsc_env { hsc_HPT = hpt1 }
1059
1060
1061
1062

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

1069
		; (restOK, hsc_env2, modOKs) 
1070
			<- upsweep' hsc_env1 old_hpt1 stable_mods cleanup 
1071
				mods (mod_index+1) nmods
1072
1073
		; return (restOK, hsc_env2, mod:modOKs)
		}
1074
1075
1076
1077
1078


-- Compile a single module.  Always produce a Linkable for it if 
-- successful.  If no compilation happened, return the old Linkable.
upsweep_mod :: HscEnv
1079
            -> HomePackageTable
Simon Marlow's avatar
Simon Marlow committed
1080
	    -> ([ModuleName],[ModuleName])
1081
            -> ModSummary
1082
1083
            -> Int  -- index of module
            -> Int  -- total number of modules
1084
1085
            -> IO (Maybe HomeModInfo)	-- Nothing => Failed

1086
upsweep_mod hsc_env old_hpt (stable_obj, stable_bco) summary mod_index nmods
1087
1088
   =    let 
       	    this_mod_name = ms_mod_name summary
1089
1090
1091
1092
1093
	    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

1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
	    is_stable_obj = this_mod_name `elem` stable_obj
	    is_stable_bco = this_mod_name `elem` stable_bco

	    old_hmi = lookupUFM old_hpt this_mod_name

            -- We're using the dflags for this module now, obtained by
            -- applying any options in its LANGUAGE & OPTIONS_GHC pragmas.
            dflags = ms_hspp_opts summary
            prevailing_target = hscTarget (hsc_dflags hsc_env)
            local_target      = hscTarget dflags

            -- If OPTIONS_GHC contains -fasm or -fvia-C, be careful that
            -- we don't do anything dodgy: these should only work to change
            -- from -fvia-C to -fasm and vice-versa, otherwise we could 
            -- end up trying to link object code to byte code.
            target = if prevailing_target /= local_target
                        && (not (isObjectTarget prevailing_target)
                            || not (isObjectTarget local_target))
                        then prevailing_target
                        else local_target 

            -- store the corrected hscTarget into the summary
            summary' = summary{ ms_hspp_opts = dflags { hscTarget = target } }

	    -- The old interface is ok if
	    --	a) we're compiling a source file, and the old HPT
	    --	   entry is for a source file
	    --	b) we're compiling a hs-boot file
	    -- Case (b) allows an hs-boot file to get the interface of its
	    -- real source file on the second iteration of the compilation
	    -- manager, but that does no harm.  Otherwise the hs-boot file
	    -- will always be recompiled
            
            mb_old_iface 
	    	= case old_hmi of
	    	     Nothing	 			  -> Nothing
	    	     Just hm_info | isBootSummary summary -> Just iface
	    			  | not (mi_boot iface)   -> Just iface
	    			  | otherwise		  -> Nothing
	    			   where 
	    			     iface = hm_iface hm_info

1136
	    compile_it :: Maybe Linkable -> IO (Maybe HomeModInfo)
Simon Marlow's avatar
Simon Marlow committed
1137
	    compile_it  = upsweep_compile hsc_env old_hpt this_mod_name 
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
				summary' mod_index nmods mb_old_iface

            compile_it_discard_iface 
                        = upsweep_compile hsc_env old_hpt this_mod_name 
				summary' mod_index nmods Nothing

        in
	case target of

            _any
                -- Regardless of whether we're generating object code or
                -- byte code, we can always use an existing object file
                -- if it is *stable* (see checkStability).
		| is_stable_obj, isJust old_hmi ->
		        return old_hmi
1153
1154
1155
			-- object is stable, and we have an entry in the
			-- old HPT: nothing to do

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