2 % (c) The University of Glasgow 2000
4 \section[ByteCodeLink]{Bytecode assembler and linker}
7 module ByteCodeLink ( UnlinkedBCO, UnlinkedBCOExpr, assembleBCO,
8 ClosureEnv, HValue, filterNameMap,
9 linkIModules, linkIExpr,
10 iNTERP_STACK_CHECK_THRESH
13 #include "HsVersions.h"
16 import Name ( Name, getName, nameModule, toRdrName, isGlobalName )
17 import RdrName ( rdrNameOcc, rdrNameModule )
18 import OccName ( occNameString )
19 import FiniteMap ( FiniteMap, addListToFM, filterFM,
20 addToFM, lookupFM, emptyFM )
22 import Literal ( Literal(..) )
23 import PrimOp ( PrimOp, primOpOcc )
24 import PrimRep ( PrimRep(..) )
25 import Constants ( wORD_SIZE )
26 import Module ( ModuleName, moduleName, moduleNameFS )
27 import Linker ( lookupSymbol )
28 import FastString ( FastString(..) )
29 import ByteCodeInstr ( BCInstr(..), ProtoBCO(..) )
30 import ByteCodeItbls ( ItblEnv, ItblPtr )
33 import Monad ( when, foldM )
35 import IArray ( array )
36 import MArray ( castSTUArray,
37 newFloatArray, writeFloatArray,
38 newDoubleArray, writeDoubleArray,
39 newIntArray, writeIntArray,
40 newAddrArray, writeAddrArray,
42 import Foreign ( Word16, Ptr(..), free )
43 import Addr ( Word, Addr(..), nullAddr )
44 import Weak ( addFinalizer )
47 import PrelBase ( Int(..) )
48 import PrelGHC ( BCO#, newBCO#, unsafeCoerce#,
49 ByteArray#, Array#, addrToHValue#, mkApUpd0# )
50 import IOExts ( fixIO )
51 import PrelArr ( Array(..) )
52 import ArrayBase ( UArray(..) )
53 import PrelIOBase ( IO(..) )
57 %************************************************************************
59 \subsection{Top-level stuff}
61 %************************************************************************
65 linkIModules :: ItblEnv -- incoming global itbl env; returned updated
66 -> ClosureEnv -- incoming global closure env; returned updated
67 -> [([UnlinkedBCO], ItblEnv)]
68 -> IO ([HValue], ItblEnv, ClosureEnv)
69 linkIModules gie gce mods
70 = do let (bcoss, ies) = unzip mods
72 final_gie = foldr plusFM gie ies
73 (final_gce, linked_bcos) <- linkSomeBCOs True final_gie gce bcos
74 return (linked_bcos, final_gie, final_gce)
77 linkIExpr :: ItblEnv -> ClosureEnv -> UnlinkedBCOExpr
78 -> IO HValue -- IO BCO# really
79 linkIExpr ie ce (root_ul_bco, aux_ul_bcos)
80 = do (aux_ce, _) <- linkSomeBCOs False ie ce aux_ul_bcos
81 (_, [root_bco]) <- linkSomeBCOs False ie aux_ce [root_ul_bco]
84 -- Link a bunch of BCOs and return them + updated closure env.
85 linkSomeBCOs :: Bool -- False <=> add _all_ BCOs to returned closure env
86 -- True <=> add only toplevel BCOs to closure env
90 -> IO (ClosureEnv, [HValue])
91 linkSomeBCOs toplevs_only ie ce_in ul_bcos
92 = do let nms = map nameOfUnlinkedBCO ul_bcos
94 ( \ hvs -> let ce_out = addListToFM ce_in (zipLazily nms hvs)
95 in mapM (linkBCO ie ce_out) ul_bcos )
97 let ce_all_additions = zip nms hvals
98 ce_top_additions = filter (isGlobalName.fst) ce_all_additions
99 ce_additions = if toplevs_only then ce_top_additions
100 else ce_all_additions
101 ce_out = -- make sure we're not inserting duplicate names into the
102 -- closure environment, which leads to trouble.
103 ASSERT (all (not . (`elemFM` ce_in)) (map fst ce_additions))
104 addListToFM ce_in ce_additions
105 return (ce_out, hvals)
107 -- A lazier zip, in which no demand is propagated to the second
108 -- list unless some demand is propagated to the snd of one of the
109 -- result list elems.
111 zipLazily (x:xs) ys = (x, head ys) : zipLazily xs (tail ys)
116 (SizedSeq Word16) -- insns
117 (SizedSeq Word) -- literals
118 (SizedSeq (Either Name PrimOp)) -- ptrs
119 (SizedSeq Name) -- itbl refs
121 nameOfUnlinkedBCO (UnlinkedBCO nm _ _ _ _) = nm
123 -- When translating expressions, we need to distinguish the root
124 -- BCO for the expression
125 type UnlinkedBCOExpr = (UnlinkedBCO, [UnlinkedBCO])
127 instance Outputable UnlinkedBCO where
128 ppr (UnlinkedBCO nm insns lits ptrs itbls)
129 = sep [text "BCO", ppr nm, text "with",
130 int (sizeSS insns), text "insns",
131 int (sizeSS lits), text "lits",
132 int (sizeSS ptrs), text "ptrs",
133 int (sizeSS itbls), text "itbls"]
136 -- these need a proper home
137 type ClosureEnv = FiniteMap Name HValue
138 data HValue = HValue -- dummy type, actually a pointer to some Real Code.
140 -- remove all entries for a given set of modules from the environment;
141 -- note that this removes all local names too (ie. temporary bindings from
142 -- the command line).
143 filterNameMap :: [ModuleName] -> FiniteMap Name a -> FiniteMap Name a
144 filterNameMap mods env
145 = filterFM (\n _ -> isGlobalName n &&
146 moduleName (nameModule n) `elem` mods) env
149 %************************************************************************
151 \subsection{The bytecode assembler}
153 %************************************************************************
155 The object format for bytecodes is: 16 bits for the opcode, and 16 for
156 each field -- so the code can be considered a sequence of 16-bit ints.
157 Each field denotes either a stack offset or number of items on the
158 stack (eg SLIDE), and index into the pointer table (eg PUSH_G), an
159 index into the literal table (eg PUSH_I/D/L), or a bytecode address in
163 -- Top level assembler fn.
164 assembleBCO :: ProtoBCO Name -> IO UnlinkedBCO
166 assembleBCO (ProtoBCO nm instrs origin malloced)
168 -- pass 1: collect up the offsets of the local labels.
169 -- Remember that the first insn starts at offset 1 since offset 0
170 -- (eventually) will hold the total # of insns.
171 label_env = mkLabelEnv emptyFM 1 instrs
173 mkLabelEnv env i_offset [] = env
174 mkLabelEnv env i_offset (i:is)
176 = case i of LABEL n -> addToFM env n i_offset ; _ -> env
177 in mkLabelEnv new_env (i_offset + instrSize16s i) is
180 = case lookupFM label_env lab of
181 Just bco_offset -> bco_offset
182 Nothing -> pprPanic "assembleBCO.findLabel" (int lab)
184 do -- pass 2: generate the instruction, ptr and nonptr bits
185 insns <- return emptySS :: IO (SizedSeq Word16)
186 lits <- return emptySS :: IO (SizedSeq Word)
187 ptrs <- return emptySS :: IO (SizedSeq (Either Name PrimOp))
188 itbls <- return emptySS :: IO (SizedSeq Name)
189 let init_asm_state = (insns,lits,ptrs,itbls)
190 (final_insns, final_lits, final_ptrs, final_itbls)
191 <- mkBits findLabel init_asm_state instrs
193 let ul_bco = UnlinkedBCO nm final_insns final_lits final_ptrs final_itbls
195 -- 8 Aug 01: Finalisers aren't safe when attached to non-primitive
196 -- objects, since they might get run too early. Disable this until
197 -- we figure out what to do.
198 -- when (not (null malloced)) (addFinalizer ul_bco (mapM_ zonk malloced))
202 zonk (A# a#) = do -- putStrLn ("freeing malloc'd block at " ++ show (A# a#))
205 -- instrs nonptrs ptrs itbls
206 type AsmState = (SizedSeq Word16, SizedSeq Word,
207 SizedSeq (Either Name PrimOp), SizedSeq Name)
209 data SizedSeq a = SizedSeq !Int [a]
210 emptySS = SizedSeq 0 []
211 addToSS (SizedSeq n r_xs) x = return (SizedSeq (n+1) (x:r_xs))
212 addListToSS (SizedSeq n r_xs) xs
213 = return (SizedSeq (n + length xs) (reverse xs ++ r_xs))
214 sizeSS (SizedSeq n r_xs) = n
215 listFromSS (SizedSeq n r_xs) = return (reverse r_xs)
218 -- This is where all the action is (pass 2 of the assembler)
219 mkBits :: (Int -> Int) -- label finder
221 -> [BCInstr] -- instructions (in)
224 mkBits findLabel st proto_insns
225 = foldM doInstr st proto_insns
227 doInstr :: AsmState -> BCInstr -> IO AsmState
230 SWIZZLE stkoff n -> instr3 st i_SWIZZLE stkoff n
231 ARGCHECK n -> instr2 st i_ARGCHECK n
232 STKCHECK n -> instr2 st i_STKCHECK n
233 PUSH_L o1 -> instr2 st i_PUSH_L o1
234 PUSH_LL o1 o2 -> instr3 st i_PUSH_LL o1 o2
235 PUSH_LLL o1 o2 o3 -> instr4 st i_PUSH_LLL o1 o2 o3
236 PUSH_G nm -> do (p, st2) <- ptr st nm
237 instr2 st2 i_PUSH_G p
238 PUSH_AS nm pk -> do (p, st2) <- ptr st (Left nm)
239 (np, st3) <- ctoi_itbl st2 pk
240 instr3 st3 i_PUSH_AS p np
241 PUSH_UBX (Left lit) nws
242 -> do (np, st2) <- literal st lit
243 instr3 st2 i_PUSH_UBX np nws
244 PUSH_UBX (Right aa) nws
245 -> do (np, st2) <- addr st aa
246 instr3 st2 i_PUSH_UBX np nws
248 PUSH_TAG tag -> instr2 st i_PUSH_TAG tag
249 SLIDE n by -> instr3 st i_SLIDE n by
250 ALLOC n -> instr2 st i_ALLOC n
251 MKAP off sz -> instr3 st i_MKAP off sz
252 UNPACK n -> instr2 st i_UNPACK n
253 UPK_TAG n m k -> instr4 st i_UPK_TAG n m k
254 PACK dcon sz -> do (itbl_no,st2) <- itbl st dcon
255 instr3 st2 i_PACK itbl_no sz
256 LABEL lab -> return st
257 TESTLT_I i l -> do (np, st2) <- int st i
258 instr3 st2 i_TESTLT_I np (findLabel l)
259 TESTEQ_I i l -> do (np, st2) <- int st i
260 instr3 st2 i_TESTEQ_I np (findLabel l)
261 TESTLT_F f l -> do (np, st2) <- float st f
262 instr3 st2 i_TESTLT_F np (findLabel l)
263 TESTEQ_F f l -> do (np, st2) <- float st f
264 instr3 st2 i_TESTEQ_F np (findLabel l)
265 TESTLT_D d l -> do (np, st2) <- double st d
266 instr3 st2 i_TESTLT_D np (findLabel l)
267 TESTEQ_D d l -> do (np, st2) <- double st d
268 instr3 st2 i_TESTEQ_D np (findLabel l)
269 TESTLT_P i l -> instr3 st i_TESTLT_P i (findLabel l)
270 TESTEQ_P i l -> instr3 st i_TESTEQ_P i (findLabel l)
271 CASEFAIL -> instr1 st i_CASEFAIL
272 JMP l -> instr2 st i_JMP (findLabel l)
273 ENTER -> instr1 st i_ENTER
274 RETURN rep -> do (itbl_no,st2) <- itoc_itbl st rep
275 instr2 st2 i_RETURN itbl_no
276 CCALL m_addr -> do (np, st2) <- addr st m_addr
277 instr2 st2 i_CCALL np
282 instr1 (st_i0,st_l0,st_p0,st_I0) i1
283 = do st_i1 <- addToSS st_i0 (i2s i1)
284 return (st_i1,st_l0,st_p0,st_I0)
286 instr2 (st_i0,st_l0,st_p0,st_I0) i1 i2
287 = do st_i1 <- addToSS st_i0 (i2s i1)
288 st_i2 <- addToSS st_i1 (i2s i2)
289 return (st_i2,st_l0,st_p0,st_I0)
291 instr3 (st_i0,st_l0,st_p0,st_I0) i1 i2 i3
292 = do st_i1 <- addToSS st_i0 (i2s i1)
293 st_i2 <- addToSS st_i1 (i2s i2)
294 st_i3 <- addToSS st_i2 (i2s i3)
295 return (st_i3,st_l0,st_p0,st_I0)
297 instr4 (st_i0,st_l0,st_p0,st_I0) i1 i2 i3 i4
298 = do st_i1 <- addToSS st_i0 (i2s i1)
299 st_i2 <- addToSS st_i1 (i2s i2)
300 st_i3 <- addToSS st_i2 (i2s i3)
301 st_i4 <- addToSS st_i3 (i2s i4)
302 return (st_i4,st_l0,st_p0,st_I0)
304 float (st_i0,st_l0,st_p0,st_I0) f
305 = do let ws = mkLitF f
306 st_l1 <- addListToSS st_l0 ws
307 return (sizeSS st_l0, (st_i0,st_l1,st_p0,st_I0))
309 double (st_i0,st_l0,st_p0,st_I0) d
310 = do let ws = mkLitD d
311 st_l1 <- addListToSS st_l0 ws
312 return (sizeSS st_l0, (st_i0,st_l1,st_p0,st_I0))
314 int (st_i0,st_l0,st_p0,st_I0) i
315 = do let ws = mkLitI i
316 st_l1 <- addListToSS st_l0 ws
317 return (sizeSS st_l0, (st_i0,st_l1,st_p0,st_I0))
319 addr (st_i0,st_l0,st_p0,st_I0) a
320 = do let ws = mkLitA a
321 st_l1 <- addListToSS st_l0 ws
322 return (sizeSS st_l0, (st_i0,st_l1,st_p0,st_I0))
324 ptr (st_i0,st_l0,st_p0,st_I0) p
325 = do st_p1 <- addToSS st_p0 p
326 return (sizeSS st_p0, (st_i0,st_l0,st_p1,st_I0))
328 itbl (st_i0,st_l0,st_p0,st_I0) dcon
329 = do st_I1 <- addToSS st_I0 (getName dcon)
330 return (sizeSS st_I0, (st_i0,st_l0,st_p0,st_I1))
332 literal st (MachWord w) = int st (fromIntegral w)
333 literal st (MachInt j) = int st (fromIntegral j)
334 literal st (MachFloat r) = float st (fromRational r)
335 literal st (MachDouble r) = double st (fromRational r)
336 literal st (MachChar c) = int st c
337 literal st other = pprPanic "ByteCodeLink.literal" (ppr other)
340 = addr st ret_itbl_addr
344 PtrRep -> stg_ctoi_ret_R1p_info
345 WordRep -> stg_ctoi_ret_R1n_info
346 IntRep -> stg_ctoi_ret_R1n_info
347 AddrRep -> stg_ctoi_ret_R1n_info
348 CharRep -> stg_ctoi_ret_R1n_info
349 FloatRep -> stg_ctoi_ret_F1_info
350 DoubleRep -> stg_ctoi_ret_D1_info
351 VoidRep -> stg_ctoi_ret_V_info
352 other -> pprPanic "ByteCodeLink.ctoi_itbl" (ppr pk)
355 = addr st ret_itbl_addr
359 CharRep -> stg_gc_unbx_r1_ret_info
360 IntRep -> stg_gc_unbx_r1_ret_info
361 AddrRep -> stg_gc_unbx_r1_ret_info
362 FloatRep -> stg_gc_f1_ret_info
363 DoubleRep -> stg_gc_d1_ret_info
365 -- Interpreter.c spots this special case
366 other -> pprPanic "ByteCodeLink.itoc_itbl" (ppr pk)
368 foreign label "stg_ctoi_ret_R1p_info" stg_ctoi_ret_R1p_info :: Addr
369 foreign label "stg_ctoi_ret_R1n_info" stg_ctoi_ret_R1n_info :: Addr
370 foreign label "stg_ctoi_ret_F1_info" stg_ctoi_ret_F1_info :: Addr
371 foreign label "stg_ctoi_ret_D1_info" stg_ctoi_ret_D1_info :: Addr
372 foreign label "stg_ctoi_ret_V_info" stg_ctoi_ret_V_info :: Addr
374 foreign label "stg_gc_unbx_r1_ret_info" stg_gc_unbx_r1_ret_info :: Addr
375 foreign label "stg_gc_f1_ret_info" stg_gc_f1_ret_info :: Addr
376 foreign label "stg_gc_d1_ret_info" stg_gc_d1_ret_info :: Addr
378 -- The size in 16-bit entities of an instruction.
379 instrSize16s :: BCInstr -> Int
412 -- Make lists of host-sized words for literals, so that when the
413 -- words are placed in memory at increasing addresses, the
414 -- bit pattern is correct for the host's word size and endianness.
415 mkLitI :: Int -> [Word]
416 mkLitF :: Float -> [Word]
417 mkLitD :: Double -> [Word]
418 mkLitA :: Addr -> [Word]
422 arr <- newFloatArray ((0::Int),0)
423 writeFloatArray arr 0 f
424 f_arr <- castSTUArray arr
425 w0 <- readWordArray f_arr 0
432 arr <- newDoubleArray ((0::Int),1)
433 writeDoubleArray arr 0 d
434 d_arr <- castSTUArray arr
435 w0 <- readWordArray d_arr 0
436 w1 <- readWordArray d_arr 1
441 arr <- newDoubleArray ((0::Int),0)
442 writeDoubleArray arr 0 d
443 d_arr <- castSTUArray arr
444 w0 <- readWordArray d_arr 0
450 arr <- newIntArray ((0::Int),0)
451 writeIntArray arr 0 i
452 i_arr <- castSTUArray arr
453 w0 <- readWordArray i_arr 0
459 arr <- newAddrArray ((0::Int),0)
460 writeAddrArray arr 0 a
461 a_arr <- castSTUArray arr
462 w0 <- readWordArray a_arr 0
468 %************************************************************************
470 \subsection{Linking interpretables into something we can run}
472 %************************************************************************
477 data BCO# = BCO# ByteArray# -- instrs :: Array Word16#
478 ByteArray# -- literals :: Array Word32#
479 PtrArray# -- ptrs :: Array HValue
480 ByteArray# -- itbls :: Array Addr#
483 linkBCO ie ce (UnlinkedBCO nm insnsSS literalsSS ptrsSS itblsSS)
484 = do insns <- listFromSS insnsSS
485 literals <- listFromSS literalsSS
486 ptrs <- listFromSS ptrsSS
487 itbls <- listFromSS itblsSS
489 linked_ptrs <- mapM (lookupCE ce) ptrs
490 linked_itbls <- mapM (lookupIE ie) itbls
492 let n_insns = sizeSS insnsSS
493 n_literals = sizeSS literalsSS
494 n_ptrs = sizeSS ptrsSS
495 n_itbls = sizeSS itblsSS
497 let ptrs_arr = array (0, n_ptrs-1) (indexify linked_ptrs)
499 ptrs_parr = case ptrs_arr of Array lo hi parr -> parr
501 itbls_arr = array (0, n_itbls-1) (indexify linked_itbls)
502 :: UArray Int ItblPtr
503 itbls_barr = case itbls_arr of UArray lo hi barr -> barr
505 insns_arr | n_insns > 65535
506 = panic "linkBCO: >= 64k insns in BCO"
509 (indexify (fromIntegral n_insns:insns))
511 insns_barr = case insns_arr of UArray lo hi barr -> barr
513 literals_arr = array (0, n_literals-1) (indexify literals)
515 literals_barr = case literals_arr of UArray lo hi barr -> barr
517 indexify :: [a] -> [(Int, a)]
518 indexify xs = zip [0..] xs
520 BCO bco# <- newBCO insns_barr literals_barr ptrs_parr itbls_barr
522 -- WAS: return (unsafeCoerce# bco#)
523 case mkApUpd0# (unsafeCoerce# bco#) of
524 (# final_bco #) -> return final_bco
529 newBCO :: ByteArray# -> ByteArray# -> Array# a -> ByteArray# -> IO BCO
531 = IO (\s -> case newBCO# a b c d s of (# s1, bco #) -> (# s1, BCO bco #))
534 lookupCE :: ClosureEnv -> Either Name PrimOp -> IO HValue
535 lookupCE ce (Right primop)
536 = do m <- lookupSymbol (primopToCLabel primop "closure")
538 Just (Ptr addr) -> case addrToHValue# addr of
539 (# hval #) -> return hval
540 Nothing -> pprPanic "ByteCodeLink.lookupCE(primop)" (ppr primop)
541 lookupCE ce (Left nm)
542 = case lookupFM ce nm of
545 -> do m <- lookupSymbol (nameToCLabel nm "closure")
547 Just (Ptr addr) -> case addrToHValue# addr of
548 (# hval #) -> return hval
549 Nothing -> pprPanic "ByteCodeLink.lookupCE" (ppr nm)
551 lookupIE :: ItblEnv -> Name -> IO (Ptr a)
553 = case lookupFM ie con_nm of
554 Just (Ptr a) -> return (Ptr a)
556 -> do -- try looking up in the object files.
557 m <- lookupSymbol (nameToCLabel con_nm "con_info")
559 Just addr -> return addr
561 -> do -- perhaps a nullary constructor?
562 n <- lookupSymbol (nameToCLabel con_nm "static_info")
564 Just addr -> return addr
565 Nothing -> pprPanic "ByteCodeLink.lookupIE" (ppr con_nm)
567 -- HACKS!!! ToDo: cleaner
568 nameToCLabel :: Name -> String{-suffix-} -> String
569 nameToCLabel n suffix
570 = _UNPK_(moduleNameFS (rdrNameModule rn))
571 ++ '_':occNameString(rdrNameOcc rn) ++ '_':suffix
572 where rn = toRdrName n
574 primopToCLabel :: PrimOp -> String{-suffix-} -> String
575 primopToCLabel primop suffix
576 = let str = "PrelPrimopWrappers_" ++ occNameString (primOpOcc primop) ++ '_':suffix
577 in --trace ("primopToCLabel: " ++ str)
582 %************************************************************************
584 \subsection{Connect to actual values for bytecode opcodes}
586 %************************************************************************
590 #include "Bytecodes.h"
592 i_ARGCHECK = (bci_ARGCHECK :: Int)
593 i_PUSH_L = (bci_PUSH_L :: Int)
594 i_PUSH_LL = (bci_PUSH_LL :: Int)
595 i_PUSH_LLL = (bci_PUSH_LLL :: Int)
596 i_PUSH_G = (bci_PUSH_G :: Int)
597 i_PUSH_AS = (bci_PUSH_AS :: Int)
598 i_PUSH_UBX = (bci_PUSH_UBX :: Int)
599 i_PUSH_TAG = (bci_PUSH_TAG :: Int)
600 i_SLIDE = (bci_SLIDE :: Int)
601 i_ALLOC = (bci_ALLOC :: Int)
602 i_MKAP = (bci_MKAP :: Int)
603 i_UNPACK = (bci_UNPACK :: Int)
604 i_UPK_TAG = (bci_UPK_TAG :: Int)
605 i_PACK = (bci_PACK :: Int)
606 i_TESTLT_I = (bci_TESTLT_I :: Int)
607 i_TESTEQ_I = (bci_TESTEQ_I :: Int)
608 i_TESTLT_F = (bci_TESTLT_F :: Int)
609 i_TESTEQ_F = (bci_TESTEQ_F :: Int)
610 i_TESTLT_D = (bci_TESTLT_D :: Int)
611 i_TESTEQ_D = (bci_TESTEQ_D :: Int)
612 i_TESTLT_P = (bci_TESTLT_P :: Int)
613 i_TESTEQ_P = (bci_TESTEQ_P :: Int)
614 i_CASEFAIL = (bci_CASEFAIL :: Int)
615 i_ENTER = (bci_ENTER :: Int)
616 i_RETURN = (bci_RETURN :: Int)
617 i_STKCHECK = (bci_STKCHECK :: Int)
618 i_JMP = (bci_JMP :: Int)
620 i_CCALL = (bci_CCALL :: Int)
621 i_SWIZZLE = (bci_SWIZZLE :: Int)
623 i_CCALL = error "Sorry pal, you need to bootstrap to use i_CCALL."
624 i_SWIZZLE = error "Sorry pal, you need to bootstrap to use i_SWIZZLE."
627 iNTERP_STACK_CHECK_THRESH = (INTERP_STACK_CHECK_THRESH :: Int)