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