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