9b22ec8cd6141da5e264491664a246d4afe4885d
[ghc.git] / compiler / ghci / ByteCodeItbls.lhs
1 %
2 % (c) The University of Glasgow 2000-2006
3 %
4 ByteCodeItbls: Generate infotables for interpreter-made bytecodes
5
6 \begin{code}
7 {-# OPTIONS -optc-DNON_POSIX_SOURCE #-}
8
9 #ifndef GHCI_TABLES_NEXT_TO_CODE
10 {-# OPTIONS_GHC -Wwarn #-}
11 -- There are lots of warnings when GHCI_TABLES_NEXT_TO_CODE is off.
12 -- It would be nice to fix this properly, but for now we turn -Werror
13 -- off.
14 #endif
15
16 module ByteCodeItbls ( ItblEnv, ItblPtr(..), itblCode, mkITbls
17                      , StgInfoTable(..)
18                      , State(..), runState, evalState, execState, MonadT(..)
19                      ) where
20
21 #include "HsVersions.h"
22
23 import DynFlags
24 import Name             ( Name, getName )
25 import NameEnv
26 import ClosureInfo
27 import DataCon          ( DataCon, dataConRepArgTys, dataConIdentity )
28 import TyCon            ( TyCon, tyConFamilySize, isDataTyCon, tyConDataCons )
29 import Type             ( flattenRepType, repType )
30 import Constants        ( mIN_PAYLOAD_SIZE, wORD_SIZE )
31 import CgHeapery        ( mkVirtHeapOffsets )
32 import Util
33
34 import Foreign
35 import Foreign.C
36
37 import Control.Monad    ( liftM )
38
39 import GHC.Exts         ( Int(I#), addr2Int# )
40 import GHC.Ptr          ( Ptr(..) )
41 \end{code}
42
43 %************************************************************************
44 %*                                                                      *
45 \subsection{Manufacturing of info tables for DataCons}
46 %*                                                                      *
47 %************************************************************************
48
49 \begin{code}
50 newtype ItblPtr = ItblPtr (Ptr ()) deriving Show
51
52 itblCode :: ItblPtr -> Ptr ()
53 itblCode (ItblPtr ptr)
54  | ghciTablesNextToCode = castPtr ptr `plusPtr` conInfoTableSizeB
55  | otherwise            = castPtr ptr
56
57 -- XXX bogus
58 conInfoTableSizeB :: Int
59 conInfoTableSizeB = 3 * wORD_SIZE
60
61 type ItblEnv = NameEnv (Name, ItblPtr)
62         -- We need the Name in the range so we know which
63         -- elements to filter out when unloading a module
64
65 mkItblEnv :: [(Name,ItblPtr)] -> ItblEnv
66 mkItblEnv pairs = mkNameEnv [(n, (n,p)) | (n,p) <- pairs]
67
68
69 -- Make info tables for the data decls in this module
70 mkITbls :: DynFlags -> [TyCon] -> IO ItblEnv
71 mkITbls _ [] = return emptyNameEnv
72 mkITbls dflags (tc:tcs) = do itbls  <- mkITbl dflags tc
73                              itbls2 <- mkITbls dflags tcs
74                              return (itbls `plusNameEnv` itbls2)
75
76 mkITbl :: DynFlags -> TyCon -> IO ItblEnv
77 mkITbl dflags tc
78    | not (isDataTyCon tc) 
79    = return emptyNameEnv
80    | dcs `lengthIs` n -- paranoia; this is an assertion.
81    = make_constr_itbls dflags dcs
82      where
83         dcs = tyConDataCons tc
84         n   = tyConFamilySize tc
85
86 mkITbl _ _ = error "Unmatched patter in mkITbl: assertion failed!"
87
88 #include "../includes/rts/storage/ClosureTypes.h"
89 cONSTR :: Int   -- Defined in ClosureTypes.h
90 cONSTR = CONSTR 
91
92 -- Assumes constructors are numbered from zero, not one
93 make_constr_itbls :: DynFlags -> [DataCon] -> IO ItblEnv
94 make_constr_itbls dflags cons
95    = do is <- mapM mk_dirret_itbl (zip cons [0..])
96         return (mkItblEnv is)
97      where
98         mk_dirret_itbl (dcon, conNo)
99            = mk_itbl dcon conNo stg_interp_constr_entry
100
101         mk_itbl :: DataCon -> Int -> Ptr () -> IO (Name,ItblPtr)
102         mk_itbl dcon conNo entry_addr = do
103            let rep_args = [ (typeCgRep rep_arg,rep_arg) | arg <- dataConRepArgTys dcon, rep_arg <- flattenRepType (repType arg) ]
104                (tot_wds, ptr_wds, _) = mkVirtHeapOffsets dflags False{-not a THUNK-} rep_args
105
106                ptrs'  = ptr_wds
107                nptrs' = tot_wds - ptr_wds
108                nptrs_really
109                   | ptrs' + nptrs' >= mIN_PAYLOAD_SIZE = nptrs'
110                   | otherwise = mIN_PAYLOAD_SIZE - ptrs'
111                code' = mkJumpToAddr entry_addr
112                itbl  = StgInfoTable {
113 #ifndef GHCI_TABLES_NEXT_TO_CODE
114                            entry = entry_addr,
115 #endif
116                            ptrs  = fromIntegral ptrs', 
117                            nptrs = fromIntegral nptrs_really,
118                            tipe  = fromIntegral cONSTR,
119                            srtlen = fromIntegral conNo
120 #ifdef GHCI_TABLES_NEXT_TO_CODE
121                          , code  = code'
122 #endif
123                         }
124            qNameCString <- newArray0 0 $ dataConIdentity dcon 
125            let conInfoTbl = StgConInfoTable {
126                                  conDesc = qNameCString,
127                                  infoTable = itbl
128                             }
129                -- Make a piece of code to jump to "entry_label".
130                -- This is the only arch-dependent bit.
131            addrCon <- newExec pokeConItbl conInfoTbl
132                     --putStrLn ("SIZE of itbl is " ++ show (sizeOf itbl))
133                     --putStrLn ("# ptrs  of itbl is " ++ show ptrs)
134                     --putStrLn ("# nptrs of itbl is " ++ show nptrs_really)
135            return (getName dcon, ItblPtr (castFunPtrToPtr addrCon))
136
137
138 -- Make code which causes a jump to the given address.  This is the
139 -- only arch-dependent bit of the itbl story.  The returned list is
140 -- itblCodeLength elements (bytes) long.
141
142 -- For sparc_TARGET_ARCH, i386_TARGET_ARCH, etc.
143 #include "nativeGen/NCG.h"
144
145 itblCodeLength :: Int
146 itblCodeLength = length (mkJumpToAddr undefined)
147
148 mkJumpToAddr :: Ptr () -> [ItblCode]
149
150 ptrToInt :: Ptr a -> Int
151 ptrToInt (Ptr a#) = I# (addr2Int# a#)
152
153 #if sparc_TARGET_ARCH
154 -- After some consideration, we'll try this, where
155 -- 0x55555555 stands in for the address to jump to.
156 -- According to includes/rts/MachRegs.h, %g3 is very
157 -- likely indeed to be baggable.
158 --
159 --   0000 07155555              sethi   %hi(0x55555555), %g3
160 --   0004 8610E155              or      %g3, %lo(0x55555555), %g3
161 --   0008 81C0C000              jmp     %g3
162 --   000c 01000000              nop
163
164 type ItblCode = Word32
165 mkJumpToAddr a
166    = let w32 = fromIntegral (ptrToInt a)
167
168          hi22, lo10 :: Word32 -> Word32
169          lo10 x = x .&. 0x3FF
170          hi22 x = (x `shiftR` 10) .&. 0x3FFFF
171
172      in  [ 0x07000000 .|. (hi22 w32),
173            0x8610E000 .|. (lo10 w32),
174            0x81C0C000,
175            0x01000000 ]
176
177 #elif powerpc_TARGET_ARCH
178 -- We'll use r12, for no particular reason.
179 -- 0xDEADBEEF stands for the adress:
180 -- 3D80DEAD lis r12,0xDEAD
181 -- 618CBEEF ori r12,r12,0xBEEF
182 -- 7D8903A6 mtctr r12
183 -- 4E800420 bctr
184
185 type ItblCode = Word32
186 mkJumpToAddr a =
187     let w32 = fromIntegral (ptrToInt a)
188         hi16 x = (x `shiftR` 16) .&. 0xFFFF
189         lo16 x = x .&. 0xFFFF
190     in  [
191         0x3D800000 .|. hi16 w32,
192         0x618C0000 .|. lo16 w32,
193         0x7D8903A6, 0x4E800420
194         ]
195
196 #elif i386_TARGET_ARCH
197 -- Let the address to jump to be 0xWWXXYYZZ.
198 -- Generate   movl $0xWWXXYYZZ,%eax  ;  jmp *%eax
199 -- which is
200 -- B8 ZZ YY XX WW FF E0
201
202 type ItblCode = Word8
203 mkJumpToAddr a
204    = let w32 = fromIntegral (ptrToInt a) :: Word32
205          insnBytes :: [Word8]
206          insnBytes
207             = [0xB8, byte0 w32, byte1 w32, 
208                      byte2 w32, byte3 w32, 
209                0xFF, 0xE0]
210      in
211          insnBytes
212
213 #elif x86_64_TARGET_ARCH
214 -- Generates:
215 --      jmpq *.L1(%rip)
216 --      .align 8
217 -- .L1: 
218 --      .quad <addr>
219 --
220 -- We need a full 64-bit pointer (we can't assume the info table is
221 -- allocated in low memory).  Assuming the info pointer is aligned to
222 -- an 8-byte boundary, the addr will also be aligned.
223
224 type ItblCode = Word8
225 mkJumpToAddr a
226    = let w64 = fromIntegral (ptrToInt a) :: Word64
227          insnBytes :: [Word8]
228          insnBytes
229             = [0xff, 0x25, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00,
230                byte0 w64, byte1 w64, byte2 w64, byte3 w64,
231                byte4 w64, byte5 w64, byte6 w64, byte7 w64]
232      in
233          insnBytes
234
235 #elif alpha_TARGET_ARCH
236 type ItblCode = Word32
237 mkJumpToAddr a
238     = [ 0xc3800000      -- br   at, .+4
239       , 0xa79c000c      -- ldq  at, 12(at)
240       , 0x6bfc0000      -- jmp  (at)    # with zero hint -- oh well
241       , 0x47ff041f      -- nop
242       , fromIntegral (w64 .&. 0x0000FFFF)
243       , fromIntegral ((w64 `shiftR` 32) .&. 0x0000FFFF) ]
244     where w64 = fromIntegral (ptrToInt a) :: Word64
245
246 #else
247 type ItblCode = Word32
248 mkJumpToAddr a
249     = undefined
250 #endif
251
252 #if defined(i386_TARGET_ARCH) || defined(x86_64_TARGET_ARCH)
253 byte0, byte1, byte2, byte3 :: (Integral w, Bits w) => w -> Word8
254 byte0 w = fromIntegral w
255 byte1 w = fromIntegral (w `shiftR` 8)
256 byte2 w = fromIntegral (w `shiftR` 16)
257 byte3 w = fromIntegral (w `shiftR` 24)
258 #endif
259
260 #if defined(x86_64_TARGET_ARCH)
261 byte4, byte5, byte6, byte7 :: (Integral w, Bits w) => w -> Word8
262 byte4 w = fromIntegral (w `shiftR` 32)
263 byte5 w = fromIntegral (w `shiftR` 40)
264 byte6 w = fromIntegral (w `shiftR` 48)
265 byte7 w = fromIntegral (w `shiftR` 56)
266 #endif
267
268 #ifndef __HADDOCK__
269 -- entry point for direct returns for created constr itbls
270 foreign import ccall "&stg_interp_constr_entry" stg_interp_constr_entry :: Ptr ()
271 #endif
272
273
274
275
276 -- Ultra-minimalist version specially for constructors
277 #if SIZEOF_VOID_P == 8
278 type HalfWord = Word32
279 #else
280 type HalfWord = Word16
281 #endif
282
283 data StgConInfoTable = StgConInfoTable {
284    conDesc   :: Ptr Word8,
285    infoTable :: StgInfoTable
286 }
287
288 instance Storable StgConInfoTable where
289    sizeOf conInfoTable    
290       = sum [ sizeOf (conDesc conInfoTable)
291             , sizeOf (infoTable conInfoTable) ]
292    alignment _ = SIZEOF_VOID_P
293    peek ptr 
294       = evalState (castPtr ptr) $ do
295 #ifdef GHCI_TABLES_NEXT_TO_CODE
296            desc <- load
297 #endif
298            itbl <- load
299 #ifndef GHCI_TABLES_NEXT_TO_CODE
300            desc <- load
301 #endif
302            return  
303               StgConInfoTable 
304               { 
305 #ifdef GHCI_TABLES_NEXT_TO_CODE
306                 conDesc   = castPtr $ ptr `plusPtr` conInfoTableSizeB `plusPtr` desc
307 #else
308                 conDesc   = desc
309 #endif
310               , infoTable = itbl
311               }
312    poke = error "poke(StgConInfoTable): use pokeConItbl instead"
313
314
315 pokeConItbl :: Ptr StgConInfoTable -> Ptr StgConInfoTable -> StgConInfoTable
316             -> IO ()
317 pokeConItbl wr_ptr ex_ptr itbl 
318       = evalState (castPtr wr_ptr) $ do
319 #ifdef GHCI_TABLES_NEXT_TO_CODE
320            store (conDesc itbl `minusPtr` (ex_ptr `plusPtr` conInfoTableSizeB))
321 #endif
322            store (infoTable itbl)
323 #ifndef GHCI_TABLES_NEXT_TO_CODE
324            store (conDesc itbl)
325 #endif
326
327 data StgInfoTable = StgInfoTable {
328 #ifndef GHCI_TABLES_NEXT_TO_CODE
329    entry  :: Ptr (),
330 #endif
331    ptrs   :: HalfWord,
332    nptrs  :: HalfWord,
333    tipe   :: HalfWord,
334    srtlen :: HalfWord
335 #ifdef GHCI_TABLES_NEXT_TO_CODE
336  , code   :: [ItblCode]
337 #endif
338   }
339
340 instance Storable StgInfoTable where
341
342    sizeOf itbl 
343       = sum
344         [
345 #ifndef GHCI_TABLES_NEXT_TO_CODE
346          fieldSz entry itbl,
347 #endif
348          fieldSz ptrs itbl,
349          fieldSz nptrs itbl,
350          fieldSz tipe itbl,
351          fieldSz srtlen itbl
352 #ifdef GHCI_TABLES_NEXT_TO_CODE
353         ,fieldSz (head.code) itbl * itblCodeLength
354 #endif
355         ]
356
357    alignment _ 
358       = SIZEOF_VOID_P
359
360    poke a0 itbl
361       = evalState (castPtr a0)
362       $ do
363 #ifndef GHCI_TABLES_NEXT_TO_CODE
364            store (entry  itbl)
365 #endif
366            store (ptrs   itbl)
367            store (nptrs  itbl)
368            store (tipe   itbl)
369            store (srtlen itbl)
370 #ifdef GHCI_TABLES_NEXT_TO_CODE
371            sequence_ (map store (code itbl))
372 #endif
373
374    peek a0
375       = evalState (castPtr a0)
376       $ do
377 #ifndef GHCI_TABLES_NEXT_TO_CODE
378            entry'  <- load
379 #endif
380            ptrs'   <- load
381            nptrs'  <- load
382            tipe'   <- load
383            srtlen' <- load
384 #ifdef GHCI_TABLES_NEXT_TO_CODE
385            code'   <- sequence (replicate itblCodeLength load)
386 #endif
387            return 
388               StgInfoTable { 
389 #ifndef GHCI_TABLES_NEXT_TO_CODE
390                  entry  = entry',
391 #endif
392                  ptrs   = ptrs',
393                  nptrs  = nptrs',
394                  tipe   = tipe',
395                  srtlen = srtlen'
396 #ifdef GHCI_TABLES_NEXT_TO_CODE
397                 ,code   = code'
398 #endif
399               }
400
401 fieldSz :: (Storable a, Storable b) => (a -> b) -> a -> Int
402 fieldSz sel x = sizeOf (sel x)
403
404 newtype State s m a = State (s -> m (s, a))
405
406 instance Monad m => Monad (State s m) where
407   return a      = State (\s -> return (s, a))
408   State m >>= k = State (\s -> m s >>= \(s', a) -> case k a of State n -> n s')
409   fail str      = State (\_ -> fail str)
410
411 class (Monad m, Monad (t m)) => MonadT t m where
412   lift :: m a -> t m a
413
414 instance Monad m => MonadT (State s) m where
415   lift m        = State (\s -> m >>= \a -> return (s, a))
416
417 runState :: Monad m => s -> State s m a -> m (s, a)
418 runState s (State m) = m s
419
420 evalState :: Monad m => s -> State s m a -> m a
421 evalState s m = liftM snd (runState s m)
422
423 execState :: Monad m => s -> State s m a -> m s
424 execState s m = liftM fst (runState s m)
425
426 type PtrIO = State (Ptr Word8) IO
427
428 advance :: Storable a => PtrIO (Ptr a)
429 advance = State adv where
430     adv addr = case castPtr addr of { addrCast -> return
431         (addr `plusPtr` sizeOfPointee addrCast, addrCast) }
432
433 sizeOfPointee :: (Storable a) => Ptr a -> Int
434 sizeOfPointee addr = sizeOf (typeHack addr)
435     where typeHack = undefined :: Ptr a -> a
436
437 store :: Storable a => a -> PtrIO ()
438 store x = do addr <- advance
439              lift (poke addr x)
440
441 load :: Storable a => PtrIO a
442 load = do addr <- advance
443           lift (peek addr)
444
445
446 newExec :: Storable a => (Ptr a -> Ptr a -> a -> IO ()) -> a -> IO (FunPtr ())
447 newExec poke_fn obj
448    = alloca $ \pcode -> do
449         wr_ptr <- _allocateExec (fromIntegral (sizeOf obj)) pcode
450         ex_ptr <- peek pcode
451         poke_fn wr_ptr ex_ptr obj
452         return (castPtrToFunPtr ex_ptr)
453
454 foreign import ccall unsafe "allocateExec"
455   _allocateExec :: CUInt -> Ptr (Ptr a) -> IO (Ptr a)  
456 \end{code}