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