ghc/compiler/codeGen/CgHeapery.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 % $Id: CgHeapery.lhs,v 1.10 1998/12/02 13:17:50 simonm Exp $
   5 %
   6 \section[CgHeapery]{Heap management functions}
   7
   8 \begin{code}
   9 module CgHeapery (
  10         fastEntryChecks, altHeapCheck, thunkChecks,
  11         allocHeap, allocDynClosure
  12
  13         -- new functions, basically inserting macro calls into Code -- HWL
  14         ,fetchAndReschedule, yield
  15     ) where
  16
  17 #include "HsVersions.h"
  18
  19 import AbsCSyn
  20 import CLabel
  21 import CgMonad
  22
  23 import CgStackery       ( getFinalStackHW, mkTaggedStkAmodes, mkTagAssts )
  24 import SMRep            ( fixedHdrSize, getSMRepStr )
  25 import AbsCUtils        ( mkAbstractCs, getAmodeRep )
  26 import CgUsages         ( getVirtAndRealHp, getRealSp, setVirtHp, setRealHp,
  27                           initHeapUsage
  28                         )
  29 import ClosureInfo      ( closureSize, closureGoodStuffSize,
  30                           slopSize, allocProfilingMsg, ClosureInfo,
  31                           closureSMRep
  32                         )
  33 import PrimRep          ( PrimRep(..), isFollowableRep )
  34 import Util             ( panic )
  35 import CmdLineOpts      ( opt_SccProfilingOn )
  36 import GlaExts
  37
  38 #ifdef DEBUG
  39 import PprAbsC          ( pprMagicId ) -- tmp
  40 import Outputable       -- tmp
  41 #endif
  42 \end{code}
  43
  44 %************************************************************************
  45 %*                                                                      *
  46 \subsection[CgHeapery-heap-overflow]{Heap overflow checking}
  47 %*                                                                      *
  48 %************************************************************************
  49
  50 The new code  for heapChecks. For GrAnSim the code for doing a heap check
  51 and doing a context switch has been separated. Especially, the HEAP_CHK
  52 macro only performs a heap check. THREAD_CONTEXT_SWITCH should be used for
  53 doing a context switch. GRAN_FETCH_AND_RESCHEDULE must be put at the
  54 beginning of every slow entry code in order to simulate the fetching of
  55 closures. If fetching is necessary (i.e. current closure is not local) then
  56 an automatic context switch is done.
  57
  58 -----------------------------------------------------------------------------
  59 A heap/stack check at a fast entry point.
  60
  61 \begin{code}
  62
  63 fastEntryChecks
  64         :: [MagicId]                    -- Live registers
  65         -> [(VirtualSpOffset,Int)]      -- stack slots to tag
  66         -> CLabel                       -- return point
  67         -> Bool                         -- node points to closure
  68         -> Code
  69         -> Code
  70
  71 fastEntryChecks regs tags ret node_points code
  72   =  mkTagAssts tags                             `thenFC` \tag_assts ->
  73      getFinalStackHW                             (\ spHw ->
  74      getRealSp                                   `thenFC` \ sp ->
  75      let stk_words = spHw - sp in
  76      initHeapUsage                               (\ hp_words  ->
  77
  78      ( if all_pointers then -- heap checks are quite easy
  79           absC (checking_code stk_words hp_words tag_assts
  80                     free_reg (length regs))
  81
  82        else -- they are complicated
  83
  84           -- save all registers on the stack and adjust the stack pointer.
  85           -- ToDo: find the initial all-pointer segment and don't save them.
  86
  87           mkTaggedStkAmodes sp addrmode_regs
  88                   `thenFC` \(new_sp, stk_assts, more_tag_assts) ->
  89
  90           -- only let the extra stack assignments affect the stack
  91           -- high water mark if we were doing a stack check anyway;
  92           -- otherwise we end up generating unnecessary stack checks.
  93           -- Careful about knot-tying loops!
  94           let real_stk_words =  if new_sp - sp > stk_words && stk_words /= 0
  95                                         then new_sp - sp
  96                                         else stk_words
  97           in
  98
  99           let adjust_sp = CAssign (CReg Sp) (CAddr (spRel sp new_sp)) in
 100
 101           absC (checking_code real_stk_words hp_words
 102                     (mkAbstractCs [tag_assts, stk_assts, more_tag_assts,
 103                                    adjust_sp])
 104                     (CReg node) 0)
 105
 106       ) `thenC`
 107
 108       setRealHp hp_words `thenC`
 109       code))
 110
 111   where
 112
 113     checking_code stk hp assts ret regs
 114         | node_points = do_checks_np stk hp assts (regs+1) -- ret not required
 115         | otherwise   = do_checks    stk hp assts ret regs
 116
 117     -- When node points to the closure for the function:
 118
 119     do_checks_np
 120         :: Int                          -- stack headroom
 121         -> Int                          -- heap  headroom
 122         -> AbstractC                    -- assignments to perform on failure
 123         -> Int                          -- number of pointer registers live
 124         -> AbstractC
 125     do_checks_np 0 0 _ _ = AbsCNop
 126     do_checks_np 0 hp_words tag_assts ptrs =
 127             CCheck HP_CHK_NP [
 128                   mkIntCLit hp_words,
 129                   mkIntCLit ptrs
 130                  ]
 131                  tag_assts
 132     do_checks_np stk_words 0 tag_assts ptrs =
 133             CCheck STK_CHK_NP [
 134                   mkIntCLit stk_words,
 135                   mkIntCLit ptrs
 136                  ]
 137                  tag_assts
 138     do_checks_np stk_words hp_words tag_assts ptrs =
 139             CCheck HP_STK_CHK_NP [
 140                   mkIntCLit stk_words,
 141                   mkIntCLit hp_words,
 142                   mkIntCLit ptrs
 143                  ]
 144                  tag_assts
 145
 146     -- When node doesn't point to the closure (we need an explicit retn addr)
 147
 148     do_checks
 149         :: Int                          -- stack headroom
 150         -> Int                          -- heap  headroom
 151         -> AbstractC                    -- assignments to perform on failure
 152         -> CAddrMode                    -- a register to hold the retn addr.
 153         -> Int                          -- number of pointer registers live
 154         -> AbstractC
 155
 156     do_checks 0 0 _ _ _ = AbsCNop
 157     do_checks 0 hp_words tag_assts ret_reg ptrs =
 158             CCheck HP_CHK [
 159                   mkIntCLit hp_words,
 160                   CLbl ret CodePtrRep,
 161                   ret_reg,
 162                   mkIntCLit ptrs
 163                  ]
 164                  tag_assts
 165     do_checks stk_words 0 tag_assts ret_reg ptrs =
 166             CCheck STK_CHK [
 167                   mkIntCLit stk_words,
 168                   CLbl ret CodePtrRep,
 169                   ret_reg,
 170                   mkIntCLit ptrs
 171                  ]
 172                  tag_assts
 173     do_checks stk_words hp_words tag_assts ret_reg ptrs =
 174             CCheck HP_STK_CHK [
 175                   mkIntCLit stk_words,
 176                   mkIntCLit hp_words,
 177                   CLbl ret CodePtrRep,
 178                   ret_reg,
 179                   mkIntCLit ptrs
 180                  ]
 181                  tag_assts
 182
 183     free_reg  = case length regs + 1 of
 184                        IBOX(x) -> CReg (VanillaReg PtrRep x)
 185
 186     all_pointers = all pointer regs
 187     pointer (VanillaReg rep _) = isFollowableRep rep
 188     pointer _ = False
 189
 190     addrmode_regs = map CReg regs
 191
 192 -- Checking code for thunks is just a special case of fast entry points:
 193
 194 thunkChecks :: CLabel -> Bool -> Code -> Code
 195 thunkChecks ret node_points code = fastEntryChecks [] [] ret node_points code
 196 \end{code}
 197
 198 Heap checks in a case alternative are nice and easy, provided this is
 199 a bog-standard algebraic case.  We have in our hand:
 200
 201        * one return address, on the stack,
 202        * one return value, in Node.
 203
 204 the canned code for this heap check failure just pushes Node on the
 205 stack, saying 'EnterGHC' to return.  The scheduler will return by
 206 entering the top value on the stack, which in turn will return through
 207 the return address, getting us back to where we were.  This is
 208 therefore only valid if the return value is *lifted* (just being
 209 boxed isn't good enough).  Only a PtrRep will do.
 210
 211 For primitive returns, we have an unlifted value in some register
 212 (either R1 or FloatReg1 or DblReg1).  This means using specialised
 213 heap-check code for these cases.
 214
 215 For unboxed tuple returns, there are an arbitrary number of possibly
 216 unboxed return values, some of which will be in registers, and the
 217 others will be on the stack, with gaps left for tagging the unboxed
 218 objects.  If a heap check is required, we need to fill in these tags.
 219
 220 The code below will cover all cases for the x86 architecture (where R1
 221 is the only VanillaReg ever used).  For other architectures, we'll
 222 have to do something about saving and restoring the other registers.
 223
 224 \begin{code}
 225 altHeapCheck
 226         :: Bool                         -- is an algebraic alternative
 227         -> [MagicId]                    -- live registers
 228         -> [(VirtualSpOffset,Int)]      -- stack slots to tag
 229         -> AbstractC
 230         -> Maybe CLabel                 -- ret address if not on top of stack.
 231         -> Code
 232         -> Code
 233
 234 -- unboxed tuple alternatives and let-no-escapes (the two most annoying
 235 -- constructs to generate code for!):
 236
 237 altHeapCheck is_fun regs tags fail_code (Just ret_addr) code
 238   = mkTagAssts tags `thenFC` \tag_assts1 ->
 239     let tag_assts = mkAbstractCs [fail_code, tag_assts1]
 240     in
 241     initHeapUsage (\ hHw -> do_heap_chk hHw tag_assts `thenC` code)
 242   where
 243     do_heap_chk words_required tag_assts
 244       = absC (if words_required == 0
 245                 then  AbsCNop
 246                 else  checking_code tag_assts)  `thenC`
 247         setRealHp words_required
 248
 249       where
 250         non_void_regs = filter (/= VoidReg) regs
 251
 252         checking_code tag_assts =
 253           case non_void_regs of
 254
 255             -- this will cover all cases for x86
 256             [VanillaReg rep ILIT(1)]
 257
 258                | isFollowableRep rep ->
 259                   CCheck HP_CHK_UT_ALT
 260                       [mkIntCLit words_required, mkIntCLit 1, mkIntCLit 0,
 261                         CReg (VanillaReg RetRep ILIT(2)),
 262                         CLbl ret_addr RetRep]
 263                       tag_assts
 264
 265                | otherwise ->
 266                   CCheck HP_CHK_UT_ALT
 267                       [mkIntCLit words_required, mkIntCLit 0, mkIntCLit 1,
 268                         CReg (VanillaReg RetRep ILIT(2)),
 269                         CLbl ret_addr RetRep]
 270                       tag_assts
 271
 272             several_regs ->
 273                 let liveness = mkRegLiveness several_regs
 274                 in
 275                 CCheck HP_CHK_GEN
 276                      [mkIntCLit words_required,
 277                       mkIntCLit (IBOX(word2Int# liveness)),
 278                       CLbl ret_addr RetRep]
 279                      tag_assts
 280
 281 -- normal algebraic and primitive case alternatives:
 282
 283 altHeapCheck is_fun regs [] AbsCNop Nothing code
 284   = initHeapUsage (\ hHw -> do_heap_chk hHw `thenC` code)
 285   where
 286     do_heap_chk :: HeapOffset -> Code
 287     do_heap_chk words_required
 288       = absC (if words_required == 0
 289                 then  AbsCNop
 290                 else  checking_code)  `thenC`
 291         setRealHp words_required
 292
 293       where
 294         non_void_regs = filter (/= VoidReg) regs
 295
 296         checking_code =
 297           case non_void_regs of
 298
 299             -- No regs live: probably a Void return
 300             [] ->
 301                CCheck HP_CHK_NOREGS [mkIntCLit words_required] AbsCNop
 302
 303             -- The SEQ case (polymophic/function typed case branch)
 304             [VanillaReg rep ILIT(1)]
 305                 |  rep == PtrRep
 306                 && is_fun ->
 307                   CCheck HP_CHK_SEQ_NP
 308                         [mkIntCLit words_required, mkIntCLit 1{-regs live-}]
 309                         AbsCNop
 310
 311             -- R1 is lifted (the common case)
 312             [VanillaReg rep ILIT(1)]
 313                 | rep == PtrRep ->
 314                   CCheck HP_CHK_NP
 315                         [mkIntCLit words_required, mkIntCLit 1{-regs live-}]
 316                         AbsCNop
 317
 318             -- R1 is boxed, but unlifted
 319                 | isFollowableRep rep ->
 320                   CCheck HP_CHK_UNPT_R1 [mkIntCLit words_required] AbsCNop
 321
 322             -- R1 is unboxed
 323                 | otherwise ->
 324                   CCheck HP_CHK_UNBX_R1 [mkIntCLit words_required] AbsCNop
 325
 326             -- FloatReg1
 327             [FloatReg ILIT(1)] ->
 328                   CCheck HP_CHK_F1 [mkIntCLit words_required] AbsCNop
 329
 330             -- DblReg1
 331             [DoubleReg ILIT(1)] ->
 332                   CCheck HP_CHK_D1 [mkIntCLit words_required] AbsCNop
 333
 334             -- LngReg1
 335             [LongReg _ ILIT(1)] ->
 336                   CCheck HP_CHK_L1 [mkIntCLit words_required] AbsCNop
 337
 338 #ifdef DEBUG
 339             _ -> panic ("CgHeapery.altHeapCheck: unimplemented heap-check, live regs = " ++ showSDoc (sep (map pprMagicId non_void_regs)))
 340 #endif
 341
 342 -- build up a bitmap of the live pointer registers
 343
 344 mkRegLiveness :: [MagicId] -> Word#
 345 mkRegLiveness [] = int2Word# 0#
 346 mkRegLiveness (VanillaReg rep i : regs)
 347    | isFollowableRep rep = ((int2Word# 1#) `shiftL#` (i -# 1#))
 348                                 `or#` mkRegLiveness regs
 349    | otherwise           = mkRegLiveness regs
 350
 351 -- Emit macro for simulating a fetch and then reschedule
 352
 353 fetchAndReschedule ::   [MagicId]               -- Live registers
 354                         -> Bool                 -- Node reqd?
 355                         -> Code
 356
 357 fetchAndReschedule regs node_reqd  =
 358       if (node `elem` regs || node_reqd)
 359         then fetch_code `thenC` reschedule_code
 360         else absC AbsCNop
 361       where
 362         all_regs = if node_reqd then node:regs else regs
 363         liveness_mask = 0 {-XXX: mkLiveRegsMask all_regs-}
 364
 365         reschedule_code = absC  (CMacroStmt GRAN_RESCHEDULE [
 366                                  mkIntCLit liveness_mask,
 367                                  mkIntCLit (if node_reqd then 1 else 0)])
 368
 369          --HWL: generate GRAN_FETCH macro for GrAnSim
 370          --     currently GRAN_FETCH and GRAN_FETCH_AND_RESCHEDULE are miai
 371         fetch_code = absC (CMacroStmt GRAN_FETCH [])
 372 \end{code}
 373
 374 The @GRAN_YIELD@ macro is taken from JSM's  code for Concurrent Haskell. It
 375 allows to context-switch at  places where @node@ is  not alive (it uses the
 376 @Continue@ rather  than the @EnterNodeCode@  function in the  RTS). We emit
 377 this kind of macro at the beginning of the following kinds of basic bocks:
 378 \begin{itemize}
 379  \item Slow entry code where node is not alive (see @CgClosure.lhs@). Normally
 380        we use @fetchAndReschedule@ at a slow entry code.
 381  \item Fast entry code (see @CgClosure.lhs@).
 382  \item Alternatives in case expressions (@CLabelledCode@ structures), provided
 383        that they are not inlined (see @CgCases.lhs@). These alternatives will
 384        be turned into separate functions.
 385 \end{itemize}
 386
 387 \begin{code}
 388 yield ::   [MagicId]               -- Live registers
 389              -> Bool                 -- Node reqd?
 390              -> Code
 391
 392 yield regs node_reqd =
 393       -- NB: node is not alive; that's why we use DO_YIELD rather than
 394       --     GRAN_RESCHEDULE
 395       yield_code
 396       where
 397         all_regs = if node_reqd then node:regs else regs
 398         liveness_mask = 0 {-XXX: mkLiveRegsMask all_regs-}
 399
 400         yield_code = absC (CMacroStmt GRAN_YIELD [mkIntCLit liveness_mask])
 401 \end{code}
 402
 403 %************************************************************************
 404 %*                                                                      *
 405 \subsection[initClosure]{Initialise a dynamic closure}
 406 %*                                                                      *
 407 %************************************************************************
 408
 409 @allocDynClosure@ puts the thing in the heap, and modifies the virtual Hp
 410 to account for this.
 411
 412 \begin{code}
 413 allocDynClosure
 414         :: ClosureInfo
 415         -> CAddrMode            -- Cost Centre to stick in the object
 416         -> CAddrMode            -- Cost Centre to blame for this alloc
 417                                 -- (usually the same; sometimes "OVERHEAD")
 418
 419         -> [(CAddrMode, VirtualHeapOffset)]     -- Offsets from start of the object
 420                                                 -- ie Info ptr has offset zero.
 421         -> FCode VirtualHeapOffset              -- Returns virt offset of object
 422
 423 allocDynClosure closure_info use_cc blame_cc amodes_with_offsets
 424   = getVirtAndRealHp                            `thenFC` \ (virtHp, realHp) ->
 425
 426         -- FIND THE OFFSET OF THE INFO-PTR WORD
 427         -- virtHp points to last allocated word, ie 1 *before* the
 428         -- info-ptr word of new object.
 429     let  info_offset = virtHp + 1
 430
 431         -- do_move IS THE ASSIGNMENT FUNCTION
 432          do_move (amode, offset_from_start)
 433            = CAssign (CVal (hpRel realHp
 434                                   (info_offset + offset_from_start))
 435                            (getAmodeRep amode))
 436                      amode
 437     in
 438         -- SAY WHAT WE ARE ABOUT TO DO
 439     profCtrC (allocProfilingMsg closure_info)
 440                            [mkIntCLit fixedHdrSize,
 441                             mkIntCLit (closureGoodStuffSize closure_info),
 442                             mkIntCLit slop_size,
 443                             mkIntCLit closure_size]     `thenC`
 444
 445         -- GENERATE THE CODE
 446     absC ( mkAbstractCs (
 447            [ cInitHdr closure_info (hpRel realHp info_offset) use_cc ]
 448            ++ (map do_move amodes_with_offsets)))       `thenC`
 449
 450         -- GENERATE CC PROFILING MESSAGES
 451     costCentresC SLIT("CCS_ALLOC") [blame_cc, mkIntCLit closure_size]
 452         -- CLitLit (_PK_ type_str) IntRep] -- not necessary? --SDM
 453                                                         `thenC`
 454
 455         -- BUMP THE VIRTUAL HEAP POINTER
 456     setVirtHp (virtHp + closure_size)                   `thenC`
 457
 458         -- RETURN PTR TO START OF OBJECT
 459     returnFC info_offset
 460   where
 461     closure_size = closureSize closure_info
 462     slop_size    = slopSize closure_info
 463     type_str     = getSMRepStr (closureSMRep closure_info)
 464
 465 -- Avoid hanging on to anything in the CC field when we're not profiling.
 466
 467 cInitHdr closure_info amode cc
 468   | opt_SccProfilingOn = CInitHdr closure_info amode cc
 469   | otherwise          = CInitHdr closure_info amode (panic "absent cc")
 470
 471 \end{code}
 472
 473 %************************************************************************
 474 %*                                                                      *
 475 \subsection{Allocate uninitialized heap space}
 476 %*                                                                      *
 477 %************************************************************************
 478
 479 \begin{code}
 480 allocHeap :: HeapOffset         -- Size of the space required
 481           -> FCode CAddrMode    -- Addr mode for first word of object
 482
 483 allocHeap space
 484   = getVirtAndRealHp                            `thenFC` \ (virtHp, realHp) ->
 485     let block_start = virtHp + 1
 486     in
 487         -- We charge the allocation to "PRIM" (which is probably right)
 488     profCtrC SLIT("ALLOC_PRIM2") [mkIntCLit space]      `thenC`
 489
 490         -- BUMP THE VIRTUAL HEAP POINTER
 491     setVirtHp (virtHp + space)                  `thenC`
 492
 493         -- RETURN PTR TO START OF OBJECT
 494     returnFC (CAddr (hpRel realHp block_start))
 495 \end{code}