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 )
18 import Module ( ModuleName, PackageName )
19 import Outputable ( SDoc )
20 import Digraph ( SCC(..), flattenSCC, flattenSCCs )
22 import Panic ( panic )
23 import BasicTypes ( GhciMode(..) )
25 #include "HsVersions.h"
29 data PersistentLinkerState
30 = PersistentLinkerState {
33 -- Current global mapping from RdrNames to closure addresses
34 closure_env :: ClosureEnv,
36 -- the current global mapping from RdrNames of DataCons to
37 -- info table addresses.
38 -- When a new Unlinked is linked into the running image, or an existing
39 -- module in the image is replaced, the itbl_env must be updated
43 -- notionally here, but really lives in the C part of the linker:
44 -- object_symtab :: FiniteMap String Addr
46 dummy :: () -- sigh, can't have an empty record
52 = LinkOK PersistentLinkerState
53 | LinkErrs PersistentLinkerState [SDoc]
59 | Trees [UnlinkedIBind] ItblEnv -- bunch of interpretable bindings, +
60 -- a mapping from DataCons to their itbls
62 instance Outputable Unlinked where
63 ppr (DotO path) = text "DotO" <+> text path
64 ppr (DotA path) = text "DotA" <+> text path
65 ppr (DotDLL path) = text "DotDLL" <+> text path
66 ppr (Trees binds _) = text "Trees" <+> ppr binds
69 isObject (DotO _) = True
70 isObject (DotA _) = True
71 isObject (DotDLL _) = True
74 nameOfObject (DotO fn) = fn
75 nameOfObject (DotA fn) = fn
76 nameOfObject (DotDLL fn) = fn
78 isInterpretable (Trees _ _) = True
79 isInterpretable _ = False
82 = LM ModuleName [Unlinked]
85 instance Outputable Linkable where
86 ppr (LM mod_nm unlinkeds) = text "LinkableM" <+> ppr mod_nm <+> ppr unlinkeds
87 ppr (LP package_nm) = text "LinkableP" <+> ptext package_nm
89 emptyPLS :: IO PersistentLinkerState
91 emptyPLS = return (PersistentLinkerState { closure_env = emptyFM,
94 emptyPLS = return (PersistentLinkerState {})
99 -- The first arg is supposed to be DriverPipeline.doLink.
100 -- Passed in here to avoid a hard-to-avoid circular dependency
101 -- between CmLink and DriverPipeline. Same deal as with
102 -- CmSummarise.summarise.
103 link :: ([String] -> IO ())
104 -> GhciMode -- interactive or batch
105 -> Bool -- attempt linking in batch mode?
108 -> PersistentLinkerState
112 --link = panic "CmLink.link: not implemented"
114 -- For the moment, in the batch linker, we don't bother to
115 -- tell doLink which packages to link -- it just tries all that
117 -- batch_attempt_linking should only be *looked at* in
118 -- batch mode. It should only be True if the upsweep was
119 -- successful and someone exports main, i.e., we have good
120 -- reason to believe that linking will succeed.
121 link doLink Batch batch_attempt_linking pci groups pls1
122 | batch_attempt_linking
123 = do putStrLn "LINK(batch): linkables are ..."
124 putStrLn (showSDoc (vcat (map ppLinkableSCC groups)))
125 let o_files = concatMap getOfiles (flattenSCCs groups)
127 -- doLink only returns if it succeeds
128 putStrLn "LINK(batch): done"
131 = do putStrLn "LINKER(batch): upsweep (partially?) failed OR main not exported;"
132 putStrLn " -- not doing linking"
135 getOfiles (LP _) = []
136 getOfiles (LM _ us) = map nameOfObject (filter isObject us)
138 link doLink Interactive batch_attempt_linking pci groups pls1
139 = do putStrLn "LINKER(interactive): not yet implemented"
143 ppLinkableSCC :: SCC Linkable -> SDoc
144 ppLinkableSCC = ppr . flattenSCC
149 link pci [] pls = return (LinkOK pls)
150 link pci (groupSCC:groups) pls = do
151 let group = flattenSCC groupSCC
152 -- the group is either all objects or all interpretable, for now
153 if all isObject group
154 then do mapM loadObj [ file | DotO file <- group ]
157 else if all isInterpretable group
158 then do (new_closure_env, new_itbl_env) <-
159 linkIModules (closure_env pls)
161 [ trees | Trees trees <- group ]
162 link pci groups (PersistentLinkerState{
163 closure_env=new_closure_env,
164 itbl_env=new_itbl_env})
166 return (LinkErrs pls (ptext SLIT("linker: group must contain all objects or all interpreted modules")))
170 modname_of_linkable (LM nm _) = nm
171 modname_of_linkable (LP _) = panic "modname_of_linkable: package"
173 is_package_linkable (LP _) = True
174 is_package_linkable (LM _ _) = False
176 filterModuleLinkables :: (ModuleName -> Bool)
179 filterModuleLinkables p [] = []
180 filterModuleLinkables p (li:lis)
183 LM modnm _ -> if p modnm then retain else dump
185 dump = filterModuleLinkables p lis