StgCmmHeap.hs 21.5 KB
Newer Older
1 2 3 4 5 6 7 8 9
-----------------------------------------------------------------------------
--
-- Stg to C--: heap management functions
--
-- (c) The University of Glasgow 2004-2006
--
-----------------------------------------------------------------------------

module StgCmmHeap (
10 11
        getVirtHp, setVirtHp, setRealHp,
        getHpRelOffset, hpRel,
12

13
        entryHeapCheck, altHeapCheck, altHeapCheckReturnsTo,
14

15 16
        mkVirtHeapOffsets, mkVirtConstrOffsets,
        mkStaticClosureFields, mkStaticClosure,
17

18
        allocDynClosure, allocDynClosureCmm, emitSetDynHdr
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
    ) where

#include "HsVersions.h"

import StgSyn
import CLabel
import StgCmmLayout
import StgCmmUtils
import StgCmmMonad
import StgCmmProf
import StgCmmTicky
import StgCmmGran
import StgCmmClosure
import StgCmmEnv

34
import MkGraph
35

36
import Hoopl hiding ((<*>), mkBranch)
37
import SMRep
38
import Cmm
39 40 41
import CmmUtils
import CostCentre
import Outputable
42
import IdInfo( CafInfo(..), mayHaveCafRefs )
43
import Module
44
import FastString( mkFastString, fsLit )
45
import Constants
46
import Util
47

48 49
import Control.Monad (when)

50
-----------------------------------------------------------
51
--              Initialise dynamic heap objects
52 53 54
-----------------------------------------------------------

allocDynClosure
Simon Marlow's avatar
Simon Marlow committed
55 56
        :: CmmInfoTable
        -> LambdaFormInfo
57 58 59 60 61 62 63 64 65 66
        -> CmmExpr              -- Cost Centre to stick in the object
        -> CmmExpr              -- Cost Centre to blame for this alloc
                                -- (usually the same; sometimes "OVERHEAD")

        -> [(NonVoid StgArg, VirtualHpOffset)]  -- Offsets from start of object
                                                -- ie Info ptr has offset zero.
                                                -- No void args in here
        -> FCode (LocalReg, CmmAGraph)

allocDynClosureCmm
Simon Marlow's avatar
Simon Marlow committed
67
        :: CmmInfoTable -> LambdaFormInfo -> CmmExpr -> CmmExpr
68 69 70 71
        -> [(CmmExpr, VirtualHpOffset)]
        -> FCode (LocalReg, CmmAGraph)

-- allocDynClosure allocates the thing in the heap,
72
-- and modifies the virtual Hp to account for this.
73 74 75
-- The second return value is the graph that sets the value of the
-- returned LocalReg, which should point to the closure after executing
-- the graph.
76 77 78 79 80

-- Note [Return a LocalReg]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- allocDynClosure returns a LocalReg, not a (Hp+8) CmmExpr.
-- Reason:
81 82 83 84 85
--      ...allocate object...
--      obj = Hp + 8
--      y = f(z)
--      ...here obj is still valid,
--         but Hp+8 means something quite different...
86 87


Simon Marlow's avatar
Simon Marlow committed
88
allocDynClosure info_tbl lf_info use_cc _blame_cc args_w_offsets
89 90
  = do  { let (args, offsets) = unzip args_w_offsets
        ; cmm_args <- mapM getArgAmode args     -- No void args
Simon Marlow's avatar
Simon Marlow committed
91 92
        ; allocDynClosureCmm info_tbl lf_info
                             use_cc _blame_cc (zip cmm_args offsets)
93 94
        }

Simon Marlow's avatar
Simon Marlow committed
95
allocDynClosureCmm info_tbl lf_info use_cc _blame_cc amodes_w_offsets
96 97 98
  = do  { virt_hp <- getVirtHp

        -- SAY WHAT WE ARE ABOUT TO DO
Simon Marlow's avatar
Simon Marlow committed
99 100 101
        ; let rep = cit_rep info_tbl
        ; tickyDynAlloc rep lf_info
        ; profDynAlloc rep use_cc
102 103 104 105 106 107 108 109

        -- FIND THE OFFSET OF THE INFO-PTR WORD
        ; let   info_offset = virt_hp + 1
                -- info_offset is the VirtualHpOffset of the first
                -- word of the new object
                -- Remember, virtHp points to last allocated word,
                -- ie 1 *before* the info-ptr word of new object.

Simon Marlow's avatar
Simon Marlow committed
110
                info_ptr = CmmLit (CmmLabel (cit_lbl info_tbl))
111 112 113

        -- ALLOCATE THE OBJECT
        ; base <- getHpRelOffset info_offset
114
        ; emitComment $ mkFastString "allocDynClosure"
115 116 117 118 119
        ; emitSetDynHdr base info_ptr  use_cc
        ; let (cmm_args, offsets) = unzip amodes_w_offsets
        ; hpStore base cmm_args offsets

        -- BUMP THE VIRTUAL HEAP POINTER
Simon Marlow's avatar
Simon Marlow committed
120
        ; setVirtHp (virt_hp + heapClosureSize rep)
121 122 123 124 125

        -- Assign to a temporary and return
        -- Note [Return a LocalReg]
        ; hp_rel <- getHpRelOffset info_offset
        ; getCodeR $ assignTemp hp_rel }
126 127

emitSetDynHdr :: CmmExpr -> CmmExpr -> CmmExpr -> FCode ()
128
emitSetDynHdr base info_ptr ccs
129 130 131 132
  = hpStore base header [0..]
  where
    header :: [CmmExpr]
    header = [info_ptr] ++ dynProfHdr ccs
133 134 135
        -- ToDo: Gransim stuff
        -- ToDo: Parallel stuff
        -- No ticky header
136 137 138 139 140 141

hpStore :: CmmExpr -> [CmmExpr] -> [VirtualHpOffset] -> FCode ()
-- Store the item (expr,off) in base[off]
hpStore base vals offs
  = emit (catAGraphs (zipWith mk_store vals offs))
  where
142
    mk_store val off = mkStore (cmmOffsetW base off) val
143 144 145


-----------------------------------------------------------
146
--              Layout of static closures
147 148 149 150 151
-----------------------------------------------------------

-- Make a static closure, adding on any extra padding needed for CAFs,
-- and adding a static link field if necessary.

152
mkStaticClosureFields
Simon Marlow's avatar
Simon Marlow committed
153
        :: CmmInfoTable
154
        -> CostCentreStack
155
        -> CafInfo
Simon Marlow's avatar
Simon Marlow committed
156
        -> Bool                 -- SRT is non-empty?
157 158
        -> [CmmLit]             -- Payload
        -> [CmmLit]             -- The full closure
Simon Marlow's avatar
Simon Marlow committed
159
mkStaticClosureFields info_tbl ccs caf_refs has_srt payload
160 161
  = mkStaticClosure info_lbl ccs payload padding
        static_link_field saved_info_field
162
  where
Simon Marlow's avatar
Simon Marlow committed
163
    info_lbl = cit_lbl info_tbl
164 165 166 167 168 169 170 171 172

    -- CAFs must have consistent layout, regardless of whether they
    -- are actually updatable or not.  The layout of a CAF is:
    --
    --        3 saved_info
    --        2 static_link
    --        1 indirectee
    --        0 info ptr
    --
Simon Marlow's avatar
Simon Marlow committed
173 174 175
    -- the static_link and saved_info fields must always be in the
    -- same place.  So we use isThunkRep rather than closureUpdReqd
    -- here:
176

Simon Marlow's avatar
Simon Marlow committed
177
    is_caf = isThunkRep (cit_rep info_tbl)
178

179 180 181
    padding
        | not is_caf = []
        | otherwise  = ASSERT(null payload) [mkIntCLit 0]
182 183

    static_link_field
Simon Marlow's avatar
Simon Marlow committed
184 185 186 187
        | is_caf || staticClosureNeedsLink has_srt info_tbl
        = [static_link_value]
        | otherwise
        = []
188 189

    saved_info_field
190 191
        | is_caf     = [mkIntCLit 0]
        | otherwise  = []
192

193
        -- For a static constructor which has NoCafRefs, we set the
194 195
        -- static link field to a non-zero value so the garbage
        -- collector will ignore it.
196
    static_link_value
197 198
        | mayHaveCafRefs caf_refs  = mkIntCLit 0
        | otherwise                = mkIntCLit 1  -- No CAF refs
199 200 201 202


mkStaticClosure :: CLabel -> CostCentreStack -> [CmmLit]
  -> [CmmLit] -> [CmmLit] -> [CmmLit] -> [CmmLit]
203
mkStaticClosure info_lbl ccs payload padding static_link_field saved_info_field
204 205
  =  [CmmLabel info_lbl]
  ++ variable_header_words
206
  ++ concatMap padLitToWord payload
207
  ++ padding
208 209 210 211
  ++ static_link_field
  ++ saved_info_field
  where
    variable_header_words
212 213 214 215
        =  staticGranHdr
        ++ staticParHdr
        ++ staticProfHdr ccs
        ++ staticTickyHdr
216

217 218
-- JD: Simon had ellided this padding, but without it the C back end asserts
-- failure. Maybe it's a bad assertion, and this padding is indeed unnecessary?
219 220 221 222 223 224 225 226 227 228 229
padLitToWord :: CmmLit -> [CmmLit]
padLitToWord lit = lit : padding pad_length
  where width = typeWidth (cmmLitType lit)
        pad_length = wORD_SIZE - widthInBytes width :: Int

        padding n | n <= 0 = []
                  | n `rem` 2 /= 0 = CmmInt 0 W8  : padding (n-1)
                  | n `rem` 4 /= 0 = CmmInt 0 W16 : padding (n-2)
                  | n `rem` 8 /= 0 = CmmInt 0 W32 : padding (n-4)
                  | otherwise      = CmmInt 0 W64 : padding (n-8)

230
-----------------------------------------------------------
231
--              Heap overflow checking
232 233 234 235 236 237 238 239 240 241 242 243
-----------------------------------------------------------

{- Note [Heap checks]
   ~~~~~~~~~~~~~~~~~~
Heap checks come in various forms.  We provide the following entry
points to the runtime system, all of which use the native C-- entry
convention.

  * gc() performs garbage collection and returns
    nothing to its caller

  * A series of canned entry points like
244
        r = gc_1p( r )
245 246
    where r is a pointer.  This performs gc, and
    then returns its argument r to its caller.
247

248
  * A series of canned entry points like
249
        gcfun_2p( f, x, y )
250 251 252 253 254 255 256 257 258
    where f is a function closure of arity 2
    This performs garbage collection, keeping alive the
    three argument ptrs, and then tail-calls f(x,y)

These are used in the following circumstances

* entryHeapCheck: Function entry
    (a) With a canned GC entry sequence
        f( f_clo, x:ptr, y:ptr ) {
259 260 261
             Hp = Hp+8
             if Hp > HpLim goto L
             ...
262 263 264
          L: HpAlloc = 8
             jump gcfun_2p( f_clo, x, y ) }
     Note the tail call to the garbage collector;
265
     it should do no register shuffling
266 267 268

    (b) No canned sequence
        f( f_clo, x:ptr, y:ptr, ...etc... ) {
269 270 271
          T: Hp = Hp+8
             if Hp > HpLim goto L
             ...
272
          L: HpAlloc = 8
273 274
             call gc()  -- Needs an info table
             goto T }
275 276

* altHeapCheck: Immediately following an eval
277 278
  Started as
        case f x y of r { (p,q) -> rhs }
279 280 281
  (a) With a canned sequence for the results of f
       (which is the very common case since
       all boxed cases return just one pointer
282 283 284 285 286 287
           ...
           r = f( x, y )
        K:      -- K needs an info table
           Hp = Hp+8
           if Hp > HpLim goto L
           ...code for rhs...
288

289 290
        L: r = gc_1p( r )
           goto K }
291

292 293 294 295
        Here, the info table needed by the call
        to gc_1p should be the *same* as the
        one for the call to f; the C-- optimiser
        spots this sharing opportunity)
296 297 298

   (b) No canned sequence for results of f
       Note second info table
299 300 301 302 303 304
           ...
           (r1,r2,r3) = call f( x, y )
        K:
           Hp = Hp+8
           if Hp > HpLim goto L
           ...code for rhs...
305

306 307
        L: call gc()    -- Extra info table here
           goto K
308 309 310

* generalHeapCheck: Anywhere else
  e.g. entry to thunk
311
       case branch *not* following eval,
312 313 314
       or let-no-escape
  Exactly the same as the previous case:

315 316 317 318
        K:      -- K needs an info table
           Hp = Hp+8
           if Hp > HpLim goto L
           ...
319

320 321
        L: call gc()
           goto K
322 323 324 325 326
-}

--------------------------------------------------------------
-- A heap/stack check at a function or thunk entry point.

327 328 329 330 331 332 333
entryHeapCheck :: ClosureInfo
               -> Int            -- Arg Offset
               -> Maybe LocalReg -- Function (closure environment)
               -> Int            -- Arity -- not same as len args b/c of voids
               -> [LocalReg]     -- Non-void args (empty for thunk)
               -> FCode ()
               -> FCode ()
334

335
entryHeapCheck cl_info offset nodeSet arity args code
336
  = do let is_thunk = arity == 0
337 338 339 340 341 342
           is_fastf = case closureFunInfo cl_info of
                           Just (_, ArgGen _) -> False
                           _otherwise         -> True

           args' = map (CmmReg . CmmLocal) args
           setN = case nodeSet of
Simon Marlow's avatar
Simon Marlow committed
343
                          Just _  -> mkNop -- No need to assign R1, it already
344
                                           -- points to the closure
345
                          Nothing -> mkAssign nodeReg $
346
                              CmmLit (CmmLabel $ staticClosureLabel cl_info)
347

348
           {- Thunks:          jump GCEnter1
349 350 351 352 353 354 355 356 357 358 359 360 361 362
              Function (fast): Set R1 = node, jump GCFun
              Function (slow): Set R1 = node, call generic_gc -}
           gc_call upd = setN <*> gc_lbl upd
           gc_lbl upd
               | is_thunk  = mkDirectJump (CmmReg $ CmmGlobal GCEnter1) [] sp
               | is_fastf  = mkDirectJump (CmmReg $ CmmGlobal GCFun) [] sp
               | otherwise = mkForeignJump Slow (CmmReg $ CmmGlobal GCFun) args' upd
               where sp = max offset upd
           {- DT (12/08/10) This is a little fishy, mainly the sp fix up amount.
            - This is since the ncg inserts spills before the stack/heap check.
            - This should be fixed up and then we won't need to fix up the Sp on
            - GC calls, but until then this fishy code works -}

       updfr_sz <- getUpdFrameOff
363 364 365 366

       loop_id <- newLabelC
       emitLabel loop_id
       heapCheck True (gc_call updfr_sz <*> mkBranch loop_id) code
367 368 369 370 371 372 373 374 375

{-
    -- This code is slightly outdated now and we could easily keep the above
    -- GC methods. However, there may be some performance gains to be made by
    -- using more specialised GC entry points. Since the semi generic GCFun
    -- entry needs to check the node and figure out what registers to save...
    -- if we provided and used more specialised GC entry points then these
    -- runtime decisions could be turned into compile time decisions.

376 377
    args'     = case fun of Just f  -> f : args
                            Nothing -> args
378
    arg_exprs = map (CmmReg . CmmLocal) args'
379
    gc_call updfr_sz
380
        | arity == 0 = mkJumpGC (CmmReg (CmmGlobal GCEnter1)) arg_exprs updfr_sz
381 382 383 384 385 386
        | otherwise =
            case gc_lbl args' of
                Just _lbl -> panic "StgCmmHeap.entryHeapCheck: not finished"
                            -- mkJumpGC (CmmLit (CmmLabel (mkRtsCodeLabel lbl)))
                            --         arg_exprs updfr_sz
                Nothing  -> mkCall generic_gc (GC, GC) [] [] updfr_sz
387

388
    gc_lbl :: [LocalReg] -> Maybe FastString
389
    gc_lbl [reg]
390 391 392 393 394 395 396 397 398 399 400
        | isGcPtrType ty  = Just (sLit "stg_gc_unpt_r1") -- "stg_gc_fun_1p"
        | isFloatType ty  = case width of
                              W32 -> Just (sLit "stg_gc_f1")
                              W64 -> Just (sLit "stg_gc_d1")
                              _other -> Nothing
        | width == wordWidth = Just (mkGcLabel "stg_gc_unbx_r1")
        | width == W64       = Just (mkGcLabel "stg_gc_l1")
        | otherwise          = Nothing
        where
          ty = localRegType reg
          width = typeWidth ty
401 402 403

    gc_lbl regs = gc_lbl_ptrs (map (isGcPtrType . localRegType) regs)

404
    gc_lbl_ptrs :: [Bool] -> Maybe FastString
405
    -- JD: TEMPORARY -- UNTIL THESE FUNCTIONS EXIST...
406 407 408
    --gc_lbl_ptrs [True,True]      = Just (sLit "stg_gc_fun_2p")
    --gc_lbl_ptrs [True,True,True] = Just (sLit "stg_gc_fun_3p")
    gc_lbl_ptrs _ = Nothing
409 410 411
-}


412 413
-- ------------------------------------------------------------
-- A heap/stack check in a case alternative
414

415 416
altHeapCheck :: [LocalReg] -> FCode a -> FCode a
altHeapCheck regs code
417 418 419 420 421 422
  = do loop_id <- newLabelC
       emitLabel loop_id
       altHeapCheckReturnsTo regs loop_id code

altHeapCheckReturnsTo :: [LocalReg] -> Label -> FCode a -> FCode a
altHeapCheckReturnsTo regs retry_lbl code
423
  = do updfr_sz <- getUpdFrameOff
424
       gc_call_code <- gc_call updfr_sz
425
       heapCheck False (gc_call_code <*> mkBranch retry_lbl) code
426

427 428
  where
    reg_exprs = map (CmmReg . CmmLocal) regs
429
      -- Note [stg_gc arguments]
430 431 432

    gc_call sp =
        case rts_label regs of
Simon Marlow's avatar
Simon Marlow committed
433 434
             Just gc -> mkCall (CmmLit gc) (GC, GC) regs reg_exprs sp (0,[])
             Nothing -> mkCall generic_gc (GC, GC) [] [] sp (0,[])
435 436 437 438 439 440 441 442 443 444 445 446 447 448

    rts_label [reg]
        | isGcPtrType ty = Just (mkGcLabel "stg_gc_unpt_r1")
        | isFloatType ty = case width of
                                W32       -> Just (mkGcLabel "stg_gc_f1")
                                W64       -> Just (mkGcLabel "stg_gc_d1")
                                _         -> Nothing

        | width == wordWidth = Just (mkGcLabel "stg_gc_unbx_r1")
        | width == W64       = Just (mkGcLabel "stg_gc_l1")
        | otherwise          = Nothing
        where
            ty = localRegType reg
            width = typeWidth ty
449 450 451

    rts_label _ = Nothing

452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
-- Note [stg_gc arguments]
-- It might seem that we could avoid passing the arguments to the
-- stg_gc function, because they are already in the right registers.
-- While this is usually the case, it isn't always.  Sometimes the
-- code generator has cleverly avoided the eval in a case, e.g. in
-- ffi/should_run/4221.hs we found
--
--   case a_r1mb of z
--     FunPtr x y -> ...
--
-- where a_r1mb is bound a top-level constructor, and is known to be
-- evaluated.  The codegen just assigns x, y and z, and continues;
-- R1 is never assigned.
--
-- So we'll have to rely on optimisations to eliminatethese
-- assignments where possible.

469

470 471 472 473 474 475 476
-- | The generic GC procedure; no params, no results
generic_gc :: CmmExpr
generic_gc = CmmLit $ mkGcLabel "stg_gc_noregs"

-- | Create a CLabel for calling a garbage collector entry point
mkGcLabel :: String -> CmmLit
mkGcLabel = (CmmLabel . (mkCmmCodeLabel rtsPackageId) . fsLit)
477 478

-------------------------------
479 480
heapCheck :: Bool -> CmmAGraph -> FCode a -> FCode a
heapCheck checkStack do_gc code
481
  = getHeapUsage $ \ hpHw ->
482 483
    -- Emit heap checks, but be sure to do it lazily so
    -- that the conditionals on hpHw don't cause a black hole
484
    do  { codeOnly $ do_checks checkStack hpHw do_gc
485 486 487 488
        ; tickyAllocHeap hpHw
        ; doGranAllocate hpHw
        ; setRealHp hpHw
        ; code }
489

490
do_checks :: Bool       -- Should we check the stack?
491 492
          -> WordOff    -- Heap headroom
          -> CmmAGraph  -- What to do on failure
493 494 495 496
          -> FCode ()
do_checks checkStack alloc do_gc = do
  gc_id <- newLabelC

497 498
  when checkStack $
     emit =<< mkCmmIfGoto sp_oflo gc_id
499

500 501 502
  when (alloc /= 0) $ do
     emitAssign hpReg bump_hp
     emit =<< mkCmmIfThen hp_oflo (alloc_n <*> mkBranch gc_id)
503 504

  emitOutOfLine gc_id $
505 506
     do_gc -- this is expected to jump back somewhere

507 508 509 510 511 512
                -- Test for stack pointer exhaustion, then
                -- bump heap pointer, and test for heap exhaustion
                -- Note that we don't move the heap pointer unless the
                -- stack check succeeds.  Otherwise we might end up
                -- with slop at the end of the current block, which can
                -- confuse the LDV profiler.
513
  where
514
    alloc_lit = CmmLit (mkIntCLit (alloc*wORD_SIZE)) -- Bytes
515 516
    bump_hp   = cmmOffsetExprB (CmmReg hpReg) alloc_lit

517 518 519
    -- Sp overflow if (Sp - CmmHighStack < SpLim)
    sp_oflo = CmmMachOp mo_wordULt
                  [CmmMachOp (MO_Sub (typeWidth (cmmRegType spReg)))
520 521
                             [CmmReg spReg, CmmLit CmmHighStackMark],
                   CmmReg spLimReg]
522

523 524 525 526 527 528 529
    -- Hp overflow if (Hp > HpLim)
    -- (Hp has been incremented by now)
    -- HpLim points to the LAST WORD of valid allocation space.
    hp_oflo = CmmMachOp mo_wordUGt
                  [CmmReg hpReg, CmmReg (CmmGlobal HpLim)]

    alloc_n = mkAssign (CmmGlobal HpAlloc) alloc_lit
530 531 532 533 534 535 536 537 538 539

{-

{- Unboxed tuple alternatives and let-no-escapes (the two most annoying
constructs to generate code for!)  For unboxed tuple returns, there
are an arbitrary number of possibly unboxed return values, some of
which will be in registers, and the others will be on the stack.  We
always organise the stack-resident fields into pointers &
non-pointers, and pass the number of each to the heap check code. -}

540 541 542 543 544 545 546
unbxTupleHeapCheck
        :: [(Id, GlobalReg)]    -- Live registers
        -> WordOff      -- no. of stack slots containing ptrs
        -> WordOff      -- no. of stack slots containing nonptrs
        -> CmmAGraph    -- code to insert in the failure path
        -> FCode ()
        -> FCode ()
547 548

unbxTupleHeapCheck regs ptrs nptrs fail_code code
549
  -- We can't manage more than 255 pointers/non-pointers
550 551
  -- in a generic heap check.
  | ptrs > 255 || nptrs > 255 = panic "altHeapCheck"
552
  | otherwise
553
  = initHeapUsage $ \ hpHw -> do
554 555 556 557 558
        { codeOnly $ do { do_checks 0 {- no stack check -} hpHw
                                    full_fail_code rts_label
                        ; tickyAllocHeap hpHw }
        ; setRealHp hpHw
        ; code }
559 560
  where
    full_fail_code  = fail_code `plusStmts` oneStmt assign_liveness
561 562 563 564
    assign_liveness = CmmAssign (CmmGlobal (VanillaReg 9))      -- Ho ho ho!
                                (CmmLit (mkWordCLit liveness))
    liveness        = mkRegLiveness regs ptrs nptrs
    rts_label       = CmmLit (CmmLabel (mkRtsCodeLabel (sLit "stg_gc_ut")))
565 566


567
{- Old Gransim com -- I have no idea whether it still makes sense (SLPJ Sep07)
568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
For GrAnSim the code for doing a heap check and doing a context switch
has been separated. Especially, the HEAP_CHK macro only performs a
heap check. THREAD_CONTEXT_SWITCH should be used for doing a context
switch. GRAN_FETCH_AND_RESCHEDULE must be put at the beginning of
every slow entry code in order to simulate the fetching of
closures. If fetching is necessary (i.e. current closure is not local)
then an automatic context switch is done. -}


When failing a check, we save a return address on the stack and
jump to a pre-compiled code fragment that saves the live registers
and returns to the scheduler.

The return address in most cases will be the beginning of the basic
block in which the check resides, since we need to perform the check
again on re-entry because someone else might have stolen the resource
in the meantime.

%************************************************************************
587
%*                                                                      *
588
     Generic Heap/Stack Checks - used in the RTS
589
%*                                                                      *
590 591 592 593 594 595 596 597
%************************************************************************

\begin{code}
hpChkGen :: CmmExpr -> CmmExpr -> CmmExpr -> FCode ()
hpChkGen bytes liveness reentry
  = do_checks' bytes True assigns stg_gc_gen
  where
    assigns = mkStmts [
598 599 600
                CmmAssign (CmmGlobal (VanillaReg 9))  liveness,
                CmmAssign (CmmGlobal (VanillaReg 10)) reentry
                ]
601 602 603 604 605 606 607 608 609 610 611 612

-- a heap check where R1 points to the closure to enter on return, and
-- we want to assign to Sp[0] on failure (used in AutoApply.cmm:BUILD_PAP).
hpChkNodePointsAssignSp0 :: CmmExpr -> CmmExpr -> FCode ()
hpChkNodePointsAssignSp0 bytes sp0
  = do_checks' bytes True assign stg_gc_enter1
  where assign = oneStmt (CmmStore (CmmReg spReg) sp0)

stg_gc_gen    = CmmLit (CmmLabel (mkRtsCodeLabel (sLit "stg_gc_gen")))
\end{code}

-}