GhcMake.hs 86.7 KB
Newer Older
1
{-# LANGUAGE BangPatterns, CPP, NondecreasingIndentation, ScopedTypeVariables #-}
2
3
4
5
{-# OPTIONS_GHC -fno-warn-warnings-deprecations #-}
-- NB: we specifically ignore deprecations. GHC 7.6 marks the .QSem module as
-- deprecated, although it became un-deprecated later. As a result, using 7.6
-- as your bootstrap compiler throws annoying warnings.
6

Simon Marlow's avatar
Simon Marlow committed
7
8
9
10
-- -----------------------------------------------------------------------------
--
-- (c) The University of Glasgow, 2011
--
dterei's avatar
dterei committed
11
12
-- This module implements multi-module compilation, and is used
-- by --make and GHCi.
Simon Marlow's avatar
Simon Marlow committed
13
14
--
-- -----------------------------------------------------------------------------
15
16
module GhcMake(
        depanal,
dterei's avatar
dterei committed
17
        load, LoadHowMuch(..),
Simon Marlow's avatar
Simon Marlow committed
18

19
        topSortModuleGraph,
Simon Marlow's avatar
Simon Marlow committed
20

dterei's avatar
dterei committed
21
22
        noModError, cyclicModuleErr
    ) where
Simon Marlow's avatar
Simon Marlow committed
23
24
25
26

#include "HsVersions.h"

#ifdef GHCI
dterei's avatar
dterei committed
27
import qualified Linker         ( unload )
Simon Marlow's avatar
Simon Marlow committed
28
29
30
#endif

import DriverPhases
dterei's avatar
dterei committed
31
import DriverPipeline
Simon Marlow's avatar
Simon Marlow committed
32
import DynFlags
dterei's avatar
dterei committed
33
import ErrUtils
Simon Marlow's avatar
Simon Marlow committed
34
import Finder
dterei's avatar
dterei committed
35
import GhcMonad
Simon Marlow's avatar
Simon Marlow committed
36
import HeaderInfo
dterei's avatar
dterei committed
37
38
39
40
import HsSyn
import HscTypes
import Module
import RdrName          ( RdrName )
dterei's avatar
dterei committed
41
42
import TcIface          ( typecheckIface )
import TcRnMonad        ( initIfaceCheck )
Simon Marlow's avatar
Simon Marlow committed
43

dterei's avatar
dterei committed
44
import Bag              ( listToBag )
Simon Marlow's avatar
Simon Marlow committed
45
46
import BasicTypes
import Digraph
parcs's avatar
parcs committed
47
import Exception        ( tryIO, gbracket, gfinally )
Simon Marlow's avatar
Simon Marlow committed
48
import FastString
Icelandjack's avatar
Icelandjack committed
49
import Maybes           ( expectJust )
50
import Name
51
import MonadUtils       ( allM, MonadIO )
Simon Marlow's avatar
Simon Marlow committed
52
import Outputable
dterei's avatar
dterei committed
53
54
55
56
import Panic
import SrcLoc
import StringBuffer
import SysTools
Simon Marlow's avatar
Simon Marlow committed
57
import UniqFM
dterei's avatar
dterei committed
58
import Util
Simon Marlow's avatar
Simon Marlow committed
59

60
import Data.Either ( rights, partitionEithers )
Simon Marlow's avatar
Simon Marlow committed
61
import qualified Data.Map as Map
62
63
import Data.Map (Map)
import qualified Data.Set as Set
dterei's avatar
dterei committed
64
import qualified FiniteMap as Map ( insertListWith )
Simon Marlow's avatar
Simon Marlow committed
65

parcs's avatar
parcs committed
66
import Control.Concurrent ( forkIOWithUnmask, killThread )
67
import qualified GHC.Conc as CC
parcs's avatar
parcs committed
68
69
70
import Control.Concurrent.MVar
import Control.Concurrent.QSem
import Control.Exception
Simon Marlow's avatar
Simon Marlow committed
71
import Control.Monad
72
import Data.IORef
Simon Marlow's avatar
Simon Marlow committed
73
74
import Data.List
import qualified Data.List as List
dterei's avatar
dterei committed
75
import Data.Maybe
parcs's avatar
parcs committed
76
import Data.Ord ( comparing )
77
import Data.Time
dterei's avatar
dterei committed
78
79
80
81
import System.Directory
import System.FilePath
import System.IO        ( fixIO )
import System.IO.Error  ( isDoesNotExistError )
Simon Marlow's avatar
Simon Marlow committed
82

parcs's avatar
parcs committed
83
84
import GHC.Conc ( getNumProcessors, getNumCapabilities, setNumCapabilities )

85
86
87
88
89
label_self :: String -> IO ()
label_self thread_name = do
    self_tid <- CC.myThreadId
    CC.labelThread self_tid thread_name

Simon Marlow's avatar
Simon Marlow committed
90
91
92
93
94
95
96
97
98
99
100
-- -----------------------------------------------------------------------------
-- Loading the program

-- | Perform a dependency analysis starting from the current targets
-- and update the session with the new module graph.
--
-- Dependency analysis entails parsing the @import@ directives and may
-- therefore require running certain preprocessors.
--
-- Note that each 'ModSummary' in the module graph caches its 'DynFlags'.
-- These 'DynFlags' are determined by the /current/ session 'DynFlags' and the
thomie's avatar
thomie committed
101
-- @OPTIONS@ and @LANGUAGE@ pragmas of the parsed module.  Thus if you want
Simon Marlow's avatar
Simon Marlow committed
102
103
104
105
106
107
108
109
110
111
-- changes to the 'DynFlags' to take effect you need to call this function
-- again.
--
depanal :: GhcMonad m =>
           [ModuleName]  -- ^ excluded modules
        -> Bool          -- ^ allow duplicate roots
        -> m ModuleGraph
depanal excluded_mods allow_dup_roots = do
  hsc_env <- getSession
  let
dterei's avatar
dterei committed
112
113
114
         dflags  = hsc_dflags hsc_env
         targets = hsc_targets hsc_env
         old_graph = hsc_mod_graph hsc_env
115

Simon Marlow's avatar
Simon Marlow committed
116
117
  liftIO $ showPass dflags "Chasing dependencies"
  liftIO $ debugTraceMsg dflags 2 (hcat [
dterei's avatar
dterei committed
118
119
             text "Chasing modules from: ",
             hcat (punctuate comma (map pprTarget targets))])
Simon Marlow's avatar
Simon Marlow committed
120

121
122
  mod_graphE <- liftIO $ downsweep hsc_env old_graph excluded_mods allow_dup_roots
  mod_graph <- reportImportErrors mod_graphE
Simon Marlow's avatar
Simon Marlow committed
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
  modifySession $ \_ -> hsc_env { hsc_mod_graph = mod_graph }
  return mod_graph

-- | Describes which modules of the module graph need to be loaded.
data LoadHowMuch
   = LoadAllTargets
     -- ^ Load all targets and its dependencies.
   | LoadUpTo ModuleName
     -- ^ Load only the given module and its dependencies.
   | LoadDependenciesOf ModuleName
     -- ^ Load only the dependencies of the given module, but not the module
     -- itself.

-- | Try to load the program.  See 'LoadHowMuch' for the different modes.
--
-- This function implements the core of GHC's @--make@ mode.  It preprocesses,
-- compiles and loads the specified modules, avoiding re-compilation wherever
Ben Gamari's avatar
Ben Gamari committed
140
-- possible.  Depending on the target (see 'DynFlags.hscTarget') compiling
Simon Marlow's avatar
Simon Marlow committed
141
142
-- and loading may result in files being created on disk.
--
143
144
-- Calls the 'defaultWarnErrLogger' after each compiling each module, whether
-- successful or not.
Simon Marlow's avatar
Simon Marlow committed
145
146
147
--
-- Throw a 'SourceError' if errors are encountered before the actual
-- compilation starts (e.g., during dependency analysis).  All other errors
148
-- are reported using the 'defaultWarnErrLogger'.
Simon Marlow's avatar
Simon Marlow committed
149
150
151
--
load :: GhcMonad m => LoadHowMuch -> m SuccessFlag
load how_much = do
dterei's avatar
dterei committed
152
153
154
155
156
157
158
159
160
161
162
    mod_graph <- depanal [] False
    guessOutputFile
    hsc_env <- getSession

    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)
163
    let all_home_mods = [ms_mod_name s
dterei's avatar
dterei committed
164
165
166
167
168
169
170
171
172
173
174
175
176
                        | s <- mod_graph, not (isBootSummary s)]
        bad_boot_mods = [s        | s <- mod_graph, isBootSummary s,
                                    not (ms_mod_name s `elem` all_home_mods)]
    ASSERT( null bad_boot_mods ) return ()

    -- check that the module given in HowMuch actually exists, otherwise
    -- topSortModuleGraph will bomb later.
    let checkHowMuch (LoadUpTo m)           = checkMod m
        checkHowMuch (LoadDependenciesOf m) = checkMod m
        checkHowMuch _ = id

        checkMod m and_then
            | m `elem` all_home_mods = and_then
177
            | otherwise = do
dterei's avatar
dterei committed
178
179
180
181
182
183
                    liftIO $ errorMsg dflags (text "no such module:" <+>
                                     quotes (ppr m))
                    return Failed

    checkHowMuch how_much $ do

184
    -- mg2_with_srcimps drops the hi-boot nodes, returning a
dterei's avatar
dterei committed
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
    -- 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]
        mg2_with_srcimps = topSortModuleGraph True mod_graph Nothing

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

    let
        -- check the stability property for each module.
        stable_mods@(stable_obj,stable_bco)
            = checkStability hpt1 mg2_with_srcimps all_home_mods

        -- prune bits of the HPT which are definitely redundant now,
        -- to save space.
203
        pruned_hpt = pruneHomePackageTable hpt1
dterei's avatar
dterei committed
204
205
206
207
208
209
210
211
                            (flattenSCCs mg2_with_srcimps)
                            stable_mods

    _ <- liftIO $ evaluate pruned_hpt

    -- before we unload anything, make sure we don't leave an old
    -- interactive context around pointing to dead bindings.  Also,
    -- write the pruned HPT to allow the old HPT to be GC'd.
212
    setSession $ discardIC $ hsc_env { hsc_HPT = pruned_hpt }
dterei's avatar
dterei committed
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255

    liftIO $ debugTraceMsg dflags 2 (text "Stable obj:" <+> ppr stable_obj $$
                            text "Stable BCO:" <+> ppr stable_bco)

    -- Unload any modules which are going to be re-linked this time around.
    let stable_linkables = [ linkable
                           | m <- stable_obj++stable_bco,
                             Just hmi <- [lookupUFM pruned_hpt m],
                             Just linkable <- [hm_linkable hmi] ]
    liftIO $ 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.

    -- 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.
    let full_mg :: [SCC ModSummary]
        full_mg    = topSortModuleGraph False mod_graph Nothing

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

        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
256
            = ASSERT( case last partial_mg0 of
dterei's avatar
dterei committed
257
258
259
260
261
                        AcyclicSCC ms -> ms_mod_name ms == _mod; _ -> False )
              List.init partial_mg0
            | otherwise
            = partial_mg0

262
        stable_mg =
dterei's avatar
dterei committed
263
264
            [ AcyclicSCC ms
            | AcyclicSCC ms <- full_mg,
265
              ms_mod_name ms `elem` stable_obj++stable_bco ]
266

267
268
269
270
271
272
273
274
275
276
        -- the modules from partial_mg that are not also stable
        -- NB. also keep cycles, we need to emit an error message later
        unstable_mg = filter not_stable partial_mg
          where not_stable (CyclicSCC _) = True
                not_stable (AcyclicSCC ms)
                   = ms_mod_name ms `notElem` stable_obj++stable_bco

        -- Load all the stable modules first, before attempting to load
        -- an unstable module (#7231).
        mg = stable_mg ++ unstable_mg
dterei's avatar
dterei committed
277
278

    -- clean up between compilations
parcs's avatar
parcs committed
279
    let cleanup hsc_env = intermediateCleanTempFiles (hsc_dflags hsc_env)
dterei's avatar
dterei committed
280
281
282
283
284
285
                              (flattenSCCs mg2_with_srcimps)
                              hsc_env

    liftIO $ debugTraceMsg dflags 2 (hang (text "Ready for upsweep")
                               2 (ppr mg))

286
    n_jobs <- case parMakeCount dflags of
parcs's avatar
parcs committed
287
288
289
290
291
                    Nothing -> liftIO getNumProcessors
                    Just n  -> return n
    let upsweep_fn | n_jobs > 1 = parUpsweep n_jobs
                   | otherwise  = upsweep

dterei's avatar
dterei committed
292
293
    setSession hsc_env{ hsc_HPT = emptyHomePackageTable }
    (upsweep_ok, modsUpswept)
parcs's avatar
parcs committed
294
       <- upsweep_fn pruned_hpt stable_mods cleanup mg
dterei's avatar
dterei committed
295
296
297
298
299
300
301
302
303
304
305
306

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

    let modsDone = reverse modsUpswept

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

    if succeeded upsweep_ok

307
     then
dterei's avatar
dterei committed
308
309
310
311
312
313
314
315
316
317
318
319
320
321
       -- Easy; just relink it all.
       do liftIO $ debugTraceMsg dflags 2 (text "Upsweep completely successful.")

          -- Clean up after ourselves
          hsc_env1 <- getSession
          liftIO $ intermediateCleanTempFiles dflags modsDone hsc_env1

          -- 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
ian@well-typed.com's avatar
ian@well-typed.com committed
322
          let no_hs_main = gopt Opt_NoHsMain dflags
323
          let
dterei's avatar
dterei committed
324
325
            main_mod = mainModIs dflags
            a_root_is_Main = any ((==main_mod).ms_mod) mod_graph
326
            do_linking = a_root_is_Main || no_hs_main || ghcLink dflags == LinkDynLib || ghcLink dflags == LinkStaticLib
dterei's avatar
dterei committed
327
328
329
330

          -- link everything together
          linkresult <- liftIO $ link (ghcLink dflags) dflags do_linking (hsc_HPT hsc_env1)

331
332
333
334
335
336
337
338
339
340
341
          if ghcLink dflags == LinkBinary && isJust ofile && not do_linking
             then do
                liftIO $ errorMsg dflags $ text
                   ("output was redirected with -o, " ++
                    "but no output will be generated\n" ++
                    "because there is no " ++
                    moduleNameString (moduleName main_mod) ++ " module.")
                -- This should be an error, not a warning (#10895).
                loadFinish Failed linkresult
             else
                loadFinish Succeeded linkresult
dterei's avatar
dterei committed
342

343
     else
dterei's avatar
dterei committed
344
345
346
347
348
349
350
       -- 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.
       do liftIO $ debugTraceMsg dflags 2 (text "Upsweep partially successful.")

          let modsDone_names
                 = map ms_mod modsDone
351
352
          let mods_to_zap_names
                 = findPartiallyCompletedCycles modsDone_names
dterei's avatar
dterei committed
353
354
                      mg2_with_srcimps
          let mods_to_keep
355
                 = filter ((`notElem` mods_to_zap_names).ms_mod)
dterei's avatar
dterei committed
356
357
358
                      modsDone

          hsc_env1 <- getSession
359
          let hpt4 = retainInTopLevelEnvs (map ms_mod_name mods_to_keep)
dterei's avatar
dterei committed
360
361
362
363
364
365
                                          (hsc_HPT hsc_env1)

          -- Clean up after ourselves
          liftIO $ intermediateCleanTempFiles dflags mods_to_keep hsc_env1

          -- there should be no Nothings where linkables should be, now
366
          ASSERT(all (isJust.hm_linkable) (eltsUFM (hsc_HPT hsc_env))) do
367

dterei's avatar
dterei committed
368
369
          -- Link everything together
          linkresult <- liftIO $ link (ghcLink dflags) dflags False hpt4
Simon Marlow's avatar
Simon Marlow committed
370

dterei's avatar
dterei committed
371
372
          modifySession $ \hsc_env -> hsc_env{ hsc_HPT = hpt4 }
          loadFinish Failed linkresult
Simon Marlow's avatar
Simon Marlow committed
373
374


dterei's avatar
dterei committed
375
376
-- | Finish up after a load.
loadFinish :: GhcMonad m => SuccessFlag -> SuccessFlag -> m SuccessFlag
Simon Marlow's avatar
Simon Marlow committed
377
378
379
380
381
382
383
384
385
386
387

-- If the link failed, unload everything and return.
loadFinish _all_ok Failed
  = do hsc_env <- getSession
       liftIO $ unload hsc_env []
       modifySession discardProg
       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
388
  = do modifySession discardIC
Simon Marlow's avatar
Simon Marlow committed
389
390
391
       return all_ok


dterei's avatar
dterei committed
392
-- | Forget the current program, but retain the persistent info in HscEnv
Simon Marlow's avatar
Simon Marlow committed
393
394
discardProg :: HscEnv -> HscEnv
discardProg hsc_env
395
396
397
  = discardIC $ hsc_env { hsc_mod_graph = emptyMG
                        , hsc_HPT = emptyHomePackageTable }

398
399
400
-- | Discard the contents of the InteractiveContext, but keep the DynFlags.
-- It will also keep ic_int_print and ic_monad if their names are from
-- external packages.
401
402
discardIC :: HscEnv -> HscEnv
discardIC hsc_env
403
404
405
406
407
408
409
410
411
412
413
414
  = hsc_env { hsc_IC = new_ic { ic_int_print = keep_external_name ic_int_print
                              , ic_monad = keep_external_name ic_monad } }
  where
  dflags = ic_dflags old_ic
  old_ic = hsc_IC hsc_env
  new_ic = emptyInteractiveContext dflags
  keep_external_name ic_name
    | nameIsFromExternalPackage this_pkg old_name = old_name
    | otherwise = ic_name new_ic
    where
    this_pkg = thisPackage dflags
    old_name = ic_name old_ic
Simon Marlow's avatar
Simon Marlow committed
415

416
417
intermediateCleanTempFiles :: DynFlags -> [ModSummary] -> HscEnv -> IO ()
intermediateCleanTempFiles dflags summaries hsc_env
418
419
 = do notIntermediate <- readIORef (filesToNotIntermediateClean dflags)
      cleanTempFilesExcept dflags (notIntermediate ++ except)
420
421
422
423
424
425
426
427
428
429
430
431
  where
    except =
          -- Save preprocessed files. The preprocessed file *might* be
          -- the same as the source file, but that doesn't do any
          -- harm.
          map ms_hspp_file summaries ++
          -- Save object files for loaded modules.  The point of this
          -- is that we might have generated and compiled a stub C
          -- file, and in the case of GHCi the object file will be a
          -- temporary file which we must not remove because we need
          -- to load/link it later.
          hptObjs (hsc_HPT hsc_env)
Simon Marlow's avatar
Simon Marlow committed
432
433
434
435
436
437
438
439
440
441
442
443
444
445

-- | If there is no -o option, guess the name of target executable
-- by using top-level source file name as a base.
guessOutputFile :: GhcMonad m => m ()
guessOutputFile = modifySession $ \env ->
    let dflags = hsc_dflags env
        mod_graph = hsc_mod_graph env
        mainModuleSrcPath :: Maybe String
        mainModuleSrcPath = do
            let isMain = (== mainModIs dflags) . ms_mod
            [ms] <- return (filter isMain mod_graph)
            ml_hs_file (ms_location ms)
        name = fmap dropExtension mainModuleSrcPath

446
        name_exe = do
Simon Marlow's avatar
Simon Marlow committed
447
#if defined(mingw32_HOST_OS)
448
449
450
451
          -- we must add the .exe extention unconditionally here, otherwise
          -- when name has an extension of its own, the .exe extension will
          -- not be added by DriverPipeline.exeFileName.  See #2248
          name' <- fmap (<.> "exe") name
Simon Marlow's avatar
Simon Marlow committed
452
#else
453
          name' <- name
Simon Marlow's avatar
Simon Marlow committed
454
#endif
455
456
457
458
459
460
461
          mainModuleSrcPath' <- mainModuleSrcPath
          -- #9930: don't clobber input files (unless they ask for it)
          if name' == mainModuleSrcPath'
            then throwGhcException . UsageError $
                 "default output name would overwrite the input file; " ++
                 "must specify -o explicitly"
            else Just name'
Simon Marlow's avatar
Simon Marlow committed
462
463
464
465
466
467
    in
    case outputFile dflags of
        Just _ -> env
        Nothing -> env { hsc_dflags = dflags { outputFile = name_exe } }

-- -----------------------------------------------------------------------------
dterei's avatar
dterei committed
468
--
Simon Marlow's avatar
Simon Marlow committed
469
470
471
472
473
-- | Prune the HomePackageTable
--
-- Before doing an upsweep, we can throw away:
--
--   - For non-stable modules:
dterei's avatar
dterei committed
474
--      - all ModDetails, all linked code
Simon Marlow's avatar
Simon Marlow committed
475
476
477
478
479
480
481
--   - 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.
dterei's avatar
dterei committed
482
483
484
485
pruneHomePackageTable :: HomePackageTable
                      -> [ModSummary]
                      -> ([ModuleName],[ModuleName])
                      -> HomePackageTable
Simon Marlow's avatar
Simon Marlow committed
486
487
488
pruneHomePackageTable hpt summ (stable_obj, stable_bco)
  = mapUFM prune hpt
  where prune hmi
dterei's avatar
dterei committed
489
490
491
492
493
494
495
496
497
          | is_stable modl = hmi'
          | otherwise      = hmi'{ hm_details = emptyModDetails }
          where
           modl = moduleName (mi_module (hm_iface hmi))
           hmi' | Just l <- hm_linkable hmi, linkableTime l < ms_hs_date ms
                = hmi{ hm_linkable = Nothing }
                | otherwise
                = hmi
                where ms = expectJust "prune" (lookupUFM ms_map modl)
Simon Marlow's avatar
Simon Marlow committed
498
499
500

        ms_map = listToUFM [(ms_mod_name ms, ms) | ms <- summ]

dterei's avatar
dterei committed
501
        is_stable m = m `elem` stable_obj || m `elem` stable_bco
Simon Marlow's avatar
Simon Marlow committed
502
503

-- -----------------------------------------------------------------------------
dterei's avatar
dterei committed
504
505
506
--
-- | Return (names of) all those in modsDone who are part of a cycle as defined
-- by theGraph.
Simon Marlow's avatar
Simon Marlow committed
507
508
509
510
511
512
513
514
findPartiallyCompletedCycles :: [Module] -> [SCC ModSummary] -> [Module]
findPartiallyCompletedCycles modsDone theGraph
   = chew theGraph
     where
        chew [] = []
        chew ((AcyclicSCC _):rest) = chew rest    -- acyclic?  not interesting.
        chew ((CyclicSCC vs):rest)
           = let names_in_this_cycle = nub (map ms_mod vs)
515
516
                 mods_in_this_cycle
                    = nub ([done | done <- modsDone,
Simon Marlow's avatar
Simon Marlow committed
517
518
                                   done `elem` names_in_this_cycle])
                 chewed_rest = chew rest
519
             in
Simon Marlow's avatar
Simon Marlow committed
520
521
522
523
524
525
526
             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


-- ---------------------------------------------------------------------------
dterei's avatar
dterei committed
527
528
--
-- | Unloading
Simon Marlow's avatar
Simon Marlow committed
529
unload :: HscEnv -> [Linkable] -> IO ()
dterei's avatar
dterei committed
530
unload hsc_env stable_linkables -- Unload everthing *except* 'stable_linkables'
Simon Marlow's avatar
Simon Marlow committed
531
532
  = case ghcLink (hsc_dflags hsc_env) of
#ifdef GHCI
dterei's avatar
dterei committed
533
        LinkInMemory -> Linker.unload (hsc_dflags hsc_env) stable_linkables
Simon Marlow's avatar
Simon Marlow committed
534
#else
dterei's avatar
dterei committed
535
        LinkInMemory -> panic "unload: no interpreter"
Simon Marlow's avatar
Simon Marlow committed
536
537
538
                                -- urgh.  avoid warnings:
                                hsc_env stable_linkables
#endif
dterei's avatar
dterei committed
539
        _other -> return ()
Simon Marlow's avatar
Simon Marlow committed
540
541
542
543
544
545

-- -----------------------------------------------------------------------------
{- |

  Stability tells us which modules definitely do not need to be recompiled.
  There are two main reasons for having stability:
546

Simon Marlow's avatar
Simon Marlow committed
547
548
549
550
551
552
553
554
555
556
557
558
559
560
   - 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

561
  stableObject m =
dterei's avatar
dterei committed
562
563
564
        all stableObject (imports m)
        && old linkable does not exist, or is == on-disk .o
        && date(on-disk .o) > date(.hs)
Simon Marlow's avatar
Simon Marlow committed
565
566

  stableBCO m =
dterei's avatar
dterei committed
567
568
        all stable (imports m)
        && date(BCO) > date(.hs)
Simon Marlow's avatar
Simon Marlow committed
569
570
571
572
573
574
@

  These properties embody the following ideas:

    - if a module is stable, then:

dterei's avatar
dterei committed
575
576
        - if it has been compiled in a previous pass (present in HPT)
          then it does not need to be compiled or re-linked.
Simon Marlow's avatar
Simon Marlow committed
577
578

        - if it has not been compiled in a previous pass,
dterei's avatar
dterei committed
579
580
          then we only need to read its .hi file from disk and
          link it to produce a 'ModDetails'.
Simon Marlow's avatar
Simon Marlow committed
581
582
583
584
585
586
587
588
589
590

    - 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
dterei's avatar
dterei committed
591
592
593
594
595
        :: HomePackageTable   -- HPT from last compilation
        -> [SCC ModSummary]   -- current module graph (cyclic)
        -> [ModuleName]       -- all home modules
        -> ([ModuleName],     -- stableObject
            [ModuleName])     -- stableBCO
Simon Marlow's avatar
Simon Marlow committed
596
597
598
599
600
601
602
603

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
dterei's avatar
dterei committed
604
605
606
        scc = flattenSCC scc0
        scc_mods = map ms_mod_name scc
        home_module m   = m `elem` all_home_mods && m `notElem` scc_mods
Simon Marlow's avatar
Simon Marlow committed
607
608

        scc_allimps = nub (filter home_module (concatMap ms_home_allimps scc))
dterei's avatar
dterei committed
609
            -- all imports outside the current SCC, but in the home pkg
610

dterei's avatar
dterei committed
611
612
613
        stable_obj_imps = map (`elem` stable_obj) scc_allimps
        stable_bco_imps = map (`elem` stable_bco) scc_allimps

614
        stableObjects =
dterei's avatar
dterei committed
615
616
617
           and stable_obj_imps
           && all object_ok scc

618
        stableBCOs =
dterei's avatar
dterei committed
619
620
621
622
           and (zipWith (||) stable_obj_imps stable_bco_imps)
           && all bco_ok scc

        object_ok ms
ian@well-typed.com's avatar
ian@well-typed.com committed
623
          | gopt Opt_ForceRecomp (ms_hspp_opts ms) = False
624
          | Just t <- ms_obj_date ms  =  t >= ms_hs_date ms
dterei's avatar
dterei committed
625
626
627
628
629
630
631
632
633
                                         && same_as_prev t
          | otherwise = False
          where
             same_as_prev t = case lookupUFM hpt (ms_mod_name ms) of
                                Just hmi  | Just l <- hm_linkable hmi
                                 -> isObjectLinkable l && t == linkableTime l
                                _other  -> True
                -- why '>=' rather than '>' above?  If the filesystem stores
                -- times to the nearset second, we may occasionally find that
634
                -- the object & source have the same modification time,
dterei's avatar
dterei committed
635
636
637
                -- especially if the source was automatically generated
                -- and compiled.  Using >= is slightly unsafe, but it matches
                -- make's behaviour.
Simon Marlow's avatar
comment    
Simon Marlow committed
638
639
640
                --
                -- But see #5527, where someone ran into this and it caused
                -- a problem.
Simon Marlow's avatar
Simon Marlow committed
641

dterei's avatar
dterei committed
642
        bco_ok ms
ian@well-typed.com's avatar
ian@well-typed.com committed
643
          | gopt Opt_ForceRecomp (ms_hspp_opts ms) = False
644
          | otherwise = case lookupUFM hpt (ms_mod_name ms) of
dterei's avatar
dterei committed
645
                Just hmi  | Just l <- hm_linkable hmi ->
646
                        not (isObjectLinkable l) &&
dterei's avatar
dterei committed
647
648
                        linkableTime l >= ms_hs_date ms
                _other  -> False
Simon Marlow's avatar
Simon Marlow committed
649

parcs's avatar
parcs committed
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
{- Parallel Upsweep
 -
 - The parallel upsweep attempts to concurrently compile the modules in the
 - compilation graph using multiple Haskell threads.
 -
 - The Algorithm
 -
 - A Haskell thread is spawned for each module in the module graph, waiting for
 - its direct dependencies to finish building before it itself begins to build.
 -
 - Each module is associated with an initially empty MVar that stores the
 - result of that particular module's compile. If the compile succeeded, then
 - the HscEnv (synchronized by an MVar) is updated with the fresh HMI of that
 - module, and the module's HMI is deleted from the old HPT (synchronized by an
 - IORef) to save space.
 -
 - Instead of immediately outputting messages to the standard handles, all
 - compilation output is deferred to a per-module TQueue. A QSem is used to
 - limit the number of workers that are compiling simultaneously.
 -
 - Meanwhile, the main thread sequentially loops over all the modules in the
 - module graph, outputting the messages stored in each module's TQueue.
-}

-- | Each module is given a unique 'LogQueue' to redirect compilation messages
-- to. A 'Nothing' value contains the result of compilation, and denotes the
-- end of the message queue.
data LogQueue = LogQueue !(IORef [Maybe (Severity, SrcSpan, PprStyle, MsgDoc)])
                         !(MVar ())

-- | The graph of modules to compile and their corresponding result 'MVar' and
-- 'LogQueue'.
type CompilationGraph = [(ModSummary, MVar SuccessFlag, LogQueue)]

-- | Build a 'CompilationGraph' out of a list of strongly-connected modules,
-- also returning the first, if any, encountered module cycle.
buildCompGraph :: [SCC ModSummary] -> IO (CompilationGraph, Maybe [ModSummary])
buildCompGraph [] = return ([], Nothing)
buildCompGraph (scc:sccs) = case scc of
    AcyclicSCC ms -> do
        mvar <- newEmptyMVar
        log_queue <- do
            ref <- newIORef []
            sem <- newEmptyMVar
            return (LogQueue ref sem)
        (rest,cycle) <- buildCompGraph sccs
        return ((ms,mvar,log_queue):rest, cycle)
    CyclicSCC mss -> return ([], Just mss)

699
-- A Module and whether it is a boot module.
700
701
702
703
704
705
706
707
708
709
710
711
712
type BuildModule = (Module, IsBoot)

-- | 'Bool' indicating if a module is a boot module or not.  We need to treat
-- boot modules specially when building compilation graphs, since they break
-- cycles.  Regular source files and signature files are treated equivalently.
data IsBoot = IsBoot | NotBoot
    deriving (Ord, Eq, Show, Read)

-- | Tests if an 'HscSource' is a boot file, primarily for constructing
-- elements of 'BuildModule'.
hscSourceToIsBoot :: HscSource -> IsBoot
hscSourceToIsBoot HsBootFile = IsBoot
hscSourceToIsBoot _ = NotBoot
713
714

mkBuildModule :: ModSummary -> BuildModule
715
mkBuildModule ms = (ms_mod ms, if isBootSummary ms then IsBoot else NotBoot)
716

parcs's avatar
parcs committed
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
-- | The entry point to the parallel upsweep.
--
-- See also the simpler, sequential 'upsweep'.
parUpsweep
    :: GhcMonad m
    => Int
    -- ^ The number of workers we wish to run in parallel
    -> HomePackageTable
    -> ([ModuleName],[ModuleName])
    -> (HscEnv -> IO ())
    -> [SCC ModSummary]
    -> m (SuccessFlag,
          [ModSummary])
parUpsweep n_jobs old_hpt stable_mods cleanup sccs = do
    hsc_env <- getSession
    let dflags = hsc_dflags hsc_env

    -- The bits of shared state we'll be using:

    -- The global HscEnv is updated with the module's HMI when a module
    -- successfully compiles.
    hsc_env_var <- liftIO $ newMVar hsc_env

    -- The old HPT is used for recompilation checking in upsweep_mod. When a
    -- module sucessfully gets compiled, its HMI is pruned from the old HPT.
    old_hpt_var <- liftIO $ newIORef old_hpt

    -- What we use to limit parallelism with.
    par_sem <- liftIO $ newQSem n_jobs


    let updNumCapabilities = liftIO $ do
            n_capabilities <- getNumCapabilities
            unless (n_capabilities /= 1) $ setNumCapabilities n_jobs
            return n_capabilities
    -- Reset the number of capabilities once the upsweep ends.
    let resetNumCapabilities orig_n = liftIO $ setNumCapabilities orig_n

    gbracket updNumCapabilities resetNumCapabilities $ \_ -> do

    -- Sync the global session with the latest HscEnv once the upsweep ends.
    let finallySyncSession io = io `gfinally` do
            hsc_env <- liftIO $ readMVar hsc_env_var
            setSession hsc_env

    finallySyncSession $ do

    -- Build the compilation graph out of the list of SCCs. Module cycles are
    -- handled at the very end, after some useful work gets done. Note that
    -- this list is topologically sorted (by virtue of 'sccs' being sorted so).
    (comp_graph,cycle) <- liftIO $ buildCompGraph sccs
    let comp_graph_w_idx = zip comp_graph [1..]

770
771
772
773
774
775
776
777
778
779
780
    -- The list of all loops in the compilation graph.
    -- NB: For convenience, the last module of each loop (aka the module that
    -- finishes the loop) is prepended to the beginning of the loop.
    let comp_graph_loops = go (map fstOf3 (reverse comp_graph))
          where
            go [] = []
            go (ms:mss) | Just loop <- getModLoop ms (ms:mss)
                        = map mkBuildModule (ms:loop) : go mss
                        | otherwise
                        = go mss

parcs's avatar
parcs committed
781
782
    -- Build a Map out of the compilation graph with which we can efficiently
    -- look up the result MVar associated with a particular home module.
783
784
785
786
787
    let home_mod_map :: Map BuildModule (MVar SuccessFlag, Int)
        home_mod_map =
            Map.fromList [ (mkBuildModule ms, (mvar, idx))
                         | ((ms,mvar,_),idx) <- comp_graph_w_idx ]

parcs's avatar
parcs committed
788

789
    liftIO $ label_self "main --make thread"
parcs's avatar
parcs committed
790
791
792
793
    -- For each module in the module graph, spawn a worker thread that will
    -- compile this module.
    let { spawnWorkers = forM comp_graph_w_idx $ \((mod,!mvar,!log_queue),!mod_idx) ->
            forkIOWithUnmask $ \unmask -> do
794
795
796
797
798
799
800
                liftIO $ label_self $ unwords
                    [ "worker --make thread"
                    , "for module"
                    , show (moduleNameString (ms_mod_name mod))
                    , "number"
                    , show mod_idx
                    ]
parcs's avatar
parcs committed
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
                -- Replace the default log_action with one that writes each
                -- message to the module's log_queue. The main thread will
                -- deal with synchronously printing these messages.
                --
                -- Use a local filesToClean var so that we can clean up
                -- intermediate files in a timely fashion (as soon as
                -- compilation for that module is finished) without having to
                -- worry about accidentally deleting a simultaneous compile's
                -- important files.
                lcl_files_to_clean <- newIORef []
                let lcl_dflags = dflags { log_action = parLogAction log_queue
                                        , filesToClean = lcl_files_to_clean }

                -- Unmask asynchronous exceptions and perform the thread-local
                -- work to compile the module (see parUpsweep_one).
                m_res <- try $ unmask $ prettyPrintGhcErrors lcl_dflags $
817
818
819
                        parUpsweep_one mod home_mod_map comp_graph_loops
                                       lcl_dflags cleanup
                                       par_sem hsc_env_var old_hpt_var
parcs's avatar
parcs committed
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
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
876
877
878
879
                                       stable_mods mod_idx (length sccs)

                res <- case m_res of
                    Right flag -> return flag
                    Left exc -> do
                        -- Don't print ThreadKilled exceptions: they are used
                        -- to kill the worker thread in the event of a user
                        -- interrupt, and the user doesn't have to be informed
                        -- about that.
                        when (fromException exc /= Just ThreadKilled)
                             (errorMsg lcl_dflags (text (show exc)))
                        return Failed

                -- Populate the result MVar.
                putMVar mvar res

                -- Write the end marker to the message queue, telling the main
                -- thread that it can stop waiting for messages from this
                -- particular compile.
                writeLogQueue log_queue Nothing

                -- Add the remaining files that weren't cleaned up to the
                -- global filesToClean ref, for cleanup later.
                files_kept <- readIORef (filesToClean lcl_dflags)
                addFilesToClean dflags files_kept


        -- Kill all the workers, masking interrupts (since killThread is
        -- interruptible). XXX: This is not ideal.
        ; killWorkers = uninterruptibleMask_ . mapM_ killThread }


    -- Spawn the workers, making sure to kill them later. Collect the results
    -- of each compile.
    results <- liftIO $ bracket spawnWorkers killWorkers $ \_ ->
        -- Loop over each module in the compilation graph in order, printing
        -- each message from its log_queue.
        forM comp_graph $ \(mod,mvar,log_queue) -> do
            printLogs dflags log_queue
            result <- readMVar mvar
            if succeeded result then return (Just mod) else return Nothing


    -- Collect and return the ModSummaries of all the successful compiles.
    -- NB: Reverse this list to maintain output parity with the sequential upsweep.
    let ok_results = reverse (catMaybes results)

    -- Handle any cycle in the original compilation graph and return the result
    -- of the upsweep.
    case cycle of
        Just mss -> do
            liftIO $ fatalErrorMsg dflags (cyclicModuleErr mss)
            return (Failed,ok_results)
        Nothing  -> do
            let success_flag = successIf (all isJust results)
            return (success_flag,ok_results)

  where
    writeLogQueue :: LogQueue -> Maybe (Severity,SrcSpan,PprStyle,MsgDoc) -> IO ()
    writeLogQueue (LogQueue ref sem) msg = do
880
        atomicModifyIORef' ref $ \msgs -> (msg:msgs,())
parcs's avatar
parcs committed
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
        _ <- tryPutMVar sem ()
        return ()

    -- The log_action callback that is used to synchronize messages from a
    -- worker thread.
    parLogAction :: LogQueue -> LogAction
    parLogAction log_queue _dflags !severity !srcSpan !style !msg = do
        writeLogQueue log_queue (Just (severity,srcSpan,style,msg))

    -- Print each message from the log_queue using the log_action from the
    -- session's DynFlags.
    printLogs :: DynFlags -> LogQueue -> IO ()
    printLogs !dflags (LogQueue ref sem) = read_msgs
      where read_msgs = do
                takeMVar sem
896
                msgs <- atomicModifyIORef' ref $ \xs -> ([], reverse xs)
parcs's avatar
parcs committed
897
898
899
900
901
902
903
904
905
906
907
908
909
910
                print_loop msgs

            print_loop [] = read_msgs
            print_loop (x:xs) = case x of
                Just (severity,srcSpan,style,msg) -> do
                    log_action dflags dflags severity srcSpan style msg
                    print_loop xs
                -- Exit the loop once we encounter the end marker.
                Nothing -> return ()

-- The interruptible subset of the worker threads' work.
parUpsweep_one
    :: ModSummary
    -- ^ The module we wish to compile
911
    -> Map BuildModule (MVar SuccessFlag, Int)
parcs's avatar
parcs committed
912
    -- ^ The map of home modules and their result MVar
913
914
    -> [[BuildModule]]
    -- ^ The list of all module loops within the compilation graph.
parcs's avatar
parcs committed
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
    -> DynFlags
    -- ^ The thread-local DynFlags
    -> (HscEnv -> IO ())
    -- ^ The callback for cleaning up intermediate files
    -> QSem
    -- ^ The semaphore for limiting the number of simultaneous compiles
    -> MVar HscEnv
    -- ^ The MVar that synchronizes updates to the global HscEnv
    -> IORef HomePackageTable
    -- ^ The old HPT
    -> ([ModuleName],[ModuleName])
    -- ^ Lists of stable objects and BCOs
    -> Int
    -- ^ The index of this module
    -> Int
    -- ^ The total number of modules
    -> IO SuccessFlag
    -- ^ The result of this compile
933
934
935
936
937
parUpsweep_one mod home_mod_map comp_graph_loops lcl_dflags cleanup par_sem
               hsc_env_var old_hpt_var stable_mods mod_index num_mods = do

    let this_build_mod = mkBuildModule mod

parcs's avatar
parcs committed
938
    let home_imps     = map unLoc $ ms_home_imps mod
939
940
941
942
    let home_src_imps = map unLoc $ ms_home_srcimps mod

    -- All the textual imports of this module.
    let textual_deps = Set.fromList $ mapFst (mkModule (thisPackage lcl_dflags)) $
943
944
                            zip home_imps     (repeat NotBoot) ++
                            zip home_src_imps (repeat IsBoot)
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011

    -- Dealing with module loops
    -- ~~~~~~~~~~~~~~~~~~~~~~~~~
    --
    -- Not only do we have to deal with explicit textual dependencies, we also
    -- have to deal with implicit dependencies introduced by import cycles that
    -- are broken by an hs-boot file. We have to ensure that:
    --
    -- 1. A module that breaks a loop must depend on all the modules in the
    --    loop (transitively or otherwise). This is normally always fulfilled
    --    by the module's textual dependencies except in degenerate loops,
    --    e.g.:
    --
    --    A.hs imports B.hs-boot
    --    B.hs doesn't import A.hs
    --    C.hs imports A.hs, B.hs
    --
    --    In this scenario, getModLoop will detect the module loop [A,B] but
    --    the loop finisher B doesn't depend on A. So we have to explicitly add
    --    A in as a dependency of B when we are compiling B.
    --
    -- 2. A module that depends on a module in an external loop can't proceed
    --    until the entire loop is re-typechecked.
    --
    -- These two invariants have to be maintained to correctly build a
    -- compilation graph with one or more loops.


    -- The loop that this module will finish. After this module successfully
    -- compiles, this loop is going to get re-typechecked.
    let finish_loop = listToMaybe
            [ tail loop | loop <- comp_graph_loops
                        , head loop == this_build_mod ]

    -- If this module finishes a loop then it must depend on all the other
    -- modules in that loop because the entire module loop is going to be
    -- re-typechecked once this module gets compiled. These extra dependencies
    -- are this module's "internal" loop dependencies, because this module is
    -- inside the loop in question.
    let int_loop_deps = Set.fromList $
            case finish_loop of
                Nothing   -> []
                Just loop -> filter (/= this_build_mod) loop

    -- If this module depends on a module within a loop then it must wait for
    -- that loop to get re-typechecked, i.e. it must wait on the module that
    -- finishes that loop. These extra dependencies are this module's
    -- "external" loop dependencies, because this module is outside of the
    -- loop(s) in question.
    let ext_loop_deps = Set.fromList
            [ head loop | loop <- comp_graph_loops
                        , any (`Set.member` textual_deps) loop
                        , this_build_mod `notElem` loop ]


    let all_deps = foldl1 Set.union [textual_deps, int_loop_deps, ext_loop_deps]

    -- All of the module's home-module dependencies.
    let home_deps_with_idx =
            [ home_dep | dep <- Set.toList all_deps
                       , Just home_dep <- [Map.lookup dep home_mod_map] ]

    -- Sort the list of dependencies in reverse-topological order. This way, by
    -- the time we get woken up by the result of an earlier dependency,
    -- subsequent dependencies are more likely to have finished. This step
    -- effectively reduces the number of MVars that each thread blocks on.
    let home_deps = map fst $ sortBy (flip (comparing snd)) home_deps_with_idx
parcs's avatar
parcs committed
1012
1013

    -- Wait for the all the module's dependencies to finish building.
1014
    deps_ok <- allM (fmap succeeded . readMVar) home_deps
parcs's avatar
parcs committed
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047

    -- We can't build this module if any of its dependencies failed to build.
    if not deps_ok
      then return Failed
      else do
        -- Any hsc_env at this point is OK to use since we only really require
        -- that the HPT contains the HMIs of our dependencies.
        hsc_env <- readMVar hsc_env_var
        old_hpt <- readIORef old_hpt_var

        let logger err = printBagOfErrors lcl_dflags (srcErrorMessages err)

        -- Limit the number of parallel compiles.
        let withSem sem = bracket_ (waitQSem sem) (signalQSem sem)
        mb_mod_info <- withSem par_sem $
            handleSourceError (\err -> do logger err; return Nothing) $ do
                -- Have the ModSummary and HscEnv point to our local log_action
                -- and filesToClean var.
                let lcl_mod = localize_mod mod
                let lcl_hsc_env = localize_hsc_env hsc_env

                -- Compile the module.
                mod_info <- upsweep_mod lcl_hsc_env old_hpt stable_mods lcl_mod
                                        mod_index num_mods
                return (Just mod_info)

        case mb_mod_info of
            Nothing -> return Failed
            Just mod_info -> do
                let this_mod = ms_mod_name mod

                -- Prune the old HPT unless this is an hs-boot module.
                unless (isBootSummary mod) $
1048
                    atomicModifyIORef' old_hpt_var $ \old_hpt ->
parcs's avatar
parcs committed
1049
1050
                        (delFromUFM old_hpt this_mod, ())

1051
                -- Update and fetch the global HscEnv.
parcs's avatar
parcs committed
1052
1053
1054
                lcl_hsc_env' <- modifyMVar hsc_env_var $ \hsc_env -> do
                    let hsc_env' = hsc_env { hsc_HPT = addToUFM (hsc_HPT hsc_env)
                                                                this_mod mod_info }
1055
1056
1057
1058
                    -- If this module is a loop finisher, now is the time to
                    -- re-typecheck the loop.
                    hsc_env'' <- case finish_loop of
                        Nothing   -> return hsc_env'
1059
                        Just loop -> typecheckLoop lcl_dflags hsc_env' $
1060
                                     map (moduleName . fst) loop
parcs's avatar
parcs committed
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
                    return (hsc_env'', localize_hsc_env hsc_env'')

                -- Clean up any intermediate files.
                cleanup lcl_hsc_env'
                return Succeeded

  where
    localize_mod mod
        = mod { ms_hspp_opts = (ms_hspp_opts mod)
                 { log_action = log_action lcl_dflags
                 , filesToClean = filesToClean lcl_dflags } }

    localize_hsc_env hsc_env
        = hsc_env { hsc_dflags = (hsc_dflags hsc_env)
                     { log_action = log_action lcl_dflags
                     , filesToClean = filesToClean lcl_dflags } }

Simon Marlow's avatar
Simon Marlow committed
1078
-- -----------------------------------------------------------------------------
dterei's avatar
dterei committed
1079
--
Simon Marlow's avatar
Simon Marlow committed
1080
1081
1082
1083
1084
1085
1086
1087
-- | 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.
--
-- There better had not be any cyclic groups here -- we check for them.
upsweep
    :: GhcMonad m
dterei's avatar
dterei committed
1088
    => HomePackageTable            -- ^ HPT from last time round (pruned)
Simon Marlow's avatar
Simon Marlow committed
1089
    -> ([ModuleName],[ModuleName]) -- ^ stable modules (see checkStability)
1090
    -> (HscEnv -> IO ())           -- ^ How to clean up unwanted tmp files
dterei's avatar
dterei committed
1091
    -> [SCC ModSummary]            -- ^ Mods to do (the worklist)
Simon Marlow's avatar
Simon Marlow committed
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
    -> m (SuccessFlag,
          [ModSummary])
       -- ^ Returns:
       --
       --  1. A flag whether the complete upsweep was successful.
       --  2. The 'HscEnv' in the monad has an updated HPT
       --  3. A list of modules which succeeded loading.

upsweep old_hpt stable_mods cleanup sccs = do
   (res, done) <- upsweep' old_hpt [] sccs 1 (length sccs)
   return (res, reverse done)
 where

  upsweep' _old_hpt done
     [] _ _
   = return (Succeeded, done)

  upsweep' _old_hpt done
     (CyclicSCC ms:_) _ _
   = do dflags <- getSessionDynFlags
        liftIO $ fatalErrorMsg dflags (cyclicModuleErr ms)
        return (Failed, done)

  upsweep' old_hpt done
     (AcyclicSCC mod:mods) mod_index nmods
1117
1118
   = do -- putStrLn ("UPSWEEP_MOD: hpt = " ++
        --           show (map (moduleUserString.moduleName.mi_module.hm_iface)
dterei's avatar
dterei committed
1119
        --                     (moduleEnvElts (hsc_HPT hsc_env)))
Simon Marlow's avatar
Simon Marlow committed
1120
1121
1122
        let logger _mod = defaultWarnErrLogger

        hsc_env <- getSession
1123
1124
1125
1126

        -- Remove unwanted tmp files between compilations
        liftIO (cleanup hsc_env)

Simon Marlow's avatar
Simon Marlow committed
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
        mb_mod_info
            <- handleSourceError
                   (\err -> do logger mod (Just err); return Nothing) $ do
                 mod_info <- liftIO $ upsweep_mod hsc_env old_hpt stable_mods
                                                  mod mod_index nmods
                 logger mod Nothing -- log warnings
                 return (Just mod_info)

        case mb_mod_info of
          Nothing -> return (Failed, done)
          Just mod_info -> do
dterei's avatar
dterei committed
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
                let this_mod = ms_mod_name mod

                        -- Add new info to hsc_env
                    hpt1     = addToUFM (hsc_HPT hsc_env) this_mod mod_info
                    hsc_env1 = hsc_env { hsc_HPT = hpt1 }

                        -- Space-saving: delete the old HPT entry
                        -- for mod BUT if mod is a hs-boot
                        -- node, don't delete it.  For the
                        -- interface, the HPT entry is probaby for the
                        -- main Haskell source file.  Deleting it
                        -- would force the real module to be recompiled
Simon Marlow's avatar
Simon Marlow committed
1150
                        -- every time.
dterei's avatar
dterei committed
1151
1152
                    old_hpt1 | isBootSummary mod = old_hpt
                             | otherwise = delFromUFM old_hpt this_mod
Simon Marlow's avatar
Simon Marlow committed
1153
1154
1155
1156
1157
1158
1159
1160

                    done' = mod:done

                        -- fixup our HomePackageTable after we've finished compiling
                        -- a mutually-recursive loop.  See reTypecheckLoop, below.
                hsc_env2 <- liftIO $ reTypecheckLoop hsc_env1 mod done'
                setSession hsc_env2

dterei's avatar
dterei committed
1161
                upsweep' old_hpt1 done' mods (mod_index+1) nmods
Simon Marlow's avatar
Simon Marlow committed
1162

1163
1164
1165
1166
1167
1168
1169
1170
1171
maybeGetIfaceDate :: DynFlags -> ModLocation -> IO (Maybe UTCTime)
maybeGetIfaceDate dflags location
 | writeInterfaceOnlyMode dflags
    -- Minor optimization: it should be harmless to check the hi file location
    -- always, but it's better to avoid hitting the filesystem if possible.
    = modificationTimeIfExists (ml_hi_file location)
 | otherwise
    = return Nothing

Simon Marlow's avatar
Simon Marlow committed
1172
1173
1174
1175
-- | Compile a single module.  Always produce a Linkable for it if
-- successful.  If no compilation happened, return the old Linkable.
upsweep_mod :: HscEnv
            -> HomePackageTable
dterei's avatar
dterei committed
1176
            -> ([ModuleName],[ModuleName])
Simon Marlow's avatar
Simon Marlow committed
1177
1178
1179
1180
1181
            -> ModSummary
            -> Int  -- index of module
            -> Int  -- total number of modules
            -> IO HomeModInfo
upsweep_mod hsc_env old_hpt (stable_obj, stable_bco) summary mod_index nmods
1182
   =    let
dterei's avatar
dterei committed
1183
1184
1185
            this_mod_name = ms_mod_name summary
            this_mod    = ms_mod summary
            mb_obj_date = ms_obj_date summary
1186
            mb_if_date  = ms_iface_date summary
dterei's avatar
dterei committed
1187
1188
            obj_fn      = ml_obj_file (ms_location summary)
            hs_date     = ms_hs_date summary
Simon Marlow's avatar
Simon Marlow committed
1189

dterei's avatar
dterei committed
1190
1191
            is_stable_obj = this_mod_name `elem` stable_obj
            is_stable_bco = this_mod_name `elem` stable_bco
Simon Marlow's avatar
Simon Marlow committed
1192

dterei's avatar
dterei committed
1193
            old_hmi = lookupUFM old_hpt this_mod_name
Simon Marlow's avatar
Simon Marlow committed
1194
1195
1196
1197
1198
1199
1200

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

ian@well-typed.com's avatar
ian@well-typed.com committed
1201
            -- If OPTIONS_GHC contains -fasm or -fllvm, be careful that
Simon Marlow's avatar
Simon Marlow committed
1202
            -- we don't do anything dodgy: these should only work to change
ian@well-typed.com's avatar
ian@well-typed.com committed
1203
            -- from -fllvm to -fasm and vice-versa, otherwise we could
Simon Marlow's avatar
Simon Marlow committed
1204
1205
1206
1207
1208
            -- 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
1209
                        else local_target
Simon Marlow's avatar
Simon Marlow committed
1210
1211
1212
1213

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

dterei's avatar
dterei committed
1214
1215
1216
1217
1218
1219
1220
1221
            -- 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
1222
1223

            mb_old_iface
dterei's avatar
dterei committed
1224
1225
1226
1227
1228
                = case old_hmi of
                     Nothing                              -> Nothing
                     Just hm_info | isBootSummary summary -> Just iface
                                  | not (mi_boot iface)   -> Just iface
                                  | otherwise             -> Nothing
1229
                                   where
dterei's avatar
dterei committed
1230
                                     iface = hm_iface hm_info
Simon Marlow's avatar
Simon Marlow committed
1231

1232
1233
            compile_it :: Maybe Linkable -> SourceModified -> IO HomeModInfo
            compile_it  mb_linkable src_modified =
1234
1235
                  compileOne hsc_env summary' mod_index nmods
                             mb_old_iface mb_linkable src_modified
Simon Marlow's avatar
Simon Marlow committed
1236

1237
1238
1239
            compile_it_discard_iface :: Maybe Linkable -> SourceModified
                                     -> IO HomeModInfo
            compile_it_discard_iface mb_linkable  src_modified =
1240
1241
                  compileOne hsc_env summary' mod_index nmods
                             Nothing mb_linkable src_modified
Simon Marlow's avatar
Simon Marlow committed
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273

            -- With the HscNothing target we create empty linkables to avoid
            -- recompilation.  We have to detect these to recompile anyway if
            -- the target changed since the last compile.
            is_fake_linkable
               | Just hmi <- old_hmi, Just l <- hm_linkable hmi =
                  null (linkableUnlinked l)
               | otherwise =
                   -- we have no linkable, so it cannot be fake
                   False

            implies False _ = True
            implies True x  = x

        in
        case () of
         _
                -- 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, Just hmi <- old_hmi -> do
                liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
                           (text "skipping stable obj mod:" <+> ppr this_mod_name)
                return hmi
                -- object is stable, and we have an entry in the
                -- old HPT: nothing to do

          | is_stable_obj, isNothing old_hmi -> do
                liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
                           (text "compiling stable on-disk mod:" <+> ppr this_mod_name)
                linkable <- liftIO $ findObjectLinkable this_mod obj_fn
                              (expectJust "upsweep1" mb_obj_date)
1274
                compile_it (Just linkable) SourceUnmodifiedAndStable
Simon Marlow's avatar
Simon Marlow committed
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
                -- object is stable, but we need to load the interface
                -- off disk to make a HMI.

          | not (isObjectTarget target), is_stable_bco,
            (target /= HscNothing) `implies` not is_fake_linkable ->
                ASSERT(isJust old_hmi) -- must be in the old_hpt
                let Just hmi = old_hmi in do
                liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
                           (text "skipping stable BCO mod:" <+> ppr this_mod_name)
                return hmi
                -- BCO is stable: nothing to do

          | not (isObjectTarget target),
            Just hmi <- old_hmi,
            Just l <- hm_linkable hmi,
            not (isObjectLinkable l),
            (target /= HscNothing) `implies` not is_fake_linkable,
            linkableTime l >= ms_hs_date summary -> do
                liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
                           (text "compiling non-stable BCO mod:" <+> ppr this_mod_name)
1295
                compile_it (Just l) SourceUnmodified
Simon Marlow's avatar
Simon Marlow committed
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
                -- we have an old BCO that is up to date with respect
                -- to the source: do a recompilation check as normal.

          -- When generating object code, if there's an up-to-date
          -- object file on the disk, then we can use it.
          -- However, if the object file is new (compared to any
          -- linkable we had from a previous compilation), then we
          -- must discard any in-memory interface, because this
          -- means the user has compiled the source file
          -- separately and generated a new interface, that we must
          -- read from the disk.
          --
          | isObjectTarget target,
            Just obj_date <- mb_obj_date,
            obj_date >= hs_date -> do
                case old_hmi of
                  Just hmi
                    | Just l <- hm_linkable hmi,
                      isObjectLinkable l && linkableTime l == obj_date -> do
                          liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
                                     (text "compiling mod with new on-disk obj:" <+> ppr this_mod_name)
1317
                          compile_it (Just l) SourceUnmodified
Simon Marlow's avatar
Simon Marlow committed
1318
1319
1320
1321
                  _otherwise -> do
                          liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
                                     (text "compiling mod with new on-disk obj2:" <+> ppr this_mod_name)
                          linkable <- liftIO $ findObjectLinkable this_mod obj_fn obj_date
1322
                          compile_it_discard_iface (Just linkable) SourceUnmodified
Simon Marlow's avatar
Simon Marlow committed
1323

1324
1325
1326
1327
1328
1329
1330
1331
          -- See Note [Recompilation checking when typechecking only]
          | writeInterfaceOnlyMode dflags,
            Just if_date <- mb_if_date,
            if_date >= hs_date -> do
                liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
                           (text "skipping tc'd mod:" <+> ppr this_mod_name)
                compile_it Nothing SourceUnmodified

Simon Marlow's avatar
Simon Marlow committed
1332
1333
1334
         _otherwise -> do
                liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
                           (text "compiling mod:" <+> ppr this_mod_name)
1335
                compile_it Nothing SourceModified
Simon Marlow's avatar
Simon Marlow committed
1336

1337
1338
1339
1340
1341
1342
1343
-- Note [Recompilation checking when typechecking only]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- If we are compiling with -fno-code -fwrite-interface, there won't
-- be any object code that we can compare against, nor should there
-- be: we're *just* generating interface files.  In this case, we
-- want to check if the interface file is new, in lieu of the object
-- file.  See also Trac #9243.
Simon Marlow's avatar
Simon Marlow committed
1344
1345
1346
1347
1348
1349


-- Filter modules in the HPT
retainInTopLevelEnvs :: [ModuleName] -> HomePackageTable -> HomePackageTable
retainInTopLevelEnvs keep_these hpt
   = listToUFM   [ (mod, expectJust "retain" mb_mod_info)
dterei's avatar
dterei committed
1350
1351
1352
                 | mod <- keep_these
                 , let mb_mod_info = lookupUFM hpt mod
                 , isJust mb_mod_info ]
Simon Marlow's avatar
Simon Marlow committed
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382

-- ---------------------------------------------------------------------------
-- Typecheck module loops
{-
See bug #930.  This code fixes a long-standing bug in --make.  The
problem is that when compiling the modules *inside* a loop, a data
type that is only defined at the top of the loop looks opaque; but
after the loop is done, the structure of the data type becomes
apparent.

The difficulty is then that two different bits of code have
different notions of what the data type looks like.

The idea is that after we compile a module which also has an .hs-boot
file, we re-generate the ModDetails for each of the modules that
depends on the .hs-boot file, so that everyone points to the proper
TyCons, Ids etc. defined by the real module, not the boot module.
Fortunately re-generating a ModDetails from a ModIface is easy: the
function TcIface.typecheckIface does exactly that.

Picking the modules to re-typecheck is slightly tricky.  Starting from
the module graph consisting of the modules that have already been
compiled, we reverse the edges (so they point from the imported module
to the importing module), and depth-first-search from the .hs-boot
node.  This gives us all the modules that depend transitively on the
.hs-boot module, and those are exactly the modules that we need to
re-typecheck.

Following this fix, GHC can compile itself with --make -O2.
-}
1383

Simon Marlow's avatar
Simon Marlow committed
1384
1385
reTypecheckLoop :: HscEnv -> ModSummary -> ModuleGraph -> IO HscEnv
reTypecheckLoop hsc_env ms graph
1386
  | Just loop <- getModLoop ms graph
parcs's avatar
parcs committed
1387
1388
  , let non_boot = filter (not.isBootSummary) loop
  = typecheckLoop (hsc_dflags hsc_env) hsc_env (map ms_mod_name non_boot)
Simon Marlow's avatar
Simon Marlow committed
1389
1390
  | otherwise
  = return hsc_env
1391
1392
1393
1394
1395
1396

getModLoop :: ModSummary -> ModuleGraph -> Maybe [ModSummary]
getModLoop ms graph
  | not (isBootSummary ms)
  , any (\m -> ms_mod m == this_mod && isBootSummary m) graph
  , let mss = reachableBackwards (ms_mod_name ms) graph
parcs's avatar
parcs committed
1397
  = Just mss
1398
1399
  | otherwise
  = Nothing
Simon Marlow's avatar
Simon Marlow committed
1400
1401
1402
 where
  this_mod = ms_mod ms

1403
1404
1405
typecheckLoop :: DynFlags -> HscEnv -> [ModuleName] -> IO HscEnv
typecheckLoop dflags hsc_env mods = do
  debugTraceMsg dflags 2 $
1406
     text "Re-typechecking loop: " <> ppr mods
Simon Marlow's avatar
Simon Marlow committed
1407
1408
1409
  new_hpt <-
    fixIO $ \new_hpt -> do
      let new_hsc_env = hsc_env{ hsc_HPT = new_hpt }
1410
      mds <- initIfaceCheck new_hsc_env $
Simon Marlow's avatar
Simon Marlow committed
1411
                mapM (typecheckIface . hm_iface) hmis
1412
      let new_hpt = addListToUFM old_hpt
Simon Marlow's avatar
Simon Marlow committed
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
                        (zip mods [ hmi{ hm_details = details }
                                  | (hmi,details) <- zip hmis mds ])
      return new_hpt
  return hsc_env{ hsc_HPT = new_hpt }
  where
    old_hpt = hsc_HPT hsc_env
    hmis    = map (expectJust "typecheckLoop" . lookupUFM old_hpt) mods

reachableBackwards :: ModuleName -> [ModSummary] -> [ModSummary]
reachableBackwards mod summaries
  = [ ms | (ms,_,_) <- reachableG (transposeG graph) root ]
  where -- the rest just sets up the graph:
        (graph, lookup_node) = moduleGraphNodes False summaries
        root  = expectJust "reachableBackwards" (lookup_node HsBootFile mod)

-- ---------------------------------------------------------------------------
dterei's avatar
dterei committed
1429
1430
--
-- | Topological sort of the module graph
Simon Marlow's avatar
Simon Marlow committed
1431
topSortModuleGraph
dterei's avatar
dterei committed
1432
          :: Bool
Simon Marlow's avatar
Simon Marlow committed
1433
          -- ^ Drop hi-boot nodes? (see below)
dterei's avatar
dterei committed
1434
1435
          -> [ModSummary]
          -> Maybe ModuleName
Simon Marlow's avatar
Simon Marlow committed
1436
             -- ^ Root module name.  If @Nothing@, use the full graph.
dterei's avatar
dterei committed
1437
          -> [SCC ModSummary]
Simon Marlow's avatar
Simon Marlow committed
1438
1439
1440
1441
1442
1443
-- ^ Calculate SCCs of the module graph, possibly dropping the hi-boot nodes
-- The resulting list of strongly-connected-components is in topologically
-- sorted order, starting with the module(s) at the bottom of the
-- dependency graph (ie compile them first) and ending with the ones at
-- the top.
--
1444
-- Drop hi-boot nodes (first boolean arg)?
Simon Marlow's avatar
Simon Marlow committed
1445
--
dterei's avatar
dterei committed
1446
1447
-- - @False@:   treat the hi-boot summaries as nodes of the graph,
--              so the graph must be acyclic
Simon Marlow's avatar
Simon Marlow committed
1448
--
dterei's avatar
dterei committed
1449
1450
1451
-- - @True@:    eliminate the hi-boot nodes, and instead pretend
--              the a source-import of Foo is an import of Foo
--              The resulting graph has no hi-boot nodes, but can be cyclic
Simon Marlow's avatar
Simon Marlow committed
1452
1453
1454
1455
1456

topSortModuleGraph drop_hs_boot_nodes summaries mb_root_mod
  = map (fmap summaryNodeSummary) $ stronglyConnCompG initial_graph
  where
    (graph, lookup_node) = moduleGraphNodes drop_hs_boot_nodes summaries
1457

Simon Marlow's avatar
Simon Marlow committed
1458
1459
1460
1461
1462
1463
1464
1465
    initial_graph = case mb_root_mod of
        Nothing -> graph
        Just root_mod ->
            -- restrict the graph to just those modules reachable from
            -- the specified module.  We do this by building a graph with
            -- the full set of nodes, and determining the reachable set from
            -- the specified node.
            let root | Just node <- lookup_node HsSrcFile root_mod, graph `hasVertexG` node = node
1466
                     | otherwise = throwGhcException (ProgramError "module does not exist")
Simon Marlow's avatar
Simon Marlow committed
1467
1468
            in graphFromEdgedVertices (seq root (reachableG graph root))

dterei's avatar
dterei committed
1469
1470
type SummaryNode = (ModSummary, Int, [Int])