compiler/ghci/ByteCodeGen.lhs

   1 %
   2 % (c) The University of Glasgow 2002-2006
   3 %
   4
   5 ByteCodeGen: Generate bytecode from Core
   6
   7 \begin{code}
   8 module ByteCodeGen ( UnlinkedBCO, byteCodeGen, coreExprToBCOs ) where
   9
  10 #include "HsVersions.h"
  11
  12 import ByteCodeInstr
  13 import ByteCodeItbls
  14 import ByteCodeFFI
  15 import ByteCodeAsm
  16 import ByteCodeLink
  17
  18 import Outputable
  19 import Name
  20 import Id
  21 import FiniteMap
  22 import ForeignCall
  23 import HscTypes
  24 import CoreUtils
  25 import CoreSyn
  26 import PprCore
  27 import Literal
  28 import PrimOp
  29 import CoreFVs
  30 import Type
  31 import DataCon
  32 import TyCon
  33 import Class
  34 import Type
  35 import Util
  36 import DataCon
  37 import Var
  38 import VarSet
  39 import TysPrim
  40 import DynFlags
  41 import ErrUtils
  42 import Unique
  43 import FastString
  44 import Panic
  45 import SMRep
  46 import Bitmap
  47 import OrdList
  48 import Constants
  49
  50 import Data.List        ( intersperse, sortBy, zip4, zip6, partition )
  51 import Foreign          ( Ptr, castPtr, mallocBytes, pokeByteOff, Word8,
  52                           withForeignPtr, castFunPtrToPtr, nullPtr, plusPtr )
  53 import Foreign.C
  54 import Control.Exception        ( throwDyn )
  55
  56 import GHC.Exts         ( Int(..), ByteArray# )
  57
  58 import Control.Monad    ( when )
  59 import Data.Char        ( ord, chr )
  60
  61 import UniqSupply
  62 import BreakArray
  63 import Data.Maybe
  64 import Module
  65 import IdInfo
  66
  67 -- -----------------------------------------------------------------------------
  68 -- Generating byte code for a complete module
  69
  70 byteCodeGen :: DynFlags
  71             -> [CoreBind]
  72             -> [TyCon]
  73             -> ModBreaks
  74             -> IO CompiledByteCode
  75 byteCodeGen dflags binds tycs modBreaks
  76    = do showPass dflags "ByteCodeGen"
  77
  78         let flatBinds = [ (bndr, freeVars rhs)
  79                         | (bndr, rhs) <- flattenBinds binds]
  80
  81         us <- mkSplitUniqSupply 'y'
  82         (BcM_State _us final_ctr mallocd _, proto_bcos)
  83            <- runBc us modBreaks (mapM schemeTopBind flatBinds)
  84
  85         when (notNull mallocd)
  86              (panic "ByteCodeGen.byteCodeGen: missing final emitBc?")
  87
  88         dumpIfSet_dyn dflags Opt_D_dump_BCOs
  89            "Proto-BCOs" (vcat (intersperse (char ' ') (map ppr proto_bcos)))
  90
  91         assembleBCOs proto_bcos tycs
  92
  93 -- -----------------------------------------------------------------------------
  94 -- Generating byte code for an expression
  95
  96 -- Returns: (the root BCO for this expression,
  97 --           a list of auxilary BCOs resulting from compiling closures)
  98 coreExprToBCOs :: DynFlags
  99                -> CoreExpr
 100                -> IO UnlinkedBCO
 101 coreExprToBCOs dflags expr
 102  = do showPass dflags "ByteCodeGen"
 103
 104       -- create a totally bogus name for the top-level BCO; this
 105       -- should be harmless, since it's never used for anything
 106       let invented_name  = mkSystemVarName (mkPseudoUniqueE 0) FSLIT("ExprTopLevel")
 107           invented_id    = Id.mkLocalId invented_name (panic "invented_id's type")
 108
 109       -- the uniques are needed to generate fresh variables when we introduce new
 110       -- let bindings for ticked expressions
 111       us <- mkSplitUniqSupply 'y'
 112       (BcM_State _us final_ctr mallocd _ , proto_bco)
 113          <- runBc us emptyModBreaks (schemeTopBind (invented_id, freeVars expr))
 114
 115       when (notNull mallocd)
 116            (panic "ByteCodeGen.coreExprToBCOs: missing final emitBc?")
 117
 118       dumpIfSet_dyn dflags Opt_D_dump_BCOs "Proto-BCOs" (ppr proto_bco)
 119
 120       assembleBCO proto_bco
 121
 122
 123 -- -----------------------------------------------------------------------------
 124 -- Compilation schema for the bytecode generator
 125
 126 type BCInstrList = OrdList BCInstr
 127
 128 type Sequel = Int       -- back off to this depth before ENTER
 129
 130 -- Maps Ids to the offset from the stack _base_ so we don't have
 131 -- to mess with it after each push/pop.
 132 type BCEnv = FiniteMap Id Int   -- To find vars on the stack
 133
 134 ppBCEnv :: BCEnv -> SDoc
 135 ppBCEnv p
 136    = text "begin-env"
 137      $$ nest 4 (vcat (map pp_one (sortBy cmp_snd (fmToList p))))
 138      $$ text "end-env"
 139      where
 140         pp_one (var, offset) = int offset <> colon <+> ppr var <+> ppr (idCgRep var)
 141         cmp_snd x y = compare (snd x) (snd y)
 142
 143 -- Create a BCO and do a spot of peephole optimisation on the insns
 144 -- at the same time.
 145 mkProtoBCO
 146    :: name
 147    -> BCInstrList
 148    -> Either  [AnnAlt Id VarSet] (AnnExpr Id VarSet)
 149    -> Int
 150    -> Int
 151    -> [StgWord]
 152    -> Bool      -- True <=> is a return point, rather than a function
 153    -> [BcPtr]
 154    -> ProtoBCO name
 155 mkProtoBCO nm instrs_ordlist origin arity bitmap_size bitmap is_ret mallocd_blocks
 156    = ProtoBCO {
 157         protoBCOName = nm,
 158         protoBCOInstrs = maybe_with_stack_check,
 159         protoBCOBitmap = bitmap,
 160         protoBCOBitmapSize = bitmap_size,
 161         protoBCOArity = arity,
 162         protoBCOExpr = origin,
 163         protoBCOPtrs = mallocd_blocks
 164       }
 165      where
 166         -- Overestimate the stack usage (in words) of this BCO,
 167         -- and if >= iNTERP_STACK_CHECK_THRESH, add an explicit
 168         -- stack check.  (The interpreter always does a stack check
 169         -- for iNTERP_STACK_CHECK_THRESH words at the start of each
 170         -- BCO anyway, so we only need to add an explicit on in the
 171         -- (hopefully rare) cases when the (overestimated) stack use
 172         -- exceeds iNTERP_STACK_CHECK_THRESH.
 173         maybe_with_stack_check
 174            | is_ret = peep_d
 175                 -- don't do stack checks at return points;
 176                 -- everything is aggregated up to the top BCO
 177                 -- (which must be a function)
 178            | stack_overest >= iNTERP_STACK_CHECK_THRESH
 179            = STKCHECK stack_overest : peep_d
 180            | otherwise
 181            = peep_d     -- the supposedly common case
 182
 183         -- We assume that this sum doesn't wrap
 184         stack_overest = sum (map bciStackUse peep_d)
 185
 186         -- Merge local pushes
 187         peep_d = peep (fromOL instrs_ordlist)
 188
 189         peep (PUSH_L off1 : PUSH_L off2 : PUSH_L off3 : rest)
 190            = PUSH_LLL off1 (off2-1) (off3-2) : peep rest
 191         peep (PUSH_L off1 : PUSH_L off2 : rest)
 192            = PUSH_LL off1 (off2-1) : peep rest
 193         peep (i:rest)
 194            = i : peep rest
 195         peep []
 196            = []
 197
 198 argBits :: [CgRep] -> [Bool]
 199 argBits [] = []
 200 argBits (rep : args)
 201   | isFollowableArg rep = False : argBits args
 202   | otherwise = take (cgRepSizeW rep) (repeat True) ++ argBits args
 203
 204 -- -----------------------------------------------------------------------------
 205 -- schemeTopBind
 206
 207 -- Compile code for the right-hand side of a top-level binding
 208
 209 schemeTopBind :: (Id, AnnExpr Id VarSet) -> BcM (ProtoBCO Name)
 210
 211
 212 schemeTopBind (id, rhs)
 213   | Just data_con <- isDataConWorkId_maybe id,
 214     isNullaryRepDataCon data_con = do
 215         -- Special case for the worker of a nullary data con.
 216         -- It'll look like this:        Nil = /\a -> Nil a
 217         -- If we feed it into schemeR, we'll get
 218         --      Nil = Nil
 219         -- because mkConAppCode treats nullary constructor applications
 220         -- by just re-using the single top-level definition.  So
 221         -- for the worker itself, we must allocate it directly.
 222     -- ioToBc (putStrLn $ "top level BCO")
 223     emitBc (mkProtoBCO (getName id) (toOL [PACK data_con 0, ENTER])
 224                        (Right rhs) 0 0 [{-no bitmap-}] False{-not alts-})
 225
 226   | otherwise
 227   = schemeR [{- No free variables -}] (id, rhs)
 228
 229
 230 -- -----------------------------------------------------------------------------
 231 -- schemeR
 232
 233 -- Compile code for a right-hand side, to give a BCO that,
 234 -- when executed with the free variables and arguments on top of the stack,
 235 -- will return with a pointer to the result on top of the stack, after
 236 -- removing the free variables and arguments.
 237 --
 238 -- Park the resulting BCO in the monad.  Also requires the
 239 -- variable to which this value was bound, so as to give the
 240 -- resulting BCO a name.
 241
 242 schemeR :: [Id]                 -- Free vars of the RHS, ordered as they
 243                                 -- will appear in the thunk.  Empty for
 244                                 -- top-level things, which have no free vars.
 245         -> (Id, AnnExpr Id VarSet)
 246         -> BcM (ProtoBCO Name)
 247 schemeR fvs (nm, rhs)
 248 {-
 249    | trace (showSDoc (
 250               (char ' '
 251                $$ (ppr.filter (not.isTyVar).varSetElems.fst) rhs
 252                $$ pprCoreExpr (deAnnotate rhs)
 253                $$ char ' '
 254               ))) False
 255    = undefined
 256    | otherwise
 257 -}
 258    = schemeR_wrk fvs nm rhs (collect [] rhs)
 259
 260 collect :: [Var] -> AnnExpr Id VarSet -> ([Var], AnnExpr' Id VarSet)
 261 collect xs (_, AnnNote note e) = collect xs e
 262 collect xs (_, AnnCast e _)    = collect xs e
 263 collect xs (_, AnnLam x e)     = collect (if isTyVar x then xs else (x:xs)) e
 264 collect xs (_, not_lambda)     = (reverse xs, not_lambda)
 265
 266 schemeR_wrk :: [Id] -> Id -> AnnExpr Id VarSet -> ([Var], AnnExpr' Var VarSet) -> BcM (ProtoBCO Name)
 267 schemeR_wrk fvs nm original_body (args, body)
 268    = let
 269          all_args  = reverse args ++ fvs
 270          arity     = length all_args
 271          -- all_args are the args in reverse order.  We're compiling a function
 272          -- \fv1..fvn x1..xn -> e
 273          -- i.e. the fvs come first
 274
 275          szsw_args = map idSizeW all_args
 276          szw_args  = sum szsw_args
 277          p_init    = listToFM (zip all_args (mkStackOffsets 0 szsw_args))
 278
 279          -- make the arg bitmap
 280          bits = argBits (reverse (map idCgRep all_args))
 281          bitmap_size = length bits
 282          bitmap = mkBitmap bits
 283      in do
 284      body_code <- schemeER_wrk szw_args p_init body
 285
 286      emitBc (mkProtoBCO (getName nm) body_code (Right original_body)
 287                 arity bitmap_size bitmap False{-not alts-})
 288
 289 -- introduce break instructions for ticked expressions
 290 schemeER_wrk :: Int -> BCEnv -> AnnExpr' Id VarSet -> BcM BCInstrList
 291 schemeER_wrk d p rhs
 292    | Just (tickInfo, (_annot, newRhs)) <- isTickedExp' rhs = do
 293         code <- schemeE d 0 p newRhs
 294         arr <- getBreakArray
 295         let idOffSets = getVarOffSets d p tickInfo
 296         let tickNumber = tickInfo_number tickInfo
 297         let breakInfo = BreakInfo
 298                         { breakInfo_module = tickInfo_module tickInfo
 299                         , breakInfo_number = tickNumber
 300                         , breakInfo_vars = idOffSets
 301                         , breakInfo_resty = exprType (deAnnotate' newRhs)
 302                         }
 303         let breakInstr = case arr of (BA arr#) -> BRK_FUN arr# tickNumber breakInfo
 304         return $ breakInstr `consOL` code
 305    | otherwise = schemeE d 0 p rhs
 306
 307 getVarOffSets :: Int -> BCEnv -> TickInfo -> [(Id, Int)]
 308 getVarOffSets d p = catMaybes . map (getOffSet d p) . tickInfo_locals
 309
 310 getOffSet :: Int -> BCEnv -> Id -> Maybe (Id, Int)
 311 getOffSet d env id
 312    = case lookupBCEnv_maybe env id of
 313         Nothing     -> Nothing
 314         Just offset -> Just (id, d - offset)
 315
 316 fvsToEnv :: BCEnv -> VarSet -> [Id]
 317 -- Takes the free variables of a right-hand side, and
 318 -- delivers an ordered list of the local variables that will
 319 -- be captured in the thunk for the RHS
 320 -- The BCEnv argument tells which variables are in the local
 321 -- environment: these are the ones that should be captured
 322 --
 323 -- The code that constructs the thunk, and the code that executes
 324 -- it, have to agree about this layout
 325 fvsToEnv p fvs = [v | v <- varSetElems fvs,
 326                       isId v,           -- Could be a type variable
 327                       v `elemFM` p]
 328
 329 -- -----------------------------------------------------------------------------
 330 -- schemeE
 331
 332 data TickInfo
 333    = TickInfo
 334      { tickInfo_number :: Int     -- the (module) unique number of the tick
 335      , tickInfo_module :: Module  -- the origin of the ticked expression
 336      , tickInfo_locals :: [Id]    -- the local vars in scope at the ticked expression
 337      }
 338
 339 instance Outputable TickInfo where
 340    ppr info = text "TickInfo" <+>
 341               parens (int (tickInfo_number info) <+> ppr (tickInfo_module info) <+>
 342                       ppr (tickInfo_locals info))
 343
 344 -- Compile code to apply the given expression to the remaining args
 345 -- on the stack, returning a HNF.
 346 schemeE :: Int -> Sequel -> BCEnv -> AnnExpr' Id VarSet -> BcM BCInstrList
 347
 348 -- Delegate tail-calls to schemeT.
 349 schemeE d s p e@(AnnApp f a)
 350    = schemeT d s p e
 351
 352 schemeE d s p e@(AnnVar v)
 353    | not (isUnLiftedType v_type)
 354    =  -- Lifted-type thing; push it in the normal way
 355      schemeT d s p e
 356
 357    | otherwise
 358    = do -- Returning an unlifted value.
 359         -- Heave it on the stack, SLIDE, and RETURN.
 360         (push, szw) <- pushAtom d p (AnnVar v)
 361         return (push                    -- value onto stack
 362                   `appOL`  mkSLIDE szw (d-s)    -- clear to sequel
 363                   `snocOL` RETURN_UBX v_rep)    -- go
 364    where
 365       v_type = idType v
 366       v_rep = typeCgRep v_type
 367
 368 schemeE d s p (AnnLit literal)
 369    = do (push, szw) <- pushAtom d p (AnnLit literal)
 370         let l_rep = typeCgRep (literalType literal)
 371         return (push                    -- value onto stack
 372                `appOL`  mkSLIDE szw (d-s)       -- clear to sequel
 373                `snocOL` RETURN_UBX l_rep)       -- go
 374
 375 schemeE d s p (AnnLet (AnnNonRec x (_,rhs)) (_,body))
 376    | (AnnVar v, args_r_to_l) <- splitApp rhs,
 377      Just data_con <- isDataConWorkId_maybe v,
 378      dataConRepArity data_con == length args_r_to_l
 379    = do -- Special case for a non-recursive let whose RHS is a
 380         -- saturatred constructor application.
 381         -- Just allocate the constructor and carry on
 382         alloc_code <- mkConAppCode d s p data_con args_r_to_l
 383         body_code <- schemeE (d+1) s (addToFM p x d) body
 384         return (alloc_code `appOL` body_code)
 385
 386 -- General case for let.  Generates correct, if inefficient, code in
 387 -- all situations.
 388 schemeE d s p (AnnLet binds (_,body))
 389    = let (xs,rhss) = case binds of AnnNonRec x rhs  -> ([x],[rhs])
 390                                    AnnRec xs_n_rhss -> unzip xs_n_rhss
 391          n_binds = length xs
 392
 393          fvss  = map (fvsToEnv p' . fst) rhss
 394
 395          -- Sizes of free vars
 396          sizes = map (\rhs_fvs -> sum (map idSizeW rhs_fvs)) fvss
 397
 398          -- the arity of each rhs
 399          arities = map (length . fst . collect []) rhss
 400
 401          -- This p', d' defn is safe because all the items being pushed
 402          -- are ptrs, so all have size 1.  d' and p' reflect the stack
 403          -- after the closures have been allocated in the heap (but not
 404          -- filled in), and pointers to them parked on the stack.
 405          p'    = addListToFM p (zipE xs (mkStackOffsets d (nOfThem n_binds 1)))
 406          d'    = d + n_binds
 407          zipE  = zipEqual "schemeE"
 408
 409          -- ToDo: don't build thunks for things with no free variables
 410          build_thunk dd [] size bco off arity
 411             = return (PUSH_BCO bco `consOL` unitOL (mkap (off+size) size))
 412            where
 413                 mkap | arity == 0 = MKAP
 414                      | otherwise  = MKPAP
 415          build_thunk dd (fv:fvs) size bco off arity = do
 416               (push_code, pushed_szw) <- pushAtom dd p' (AnnVar fv)
 417               more_push_code <- build_thunk (dd+pushed_szw) fvs size bco off arity
 418               return (push_code `appOL` more_push_code)
 419
 420          alloc_code = toOL (zipWith mkAlloc sizes arities)
 421            where mkAlloc sz 0     = ALLOC_AP sz
 422                  mkAlloc sz arity = ALLOC_PAP arity sz
 423
 424          compile_bind d' fvs x rhs size arity off = do
 425                 bco <- schemeR fvs (x,rhs)
 426                 build_thunk d' fvs size bco off arity
 427
 428          compile_binds =
 429             [ compile_bind d' fvs x rhs size arity n
 430             | (fvs, x, rhs, size, arity, n) <-
 431                 zip6 fvss xs rhss sizes arities [n_binds, n_binds-1 .. 1]
 432             ]
 433      in do
 434      body_code <- schemeE d' s p' body
 435      thunk_codes <- sequence compile_binds
 436      return (alloc_code `appOL` concatOL thunk_codes `appOL` body_code)
 437
 438 -- introduce a let binding for a ticked case expression. This rule *should* only fire when the
 439 -- expression was not already let-bound (the code gen for let bindings should take care of that).
 440 -- Todo: we call exprFreeVars on a deAnnotated expression, this may not be the best way
 441 -- to calculate the free vars but it seemed like the least intrusive thing to do
 442 schemeE d s p exp@(AnnCase {})
 443    | Just (tickInfo, _exp) <- isTickedExp' exp = do
 444         let fvs = exprFreeVars $ deAnnotate' exp
 445         let ty = exprType $ deAnnotate' exp
 446         id <- newId ty
 447         -- Todo: is emptyVarSet correct on the next line?
 448         let letExp = AnnLet (AnnNonRec id (fvs, exp)) (emptyVarSet, AnnVar id)
 449         schemeE d s p letExp
 450
 451 schemeE d s p (AnnCase scrut bndr _ [(DataAlt dc, [bind1, bind2], rhs)])
 452    | isUnboxedTupleCon dc, VoidArg <- typeCgRep (idType bind1)
 453         -- Convert
 454         --      case .... of x { (# VoidArg'd-thing, a #) -> ... }
 455         -- to
 456         --      case .... of a { DEFAULT -> ... }
 457         -- becuse the return convention for both are identical.
 458         --
 459         -- Note that it does not matter losing the void-rep thing from the
 460         -- envt (it won't be bound now) because we never look such things up.
 461
 462    = --trace "automagic mashing of case alts (# VoidArg, a #)" $
 463      doCase d s p scrut bind2 [(DEFAULT, [], rhs)] True{-unboxed tuple-}
 464
 465    | isUnboxedTupleCon dc, VoidArg <- typeCgRep (idType bind2)
 466    = --trace "automagic mashing of case alts (# a, VoidArg #)" $
 467      doCase d s p scrut bind1 [(DEFAULT, [], rhs)] True{-unboxed tuple-}
 468
 469 schemeE d s p (AnnCase scrut bndr _ [(DataAlt dc, [bind1], rhs)])
 470    | isUnboxedTupleCon dc
 471         -- Similarly, convert
 472         --      case .... of x { (# a #) -> ... }
 473         -- to
 474         --      case .... of a { DEFAULT -> ... }
 475    = --trace "automagic mashing of case alts (# a #)"  $
 476      doCase d s p scrut bind1 [(DEFAULT, [], rhs)] True{-unboxed tuple-}
 477
 478 schemeE d s p (AnnCase scrut bndr _ alts)
 479    = doCase d s p scrut bndr alts False{-not an unboxed tuple-}
 480
 481 schemeE d s p (AnnNote note (_, body))
 482    = schemeE d s p body
 483
 484 schemeE d s p (AnnCast (_, body) _)
 485    = schemeE d s p body
 486
 487 schemeE d s p other
 488    = pprPanic "ByteCodeGen.schemeE: unhandled case"
 489                (pprCoreExpr (deAnnotate' other))
 490
 491 {-
 492    Ticked Expressions
 493    ------------------
 494
 495    A ticked expression looks like this:
 496
 497       case tick<n> var1 ... varN of DEFAULT -> e
 498
 499    (*) <n> is the number of the tick, which is unique within a module
 500    (*) var1 ... varN are the local variables in scope at the tick site
 501
 502    If we find a ticked expression we return:
 503
 504       Just ((n, [var1 ... varN]), e)
 505
 506   otherwise we return Nothing.
 507
 508   The idea is that the "case tick<n> ..." is really just an annotation on
 509   the code. When we find such a thing, we pull out the useful information,
 510   and then compile the code as if it was just the expression "e".
 511
 512 -}
 513
 514 isTickedExp :: AnnExpr Id a -> Maybe (TickInfo, AnnExpr Id a)
 515 isTickedExp (annot, expr) = isTickedExp' expr
 516
 517 isTickedExp' :: AnnExpr' Id a -> Maybe (TickInfo, AnnExpr Id a)
 518 isTickedExp' (AnnCase scrut _bndr _type alts)
 519    | Just tickInfo <- isTickedScrut scrut,
 520      [(DEFAULT, _bndr, rhs)] <- alts
 521      = Just (tickInfo, rhs)
 522    where
 523    isTickedScrut :: (AnnExpr Id a) -> Maybe TickInfo
 524    isTickedScrut expr
 525       | Var id <- f,
 526         Just (TickBox modName tickNumber) <- isTickBoxOp_maybe id
 527            = Just $ TickInfo { tickInfo_number = tickNumber
 528                              , tickInfo_module = modName
 529                              , tickInfo_locals = idsOfArgs args
 530                              }
 531       | otherwise = Nothing
 532       where
 533       (f, args) = collectArgs $ deAnnotate expr
 534       idsOfArgs :: [Expr Id] -> [Id]
 535       idsOfArgs = catMaybes . map exprId
 536       exprId :: Expr Id -> Maybe Id
 537       exprId (Var id) = Just id
 538       exprId other    = Nothing
 539
 540 isTickedExp' other = Nothing
 541
 542 -- Compile code to do a tail call.  Specifically, push the fn,
 543 -- slide the on-stack app back down to the sequel depth,
 544 -- and enter.  Four cases:
 545 --
 546 -- 0.  (Nasty hack).
 547 --     An application "GHC.Prim.tagToEnum# <type> unboxed-int".
 548 --     The int will be on the stack.  Generate a code sequence
 549 --     to convert it to the relevant constructor, SLIDE and ENTER.
 550 --
 551 -- 1.  The fn denotes a ccall.  Defer to generateCCall.
 552 --
 553 -- 2.  (Another nasty hack).  Spot (# a::VoidArg, b #) and treat
 554 --     it simply as  b  -- since the representations are identical
 555 --     (the VoidArg takes up zero stack space).  Also, spot
 556 --     (# b #) and treat it as  b.
 557 --
 558 -- 3.  Application of a constructor, by defn saturated.
 559 --     Split the args into ptrs and non-ptrs, and push the nonptrs,
 560 --     then the ptrs, and then do PACK and RETURN.
 561 --
 562 -- 4.  Otherwise, it must be a function call.  Push the args
 563 --     right to left, SLIDE and ENTER.
 564
 565 schemeT :: Int          -- Stack depth
 566         -> Sequel       -- Sequel depth
 567         -> BCEnv        -- stack env
 568         -> AnnExpr' Id VarSet
 569         -> BcM BCInstrList
 570
 571 schemeT d s p app
 572
 573 --   | trace ("schemeT: env in = \n" ++ showSDocDebug (ppBCEnv p)) False
 574 --   = panic "schemeT ?!?!"
 575
 576 --   | trace ("\nschemeT\n" ++ showSDoc (pprCoreExpr (deAnnotate' app)) ++ "\n") False
 577 --   = error "?!?!"
 578
 579    -- Case 0
 580    | Just (arg, constr_names) <- maybe_is_tagToEnum_call
 581    = do (push, arg_words) <- pushAtom d p arg
 582         tagToId_sequence <- implement_tagToId constr_names
 583         return (push `appOL`  tagToId_sequence
 584                        `appOL`  mkSLIDE 1 (d+arg_words-s)
 585                        `snocOL` ENTER)
 586
 587    -- Case 1
 588    | Just (CCall ccall_spec) <- isFCallId_maybe fn
 589    = generateCCall d s p ccall_spec fn args_r_to_l
 590
 591    -- Case 2: Constructor application
 592    | Just con <- maybe_saturated_dcon,
 593      isUnboxedTupleCon con
 594    = case args_r_to_l of
 595         [arg1,arg2] | isVoidArgAtom arg1 ->
 596                   unboxedTupleReturn d s p arg2
 597         [arg1,arg2] | isVoidArgAtom arg2 ->
 598                   unboxedTupleReturn d s p arg1
 599         _other -> unboxedTupleException
 600
 601    -- Case 3: Ordinary data constructor
 602    | Just con <- maybe_saturated_dcon
 603    = do alloc_con <- mkConAppCode d s p con args_r_to_l
 604         return (alloc_con        `appOL`
 605                   mkSLIDE 1 (d - s) `snocOL`
 606                   ENTER)
 607
 608    -- Case 4: Tail call of function
 609    | otherwise
 610    = doTailCall d s p fn args_r_to_l
 611
 612    where
 613       -- Detect and extract relevant info for the tagToEnum kludge.
 614       maybe_is_tagToEnum_call
 615          = let extract_constr_Names ty
 616                  | Just (tyc, []) <- splitTyConApp_maybe (repType ty),
 617                    isDataTyCon tyc
 618                    = map (getName . dataConWorkId) (tyConDataCons tyc)
 619                    -- NOTE: use the worker name, not the source name of
 620                    -- the DataCon.  See DataCon.lhs for details.
 621                  | otherwise
 622                    = panic "maybe_is_tagToEnum_call.extract_constr_Ids"
 623            in
 624            case app of
 625               (AnnApp (_, AnnApp (_, AnnVar v) (_, AnnType t)) arg)
 626                  -> case isPrimOpId_maybe v of
 627                        Just TagToEnumOp -> Just (snd arg, extract_constr_Names t)
 628                        other            -> Nothing
 629               other -> Nothing
 630
 631         -- Extract the args (R->L) and fn
 632         -- The function will necessarily be a variable,
 633         -- because we are compiling a tail call
 634       (AnnVar fn, args_r_to_l) = splitApp app
 635
 636       -- Only consider this to be a constructor application iff it is
 637       -- saturated.  Otherwise, we'll call the constructor wrapper.
 638       n_args = length args_r_to_l
 639       maybe_saturated_dcon
 640         = case isDataConWorkId_maybe fn of
 641                 Just con | dataConRepArity con == n_args -> Just con
 642                 _ -> Nothing
 643
 644 -- -----------------------------------------------------------------------------
 645 -- Generate code to build a constructor application,
 646 -- leaving it on top of the stack
 647
 648 mkConAppCode :: Int -> Sequel -> BCEnv
 649              -> DataCon                 -- The data constructor
 650              -> [AnnExpr' Id VarSet]    -- Args, in *reverse* order
 651              -> BcM BCInstrList
 652
 653 mkConAppCode orig_d s p con []  -- Nullary constructor
 654   = ASSERT( isNullaryRepDataCon con )
 655     return (unitOL (PUSH_G (getName (dataConWorkId con))))
 656         -- Instead of doing a PACK, which would allocate a fresh
 657         -- copy of this constructor, use the single shared version.
 658
 659 mkConAppCode orig_d s p con args_r_to_l
 660   = ASSERT( dataConRepArity con == length args_r_to_l )
 661     do_pushery orig_d (non_ptr_args ++ ptr_args)
 662  where
 663         -- The args are already in reverse order, which is the way PACK
 664         -- expects them to be.  We must push the non-ptrs after the ptrs.
 665       (ptr_args, non_ptr_args) = partition isPtrAtom args_r_to_l
 666
 667       do_pushery d (arg:args)
 668          = do (push, arg_words) <- pushAtom d p arg
 669               more_push_code <- do_pushery (d+arg_words) args
 670               return (push `appOL` more_push_code)
 671       do_pushery d []
 672          = return (unitOL (PACK con n_arg_words))
 673          where
 674            n_arg_words = d - orig_d
 675
 676
 677 -- -----------------------------------------------------------------------------
 678 -- Returning an unboxed tuple with one non-void component (the only
 679 -- case we can handle).
 680 --
 681 -- Remember, we don't want to *evaluate* the component that is being
 682 -- returned, even if it is a pointed type.  We always just return.
 683
 684 unboxedTupleReturn
 685         :: Int -> Sequel -> BCEnv
 686         -> AnnExpr' Id VarSet -> BcM BCInstrList
 687 unboxedTupleReturn d s p arg = do
 688   (push, sz) <- pushAtom d p arg
 689   return (push `appOL`
 690             mkSLIDE sz (d-s) `snocOL`
 691             RETURN_UBX (atomRep arg))
 692
 693 -- -----------------------------------------------------------------------------
 694 -- Generate code for a tail-call
 695
 696 doTailCall
 697         :: Int -> Sequel -> BCEnv
 698         -> Id -> [AnnExpr' Id VarSet]
 699         -> BcM BCInstrList
 700 doTailCall init_d s p fn args
 701   = do_pushes init_d args (map atomRep args)
 702   where
 703   do_pushes d [] reps = do
 704         ASSERT( null reps ) return ()
 705         (push_fn, sz) <- pushAtom d p (AnnVar fn)
 706         ASSERT( sz == 1 ) return ()
 707         return (push_fn `appOL` (
 708                   mkSLIDE ((d-init_d) + 1) (init_d - s) `appOL`
 709                   unitOL ENTER))
 710   do_pushes d args reps = do
 711       let (push_apply, n, rest_of_reps) = findPushSeq reps
 712           (these_args, rest_of_args) = splitAt n args
 713       (next_d, push_code) <- push_seq d these_args
 714       instrs <- do_pushes (next_d + 1) rest_of_args rest_of_reps
 715                 --                ^^^ for the PUSH_APPLY_ instruction
 716       return (push_code `appOL` (push_apply `consOL` instrs))
 717
 718   push_seq d [] = return (d, nilOL)
 719   push_seq d (arg:args) = do
 720     (push_code, sz) <- pushAtom d p arg
 721     (final_d, more_push_code) <- push_seq (d+sz) args
 722     return (final_d, push_code `appOL` more_push_code)
 723
 724 -- v. similar to CgStackery.findMatch, ToDo: merge
 725 findPushSeq (PtrArg: PtrArg: PtrArg: PtrArg: PtrArg: PtrArg: rest)
 726   = (PUSH_APPLY_PPPPPP, 6, rest)
 727 findPushSeq (PtrArg: PtrArg: PtrArg: PtrArg: PtrArg: rest)
 728   = (PUSH_APPLY_PPPPP, 5, rest)
 729 findPushSeq (PtrArg: PtrArg: PtrArg: PtrArg: rest)
 730   = (PUSH_APPLY_PPPP, 4, rest)
 731 findPushSeq (PtrArg: PtrArg: PtrArg: rest)
 732   = (PUSH_APPLY_PPP, 3, rest)
 733 findPushSeq (PtrArg: PtrArg: rest)
 734   = (PUSH_APPLY_PP, 2, rest)
 735 findPushSeq (PtrArg: rest)
 736   = (PUSH_APPLY_P, 1, rest)
 737 findPushSeq (VoidArg: rest)
 738   = (PUSH_APPLY_V, 1, rest)
 739 findPushSeq (NonPtrArg: rest)
 740   = (PUSH_APPLY_N, 1, rest)
 741 findPushSeq (FloatArg: rest)
 742   = (PUSH_APPLY_F, 1, rest)
 743 findPushSeq (DoubleArg: rest)
 744   = (PUSH_APPLY_D, 1, rest)
 745 findPushSeq (LongArg: rest)
 746   = (PUSH_APPLY_L, 1, rest)
 747 findPushSeq _
 748   = panic "ByteCodeGen.findPushSeq"
 749
 750 -- -----------------------------------------------------------------------------
 751 -- Case expressions
 752
 753 doCase  :: Int -> Sequel -> BCEnv
 754         -> AnnExpr Id VarSet -> Id -> [AnnAlt Id VarSet]
 755         -> Bool  -- True <=> is an unboxed tuple case, don't enter the result
 756         -> BcM BCInstrList
 757 doCase d s p (_,scrut) bndr alts is_unboxed_tuple
 758   = let
 759         -- Top of stack is the return itbl, as usual.
 760         -- underneath it is the pointer to the alt_code BCO.
 761         -- When an alt is entered, it assumes the returned value is
 762         -- on top of the itbl.
 763         ret_frame_sizeW = 2
 764
 765         -- An unlifted value gets an extra info table pushed on top
 766         -- when it is returned.
 767         unlifted_itbl_sizeW | isAlgCase = 0
 768                             | otherwise = 1
 769
 770         -- depth of stack after the return value has been pushed
 771         d_bndr = d + ret_frame_sizeW + idSizeW bndr
 772
 773         -- depth of stack after the extra info table for an unboxed return
 774         -- has been pushed, if any.  This is the stack depth at the
 775         -- continuation.
 776         d_alts = d_bndr + unlifted_itbl_sizeW
 777
 778         -- Env in which to compile the alts, not including
 779         -- any vars bound by the alts themselves
 780         p_alts = addToFM p bndr (d_bndr - 1)
 781
 782         bndr_ty = idType bndr
 783         isAlgCase = not (isUnLiftedType bndr_ty) && not is_unboxed_tuple
 784
 785         -- given an alt, return a discr and code for it.
 786         codeAlt alt@(DEFAULT, _, (_,rhs))
 787            = do rhs_code <- schemeE d_alts s p_alts rhs
 788                 return (NoDiscr, rhs_code)
 789
 790         codeAlt alt@(discr, bndrs, (_,rhs))
 791            -- primitive or nullary constructor alt: no need to UNPACK
 792            | null real_bndrs = do
 793                 rhs_code <- schemeE d_alts s p_alts rhs
 794                 return (my_discr alt, rhs_code)
 795            -- algebraic alt with some binders
 796            | ASSERT(isAlgCase) otherwise =
 797              let
 798                  (ptrs,nptrs) = partition (isFollowableArg.idCgRep) real_bndrs
 799                  ptr_sizes    = map idSizeW ptrs
 800                  nptrs_sizes  = map idSizeW nptrs
 801                  bind_sizes   = ptr_sizes ++ nptrs_sizes
 802                  size         = sum ptr_sizes + sum nptrs_sizes
 803                  -- the UNPACK instruction unpacks in reverse order...
 804                  p' = addListToFM p_alts
 805                         (zip (reverse (ptrs ++ nptrs))
 806                           (mkStackOffsets d_alts (reverse bind_sizes)))
 807              in do
 808              rhs_code <- schemeE (d_alts+size) s p' rhs
 809              return (my_discr alt, unitOL (UNPACK size) `appOL` rhs_code)
 810            where
 811              real_bndrs = filter (not.isTyVar) bndrs
 812
 813         my_discr (DEFAULT, binds, rhs) = NoDiscr {-shouldn't really happen-}
 814         my_discr (DataAlt dc, binds, rhs)
 815            | isUnboxedTupleCon dc
 816            = unboxedTupleException
 817            | otherwise
 818            = DiscrP (dataConTag dc - fIRST_TAG)
 819         my_discr (LitAlt l, binds, rhs)
 820            = case l of MachInt i     -> DiscrI (fromInteger i)
 821                        MachFloat r   -> DiscrF (fromRational r)
 822                        MachDouble r  -> DiscrD (fromRational r)
 823                        MachChar i    -> DiscrI (ord i)
 824                        _ -> pprPanic "schemeE(AnnCase).my_discr" (ppr l)
 825
 826         maybe_ncons
 827            | not isAlgCase = Nothing
 828            | otherwise
 829            = case [dc | (DataAlt dc, _, _) <- alts] of
 830                 []     -> Nothing
 831                 (dc:_) -> Just (tyConFamilySize (dataConTyCon dc))
 832
 833         -- the bitmap is relative to stack depth d, i.e. before the
 834         -- BCO, info table and return value are pushed on.
 835         -- This bit of code is v. similar to buildLivenessMask in CgBindery,
 836         -- except that here we build the bitmap from the known bindings of
 837         -- things that are pointers, whereas in CgBindery the code builds the
 838         -- bitmap from the free slots and unboxed bindings.
 839         -- (ToDo: merge?)
 840         --
 841         -- NOTE [7/12/2006] bug #1013, testcase ghci/should_run/ghci002.
 842         -- The bitmap must cover the portion of the stack up to the sequel only.
 843         -- Previously we were building a bitmap for the whole depth (d), but we
 844         -- really want a bitmap up to depth (d-s).  This affects compilation of
 845         -- case-of-case expressions, which is the only time we can be compiling a
 846         -- case expression with s /= 0.
 847         bitmap_size = d-s
 848         bitmap = intsToReverseBitmap bitmap_size{-size-}
 849                         (sortLe (<=) (filter (< bitmap_size) rel_slots))
 850           where
 851           binds = fmToList p
 852           rel_slots = concat (map spread binds)
 853           spread (id, offset)
 854                 | isFollowableArg (idCgRep id) = [ rel_offset ]
 855                 | otherwise = []
 856                 where rel_offset = d - offset - 1
 857
 858      in do
 859      alt_stuff <- mapM codeAlt alts
 860      alt_final <- mkMultiBranch maybe_ncons alt_stuff
 861
 862      let
 863          alt_bco_name = getName bndr
 864          alt_bco = mkProtoBCO alt_bco_name alt_final (Left alts)
 865                         0{-no arity-} bitmap_size bitmap True{-is alts-}
 866      -- in
 867 --     trace ("case: bndr = " ++ showSDocDebug (ppr bndr) ++ "\ndepth = " ++ show d ++ "\nenv = \n" ++ showSDocDebug (ppBCEnv p) ++
 868 --           "\n      bitmap = " ++ show bitmap) $ do
 869      scrut_code <- schemeE (d + ret_frame_sizeW) (d + ret_frame_sizeW) p scrut
 870      alt_bco' <- emitBc alt_bco
 871      let push_alts
 872             | isAlgCase = PUSH_ALTS alt_bco'
 873             | otherwise = PUSH_ALTS_UNLIFTED alt_bco' (typeCgRep bndr_ty)
 874      return (push_alts `consOL` scrut_code)
 875
 876
 877 -- -----------------------------------------------------------------------------
 878 -- Deal with a CCall.
 879
 880 -- Taggedly push the args onto the stack R->L,
 881 -- deferencing ForeignObj#s and adjusting addrs to point to
 882 -- payloads in Ptr/Byte arrays.  Then, generate the marshalling
 883 -- (machine) code for the ccall, and create bytecodes to call that and
 884 -- then return in the right way.
 885
 886 generateCCall :: Int -> Sequel          -- stack and sequel depths
 887               -> BCEnv
 888               -> CCallSpec              -- where to call
 889               -> Id                     -- of target, for type info
 890               -> [AnnExpr' Id VarSet]   -- args (atoms)
 891               -> BcM BCInstrList
 892
 893 generateCCall d0 s p ccall_spec@(CCallSpec target cconv safety) fn args_r_to_l
 894    = let
 895          -- useful constants
 896          addr_sizeW = cgRepSizeW NonPtrArg
 897
 898          -- Get the args on the stack, with tags and suitably
 899          -- dereferenced for the CCall.  For each arg, return the
 900          -- depth to the first word of the bits for that arg, and the
 901          -- CgRep of what was actually pushed.
 902
 903          pargs d [] = return []
 904          pargs d (a:az)
 905             = let arg_ty = repType (exprType (deAnnotate' a))
 906
 907               in case splitTyConApp_maybe arg_ty of
 908                     -- Don't push the FO; instead push the Addr# it
 909                     -- contains.
 910                     Just (t, _)
 911                      | t == arrayPrimTyCon || t == mutableArrayPrimTyCon
 912                        -> do rest <- pargs (d + addr_sizeW) az
 913                              code <- parg_ArrayishRep arrPtrsHdrSize d p a
 914                              return ((code,NonPtrArg):rest)
 915
 916                      | t == byteArrayPrimTyCon || t == mutableByteArrayPrimTyCon
 917                        -> do rest <- pargs (d + addr_sizeW) az
 918                              code <- parg_ArrayishRep arrWordsHdrSize d p a
 919                              return ((code,NonPtrArg):rest)
 920
 921                     -- Default case: push taggedly, but otherwise intact.
 922                     other
 923                        -> do (code_a, sz_a) <- pushAtom d p a
 924                              rest <- pargs (d+sz_a) az
 925                              return ((code_a, atomRep a) : rest)
 926
 927          -- Do magic for Ptr/Byte arrays.  Push a ptr to the array on
 928          -- the stack but then advance it over the headers, so as to
 929          -- point to the payload.
 930          parg_ArrayishRep hdrSize d p a
 931             = do (push_fo, _) <- pushAtom d p a
 932                  -- The ptr points at the header.  Advance it over the
 933                  -- header and then pretend this is an Addr#.
 934                  return (push_fo `snocOL` SWIZZLE 0 hdrSize)
 935
 936      in do
 937      code_n_reps <- pargs d0 args_r_to_l
 938      let
 939          (pushs_arg, a_reps_pushed_r_to_l) = unzip code_n_reps
 940
 941          push_args    = concatOL pushs_arg
 942          d_after_args = d0 + sum (map cgRepSizeW a_reps_pushed_r_to_l)
 943          a_reps_pushed_RAW
 944             | null a_reps_pushed_r_to_l || head a_reps_pushed_r_to_l /= VoidArg
 945             = panic "ByteCodeGen.generateCCall: missing or invalid World token?"
 946             | otherwise
 947             = reverse (tail a_reps_pushed_r_to_l)
 948
 949          -- Now: a_reps_pushed_RAW are the reps which are actually on the stack.
 950          -- push_args is the code to do that.
 951          -- d_after_args is the stack depth once the args are on.
 952
 953          -- Get the result rep.
 954          (returns_void, r_rep)
 955             = case maybe_getCCallReturnRep (idType fn) of
 956                  Nothing -> (True,  VoidArg)
 957                  Just rr -> (False, rr)
 958          {-
 959          Because the Haskell stack grows down, the a_reps refer to
 960          lowest to highest addresses in that order.  The args for the call
 961          are on the stack.  Now push an unboxed Addr# indicating
 962          the C function to call.  Then push a dummy placeholder for the
 963          result.  Finally, emit a CCALL insn with an offset pointing to the
 964          Addr# just pushed, and a literal field holding the mallocville
 965          address of the piece of marshalling code we generate.
 966          So, just prior to the CCALL insn, the stack looks like this
 967          (growing down, as usual):
 968
 969             <arg_n>
 970             ...
 971             <arg_1>
 972             Addr# address_of_C_fn
 973             <placeholder-for-result#> (must be an unboxed type)
 974
 975          The interpreter then calls the marshall code mentioned
 976          in the CCALL insn, passing it (& <placeholder-for-result#>),
 977          that is, the addr of the topmost word in the stack.
 978          When this returns, the placeholder will have been
 979          filled in.  The placeholder is slid down to the sequel
 980          depth, and we RETURN.
 981
 982          This arrangement makes it simple to do f-i-dynamic since the Addr#
 983          value is the first arg anyway.
 984
 985          The marshalling code is generated specifically for this
 986          call site, and so knows exactly the (Haskell) stack
 987          offsets of the args, fn address and placeholder.  It
 988          copies the args to the C stack, calls the stacked addr,
 989          and parks the result back in the placeholder.  The interpreter
 990          calls it as a normal C call, assuming it has a signature
 991             void marshall_code ( StgWord* ptr_to_top_of_stack )
 992          -}
 993          -- resolve static address
 994          get_target_info
 995             = case target of
 996                  DynamicTarget
 997                     -> return (False, panic "ByteCodeGen.generateCCall(dyn)")
 998                  StaticTarget target
 999                     -> do res <- ioToBc (lookupStaticPtr target)
1000                           return (True, res)
1001      -- in
1002      (is_static, static_target_addr) <- get_target_info
1003      let
1004
1005          -- Get the arg reps, zapping the leading Addr# in the dynamic case
1006          a_reps --  | trace (showSDoc (ppr a_reps_pushed_RAW)) False = error "???"
1007                 | is_static = a_reps_pushed_RAW
1008                 | otherwise = if null a_reps_pushed_RAW
1009                               then panic "ByteCodeGen.generateCCall: dyn with no args"
1010                               else tail a_reps_pushed_RAW
1011
1012          -- push the Addr#
1013          (push_Addr, d_after_Addr)
1014             | is_static
1015             = (toOL [PUSH_UBX (Right static_target_addr) addr_sizeW],
1016                d_after_args + addr_sizeW)
1017             | otherwise -- is already on the stack
1018             = (nilOL, d_after_args)
1019
1020          -- Push the return placeholder.  For a call returning nothing,
1021          -- this is a VoidArg (tag).
1022          r_sizeW   = cgRepSizeW r_rep
1023          d_after_r = d_after_Addr + r_sizeW
1024          r_lit     = mkDummyLiteral r_rep
1025          push_r    = (if   returns_void
1026                       then nilOL
1027                       else unitOL (PUSH_UBX (Left r_lit) r_sizeW))
1028
1029          -- generate the marshalling code we're going to call
1030          r_offW       = 0
1031          addr_offW    = r_sizeW
1032          arg1_offW    = r_sizeW + addr_sizeW
1033          args_offW    = map (arg1_offW +)
1034                             (init (scanl (+) 0 (map cgRepSizeW a_reps)))
1035      -- in
1036      addr_of_marshaller <- ioToBc (mkMarshalCode cconv
1037                                 (r_offW, r_rep) addr_offW
1038                                 (zip args_offW a_reps))
1039      recordItblMallocBc (ItblPtr (castFunPtrToPtr addr_of_marshaller))
1040      let
1041          -- Offset of the next stack frame down the stack.  The CCALL
1042          -- instruction needs to describe the chunk of stack containing
1043          -- the ccall args to the GC, so it needs to know how large it
1044          -- is.  See comment in Interpreter.c with the CCALL instruction.
1045          stk_offset   = d_after_r - s
1046
1047          -- do the call
1048          do_call      = unitOL (CCALL stk_offset (castFunPtrToPtr addr_of_marshaller))
1049          -- slide and return
1050          wrapup       = mkSLIDE r_sizeW (d_after_r - r_sizeW - s)
1051                         `snocOL` RETURN_UBX r_rep
1052      --in
1053          --trace (show (arg1_offW, args_offW  ,  (map cgRepSizeW a_reps) )) $
1054      return (
1055          push_args `appOL`
1056          push_Addr `appOL` push_r `appOL` do_call `appOL` wrapup
1057          )
1058
1059
1060 -- Make a dummy literal, to be used as a placeholder for FFI return
1061 -- values on the stack.
1062 mkDummyLiteral :: CgRep -> Literal
1063 mkDummyLiteral pr
1064    = case pr of
1065         NonPtrArg -> MachWord 0
1066         DoubleArg -> MachDouble 0
1067         FloatArg  -> MachFloat 0
1068         LongArg   -> MachWord64 0
1069         _         -> moan64 "mkDummyLiteral" (ppr pr)
1070
1071
1072 -- Convert (eg)
1073 --     GHC.Prim.Char# -> GHC.Prim.State# GHC.Prim.RealWorld
1074 --                   -> (# GHC.Prim.State# GHC.Prim.RealWorld, GHC.Prim.Int# #)
1075 --
1076 -- to  Just IntRep
1077 -- and check that an unboxed pair is returned wherein the first arg is VoidArg'd.
1078 --
1079 -- Alternatively, for call-targets returning nothing, convert
1080 --
1081 --     GHC.Prim.Char# -> GHC.Prim.State# GHC.Prim.RealWorld
1082 --                   -> (# GHC.Prim.State# GHC.Prim.RealWorld #)
1083 --
1084 -- to  Nothing
1085
1086 maybe_getCCallReturnRep :: Type -> Maybe CgRep
1087 maybe_getCCallReturnRep fn_ty
1088    = let (a_tys, r_ty) = splitFunTys (dropForAlls fn_ty)
1089          maybe_r_rep_to_go
1090             = if isSingleton r_reps then Nothing else Just (r_reps !! 1)
1091          (r_tycon, r_reps)
1092             = case splitTyConApp_maybe (repType r_ty) of
1093                       (Just (tyc, tys)) -> (tyc, map typeCgRep tys)
1094                       Nothing -> blargh
1095          ok = ( ( r_reps `lengthIs` 2 && VoidArg == head r_reps)
1096                 || r_reps == [VoidArg] )
1097               && isUnboxedTupleTyCon r_tycon
1098               && case maybe_r_rep_to_go of
1099                     Nothing    -> True
1100                     Just r_rep -> r_rep /= PtrArg
1101                                   -- if it was, it would be impossible
1102                                   -- to create a valid return value
1103                                   -- placeholder on the stack
1104          blargh = pprPanic "maybe_getCCallReturn: can't handle:"
1105                            (pprType fn_ty)
1106      in
1107      --trace (showSDoc (ppr (a_reps, r_reps))) $
1108      if ok then maybe_r_rep_to_go else blargh
1109
1110 -- Compile code which expects an unboxed Int on the top of stack,
1111 -- (call it i), and pushes the i'th closure in the supplied list
1112 -- as a consequence.
1113 implement_tagToId :: [Name] -> BcM BCInstrList
1114 implement_tagToId names
1115    = ASSERT( notNull names )
1116      do labels <- getLabelsBc (length names)
1117         label_fail <- getLabelBc
1118         label_exit <- getLabelBc
1119         let infos = zip4 labels (tail labels ++ [label_fail])
1120                                 [0 ..] names
1121             steps = map (mkStep label_exit) infos
1122         return (concatOL steps
1123                   `appOL`
1124                   toOL [LABEL label_fail, CASEFAIL, LABEL label_exit])
1125      where
1126         mkStep l_exit (my_label, next_label, n, name_for_n)
1127            = toOL [LABEL my_label,
1128                    TESTEQ_I n next_label,
1129                    PUSH_G name_for_n,
1130                    JMP l_exit]
1131
1132
1133 -- -----------------------------------------------------------------------------
1134 -- pushAtom
1135
1136 -- Push an atom onto the stack, returning suitable code & number of
1137 -- stack words used.
1138 --
1139 -- The env p must map each variable to the highest- numbered stack
1140 -- slot for it.  For example, if the stack has depth 4 and we
1141 -- tagged-ly push (v :: Int#) on it, the value will be in stack[4],
1142 -- the tag in stack[5], the stack will have depth 6, and p must map v
1143 -- to 5 and not to 4.  Stack locations are numbered from zero, so a
1144 -- depth 6 stack has valid words 0 .. 5.
1145
1146 pushAtom :: Int -> BCEnv -> AnnExpr' Id VarSet -> BcM (BCInstrList, Int)
1147
1148 pushAtom d p (AnnApp f (_, AnnType _))
1149    = pushAtom d p (snd f)
1150
1151 pushAtom d p (AnnNote note e)
1152    = pushAtom d p (snd e)
1153
1154 pushAtom d p (AnnLam x e)
1155    | isTyVar x
1156    = pushAtom d p (snd e)
1157
1158 pushAtom d p (AnnVar v)
1159
1160    | idCgRep v == VoidArg
1161    = return (nilOL, 0)
1162
1163    | isFCallId v
1164    = pprPanic "pushAtom: shouldn't get an FCallId here" (ppr v)
1165
1166    | Just primop <- isPrimOpId_maybe v
1167    = return (unitOL (PUSH_PRIMOP primop), 1)
1168
1169    | Just d_v <- lookupBCEnv_maybe p v  -- v is a local variable
1170    = return (toOL (nOfThem sz (PUSH_L (d-d_v+sz-2))), sz)
1171          -- d - d_v                 the number of words between the TOS
1172          --                         and the 1st slot of the object
1173          --
1174          -- d - d_v - 1             the offset from the TOS of the 1st slot
1175          --
1176          -- d - d_v - 1 + sz - 1    the offset from the TOS of the last slot
1177          --                         of the object.
1178          --
1179          -- Having found the last slot, we proceed to copy the right number of
1180          -- slots on to the top of the stack.
1181
1182     | otherwise  -- v must be a global variable
1183     = ASSERT(sz == 1)
1184       return (unitOL (PUSH_G (getName v)), sz)
1185
1186     where
1187          sz = idSizeW v
1188
1189
1190 pushAtom d p (AnnLit lit)
1191    = case lit of
1192         MachLabel fs _ -> code NonPtrArg
1193         MachWord w     -> code NonPtrArg
1194         MachInt i      -> code PtrArg
1195         MachFloat r    -> code FloatArg
1196         MachDouble r   -> code DoubleArg
1197         MachChar c     -> code NonPtrArg
1198         MachStr s      -> pushStr s
1199      where
1200         code rep
1201            = let size_host_words = cgRepSizeW rep
1202              in  return (unitOL (PUSH_UBX (Left lit) size_host_words),
1203                            size_host_words)
1204
1205         pushStr s
1206            = let getMallocvilleAddr
1207                     = case s of
1208                          FastString _ n _ fp _ ->
1209                             -- we could grab the Ptr from the ForeignPtr,
1210                             -- but then we have no way to control its lifetime.
1211                             -- In reality it'll probably stay alive long enoungh
1212                             -- by virtue of the global FastString table, but
1213                             -- to be on the safe side we copy the string into
1214                             -- a malloc'd area of memory.
1215                                 do ptr <- ioToBc (mallocBytes (n+1))
1216                                    recordMallocBc ptr
1217                                    ioToBc (
1218                                       withForeignPtr fp $ \p -> do
1219                                          memcpy ptr p (fromIntegral n)
1220                                          pokeByteOff ptr n (fromIntegral (ord '\0') :: Word8)
1221                                          return ptr
1222                                       )
1223              in do
1224                 addr <- getMallocvilleAddr
1225                 -- Get the addr on the stack, untaggedly
1226                 return (unitOL (PUSH_UBX (Right addr) 1), 1)
1227
1228 pushAtom d p (AnnCast e _)
1229    = pushAtom d p (snd e)
1230
1231 pushAtom d p other
1232    = pprPanic "ByteCodeGen.pushAtom"
1233               (pprCoreExpr (deAnnotate (undefined, other)))
1234
1235 foreign import ccall unsafe "memcpy"
1236  memcpy :: Ptr a -> Ptr b -> CSize -> IO ()
1237
1238
1239 -- -----------------------------------------------------------------------------
1240 -- Given a bunch of alts code and their discrs, do the donkey work
1241 -- of making a multiway branch using a switch tree.
1242 -- What a load of hassle!
1243
1244 mkMultiBranch :: Maybe Int      --  # datacons in tycon, if alg alt
1245                                 -- a hint; generates better code
1246                                 -- Nothing is always safe
1247               -> [(Discr, BCInstrList)]
1248               -> BcM BCInstrList
1249 mkMultiBranch maybe_ncons raw_ways
1250    = let d_way     = filter (isNoDiscr.fst) raw_ways
1251          notd_ways = sortLe
1252                         (\w1 w2 -> leAlt (fst w1) (fst w2))
1253                         (filter (not.isNoDiscr.fst) raw_ways)
1254
1255          mkTree :: [(Discr, BCInstrList)] -> Discr -> Discr -> BcM BCInstrList
1256          mkTree [] range_lo range_hi = return the_default
1257
1258          mkTree [val] range_lo range_hi
1259             | range_lo `eqAlt` range_hi
1260             = return (snd val)
1261             | otherwise
1262             = do label_neq <- getLabelBc
1263                  return (mkTestEQ (fst val) label_neq
1264                           `consOL` (snd val
1265                           `appOL`   unitOL (LABEL label_neq)
1266                           `appOL`   the_default))
1267
1268          mkTree vals range_lo range_hi
1269             = let n = length vals `div` 2
1270                   vals_lo = take n vals
1271                   vals_hi = drop n vals
1272                   v_mid = fst (head vals_hi)
1273               in do
1274               label_geq <- getLabelBc
1275               code_lo <- mkTree vals_lo range_lo (dec v_mid)
1276               code_hi <- mkTree vals_hi v_mid range_hi
1277               return (mkTestLT v_mid label_geq
1278                         `consOL` (code_lo
1279                         `appOL`   unitOL (LABEL label_geq)
1280                         `appOL`   code_hi))
1281
1282          the_default
1283             = case d_way of [] -> unitOL CASEFAIL
1284                             [(_, def)] -> def
1285
1286          -- None of these will be needed if there are no non-default alts
1287          (mkTestLT, mkTestEQ, init_lo, init_hi)
1288             | null notd_ways
1289             = panic "mkMultiBranch: awesome foursome"
1290             | otherwise
1291             = case fst (head notd_ways) of {
1292               DiscrI _ -> ( \(DiscrI i) fail_label -> TESTLT_I i fail_label,
1293                             \(DiscrI i) fail_label -> TESTEQ_I i fail_label,
1294                             DiscrI minBound,
1295                             DiscrI maxBound );
1296               DiscrF _ -> ( \(DiscrF f) fail_label -> TESTLT_F f fail_label,
1297                             \(DiscrF f) fail_label -> TESTEQ_F f fail_label,
1298                             DiscrF minF,
1299                             DiscrF maxF );
1300               DiscrD _ -> ( \(DiscrD d) fail_label -> TESTLT_D d fail_label,
1301                             \(DiscrD d) fail_label -> TESTEQ_D d fail_label,
1302                             DiscrD minD,
1303                             DiscrD maxD );
1304               DiscrP _ -> ( \(DiscrP i) fail_label -> TESTLT_P i fail_label,
1305                             \(DiscrP i) fail_label -> TESTEQ_P i fail_label,
1306                             DiscrP algMinBound,
1307                             DiscrP algMaxBound )
1308               }
1309
1310          (algMinBound, algMaxBound)
1311             = case maybe_ncons of
1312                  Just n  -> (0, n - 1)
1313                  Nothing -> (minBound, maxBound)
1314
1315          (DiscrI i1) `eqAlt` (DiscrI i2) = i1 == i2
1316          (DiscrF f1) `eqAlt` (DiscrF f2) = f1 == f2
1317          (DiscrD d1) `eqAlt` (DiscrD d2) = d1 == d2
1318          (DiscrP i1) `eqAlt` (DiscrP i2) = i1 == i2
1319          NoDiscr     `eqAlt` NoDiscr     = True
1320          _           `eqAlt` _           = False
1321
1322          (DiscrI i1) `leAlt` (DiscrI i2) = i1 <= i2
1323          (DiscrF f1) `leAlt` (DiscrF f2) = f1 <= f2
1324          (DiscrD d1) `leAlt` (DiscrD d2) = d1 <= d2
1325          (DiscrP i1) `leAlt` (DiscrP i2) = i1 <= i2
1326          NoDiscr     `leAlt` NoDiscr     = True
1327          _           `leAlt` _           = False
1328
1329          isNoDiscr NoDiscr = True
1330          isNoDiscr _       = False
1331
1332          dec (DiscrI i) = DiscrI (i-1)
1333          dec (DiscrP i) = DiscrP (i-1)
1334          dec other      = other         -- not really right, but if you
1335                 -- do cases on floating values, you'll get what you deserve
1336
1337          -- same snotty comment applies to the following
1338          minF, maxF :: Float
1339          minD, maxD :: Double
1340          minF = -1.0e37
1341          maxF =  1.0e37
1342          minD = -1.0e308
1343          maxD =  1.0e308
1344      in
1345          mkTree notd_ways init_lo init_hi
1346
1347
1348 -- -----------------------------------------------------------------------------
1349 -- Supporting junk for the compilation schemes
1350
1351 -- Describes case alts
1352 data Discr
1353    = DiscrI Int
1354    | DiscrF Float
1355    | DiscrD Double
1356    | DiscrP Int
1357    | NoDiscr
1358
1359 instance Outputable Discr where
1360    ppr (DiscrI i) = int i
1361    ppr (DiscrF f) = text (show f)
1362    ppr (DiscrD d) = text (show d)
1363    ppr (DiscrP i) = int i
1364    ppr NoDiscr    = text "DEF"
1365
1366
1367 lookupBCEnv_maybe :: BCEnv -> Id -> Maybe Int
1368 lookupBCEnv_maybe = lookupFM
1369
1370 idSizeW :: Id -> Int
1371 idSizeW id = cgRepSizeW (typeCgRep (idType id))
1372
1373 unboxedTupleException :: a
1374 unboxedTupleException
1375    = throwDyn
1376         (Panic
1377            ("Bytecode generator can't handle unboxed tuples.  Possibly due\n" ++
1378             "\tto foreign import/export decls in source.  Workaround:\n" ++
1379             "\tcompile this module to a .o file, then restart session."))
1380
1381
1382 mkSLIDE n d = if d == 0 then nilOL else unitOL (SLIDE n d)
1383 bind x f    = f x
1384
1385 splitApp :: AnnExpr' id ann -> (AnnExpr' id ann, [AnnExpr' id ann])
1386         -- The arguments are returned in *right-to-left* order
1387 splitApp (AnnApp (_,f) (_,a))
1388                | isTypeAtom a = splitApp f
1389                | otherwise    = case splitApp f of
1390                                      (f', as) -> (f', a:as)
1391 splitApp (AnnNote n (_,e))    = splitApp e
1392 splitApp (AnnCast (_,e) _)    = splitApp e
1393 splitApp e                    = (e, [])
1394
1395
1396 isTypeAtom :: AnnExpr' id ann -> Bool
1397 isTypeAtom (AnnType _) = True
1398 isTypeAtom _           = False
1399
1400 isVoidArgAtom :: AnnExpr' id ann -> Bool
1401 isVoidArgAtom (AnnVar v)        = typeCgRep (idType v) == VoidArg
1402 isVoidArgAtom (AnnNote n (_,e)) = isVoidArgAtom e
1403 isVoidArgAtom (AnnCast (_,e) _) = isVoidArgAtom e
1404 isVoidArgAtom _                 = False
1405
1406 atomRep :: AnnExpr' Id ann -> CgRep
1407 atomRep (AnnVar v)    = typeCgRep (idType v)
1408 atomRep (AnnLit l)    = typeCgRep (literalType l)
1409 atomRep (AnnNote n b) = atomRep (snd b)
1410 atomRep (AnnApp f (_, AnnType _)) = atomRep (snd f)
1411 atomRep (AnnLam x e) | isTyVar x = atomRep (snd e)
1412 atomRep (AnnCast b _) = atomRep (snd b)
1413 atomRep other = pprPanic "atomRep" (ppr (deAnnotate (undefined,other)))
1414
1415 isPtrAtom :: AnnExpr' Id ann -> Bool
1416 isPtrAtom e = atomRep e == PtrArg
1417
1418 -- Let szsw be the sizes in words of some items pushed onto the stack,
1419 -- which has initial depth d'.  Return the values which the stack environment
1420 -- should map these items to.
1421 mkStackOffsets :: Int -> [Int] -> [Int]
1422 mkStackOffsets original_depth szsw
1423    = map (subtract 1) (tail (scanl (+) original_depth szsw))
1424
1425 -- -----------------------------------------------------------------------------
1426 -- The bytecode generator's monad
1427
1428 type BcPtr = Either ItblPtr (Ptr ())
1429
1430 data BcM_State
1431    = BcM_State {
1432         uniqSupply :: UniqSupply,       -- for generating fresh variable names
1433         nextlabel :: Int,               -- for generating local labels
1434         malloced  :: [BcPtr],           -- thunks malloced for current BCO
1435                                         -- Should be free()d when it is GCd
1436         breakArray :: BreakArray        -- array of breakpoint flags
1437         }
1438
1439 newtype BcM r = BcM (BcM_State -> IO (BcM_State, r))
1440
1441 ioToBc :: IO a -> BcM a
1442 ioToBc io = BcM $ \st -> do
1443   x <- io
1444   return (st, x)
1445
1446 runBc :: UniqSupply -> ModBreaks -> BcM r -> IO (BcM_State, r)
1447 runBc us modBreaks (BcM m)
1448    = m (BcM_State us 0 [] breakArray)
1449    where
1450    breakArray = modBreaks_flags modBreaks
1451
1452 thenBc :: BcM a -> (a -> BcM b) -> BcM b
1453 thenBc (BcM expr) cont = BcM $ \st0 -> do
1454   (st1, q) <- expr st0
1455   let BcM k = cont q
1456   (st2, r) <- k st1
1457   return (st2, r)
1458
1459 thenBc_ :: BcM a -> BcM b -> BcM b
1460 thenBc_ (BcM expr) (BcM cont) = BcM $ \st0 -> do
1461   (st1, q) <- expr st0
1462   (st2, r) <- cont st1
1463   return (st2, r)
1464
1465 returnBc :: a -> BcM a
1466 returnBc result = BcM $ \st -> (return (st, result))
1467
1468 instance Monad BcM where
1469   (>>=) = thenBc
1470   (>>)  = thenBc_
1471   return = returnBc
1472
1473 emitBc :: ([BcPtr] -> ProtoBCO Name) -> BcM (ProtoBCO Name)
1474 emitBc bco
1475   = BcM $ \st -> return (st{malloced=[]}, bco (malloced st))
1476
1477 recordMallocBc :: Ptr a -> BcM ()
1478 recordMallocBc a
1479   = BcM $ \st -> return (st{malloced = Right (castPtr a) : malloced st}, ())
1480
1481 recordItblMallocBc :: ItblPtr -> BcM ()
1482 recordItblMallocBc a
1483   = BcM $ \st -> return (st{malloced = Left a : malloced st}, ())
1484
1485 getLabelBc :: BcM Int
1486 getLabelBc
1487   = BcM $ \st -> return (st{nextlabel = 1 + nextlabel st}, nextlabel st)
1488
1489 getLabelsBc :: Int -> BcM [Int]
1490 getLabelsBc n
1491   = BcM $ \st -> let ctr = nextlabel st
1492                  in return (st{nextlabel = ctr+n}, [ctr .. ctr+n-1])
1493
1494 getBreakArray :: BcM BreakArray
1495 getBreakArray = BcM $ \st -> return (st, breakArray st)
1496
1497 newUnique :: BcM Unique
1498 newUnique = BcM $
1499    \st -> case splitUniqSupply (uniqSupply st) of
1500              (us1, us2) -> let newState = st { uniqSupply = us2 }
1501                            in  return (newState, uniqFromSupply us1)
1502
1503 newId :: Type -> BcM Id
1504 newId ty = do
1505     uniq <- newUnique
1506     return $ mkSysLocal FSLIT("ticked") uniq ty
1507 \end{code}