2 % (c) The University of Glasgow 2002-2006
5 ByteCodeLink: Bytecode assembler and linker
8 {-# OPTIONS -optc-DNON_POSIX_SOURCE #-}
11 assembleBCOs, assembleBCO,
14 UnlinkedBCO(..), BCOPtr(..), BCONPtr(..), bcoFreeNames,
15 SizedSeq, sizeSS, ssElts,
16 iNTERP_STACK_CHECK_THRESH
19 #include "HsVersions.h"
36 import Control.Monad ( foldM )
37 import Control.Monad.ST ( runST )
39 import GHC.Word ( Word(..) )
40 import Data.Array.MArray
41 import Data.Array.Unboxed ( listArray )
42 import Data.Array.Base ( UArray(..) )
43 import Data.Array.ST ( castSTUArray )
44 import Foreign ( Word16, free )
46 import Data.Int ( Int64 )
47 import Data.Char ( ord )
49 import GHC.Base ( ByteArray# )
50 import GHC.IOBase ( IO(..) )
51 import GHC.Ptr ( Ptr(..) )
53 -- -----------------------------------------------------------------------------
56 -- CompiledByteCode represents the result of byte-code
57 -- compiling a bunch of functions and data types
60 = ByteCode [UnlinkedBCO] -- Bunch of interpretable bindings
61 ItblEnv -- A mapping from DataCons to their itbls
63 instance Outputable CompiledByteCode where
64 ppr (ByteCode bcos _) = ppr bcos
69 unlinkedBCOName :: Name,
70 unlinkedBCOArity :: Int,
71 unlinkedBCOInstrs :: ByteArray#, -- insns
72 unlinkedBCOBitmap :: ByteArray#, -- bitmap
73 unlinkedBCOLits :: (SizedSeq BCONPtr), -- non-ptrs
74 unlinkedBCOPtrs :: (SizedSeq BCOPtr) -- ptrs
80 | BCOPtrBCO UnlinkedBCO
84 | BCONPtrLbl FastString
87 -- | Finds external references. Remember to remove the names
88 -- defined by this group of BCOs themselves
89 bcoFreeNames :: UnlinkedBCO -> NameSet
91 = bco_refs bco `minusNameSet` mkNameSet [unlinkedBCOName bco]
93 bco_refs (UnlinkedBCO _ _ _ _ nonptrs ptrs)
95 mkNameSet [ n | BCOPtrName n <- ssElts ptrs ] :
96 mkNameSet [ n | BCONPtrItbl n <- ssElts nonptrs ] :
97 map bco_refs [ bco | BCOPtrBCO bco <- ssElts ptrs ]
100 instance Outputable UnlinkedBCO where
101 ppr (UnlinkedBCO nm arity insns bitmap lits ptrs)
102 = sep [text "BCO", ppr nm, text "with",
103 int (sizeSS lits), text "lits",
104 int (sizeSS ptrs), text "ptrs" ]
106 -- -----------------------------------------------------------------------------
107 -- The bytecode assembler
109 -- The object format for bytecodes is: 16 bits for the opcode, and 16
110 -- for each field -- so the code can be considered a sequence of
111 -- 16-bit ints. Each field denotes either a stack offset or number of
112 -- items on the stack (eg SLIDE), and index into the pointer table (eg
113 -- PUSH_G), an index into the literal table (eg PUSH_I/D/L), or a
114 -- bytecode address in this BCO.
116 -- Top level assembler fn.
117 assembleBCOs :: [ProtoBCO Name] -> [TyCon] -> IO CompiledByteCode
118 assembleBCOs proto_bcos tycons
119 = do itblenv <- mkITbls tycons
120 bcos <- mapM assembleBCO proto_bcos
121 return (ByteCode bcos itblenv)
123 assembleBCO :: ProtoBCO Name -> IO UnlinkedBCO
124 assembleBCO (ProtoBCO nm instrs bitmap bsize arity origin malloced)
126 -- pass 1: collect up the offsets of the local labels.
127 -- Remember that the first insn starts at offset 1 since offset 0
128 -- (eventually) will hold the total # of insns.
129 label_env = mkLabelEnv emptyFM 1 instrs
131 mkLabelEnv env i_offset [] = env
132 mkLabelEnv env i_offset (i:is)
134 = case i of LABEL n -> addToFM env n i_offset ; _ -> env
135 in mkLabelEnv new_env (i_offset + instrSize16s i) is
138 = case lookupFM label_env lab of
139 Just bco_offset -> bco_offset
140 Nothing -> pprPanic "assembleBCO.findLabel" (int lab)
142 do -- pass 2: generate the instruction, ptr and nonptr bits
143 insns <- return emptySS :: IO (SizedSeq Word16)
144 lits <- return emptySS :: IO (SizedSeq BCONPtr)
145 ptrs <- return emptySS :: IO (SizedSeq BCOPtr)
146 let init_asm_state = (insns,lits,ptrs)
147 (final_insns, final_lits, final_ptrs)
148 <- mkBits findLabel init_asm_state instrs
150 let asm_insns = ssElts final_insns
151 n_insns = sizeSS final_insns
154 | n_insns > 65535 = panic "linkBCO: >= 64k insns in BCO"
155 | otherwise = mkInstrArray n_insns asm_insns
156 insns_barr = case insns_arr of UArray _lo _hi barr -> barr
158 bitmap_arr = mkBitmapArray bsize bitmap
159 bitmap_barr = case bitmap_arr of UArray _lo _hi barr -> barr
161 let ul_bco = UnlinkedBCO nm arity insns_barr bitmap_barr final_lits
164 -- 8 Aug 01: Finalisers aren't safe when attached to non-primitive
165 -- objects, since they might get run too early. Disable this until
166 -- we figure out what to do.
167 -- when (notNull malloced) (addFinalizer ul_bco (mapM_ zonk malloced))
171 zonk ptr = do -- putStrLn ("freeing malloc'd block at " ++ show (A# a#))
174 mkBitmapArray :: Int -> [StgWord] -> UArray Int StgWord
175 mkBitmapArray bsize bitmap
176 = listArray (0, length bitmap) (fromIntegral bsize : bitmap)
178 mkInstrArray :: Int -> [Word16] -> UArray Int Word16
179 mkInstrArray n_insns asm_insns
180 = listArray (0, n_insns) (fromIntegral n_insns : asm_insns)
182 -- instrs nonptrs ptrs
183 type AsmState = (SizedSeq Word16,
187 data SizedSeq a = SizedSeq !Int [a]
188 emptySS = SizedSeq 0 []
190 -- Why are these two monadic???
191 addToSS (SizedSeq n r_xs) x = return (SizedSeq (n+1) (x:r_xs))
192 addListToSS (SizedSeq n r_xs) xs
193 = return (SizedSeq (n + length xs) (reverse xs ++ r_xs))
195 ssElts :: SizedSeq a -> [a]
196 ssElts (SizedSeq n r_xs) = reverse r_xs
198 sizeSS :: SizedSeq a -> Int
199 sizeSS (SizedSeq n r_xs) = n
201 -- Bring in all the bci_ bytecode constants.
202 #include "Bytecodes.h"
204 largeArgInstr :: Int -> Int
205 largeArgInstr bci = bci_FLAG_LARGE_ARGS .|. bci
207 largeArg :: Int -> [Int]
209 | wORD_SIZE_IN_BITS == 64
210 = [(i .&. 0xFFFF000000000000) `shiftR` 48,
211 (i .&. 0x0000FFFF00000000) `shiftR` 32,
212 (i .&. 0x00000000FFFF0000) `shiftR` 16,
213 (i .&. 0x000000000000FFFF)]
214 | wORD_SIZE_IN_BITS == 32
215 = [(i .&. 0xFFFF0000) `shiftR` 16,
217 | otherwise = error "wORD_SIZE_IN_BITS not 32 or 64?"
219 -- This is where all the action is (pass 2 of the assembler)
220 mkBits :: (Int -> Int) -- label finder
222 -> [BCInstr] -- instructions (in)
225 mkBits findLabel st proto_insns
226 = foldM doInstr st proto_insns
228 doInstr :: AsmState -> BCInstr -> IO AsmState
233 instrn st (largeArgInstr bci_STKCHECK : largeArg n)
234 | otherwise -> instr2 st bci_STKCHECK n
235 PUSH_L o1 -> instr2 st bci_PUSH_L o1
236 PUSH_LL o1 o2 -> instr3 st bci_PUSH_LL o1 o2
237 PUSH_LLL o1 o2 o3 -> instr4 st bci_PUSH_LLL o1 o2 o3
238 PUSH_G nm -> do (p, st2) <- ptr st (BCOPtrName nm)
239 instr2 st2 bci_PUSH_G p
240 PUSH_PRIMOP op -> do (p, st2) <- ptr st (BCOPtrPrimOp op)
241 instr2 st2 bci_PUSH_G p
242 PUSH_BCO proto -> do ul_bco <- assembleBCO proto
243 (p, st2) <- ptr st (BCOPtrBCO ul_bco)
244 instr2 st2 bci_PUSH_G p
245 PUSH_ALTS proto -> do ul_bco <- assembleBCO proto
246 (p, st2) <- ptr st (BCOPtrBCO ul_bco)
247 instr2 st2 bci_PUSH_ALTS p
248 PUSH_ALTS_UNLIFTED proto pk -> do
249 ul_bco <- assembleBCO proto
250 (p, st2) <- ptr st (BCOPtrBCO ul_bco)
251 instr2 st2 (push_alts pk) p
252 PUSH_UBX (Left lit) nws
253 -> do (np, st2) <- literal st lit
254 instr3 st2 bci_PUSH_UBX np nws
255 PUSH_UBX (Right aa) nws
256 -> do (np, st2) <- addr st aa
257 instr3 st2 bci_PUSH_UBX np nws
259 PUSH_APPLY_N -> do instr1 st bci_PUSH_APPLY_N
260 PUSH_APPLY_V -> do instr1 st bci_PUSH_APPLY_V
261 PUSH_APPLY_F -> do instr1 st bci_PUSH_APPLY_F
262 PUSH_APPLY_D -> do instr1 st bci_PUSH_APPLY_D
263 PUSH_APPLY_L -> do instr1 st bci_PUSH_APPLY_L
264 PUSH_APPLY_P -> do instr1 st bci_PUSH_APPLY_P
265 PUSH_APPLY_PP -> do instr1 st bci_PUSH_APPLY_PP
266 PUSH_APPLY_PPP -> do instr1 st bci_PUSH_APPLY_PPP
267 PUSH_APPLY_PPPP -> do instr1 st bci_PUSH_APPLY_PPPP
268 PUSH_APPLY_PPPPP -> do instr1 st bci_PUSH_APPLY_PPPPP
269 PUSH_APPLY_PPPPPP -> do instr1 st bci_PUSH_APPLY_PPPPPP
271 SLIDE n by -> instr3 st bci_SLIDE n by
272 ALLOC_AP n -> instr2 st bci_ALLOC_AP n
273 ALLOC_PAP arity n -> instr3 st bci_ALLOC_PAP arity n
274 MKAP off sz -> instr3 st bci_MKAP off sz
275 MKPAP off sz -> instr3 st bci_MKPAP off sz
276 UNPACK n -> instr2 st bci_UNPACK n
277 PACK dcon sz -> do (itbl_no,st2) <- itbl st dcon
278 instr3 st2 bci_PACK itbl_no sz
279 LABEL lab -> return st
280 TESTLT_I i l -> do (np, st2) <- int st i
281 instr3 st2 bci_TESTLT_I np (findLabel l)
282 TESTEQ_I i l -> do (np, st2) <- int st i
283 instr3 st2 bci_TESTEQ_I np (findLabel l)
284 TESTLT_F f l -> do (np, st2) <- float st f
285 instr3 st2 bci_TESTLT_F np (findLabel l)
286 TESTEQ_F f l -> do (np, st2) <- float st f
287 instr3 st2 bci_TESTEQ_F np (findLabel l)
288 TESTLT_D d l -> do (np, st2) <- double st d
289 instr3 st2 bci_TESTLT_D np (findLabel l)
290 TESTEQ_D d l -> do (np, st2) <- double st d
291 instr3 st2 bci_TESTEQ_D np (findLabel l)
292 TESTLT_P i l -> instr3 st bci_TESTLT_P i (findLabel l)
293 TESTEQ_P i l -> instr3 st bci_TESTEQ_P i (findLabel l)
294 CASEFAIL -> instr1 st bci_CASEFAIL
295 SWIZZLE stkoff n -> instr3 st bci_SWIZZLE stkoff n
296 JMP l -> instr2 st bci_JMP (findLabel l)
297 ENTER -> instr1 st bci_ENTER
298 RETURN -> instr1 st bci_RETURN
299 RETURN_UBX rep -> instr1 st (return_ubx rep)
300 CCALL off m_addr -> do (np, st2) <- addr st m_addr
301 instr3 st2 bci_CCALL off np
306 instrn :: AsmState -> [Int] -> IO AsmState
307 instrn st [] = return st
308 instrn (st_i, st_l, st_p) (i:is)
309 = do st_i' <- addToSS st_i (i2s i)
310 instrn (st_i', st_l, st_p) is
312 instr1 (st_i0,st_l0,st_p0) i1
313 = do st_i1 <- addToSS st_i0 i1
314 return (st_i1,st_l0,st_p0)
316 instr2 (st_i0,st_l0,st_p0) i1 i2
317 = do st_i1 <- addToSS st_i0 (i2s i1)
318 st_i2 <- addToSS st_i1 (i2s i2)
319 return (st_i2,st_l0,st_p0)
321 instr3 (st_i0,st_l0,st_p0) i1 i2 i3
322 = do st_i1 <- addToSS st_i0 (i2s i1)
323 st_i2 <- addToSS st_i1 (i2s i2)
324 st_i3 <- addToSS st_i2 (i2s i3)
325 return (st_i3,st_l0,st_p0)
327 instr4 (st_i0,st_l0,st_p0) i1 i2 i3 i4
328 = do st_i1 <- addToSS st_i0 (i2s i1)
329 st_i2 <- addToSS st_i1 (i2s i2)
330 st_i3 <- addToSS st_i2 (i2s i3)
331 st_i4 <- addToSS st_i3 (i2s i4)
332 return (st_i4,st_l0,st_p0)
334 float (st_i0,st_l0,st_p0) f
335 = do let ws = mkLitF f
336 st_l1 <- addListToSS st_l0 (map BCONPtrWord ws)
337 return (sizeSS st_l0, (st_i0,st_l1,st_p0))
339 double (st_i0,st_l0,st_p0) d
340 = do let ws = mkLitD d
341 st_l1 <- addListToSS st_l0 (map BCONPtrWord ws)
342 return (sizeSS st_l0, (st_i0,st_l1,st_p0))
344 int (st_i0,st_l0,st_p0) i
345 = do let ws = mkLitI i
346 st_l1 <- addListToSS st_l0 (map BCONPtrWord ws)
347 return (sizeSS st_l0, (st_i0,st_l1,st_p0))
349 int64 (st_i0,st_l0,st_p0) i
350 = do let ws = mkLitI64 i
351 st_l1 <- addListToSS st_l0 (map BCONPtrWord ws)
352 return (sizeSS st_l0, (st_i0,st_l1,st_p0))
354 addr (st_i0,st_l0,st_p0) a
355 = do let ws = mkLitPtr a
356 st_l1 <- addListToSS st_l0 (map BCONPtrWord ws)
357 return (sizeSS st_l0, (st_i0,st_l1,st_p0))
359 litlabel (st_i0,st_l0,st_p0) fs
360 = do st_l1 <- addListToSS st_l0 [BCONPtrLbl fs]
361 return (sizeSS st_l0, (st_i0,st_l1,st_p0))
363 ptr (st_i0,st_l0,st_p0) p
364 = do st_p1 <- addToSS st_p0 p
365 return (sizeSS st_p0, (st_i0,st_l0,st_p1))
367 itbl (st_i0,st_l0,st_p0) dcon
368 = do st_l1 <- addToSS st_l0 (BCONPtrItbl (getName dcon))
369 return (sizeSS st_l0, (st_i0,st_l1,st_p0))
371 #ifdef mingw32_TARGET_OS
372 literal st (MachLabel fs (Just sz))
373 = litlabel st (appendFS fs (mkFastString ('@':show sz)))
374 -- On Windows, stdcall labels have a suffix indicating the no. of
375 -- arg words, e.g. foo@8. testcase: ffi012(ghci)
377 literal st (MachLabel fs _) = litlabel st fs
378 literal st (MachWord w) = int st (fromIntegral w)
379 literal st (MachInt j) = int st (fromIntegral j)
380 literal st (MachFloat r) = float st (fromRational r)
381 literal st (MachDouble r) = double st (fromRational r)
382 literal st (MachChar c) = int st (ord c)
383 literal st (MachInt64 ii) = int64 st (fromIntegral ii)
384 literal st (MachWord64 ii) = int64 st (fromIntegral ii)
385 literal st other = pprPanic "ByteCodeLink.literal" (ppr other)
388 push_alts NonPtrArg = bci_PUSH_ALTS_N
389 push_alts FloatArg = bci_PUSH_ALTS_F
390 push_alts DoubleArg = bci_PUSH_ALTS_D
391 push_alts VoidArg = bci_PUSH_ALTS_V
392 push_alts LongArg = bci_PUSH_ALTS_L
393 push_alts PtrArg = bci_PUSH_ALTS_P
395 return_ubx NonPtrArg = bci_RETURN_N
396 return_ubx FloatArg = bci_RETURN_F
397 return_ubx DoubleArg = bci_RETURN_D
398 return_ubx VoidArg = bci_RETURN_V
399 return_ubx LongArg = bci_RETURN_L
400 return_ubx PtrArg = bci_RETURN_P
403 -- The size in 16-bit entities of an instruction.
404 instrSize16s :: BCInstr -> Int
415 PUSH_ALTS_UNLIFTED{} -> 2
424 PUSH_APPLY_PPP{} -> 1
425 PUSH_APPLY_PPPP{} -> 1
426 PUSH_APPLY_PPPPP{} -> 1
427 PUSH_APPLY_PPPPPP{} -> 1
452 -- Make lists of host-sized words for literals, so that when the
453 -- words are placed in memory at increasing addresses, the
454 -- bit pattern is correct for the host's word size and endianness.
455 mkLitI :: Int -> [Word]
456 mkLitF :: Float -> [Word]
457 mkLitD :: Double -> [Word]
458 mkLitPtr :: Ptr () -> [Word]
459 mkLitI64 :: Int64 -> [Word]
463 arr <- newArray_ ((0::Int),0)
465 f_arr <- castSTUArray arr
466 w0 <- readArray f_arr 0
473 arr <- newArray_ ((0::Int),1)
475 d_arr <- castSTUArray arr
476 w0 <- readArray d_arr 0
477 w1 <- readArray d_arr 1
478 return [w0 :: Word, w1]
482 arr <- newArray_ ((0::Int),0)
484 d_arr <- castSTUArray arr
485 w0 <- readArray d_arr 0
492 arr <- newArray_ ((0::Int),1)
494 d_arr <- castSTUArray arr
495 w0 <- readArray d_arr 0
496 w1 <- readArray d_arr 1
497 return [w0 :: Word,w1]
501 arr <- newArray_ ((0::Int),0)
503 d_arr <- castSTUArray arr
504 w0 <- readArray d_arr 0
510 arr <- newArray_ ((0::Int),0)
512 i_arr <- castSTUArray arr
513 w0 <- readArray i_arr 0
519 arr <- newArray_ ((0::Int),0)
521 a_arr <- castSTUArray arr
522 w0 <- readArray a_arr 0
526 iNTERP_STACK_CHECK_THRESH = (INTERP_STACK_CHECK_THRESH :: Int)