ghc/compiler/codeGen/CgClosure.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 % $Id: CgClosure.lhs,v 1.49 2001/09/26 15:11:50 simonpj Exp $
   5 %
   6 \section[CgClosure]{Code generation for closures}
   7
   8 This module provides the support code for @StgToAbstractC@ to deal
   9 with {\em closures} on the RHSs of let(rec)s.  See also
  10 @CgCon@, which deals with constructors.
  11
  12 \begin{code}
  13 module CgClosure ( cgTopRhsClosure,
  14                    cgStdRhsClosure,
  15                    cgRhsClosure,
  16                    closureCodeBody ) where
  17
  18 #include "HsVersions.h"
  19
  20 import {-# SOURCE #-} CgExpr ( cgExpr )
  21
  22 import CgMonad
  23 import AbsCSyn
  24 import StgSyn
  25
  26 import AbsCUtils        ( mkAbstractCs, getAmodeRep )
  27 import CgBindery        ( getCAddrMode, getArgAmodes,
  28                           getCAddrModeAndInfo, bindNewToNode,
  29                           bindNewToStack,
  30                           bindNewToReg, bindArgsToRegs,
  31                           stableAmodeIdInfo, heapIdInfo, CgIdInfo
  32                         )
  33 import CgUpdate         ( pushUpdateFrame )
  34 import CgHeapery        ( allocDynClosure,
  35                           fetchAndReschedule, yield,  -- HWL
  36                           fastEntryChecks, thunkChecks
  37                         )
  38 import CgStackery       ( mkTaggedVirtStkOffsets, freeStackSlots )
  39 import CgUsages         ( adjustSpAndHp, setRealAndVirtualSp, getVirtSp,
  40                           getSpRelOffset, getHpRelOffset
  41                         )
  42 import CLabel           ( CLabel, mkClosureLabel, mkFastEntryLabel,
  43                           mkRednCountsLabel, mkInfoTableLabel
  44                         )
  45 import ClosureInfo      -- lots and lots of stuff
  46 import CmdLineOpts      ( opt_GranMacros, opt_SccProfilingOn, opt_DoTickyProfiling )
  47 import CostCentre
  48 import Id               ( Id, idName, idType, idPrimRep )
  49 import Name             ( Name, isLocalName )
  50 import Module           ( Module, pprModule )
  51 import ListSetOps       ( minusList )
  52 import PrimRep          ( PrimRep(..) )
  53 import PprType          ( showTypeCategory )
  54 import Util             ( isIn )
  55 import CmdLineOpts      ( opt_SccProfilingOn )
  56 import Outputable
  57
  58 import Name             ( nameOccName )
  59 import OccName          ( occNameFS )
  60 import FastTypes        ( iBox )
  61 \end{code}
  62
  63 %********************************************************
  64 %*                                                      *
  65 \subsection[closures-no-free-vars]{Top-level closures}
  66 %*                                                      *
  67 %********************************************************
  68
  69 For closures bound at top level, allocate in static space.
  70 They should have no free variables.
  71
  72 \begin{code}
  73 cgTopRhsClosure :: Id
  74                 -> CostCentreStack      -- Optional cost centre annotation
  75                 -> StgBinderInfo
  76                 -> SRT
  77                 -> [Id]         -- Args
  78                 -> StgExpr
  79                 -> LambdaFormInfo
  80                 -> FCode (Id, CgIdInfo)
  81
  82 cgTopRhsClosure id ccs binder_info srt args body lf_info
  83   =
  84     -- LAY OUT THE OBJECT
  85     getSRTInfo srt              `thenFC` \ srt_info ->
  86     let
  87         name          = idName id
  88         closure_info  = layOutStaticNoFVClosure name lf_info srt_info
  89         closure_label = mkClosureLabel name
  90         cg_id_info    = stableAmodeIdInfo id (CLbl closure_label PtrRep) lf_info
  91     in
  92
  93         -- BUILD THE OBJECT (IF NECESSARY)
  94     ({- if staticClosureRequired name binder_info lf_info
  95      then -}
  96         (if opt_SccProfilingOn
  97           then
  98              absC (CStaticClosure
  99                 closure_label   -- Labelled with the name on lhs of defn
 100                 closure_info
 101                 (mkCCostCentreStack ccs)
 102                 [])             -- No fields
 103           else
 104              absC (CStaticClosure
 105                 closure_label   -- Labelled with the name on lhs of defn
 106                 closure_info
 107                 (panic "absent cc")
 108                 [])             -- No fields
 109         )
 110
 111      {- else
 112         nopC -}
 113                                                         `thenC`
 114
 115         -- GENERATE THE INFO TABLE (IF NECESSARY)
 116     forkClosureBody (closureCodeBody binder_info closure_info
 117                                          ccs args body)
 118
 119     ) `thenC`
 120
 121     returnFC (id, cg_id_info)
 122
 123 \end{code}
 124
 125 %********************************************************
 126 %*                                                      *
 127 \subsection[non-top-level-closures]{Non top-level closures}
 128 %*                                                      *
 129 %********************************************************
 130
 131 For closures with free vars, allocate in heap.
 132
 133 \begin{code}
 134 cgStdRhsClosure
 135         :: Id
 136         -> CostCentreStack      -- Optional cost centre annotation
 137         -> StgBinderInfo
 138         -> [Id]                 -- Free vars
 139         -> [Id]                 -- Args
 140         -> StgExpr
 141         -> LambdaFormInfo
 142         -> [StgArg]             -- payload
 143         -> FCode (Id, CgIdInfo)
 144
 145 cgStdRhsClosure binder cc binder_info fvs args body lf_info payload
 146                 -- AHA!  A STANDARD-FORM THUNK
 147   = (
 148         -- LAY OUT THE OBJECT
 149     getArgAmodes payload                        `thenFC` \ amodes ->
 150     let
 151         (closure_info, amodes_w_offsets)
 152           = layOutDynClosure (idName binder) getAmodeRep amodes lf_info NoC_SRT
 153                 -- No SRT for a standard-form closure
 154
 155         (use_cc, blame_cc) = chooseDynCostCentres cc args fvs body
 156     in
 157         -- BUILD THE OBJECT
 158     allocDynClosure closure_info use_cc blame_cc amodes_w_offsets
 159     )
 160                 `thenFC` \ heap_offset ->
 161
 162         -- RETURN
 163     returnFC (binder, heapIdInfo binder heap_offset lf_info)
 164 \end{code}
 165
 166 Here's the general case.
 167
 168 \begin{code}
 169 cgRhsClosure    :: Id
 170                 -> CostCentreStack      -- Optional cost centre annotation
 171                 -> StgBinderInfo
 172                 -> SRT
 173                 -> [Id]                 -- Free vars
 174                 -> [Id]                 -- Args
 175                 -> StgExpr
 176                 -> LambdaFormInfo
 177                 -> FCode (Id, CgIdInfo)
 178
 179 cgRhsClosure binder cc binder_info srt fvs args body lf_info
 180   = (
 181         -- LAY OUT THE OBJECT
 182         --
 183         -- If the binder is itself a free variable, then don't store
 184         -- it in the closure.  Instead, just bind it to Node on entry.
 185         -- NB we can be sure that Node will point to it, because we
 186         -- havn't told mkClosureLFInfo about this; so if the binder
 187         -- *was* a free var of its RHS, mkClosureLFInfo thinks it *is*
 188         -- stored in the closure itself, so it will make sure that
 189         -- Node points to it...
 190     let
 191         is_elem        = isIn "cgRhsClosure"
 192
 193         binder_is_a_fv = binder `is_elem` fvs
 194         reduced_fvs    = if binder_is_a_fv
 195                          then fvs `minusList` [binder]
 196                          else fvs
 197     in
 198     mapFCs getCAddrModeAndInfo reduced_fvs      `thenFC` \ fvs_w_amodes_and_info ->
 199     getSRTInfo srt                              `thenFC` \ srt_info ->
 200     let
 201         closure_info :: ClosureInfo
 202         bind_details :: [((Id, CAddrMode, LambdaFormInfo), VirtualHeapOffset)]
 203
 204         (closure_info, bind_details)
 205           = layOutDynClosure (idName binder) get_kind
 206                              fvs_w_amodes_and_info lf_info srt_info
 207
 208         bind_fv ((id, _, lf_info), offset) = bindNewToNode id offset lf_info
 209
 210         amodes_w_offsets = [(amode,offset) | ((_,amode,_), offset) <- bind_details]
 211
 212         get_kind (id, _, _) = idPrimRep id
 213     in
 214         -- BUILD ITS INFO TABLE AND CODE
 215     forkClosureBody (
 216                 -- Bind the fvs
 217             mapCs bind_fv bind_details `thenC`
 218
 219                 -- Bind the binder itself, if it is a free var
 220             (if binder_is_a_fv then
 221                 bindNewToReg binder node lf_info
 222             else
 223                 nopC)                                   `thenC`
 224
 225                 -- Compile the body
 226             closureCodeBody binder_info closure_info cc args body
 227     )   `thenC`
 228
 229         -- BUILD THE OBJECT
 230     let
 231         (use_cc, blame_cc) = chooseDynCostCentres cc args fvs body
 232     in
 233     allocDynClosure closure_info use_cc blame_cc amodes_w_offsets
 234     )           `thenFC` \ heap_offset ->
 235
 236         -- RETURN
 237     returnFC (binder, heapIdInfo binder heap_offset lf_info)
 238 \end{code}
 239
 240 %************************************************************************
 241 %*                                                                      *
 242 \subsection[code-for-closures]{The code for closures}
 243 %*                                                                      *
 244 %************************************************************************
 245
 246 \begin{code}
 247 closureCodeBody :: StgBinderInfo
 248                 -> ClosureInfo     -- Lots of information about this closure
 249                 -> CostCentreStack -- Optional cost centre attached to closure
 250                 -> [Id]
 251                 -> StgExpr
 252                 -> Code
 253 \end{code}
 254
 255 There are two main cases for the code for closures.  If there are {\em
 256 no arguments}, then the closure is a thunk, and not in normal form.
 257 So it should set up an update frame (if it is shared).  Also, it has
 258 no argument satisfaction check, so fast and slow entry-point labels
 259 are the same.
 260
 261 \begin{code}
 262 closureCodeBody binder_info closure_info cc [] body
 263   = -- thunks cannot have a primitive type!
 264     getAbsC body_code   `thenFC` \ body_absC ->
 265     moduleName          `thenFC` \ mod_name ->
 266
 267     absC (CClosureInfoAndCode closure_info body_absC Nothing
 268                               (cl_descr mod_name))
 269   where
 270     cl_descr mod_name = closureDescription mod_name (closureName closure_info)
 271
 272     body_label   = entryLabelFromCI closure_info
 273
 274     is_box  = case body of { StgApp fun [] -> True; _ -> False }
 275
 276     body_code   = profCtrC SLIT("TICK_ENT_THK") []              `thenC`
 277                   thunkWrapper closure_info body_label (
 278                         -- We only enter cc after setting up update so that cc
 279                         -- of enclosing scope will be recorded in update frame
 280                         -- CAF/DICT functions will be subsumed by this enclosing cc
 281                     enterCostCentreCode closure_info cc IsThunk is_box `thenC`
 282                     cgExpr body)
 283 \end{code}
 284
 285 If there is {\em at least one argument}, then this closure is in
 286 normal form, so there is no need to set up an update frame.  On the
 287 other hand, we do have to check that there are enough args, and
 288 perform an update if not!
 289
 290 The Macros for GrAnSim are produced at the beginning of the
 291 argSatisfactionCheck (by calling fetchAndReschedule).  There info if
 292 Node points to closure is available. -- HWL
 293
 294 \begin{code}
 295 closureCodeBody binder_info closure_info cc all_args body
 296   = getEntryConvention name lf_info
 297                        (map idPrimRep all_args)         `thenFC` \ entry_conv ->
 298
 299     -- get the current virtual Sp (it might not be zero, eg. if we're
 300     -- compiling a let-no-escape).
 301     getVirtSp `thenFC` \vSp ->
 302
 303     let
 304         -- Figure out what is needed and what isn't
 305
 306         -- SDM: need everything for now in case the heap/stack check refers
 307         -- to it. (ToDo)
 308         slow_code_needed   = True
 309                    --slowFunEntryCodeRequired name binder_info entry_conv
 310         info_table_needed  = True
 311                    --funInfoTableRequired name binder_info lf_info
 312
 313         -- Arg mapping for standard (slow) entry point; all args on stack,
 314         -- with tagging.
 315         (sp_all_args, arg_offsets, _)
 316            = mkTaggedVirtStkOffsets vSp idPrimRep all_args
 317
 318         -- Arg mapping for the fast entry point; as many args as poss in
 319         -- registers; the rest on the stack
 320         --      arg_regs are the registers used for arg passing
 321         --      stk_args are the args which are passed on the stack
 322         --
 323         -- Args passed on the stack are tagged, but the tags may not
 324         -- actually be present (just gaps) if the function is called
 325         -- by jumping directly to the fast entry point.
 326         --
 327         arg_regs = case entry_conv of
 328                 DirectEntry lbl arity regs -> regs
 329                 other                      -> []  -- "(HWL ignored; no args passed in regs)"
 330
 331         num_arg_regs = length arg_regs
 332
 333         (reg_args, stk_args) = splitAt num_arg_regs all_args
 334
 335         (sp_stk_args, stk_offsets, stk_tags)
 336           = mkTaggedVirtStkOffsets vSp idPrimRep stk_args
 337
 338         -- HWL; Note: empty list of live regs in slow entry code
 339         -- Old version (reschedule combined with heap check);
 340         -- see argSatisfactionCheck for new version
 341         --slow_entry_code = forceHeapCheck [node] True slow_entry_code'
 342         --                where node = UnusedReg PtrRep 1
 343         --slow_entry_code = forceHeapCheck [] True slow_entry_code'
 344
 345         slow_entry_code
 346           = profCtrC SLIT("TICK_ENT_FUN_STD") [
 347                     CLbl ticky_ctr_label DataPtrRep
 348             ] `thenC`
 349
 350             -- Bind args, and record expected position of stk ptrs
 351             mapCs bindNewToStack arg_offsets                `thenC`
 352             setRealAndVirtualSp sp_all_args                 `thenC`
 353
 354             argSatisfactionCheck closure_info   arg_regs            `thenC`
 355
 356             -- OK, so there are enough args.  Now we need to stuff as
 357             -- many of them in registers as the fast-entry code
 358             -- expects. Note that the zipWith will give up when it hits
 359             -- the end of arg_regs.
 360
 361             mapFCs getCAddrMode all_args            `thenFC` \ stk_amodes ->
 362             absC (mkAbstractCs (zipWith assign_to_reg arg_regs stk_amodes))
 363                                                             `thenC`
 364
 365             -- Now adjust real stack pointers (no need to adjust Hp,
 366             -- but call this function for convenience).
 367             adjustSpAndHp sp_stk_args                   `thenC`
 368
 369             absC (CFallThrough (CLbl fast_label CodePtrRep))
 370
 371         assign_to_reg reg_id amode = CAssign (CReg reg_id) amode
 372
 373         -- HWL
 374         -- Old version (reschedule combined with heap check);
 375         -- see argSatisfactionCheck for new version
 376         -- fast_entry_code = forceHeapCheck [] True fast_entry_code'
 377
 378         fast_entry_code = do
 379                 mod_name <- moduleName
 380                 profCtrC SLIT("TICK_CTR") [
 381                         CLbl ticky_ctr_label DataPtrRep,
 382                         mkCString (_PK_ (ppr_for_ticky_name mod_name name)),
 383                         mkIntCLit stg_arity,    -- total # of args
 384                         mkIntCLit sp_stk_args,  -- # passed on stk
 385                         mkCString (_PK_ (map (showTypeCategory . idType) all_args))
 386                         ]
 387                 let prof =
 388                         profCtrC SLIT("TICK_ENT_FUN_DIRECT") [
 389                                 CLbl ticky_ctr_label DataPtrRep
 390                         ]
 391
 392 -- Nuked for now; see comment at end of file
 393 --                  CString (_PK_ (show_wrapper_name wrapper_maybe)),
 394 --                  CString (_PK_ (show_wrapper_arg_kinds wrapper_maybe))
 395
 396
 397                 -- Bind args to regs/stack as appropriate, and
 398                 -- record expected position of sps.
 399                 bindArgsToRegs reg_args arg_regs
 400                 mapCs bindNewToStack stk_offsets
 401                 setRealAndVirtualSp sp_stk_args
 402
 403                 -- free up the stack slots containing tags
 404                 freeStackSlots (map fst stk_tags)
 405
 406                 -- Enter the closures cc, if required
 407                 enterCostCentreCode closure_info cc IsFunction False
 408
 409                 -- Do the business
 410                 funWrapper closure_info arg_regs stk_tags info_label
 411                         (prof >> cgExpr body)
 412     in
 413
 414     setTickyCtrLabel ticky_ctr_label (
 415
 416         -- Make a labelled code-block for the slow and fast entry code
 417       forkAbsC (if slow_code_needed then slow_entry_code else absC AbsCNop)
 418                                 `thenFC` \ slow_abs_c ->
 419       forkAbsC fast_entry_code  `thenFC` \ fast_abs_c ->
 420       moduleName                `thenFC` \ mod_name ->
 421
 422         -- Now either construct the info table, or put the fast code in alone
 423         -- (We never have slow code without an info table)
 424         -- XXX probably need the info table and slow entry code in case of
 425         -- a heap check failure.
 426       absC (
 427        if info_table_needed then
 428           CClosureInfoAndCode closure_info slow_abs_c (Just fast_abs_c)
 429                         (cl_descr mod_name)
 430        else
 431         CCodeBlock fast_label fast_abs_c
 432        )
 433     )
 434   where
 435     ticky_ctr_label = mkRednCountsLabel name
 436
 437     stg_arity = length all_args
 438     lf_info = closureLFInfo closure_info
 439
 440     cl_descr mod_name = closureDescription mod_name name
 441
 442         -- Manufacture labels
 443     name       = closureName closure_info
 444     fast_label = mkFastEntryLabel name stg_arity
 445     info_label = mkInfoTableLabel name
 446
 447
 448 -- When printing the name of a thing in a ticky file, we want to
 449 -- give the module name even for *local* things.   We print
 450 -- just "x (M)" rather that "M.x" to distinguish them from the global kind.
 451 ppr_for_ticky_name mod_name name
 452   | isLocalName name = showSDocDebug (ppr name <+> (parens (ppr mod_name)))
 453   | otherwise        = showSDocDebug (ppr name)
 454 \end{code}
 455
 456 For lexically scoped profiling we have to load the cost centre from
 457 the closure entered, if the costs are not supposed to be inherited.
 458 This is done immediately on entering the fast entry point.
 459
 460 Load current cost centre from closure, if not inherited.
 461 Node is guaranteed to point to it, if profiling and not inherited.
 462
 463 \begin{code}
 464 data IsThunk = IsThunk | IsFunction -- Bool-like, local
 465 -- #ifdef DEBUG
 466         deriving Eq
 467 -- #endif
 468
 469 enterCostCentreCode
 470    :: ClosureInfo -> CostCentreStack
 471    -> IsThunk
 472    -> Bool      -- is_box: this closure is a special box introduced by SCCfinal
 473    -> Code
 474
 475 enterCostCentreCode closure_info ccs is_thunk is_box
 476   = if not opt_SccProfilingOn then
 477         nopC
 478     else
 479         ASSERT(not (noCCSAttached ccs))
 480
 481         if isSubsumedCCS ccs then
 482             ASSERT(isToplevClosure closure_info)
 483             ASSERT(is_thunk == IsFunction)
 484             costCentresC SLIT("ENTER_CCS_FSUB") []
 485
 486         else if isCurrentCCS ccs then
 487             if re_entrant && not is_box
 488                 then costCentresC SLIT("ENTER_CCS_FCL") [CReg node]
 489                 else costCentresC SLIT("ENTER_CCS_TCL") [CReg node]
 490
 491         else if isCafCCS ccs then
 492             ASSERT(isToplevClosure closure_info)
 493             ASSERT(is_thunk == IsThunk)
 494                 -- might be a PAP, in which case we want to subsume costs
 495             if re_entrant
 496                 then costCentresC SLIT("ENTER_CCS_FSUB") []
 497                 else costCentresC SLIT("ENTER_CCS_CAF") c_ccs
 498
 499         else panic "enterCostCentreCode"
 500
 501    where
 502         c_ccs = [mkCCostCentreStack ccs]
 503         re_entrant = closureReEntrant closure_info
 504 \end{code}
 505
 506 %************************************************************************
 507 %*                                                                      *
 508 \subsubsection[pre-closure-code-stuff]{Pre-closure-code code}
 509 %*                                                                      *
 510 %************************************************************************
 511
 512 The argument-satisfaction check code is placed after binding
 513 the arguments to their stack locations. Hence, the virtual stack
 514 pointer is pointing after all the args, and virtual offset 1 means
 515 the base of frame and hence most distant arg.  Hence
 516 virtual offset 0 is just beyond the most distant argument; the
 517 relative offset of this word tells how many words of arguments
 518 are expected.
 519
 520 \begin{code}
 521 argSatisfactionCheck :: ClosureInfo -> [MagicId] {-GRAN-} -> Code
 522
 523 argSatisfactionCheck closure_info arg_regs
 524
 525   = nodeMustPointToIt (closureLFInfo closure_info)   `thenFC` \ node_points ->
 526
 527 --      let
 528 --         emit_gran_macros = opt_GranMacros
 529 --      in
 530
 531     -- HWL  ngo' ngoq:
 532     -- absC (CMacroStmt GRAN_FETCH [])                  `thenC`
 533     -- forceHeapCheck [] node_points (absC AbsCNop)                     `thenC`
 534     --(if opt_GranMacros
 535     --  then if node_points
 536     --         then fetchAndReschedule  arg_regs node_points
 537     --         else yield arg_regs node_points
 538     --  else absC AbsCNop)                       `thenC`
 539
 540         getSpRelOffset 0        `thenFC` \ (SpRel sp) ->
 541         let
 542             off     = iBox sp
 543             rel_arg = mkIntCLit off
 544         in
 545         ASSERT(off /= 0)
 546         if node_points then
 547             absC (CMacroStmt ARGS_CHK [rel_arg]) -- node already points
 548         else
 549             absC (CMacroStmt ARGS_CHK_LOAD_NODE [rel_arg, set_Node_to_this])
 550   where
 551     -- We must tell the arg-satis macro whether Node is pointing to
 552     -- the closure or not.  If it isn't so pointing, then we give to
 553     -- the macro the (static) address of the closure.
 554
 555     set_Node_to_this = CLbl (closureLabelFromCI closure_info) PtrRep
 556 \end{code}
 557
 558 %************************************************************************
 559 %*                                                                      *
 560 \subsubsection[closure-code-wrappers]{Wrappers around closure code}
 561 %*                                                                      *
 562 %************************************************************************
 563
 564 \begin{code}
 565 thunkWrapper:: ClosureInfo -> CLabel -> Code -> Code
 566 thunkWrapper closure_info lbl thunk_code
 567   =     -- Stack and heap overflow checks
 568     nodeMustPointToIt (closureLFInfo closure_info) `thenFC` \ node_points ->
 569
 570     -- HWL: insert macros for GrAnSim; 2 versions depending on liveness of node
 571     -- (we prefer fetchAndReschedule-style context switches to yield ones)
 572     (if opt_GranMacros
 573        then if node_points
 574               then fetchAndReschedule [] node_points
 575               else yield [] node_points
 576        else absC AbsCNop)                       `thenC`
 577
 578         -- stack and/or heap checks
 579     thunkChecks lbl node_points (
 580
 581         -- Overwrite with black hole if necessary
 582     blackHoleIt closure_info node_points  `thenC`
 583
 584     setupUpdate closure_info (                  -- setupUpdate *encloses* the rest
 585
 586         -- Finally, do the business
 587     thunk_code
 588     ))
 589
 590 funWrapper :: ClosureInfo       -- Closure whose code body this is
 591            -> [MagicId]         -- List of argument registers (if any)
 592            -> [(VirtualSpOffset,Int)] -- tagged stack slots
 593            -> CLabel            -- info table for heap check ret.
 594            -> Code              -- Body of function being compiled
 595            -> Code
 596 funWrapper closure_info arg_regs stk_tags info_label fun_body
 597   =     -- Stack overflow check
 598     nodeMustPointToIt (closureLFInfo closure_info)      `thenFC` \ node_points ->
 599     -- HWL   chu' ngoq:
 600     (if opt_GranMacros
 601        then yield arg_regs node_points
 602        else absC AbsCNop)                                 `thenC`
 603
 604         -- heap and/or stack checks
 605     fastEntryChecks arg_regs stk_tags info_label node_points (
 606
 607         -- Finally, do the business
 608     fun_body
 609     )
 610 \end{code}
 611
 612
 613 %************************************************************************
 614 %*                                                                      *
 615 \subsubsubsection[update-and-BHs]{Update and black-hole wrappers}
 616 %*                                                                      *
 617 %************************************************************************
 618
 619
 620 \begin{code}
 621 blackHoleIt :: ClosureInfo -> Bool -> Code      -- Only called for closures with no args
 622
 623 blackHoleIt closure_info node_points
 624   = if blackHoleOnEntry closure_info && node_points
 625     then
 626         let
 627           info_label = infoTableLabelFromCI closure_info
 628           args = [ CLbl info_label DataPtrRep ]
 629         in
 630         absC (if closureSingleEntry(closure_info) then
 631                 CMacroStmt UPD_BH_SINGLE_ENTRY args
 632               else
 633                 CMacroStmt UPD_BH_UPDATABLE args)
 634     else
 635         nopC
 636 \end{code}
 637
 638 \begin{code}
 639 setupUpdate :: ClosureInfo -> Code -> Code      -- Only called for closures with no args
 640         -- Nota Bene: this function does not change Node (even if it's a CAF),
 641         -- so that the cost centre in the original closure can still be
 642         -- extracted by a subsequent ENTER_CC_TCL
 643
 644 -- I've tidied up the code for this function, but it should still do the same as
 645 -- it did before (modulo ticky stuff).  KSW 1999-04.
 646 setupUpdate closure_info code
 647  = if closureReEntrant closure_info
 648    then
 649      code
 650    else
 651      case (closureUpdReqd closure_info, isStaticClosure closure_info) of
 652        (False,False) -> profCtrC SLIT("TICK_UPDF_OMITTED") [] `thenC`
 653                         code
 654        (False,True ) -> (if opt_DoTickyProfiling
 655                          then
 656                          -- blackhole the SE CAF
 657                            link_caf seCafBlackHoleClosureInfo `thenFC` \ _ -> nopC
 658                          else
 659                            nopC)                                                       `thenC`
 660                         profCtrC SLIT("TICK_UPD_CAF_BH_SINGLE_ENTRY") [mkCString cl_name] `thenC`
 661                         profCtrC SLIT("TICK_UPDF_OMITTED") []                           `thenC`
 662                         code
 663        (True ,False) -> pushUpdateFrame (CReg node) code
 664        (True ,True ) -> -- blackhole the (updatable) CAF:
 665                         link_caf cafBlackHoleClosureInfo           `thenFC` \ update_closure ->
 666                         profCtrC SLIT("TICK_UPD_CAF_BH_UPDATABLE") [mkCString cl_name]    `thenC`
 667                         pushUpdateFrame update_closure code
 668  where
 669    cl_name :: FAST_STRING
 670    cl_name  = (occNameFS . nameOccName . closureName) closure_info
 671
 672    link_caf :: (ClosureInfo -> ClosureInfo)  -- function yielding BH closure_info
 673             -> FCode CAddrMode               -- Returns amode for closure to be updated
 674    link_caf bhCI
 675      = -- To update a CAF we must allocate a black hole, link the CAF onto the
 676        -- CAF list, then update the CAF to point to the fresh black hole.
 677        -- This function returns the address of the black hole, so it can be
 678        -- updated with the new value when available.
 679
 680              -- Alloc black hole specifying CC_HDR(Node) as the cost centre
 681        let
 682            use_cc   = CMacroExpr PtrRep CCS_HDR [nodeReg]
 683            blame_cc = use_cc
 684        in
 685        allocDynClosure (bhCI closure_info) use_cc blame_cc []  `thenFC` \ heap_offset ->
 686        getHpRelOffset heap_offset                              `thenFC` \ hp_rel ->
 687        let  amode = CAddr hp_rel
 688        in
 689        absC (CMacroStmt UPD_CAF [CReg node, amode])            `thenC`
 690        returnFC amode
 691 \end{code}
 692
 693 %************************************************************************
 694 %*                                                                      *
 695 \subsection[CgClosure-Description]{Profiling Closure Description.}
 696 %*                                                                      *
 697 %************************************************************************
 698
 699 For "global" data constructors the description is simply occurrence
 700 name of the data constructor itself (see \ref{CgConTbls-info-tables}).
 701
 702 Otherwise it is determind by @closureDescription@ from the let
 703 binding information.
 704
 705 \begin{code}
 706 closureDescription :: Module            -- Module
 707                    -> Name              -- Id of closure binding
 708                    -> String
 709
 710         -- Not called for StgRhsCon which have global info tables built in
 711         -- CgConTbls.lhs with a description generated from the data constructor
 712
 713 closureDescription mod_name name
 714   = showSDoc (
 715         hcat [char '<',
 716                    pprModule mod_name,
 717                    char '.',
 718                    ppr name,
 719                    char '>'])
 720 \end{code}
 721
 722 \begin{code}
 723 chooseDynCostCentres ccs args fvs body
 724   = let
 725         use_cc -- cost-centre we record in the object
 726           = if currentOrSubsumedCCS ccs
 727             then CReg CurCostCentre
 728             else mkCCostCentreStack ccs
 729
 730         blame_cc -- cost-centre on whom we blame the allocation
 731           = case (args, fvs, body) of
 732               ([], _, StgApp fun [{-no args-}])
 733                 -> mkCCostCentreStack overheadCCS
 734               _ -> use_cc
 735
 736             -- if it's an utterly trivial RHS, then it must be
 737             -- one introduced by boxHigherOrderArgs for profiling,
 738             -- so we charge it to "OVERHEAD".
 739
 740             -- This looks like a HACK to me --SDM
 741     in
 742     (use_cc, blame_cc)
 743 \end{code}
 744
 745
 746