2 % (c) The University of Glasgow 2006
3 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
5 \section[CgHeapery]{Heap management functions}
9 initHeapUsage, getVirtHp, setVirtHp, setRealHp,
10 getHpRelOffset, hpRel,
12 funEntryChecks, thunkEntryChecks,
13 altHeapCheck, unbxTupleHeapCheck,
14 hpChkGen, hpChkNodePointsAssignSp0,
15 stkChkGen, stkChkNodePoints,
17 layOutDynConstr, layOutStaticConstr,
18 mkVirtHeapOffsets, mkStaticClosureFields, mkStaticClosure,
20 allocDynClosure, emitSetDynHdr
23 #include "HsVersions.h"
53 %************************************************************************
55 \subsection[CgUsages-heapery]{Monad things for fiddling with heap usage}
57 %************************************************************************
59 The heap always grows upwards, so hpRel is easy
62 hpRel :: VirtualHpOffset -- virtual offset of Hp
63 -> VirtualHpOffset -- virtual offset of The Thing
64 -> WordOff -- integer word offset
65 hpRel hp off = off - hp
68 @initHeapUsage@ applies a function to the amount of heap that it uses.
69 It initialises the heap usage to zeros, and passes on an unchanged
72 It is usually a prelude to performing a GC check, so everything must
73 be in a tidy and consistent state.
75 rje: Note the slightly suble fixed point behaviour needed here
78 initHeapUsage :: (VirtualHpOffset -> Code) -> Code
80 = do { orig_hp_usage <- getHpUsage
81 ; setHpUsage initHpUsage
82 ; fixC (\heap_usage2 -> do
83 { fcode (heapHWM heap_usage2)
85 ; setHpUsage orig_hp_usage }
87 setVirtHp :: VirtualHpOffset -> Code
89 = do { hp_usage <- getHpUsage
90 ; setHpUsage (hp_usage {virtHp = new_virtHp}) }
92 getVirtHp :: FCode VirtualHpOffset
94 = do { hp_usage <- getHpUsage
95 ; return (virtHp hp_usage) }
97 setRealHp :: VirtualHpOffset -> Code
99 = do { hp_usage <- getHpUsage
100 ; setHpUsage (hp_usage {realHp = new_realHp}) }
102 getHpRelOffset :: VirtualHpOffset -> FCode CmmExpr
103 getHpRelOffset virtual_offset
104 = do { hp_usg <- getHpUsage
105 ; return (cmmRegOffW hpReg (hpRel (realHp hp_usg) virtual_offset)) }
109 %************************************************************************
111 Layout of heap objects
113 %************************************************************************
116 layOutDynConstr, layOutStaticConstr
121 [(a,VirtualHpOffset)])
123 layOutDynConstr = layOutConstr False
124 layOutStaticConstr = layOutConstr True
126 layOutConstr is_static this_pkg data_con args
127 = (mkConInfo this_pkg is_static data_con tot_wds ptr_wds,
130 (tot_wds, -- #ptr_wds + #nonptr_wds
132 things_w_offsets) = mkVirtHeapOffsets False{-not a thunk-} args
135 @mkVirtHeapOffsets@ always returns boxed things with smaller offsets
136 than the unboxed things, and furthermore, the offsets in the result
141 :: Bool -- True <=> is a thunk
142 -> [(CgRep,a)] -- Things to make offsets for
143 -> (WordOff, -- _Total_ number of words allocated
144 WordOff, -- Number of words allocated for *pointers*
145 [(a, VirtualHpOffset)])
146 -- Things with their offsets from start of
147 -- object in order of increasing offset
149 -- First in list gets lowest offset, which is initial offset + 1.
151 mkVirtHeapOffsets is_thunk things
152 = let non_void_things = filterOut (isVoidArg . fst) things
153 (ptrs, non_ptrs) = separateByPtrFollowness non_void_things
154 (wds_of_ptrs, ptrs_w_offsets) = mapAccumL computeOffset 0 ptrs
155 (tot_wds, non_ptrs_w_offsets) = mapAccumL computeOffset wds_of_ptrs non_ptrs
157 (tot_wds, wds_of_ptrs, ptrs_w_offsets ++ non_ptrs_w_offsets)
159 hdr_size | is_thunk = thunkHdrSize
160 | otherwise = fixedHdrSize
162 computeOffset wds_so_far (rep, thing)
163 = (wds_so_far + cgRepSizeW rep, (thing, hdr_size + wds_so_far))
167 %************************************************************************
169 Lay out a static closure
171 %************************************************************************
173 Make a static closure, adding on any extra padding needed for CAFs,
174 and adding a static link field if necessary.
177 mkStaticClosureFields
180 -> Bool -- Has CAF refs
181 -> [CmmLit] -- Payload
182 -> [CmmLit] -- The full closure
183 mkStaticClosureFields cl_info ccs caf_refs payload
184 = mkStaticClosure info_lbl ccs payload padding_wds
185 static_link_field saved_info_field
187 info_lbl = infoTableLabelFromCI cl_info
189 -- CAFs must have consistent layout, regardless of whether they
190 -- are actually updatable or not. The layout of a CAF is:
197 -- the static_link and saved_info fields must always be in the same
198 -- place. So we use closureNeedsUpdSpace rather than
199 -- closureUpdReqd here:
201 is_caf = closureNeedsUpdSpace cl_info
205 | otherwise = ASSERT(null payload) [mkIntCLit 0]
208 | is_caf || staticClosureNeedsLink cl_info = [static_link_value]
212 | is_caf = [mkIntCLit 0]
215 -- for a static constructor which has NoCafRefs, we set the
216 -- static link field to a non-zero value so the garbage
217 -- collector will ignore it.
219 | caf_refs = mkIntCLit 0
220 | otherwise = mkIntCLit 1
223 mkStaticClosure :: CLabel -> CostCentreStack -> [CmmLit]
224 -> [CmmLit] -> [CmmLit] -> [CmmLit] -> [CmmLit]
225 mkStaticClosure info_lbl ccs payload padding_wds static_link_field saved_info_field
226 = [CmmLabel info_lbl]
227 ++ variable_header_words
233 variable_header_words
240 %************************************************************************
242 \subsection[CgHeapery-heap-overflow]{Heap overflow checking}
244 %************************************************************************
246 The new code for heapChecks. For GrAnSim the code for doing a heap check
247 and doing a context switch has been separated. Especially, the HEAP_CHK
248 macro only performs a heap check. THREAD_CONTEXT_SWITCH should be used for
249 doing a context switch. GRAN_FETCH_AND_RESCHEDULE must be put at the
250 beginning of every slow entry code in order to simulate the fetching of
251 closures. If fetching is necessary (i.e. current closure is not local) then
252 an automatic context switch is done.
254 --------------------------------------------------------------
255 A heap/stack check at a function or thunk entry point.
258 funEntryChecks :: ClosureInfo -> CmmStmts -> Code -> Code
259 funEntryChecks cl_info reg_save_code code
260 = hpStkCheck cl_info True reg_save_code code
262 thunkEntryChecks :: ClosureInfo -> Code -> Code
263 thunkEntryChecks cl_info code
264 = hpStkCheck cl_info False noStmts code
266 hpStkCheck :: ClosureInfo -- Function closure
267 -> Bool -- Is a function? (not a thunk)
268 -> CmmStmts -- Register saves
272 hpStkCheck cl_info is_fun reg_save_code code
273 = getFinalStackHW $ \ spHw -> do
275 ; let stk_words = spHw - sp
276 ; initHeapUsage $ \ hpHw -> do
277 { -- Emit heap checks, but be sure to do it lazily so
278 -- that the conditionals on hpHw don't cause a black hole
280 { do_checks stk_words hpHw full_save_code rts_label
281 ; tickyAllocHeap hpHw }
287 | nodeMustPointToIt (closureLFInfo cl_info)
290 = oneStmt (CmmAssign nodeReg (CmmLit (CmmLabel closure_lbl)))
291 -- Strictly speaking, we should tag node here. But if
292 -- node doesn't point to the closure, the code for the closure
293 -- cannot depend on the value of R1 anyway, so we're safe.
294 closure_lbl = closureLabelFromCI cl_info
296 full_save_code = node_asst `plusStmts` reg_save_code
298 rts_label | is_fun = CmmReg (CmmGlobal GCFun)
299 -- Function entry point
300 | otherwise = CmmReg (CmmGlobal GCEnter1)
301 -- Thunk or case return
302 -- In the thunk/case-return case, R1 points to a closure
303 -- which should be (re)-entered after GC
306 Heap checks in a case alternative are nice and easy, provided this is
307 a bog-standard algebraic case. We have in our hand:
309 * one return address, on the stack,
310 * one return value, in Node.
312 the canned code for this heap check failure just pushes Node on the
313 stack, saying 'EnterGHC' to return. The scheduler will return by
314 entering the top value on the stack, which in turn will return through
315 the return address, getting us back to where we were. This is
316 therefore only valid if the return value is *lifted* (just being
317 boxed isn't good enough).
319 For primitive returns, we have an unlifted value in some register
320 (either R1 or FloatReg1 or DblReg1). This means using specialised
321 heap-check code for these cases.
325 :: AltType -- PolyAlt, PrimAlt, AlgAlt, but *not* UbxTupAlt
326 -- (Unboxed tuples are dealt with by ubxTupleHeapCheck)
327 -> Code -- Continuation
329 altHeapCheck alt_type code
330 = initHeapUsage $ \ hpHw -> do
332 { do_checks 0 {- no stack chk -} hpHw
333 noStmts {- nothign to save -}
335 ; tickyAllocHeap hpHw }
339 rts_label PolyAlt = CmmLit (CmmLabel (mkRtsCodeLabel SLIT( "stg_gc_unpt_r1")))
340 -- Do *not* enter R1 after a heap check in
341 -- a polymorphic case. It might be a function
342 -- and the entry code for a function (currently)
345 -- However R1 is guaranteed to be a pointer
347 rts_label (AlgAlt tc) = stg_gc_enter1
348 -- Enter R1 after the heap check; it's a pointer
350 rts_label (PrimAlt tc)
351 = CmmLit $ CmmLabel $
352 case primRepToCgRep (tyConPrimRep tc) of
353 VoidArg -> mkRtsCodeLabel SLIT( "stg_gc_noregs")
354 FloatArg -> mkRtsCodeLabel SLIT( "stg_gc_f1")
355 DoubleArg -> mkRtsCodeLabel SLIT( "stg_gc_d1")
356 LongArg -> mkRtsCodeLabel SLIT( "stg_gc_l1")
357 -- R1 is boxed but unlifted:
358 PtrArg -> mkRtsCodeLabel SLIT( "stg_gc_unpt_r1")
360 NonPtrArg -> mkRtsCodeLabel SLIT( "stg_gc_unbx_r1")
362 rts_label (UbxTupAlt _) = panic "altHeapCheck"
366 Unboxed tuple alternatives and let-no-escapes (the two most annoying
367 constructs to generate code for!) For unboxed tuple returns, there
368 are an arbitrary number of possibly unboxed return values, some of
369 which will be in registers, and the others will be on the stack. We
370 always organise the stack-resident fields into pointers &
371 non-pointers, and pass the number of each to the heap check code.
375 :: [(Id, GlobalReg)] -- Live registers
376 -> WordOff -- no. of stack slots containing ptrs
377 -> WordOff -- no. of stack slots containing nonptrs
378 -> CmmStmts -- code to insert in the failure path
382 unbxTupleHeapCheck regs ptrs nptrs fail_code code
383 -- We can't manage more than 255 pointers/non-pointers
384 -- in a generic heap check.
385 | ptrs > 255 || nptrs > 255 = panic "altHeapCheck"
387 = initHeapUsage $ \ hpHw -> do
388 { codeOnly $ do { do_checks 0 {- no stack check -} hpHw
389 full_fail_code rts_label
390 ; tickyAllocHeap hpHw }
394 full_fail_code = fail_code `plusStmts` oneStmt assign_liveness
395 assign_liveness = CmmAssign (CmmGlobal (VanillaReg 9)) -- Ho ho ho!
396 (CmmLit (mkWordCLit liveness))
397 liveness = mkRegLiveness regs ptrs nptrs
398 rts_label = CmmLit (CmmLabel (mkRtsCodeLabel SLIT("stg_gc_ut")))
403 %************************************************************************
407 %************************************************************************
409 When failing a check, we save a return address on the stack and
410 jump to a pre-compiled code fragment that saves the live registers
411 and returns to the scheduler.
413 The return address in most cases will be the beginning of the basic
414 block in which the check resides, since we need to perform the check
415 again on re-entry because someone else might have stolen the resource
419 do_checks :: WordOff -- Stack headroom
420 -> WordOff -- Heap headroom
421 -> CmmStmts -- Assignments to perform on failure
422 -> CmmExpr -- Rts address to jump to on failure
424 do_checks 0 0 _ _ = nopC
425 do_checks stk hp reg_save_code rts_lbl
426 = do_checks' (CmmLit (mkIntCLit (stk*wORD_SIZE)))
427 (CmmLit (mkIntCLit (hp*wORD_SIZE)))
428 (stk /= 0) (hp /= 0) reg_save_code rts_lbl
430 -- The offsets are now in *bytes*
431 do_checks' stk_expr hp_expr stk_nonzero hp_nonzero reg_save_code rts_lbl
432 = do { doGranAllocate hp_expr
434 -- Emit a block for the heap-check-failure code
435 ; blk_id <- forkLabelledCode $ do
437 stmtC (CmmAssign (CmmGlobal HpAlloc) hp_expr)
438 ; emitStmts reg_save_code
439 ; stmtC (CmmJump rts_lbl []) }
441 -- Check for stack overflow *FIRST*; otherwise
442 -- we might bumping Hp and then failing stack oflo
444 (stmtC (CmmCondBranch stk_oflo blk_id))
447 (stmtsC [CmmAssign hpReg
448 (cmmOffsetExprB (CmmReg hpReg) hp_expr),
449 CmmCondBranch hp_oflo blk_id])
450 -- Bump heap pointer, and test for heap exhaustion
451 -- Note that we don't move the heap pointer unless the
452 -- stack check succeeds. Otherwise we might end up
453 -- with slop at the end of the current block, which can
454 -- confuse the LDV profiler.
457 -- Stk overflow if (Sp - stk_bytes < SpLim)
458 stk_oflo = CmmMachOp mo_wordULt
459 [CmmMachOp mo_wordSub [CmmReg spReg, stk_expr],
460 CmmReg (CmmGlobal SpLim)]
462 -- Hp overflow if (Hpp > HpLim)
463 -- (Hp has been incremented by now)
464 -- HpLim points to the LAST WORD of valid allocation space.
465 hp_oflo = CmmMachOp mo_wordUGt
466 [CmmReg hpReg, CmmReg (CmmGlobal HpLim)]
469 %************************************************************************
471 Generic Heap/Stack Checks - used in the RTS
473 %************************************************************************
476 hpChkGen :: CmmExpr -> CmmExpr -> CmmExpr -> Code
477 hpChkGen bytes liveness reentry
478 = do_checks' (CmmLit (mkIntCLit 0)) bytes False True assigns stg_gc_gen
481 CmmAssign (CmmGlobal (VanillaReg 9)) liveness,
482 CmmAssign (CmmGlobal (VanillaReg 10)) reentry
485 -- a heap check where R1 points to the closure to enter on return, and
486 -- we want to assign to Sp[0] on failure (used in AutoApply.cmm:BUILD_PAP).
487 hpChkNodePointsAssignSp0 :: CmmExpr -> CmmExpr -> Code
488 hpChkNodePointsAssignSp0 bytes sp0
489 = do_checks' (CmmLit (mkIntCLit 0)) bytes False True assign stg_gc_enter1
490 where assign = oneStmt (CmmStore (CmmReg spReg) sp0)
492 stkChkGen :: CmmExpr -> CmmExpr -> CmmExpr -> Code
493 stkChkGen bytes liveness reentry
494 = do_checks' bytes (CmmLit (mkIntCLit 0)) True False assigns stg_gc_gen
497 CmmAssign (CmmGlobal (VanillaReg 9)) liveness,
498 CmmAssign (CmmGlobal (VanillaReg 10)) reentry
501 stkChkNodePoints :: CmmExpr -> Code
502 stkChkNodePoints bytes
503 = do_checks' bytes (CmmLit (mkIntCLit 0)) True False noStmts stg_gc_enter1
505 stg_gc_gen = CmmLit (CmmLabel (mkRtsCodeLabel SLIT("stg_gc_gen")))
506 stg_gc_enter1 = CmmReg (CmmGlobal GCEnter1)
509 %************************************************************************
511 \subsection[initClosure]{Initialise a dynamic closure}
513 %************************************************************************
515 @allocDynClosure@ puts the thing in the heap, and modifies the virtual Hp
521 -> CmmExpr -- Cost Centre to stick in the object
522 -> CmmExpr -- Cost Centre to blame for this alloc
523 -- (usually the same; sometimes "OVERHEAD")
525 -> [(CmmExpr, VirtualHpOffset)] -- Offsets from start of the object
526 -- ie Info ptr has offset zero.
527 -> FCode VirtualHpOffset -- Returns virt offset of object
529 allocDynClosure cl_info use_cc blame_cc amodes_with_offsets
530 = do { virt_hp <- getVirtHp
532 -- FIND THE OFFSET OF THE INFO-PTR WORD
533 ; let info_offset = virt_hp + 1
534 -- info_offset is the VirtualHpOffset of the first
535 -- word of the new object
536 -- Remember, virtHp points to last allocated word,
537 -- ie 1 *before* the info-ptr word of new object.
539 info_ptr = CmmLit (CmmLabel (infoTableLabelFromCI cl_info))
540 hdr_w_offsets = initDynHdr info_ptr use_cc `zip` [0..]
542 -- SAY WHAT WE ARE ABOUT TO DO
543 ; profDynAlloc cl_info use_cc
544 -- ToDo: This is almost certainly wrong
545 -- We're ignoring blame_cc. But until we've
546 -- fixed the boxing hack in chooseDynCostCentres etc,
547 -- we're worried about making things worse by "fixing"
548 -- this part to use blame_cc!
550 ; tickyDynAlloc cl_info
552 -- ALLOCATE THE OBJECT
553 ; base <- getHpRelOffset info_offset
554 ; hpStore base (hdr_w_offsets ++ amodes_with_offsets)
556 -- BUMP THE VIRTUAL HEAP POINTER
557 ; setVirtHp (virt_hp + closureSize cl_info)
559 -- RETURN PTR TO START OF OBJECT
560 ; returnFC info_offset }
563 initDynHdr :: CmmExpr
564 -> CmmExpr -- Cost centre to put in object
566 initDynHdr info_ptr cc
568 -- ToDo: Gransim stuff
569 -- ToDo: Parallel stuff
573 hpStore :: CmmExpr -> [(CmmExpr, VirtualHpOffset)] -> Code
574 -- Store the item (expr,off) in base[off]
576 = stmtsC [ CmmStore (cmmOffsetW base off) val
579 emitSetDynHdr :: CmmExpr -> CmmExpr -> CmmExpr -> Code
580 emitSetDynHdr base info_ptr ccs
581 = hpStore base (zip (initDynHdr info_ptr ccs) [0..])