ghc/compiler/ghci/CmLink.lhs

   1 %
   2 % (c) The University of Glasgow, 2000
   3 %
   4 \section[CmLink]{Linker for GHCI}
   5
   6 \begin{code}
   7 module CmLink ( Linkable(..),  Unlinked(..),
   8                 filterModuleLinkables,
   9                 modname_of_linkable, is_package_linkable,
  10                 LinkResult(..),
  11                 link,
  12                 PersistentLinkerState{-abstractly!-}, emptyPLS )
  13 where
  14
  15 import StgInterp        ( linkIModules, ClosureEnv, ItblEnv )
  16
  17 import CmStaticInfo     ( PackageConfigInfo )
  18 import Module           ( ModuleName, PackageName )
  19 import InterpSyn        ( UnlinkedIBind, HValue, binder )
  20 import Module           ( Module )
  21 import Outputable       ( SDoc )
  22 import FiniteMap        ( emptyFM )
  23 import Digraph          ( SCC(..) )
  24 import Outputable
  25 import Panic            ( panic )
  26
  27 #include "HsVersions.h"
  28 \end{code}
  29
  30 \begin{code}
  31 data PersistentLinkerState
  32    = PersistentLinkerState {
  33         -- Current global mapping from RdrNames to closure addresses
  34         closure_env :: ClosureEnv,
  35
  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
  40         -- appropriately.
  41         itbl_env    :: ItblEnv
  42
  43         -- notionally here, but really lives in the C part of the linker:
  44         --            object_symtab :: FiniteMap String Addr
  45      }
  46
  47 data LinkResult
  48    = LinkOK   PersistentLinkerState
  49    | LinkErrs PersistentLinkerState [SDoc]
  50
  51 data Unlinked
  52    = DotO FilePath
  53    | DotA FilePath
  54    | DotDLL FilePath
  55    | Trees [UnlinkedIBind] ItblEnv  -- bunch of interpretable bindings, +
  56                                     -- a mapping from DataCons to their itbls
  57
  58 instance Outputable Unlinked where
  59    ppr (DotO path)   = text "DotO" <+> text path
  60    ppr (DotA path)   = text "DotA" <+> text path
  61    ppr (DotDLL path) = text "DotDLL" <+> text path
  62    ppr (Trees binds _) = text "Trees" <+> ppr (map binder binds)
  63
  64
  65 isObject (DotO _) = True
  66 isObject (DotA _) = True
  67 isObject (DotDLL _) = True
  68 isObject _ = False
  69
  70 isInterpretable (Trees _ _) = True
  71 isInterpretable _ = False
  72
  73 data Linkable
  74    = LM ModuleName [Unlinked]
  75    | LP PackageName
  76
  77 instance Outputable Linkable where
  78    ppr (LM mod_nm unlinkeds) = text "LinkableM" <+> ppr mod_nm <+> ppr unlinkeds
  79    ppr (LP package_nm)       = text "LinkableP" <+> ptext package_nm
  80
  81 emptyPLS :: IO PersistentLinkerState
  82 emptyPLS = return (PersistentLinkerState { closure_env = emptyFM,
  83                                            itbl_env    = emptyFM })
  84 \end{code}
  85
  86 \begin{code}
  87 link :: PackageConfigInfo
  88      -> [SCC Linkable]
  89      -> PersistentLinkerState
  90      -> IO LinkResult
  91
  92 #ifndef GHCI_NOTYET
  93 --link = panic "CmLink.link: not implemented"
  94 link pci groups pls1
  95    = do putStrLn "Hello from the Linker!"
  96         putStrLn (showSDoc (vcat (map ppLinkableSCC groups)))
  97         putStrLn "Bye-bye from the Linker!"
  98         return (LinkOK pls1)
  99
 100 ppLinkableSCC :: SCC Linkable -> SDoc
 101 ppLinkableSCC (CyclicSCC xs) = ppr xs
 102 ppLinkableSCC (AcyclicSCC x) = ppr [x]
 103
 104
 105 #else
 106 link pci [] pls = return (LinkOK pls)
 107 link pci (group:groups) pls = do
 108    -- the group is either all objects or all interpretable, for now
 109    if all isObject group
 110         then do mapM loadObj [ file | DotO file <- group ]
 111                 resolveObjs
 112                 link pci groups pls
 113     else if all isInterpretable group
 114         then do (new_closure_env, new_itbl_env) <-
 115                    linkIModules (closure_env pls)
 116                                 (itbl_env pls)
 117                                 [ trees | Trees trees <- group ]
 118                 link pci groups (PersistentLinkerState{
 119                                    closure_env=new_closure_env,
 120                                    itbl_env=new_itbl_env})
 121     else
 122         return (LinkErrs pls (ptext SLIT("linker: group must contain all objects or all interpreted modules")))
 123 #endif
 124
 125 modname_of_linkable (LM nm _) = nm
 126 modname_of_linkable (LP _)    = panic "modname_of_linkable: package"
 127
 128 is_package_linkable (LP _)   = True
 129 is_package_linkable (LM _ _) = False
 130
 131 filterModuleLinkables :: (ModuleName -> Bool)
 132                       -> [Linkable]
 133                       -> [Linkable]
 134 filterModuleLinkables p [] = []
 135 filterModuleLinkables p (li:lis)
 136    = case li of
 137         LP _       -> retain
 138         LM modnm _ -> if p modnm then retain else dump
 139      where
 140         dump   = filterModuleLinkables p lis
 141         retain = li : dump
 142 \end{code}