Add {-# OPTIONS_GHC -w #-} and some blurb to all compiler modules
[ghc-hetmet.git] / compiler / codeGen / CgHeapery.lhs
1 %
2 % (c) The University of Glasgow 2006
3 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 %
5 \section[CgHeapery]{Heap management functions}
6
7 \begin{code}
8 {-# OPTIONS_GHC -w #-}
9 -- The above warning supression flag is a temporary kludge.
10 -- While working on this module you are encouraged to remove it and fix
11 -- any warnings in the module. See
12 --     http://hackage.haskell.org/trac/ghc/wiki/WorkingConventions#Warnings
13 -- for details
14
15 module CgHeapery (
16         initHeapUsage, getVirtHp, setVirtHp, setRealHp, 
17         getHpRelOffset, hpRel,
18
19         funEntryChecks, thunkEntryChecks, 
20         altHeapCheck, unbxTupleHeapCheck, 
21         hpChkGen, hpChkNodePointsAssignSp0,
22         stkChkGen, stkChkNodePoints,
23
24         layOutDynConstr, layOutStaticConstr,
25         mkVirtHeapOffsets, mkStaticClosureFields, mkStaticClosure,
26
27         allocDynClosure, emitSetDynHdr
28     ) where
29
30 #include "HsVersions.h"
31
32 import StgSyn
33 import CLabel
34 import CgUtils
35 import CgMonad
36 import CgProf
37 import CgTicky
38 import CgParallel
39 import CgStackery
40 import CgCallConv
41 import ClosureInfo
42 import SMRep
43
44 import Cmm
45 import MachOp
46 import CmmUtils
47 import Id
48 import DataCon
49 import TyCon
50 import CostCentre
51 import Util
52 import Constants
53 import PackageConfig
54 import Outputable
55
56 import Data.List
57 \end{code}
58
59
60 %************************************************************************
61 %*                                                                      *
62 \subsection[CgUsages-heapery]{Monad things for fiddling with heap usage}
63 %*                                                                      *
64 %************************************************************************
65
66 The heap always grows upwards, so hpRel is easy
67
68 \begin{code}
69 hpRel :: VirtualHpOffset        -- virtual offset of Hp
70       -> VirtualHpOffset        -- virtual offset of The Thing
71       -> WordOff                        -- integer word offset
72 hpRel hp off = off - hp
73 \end{code}
74
75 @initHeapUsage@ applies a function to the amount of heap that it uses.
76 It initialises the heap usage to zeros, and passes on an unchanged
77 heap usage.
78
79 It is usually a prelude to performing a GC check, so everything must
80 be in a tidy and consistent state.
81
82 rje: Note the slightly suble fixed point behaviour needed here
83
84 \begin{code}
85 initHeapUsage :: (VirtualHpOffset -> Code) -> Code
86 initHeapUsage fcode
87   = do  { orig_hp_usage <- getHpUsage
88         ; setHpUsage initHpUsage
89         ; fixC (\heap_usage2 -> do
90                 { fcode (heapHWM heap_usage2)
91                 ; getHpUsage })
92         ; setHpUsage orig_hp_usage }
93
94 setVirtHp :: VirtualHpOffset -> Code
95 setVirtHp new_virtHp
96   = do  { hp_usage <- getHpUsage
97         ; setHpUsage (hp_usage {virtHp = new_virtHp}) }
98
99 getVirtHp :: FCode VirtualHpOffset
100 getVirtHp 
101   = do  { hp_usage <- getHpUsage
102         ; return (virtHp hp_usage) }
103
104 setRealHp ::  VirtualHpOffset -> Code
105 setRealHp new_realHp
106   = do  { hp_usage <- getHpUsage
107         ; setHpUsage (hp_usage {realHp = new_realHp}) }
108
109 getHpRelOffset :: VirtualHpOffset -> FCode CmmExpr
110 getHpRelOffset virtual_offset
111   = do  { hp_usg <- getHpUsage
112         ; return (cmmRegOffW hpReg (hpRel (realHp hp_usg) virtual_offset)) }
113 \end{code}
114
115
116 %************************************************************************
117 %*                                                                      *
118                 Layout of heap objects
119 %*                                                                      *
120 %************************************************************************
121
122 \begin{code}
123 layOutDynConstr, layOutStaticConstr
124         :: DataCon
125         -> [(CgRep,a)]
126         -> (ClosureInfo,
127             [(a,VirtualHpOffset)])
128
129 layOutDynConstr    = layOutConstr False
130 layOutStaticConstr = layOutConstr True
131
132 layOutConstr is_static data_con args
133    = (mkConInfo is_static data_con tot_wds ptr_wds,
134       things_w_offsets)
135   where
136     (tot_wds,            --  #ptr_wds + #nonptr_wds
137      ptr_wds,            --  #ptr_wds
138      things_w_offsets) = mkVirtHeapOffsets False{-not a thunk-} args
139 \end{code}
140
141 @mkVirtHeapOffsets@ always returns boxed things with smaller offsets
142 than the unboxed things, and furthermore, the offsets in the result
143 list
144
145 \begin{code}
146 mkVirtHeapOffsets
147           :: Bool               -- True <=> is a thunk
148           -> [(CgRep,a)]        -- Things to make offsets for
149           -> (WordOff,          -- _Total_ number of words allocated
150               WordOff,          -- Number of words allocated for *pointers*
151               [(a, VirtualHpOffset)])
152                                 -- Things with their offsets from start of 
153                                 --  object in order of increasing offset
154
155 -- First in list gets lowest offset, which is initial offset + 1.
156
157 mkVirtHeapOffsets is_thunk things
158   = let non_void_things               = filterOut (isVoidArg . fst) things
159         (ptrs, non_ptrs)              = separateByPtrFollowness non_void_things
160         (wds_of_ptrs, ptrs_w_offsets) = mapAccumL computeOffset 0 ptrs
161         (tot_wds, non_ptrs_w_offsets) = mapAccumL computeOffset wds_of_ptrs non_ptrs
162     in
163     (tot_wds, wds_of_ptrs, ptrs_w_offsets ++ non_ptrs_w_offsets)
164   where
165     hdr_size    | is_thunk   = thunkHdrSize
166                 | otherwise  = fixedHdrSize
167
168     computeOffset wds_so_far (rep, thing)
169       = (wds_so_far + cgRepSizeW rep, (thing, hdr_size + wds_so_far))
170 \end{code}
171
172
173 %************************************************************************
174 %*                                                                      *
175                 Lay out a static closure
176 %*                                                                      *
177 %************************************************************************
178
179 Make a static closure, adding on any extra padding needed for CAFs,
180 and adding a static link field if necessary.
181
182 \begin{code}
183 mkStaticClosureFields 
184         :: ClosureInfo 
185         -> CostCentreStack 
186         -> Bool                 -- Has CAF refs
187         -> [CmmLit]             -- Payload
188         -> [CmmLit]             -- The full closure
189 mkStaticClosureFields cl_info ccs caf_refs payload
190   = mkStaticClosure info_lbl ccs payload padding_wds 
191         static_link_field saved_info_field
192   where
193     info_lbl = infoTableLabelFromCI cl_info
194
195     -- CAFs must have consistent layout, regardless of whether they
196     -- are actually updatable or not.  The layout of a CAF is:
197     --
198     --        3 saved_info
199     --        2 static_link
200     --        1 indirectee
201     --        0 info ptr
202     --
203     -- the static_link and saved_info fields must always be in the same
204     -- place.  So we use closureNeedsUpdSpace rather than
205     -- closureUpdReqd here:
206
207     is_caf = closureNeedsUpdSpace cl_info
208
209     padding_wds
210         | not is_caf = []
211         | otherwise  = ASSERT(null payload) [mkIntCLit 0]
212
213     static_link_field
214         | is_caf || staticClosureNeedsLink cl_info = [static_link_value]
215         | otherwise                                = []
216
217     saved_info_field
218         | is_caf     = [mkIntCLit 0]
219         | otherwise  = []
220
221         -- for a static constructor which has NoCafRefs, we set the
222         -- static link field to a non-zero value so the garbage
223         -- collector will ignore it.
224     static_link_value
225         | caf_refs      = mkIntCLit 0
226         | otherwise     = mkIntCLit 1
227
228
229 mkStaticClosure :: CLabel -> CostCentreStack -> [CmmLit]
230   -> [CmmLit] -> [CmmLit] -> [CmmLit] -> [CmmLit]
231 mkStaticClosure info_lbl ccs payload padding_wds static_link_field saved_info_field
232   =  [CmmLabel info_lbl]
233   ++ variable_header_words
234   ++ payload
235   ++ padding_wds
236   ++ static_link_field
237   ++ saved_info_field
238   where
239     variable_header_words
240         =  staticGranHdr
241         ++ staticParHdr
242         ++ staticProfHdr ccs
243         ++ staticTickyHdr
244 \end{code}
245
246 %************************************************************************
247 %*                                                                      *
248 \subsection[CgHeapery-heap-overflow]{Heap overflow checking}
249 %*                                                                      *
250 %************************************************************************
251
252 The new code  for heapChecks. For GrAnSim the code for doing a heap check
253 and doing a context switch has been separated. Especially, the HEAP_CHK
254 macro only performs a heap check. THREAD_CONTEXT_SWITCH should be used for
255 doing a context switch. GRAN_FETCH_AND_RESCHEDULE must be put at the
256 beginning of every slow entry code in order to simulate the fetching of
257 closures. If fetching is necessary (i.e. current closure is not local) then
258 an automatic context switch is done.
259
260 --------------------------------------------------------------
261 A heap/stack check at a function or thunk entry point.
262
263 \begin{code}
264 funEntryChecks :: ClosureInfo -> CmmStmts -> Code -> Code
265 funEntryChecks cl_info reg_save_code code 
266   = hpStkCheck cl_info True reg_save_code code
267
268 thunkEntryChecks :: ClosureInfo -> Code -> Code
269 thunkEntryChecks cl_info code 
270   = hpStkCheck cl_info False noStmts code
271
272 hpStkCheck :: ClosureInfo       -- Function closure
273            -> Bool              -- Is a function? (not a thunk)
274            -> CmmStmts          -- Register saves
275            -> Code
276            -> Code
277
278 hpStkCheck cl_info is_fun reg_save_code code
279   =  getFinalStackHW    $ \ spHw -> do
280         { sp <- getRealSp
281         ; let stk_words = spHw - sp
282         ; initHeapUsage $ \ hpHw  -> do
283             {   -- Emit heap checks, but be sure to do it lazily so 
284                 -- that the conditionals on hpHw don't cause a black hole
285               codeOnly $ do
286                 { do_checks stk_words hpHw full_save_code rts_label
287                 ; tickyAllocHeap hpHw }
288             ; setRealHp hpHw
289             ; code }
290         }
291   where
292     node_asst 
293         | nodeMustPointToIt (closureLFInfo cl_info)
294         = noStmts
295         | otherwise
296         = oneStmt (CmmAssign nodeReg (CmmLit (CmmLabel closure_lbl)))
297         -- Strictly speaking, we should tag node here.  But if
298         -- node doesn't point to the closure, the code for the closure
299         -- cannot depend on the value of R1 anyway, so we're safe.
300     closure_lbl = closureLabelFromCI cl_info
301
302     full_save_code = node_asst `plusStmts` reg_save_code
303
304     rts_label | is_fun    = CmmReg (CmmGlobal GCFun)
305                                 -- Function entry point
306               | otherwise = CmmReg (CmmGlobal GCEnter1)
307                                 -- Thunk or case return
308         -- In the thunk/case-return case, R1 points to a closure
309         -- which should be (re)-entered after GC
310 \end{code}
311
312 Heap checks in a case alternative are nice and easy, provided this is
313 a bog-standard algebraic case.  We have in our hand:
314
315        * one return address, on the stack,
316        * one return value, in Node.
317
318 the canned code for this heap check failure just pushes Node on the
319 stack, saying 'EnterGHC' to return.  The scheduler will return by
320 entering the top value on the stack, which in turn will return through
321 the return address, getting us back to where we were.  This is
322 therefore only valid if the return value is *lifted* (just being
323 boxed isn't good enough).
324
325 For primitive returns, we have an unlifted value in some register
326 (either R1 or FloatReg1 or DblReg1).  This means using specialised
327 heap-check code for these cases.
328
329 \begin{code}
330 altHeapCheck 
331     :: AltType  -- PolyAlt, PrimAlt, AlgAlt, but *not* UbxTupAlt
332                 --      (Unboxed tuples are dealt with by ubxTupleHeapCheck)
333     -> Code     -- Continuation
334     -> Code
335 altHeapCheck alt_type code
336   = initHeapUsage $ \ hpHw -> do
337         { codeOnly $ do
338              { do_checks 0 {- no stack chk -} hpHw
339                          noStmts {- nothign to save -}
340                          (rts_label alt_type)
341              ; tickyAllocHeap hpHw }
342         ; setRealHp hpHw
343         ; code }
344   where
345     rts_label PolyAlt = CmmLit (CmmLabel (mkRtsCodeLabel SLIT( "stg_gc_unpt_r1")))
346         -- Do *not* enter R1 after a heap check in
347         -- a polymorphic case.  It might be a function
348         -- and the entry code for a function (currently)
349         -- applies it
350         --
351         -- However R1 is guaranteed to be a pointer
352
353     rts_label (AlgAlt tc) = stg_gc_enter1
354         -- Enter R1 after the heap check; it's a pointer
355         
356     rts_label (PrimAlt tc)
357       = CmmLit $ CmmLabel $ 
358         case primRepToCgRep (tyConPrimRep tc) of
359           VoidArg   -> mkRtsCodeLabel SLIT( "stg_gc_noregs")
360           FloatArg  -> mkRtsCodeLabel SLIT( "stg_gc_f1")
361           DoubleArg -> mkRtsCodeLabel SLIT( "stg_gc_d1")
362           LongArg   -> mkRtsCodeLabel SLIT( "stg_gc_l1")
363                                 -- R1 is boxed but unlifted: 
364           PtrArg    -> mkRtsCodeLabel SLIT( "stg_gc_unpt_r1")
365                                 -- R1 is unboxed:
366           NonPtrArg -> mkRtsCodeLabel SLIT( "stg_gc_unbx_r1")
367
368     rts_label (UbxTupAlt _) = panic "altHeapCheck"
369 \end{code}
370
371
372 Unboxed tuple alternatives and let-no-escapes (the two most annoying
373 constructs to generate code for!)  For unboxed tuple returns, there
374 are an arbitrary number of possibly unboxed return values, some of
375 which will be in registers, and the others will be on the stack.  We
376 always organise the stack-resident fields into pointers &
377 non-pointers, and pass the number of each to the heap check code.
378
379 \begin{code}
380 unbxTupleHeapCheck 
381         :: [(Id, GlobalReg)]    -- Live registers
382         -> WordOff      -- no. of stack slots containing ptrs
383         -> WordOff      -- no. of stack slots containing nonptrs
384         -> CmmStmts     -- code to insert in the failure path
385         -> Code
386         -> Code
387
388 unbxTupleHeapCheck regs ptrs nptrs fail_code code
389   -- We can't manage more than 255 pointers/non-pointers 
390   -- in a generic heap check.
391   | ptrs > 255 || nptrs > 255 = panic "altHeapCheck"
392   | otherwise 
393   = initHeapUsage $ \ hpHw -> do
394         { codeOnly $ do { do_checks 0 {- no stack check -} hpHw
395                                     full_fail_code rts_label
396                         ; tickyAllocHeap hpHw }
397         ; setRealHp hpHw
398         ; code }
399   where
400     full_fail_code  = fail_code `plusStmts` oneStmt assign_liveness
401     assign_liveness = CmmAssign (CmmGlobal (VanillaReg 9))      -- Ho ho ho!
402                                 (CmmLit (mkWordCLit liveness))
403     liveness        = mkRegLiveness regs ptrs nptrs
404     rts_label       = CmmLit (CmmLabel (mkRtsCodeLabel SLIT("stg_gc_ut")))
405
406 \end{code}
407
408
409 %************************************************************************
410 %*                                                                      *
411                 Heap/Stack Checks.
412 %*                                                                      *
413 %************************************************************************
414
415 When failing a check, we save a return address on the stack and
416 jump to a pre-compiled code fragment that saves the live registers
417 and returns to the scheduler.
418
419 The return address in most cases will be the beginning of the basic
420 block in which the check resides, since we need to perform the check
421 again on re-entry because someone else might have stolen the resource
422 in the meantime.
423
424 \begin{code}
425 do_checks :: WordOff    -- Stack headroom
426           -> WordOff    -- Heap  headroom
427           -> CmmStmts   -- Assignments to perform on failure
428           -> CmmExpr    -- Rts address to jump to on failure
429           -> Code
430 do_checks 0 0 _ _   = nopC
431 do_checks stk hp reg_save_code rts_lbl
432   = do_checks' (CmmLit (mkIntCLit (stk*wORD_SIZE))) 
433                (CmmLit (mkIntCLit (hp*wORD_SIZE)))
434          (stk /= 0) (hp /= 0) reg_save_code rts_lbl
435
436 -- The offsets are now in *bytes*
437 do_checks' stk_expr hp_expr stk_nonzero hp_nonzero reg_save_code rts_lbl
438   = do  { doGranAllocate hp_expr
439
440         -- Emit a block for the heap-check-failure code
441         ; blk_id <- forkLabelledCode $ do
442                         { whenC hp_nonzero $
443                                 stmtC (CmmAssign (CmmGlobal HpAlloc) hp_expr)
444                         ; emitStmts reg_save_code
445                         ; stmtC (CmmJump rts_lbl []) }
446
447         -- Check for stack overflow *FIRST*; otherwise
448         -- we might bumping Hp and then failing stack oflo
449         ; whenC stk_nonzero
450                 (stmtC (CmmCondBranch stk_oflo blk_id))
451
452         ; whenC hp_nonzero
453                 (stmtsC [CmmAssign hpReg 
454                                 (cmmOffsetExprB (CmmReg hpReg) hp_expr),
455                         CmmCondBranch hp_oflo blk_id]) 
456                 -- Bump heap pointer, and test for heap exhaustion
457                 -- Note that we don't move the heap pointer unless the 
458                 -- stack check succeeds.  Otherwise we might end up
459                 -- with slop at the end of the current block, which can 
460                 -- confuse the LDV profiler.
461     }
462   where
463         -- Stk overflow if (Sp - stk_bytes < SpLim)
464     stk_oflo = CmmMachOp mo_wordULt 
465                   [CmmMachOp mo_wordSub [CmmReg spReg, stk_expr],
466                    CmmReg (CmmGlobal SpLim)]
467
468         -- Hp overflow if (Hp > HpLim)
469         -- (Hp has been incremented by now)
470         -- HpLim points to the LAST WORD of valid allocation space.
471     hp_oflo = CmmMachOp mo_wordUGt 
472                   [CmmReg hpReg, CmmReg (CmmGlobal HpLim)]
473 \end{code}
474
475 %************************************************************************
476 %*                                                                      *
477      Generic Heap/Stack Checks - used in the RTS
478 %*                                                                      *
479 %************************************************************************
480
481 \begin{code}
482 hpChkGen :: CmmExpr -> CmmExpr -> CmmExpr -> Code
483 hpChkGen bytes liveness reentry
484   = do_checks' (CmmLit (mkIntCLit 0)) bytes False True assigns stg_gc_gen
485   where
486     assigns = mkStmts [
487                 CmmAssign (CmmGlobal (VanillaReg 9))  liveness,
488                 CmmAssign (CmmGlobal (VanillaReg 10)) reentry
489                 ]
490
491 -- a heap check where R1 points to the closure to enter on return, and
492 -- we want to assign to Sp[0] on failure (used in AutoApply.cmm:BUILD_PAP).
493 hpChkNodePointsAssignSp0 :: CmmExpr -> CmmExpr -> Code
494 hpChkNodePointsAssignSp0 bytes sp0
495   = do_checks' (CmmLit (mkIntCLit 0)) bytes False True assign stg_gc_enter1
496   where assign = oneStmt (CmmStore (CmmReg spReg) sp0)
497
498 stkChkGen :: CmmExpr -> CmmExpr -> CmmExpr -> Code
499 stkChkGen bytes liveness reentry
500   = do_checks' bytes (CmmLit (mkIntCLit 0)) True False assigns stg_gc_gen
501   where
502     assigns = mkStmts [
503                 CmmAssign (CmmGlobal (VanillaReg 9))  liveness,
504                 CmmAssign (CmmGlobal (VanillaReg 10)) reentry
505                 ]
506
507 stkChkNodePoints :: CmmExpr -> Code
508 stkChkNodePoints bytes
509   = do_checks' bytes (CmmLit (mkIntCLit 0)) True False noStmts stg_gc_enter1
510
511 stg_gc_gen = CmmLit (CmmLabel (mkRtsCodeLabel SLIT("stg_gc_gen")))
512 stg_gc_enter1 = CmmReg (CmmGlobal GCEnter1)
513 \end{code}
514
515 %************************************************************************
516 %*                                                                      *
517 \subsection[initClosure]{Initialise a dynamic closure}
518 %*                                                                      *
519 %************************************************************************
520
521 @allocDynClosure@ puts the thing in the heap, and modifies the virtual Hp
522 to account for this.
523
524 \begin{code}
525 allocDynClosure
526         :: ClosureInfo
527         -> CmmExpr              -- Cost Centre to stick in the object
528         -> CmmExpr              -- Cost Centre to blame for this alloc
529                                 -- (usually the same; sometimes "OVERHEAD")
530
531         -> [(CmmExpr, VirtualHpOffset)] -- Offsets from start of the object
532                                         -- ie Info ptr has offset zero.
533         -> FCode VirtualHpOffset        -- Returns virt offset of object
534
535 allocDynClosure cl_info use_cc blame_cc amodes_with_offsets
536   = do  { virt_hp <- getVirtHp
537
538         -- FIND THE OFFSET OF THE INFO-PTR WORD
539         ; let   info_offset = virt_hp + 1
540                 -- info_offset is the VirtualHpOffset of the first
541                 -- word of the new object
542                 -- Remember, virtHp points to last allocated word, 
543                 -- ie 1 *before* the info-ptr word of new object.
544
545                 info_ptr = CmmLit (CmmLabel (infoTableLabelFromCI cl_info))
546                 hdr_w_offsets = initDynHdr info_ptr use_cc `zip` [0..]
547
548         -- SAY WHAT WE ARE ABOUT TO DO
549         ; profDynAlloc cl_info use_cc   
550                 -- ToDo: This is almost certainly wrong
551                 -- We're ignoring blame_cc. But until we've
552                 -- fixed the boxing hack in chooseDynCostCentres etc,
553                 -- we're worried about making things worse by "fixing"
554                 -- this part to use blame_cc!
555
556         ; tickyDynAlloc cl_info
557
558         -- ALLOCATE THE OBJECT
559         ; base <- getHpRelOffset info_offset
560         ; hpStore base (hdr_w_offsets ++ amodes_with_offsets)
561
562         -- BUMP THE VIRTUAL HEAP POINTER
563         ; setVirtHp (virt_hp + closureSize cl_info)
564         
565         -- RETURN PTR TO START OF OBJECT
566         ; returnFC info_offset }
567
568
569 initDynHdr :: CmmExpr 
570            -> CmmExpr           -- Cost centre to put in object
571            -> [CmmExpr]
572 initDynHdr info_ptr cc
573   =  [info_ptr]
574         -- ToDo: Gransim stuff
575         -- ToDo: Parallel stuff
576   ++ dynProfHdr cc
577         -- No ticky header
578
579 hpStore :: CmmExpr -> [(CmmExpr, VirtualHpOffset)] -> Code
580 -- Store the item (expr,off) in base[off]
581 hpStore base es
582   = stmtsC [ CmmStore (cmmOffsetW base off) val 
583            | (val, off) <- es ]
584
585 emitSetDynHdr :: CmmExpr -> CmmExpr -> CmmExpr -> Code
586 emitSetDynHdr base info_ptr ccs 
587   = hpStore base (zip (initDynHdr info_ptr ccs) [0..])
588 \end{code}