GHC.hs 86.1 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
        BreakArray, setBreakOn, setBreakOff, getBreak,
91
        modInfoModBreaks, 
92
93
94
#endif

	-- * Abstract syntax elements
95

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

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

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

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

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

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

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

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

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

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

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

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

	-- ** Source locations
	SrcLoc, pprDefnLoc,
Simon Marlow's avatar
Simon Marlow committed
167
168
169
170
171
172
173
174
        mkSrcLoc, isGoodSrcLoc,
	srcLocFile, srcLocLine, srcLocCol,
        SrcSpan,
        mkSrcSpan, srcLocSpan,
        srcSpanStart, srcSpanEnd,
	srcSpanFile, 
        srcSpanStartLine, srcSpanEndLine, 
        srcSpanStartCol, srcSpanEndCol,
175

176
177
178
179
	-- * Exceptions
	GhcException(..), showGhcException,

	-- * Miscellaneous
180
181
	sessionHscEnv,
	cyclicModuleErr,
182
183
  ) where

184
185
186
{-
 ToDo:

187
  * inline bits of HscMain here to simplify layering: hscTcExpr, hscStmt.
188
189
190
191
192
193
  * what StaticFlags should we expose, if any?
-}

#include "HsVersions.h"

#ifdef GHCI
mnislaih's avatar
mnislaih committed
194
import RtClosureInspect ( cvObtainTerm, Term )
195
196
import TcRnDriver	( tcRnLookupRdrName, tcRnGetInfo,
			  tcRnLookupName, getModuleExports )
197
import VarEnv		( emptyTidyEnv )
198
import GHC.Exts         ( unsafeCoerce#, Ptr )
199
import Foreign.StablePtr( deRefStablePtr, StablePtr, newStablePtr, freeStablePtr )
200
import Foreign          ( poke )
mnislaih's avatar
mnislaih committed
201
import qualified Linker
202
import Linker           ( HValue )
mnislaih's avatar
mnislaih committed
203
204

import Data.Dynamic     ( Dynamic )
205

206
207
208
import ByteCodeInstr
import IdInfo
import HscMain          ( hscParseIdentifier, hscTcExpr, hscKcType, hscStmt )
209
import BreakArray
210
211
#endif

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

263
import Data.Array
264
265
import Control.Concurrent
import System.Directory ( getModificationTime, doesFileExist )
266
267
import Data.Maybe
import Data.List
268
import qualified Data.List as List
269
import Control.Monad
270
271
272
273
274
import System.Exit	( exitWith, ExitCode(..) )
import System.Time	( ClockTime )
import Control.Exception as Exception hiding (handle)
import Data.IORef
import System.IO
275
import System.IO.Error	( isDoesNotExistError )
276
import Prelude hiding (init)
277

278
279
280
281
282
283
#if __GLASGOW_HASKELL__ < 600
import System.IO as System.IO.Error ( try )
#else
import System.IO.Error	( try )
#endif

284
-- -----------------------------------------------------------------------------
285
-- Exception handlers
286
287
288
289
290

-- | 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.
291
292
defaultErrorHandler :: DynFlags -> IO a -> IO a
defaultErrorHandler dflags inner = 
293
294
295
296
297
  -- 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
298
299
		IOException _ ->
		  fatalErrorMsg dflags (text (show exception))
300
		AsyncException StackOverflow ->
301
302
303
		  fatalErrorMsg dflags (text "stack overflow: use +RTS -K<size> to increase it")
		_other ->
		  fatalErrorMsg dflags (text (show (Panic (show exception))))
304
305
306
	   exitWith (ExitFailure 1)
         ) $

307
308
  -- program errors: messages with locations attached.  Sometimes it is
  -- convenient to just throw these as exceptions.
309
  handleDyn (\dyn -> do printBagOfErrors dflags (unitBag dyn)
310
311
312
			exitWith (ExitFailure 1)) $

  -- error messages propagated as exceptions
313
314
315
316
317
  handleDyn (\dyn -> do
  		hFlush stdout
  		case dyn of
		     PhaseFailed _ code -> exitWith code
		     Interrupted -> exitWith (ExitFailure 1)
318
		     _ -> do fatalErrorMsg dflags (text (show (dyn :: GhcException)))
319
320
321
322
323
324
325
326
			     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.
327
328
defaultCleanupHandler :: DynFlags -> IO a -> IO a
defaultCleanupHandler dflags inner = 
329
    -- make sure we clean up after ourselves
330
331
    later (do cleanTempFiles dflags
              cleanTempDirs dflags
332
333
334
335
336
          )
          -- exceptions will be blocked while we clean the temporary files,
          -- so there shouldn't be any difficulty if we receive further
          -- signals.
    inner
337
338
339
340


-- | Starts a new session.  A session consists of a set of loaded
-- modules, a set of options (DynFlags), and an interactive context.
341
342
newSession :: Maybe FilePath -> IO Session
newSession mb_top_dir = do
343
344
  -- catch ^C
  main_thread <- myThreadId
345
  modifyMVar_ interruptTargetThread (return . (main_thread :))
346
347
348
349
  installSignalHandlers

  dflags0 <- initSysTools mb_top_dir defaultDynFlags
  dflags  <- initDynFlags dflags0
350
  env <- newHscEnv dflags
351
  ref <- newIORef env
352
353
354
355
356
357
358
359
360
361
362
363
  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
364
365
366
367
368
369

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

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

372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
-- | 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
389

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

407
-- -----------------------------------------------------------------------------
408
-- Targets
409
410
411
412
413
414

-- 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
415
-- the program\/library.  Unloading the current program is achieved by
416
-- setting the current set of targets to be empty, followed by load.
417
setTargets :: Session -> [Target] -> IO ()
418
setTargets s targets = modifySession s (\h -> h{ hsc_targets = targets })
419
420

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

424
-- | Add another target
425
426
427
addTarget :: Session -> Target -> IO ()
addTarget s target
  = modifySession s (\h -> h{ hsc_targets = target : hsc_targets h })
428

429
430
431
432
433
434
-- | 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 ]
435

436
437
438
439
440
441
442
443
444
-- 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
--
445
446
447
448
guessTarget :: String -> Maybe Phase -> IO Target
guessTarget file (Just phase)
   = return (Target (TargetFile file (Just phase)) Nothing)
guessTarget file Nothing
449
   | isHaskellSrcFilename file
450
   = return (Target (TargetFile file Nothing) Nothing)
451
452
   | otherwise
   = do exists <- doesFileExist hs_file
453
454
455
	if exists
	   then return (Target (TargetFile hs_file Nothing) Nothing)
	   else do
456
	exists <- doesFileExist lhs_file
457
458
459
	if exists
	   then return (Target (TargetFile lhs_file Nothing) Nothing)
	   else do
Simon Marlow's avatar
Simon Marlow committed
460
	return (Target (TargetModule (mkModuleName file)) Nothing)
461
     where 
462
463
	 hs_file  = file `joinFileExt` "hs"
	 lhs_file = file `joinFileExt` "lhs"
464

465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
-- -----------------------------------------------------------------------------
-- 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 }

490
491
492
493
494
495
-- -----------------------------------------------------------------------------
-- Parsing Haddock comments

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

496
497
-- -----------------------------------------------------------------------------
-- Loading the program
498

499
500
-- 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
501
depanal :: Session -> [ModuleName] -> Bool -> IO (Maybe ModuleGraph)
502
depanal (Session ref) excluded_mods allow_dup_roots = do
503
504
505
506
507
508
509
  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"
510
511
512
  debugTraceMsg dflags 2 (hcat [
	     text "Chasing modules from: ",
	     hcat (punctuate comma (map pprTarget targets))])
513

514
  r <- downsweep hsc_env old_graph excluded_mods allow_dup_roots
515
  case r of
516
    Just mod_graph -> writeIORef ref hsc_env{ hsc_mod_graph = mod_graph }
517
518
    _ -> return ()
  return r
519

520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
{-
-- | 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
538
539
   | LoadUpTo ModuleName
   | LoadDependenciesOf ModuleName
540
541
542
543

-- | 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.
544
load :: Session -> LoadHowMuch -> IO SuccessFlag
545
load s@(Session ref) how_much
546
   = do 
547
548
549
550
	-- 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.
551
	mb_graph <- depanal s [] False
552
553
554
	case mb_graph of	   
	   Just mod_graph -> load2 s how_much mod_graph 
	   Nothing        -> return Failed
555

556
load2 s@(Session ref) how_much mod_graph = do
557
        guessOutputFile s
558
559
560
561
562
563
564
565
566
	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
567
568
        let all_home_mods = [ms_mod_name s 
			    | s <- mod_graph, not (isBootSummary s)]
569
#ifdef DEBUG
570
	    bad_boot_mods = [s 	      | s <- mod_graph, isBootSummary s,
Simon Marlow's avatar
Simon Marlow committed
571
					not (ms_mod_name s `elem` all_home_mods)]
572
#endif
573
574
575
576
577
578
579
580
	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]
581
	    mg2_with_srcimps = topSortModuleGraph True mod_graph Nothing
582

583
584
585
586
587
	-- If we can determine that any of the {-# SOURCE #-} imports
	-- are definitely unnecessary, then emit a warning.
	warnUnnecessarySourceImports dflags mg2_with_srcimps

 	let
588
589
	    -- check the stability property for each module.
	    stable_mods@(stable_obj,stable_bco)
590
	        = checkStability hpt1 mg2_with_srcimps all_home_mods
591
592
593
594
595
596
597
598
599

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

600
601
	debugTraceMsg dflags 2 (text "Stable obj:" <+> ppr stable_obj $$
				text "Stable BCO:" <+> ppr stable_bco)
602
603

	-- Unload any modules which are going to be re-linked this time around.
604
605
	let stable_linkables = [ linkable
			       | m <- stable_obj++stable_bco,
Simon Marlow's avatar
Simon Marlow committed
606
				 Just hmi <- [lookupUFM pruned_hpt m],
607
				 Just linkable <- [hm_linkable hmi] ]
608
609
610
611
612
613
614
615
616
617
618
619
	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.

620
621
622
623
624
625
        -- 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.
626
        let full_mg :: [SCC ModSummary]
627
	    full_mg    = topSortModuleGraph False mod_graph Nothing
628
629
630

	    maybe_top_mod = case how_much of
				LoadUpTo m           -> Just m
631
			  	LoadDependenciesOf m -> Just m
632
633
			  	_		     -> Nothing

634
635
636
637
638
639
640
641
642
	    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
643
			    AcyclicSCC ms -> ms_mod_name ms == mod; _ -> False )
644
645
646
647
		  List.init partial_mg0
		| otherwise
		= partial_mg0
  
648
649
650
	    stable_mg = 
		[ AcyclicSCC ms
	        | AcyclicSCC ms <- full_mg,
Simon Marlow's avatar
Simon Marlow committed
651
652
653
		  ms_mod_name ms `elem` stable_obj++stable_bco,
		  ms_mod_name ms `notElem` [ ms_mod_name ms' | 
						AcyclicSCC ms' <- partial_mg ] ]
654
655
656

	    mg = stable_mg ++ partial_mg

657
658
	-- clean up between compilations
	let cleanup = cleanTempFilesExcept dflags
659
			  (ppFilesFromSummaries (flattenSCCs mg2_with_srcimps))
660

661
662
	debugTraceMsg dflags 2 (hang (text "Ready for upsweep") 
				   2 (ppr mg))
663
664
        (upsweep_ok, hsc_env1, modsUpswept)
           <- upsweep (hsc_env { hsc_HPT = emptyHomePackageTable })
665
			   pruned_hpt stable_mods cleanup mg
666
667
668
669
670

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

671
        let modsDone = reverse modsUpswept
672
673
674
675
676
677
678
679

        -- 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.
680
           do debugTraceMsg dflags 2 (text "Upsweep completely successful.")
681
682
683
684
685
686
687
688
689
690
691
692
693

	      -- 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 
694
695
	 	main_mod = mainModIs dflags
		a_root_is_Main = any ((==main_mod).ms_mod) mod_graph
696
697
		do_linking = a_root_is_Main || no_hs_main

698
699
700
701
702
703
704
	      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.")
705
706

	      -- link everything together
707
              linkresult <- link (ghcLink dflags) dflags do_linking (hsc_HPT hsc_env1)
708

709
	      loadFinish Succeeded linkresult ref hsc_env1
710
711
712
713
714

         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.
715
           do debugTraceMsg dflags 2 (text "Upsweep partially successful.")
716
717
718
719
720
721
722
723
724
725

              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
726
              let hpt4 = retainInTopLevelEnvs (map ms_mod_name mods_to_keep) 
727
					      (hsc_HPT hsc_env1)
728
729
730
731

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

732
733
	      -- there should be no Nothings where linkables should be, now
	      ASSERT(all (isJust.hm_linkable) 
Simon Marlow's avatar
Simon Marlow committed
734
			(eltsUFM (hsc_HPT hsc_env))) do
735
	
736
	      -- Link everything together
737
              linkresult <- link (ghcLink dflags) dflags False hpt4
738

739
	      let hsc_env4 = hsc_env1{ hsc_HPT = hpt4 }
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
	      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

756

757
758
759
760
761
762
763
764
765
766
-- 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.
767
ppFilesFromSummaries summaries = map ms_hspp_file summaries
768

769
770
771
772
773
-- -----------------------------------------------------------------------------
-- Check module

data CheckedModule = 
  CheckedModule { parsedSource      :: ParsedSource,
774
		  renamedSource     :: Maybe RenamedSource,
775
776
777
		  typecheckedSource :: Maybe TypecheckedSource,
		  checkedModuleInfo :: Maybe ModuleInfo
	        }
778
779
780
781
782
	-- 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.
783

784
type ParsedSource      = Located (HsModule RdrName)
785
786
type RenamedSource     = (HsGroup Name, [LImportDecl Name], Maybe [LIE Name],
                          Maybe (HsDoc Name), HaddockModInfo Name)
787
788
type TypecheckedSource = LHsBinds Id

789
790
791
792
793
794
795
796
797
798
799
800
801
-- 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


802
803
804
805
-- | 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
806
checkModule :: Session -> ModuleName -> IO (Maybe CheckedModule)
807
checkModule session@(Session ref) mod = do
808
	-- load up the dependencies first
809
   r <- load session (LoadDependenciesOf mod)
810
811
812
813
814
   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
815
   case [ ms | ms <- mg, ms_mod_name ms == mod ] of
816
817
	[] -> return Nothing
	(ms:_) -> do 
818
	   mbChecked <- hscFileCheck hsc_env{hsc_dflags=ms_hspp_opts ms} ms
819
820
821
	   case mbChecked of
             Nothing -> return Nothing
             Just (HscChecked parsed renamed Nothing) ->
822
823
824
825
826
		   return (Just (CheckedModule {
					parsedSource = parsed,
					renamedSource = renamed,
					typecheckedSource = Nothing,
					checkedModuleInfo = Nothing }))
827
828
             Just (HscChecked parsed renamed
			   (Just (tc_binds, rdr_env, details))) -> do
829
		   let minf = ModuleInfo {
830
				minf_type_env  = md_types details,
831
832
				minf_exports   = availsToNameSet $
                                                     md_exports details,
833
834
				minf_rdr_env   = Just rdr_env,
				minf_instances = md_insts details
mnislaih's avatar
mnislaih committed
835
#ifdef GHCI
836
                               ,minf_modBreaks = emptyModBreaks 
mnislaih's avatar
mnislaih committed
837
#endif
838
839
840
			      }
		   return (Just (CheckedModule {
					parsedSource = parsed,
841
					renamedSource = renamed,
842
843
844
845
					typecheckedSource = Just tc_binds,
					checkedModuleInfo = Just minf }))

-- ---------------------------------------------------------------------------
846
847
848
849
-- Unloading

unload :: HscEnv -> [Linkable] -> IO ()
unload hsc_env stable_linkables	-- Unload everthing *except* 'stable_linkables'
850
  = case ghcLink (hsc_dflags hsc_env) of
851
#ifdef GHCI
852
	LinkInMemory -> Linker.unload (hsc_dflags hsc_env) stable_linkables
853
#else
854
	LinkInMemory -> panic "unload: no interpreter"
855
#endif
856
	other -> return ()
857

858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
-- -----------------------------------------------------------------------------
-- 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:

891
    - if a module is stable, then:
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
	- 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
910
911
912
	-> [ModuleName]			-- all home modules
	-> ([ModuleName],		-- stableObject
	    [ModuleName])		-- stableBCO
913
914
915
916
917
918
919
920
921

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
922
	scc_mods = map ms_mod_name scc
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
	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
944
	     same_as_prev t = case lookupUFM hpt (ms_mod_name ms) of
945
946
				Just hmi  | Just l <- hm_linkable hmi
				 -> isObjectLinkable l && t == linkableTime l
947
				_other  -> True
948
		-- why '>=' rather than '>' above?  If the filesystem stores
949
950
951
952
953
954
		-- 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.

955
	bco_ok ms
Simon Marlow's avatar
Simon Marlow committed
956
	  = case lookupUFM hpt (ms_mod_name ms) of
957
958
959
		Just hmi  | Just l <- hm_linkable hmi ->
			not (isObjectLinkable l) && 
			linkableTime l >= ms_hs_date ms
960
		_other  -> False
961

Simon Marlow's avatar
Simon Marlow committed
962
ms_allimps :: ModSummary -> [ModuleName]
963
ms_allimps ms = map unLoc (ms_srcimps ms ++ ms_imps ms)
964

965
966
-- -----------------------------------------------------------------------------
-- Prune the HomePackageTable
967

968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
-- 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
983
   -> ([ModuleName],[ModuleName])
984
985
986
   -> HomePackageTable

pruneHomePackageTable hpt summ (stable_obj, stable_bco)
Simon Marlow's avatar
Simon Marlow committed
987
  = mapUFM prune hpt
988
989
990
991
  where prune hmi
	  | is_stable modl = hmi'
	  | otherwise      = hmi'{ hm_details = emptyModDetails }
	  where
Simon Marlow's avatar
Simon Marlow committed
992
	   modl = moduleName (mi_module (hm_iface hmi))
993
994
995
996
	   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
997
		where ms = expectJust "prune" (lookupUFM ms_map modl)
998

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

1001
1002
1003
	is_stable m = m `elem` stable_obj || m `elem` stable_bco

-- -----------------------------------------------------------------------------
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024

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

1025
1026
1027
1028
1029
-- -----------------------------------------------------------------------------
-- 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.
1030
1031

-- There better had not be any cyclic groups here -- we check for them.
1032
1033
1034
1035

upsweep
    :: HscEnv			-- Includes initially-empty HPT
    -> HomePackageTable		-- HPT from last time round (pruned)
Simon Marlow's avatar
Simon Marlow committed
1036
    -> ([ModuleName],[ModuleName]) -- stable modules (see checkStability)
1037
1038
1039
1040
1041
1042
    -> 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

1043
1044
upsweep hsc_env old_hpt stable_mods cleanup mods
   = upsweep' hsc_env old_hpt stable_mods cleanup mods 1 (length mods)
1045

1046
upsweep' hsc_env old_hpt stable_mods cleanup
1047
     [] _ _
1048
1049
   = return (Succeeded, hsc_env, [])

1050
upsweep' hsc_env old_hpt stable_mods cleanup
1051
     (CyclicSCC ms:_) _ _
1052
   = do fatalErrorMsg (hsc_dflags hsc_env) (cyclicModuleErr ms)
1053
1054
        return (Failed, hsc_env, [])

1055
upsweep' hsc_env old_hpt stable_mods cleanup
1056
     (AcyclicSCC mod:mods) mod_index nmods
1057
1058
1059
1060
   = do -- putStrLn ("UPSWEEP_MOD: hpt = " ++ 
	--	     show (map (moduleUserString.moduleName.mi_module.hm_iface) 
	--		       (moduleEnvElts (hsc_HPT hsc_env)))

1061
        mb_mod_info <- upsweep_mod hsc_env old_hpt stable_mods mod 
1062
                       mod_index nmods
1063
1064
1065
1066
1067
1068

	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
1069
		{ let this_mod = ms_mod_name mod
1070
1071

			-- Add new info to hsc_env
Simon Marlow's avatar
Simon Marlow committed
1072
		      hpt1     = addToUFM (hsc_HPT hsc_env) this_mod mod_info
1073
		      hsc_env1 = hsc_env { hsc_HPT = hpt1 }
1074
1075
1076
1077

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

1084
		; (restOK, hsc_env2, modOKs) 
1085
			<- upsweep' hsc_env1 old_hpt1 stable_mods cleanup 
1086
				mods (mod_index+1) nmods
1087
1088
		; return (restOK, hsc_env2, mod:modOKs)
		}
1089
1090
1091
1092
1093


-- Compile a single module.  Always produce a Linkable for it if 
-- successful.  If no compilation happened, return the old Linkable.
upsweep_mod :: HscEnv
1094
            -> HomePackageTable
Simon Marlow's avatar
Simon Marlow committed
1095
	    -> ([ModuleName],[ModuleName])
1096
            -> ModSummary
1097
1098
            -> Int  -- index of module
            -> Int  -- total number of modules
1099
1100
            -> IO (Maybe HomeModInfo)	-- Nothing => Failed

1101
upsweep_mod hsc_env old_hpt (stable_obj, stable_bco) summary mod_index nmods
1102
1103
   =    let 
       	    this_mod_name = ms_mod_name summary
1104
1105
1106
1107
1108
	    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

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
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
	    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