ghc/compiler/ghci/ByteCodeItbls.lhs

   1 %
   2 % (c) The University of Glasgow 2000
   3 %
   4 \section[ByteCodeItbls]{Generate infotables for interpreter-made bytecodes}
   5
   6 \begin{code}
   7
   8 {-# OPTIONS -optc-DNON_POSIX_SOURCE #-}
   9
  10 module ByteCodeItbls ( ItblEnv, ItblPtr, mkITbls ) where
  11
  12 #include "HsVersions.h"
  13
  14 import Name             ( Name, getName )
  15 import NameEnv
  16 import Type             ( typePrimRep )
  17 import DataCon          ( DataCon, dataConRepArgTys )
  18 import TyCon            ( TyCon, tyConFamilySize, isDataTyCon, tyConDataCons )
  19 import Constants        ( mIN_SIZE_NonUpdHeapObject )
  20 import ClosureInfo      ( mkVirtHeapOffsets )
  21 import FastString       ( FastString(..) )
  22 import Util             ( lengthIs, listLengthCmp )
  23
  24 import Foreign          ( Storable(..), Word8, Word16, Word32, Word64,
  25                           malloc, castPtr, plusPtr )
  26 import DATA_BITS        ( Bits(..), shiftR )
  27
  28 import GHC.Exts         ( Int(I#), addr2Int# )
  29 #if __GLASGOW_HASKELL__ < 503
  30 import Ptr              ( Ptr(..) )
  31 #else
  32 import GHC.Ptr          ( Ptr(..) )
  33 #endif
  34 \end{code}
  35
  36 %************************************************************************
  37 %*                                                                      *
  38 \subsection{Manufacturing of info tables for DataCons}
  39 %*                                                                      *
  40 %************************************************************************
  41
  42 \begin{code}
  43 type ItblPtr = Ptr StgInfoTable
  44 type ItblEnv = NameEnv (Name, ItblPtr)
  45         -- We need the Name in the range so we know which
  46         -- elements to filter out when unloading a module
  47
  48 mkItblEnv :: [(Name,ItblPtr)] -> ItblEnv
  49 mkItblEnv pairs = mkNameEnv [(n, (n,p)) | (n,p) <- pairs]
  50
  51
  52 -- Make info tables for the data decls in this module
  53 mkITbls :: [TyCon] -> IO ItblEnv
  54 mkITbls [] = return emptyNameEnv
  55 mkITbls (tc:tcs) = do itbls  <- mkITbl tc
  56                       itbls2 <- mkITbls tcs
  57                       return (itbls `plusNameEnv` itbls2)
  58
  59 mkITbl :: TyCon -> IO ItblEnv
  60 mkITbl tc
  61    | not (isDataTyCon tc)
  62    = return emptyNameEnv
  63    | dcs `lengthIs` n -- paranoia; this is an assertion.
  64    = make_constr_itbls dcs
  65      where
  66         dcs = tyConDataCons tc
  67         n   = tyConFamilySize tc
  68
  69 cONSTR :: Int
  70 cONSTR = 1  -- as defined in ghc/includes/ClosureTypes.h
  71
  72 -- Assumes constructors are numbered from zero, not one
  73 make_constr_itbls :: [DataCon] -> IO ItblEnv
  74 make_constr_itbls cons
  75    | listLengthCmp cons 8 /= GT -- <= 8 elements in the list
  76    = do is <- mapM mk_vecret_itbl (zip cons [0..])
  77         return (mkItblEnv is)
  78    | otherwise
  79    = do is <- mapM mk_dirret_itbl (zip cons [0..])
  80         return (mkItblEnv is)
  81      where
  82         mk_vecret_itbl (dcon, conNo)
  83            = mk_itbl dcon conNo (vecret_entry conNo)
  84         mk_dirret_itbl (dcon, conNo)
  85            = mk_itbl dcon conNo stg_interp_constr_entry
  86
  87         mk_itbl :: DataCon -> Int -> Ptr () -> IO (Name,ItblPtr)
  88         mk_itbl dcon conNo entry_addr
  89            = let (tot_wds, ptr_wds, _)
  90                     = mkVirtHeapOffsets typePrimRep (dataConRepArgTys dcon)
  91                  ptrs  = ptr_wds
  92                  nptrs = tot_wds - ptr_wds
  93                  nptrs_really
  94                     | ptrs + nptrs >= mIN_SIZE_NonUpdHeapObject = nptrs
  95                     | otherwise = mIN_SIZE_NonUpdHeapObject - ptrs
  96                  itbl  = StgInfoTable {
  97                            ptrs  = fromIntegral ptrs,
  98                            nptrs = fromIntegral nptrs_really,
  99                            tipe  = fromIntegral cONSTR,
 100                            srtlen = fromIntegral conNo,
 101                            code  = code
 102                         }
 103                  -- Make a piece of code to jump to "entry_label".
 104                  -- This is the only arch-dependent bit.
 105                  code = mkJumpToAddr entry_addr
 106              in
 107                  do addr <- malloc
 108                     --putStrLn ("SIZE of itbl is " ++ show (sizeOf itbl))
 109                     --putStrLn ("# ptrs  of itbl is " ++ show ptrs)
 110                     --putStrLn ("# nptrs of itbl is " ++ show nptrs_really)
 111                     poke addr itbl
 112                     return (getName dcon, addr `plusPtr` 8)
 113
 114
 115 -- Make code which causes a jump to the given address.  This is the
 116 -- only arch-dependent bit of the itbl story.  The returned list is
 117 -- itblCodeLength elements (bytes) long.
 118
 119 -- For sparc_TARGET_ARCH, i386_TARGET_ARCH, etc.
 120 #include "nativeGen/NCG.h"
 121
 122 itblCodeLength :: Int
 123 itblCodeLength = length (mkJumpToAddr undefined)
 124
 125 mkJumpToAddr :: Ptr () -> [ItblCode]
 126
 127 ptrToInt (Ptr a#) = I# (addr2Int# a#)
 128
 129 #if sparc_TARGET_ARCH
 130 -- After some consideration, we'll try this, where
 131 -- 0x55555555 stands in for the address to jump to.
 132 -- According to ghc/includes/MachRegs.h, %g3 is very
 133 -- likely indeed to be baggable.
 134 --
 135 --   0000 07155555              sethi   %hi(0x55555555), %g3
 136 --   0004 8610E155              or      %g3, %lo(0x55555555), %g3
 137 --   0008 81C0C000              jmp     %g3
 138 --   000c 01000000              nop
 139
 140 type ItblCode = Word32
 141 mkJumpToAddr a
 142    = let w32 = fromIntegral (ptrToInt a)
 143
 144          hi22, lo10 :: Word32 -> Word32
 145          lo10 x = x .&. 0x3FF
 146          hi22 x = (x `shiftR` 10) .&. 0x3FFFF
 147
 148      in  [ 0x07000000 .|. (hi22 w32),
 149            0x8610E000 .|. (lo10 w32),
 150            0x81C0C000,
 151            0x01000000 ]
 152
 153 #elif powerpc_TARGET_ARCH
 154 -- We'll use r12, for no particular reason.
 155 -- 0xDEADBEEF stands for the adress:
 156 -- 3D80DEAD lis r12,0xDEAD
 157 -- 618CBEEF ori r12,r12,0xBEEF
 158 -- 7D8903A6 mtctr r12
 159 -- 4E800420 bctr
 160
 161 type ItblCode = Word32
 162 mkJumpToAddr a =
 163     let w32 = fromIntegral (ptrToInt a)
 164         hi16 x = (x `shiftR` 16) .&. 0xFFFF
 165         lo16 x = x .&. 0xFFFF
 166     in  [
 167         0x3D800000 .|. hi16 w32,
 168         0x618C0000 .|. lo16 w32,
 169         0x7D8903A6, 0x4E800420
 170         ]
 171
 172 #elif i386_TARGET_ARCH
 173 -- Let the address to jump to be 0xWWXXYYZZ.
 174 -- Generate   movl $0xWWXXYYZZ,%eax  ;  jmp *%eax
 175 -- which is
 176 -- B8 ZZ YY XX WW FF E0
 177
 178 type ItblCode = Word8
 179 mkJumpToAddr a
 180    = let w32 = fromIntegral (ptrToInt a)
 181          insnBytes :: [Word8]
 182          insnBytes
 183             = [0xB8, byte 0 w32, byte 1 w32,
 184                      byte 2 w32, byte 3 w32,
 185                0xFF, 0xE0]
 186      in
 187          insnBytes
 188
 189 #elif alpha_TARGET_ARCH
 190 type ItblCode = Word32
 191 mkJumpToAddr a
 192     = [ 0xc3800000      -- br   at, .+4
 193       , 0xa79c000c      -- ldq  at, 12(at)
 194       , 0x6bfc0000      -- jmp  (at)    # with zero hint -- oh well
 195       , 0x47ff041f      -- nop
 196       , fromIntegral (w64 .&. 0x0000FFFF)
 197       , fromIntegral ((w64 `shiftR` 32) .&. 0x0000FFFF) ]
 198     where w64 = fromIntegral (ptrToInt a) :: Word64
 199
 200 #else
 201 type ItblCode = Word32
 202 mkJumpToAddr a
 203     = undefined
 204 #endif
 205
 206
 207 byte :: Int -> Word32 -> Word8
 208 byte 0 w = fromIntegral (w .&. 0xFF)
 209 byte 1 w = fromIntegral ((w `shiftR` 8) .&. 0xFF)
 210 byte 2 w = fromIntegral ((w `shiftR` 16) .&. 0xFF)
 211 byte 3 w = fromIntegral ((w `shiftR` 24) .&. 0xFF)
 212
 213
 214 vecret_entry 0 = stg_interp_constr1_entry
 215 vecret_entry 1 = stg_interp_constr2_entry
 216 vecret_entry 2 = stg_interp_constr3_entry
 217 vecret_entry 3 = stg_interp_constr4_entry
 218 vecret_entry 4 = stg_interp_constr5_entry
 219 vecret_entry 5 = stg_interp_constr6_entry
 220 vecret_entry 6 = stg_interp_constr7_entry
 221 vecret_entry 7 = stg_interp_constr8_entry
 222
 223 -- entry point for direct returns for created constr itbls
 224 foreign label "stg_interp_constr_entry" stg_interp_constr_entry :: Ptr ()
 225 -- and the 8 vectored ones
 226 foreign label "stg_interp_constr1_entry" stg_interp_constr1_entry :: Ptr ()
 227 foreign label "stg_interp_constr2_entry" stg_interp_constr2_entry :: Ptr ()
 228 foreign label "stg_interp_constr3_entry" stg_interp_constr3_entry :: Ptr ()
 229 foreign label "stg_interp_constr4_entry" stg_interp_constr4_entry :: Ptr ()
 230 foreign label "stg_interp_constr5_entry" stg_interp_constr5_entry :: Ptr ()
 231 foreign label "stg_interp_constr6_entry" stg_interp_constr6_entry :: Ptr ()
 232 foreign label "stg_interp_constr7_entry" stg_interp_constr7_entry :: Ptr ()
 233 foreign label "stg_interp_constr8_entry" stg_interp_constr8_entry :: Ptr ()
 234
 235
 236
 237
 238
 239 -- Ultra-minimalist version specially for constructors
 240 #if SIZEOF_VOID_P == 8
 241 type HalfWord = Word32
 242 #else
 243 type HalfWord = Word16
 244 #endif
 245
 246 data StgInfoTable = StgInfoTable {
 247    ptrs   :: HalfWord,
 248    nptrs  :: HalfWord,
 249    tipe   :: HalfWord,
 250    srtlen :: HalfWord,
 251    code   :: [ItblCode]
 252 }
 253
 254 instance Storable StgInfoTable where
 255
 256    sizeOf itbl
 257       = sum
 258         [fieldSz ptrs itbl,
 259          fieldSz nptrs itbl,
 260          fieldSz tipe itbl,
 261          fieldSz srtlen itbl,
 262          fieldSz (head.code) itbl * itblCodeLength]
 263
 264    alignment itbl
 265       = SIZEOF_VOID_P
 266
 267    poke a0 itbl
 268       = runState (castPtr a0)
 269       $ do store (ptrs   itbl)
 270            store (nptrs  itbl)
 271            store (tipe   itbl)
 272            store (srtlen itbl)
 273            sequence_ (map store (code itbl))
 274
 275    peek a0
 276       = runState (castPtr a0)
 277       $ do ptrs   <- load
 278            nptrs  <- load
 279            tipe   <- load
 280            srtlen <- load
 281            code   <- sequence (replicate itblCodeLength load)
 282            return
 283               StgInfoTable {
 284                  ptrs   = ptrs,
 285                  nptrs  = nptrs,
 286                  tipe   = tipe,
 287                  srtlen = srtlen,
 288                  code   = code
 289               }
 290
 291 fieldSz :: (Storable a, Storable b) => (a -> b) -> a -> Int
 292 fieldSz sel x = sizeOf (sel x)
 293
 294 newtype State s m a = State (s -> m (s, a))
 295
 296 instance Monad m => Monad (State s m) where
 297   return a      = State (\s -> return (s, a))
 298   State m >>= k = State (\s -> m s >>= \(s', a) -> case k a of State n -> n s')
 299   fail str      = State (\s -> fail str)
 300
 301 class (Monad m, Monad (t m)) => MonadT t m where
 302   lift :: m a -> t m a
 303
 304 instance Monad m => MonadT (State s) m where
 305   lift m        = State (\s -> m >>= \a -> return (s, a))
 306
 307 runState :: (Monad m) => s -> State s m a -> m a
 308 runState s (State m) = m s >>= return . snd
 309
 310 type PtrIO = State (Ptr Word8) IO
 311
 312 advance :: Storable a => PtrIO (Ptr a)
 313 advance = State adv where
 314     adv addr = case castPtr addr of { addrCast -> return
 315         (addr `plusPtr` sizeOfPointee addrCast, addrCast) }
 316
 317 sizeOfPointee :: (Storable a) => Ptr a -> Int
 318 sizeOfPointee addr = sizeOf (typeHack addr)
 319     where typeHack = undefined :: Ptr a -> a
 320
 321 store :: Storable a => a -> PtrIO ()
 322 store x = do addr <- advance
 323              lift (poke addr x)
 324
 325 load :: Storable a => PtrIO a
 326 load = do addr <- advance
 327           lift (peek addr)
 328
 329 \end{code}