ghc/compiler/codeGen/CgClosure.lhs

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