2 % (c) The University of Glasgow, 2000
4 \section[CmLink]{Linker for GHCI}
7 module CmLink ( Linkable(..), Unlinked(..),
9 modname_of_linkable, is_package_linkable,
12 PersistentLinkerState{-abstractly!-}, emptyPLS )
17 import CmStaticInfo ( PackageConfigInfo, GhciMode(..) )
18 import Module ( ModuleName, PackageName )
19 import Outputable ( SDoc )
20 import Digraph ( SCC(..), flattenSCC, flattenSCCs )
22 import Panic ( panic )
24 #include "HsVersions.h"
28 data PersistentLinkerState
29 = PersistentLinkerState {
32 -- Current global mapping from RdrNames to closure addresses
33 closure_env :: ClosureEnv,
35 -- the current global mapping from RdrNames of DataCons to
36 -- info table addresses.
37 -- When a new Unlinked is linked into the running image, or an existing
38 -- module in the image is replaced, the itbl_env must be updated
42 -- notionally here, but really lives in the C part of the linker:
43 -- object_symtab :: FiniteMap String Addr
45 dummy :: () -- sigh, can't have an empty record
51 = LinkOK PersistentLinkerState
52 | LinkErrs PersistentLinkerState [SDoc]
58 | Trees [UnlinkedIBind] ItblEnv -- bunch of interpretable bindings, +
59 -- a mapping from DataCons to their itbls
61 instance Outputable Unlinked where
62 ppr (DotO path) = text "DotO" <+> text path
63 ppr (DotA path) = text "DotA" <+> text path
64 ppr (DotDLL path) = text "DotDLL" <+> text path
65 ppr (Trees binds _) = text "Trees" <+> ppr binds
68 isObject (DotO _) = True
69 isObject (DotA _) = True
70 isObject (DotDLL _) = True
73 nameOfObject (DotO fn) = fn
74 nameOfObject (DotA fn) = fn
75 nameOfObject (DotDLL fn) = fn
77 isInterpretable (Trees _ _) = True
78 isInterpretable _ = False
81 = LM ModuleName [Unlinked]
84 instance Outputable Linkable where
85 ppr (LM mod_nm unlinkeds) = text "LinkableM" <+> ppr mod_nm <+> ppr unlinkeds
86 ppr (LP package_nm) = text "LinkableP" <+> ptext package_nm
88 emptyPLS :: IO PersistentLinkerState
90 emptyPLS = return (PersistentLinkerState { closure_env = emptyFM,
93 emptyPLS = return (PersistentLinkerState {})
98 -- The first arg is supposed to be DriverPipeline.doLink.
99 -- Passed in here to avoid a hard-to-avoid circular dependency
100 -- between CmLink and DriverPipeline. Same deal as with
101 -- CmSummarise.summarise.
102 link :: ([String] -> IO ())
103 -> GhciMode -- interactive or batch
104 -> Bool -- attempt linking in batch mode?
107 -> PersistentLinkerState
111 --link = panic "CmLink.link: not implemented"
113 -- For the moment, in the batch linker, we don't bother to
114 -- tell doLink which packages to link -- it just tries all that
116 -- batch_attempt_linking should only be *looked at* in
117 -- batch mode. It should only be True if the upsweep was
118 -- successful and someone exports main, i.e., we have good
119 -- reason to believe that linking will succeed.
120 link doLink Batch batch_attempt_linking pci groups pls1
121 | batch_attempt_linking
122 = do putStrLn "LINK(batch): linkables are ..."
123 putStrLn (showSDoc (vcat (map ppLinkableSCC groups)))
124 let o_files = concatMap getOfiles (flattenSCCs groups)
126 -- doLink only returns if it succeeds
127 putStrLn "LINK(batch): done"
130 = do putStrLn "LINKER(batch): upsweep (partially?) failed OR main not exported;"
131 putStrLn " -- not doing linking"
134 getOfiles (LP _) = []
135 getOfiles (LM _ us) = map nameOfObject (filter isObject us)
137 link doLink Interactive batch_attempt_linking pci groups pls1
138 = do putStrLn "LINKER(interactive): not yet implemented"
142 ppLinkableSCC :: SCC Linkable -> SDoc
143 ppLinkableSCC = ppr . flattenSCC
148 link pci [] pls = return (LinkOK pls)
149 link pci (groupSCC:groups) pls = do
150 let group = flattenSCC groupSCC
151 -- the group is either all objects or all interpretable, for now
152 if all isObject group
153 then do mapM loadObj [ file | DotO file <- group ]
156 else if all isInterpretable group
157 then do (new_closure_env, new_itbl_env) <-
158 linkIModules (closure_env pls)
160 [ trees | Trees trees <- group ]
161 link pci groups (PersistentLinkerState{
162 closure_env=new_closure_env,
163 itbl_env=new_itbl_env})
165 return (LinkErrs pls (ptext SLIT("linker: group must contain all objects or all interpreted modules")))
169 modname_of_linkable (LM nm _) = nm
170 modname_of_linkable (LP _) = panic "modname_of_linkable: package"
172 is_package_linkable (LP _) = True
173 is_package_linkable (LM _ _) = False
175 filterModuleLinkables :: (ModuleName -> Bool)
178 filterModuleLinkables p [] = []
179 filterModuleLinkables p (li:lis)
182 LM modnm _ -> if p modnm then retain else dump
184 dump = filterModuleLinkables p lis