2 % (c) The University of Glasgow, 2002
4 % The Compilation Manager
7 {-# OPTIONS -fvia-C #-}
11 CmState, emptyCmState, -- abstract
13 cmInit, -- :: GhciMode -> IO CmState
15 cmDepAnal, -- :: CmState -> DynFlags -> [FilePath] -> IO ModuleGraph
17 cmLoadModules, -- :: CmState -> DynFlags -> ModuleGraph
18 -- -> IO (CmState, Bool, [String])
20 cmUnload, -- :: CmState -> DynFlags -> IO CmState
23 cmModuleIsInterpreted, -- :: CmState -> String -> IO Bool
25 cmSetContext, -- :: CmState -> DynFlags -> [String] -> [String] -> IO CmState
26 cmGetContext, -- :: CmState -> IO ([String],[String])
28 cmInfoThing, -- :: CmState -> DynFlags -> String
29 -- -> IO (CmState, [(TyThing,Fixity)])
31 cmBrowseModule, -- :: CmState -> IO [TyThing]
34 cmRunStmt, -- :: CmState -> DynFlags -> String
35 -- -> IO (CmState, CmRunResult)
37 cmTypeOfExpr, -- :: CmState -> DynFlags -> String
38 -- -> IO (CmState, Maybe String)
40 cmTypeOfName, -- :: CmState -> Name -> IO (Maybe String)
43 cmCompileExpr, -- :: CmState -> DynFlags -> String
44 -- -> IO (CmState, Maybe HValue)
46 cmGetModuleGraph, -- :: CmState -> ModuleGraph
47 cmGetLinkables, -- :: CmState -> [Linkable]
49 cmGetBindings, -- :: CmState -> [TyThing]
50 cmGetPrintUnqual, -- :: CmState -> PrintUnqualified
58 #include "HsVersions.h"
66 import DriverState ( v_Output_file )
71 import HscMain ( initPersistentCompilerState, hscThing,
74 import HscMain ( initPersistentCompilerState )
76 import HscTypes hiding ( moduleNameToModule )
77 import Name ( Name, NamedThing(..), nameRdrName, nameModule,
78 isHomePackageName, isExternalName )
80 import Rename ( mkGlobalContext )
81 import RdrName ( emptyRdrEnv )
85 import Unique ( Uniquable )
86 import Digraph ( SCC(..), stronglyConnComp, flattenSCC, flattenSCCs )
87 import ErrUtils ( showPass )
88 import SysTools ( cleanTempFilesExcept )
92 import CmdLineOpts ( DynFlags(..), getDynFlags )
93 import Maybes ( expectJust )
98 import RdrName ( lookupRdrEnv )
99 import Id ( idType, idName )
100 import Type ( tidyType )
101 import VarEnv ( emptyTidyEnv )
102 import BasicTypes ( Fixity, defaultFixity )
103 import Interpreter ( HValue )
104 import HscMain ( hscStmt )
105 import GlaExts ( unsafeCoerce# )
108 import Exception ( Exception, try )
112 import Exception ( throwDyn )
115 import Directory ( getModificationTime, doesFileExist )
124 -- Persistent state for the entire system
127 hst :: HomeSymbolTable, -- home symbol table
128 hit :: HomeIfaceTable, -- home interface table
129 ui :: UnlinkedImage, -- the unlinked images
130 mg :: ModuleGraph, -- the module graph
131 gmode :: GhciMode, -- NEVER CHANGES
132 ic :: InteractiveContext, -- command-line binding info
134 pcs :: PersistentCompilerState, -- compile's persistent state
135 pls :: PersistentLinkerState -- link's persistent state
138 emptyCmState :: GhciMode -> IO CmState
140 = do pcs <- initPersistentCompilerState
142 return (CmState { hst = emptySymbolTable,
143 hit = emptyIfaceTable,
147 ic = emptyInteractiveContext,
151 emptyInteractiveContext
152 = InteractiveContext { ic_toplev_scope = [],
154 ic_rn_gbl_env = emptyRdrEnv,
155 ic_print_unqual = alwaysQualify,
156 ic_rn_local_env = emptyRdrEnv,
157 ic_type_env = emptyTypeEnv }
160 type UnlinkedImage = [Linkable] -- the unlinked images (should be a set, really)
161 emptyUI :: UnlinkedImage
164 type ModuleGraph = [ModSummary] -- the module graph, topologically sorted
165 emptyMG :: ModuleGraph
168 -----------------------------------------------------------------------------
169 -- Produce an initial CmState.
171 cmInit :: GhciMode -> IO CmState
172 cmInit mode = emptyCmState mode
174 -----------------------------------------------------------------------------
175 -- Grab information from the CmState
177 cmGetModuleGraph = mg
180 cmGetBindings cmstate = nameEnvElts (ic_type_env (ic cmstate))
181 cmGetPrintUnqual cmstate = ic_print_unqual (ic cmstate)
183 -----------------------------------------------------------------------------
184 -- Setting the context doesn't throw away any bindings; the bindings
185 -- we've built up in the InteractiveContext simply move to the new
186 -- module. They always shadow anything in scope in the current context.
189 :: CmState -> DynFlags
190 -> [String] -- take the top-level scopes of these modules
191 -> [String] -- and the just the exports from these
193 cmSetContext cmstate dflags toplevs exports = do
194 let CmState{ hit=hit, hst=hst, pcs=pcs, ic=old_ic } = cmstate
196 toplev_mods <- mapM (getTopLevModule hit) (map mkModuleName toplevs)
197 export_mods <- mapM (moduleNameToModule hit) (map mkModuleName exports)
199 (new_pcs, print_unqual, maybe_env)
200 <- mkGlobalContext dflags hit hst pcs toplev_mods export_mods
203 Nothing -> return cmstate
204 Just env -> return cmstate{ pcs = new_pcs,
205 ic = old_ic{ ic_toplev_scope = toplev_mods,
206 ic_exports = export_mods,
208 ic_print_unqual = print_unqual } }
210 getTopLevModule hit mn =
211 case lookupModuleEnvByName hit mn of
213 | Just _ <- mi_globals iface -> return (mi_module iface)
214 _other -> throwDyn (CmdLineError (
215 "cannot enter the top-level scope of a compiled module (module `" ++
216 moduleNameUserString mn ++ "')"))
218 moduleNameToModule :: HomeIfaceTable -> ModuleName -> IO Module
219 moduleNameToModule hit mn = do
220 case lookupModuleEnvByName hit mn of
221 Just iface -> return (mi_module iface)
222 _not_a_home_module -> do
223 maybe_stuff <- findModule mn
225 Nothing -> throwDyn (CmdLineError ("can't find module `"
226 ++ moduleNameUserString mn ++ "'"))
227 Just (m,_) -> return m
229 cmGetContext :: CmState -> IO ([String],[String])
230 cmGetContext CmState{ic=ic} =
231 return (map moduleUserString (ic_toplev_scope ic),
232 map moduleUserString (ic_exports ic))
234 cmModuleIsInterpreted :: CmState -> String -> IO Bool
235 cmModuleIsInterpreted cmstate str
236 = case lookupModuleEnvByName (hit cmstate) (mkModuleName str) of
237 Just iface -> return (not (isNothing (mi_globals iface)))
238 _not_a_home_module -> return False
240 -----------------------------------------------------------------------------
241 -- cmInfoThing: convert a String to a TyThing
243 -- A string may refer to more than one TyThing (eg. a constructor,
244 -- and type constructor), so we return a list of all the possible TyThings.
247 cmInfoThing :: CmState -> DynFlags -> String -> IO (CmState, [(TyThing,Fixity)])
248 cmInfoThing cmstate dflags id
249 = do (new_pcs, things) <- hscThing dflags hst hit pcs icontext id
250 let pairs = map (\x -> (x, getFixity new_pcs (getName x))) things
251 return (cmstate{ pcs=new_pcs }, pairs)
253 CmState{ hst=hst, hit=hit, pcs=pcs, pls=pls, ic=icontext } = cmstate
255 getFixity :: PersistentCompilerState -> Name -> Fixity
257 | isExternalName name,
258 Just iface <- lookupModuleEnv iface_table (nameModule name),
259 Just fixity <- lookupNameEnv (mi_fixities iface) name
263 where iface_table | isHomePackageName name = hit
264 | otherwise = pcs_PIT pcs
267 -- ---------------------------------------------------------------------------
268 -- cmBrowseModule: get all the TyThings defined in a module
271 cmBrowseModule :: CmState -> DynFlags -> String -> Bool
272 -> IO (CmState, [TyThing])
273 cmBrowseModule cmstate dflags str exports_only = do
274 let mn = mkModuleName str
275 mod <- moduleNameToModule hit mn
276 (pcs1, maybe_ty_things)
277 <- hscModuleContents dflags hst hit pcs mod exports_only
278 case maybe_ty_things of
279 Nothing -> return (cmstate{pcs=pcs1}, [])
280 Just ty_things -> return (cmstate{pcs=pcs1}, ty_things)
282 CmState{ hst=hst, hit=hit, pcs=pcs, pls=pls, ic=icontext } = cmstate
285 -----------------------------------------------------------------------------
286 -- cmRunStmt: Run a statement/expr.
290 = CmRunOk [Name] -- names bound by this evaluation
292 | CmRunException Exception -- statement raised an exception
294 cmRunStmt :: CmState -> DynFlags -> String -> IO (CmState, CmRunResult)
295 cmRunStmt cmstate@CmState{ hst=hst, hit=hit, pcs=pcs, pls=pls, ic=icontext }
298 let InteractiveContext {
299 ic_rn_local_env = rn_env,
300 ic_type_env = type_env } = icontext
302 (new_pcs, maybe_stuff)
303 <- hscStmt dflags hst hit pcs icontext expr False{-stmt-}
306 Nothing -> return (cmstate{ pcs=new_pcs }, CmRunFailed)
307 Just (ids, _, bcos) -> do
309 -- update the interactive context
311 names = map idName ids
313 -- these names have just been shadowed
314 shadowed = [ n | r <- map nameRdrName names,
315 Just n <- [lookupRdrEnv rn_env r] ]
317 new_rn_env = extendLocalRdrEnv rn_env names
319 -- remove any shadowed bindings from the type_env
320 filtered_type_env = delListFromNameEnv type_env shadowed
322 new_type_env = extendNameEnvList filtered_type_env
323 [ (getName id, AnId id) | id <- ids]
325 new_ic = icontext { ic_rn_local_env = new_rn_env,
326 ic_type_env = new_type_env }
329 hval <- linkExpr pls bcos
332 let thing_to_run = unsafeCoerce# hval :: IO [HValue]
333 either_hvals <- sandboxIO thing_to_run
336 -> do hPutStrLn stderr ("unknown failure, code " ++ show err)
337 return ( cmstate{ pcs=new_pcs, ic=new_ic }, CmRunFailed )
342 return ( cmstate{ pcs=new_pcs, ic=new_ic },
345 -- Get the newly bound things, and bind them.
346 -- Don't forget to delete any shadowed bindings from the
347 -- closure_env, lest we end up with a space leak.
348 pls <- delListFromClosureEnv pls shadowed
349 new_pls <- addListToClosureEnv pls (zip names hvals)
351 return (cmstate{ pcs=new_pcs, pls=new_pls, ic=new_ic },
355 -- We run the statement in a "sandbox" to protect the rest of the
356 -- system from anything the expression might do. For now, this
357 -- consists of just wrapping it in an exception handler, but see below
358 -- for another version.
360 sandboxIO :: IO a -> IO (Either Int (Either Exception a))
362 r <- Exception.try thing
366 -- This version of sandboxIO runs the expression in a completely new
367 -- RTS main thread. It is disabled for now because ^C exceptions
368 -- won't be delivered to the new thread, instead they'll be delivered
369 -- to the (blocked) GHCi main thread.
371 sandboxIO :: IO a -> IO (Either Int (Either Exception a))
373 st_thing <- newStablePtr (Exception.try thing)
374 alloca $ \ p_st_result -> do
375 stat <- rts_evalStableIO st_thing p_st_result
376 freeStablePtr st_thing
378 then do st_result <- peek p_st_result
379 result <- deRefStablePtr st_result
380 freeStablePtr st_result
381 return (Right result)
383 return (Left (fromIntegral stat))
385 foreign import "rts_evalStableIO" {- safe -}
386 rts_evalStableIO :: StablePtr (IO a) -> Ptr (StablePtr a) -> IO CInt
387 -- more informative than the C type!
391 -----------------------------------------------------------------------------
392 -- cmTypeOfExpr: returns a string representing the type of an expression
395 cmTypeOfExpr :: CmState -> DynFlags -> String -> IO (CmState, Maybe String)
396 cmTypeOfExpr cmstate dflags expr
397 = do (new_pcs, maybe_stuff)
398 <- hscStmt dflags hst hit pcs ic expr True{-just an expr-}
400 let new_cmstate = cmstate{pcs = new_pcs}
403 Nothing -> return (new_cmstate, Nothing)
404 Just (_, ty, _) -> return (new_cmstate, Just str)
406 str = showSDocForUser unqual (ppr tidy_ty)
407 unqual = ic_print_unqual ic
408 tidy_ty = tidyType emptyTidyEnv ty
410 CmState{ hst=hst, hit=hit, pcs=pcs, ic=ic } = cmstate
413 -----------------------------------------------------------------------------
414 -- cmTypeOfName: returns a string representing the type of a name.
417 cmTypeOfName :: CmState -> Name -> IO (Maybe String)
418 cmTypeOfName CmState{ hit=hit, pcs=pcs, ic=ic } name
419 = case lookupNameEnv (ic_type_env ic) name of
420 Nothing -> return Nothing
421 Just (AnId id) -> return (Just str)
423 unqual = ic_print_unqual ic
424 ty = tidyType emptyTidyEnv (idType id)
425 str = showSDocForUser unqual (ppr ty)
427 _ -> panic "cmTypeOfName"
430 -----------------------------------------------------------------------------
431 -- cmCompileExpr: compile an expression and deliver an HValue
434 cmCompileExpr :: CmState -> DynFlags -> String -> IO (CmState, Maybe HValue)
435 cmCompileExpr cmstate dflags expr
437 let InteractiveContext {
438 ic_rn_local_env = rn_env,
439 ic_type_env = type_env } = icontext
441 (new_pcs, maybe_stuff)
442 <- hscStmt dflags hst hit pcs icontext
443 ("let __cmCompileExpr = "++expr) False{-stmt-}
446 Nothing -> return (cmstate{ pcs=new_pcs }, Nothing)
447 Just (ids, _, bcos) -> do
450 hval <- linkExpr pls bcos
453 let thing_to_run = unsafeCoerce# hval :: IO [HValue]
454 hvals <- thing_to_run
457 ([id],[hv]) -> return (cmstate{ pcs=new_pcs }, Just hv)
458 _ -> panic "cmCompileExpr"
461 CmState{ hst=hst, hit=hit, pcs=pcs, pls=pls, ic=icontext } = cmstate
464 -----------------------------------------------------------------------------
465 -- Unload the compilation manager's state: everything it knows about the
466 -- current collection of modules in the Home package.
468 cmUnload :: CmState -> DynFlags -> IO CmState
469 cmUnload state@CmState{ gmode=mode, pls=pls, pcs=pcs } dflags
470 = do -- Throw away the old home dir cache
473 -- Unload everything the linker knows about
474 new_pls <- CmLink.unload mode dflags [] pls
476 -- Start with a fresh CmState, but keep the PersistentCompilerState
477 new_state <- cmInit mode
478 return new_state{ pcs=pcs, pls=new_pls }
481 -----------------------------------------------------------------------------
482 -- Trace dependency graph
484 -- This is a seperate pass so that the caller can back off and keep
485 -- the current state if the downsweep fails.
487 cmDepAnal :: CmState -> DynFlags -> [FilePath] -> IO ModuleGraph
488 cmDepAnal cmstate dflags rootnames
489 = do showPass dflags "Chasing dependencies"
490 when (verbosity dflags >= 1 && gmode cmstate == Batch) $
491 hPutStrLn stderr (showSDoc (hcat [
492 text progName, text ": chasing modules from: ",
493 hcat (punctuate comma (map text rootnames))]))
494 downsweep rootnames (mg cmstate)
496 -----------------------------------------------------------------------------
497 -- The real business of the compilation manager: given a system state and
498 -- a module name, try and bring the module up to date, probably changing
499 -- the system state at the same time.
501 cmLoadModules :: CmState
504 -> IO (CmState, -- new state
505 Bool, -- was successful
506 [String]) -- list of modules loaded
508 cmLoadModules cmstate1 dflags mg2unsorted
509 = do -- version 1's are the original, before downsweep
510 let pls1 = pls cmstate1
511 let pcs1 = pcs cmstate1
512 let hst1 = hst cmstate1
513 let hit1 = hit cmstate1
514 -- similarly, ui1 is the (complete) set of linkables from
515 -- the previous pass, if any.
516 let ui1 = ui cmstate1
518 let ghci_mode = gmode cmstate1 -- this never changes
520 -- Do the downsweep to reestablish the module graph
521 let verb = verbosity dflags
523 -- Find out if we have a Main module
525 = any ((=="Main").moduleNameUserString.modSummaryName)
528 let mg2unsorted_names = map modSummaryName mg2unsorted
530 -- reachable_from follows source as well as normal imports
531 let reachable_from :: ModuleName -> [ModuleName]
532 reachable_from = downwards_closure_of_module mg2unsorted
534 -- should be cycle free; ignores 'import source's
535 let mg2 = topological_sort False mg2unsorted
536 -- ... whereas this takes them into account. Used for
537 -- backing out partially complete cycles following a failed
538 -- upsweep, and for removing from hst/hit all the modules
539 -- not in strict downwards closure, during calls to compile.
540 let mg2_with_srcimps = topological_sort True mg2unsorted
542 -- Sort out which linkables we wish to keep in the unlinked image.
543 -- See getValidLinkables below for details.
544 (valid_old_linkables, new_linkables)
545 <- getValidLinkables ghci_mode ui1
546 mg2unsorted_names mg2_with_srcimps
548 -- putStrLn (showSDoc (vcat [ppr valid_old_linkables, ppr new_linkables]))
550 -- uniq of ModuleName is the same as Module, fortunately...
551 let hit2 = delListFromUFM hit1 (map linkableModName new_linkables)
553 -- When (verb >= 2) $
554 -- putStrLn (showSDoc (text "Valid linkables:"
555 -- <+> ppr valid_linkables))
557 -- Figure out a stable set of modules which can be retained
558 -- the top level envs, to avoid upsweeping them. Goes to a
559 -- bit of trouble to avoid upsweeping module cycles.
561 -- Construct a set S of stable modules like this:
562 -- Travel upwards, over the sccified graph. For each scc
563 -- of modules ms, add ms to S only if:
564 -- 1. All home imports of ms are either in ms or S
565 -- 2. A valid old linkable exists for each module in ms
567 stable_mods <- preUpsweep valid_old_linkables
568 mg2unsorted_names [] mg2_with_srcimps
571 = concatMap (findInSummaries mg2unsorted) stable_mods
574 = filter (\m -> linkableModName m `elem` stable_mods)
578 putStrLn (showSDoc (text "Stable modules:"
579 <+> sep (map (text.moduleNameUserString) stable_mods)))
581 -- unload any modules which are going to be re-linked this
583 pls2 <- CmLink.unload ghci_mode dflags stable_linkables pls1
585 -- we can now glom together our linkable sets
586 let valid_linkables = valid_old_linkables ++ new_linkables
588 -- We could at this point detect cycles which aren't broken by
589 -- a source-import, and complain immediately, but it seems better
590 -- to let upsweep_mods do this, so at least some useful work gets
591 -- done before the upsweep is abandoned.
593 = filter (\scc -> any (`notElem` stable_mods)
594 (map modSummaryName (flattenSCC scc)))
597 --hPutStrLn stderr "after tsort:\n"
598 --hPutStrLn stderr (showSDoc (vcat (map ppr mg2)))
600 -- Because we don't take into account source imports when doing
601 -- the topological sort, there shouldn't be any cycles in mg2.
602 -- If there is, we complain and give up -- the user needs to
603 -- break the cycle using a boot file.
605 -- Now do the upsweep, calling compile for each module in
606 -- turn. Final result is version 3 of everything.
608 let threaded2 = CmThreaded pcs1 hst1 hit2
610 -- clean up between compilations
611 let cleanup = cleanTempFilesExcept verb
612 (ppFilesFromSummaries (flattenSCCs upsweep_these))
614 (upsweep_complete_success, threaded3, modsUpswept, newLis)
615 <- upsweep_mods ghci_mode dflags valid_linkables reachable_from
616 threaded2 cleanup upsweep_these
618 let ui3 = add_to_ui valid_linkables newLis
619 let (CmThreaded pcs3 hst3 hit3) = threaded3
621 -- At this point, modsUpswept and newLis should have the same
622 -- length, so there is one new (or old) linkable for each
623 -- mod which was processed (passed to compile).
625 -- Make modsDone be the summaries for each home module now
626 -- available; this should equal the domains of hst3 and hit3.
627 -- (NOT STRICTLY TRUE if an interactive session was started
628 -- with some object on disk ???)
629 -- Get in in a roughly top .. bottom order (hence reverse).
631 let modsDone = reverse modsUpswept ++ stable_summaries
633 -- Try and do linking in some form, depending on whether the
634 -- upsweep was completely or only partially successful.
636 if upsweep_complete_success
639 -- Easy; just relink it all.
640 do when (verb >= 2) $
641 hPutStrLn stderr "Upsweep completely successful."
643 -- clean up after ourselves
644 cleanTempFilesExcept verb (ppFilesFromSummaries modsDone)
646 -- issue a warning for the confusing case where the user said '-o foo'
647 -- but we're not going to do any linking.
648 ofile <- readIORef v_Output_file
649 when (ghci_mode == Batch && isJust ofile && not a_root_is_Main
651 hPutStrLn stderr "Warning: output was redirected with -o, but no output will be generated\nbecause there is no Main module."
653 -- link everything together
654 linkresult <- link ghci_mode dflags a_root_is_Main ui3 pls2
656 cmLoadFinish True linkresult
657 hst3 hit3 ui3 modsDone ghci_mode pcs3
660 -- Tricky. We need to back out the effects of compiling any
661 -- half-done cycles, both so as to clean up the top level envs
662 -- and to avoid telling the interactive linker to link them.
663 do when (verb >= 2) $
664 hPutStrLn stderr "Upsweep partially successful."
667 = map modSummaryName modsDone
668 let mods_to_zap_names
669 = findPartiallyCompletedCycles modsDone_names
672 = filter ((`notElem` mods_to_zap_names).modSummaryName)
675 let (hst4, hit4, ui4)
676 = retainInTopLevelEnvs (map modSummaryName mods_to_keep)
679 -- clean up after ourselves
680 cleanTempFilesExcept verb (ppFilesFromSummaries mods_to_keep)
682 -- link everything together
683 linkresult <- link ghci_mode dflags False ui4 pls2
685 cmLoadFinish False linkresult
686 hst4 hit4 ui4 mods_to_keep ghci_mode pcs3
689 -- Finish up after a cmLoad.
691 -- If the link failed, unload everything and return.
692 cmLoadFinish ok (LinkFailed pls) hst hit ui mods ghci_mode pcs = do
693 dflags <- getDynFlags
694 new_pls <- CmLink.unload ghci_mode dflags [] pls
695 new_state <- cmInit ghci_mode
696 return (new_state{ pcs=pcs, pls=new_pls }, False, [])
698 -- Empty the interactive context and set the module context to the topmost
699 -- newly loaded module, or the Prelude if none were loaded.
700 cmLoadFinish ok (LinkOK pls) hst hit ui mods ghci_mode pcs
701 = do let new_cmstate = CmState{ hst=hst, hit=hit, ui=ui, mg=mods,
702 gmode=ghci_mode, pcs=pcs, pls=pls,
703 ic = emptyInteractiveContext }
704 mods_loaded = map (moduleNameUserString.modSummaryName) mods
706 return (new_cmstate, ok, mods_loaded)
708 -- used to fish out the preprocess output files for the purposes
710 ppFilesFromSummaries summaries
711 = [ fn | Just fn <- map toPpFile summaries ]
714 | hspp /= ml_hs_file loc = hspp
715 | otherwise = Nothing
717 loc = ms_location sum
718 hspp = ml_hspp_file loc
721 -----------------------------------------------------------------------------
724 -- For each module (or SCC of modules), we take:
726 -- - an on-disk linkable, if this is the first time around and one
729 -- - the old linkable, otherwise (and if one is available).
731 -- and we throw away the linkable if it is older than the source file.
732 -- In interactive mode, we also ignore the on-disk linkables unless
733 -- all of the dependents of this SCC also have on-disk linkables (we
734 -- can't have dynamically loaded objects that depend on interpreted
737 -- If a module has a valid linkable, then it may be STABLE (see below),
738 -- and it is classified as SOURCE UNCHANGED for the purposes of calling
741 -- ToDo: this pass could be merged with the preUpsweep.
745 -> [Linkable] -- old linkables
746 -> [ModuleName] -- all home modules
747 -> [SCC ModSummary] -- all modules in the program, dependency order
748 -> IO ( [Linkable], -- still-valid linkables
749 [Linkable] -- new linkables we just found
752 getValidLinkables mode old_linkables all_home_mods module_graph = do
753 ls <- foldM (getValidLinkablesSCC mode old_linkables all_home_mods)
755 return (partition_it ls [] [])
757 partition_it [] valid new = (valid,new)
758 partition_it ((l,b):ls) valid new
759 | b = partition_it ls valid (l:new)
760 | otherwise = partition_it ls (l:valid) new
763 getValidLinkablesSCC mode old_linkables all_home_mods new_linkables scc0
765 scc = flattenSCC scc0
766 scc_names = map modSummaryName scc
767 home_module m = m `elem` all_home_mods && m `notElem` scc_names
768 scc_allhomeimps = nub (filter home_module (concatMap ms_imps scc))
769 -- NB. ms_imps, not ms_allimps above. We don't want to
770 -- force a module's SOURCE imports to be already compiled for
771 -- its object linkable to be valid.
774 case findModuleLinkable_maybe (map fst new_linkables) m of
776 Just l -> isObjectLinkable l
778 objects_allowed = mode == Batch || all has_object scc_allhomeimps
782 <- foldM (getValidLinkable old_linkables objects_allowed) [] scc
784 -- since an scc can contain only all objects or no objects at all,
785 -- we have to check whether we got all objects or not, and re-do
786 -- the linkable check if not.
789 && not (all isObjectLinkable (map fst new_linkables'))
790 then foldM (getValidLinkable old_linkables False) [] scc
791 else return new_linkables'
793 return (new_linkables ++ new_linkables')
796 getValidLinkable :: [Linkable] -> Bool -> [(Linkable,Bool)] -> ModSummary
797 -> IO [(Linkable,Bool)]
798 -- True <=> linkable is new
799 getValidLinkable old_linkables objects_allowed new_linkables summary
800 = do let mod_name = modSummaryName summary
803 <- if (not objects_allowed)
806 else case ml_obj_file (ms_location summary) of
807 Just obj_fn -> maybe_getFileLinkable mod_name obj_fn
808 Nothing -> return Nothing
810 let old_linkable = findModuleLinkable_maybe old_linkables mod_name
813 case (old_linkable, maybe_disk_linkable) of
814 (Nothing, Nothing) -> []
816 -- new object linkable just appeared
817 (Nothing, Just l) -> up_to_date l True
820 | isObjectLinkable l -> []
821 -- object linkable disappeared! In case we need to
822 -- relink the module, disregard the old linkable and
823 -- just interpret the module from now on.
824 | otherwise -> up_to_date l False
825 -- old byte code linkable
828 | not (isObjectLinkable l) -> up_to_date l False
829 -- if the previous linkable was interpreted, then we
830 -- ignore a newly compiled version, because the version
831 -- numbers in the interface file will be out-of-sync with
832 -- our internal ones.
833 | linkableTime l' > linkableTime l -> up_to_date l' True
834 | linkableTime l' == linkableTime l -> up_to_date l False
836 -- on-disk linkable has been replaced by an older one!
837 -- again, disregard the previous one.
840 | linkableTime l < ms_hs_date summary = []
841 | otherwise = [(l,b)]
842 -- why '<' rather than '<=' above? If the filesystem stores
843 -- times to the nearset second, we may occasionally find that
844 -- the object & source have the same modification time,
845 -- especially if the source was automatically generated
846 -- and compiled. Using >= is slightly unsafe, but it matches
849 return (new_linkables' ++ new_linkables)
852 maybe_getFileLinkable :: ModuleName -> FilePath -> IO (Maybe Linkable)
853 maybe_getFileLinkable mod obj_fn
854 = do obj_exist <- doesFileExist obj_fn
858 do let stub_fn = case splitFilename3 obj_fn of
859 (dir, base, ext) -> dir ++ "/" ++ base ++ ".stub_o"
860 stub_exist <- doesFileExist stub_fn
861 obj_time <- getModificationTime obj_fn
863 then return (Just (LM obj_time mod [DotO obj_fn, DotO stub_fn]))
864 else return (Just (LM obj_time mod [DotO obj_fn]))
867 -----------------------------------------------------------------------------
868 -- Do a pre-upsweep without use of "compile", to establish a
869 -- (downward-closed) set of stable modules for which we won't call compile.
872 -- * has a valid linkable (see getValidLinkables above)
873 -- * depends only on stable modules
874 -- * has an interface in the HIT (interactive mode only)
876 preUpsweep :: [Linkable] -- new valid linkables
877 -> [ModuleName] -- names of all mods encountered in downsweep
878 -> [ModuleName] -- accumulating stable modules
879 -> [SCC ModSummary] -- scc-ified mod graph, including src imps
880 -> IO [ModuleName] -- stable modules
882 preUpsweep valid_lis all_home_mods stable [] = return stable
883 preUpsweep valid_lis all_home_mods stable (scc0:sccs)
884 = do let scc = flattenSCC scc0
885 scc_allhomeimps :: [ModuleName]
887 = nub (filter (`elem` all_home_mods) (concatMap ms_allimps scc))
888 all_imports_in_scc_or_stable
889 = all in_stable_or_scc scc_allhomeimps
891 = map modSummaryName scc
893 = m `elem` scc_names || m `elem` stable
895 -- now we check for valid linkables: each module in the SCC must
896 -- have a valid linkable (see getValidLinkables above).
897 has_valid_linkable new_summary
898 = isJust (findModuleLinkable_maybe valid_lis modname)
899 where modname = modSummaryName new_summary
901 scc_is_stable = all_imports_in_scc_or_stable
902 && all has_valid_linkable scc
905 then preUpsweep valid_lis all_home_mods (scc_names++stable) sccs
906 else preUpsweep valid_lis all_home_mods stable sccs
909 -- Helper for preUpsweep. Assuming that new_summary's imports are all
910 -- stable (in the sense of preUpsweep), determine if new_summary is itself
911 -- stable, and, if so, in batch mode, return its linkable.
912 findInSummaries :: [ModSummary] -> ModuleName -> [ModSummary]
913 findInSummaries old_summaries mod_name
914 = [s | s <- old_summaries, modSummaryName s == mod_name]
916 findModInSummaries :: [ModSummary] -> Module -> Maybe ModSummary
917 findModInSummaries old_summaries mod
918 = case [s | s <- old_summaries, ms_mod s == mod] of
922 -- Return (names of) all those in modsDone who are part of a cycle
923 -- as defined by theGraph.
924 findPartiallyCompletedCycles :: [ModuleName] -> [SCC ModSummary] -> [ModuleName]
925 findPartiallyCompletedCycles modsDone theGraph
929 chew ((AcyclicSCC v):rest) = chew rest -- acyclic? not interesting.
930 chew ((CyclicSCC vs):rest)
931 = let names_in_this_cycle = nub (map modSummaryName vs)
933 = nub ([done | done <- modsDone,
934 done `elem` names_in_this_cycle])
935 chewed_rest = chew rest
937 if notNull mods_in_this_cycle
938 && length mods_in_this_cycle < length names_in_this_cycle
939 then mods_in_this_cycle ++ chewed_rest
943 -- Add the given (LM-form) Linkables to the UI, overwriting previous
944 -- versions if they exist.
945 add_to_ui :: UnlinkedImage -> [Linkable] -> UnlinkedImage
947 = filter (not_in lis) ui ++ lis
949 not_in :: [Linkable] -> Linkable -> Bool
951 = all (\l -> linkableModName l /= mod) lis
952 where mod = linkableModName li
955 data CmThreaded -- stuff threaded through individual module compilations
956 = CmThreaded PersistentCompilerState HomeSymbolTable HomeIfaceTable
959 -- Compile multiple modules, stopping as soon as an error appears.
960 -- There better had not be any cyclic groups here -- we check for them.
961 upsweep_mods :: GhciMode
963 -> UnlinkedImage -- valid linkables
964 -> (ModuleName -> [ModuleName]) -- to construct downward closures
965 -> CmThreaded -- PCS & HST & HIT
966 -> IO () -- how to clean up unwanted tmp files
967 -> [SCC ModSummary] -- mods to do (the worklist)
968 -- ...... RETURNING ......
969 -> IO (Bool{-complete success?-},
971 [ModSummary], -- mods which succeeded
972 [Linkable]) -- new linkables
974 upsweep_mods ghci_mode dflags oldUI reachable_from threaded cleanup
976 = return (True, threaded, [], [])
978 upsweep_mods ghci_mode dflags oldUI reachable_from threaded cleanup
980 = do hPutStrLn stderr ("Module imports form a cycle for modules:\n\t" ++
981 unwords (map (moduleNameUserString.modSummaryName) ms))
982 return (False, threaded, [], [])
984 upsweep_mods ghci_mode dflags oldUI reachable_from threaded cleanup
985 ((AcyclicSCC mod):mods)
986 = do --case threaded of
987 -- CmThreaded pcsz hstz hitz
988 -- -> putStrLn ("UPSWEEP_MOD: hit = " ++ show (map (moduleNameUserString.moduleName.mi_module) (eltsUFM hitz)))
990 (threaded1, maybe_linkable)
991 <- upsweep_mod ghci_mode dflags oldUI threaded mod
992 (reachable_from (modSummaryName mod))
994 -- remove unwanted tmp files between compilations
997 case maybe_linkable of
999 -> -- No errors; do the rest
1000 do (restOK, threaded2, modOKs, linkables)
1001 <- upsweep_mods ghci_mode dflags oldUI reachable_from
1002 threaded1 cleanup mods
1003 return (restOK, threaded2, mod:modOKs, linkable:linkables)
1004 Nothing -- we got a compilation error; give up now
1005 -> return (False, threaded1, [], [])
1008 -- Compile a single module. Always produce a Linkable for it if
1009 -- successful. If no compilation happened, return the old Linkable.
1010 upsweep_mod :: GhciMode
1016 -> IO (CmThreaded, Maybe Linkable)
1018 upsweep_mod ghci_mode dflags oldUI threaded1 summary1 reachable_inc_me
1020 let mod_name = modSummaryName summary1
1022 let (CmThreaded pcs1 hst1 hit1) = threaded1
1023 let old_iface = lookupUFM hit1 mod_name
1025 let maybe_old_linkable = findModuleLinkable_maybe oldUI mod_name
1027 source_unchanged = isJust maybe_old_linkable
1029 reachable_only = filter (/= (modSummaryName summary1))
1032 -- in interactive mode, all home modules below us *must* have an
1033 -- interface in the HIT. We never demand-load home interfaces in
1034 -- interactive mode.
1035 (hst1_strictDC, hit1_strictDC, [])
1036 = ASSERT(ghci_mode == Batch ||
1037 all (`elemUFM` hit1) reachable_only)
1038 retainInTopLevelEnvs reachable_only (hst1,hit1,[])
1041 = expectJust "upsweep_mod:old_linkable" maybe_old_linkable
1044 | Just l <- maybe_old_linkable, isObjectLinkable l = True
1047 compresult <- compile ghci_mode summary1 source_unchanged
1048 have_object old_iface hst1_strictDC hit1_strictDC pcs1
1052 -- Compilation "succeeded", and may or may not have returned a new
1053 -- linkable (depending on whether compilation was actually performed
1055 CompOK pcs2 new_details new_iface maybe_new_linkable
1056 -> do let hst2 = addToUFM hst1 mod_name new_details
1057 hit2 = addToUFM hit1 mod_name new_iface
1058 threaded2 = CmThreaded pcs2 hst2 hit2
1060 return (threaded2, if isJust maybe_new_linkable
1061 then maybe_new_linkable
1062 else Just old_linkable)
1064 -- Compilation failed. compile may still have updated
1067 -> do let threaded2 = CmThreaded pcs2 hst1 hit1
1068 return (threaded2, Nothing)
1070 -- Filter modules in the top level envs (HST, HIT, UI).
1071 retainInTopLevelEnvs :: [ModuleName]
1072 -> (HomeSymbolTable, HomeIfaceTable, UnlinkedImage)
1073 -> (HomeSymbolTable, HomeIfaceTable, UnlinkedImage)
1074 retainInTopLevelEnvs keep_these (hst, hit, ui)
1075 = (retainInUFM hst keep_these,
1076 retainInUFM hit keep_these,
1077 filterModuleLinkables (`elem` keep_these) ui
1080 retainInUFM :: Uniquable key => UniqFM elt -> [key] -> UniqFM elt
1081 retainInUFM ufm keys_to_keep
1082 = listToUFM (concatMap (maybeLookupUFM ufm) keys_to_keep)
1083 maybeLookupUFM ufm u
1084 = case lookupUFM ufm u of Nothing -> []; Just val -> [(u, val)]
1086 -- Needed to clean up HIT and HST so that we don't get duplicates in inst env
1087 downwards_closure_of_module :: [ModSummary] -> ModuleName -> [ModuleName]
1088 downwards_closure_of_module summaries root
1089 = let toEdge :: ModSummary -> (ModuleName,[ModuleName])
1090 toEdge summ = (modSummaryName summ,
1091 filter (`elem` all_mods) (ms_allimps summ))
1093 all_mods = map modSummaryName summaries
1095 res = simple_transitive_closure (map toEdge summaries) [root]
1097 -- trace (showSDoc (text "DC of mod" <+> ppr root
1098 -- <+> text "=" <+> ppr res)) $
1101 -- Calculate transitive closures from a set of roots given an adjacency list
1102 simple_transitive_closure :: Eq a => [(a,[a])] -> [a] -> [a]
1103 simple_transitive_closure graph set
1104 = let set2 = nub (concatMap dsts set ++ set)
1105 dsts node = fromMaybe [] (lookup node graph)
1107 if length set == length set2
1109 else simple_transitive_closure graph set2
1112 -- Calculate SCCs of the module graph, with or without taking into
1113 -- account source imports.
1114 topological_sort :: Bool -> [ModSummary] -> [SCC ModSummary]
1115 topological_sort include_source_imports summaries
1117 toEdge :: ModSummary -> (ModSummary,ModuleName,[ModuleName])
1119 = (summ, modSummaryName summ,
1120 (if include_source_imports
1121 then ms_srcimps summ else []) ++ ms_imps summ)
1123 mash_edge :: (ModSummary,ModuleName,[ModuleName]) -> (ModSummary,Int,[Int])
1124 mash_edge (summ, m, m_imports)
1125 = case lookup m key_map of
1126 Nothing -> panic "reverse_topological_sort"
1127 Just mk -> (summ, mk,
1128 -- ignore imports not from the home package
1129 catMaybes (map (flip lookup key_map) m_imports))
1131 edges = map toEdge summaries
1132 key_map = zip [nm | (s,nm,imps) <- edges] [1 ..] :: [(ModuleName,Int)]
1133 scc_input = map mash_edge edges
1134 sccs = stronglyConnComp scc_input
1139 -----------------------------------------------------------------------------
1140 -- Downsweep (dependency analysis)
1142 -- Chase downwards from the specified root set, returning summaries
1143 -- for all home modules encountered. Only follow source-import
1146 -- We pass in the previous collection of summaries, which is used as a
1147 -- cache to avoid recalculating a module summary if the source is
1150 downsweep :: [FilePath] -> [ModSummary] -> IO [ModSummary]
1151 downsweep roots old_summaries
1152 = do rootSummaries <- mapM getRootSummary roots
1154 <- loop (concat (map (\ m -> zip (repeat (fromMaybe "<unknown>" (ml_hs_file (ms_location m))))
1155 (ms_imps m)) rootSummaries))
1156 (mkModuleEnv [ (mod, s) | s <- rootSummaries,
1157 let mod = ms_mod s, isHomeModule mod
1159 return all_summaries
1161 getRootSummary :: FilePath -> IO ModSummary
1163 | haskellish_src_file file
1164 = do exists <- doesFileExist file
1165 if exists then summariseFile file else do
1166 throwDyn (CmdLineError ("can't find file `" ++ file ++ "'"))
1168 = do exists <- doesFileExist hs_file
1169 if exists then summariseFile hs_file else do
1170 exists <- doesFileExist lhs_file
1171 if exists then summariseFile lhs_file else do
1172 let mod_name = mkModuleName file
1173 maybe_summary <- getSummary (file, mod_name)
1174 case maybe_summary of
1175 Nothing -> packageModErr mod_name
1178 hs_file = file ++ ".hs"
1179 lhs_file = file ++ ".lhs"
1181 getSummary :: (FilePath,ModuleName) -> IO (Maybe ModSummary)
1182 getSummary (currentMod,nm)
1183 = do found <- findModule nm
1185 Just (mod, location) -> do
1186 let old_summary = findModInSummaries old_summaries mod
1187 summarise mod location old_summary
1190 throwDyn (CmdLineError
1191 ("can't find module `"
1192 ++ showSDoc (ppr nm) ++ "' (while processing "
1193 ++ show currentMod ++ ")"))
1195 -- loop invariant: env doesn't contain package modules
1196 loop :: [(FilePath,ModuleName)] -> ModuleEnv ModSummary -> IO [ModSummary]
1197 loop [] env = return (moduleEnvElts env)
1199 = do -- imports for modules we don't already have
1200 let needed_imps = nub (filter (not . (`elemUFM` env).snd) imps)
1203 needed_summaries <- mapM getSummary needed_imps
1205 -- get just the "home" modules
1206 let new_home_summaries = [ s | Just s <- needed_summaries ]
1208 -- loop, checking the new imports
1209 let new_imps = concat (map (\ m -> zip (repeat (fromMaybe "<unknown>" (ml_hs_file (ms_location m))))
1210 (ms_imps m)) new_home_summaries)
1211 loop new_imps (extendModuleEnvList env
1212 [ (ms_mod s, s) | s <- new_home_summaries ])
1214 -----------------------------------------------------------------------------
1215 -- Summarising modules
1217 -- We have two types of summarisation:
1219 -- * Summarise a file. This is used for the root module(s) passed to
1220 -- cmLoadModules. The file is read, and used to determine the root
1221 -- module name. The module name may differ from the filename.
1223 -- * Summarise a module. We are given a module name, and must provide
1224 -- a summary. The finder is used to locate the file in which the module
1227 summariseFile :: FilePath -> IO ModSummary
1229 = do hspp_fn <- preprocess file
1230 (srcimps,imps,mod_name) <- getImportsFromFile hspp_fn
1232 let (path, basename, _ext) = splitFilename3 file
1235 <- mkHomeModuleLocn mod_name (path ++ '/':basename) file
1238 <- case ml_hs_file location of
1239 Nothing -> noHsFileErr mod_name
1240 Just src_fn -> getModificationTime src_fn
1242 return (ModSummary mod
1243 location{ml_hspp_file=Just hspp_fn}
1244 srcimps imps src_timestamp)
1246 -- Summarise a module, and pick up source and timestamp.
1247 summarise :: Module -> ModuleLocation -> Maybe ModSummary
1248 -> IO (Maybe ModSummary)
1249 summarise mod location old_summary
1250 | not (isHomeModule mod) = return Nothing
1252 = do let hs_fn = expectJust "summarise" (ml_hs_file location)
1254 case ml_hs_file location of {
1255 Nothing -> noHsFileErr mod;
1258 src_timestamp <- getModificationTime src_fn
1260 -- return the cached summary if the source didn't change
1261 case old_summary of {
1262 Just s | ms_hs_date s == src_timestamp -> return (Just s);
1265 hspp_fn <- preprocess hs_fn
1266 (srcimps,imps,mod_name) <- getImportsFromFile hspp_fn
1268 when (mod_name /= moduleName mod) $
1269 throwDyn (ProgramError
1270 (showSDoc (text hs_fn
1271 <> text ": file name does not match module name"
1272 <+> quotes (ppr (moduleName mod)))))
1274 return (Just (ModSummary mod location{ml_hspp_file=Just hspp_fn}
1275 srcimps imps src_timestamp))
1281 = throwDyn (CmdLineError (showSDoc (text "no source file for module" <+> quotes (ppr mod))))
1284 = throwDyn (CmdLineError (showSDoc (text "module" <+>
1285 quotes (ppr mod) <+>
1286 text "is a package module")))