\section[ByteCodeGen]{Generate bytecode from Core}
\begin{code}
-module ByteCodeGen ( byteCodeGen ) where
+module ByteCodeGen ( byteCodeGen, assembleBCO ) where
#include "HsVersions.h"
---import Id
---import Name
---import PrimOp
-
import Outputable
import Name ( Name, getName )
import Id ( Id, idType, isDataConId_maybe )
import OrdList ( OrdList, consOL, snocOL, appOL, unitOL,
nilOL, toOL, concatOL, fromOL )
import FiniteMap ( FiniteMap, addListToFM, listToFM,
- addToFM, lookupFM, fmToList )
+ addToFM, lookupFM, fmToList, emptyFM )
import CoreSyn
+import PprCore ( pprCoreExpr, pprCoreAlt )
import Literal ( Literal(..) )
import PrimRep ( PrimRep(..) )
import CoreFVs ( freeVars )
import Type ( typePrimRep )
-import DataCon ( DataCon, dataConTag, fIRST_TAG )
-import Util ( zipEqual, zipWith4Equal, naturalMergeSortLe )
+import DataCon ( DataCon, dataConTag, fIRST_TAG, dataConTyCon )
+import TyCon ( tyConFamilySize )
+import Util ( zipEqual, zipWith4Equal, naturalMergeSortLe, nOfThem )
+import Var ( isTyVar )
import VarSet ( VarSet, varSetElems )
---import FastTypes
+import PrimRep ( getPrimRepSize, isFollowableRep )
+import Constants ( wORD_SIZE )
+
+import Monad ( foldM )
+import Foreign ( Addr, Word16, Word32 )
+import ST ( runST )
+--import MutableArray ( readWord32Array,
+-- newFloatArray, writeFloatArray,
+-- newDoubleArray, writeDoubleArray,
+-- newIntArray, writeIntArray,
+-- newAddrArray, writeAddrArray )
+
+import MArray
\end{code}
Entry point.
\begin{code}
-byteCodeGen :: [CoreBind] -> [BCO Name]
+byteCodeGen :: [CoreBind] -> [ProtoBCO Name]
byteCodeGen binds
= let flatBinds = concatMap getBind binds
getBind (NonRec bndr rhs) = [(bndr, freeVars rhs)]
in
case final_state of
BcM_State bcos final_ctr -> bcos
-
\end{code}
-The real machinery.
+
+%************************************************************************
+%* *
+\subsection{Bytecodes, and Outputery.}
+%* *
+%************************************************************************
\begin{code}
+
type LocalLabel = Int
+data UnboxedLit = UnboxedI Int | UnboxedF Float | UnboxedD Double
+
data BCInstr
-- Messing with the stack
- = ARGCHECK Int
- | PUSH_L Int{-size-} Int{-offset-}
- | PUSH_G Name
- | PUSH_I Integer
- | SLIDE Int{-this many-} Int{-down by this much-}
+ = ARGCHECK Int
+ -- Push locals (existing bits of the stack)
+ | PUSH_L Int{-offset-}
+ | PUSH_LL Int Int{-2 offsets-}
+ | PUSH_LLL Int Int Int{-3 offsets-}
+ -- Push a ptr
+ | PUSH_G Name
+ -- Push an alt continuation
+ | PUSH_AS Name PrimRep -- push alts and BCO_ptr_ret_info
+ -- PrimRep so we know which itbl
+ -- Pushing literals
+ | PUSH_UBX Literal Int
+ -- push this int/float/double, NO TAG, on the stack
+ -- Int is # of items in literal pool to push
+ | PUSH_TAG Int -- push this tag on the stack
+
+ | SLIDE Int{-this many-} Int{-down by this much-}
-- To do with the heap
- | ALLOC Int
- | MKAP Int{-place ptr to heap this far down stack-} Int{-# words-}
- | UNPACK Int
- | PACK DataCon Int
+ | ALLOC Int -- make an AP_UPD with this many payload words, zeroed
+ | MKAP Int{-ptr to AP_UPD is this far down stack-} Int{-# words-}
+ | UNPACK Int -- unpack N ptr words from t.o.s Constr
+ | UPK_TAG Int Int Int
+ -- unpack N non-ptr words from offset M in constructor
+ -- K words down the stack
+ | PACK DataCon Int
-- For doing case trees
- | LABEL LocalLabel
- | TESTLT_I Int LocalLabel
- | TESTEQ_I Int LocalLabel
- | TESTLT_F Float LocalLabel
- | TESTEQ_F Float LocalLabel
- | TESTLT_D Double LocalLabel
- | TESTEQ_D Double LocalLabel
- | TESTLT_P Int LocalLabel
- | TESTEQ_P Int LocalLabel
+ | LABEL LocalLabel
+ | TESTLT_I Int LocalLabel
+ | TESTEQ_I Int LocalLabel
+ | TESTLT_F Float LocalLabel
+ | TESTEQ_F Float LocalLabel
+ | TESTLT_D Double LocalLabel
+ | TESTEQ_D Double LocalLabel
+ | TESTLT_P Int LocalLabel
+ | TESTEQ_P Int LocalLabel
| CASEFAIL
-- To Infinity And Beyond
| ENTER
+ | RETURN -- unboxed value on TOS. Use tag to find underlying ret itbl
+ -- and return as per that.
+
instance Outputable BCInstr where
ppr (ARGCHECK n) = text "ARGCHECK" <+> int n
- ppr (PUSH_L sz offset) = text "PUSH_L " <+> int sz <+> int offset
+ ppr (PUSH_L offset) = text "PUSH_L " <+> int offset
+ ppr (PUSH_LL o1 o2) = text "PUSH_LL " <+> int o1 <+> int o2
+ ppr (PUSH_LLL o1 o2 o3) = text "PUSH_LLL" <+> int o1 <+> int o2 <+> int o3
ppr (PUSH_G nm) = text "PUSH_G " <+> ppr nm
- ppr (PUSH_I i) = text "PUSH_I " <+> integer i
+ ppr (PUSH_AS nm pk) = text "PUSH_AS " <+> ppr nm <+> ppr pk
ppr (SLIDE n d) = text "SLIDE " <+> int n <+> int d
ppr (ALLOC sz) = text "ALLOC " <+> int sz
ppr (MKAP offset sz) = text "MKAP " <+> int offset <+> int sz
ppr (UNPACK sz) = text "UNPACK " <+> int sz
ppr (PACK dcon sz) = text "PACK " <+> ppr dcon <+> ppr sz
+ ppr (LABEL lab) = text "__" <> int lab <> colon
+ ppr (TESTLT_I i lab) = text "TESTLT_I" <+> int i <+> text "__" <> int lab
+ ppr (TESTEQ_I i lab) = text "TESTEQ_I" <+> int i <+> text "__" <> int lab
+ ppr (TESTLT_F f lab) = text "TESTLT_F" <+> float f <+> text "__" <> int lab
+ ppr (TESTEQ_F f lab) = text "TESTEQ_F" <+> float f <+> text "__" <> int lab
+ ppr (TESTLT_D d lab) = text "TESTLT_D" <+> double d <+> text "__" <> int lab
+ ppr (TESTEQ_D d lab) = text "TESTEQ_D" <+> double d <+> text "__" <> int lab
+ ppr (TESTLT_P i lab) = text "TESTLT_P" <+> int i <+> text "__" <> int lab
+ ppr (TESTEQ_P i lab) = text "TESTEQ_P" <+> int i <+> text "__" <> int lab
+ ppr CASEFAIL = text "CASEFAIL"
ppr ENTER = text "ENTER"
+ ppr RETURN = text "RETURN"
pprAltCode discrs_n_codes
= vcat (map f discrs_n_codes)
where f (discr, code) = ppr discr <> colon <+> vcat (map ppr (fromOL code))
+instance Outputable a => Outputable (ProtoBCO a) where
+ ppr (ProtoBCO name instrs origin)
+ = (text "ProtoBCO" <+> ppr name <> colon)
+ $$ nest 6 (vcat (map ppr instrs))
+ $$ case origin of
+ Left alts -> vcat (map (pprCoreAlt.deAnnAlt) alts)
+ Right rhs -> pprCoreExpr (deAnnotate rhs)
+\end{code}
-type BCInstrList = OrdList BCInstr
-
-data BCO a = BCO a BCInstrList
+%************************************************************************
+%* *
+\subsection{Compilation schema for the bytecode generator.}
+%* *
+%************************************************************************
-instance Outputable a => Outputable (BCO a) where
- ppr (BCO name instrs)
- = (text "BCO" <+> ppr name <> colon)
- $$ nest 6 (vcat (map ppr (fromOL instrs)))
+\begin{code}
+type BCInstrList = OrdList BCInstr
+data ProtoBCO a
+ = ProtoBCO a -- name, in some sense
+ [BCInstr] -- instrs
+ -- what the BCO came from
+ (Either [AnnAlt Id VarSet]
+ (AnnExpr Id VarSet))
type Sequel = Int -- back off to this depth before ENTER
-- to mess with it after each push/pop.
type BCEnv = FiniteMap Id Int -- To find vars on the stack
-lookupBCEnv :: BCEnv -> Id -> Int
-lookupBCEnv env nm
- = case lookupFM env nm of
- Nothing -> pprPanic "lookupBCEnv"
- (ppr nm $$ char ' ' $$ vcat (map ppr (fmToList env)))
- Just xx -> xx
-
-lookupBCEnv_maybe :: BCEnv -> Id -> Maybe Int
-lookupBCEnv_maybe = lookupFM
-
-
--- Describes case alts
-data Discr
- = DiscrI Int
- | DiscrF Float
- | DiscrD Double
- | DiscrP Int
- | NoDiscr
-
-instance Outputable Discr where
- ppr (DiscrI i) = int i
- ppr (DiscrF f) = text (show f)
- ppr (DiscrD d) = text (show d)
- ppr (DiscrP i) = int i
- ppr NoDiscr = text "DEF"
-
-
--- Hmm. This isn't really right (ie on Alpha, idSizeW Double -> 2)
--- There must be an Officially Approved way to do this somewhere.
-idSizeW :: Id -> Int
-idSizeW nm
- = let pr = typePrimRep (idType nm)
- in case pr of IntRep -> 2
- FloatRep -> 2
- DoubleRep -> 3
- PtrRep -> 1
- other -> pprPanic "ByteCodeGen.idSizeW" (ppr pr)
+-- Create a BCO and do a spot of peephole optimisation on the insns
+-- at the same time.
+mkProtoBCO nm instrs_ordlist origin
+ = ProtoBCO nm (peep (fromOL instrs_ordlist)) origin
+ where
+ peep (PUSH_L off1 : PUSH_L off2 : PUSH_L off3 : rest)
+ = PUSH_LLL off1 (off2-1) (off3-2) : peep rest
+ peep (PUSH_L off1 : PUSH_L off2 : rest)
+ = PUSH_LL off1 off2 : peep rest
+ peep (i:rest)
+ = i : peep rest
+ peep []
+ = []
-- Compile code for the right hand side of a let binding.
-- variable to which this value was bound, so as to give the
-- resulting BCO a name.
schemeR :: (Id, AnnExpr Id VarSet) -> BcM ()
-schemeR (nm, rhs) = schemeR_wrk nm (collect [] rhs)
+schemeR (nm, rhs) = schemeR_wrk rhs nm (collect [] rhs)
-collect xs (_, AnnLam x e) = collect (x:xs) e
-collect xs not_lambda = (reverse xs, not_lambda)
+collect xs (_, AnnLam x e)
+ = collect (if isTyVar x then xs else (x:xs)) e
+collect xs not_lambda
+ = (reverse xs, not_lambda)
-schemeR_wrk nm (args, body)
- = let fvs = fst body
- all_args = varSetElems fvs ++ args
- szsw_args = map idSizeW all_args
+schemeR_wrk original_body nm (args, body)
+ = let fvs = filter (not.isTyVar) (varSetElems (fst original_body))
+ all_args = fvs ++ reverse args
+ szsw_args = map taggedIdSizeW all_args
szw_args = sum szsw_args
- p_init = listToFM (zip all_args (scanl (+) 0 szsw_args))
+ p_init = listToFM (zip all_args (mkStackOffsets 0 szsw_args))
argcheck = if null args then nilOL else unitOL (ARGCHECK szw_args)
in
schemeE szw_args 0 p_init body `thenBc` \ body_code ->
- emitBc (BCO (getName nm) (appOL argcheck body_code))
+ emitBc (mkProtoBCO (getName nm) (appOL argcheck body_code) (Right original_body))
+-- Let szsw be the sizes in words of some items pushed onto the stack,
+-- which has initial depth d'. Return the values which the stack environment
+-- should map these items to.
+mkStackOffsets :: Int -> [Int] -> [Int]
+mkStackOffsets original_depth szsw
+ = map (subtract 1) (tail (scanl (+) original_depth szsw))
-- Compile code to apply the given expression to the remaining args
-- on the stack, returning a HNF.
schemeE :: Int -> Sequel -> BCEnv -> AnnExpr Id VarSet -> BcM BCInstrList
-- Delegate tail-calls to schemeT.
-schemeE d s p (fvs, AnnApp f a) = returnBc (schemeT d s 0 p (fvs, AnnApp f a))
-schemeE d s p (fvs, AnnVar v) = returnBc (schemeT d s 0 p (fvs, AnnVar v))
+schemeE d s p e@(fvs, AnnApp f a)
+ = returnBc (schemeT (should_args_be_tagged e) d s 0 p (fvs, AnnApp f a))
+schemeE d s p e@(fvs, AnnVar v)
+ | isFollowableRep (typePrimRep (idType v))
+ = returnBc (schemeT (should_args_be_tagged e) d s 0 p (fvs, AnnVar v))
+ | otherwise
+ = -- returning an unboxed value. Heave it on the stack, SLIDE, and RETURN.
+ let (push, szw) = pushAtom True d p (AnnVar v)
+ in returnBc (push -- value onto stack
+ `snocOL` SLIDE szw (d-s) -- clear to sequel
+ `snocOL` RETURN) -- go
+
+schemeE d s p (fvs, AnnLit literal)
+ = let (push, szw) = pushAtom True d p (AnnLit literal)
+ in returnBc (push -- value onto stack
+ `snocOL` SLIDE szw (d-s) -- clear to sequel
+ `snocOL` RETURN) -- go
schemeE d s p (fvs, AnnLet binds b)
= let (xs,rhss) = case binds of AnnNonRec x rhs -> ([x],[rhs])
AnnRec xs_n_rhss -> unzip xs_n_rhss
- in
- mapBc schemeR (zip xs rhss) `thenBc_`
- let n = length xs
- fvss = map (varSetElems.fst) rhss
- sizes = map (\rhs_fvs -> 1 + sum (map idSizeW rhs_fvs)) fvss
- p' = addListToFM p (zipE xs [d .. d+n-1])
+ n = length xs
+ fvss = map (filter (not.isTyVar).varSetElems.fst) rhss
+ sizes = map (\rhs_fvs -> 1 + sum (map taggedIdSizeW rhs_fvs)) fvss
+
+ -- This p', d' defn is safe because all the items being pushed
+ -- are ptrs, so all have size 1. d' and p' reflect the stack
+ -- after the closures have been allocated in the heap (but not
+ -- filled in), and pointers to them parked on the stack.
+ p' = addListToFM p (zipE xs (mkStackOffsets d (nOfThem n 1)))
d' = d + n
+
infos = zipE4 fvss sizes xs [n, n-1 .. 1]
zipE = zipEqual "schemeE"
zipE4 = zipWith4Equal "schemeE" (\a b c d -> (a,b,c,d))
-- ToDo: don't build thunks for things with no free variables
- buildThunk (fvs, size, id, off)
- = case unzip (map (pushAtom d' p . AnnVar) (reverse fvs)) of
- (push_codes, pushed_szsw)
- -> ASSERT(sum pushed_szsw == size - 1)
- (toOL push_codes `snocOL` PUSH_G (getName id)
- `appOL` unitOL (MKAP off size))
-
- thunkCode = concatOL (map buildThunk infos)
+ buildThunk dd ([], size, id, off)
+ = PUSH_G (getName id)
+ `consOL` unitOL (MKAP (off+size-1) size)
+ buildThunk dd ((fv:fvs), size, id, off)
+ = case pushAtom True dd p' (AnnVar fv) of
+ (push_code, pushed_szw)
+ -> push_code `appOL`
+ buildThunk (dd+pushed_szw) (fvs, size, id, off)
+
+ thunkCode = concatOL (map (buildThunk d') infos)
allocCode = toOL (map ALLOC sizes)
in
- schemeE d' s p' b `thenBc` \ bodyCode ->
- mapBc schemeR (zip xs rhss) `thenBc` \_ ->
+ schemeE d' s p' b `thenBc` \ bodyCode ->
+ mapBc schemeR (zip xs rhss) `thenBc_`
returnBc (allocCode `appOL` thunkCode `appOL` bodyCode)
-- Env and depth in which to compile the alts, not including
-- any vars bound by the alts themselves
- d' = d + ret_frame_sizeW + idSizeW bndr
- p' = addToFM p bndr d'
+ d' = d + ret_frame_sizeW + taggedIdSizeW bndr
+ p' = addToFM p bndr (d' - 1)
+ scrut_primrep = typePrimRep (idType bndr)
isAlgCase
- = case typePrimRep (idType bndr) of
+ = case scrut_primrep of
IntRep -> False ; FloatRep -> False ; DoubleRep -> False
PtrRep -> True
other -> pprPanic "ByteCodeGen.schemeE" (ppr other)
-- given an alt, return a discr and code for it.
- codeAlt alt@(discr, binds, rhs)
+ codeAlt alt@(discr, binds_f, rhs)
| isAlgCase
- = let binds_szsw = map idSizeW binds
- binds_szw = sum binds_szsw
- p'' = addListToFM p' (zip binds (scanl (+) d' binds_szsw))
- d'' = d' + binds_szw
+ = let binds_r = reverse binds_f
+ binds_r_szsw = map untaggedIdSizeW binds_r
+ binds_szw = sum binds_r_szsw
+ p'' = addListToFM
+ p' (zip binds_r (mkStackOffsets d' binds_r_szsw))
+ d'' = d' + binds_szw
+ unpack_code = mkUnpackCode 0 0 (map (typePrimRep.idType) binds_f)
in schemeE d'' s p'' rhs `thenBc` \ rhs_code ->
- returnBc (my_discr alt, UNPACK binds_szw `consOL` rhs_code)
+ returnBc (my_discr alt, unpack_code `appOL` rhs_code)
| otherwise
- = ASSERT(null binds)
+ = ASSERT(null binds_f)
schemeE d' s p' rhs `thenBc` \ rhs_code ->
returnBc (my_discr alt, rhs_code)
my_discr (DEFAULT, binds, rhs) = NoDiscr
- my_discr (DataAlt dc, binds, rhs) = DiscrP (dataConTag dc - fIRST_TAG)
+ my_discr (DataAlt dc, binds, rhs) = DiscrP (dataConTag dc)
my_discr (LitAlt l, binds, rhs)
= case l of MachInt i -> DiscrI (fromInteger i)
MachFloat r -> DiscrF (fromRational r)
MachDouble r -> DiscrD (fromRational r)
+ maybe_ncons
+ | not isAlgCase = Nothing
+ | otherwise
+ = case [dc | (DataAlt dc, _, _) <- alts] of
+ [] -> Nothing
+ (dc:_) -> Just (tyConFamilySize (dataConTyCon dc))
+
in
mapBc codeAlt alts `thenBc` \ alt_stuff ->
- mkMultiBranch alt_stuff `thenBc` \ alt_final ->
+ mkMultiBranch maybe_ncons alt_stuff `thenBc` \ alt_final ->
let
alt_bco_name = getName bndr
- alt_bco = BCO alt_bco_name alt_final
+ alt_bco = mkProtoBCO alt_bco_name alt_final (Left alts)
in
schemeE (d + ret_frame_sizeW)
(d + ret_frame_sizeW) p scrut `thenBc` \ scrut_code ->
emitBc alt_bco `thenBc_`
- returnBc (PUSH_G alt_bco_name `consOL` scrut_code)
+ returnBc (PUSH_AS alt_bco_name scrut_primrep `consOL` scrut_code)
+
+
+schemeE d s p (fvs, AnnNote note body)
+ = schemeE d s p body
+
+schemeE d s p other
+ = pprPanic "ByteCodeGen.schemeE: unhandled case"
+ (pprCoreExpr (deAnnotate other))
+
+
+-- Compile code to do a tail call. Doesn't need to be monadic.
+schemeT :: Bool -- do tagging?
+ -> Int -- Stack depth
+ -> Sequel -- Sequel depth
+ -> Int -- # arg words so far
+ -> BCEnv -- stack env
+ -> AnnExpr Id VarSet -> BCInstrList
+
+schemeT enTag d s narg_words p (_, AnnApp f a)
+ = case snd a of
+ AnnType _ -> schemeT enTag d s narg_words p f
+ other
+ -> let (push, arg_words) = pushAtom enTag d p (snd a)
+ in push
+ `appOL` schemeT enTag (d+arg_words) s (narg_words+arg_words) p f
+
+schemeT enTag d s narg_words p (_, AnnVar f)
+ | Just con <- isDataConId_maybe f
+ = ASSERT(enTag == False)
+ PACK con narg_words `consOL` (mkSLIDE 1 (d-s-1) `snocOL` ENTER)
+ | otherwise
+ = ASSERT(enTag == True)
+ let (push, arg_words) = pushAtom True d p (AnnVar f)
+ in push
+ `appOL` mkSLIDE (narg_words+arg_words) (d - s - narg_words)
+ `snocOL` ENTER
+
+mkSLIDE n d
+ = if d == 0 then nilOL else unitOL (SLIDE n d)
+
+should_args_be_tagged (_, AnnVar v)
+ = case isDataConId_maybe v of
+ Just dcon -> False; Nothing -> True
+should_args_be_tagged (_, AnnApp f a)
+ = should_args_be_tagged f
+should_args_be_tagged (_, other)
+ = panic "should_args_be_tagged: tail call to non-con, non-var"
+
+
+-- Make code to unpack a constructor onto the stack, adding
+-- tags for the unboxed bits. Takes the PrimReps of the constructor's
+-- arguments, and a travelling offset along both the constructor
+-- (off_h) and the stack (off_s).
+mkUnpackCode :: Int -> Int -> [PrimRep] -> BCInstrList
+mkUnpackCode off_h off_s [] = nilOL
+mkUnpackCode off_h off_s (r:rs)
+ | isFollowableRep r
+ = let (rs_ptr, rs_nptr) = span isFollowableRep (r:rs)
+ ptrs_szw = sum (map untaggedSizeW rs_ptr)
+ in ASSERT(ptrs_szw == length rs_ptr)
+ ASSERT(off_h == 0)
+ ASSERT(off_s == 0)
+ UNPACK ptrs_szw
+ `consOL` mkUnpackCode (off_h + ptrs_szw) (off_s + ptrs_szw) rs_nptr
+ | otherwise
+ = case r of
+ IntRep -> approved
+ FloatRep -> approved
+ DoubleRep -> approved
+ where
+ approved = UPK_TAG usizeW off_h off_s `consOL` theRest
+ theRest = mkUnpackCode (off_h + usizeW) (off_s + tsizeW) rs
+ usizeW = untaggedSizeW r
+ tsizeW = taggedSizeW r
+
+-- Push an atom onto the stack, returning suitable code & number of
+-- stack words used. Pushes it either tagged or untagged, since
+-- pushAtom is used to set up the stack prior to copying into the
+-- heap for both APs (requiring tags) and constructors (which don't).
+--
+-- NB this means NO GC between pushing atoms for a constructor and
+-- copying them into the heap. It probably also means that
+-- tail calls MUST be of the form atom{atom ... atom} since if the
+-- expression head was allowed to be arbitrary, there could be GC
+-- in between pushing the arg atoms and completing the head.
+-- (not sure; perhaps the allocate/doYouWantToGC interface means this
+-- isn't a problem; but only if arbitrary graph construction for the
+-- head doesn't leave this BCO, since GC might happen at the start of
+-- each BCO (we consult doYouWantToGC there).
+--
+-- Blargh. JRS 001206
+--
+-- NB (further) that the env p must map each variable to the highest-
+-- numbered stack slot for it. For example, if the stack has depth 4
+-- and we tagged-ly push (v :: Int#) on it, the value will be in stack[4],
+-- the tag in stack[5], the stack will have depth 6, and p must map v to
+-- 5 and not to 4. Stack locations are numbered from zero, so a depth
+-- 6 stack has valid words 0 .. 5.
+
+pushAtom :: Bool -> Int -> BCEnv -> AnnExpr' Id VarSet -> (BCInstrList, Int)
+pushAtom tagged d p (AnnVar v)
+ = let str = "\npushAtom " ++ showSDocDebug (ppr v) ++ ", depth = " ++ show d
+ ++ ", env =\n" ++
+ showSDocDebug (nest 4 (vcat (map ppr (fmToList p))))
+ ++ " -->\n" ++
+ showSDoc (nest 4 (vcat (map ppr (fromOL (fst result)))))
+ ++ "\nendPushAtom " ++ showSDocDebug (ppr v)
+ str' = if str == str then str else str
+
+ result
+ = case lookupBCEnv_maybe p v of
+ Just d_v -> (toOL (nOfThem nwords (PUSH_L (d-d_v+sz_t-2))), sz_t)
+ Nothing -> ASSERT(sz_t == 1) (unitOL (PUSH_G nm), sz_t)
+
+ nm = getName v
+ sz_t = taggedIdSizeW v
+ sz_u = untaggedIdSizeW v
+ nwords = if tagged then sz_t else sz_u
+ in
+ --trace str'
+ result
+
+pushAtom True d p (AnnLit lit)
+ = let (ubx_code, ubx_size) = pushAtom False d p (AnnLit lit)
+ in (ubx_code `snocOL` PUSH_TAG ubx_size, 1 + ubx_size)
+
+pushAtom False d p (AnnLit lit)
+ = case lit of
+ MachInt i -> code IntRep
+ MachFloat r -> code FloatRep
+ MachDouble r -> code DoubleRep
+ where
+ code rep
+ = let size_host_words = untaggedSizeW rep
+ size_in_word32s = (size_host_words * wORD_SIZE) `div` 4
+ in (unitOL (PUSH_UBX lit size_in_word32s), size_host_words)
+
+pushAtom tagged d p (AnnApp f (_, AnnType _))
+ = pushAtom tagged d p (snd f)
+
+pushAtom tagged d p other
+ = pprPanic "ByteCodeGen.pushAtom"
+ (pprCoreExpr (deAnnotate (undefined, other)))
-- Given a bunch of alts code and their discrs, do the donkey work
-- of making a multiway branch using a switch tree.
-- What a load of hassle!
-mkMultiBranch :: [(Discr, BCInstrList)] -> BcM BCInstrList
-mkMultiBranch raw_ways
+mkMultiBranch :: Maybe Int -- # datacons in tycon, if alg alt
+ -- a hint; generates better code
+ -- Nothing is always safe
+ -> [(Discr, BCInstrList)]
+ -> BcM BCInstrList
+mkMultiBranch maybe_ncons raw_ways
= let d_way = filter (isNoDiscr.fst) raw_ways
notd_ways = naturalMergeSortLe
(\w1 w2 -> leAlt (fst w1) (fst w2))
DiscrD maxD );
DiscrP _ -> ( \(DiscrP i) fail_label -> TESTLT_P i fail_label,
\(DiscrP i) fail_label -> TESTEQ_P i fail_label,
- DiscrP minBound,
- DiscrP maxBound )
+ DiscrP algMinBound,
+ DiscrP algMaxBound )
}
+ (algMinBound, algMaxBound)
+ = case maybe_ncons of
+ Just n -> (fIRST_TAG, fIRST_TAG + n - 1)
+ Nothing -> (minBound, maxBound)
+
(DiscrI i1) `eqAlt` (DiscrI i2) = i1 == i2
(DiscrF f1) `eqAlt` (DiscrF f2) = f1 == f2
(DiscrD d1) `eqAlt` (DiscrD d2) = d1 == d2
in
mkTree notd_ways init_lo init_hi
+\end{code}
--- Compile code to do a tail call. Doesn't need to be monadic.
-schemeT :: Int -> Sequel -> Int -> BCEnv -> AnnExpr Id VarSet -> BCInstrList
+%************************************************************************
+%* *
+\subsection{Supporting junk for the compilation schemes}
+%* *
+%************************************************************************
-schemeT d s narg_words p (_, AnnApp f a)
- = let (push, arg_words) = pushAtom d p (snd a)
- in push
- `consOL` schemeT (d+arg_words) s (narg_words+arg_words) p f
+\begin{code}
-schemeT d s narg_words p (_, AnnVar f)
- | Just con <- isDataConId_maybe f
- = PACK con narg_words `consOL` SLIDE 1 (d-s-1) `consOL` unitOL ENTER
- | otherwise
- = let (push, arg_words) = pushAtom d p (AnnVar f)
- in push
- `consOL` SLIDE (narg_words+arg_words) (d - s - narg_words)
- `consOL` unitOL ENTER
+-- Describes case alts
+data Discr
+ = DiscrI Int
+ | DiscrF Float
+ | DiscrD Double
+ | DiscrP Int
+ | NoDiscr
+instance Outputable Discr where
+ ppr (DiscrI i) = int i
+ ppr (DiscrF f) = text (show f)
+ ppr (DiscrD d) = text (show d)
+ ppr (DiscrP i) = int i
+ ppr NoDiscr = text "DEF"
--- Push an atom onto the stack, returning suitable code & number of
--- stack words used.
-pushAtom d p (AnnVar v)
- = case lookupBCEnv_maybe p v of
- Just offset -> (PUSH_L sz offset, sz)
- Nothing -> ASSERT(sz == 1) (PUSH_G nm, 1)
- where
- nm = getName v
- sz = idSizeW v
-pushAtom d p (AnnLit lit)
- = case lit of
- MachInt i -> (PUSH_I i, 2)
+-- Find things in the BCEnv (the what's-on-the-stack-env)
+-- See comment preceding pushAtom for precise meaning of env contents
+lookupBCEnv :: BCEnv -> Id -> Int
+lookupBCEnv env nm
+ = case lookupFM env nm of
+ Nothing -> pprPanic "lookupBCEnv"
+ (ppr nm $$ char ' ' $$ vcat (map ppr (fmToList env)))
+ Just xx -> xx
+
+lookupBCEnv_maybe :: BCEnv -> Id -> Maybe Int
+lookupBCEnv_maybe = lookupFM
+
+
+-- When I push one of these on the stack, how much does Sp move by?
+taggedSizeW :: PrimRep -> Int
+taggedSizeW pr
+ | isFollowableRep pr = 1
+ | otherwise = 1{-the tag-} + getPrimRepSize pr
+
+
+-- The plain size of something, without tag.
+untaggedSizeW :: PrimRep -> Int
+untaggedSizeW pr
+ | isFollowableRep pr = 1
+ | otherwise = getPrimRepSize pr
+
+
+taggedIdSizeW, untaggedIdSizeW :: Id -> Int
+taggedIdSizeW = taggedSizeW . typePrimRep . idType
+untaggedIdSizeW = untaggedSizeW . typePrimRep . idType
+
\end{code}
-The bytecode generator's monad.
+%************************************************************************
+%* *
+\subsection{The bytecode generator's monad}
+%* *
+%************************************************************************
\begin{code}
data BcM_State
- = BcM_State { bcos :: [BCO Name], -- accumulates completed BCOs
+ = BcM_State { bcos :: [ProtoBCO Name], -- accumulates completed BCOs
nextlabel :: Int } -- for generating local labels
type BcM result = BcM_State -> (result, BcM_State)
-mkBcM_State :: [BCO Name] -> Int -> BcM_State
+mkBcM_State :: [ProtoBCO Name] -> Int -> BcM_State
mkBcM_State = BcM_State
runBc :: BcM_State -> BcM () -> BcM_State
mapBc f xs `thenBc` \ rs ->
returnBc (r:rs)
-emitBc :: BCO Name -> BcM ()
+emitBc :: ProtoBCO Name -> BcM ()
emitBc bco st
= ((), st{bcos = bco : bcos st})
getLabelBc :: BcM Int
getLabelBc st
= (nextlabel st, st{nextlabel = 1 + nextlabel st})
+
+\end{code}
+
+%************************************************************************
+%* *
+\subsection{The bytecode assembler}
+%* *
+%************************************************************************
+
+The object format for bytecodes is: 16 bits for the opcode, and 16 for
+each field -- so the code can be considered a sequence of 16-bit ints.
+Each field denotes either a stack offset or number of items on the
+stack (eg SLIDE), and index into the pointer table (eg PUSH_G), an
+index into the literal table (eg PUSH_I/D/L), or a bytecode address in
+this BCO.
+
+\begin{code}
+-- An (almost) assembled BCO.
+data BCO a = BCO [Word16] -- instructions
+ [Word32] -- literal pool
+ [a] -- Names or HValues
+
+-- Top level assembler fn.
+assembleBCO :: ProtoBCO Name -> IO AsmState
+assembleBCO (ProtoBCO nm instrs origin)
+ = let
+ -- pass 1: collect up the offsets of the local labels
+ label_env = mkLabelEnv emptyFM 0 instrs
+
+ mkLabelEnv env i_offset [] = env
+ mkLabelEnv env i_offset (i:is)
+ = let new_env
+ = case i of LABEL n -> addToFM env n i_offset ; _ -> env
+ in mkLabelEnv new_env (i_offset + instrSizeB i) is
+
+ findLabel lab
+ = case lookupFM label_env lab of
+ Just bco_offset -> bco_offset
+ Nothing -> pprPanic "assembleBCO.findLabel" (int lab)
+
+ init_n_insns = 10
+ init_n_lits = 4
+ init_n_ptrs = 4
+ in
+ do insns <- newXIOUArray init_n_insns :: IO (XIOUArray Word16)
+ lits <- newXIOUArray init_n_lits :: IO (XIOUArray Word32)
+ ptrs <- newXIOArray init_n_ptrs -- :: IO (XIOArray Name)
+
+ -- pass 2: generate the instruction, ptr and nonptr bits
+ let init_asm_state = (insns,lits,ptrs)
+ final_asm_state <- mkBits findLabel init_asm_state instrs
+
+ return final_asm_state
+
+
+-- instrs nonptrs ptrs
+type AsmState = (XIOUArray Word16, XIOUArray Word32, XIOArray Name)
+
+
+-- This is where all the action is (pass 2 of the assembler)
+mkBits :: (Int -> Int) -- label finder
+ -> AsmState
+ -> [BCInstr] -- instructions (in)
+ -> IO AsmState
+
+mkBits findLabel st proto_insns
+ = foldM doInstr st proto_insns
+ where
+ doInstr :: AsmState -> BCInstr -> IO AsmState
+ doInstr st i
+ = case i of
+ ARGCHECK n -> instr2 st i_ARGCHECK n
+ PUSH_L o1 -> instr2 st i_PUSH_L o1
+ PUSH_LL o1 o2 -> instr3 st i_PUSH_LL o1 o2
+ PUSH_LLL o1 o2 o3 -> instr4 st i_PUSH_LLL o1 o2 o3
+ PUSH_G nm -> do (p, st2) <- ptr st nm
+ instr2 st2 i_PUSH_G p
+ PUSH_AS nm pk -> do (p, st2) <- ptr st nm
+ (np, st3) <- ret_itbl st2 pk
+ instr3 st3 i_PUSH_AS p np
+ PUSH_UBX lit nw32s -> do (np, st2) <- literal st lit
+ instr3 st2 i_PUSH_UBX np nw32s
+ PUSH_TAG tag -> instr2 st i_PUSH_TAG tag
+ SLIDE n by -> instr3 st i_SLIDE n by
+ ALLOC n -> instr2 st i_ALLOC n
+ MKAP off sz -> instr3 st i_MKAP off sz
+ UNPACK n -> instr2 st i_UNPACK n
+ UPK_TAG n m k -> instr4 st i_UPK_TAG n m k
+ PACK dcon sz -> do (np,st2) <- itbl st dcon
+ instr3 st2 i_PACK np sz
+ LABEL lab -> return st
+ TESTLT_I i l -> do (np, st2) <- int st i
+ instr3 st2 i_TESTLT_I np (findLabel l)
+ TESTEQ_I i l -> do (np, st2) <- int st i
+ instr3 st2 i_TESTEQ_I np (findLabel l)
+ TESTLT_F f l -> do (np, st2) <- float st f
+ instr3 st2 i_TESTLT_F np (findLabel l)
+ TESTEQ_F f l -> do (np, st2) <- float st f
+ instr3 st2 i_TESTEQ_F np (findLabel l)
+ TESTLT_D d l -> do (np, st2) <- double st d
+ instr3 st2 i_TESTLT_D np (findLabel l)
+ TESTEQ_D d l -> do (np, st2) <- double st d
+ instr3 st2 i_TESTEQ_D np (findLabel l)
+ TESTLT_P i l -> do (np, st2) <- int st i
+ instr3 st2 i_TESTLT_P np (findLabel l)
+ TESTEQ_P i l -> do (np, st2) <- int st i
+ instr3 st2 i_TESTEQ_P np (findLabel l)
+ CASEFAIL -> instr1 st i_CASEFAIL
+ ENTER -> instr1 st i_ENTER
+ RETURN -> instr1 st i_RETURN
+
+ i2s :: Int -> Word16
+ i2s = fromIntegral
+
+ instr1 (st_i0,st_l0,st_p0) i1
+ = do st_i1 <- addToXIOUArray st_i0 (i2s i1)
+ return (st_i1,st_l0,st_p0)
+
+ instr2 (st_i0,st_l0,st_p0) i1 i2
+ = do st_i1 <- addToXIOUArray st_i0 (i2s i1)
+ st_i2 <- addToXIOUArray st_i1 (i2s i2)
+ return (st_i2,st_l0,st_p0)
+
+ instr3 (st_i0,st_l0,st_p0) i1 i2 i3
+ = do st_i1 <- addToXIOUArray st_i0 (i2s i1)
+ st_i2 <- addToXIOUArray st_i1 (i2s i2)
+ st_i3 <- addToXIOUArray st_i2 (i2s i3)
+ return (st_i3,st_l0,st_p0)
+
+ instr4 (st_i0,st_l0,st_p0) i1 i2 i3 i4
+ = do st_i1 <- addToXIOUArray st_i0 (i2s i1)
+ st_i2 <- addToXIOUArray st_i1 (i2s i2)
+ st_i3 <- addToXIOUArray st_i2 (i2s i3)
+ st_i4 <- addToXIOUArray st_i3 (i2s i4)
+ return (st_i4,st_l0,st_p0)
+
+ float (st_i0,st_l0,st_p0) f
+ = do let w32s = mkLitF f
+ st_l1 <- addListToXIOUArray st_l0 w32s
+ return (usedXIOU st_l0, (st_i0,st_l1,st_p0))
+
+ double (st_i0,st_l0,st_p0) d
+ = do let w32s = mkLitD d
+ st_l1 <- addListToXIOUArray st_l0 w32s
+ return (usedXIOU st_l0, (st_i0,st_l1,st_p0))
+
+ int (st_i0,st_l0,st_p0) i
+ = do let w32s = mkLitI i
+ st_l1 <- addListToXIOUArray st_l0 w32s
+ return (usedXIOU st_l0, (st_i0,st_l1,st_p0))
+
+ addr (st_i0,st_l0,st_p0) a
+ = do let w32s = mkLitA a
+ st_l1 <- addListToXIOUArray st_l0 w32s
+ return (usedXIOU st_l0, (st_i0,st_l1,st_p0))
+
+ ptr (st_i0,st_l0,st_p0) p
+ = do st_p1 <- addToXIOArray st_p0 p
+ return (usedXIO st_p0, (st_i0,st_l0,st_p1))
+
+ literal st (MachInt j) = int st (fromIntegral j)
+ literal st (MachFloat r) = float st (fromRational r)
+ literal st (MachDouble r) = double st (fromRational r)
+
+ ret_itbl st pk = panic "ret_itbl" -- return (65535, st)
+ itbl st dcon = panic "itbl" -- return (65536, st)
+
+
+-- The size in bytes of an instruction.
+instrSizeB :: BCInstr -> Int
+instrSizeB instr
+ = case instr of
+ ARGCHECK _ -> 4
+ PUSH_L _ -> 4
+ PUSH_LL _ _ -> 6
+ PUSH_LLL _ _ _ -> 8
+ PUSH_G _ -> 4
+ SLIDE _ _ -> 6
+ ALLOC _ -> 4
+ MKAP _ _ -> 6
+ UNPACK _ -> 4
+ PACK _ _ -> 6
+ LABEL _ -> 4
+ TESTLT_I _ _ -> 6
+ TESTEQ_I _ _ -> 6
+ TESTLT_F _ _ -> 6
+ TESTEQ_F _ _ -> 6
+ TESTLT_D _ _ -> 6
+ TESTEQ_D _ _ -> 6
+ TESTLT_P _ _ -> 6
+ TESTEQ_P _ _ -> 6
+ CASEFAIL -> 2
+ ENTER -> 2
+ RETURN -> 2
+
+
+-- Sizes of Int, Float and Double literals, in units of 32-bitses
+intLitSz32s, floatLitSz32s, doubleLitSz32s, addrLitSz32s :: Int
+intLitSz32s = wORD_SIZE `div` 4
+floatLitSz32s = 1 -- Assume IEEE floats
+doubleLitSz32s = 2
+addrLitSz32s = intLitSz32s
+
+-- Make lists of 32-bit words for literals, so that when the
+-- words are placed in memory at increasing addresses, the
+-- bit pattern is correct for the host's word size and endianness.
+mkLitI :: Int -> [Word32]
+mkLitF :: Float -> [Word32]
+mkLitD :: Double -> [Word32]
+mkLitA :: Addr -> [Word32]
+
+mkLitF f
+ = runST (do
+ arr <- newFloatArray ((0::Int),0)
+ writeFloatArray arr 0 f
+ f_arr <- castSTUArray arr
+ w0 <- readWord32Array f_arr 0
+ return [w0]
+ )
+
+mkLitD d
+ = runST (do
+ arr <- newDoubleArray ((0::Int),0)
+ writeDoubleArray arr 0 d
+ d_arr <- castSTUArray arr
+ w0 <- readWord32Array d_arr 0
+ w1 <- readWord32Array d_arr 1
+ return [w0,w1]
+ )
+
+mkLitI i
+ | wORD_SIZE == 4
+ = runST (do
+ arr <- newIntArray ((0::Int),0)
+ writeIntArray arr 0 i
+ i_arr <- castSTUArray arr
+ w0 <- readWord32Array i_arr 0
+ return [w0]
+ )
+ | wORD_SIZE == 8
+ = runST (do
+ arr <- newIntArray ((0::Int),0)
+ writeIntArray arr 0 i
+ i_arr <- castSTUArray arr
+ w0 <- readWord32Array i_arr 0
+ w1 <- readWord32Array i_arr 1
+ return [w0,w1]
+ )
+
+mkLitA a
+ | wORD_SIZE == 4
+ = runST (do
+ arr <- newAddrArray ((0::Int),0)
+ writeAddrArray arr 0 a
+ a_arr <- castSTUArray arr
+ w0 <- readWord32Array a_arr 0
+ return [w0]
+ )
+ | wORD_SIZE == 8
+ = runST (do
+ arr <- newAddrArray ((0::Int),0)
+ writeAddrArray arr 0 a
+ a_arr <- castSTUArray arr
+ w0 <- readWord32Array a_arr 0
+ w1 <- readWord32Array a_arr 1
+ return [w0,w1]
+ )
+
+
+
+-- Zero-based expandable arrays
+data XIOUArray ele
+ = XIOUArray { usedXIOU :: Int, stuffXIOU :: (IOUArray Int ele) }
+data XIOArray ele
+ = XIOArray { usedXIO :: Int , stuffXIO :: (IOArray Int ele) }
+
+newXIOUArray size
+ = do arr <- newArray (0, size-1)
+ return (XIOUArray 0 arr)
+
+addListToXIOUArray xarr []
+ = return xarr
+addListToXIOUArray xarr (x:xs)
+ = addToXIOUArray xarr x >>= \ xarr' -> addListToXIOUArray xarr' xs
+
+
+addToXIOUArray :: MArray IOUArray a IO
+ => XIOUArray a -> a -> IO (XIOUArray a)
+addToXIOUArray (XIOUArray n_arr arr) x
+ = case bounds arr of
+ (lo, hi) -> ASSERT(lo == 0)
+ if n_arr > hi
+ then do new_arr <- newArray (0, 2*hi-1)
+ copy hi arr new_arr
+ addToXIOUArray (XIOUArray n_arr new_arr) x
+ else do writeArray arr n_arr x
+ return (XIOUArray (n_arr+1) arr)
+ where
+ copy :: MArray IOUArray a IO
+ => Int -> IOUArray Int a -> IOUArray Int a -> IO ()
+ copy n src dst
+ | n < 0 = return ()
+ | otherwise = do nx <- readArray src n
+ writeArray dst n nx
+ copy (n-1) src dst
+
+
+
+newXIOArray size
+ = do arr <- newArray (0, size-1)
+ return (XIOArray 0 arr)
+
+addToXIOArray :: XIOArray a -> a -> IO (XIOArray a)
+addToXIOArray (XIOArray n_arr arr) x
+ = case bounds arr of
+ (lo, hi) -> ASSERT(lo == 0)
+ if n_arr > hi
+ then do new_arr <- newArray (0, 2*hi-1)
+ copy hi arr new_arr
+ addToXIOArray (XIOArray n_arr new_arr) x
+ else do writeArray arr n_arr x
+ return (XIOArray (n_arr+1) arr)
+ where
+ copy :: Int -> IOArray Int a -> IOArray Int a -> IO ()
+ copy n src dst
+ | n < 0 = return ()
+ | otherwise = do nx <- readArray src n
+ writeArray dst n nx
+ copy (n-1) src dst
+
+
+#include "Bytecodes.h"
+
+i_ARGCHECK = (bci_ARGCHECK :: Int)
+i_PUSH_L = (bci_PUSH_L :: Int)
+i_PUSH_LL = (bci_PUSH_LL :: Int)
+i_PUSH_LLL = (bci_PUSH_LLL :: Int)
+i_PUSH_G = (bci_PUSH_G :: Int)
+i_PUSH_AS = (bci_PUSH_AS :: Int)
+i_PUSH_UBX = (bci_PUSH_UBX :: Int)
+i_PUSH_TAG = (bci_PUSH_TAG :: Int)
+i_SLIDE = (bci_SLIDE :: Int)
+i_ALLOC = (bci_ALLOC :: Int)
+i_MKAP = (bci_MKAP :: Int)
+i_UNPACK = (bci_UNPACK :: Int)
+i_UPK_TAG = (bci_UPK_TAG :: Int)
+i_PACK = (bci_PACK :: Int)
+i_LABEL = (bci_LABEL :: Int)
+i_TESTLT_I = (bci_TESTLT_I :: Int)
+i_TESTEQ_I = (bci_TESTEQ_I :: Int)
+i_TESTLT_F = (bci_TESTLT_F :: Int)
+i_TESTEQ_F = (bci_TESTEQ_F :: Int)
+i_TESTLT_D = (bci_TESTLT_D :: Int)
+i_TESTEQ_D = (bci_TESTEQ_D :: Int)
+i_TESTLT_P = (bci_TESTLT_P :: Int)
+i_TESTEQ_P = (bci_TESTEQ_P :: Int)
+i_CASEFAIL = (bci_CASEFAIL :: Int)
+i_ENTER = (bci_ENTER :: Int)
+i_RETURN = (bci_RETURN :: Int)
+
\end{code}