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