ghc/compiler/codeGen/CgClosure.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 % $Id: CgClosure.lhs,v 1.31 1999/05/18 15:03:47 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       ( adjustRealSp, mkTaggedVirtStkOffsets, freeStackSlots )
  39 import CgUsages         ( 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 )
  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
  61 getWrapperArgTypeCategories = panic "CgClosure.getWrapperArgTypeCategories (ToDo)"
  62 \end{code}
  63
  64 %********************************************************
  65 %*                                                      *
  66 \subsection[closures-no-free-vars]{Top-level closures}
  67 %*                                                      *
  68 %********************************************************
  69
  70 For closures bound at top level, allocate in static space.
  71 They should have no free variables.
  72
  73 \begin{code}
  74 cgTopRhsClosure :: Id
  75                 -> CostCentreStack      -- Optional cost centre annotation
  76                 -> StgBinderInfo
  77                 -> [Id]         -- Args
  78                 -> StgExpr
  79                 -> LambdaFormInfo
  80                 -> FCode (Id, CgIdInfo)
  81
  82 cgTopRhsClosure id ccs binder_info args body lf_info
  83   =     -- LAY OUT THE OBJECT
  84     let
  85         closure_info = layOutStaticNoFVClosure name lf_info
  86     in
  87
  88         -- BUILD THE OBJECT (IF NECESSARY)
  89     ({- if staticClosureRequired name binder_info lf_info
  90      then -}
  91         (if opt_SccProfilingOn
  92           then
  93              absC (CStaticClosure
  94                 closure_label   -- Labelled with the name on lhs of defn
  95                 closure_info
  96                 (mkCCostCentreStack ccs)
  97                 [])             -- No fields
  98           else
  99              absC (CStaticClosure
 100                 closure_label   -- Labelled with the name on lhs of defn
 101                 closure_info
 102                 (panic "absent cc")
 103                 [])             -- No fields
 104         )
 105
 106      {- else
 107         nopC -}
 108                                                         `thenC`
 109
 110         -- GENERATE THE INFO TABLE (IF NECESSARY)
 111     forkClosureBody (closureCodeBody binder_info closure_info
 112                                          ccs args body)
 113
 114     ) `thenC`
 115
 116     returnFC (id, cg_id_info)
 117   where
 118     name          = idName id
 119     closure_label = mkClosureLabel name
 120     cg_id_info    = stableAmodeIdInfo id (CLbl closure_label PtrRep) lf_info
 121 \end{code}
 122
 123 %********************************************************
 124 %*                                                      *
 125 \subsection[non-top-level-closures]{Non top-level closures}
 126 %*                                                      *
 127 %********************************************************
 128
 129 For closures with free vars, allocate in heap.
 130
 131 \begin{code}
 132 cgStdRhsClosure
 133         :: Id
 134         -> CostCentreStack      -- Optional cost centre annotation
 135         -> StgBinderInfo
 136         -> [Id]                 -- Free vars
 137         -> [Id]                 -- Args
 138         -> StgExpr
 139         -> LambdaFormInfo
 140         -> [StgArg]             -- payload
 141         -> FCode (Id, CgIdInfo)
 142
 143 cgStdRhsClosure binder cc binder_info fvs args body lf_info payload
 144                 -- AHA!  A STANDARD-FORM THUNK
 145   = (
 146         -- LAY OUT THE OBJECT
 147     getArgAmodes payload                        `thenFC` \ amodes ->
 148     let
 149         (closure_info, amodes_w_offsets)
 150           = layOutDynClosure (idName binder) getAmodeRep amodes lf_info
 151
 152         (use_cc, blame_cc) = chooseDynCostCentres cc args fvs body
 153     in
 154         -- BUILD THE OBJECT
 155     allocDynClosure closure_info use_cc blame_cc amodes_w_offsets
 156     )
 157                 `thenFC` \ heap_offset ->
 158
 159         -- RETURN
 160     returnFC (binder, heapIdInfo binder heap_offset lf_info)
 161
 162   where
 163     is_std_thunk           = isStandardFormThunk 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                 -> [Id]                 -- Free vars
 173                 -> [Id]                 -- Args
 174                 -> StgExpr
 175                 -> LambdaFormInfo
 176                 -> FCode (Id, CgIdInfo)
 177
 178 cgRhsClosure binder cc binder_info 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 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                 -> ClosureInfo     -- Lots of information about this closure
 248                 -> CostCentreStack -- Optional cost centre attached to closure
 249                 -> [Id]
 250                 -> StgExpr
 251                 -> Code
 252 \end{code}
 253
 254 There are two main cases for the code for closures.  If there are {\em
 255 no arguments}, then the closure is a thunk, and not in normal form.
 256 So it should set up an update frame (if it is shared).  Also, it has
 257 no argument satisfaction check, so fast and slow entry-point labels
 258 are the same.
 259
 260 \begin{code}
 261 closureCodeBody binder_info closure_info cc [] body
 262   = -- thunks cannot have a primitive type!
 263     getAbsC body_code   `thenFC` \ body_absC ->
 264     moduleName          `thenFC` \ mod_name ->
 265
 266     absC (CClosureInfoAndCode closure_info body_absC Nothing
 267                               (cl_descr mod_name))
 268   where
 269     cl_descr mod_name = closureDescription mod_name (closureName closure_info)
 270
 271     body_label   = entryLabelFromCI closure_info
 272     is_box  = case body of { StgApp fun [] -> True; _ -> False }
 273
 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 is_box `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 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                     mkIntCLit stg_arity         -- total # of args
 375
 376                 {-  CLbl (mkRednCountsLabel name) PtrRep,
 377                     CString (_PK_ (showSDoc (ppr name))),
 378                     mkIntCLit stg_arity,        -- total # of args
 379                     mkIntCLit sp_stk_args,      -- # passed on stk
 380                     CString (_PK_ (map (showTypeCategory . idType) all_args)),
 381                     CString SLIT(""), CString SLIT("")
 382                 -}
 383
 384 -- Nuked for now; see comment at end of file
 385 --                  CString (_PK_ (show_wrapper_name wrapper_maybe)),
 386 --                  CString (_PK_ (show_wrapper_arg_kinds wrapper_maybe))
 387
 388                 ]                       `thenC`
 389
 390                 -- Bind args to regs/stack as appropriate, and
 391                 -- record expected position of sps.
 392             bindArgsToRegs reg_args arg_regs                `thenC`
 393             mapCs bindNewToStack stk_offsets                `thenC`
 394             setRealAndVirtualSp sp_stk_args                 `thenC`
 395
 396                 -- free up the stack slots containing tags
 397             freeStackSlots (map fst stk_tags)               `thenC`
 398
 399                 -- Enter the closures cc, if required
 400             enterCostCentreCode closure_info cc IsFunction False `thenC`
 401
 402                 -- Do the business
 403             funWrapper closure_info arg_regs stk_tags info_label (cgExpr body)
 404     in
 405         -- Make a labelled code-block for the slow and fast entry code
 406     forkAbsC (if slow_code_needed then slow_entry_code else absC AbsCNop)
 407                                 `thenFC` \ slow_abs_c ->
 408     forkAbsC fast_entry_code    `thenFC` \ fast_abs_c ->
 409     moduleName                  `thenFC` \ mod_name ->
 410
 411         -- Now either construct the info table, or put the fast code in alone
 412         -- (We never have slow code without an info table)
 413         -- XXX probably need the info table and slow entry code in case of
 414         -- a heap check failure.
 415     absC (
 416       if info_table_needed then
 417         CClosureInfoAndCode closure_info slow_abs_c (Just fast_abs_c)
 418                         (cl_descr mod_name)
 419       else
 420         CCodeBlock fast_label fast_abs_c
 421     )
 422   where
 423     stg_arity = length all_args
 424     lf_info = closureLFInfo closure_info
 425
 426     cl_descr mod_name = closureDescription mod_name name
 427
 428         -- Manufacture labels
 429     name       = closureName closure_info
 430     fast_label = mkFastEntryLabel name stg_arity
 431     info_label = mkInfoTableLabel name
 432 \end{code}
 433
 434 For lexically scoped profiling we have to load the cost centre from
 435 the closure entered, if the costs are not supposed to be inherited.
 436 This is done immediately on entering the fast entry point.
 437
 438 Load current cost centre from closure, if not inherited.
 439 Node is guaranteed to point to it, if profiling and not inherited.
 440
 441 \begin{code}
 442 data IsThunk = IsThunk | IsFunction -- Bool-like, local
 443 -- #ifdef DEBUG
 444         deriving Eq
 445 -- #endif
 446
 447 enterCostCentreCode
 448    :: ClosureInfo -> CostCentreStack
 449    -> IsThunk
 450    -> Bool      -- is_box: this closure is a special box introduced by SCCfinal
 451    -> Code
 452
 453 enterCostCentreCode closure_info ccs is_thunk is_box
 454   = if not opt_SccProfilingOn then
 455         nopC
 456     else
 457         ASSERT(not (noCCSAttached ccs))
 458
 459         if isSubsumedCCS ccs then
 460             ASSERT(isToplevClosure closure_info)
 461             ASSERT(is_thunk == IsFunction)
 462             costCentresC SLIT("ENTER_CCS_FSUB") []
 463
 464         else if isCurrentCCS ccs then
 465             if re_entrant && not is_box
 466                 then costCentresC SLIT("ENTER_CCS_FCL") [CReg node]
 467                 else costCentresC SLIT("ENTER_CCS_TCL") [CReg node]
 468
 469         else if isCafCCS ccs then
 470             ASSERT(isToplevClosure closure_info)
 471             ASSERT(is_thunk == IsThunk)
 472                 -- might be a PAP, in which case we want to subsume costs
 473             if re_entrant
 474                 then costCentresC SLIT("ENTER_CCS_FSUB") []
 475                 else costCentresC SLIT("ENTER_CCS_CAF") c_ccs
 476
 477         else panic "enterCostCentreCode"
 478
 479    where
 480         c_ccs = [mkCCostCentreStack ccs]
 481         re_entrant = closureReEntrant closure_info
 482 \end{code}
 483
 484 %************************************************************************
 485 %*                                                                      *
 486 \subsubsection[pre-closure-code-stuff]{Pre-closure-code code}
 487 %*                                                                      *
 488 %************************************************************************
 489
 490 The argument-satisfaction check code is placed after binding
 491 the arguments to their stack locations. Hence, the virtual stack
 492 pointer is pointing after all the args, and virtual offset 1 means
 493 the base of frame and hence most distant arg.  Hence
 494 virtual offset 0 is just beyond the most distant argument; the
 495 relative offset of this word tells how many words of arguments
 496 are expected.
 497
 498 \begin{code}
 499 argSatisfactionCheck :: ClosureInfo -> Code
 500
 501 argSatisfactionCheck closure_info
 502
 503   = nodeMustPointToIt (closureLFInfo closure_info)   `thenFC` \ node_points ->
 504
 505     let
 506        emit_gran_macros = opt_GranMacros
 507     in
 508
 509     -- HWL  ngo' ngoq:
 510     -- absC (CMacroStmt GRAN_FETCH [])                  `thenC`
 511     -- forceHeapCheck [] node_points (absC AbsCNop)                     `thenC`
 512     (if emit_gran_macros
 513       then if node_points
 514              then fetchAndReschedule  [] node_points
 515              else yield [] node_points
 516       else absC AbsCNop)                       `thenC`
 517
 518         getSpRelOffset 0        `thenFC` \ (SpRel sp) ->
 519         let
 520             off = I# sp
 521             rel_arg = mkIntCLit off
 522         in
 523         ASSERT(off /= 0)
 524         if node_points then
 525             absC (CMacroStmt ARGS_CHK [rel_arg]) -- node already points
 526         else
 527             absC (CMacroStmt ARGS_CHK_LOAD_NODE [rel_arg, set_Node_to_this])
 528   where
 529     -- We must tell the arg-satis macro whether Node is pointing to
 530     -- the closure or not.  If it isn't so pointing, then we give to
 531     -- the macro the (static) address of the closure.
 532
 533     set_Node_to_this = CLbl (closureLabelFromCI closure_info) PtrRep
 534 \end{code}
 535
 536 %************************************************************************
 537 %*                                                                      *
 538 \subsubsection[closure-code-wrappers]{Wrappers around closure code}
 539 %*                                                                      *
 540 %************************************************************************
 541
 542 \begin{code}
 543 thunkWrapper:: ClosureInfo -> CLabel -> Code -> Code
 544 thunkWrapper closure_info label thunk_code
 545   =     -- Stack and heap overflow checks
 546     nodeMustPointToIt (closureLFInfo closure_info) `thenFC` \ node_points ->
 547
 548     let
 549        emit_gran_macros = opt_GranMacros
 550     in
 551         -- HWL: insert macros for GrAnSim; 2 versions depending on liveness of node
 552         -- (we prefer fetchAndReschedule-style context switches to yield ones)
 553     (if emit_gran_macros
 554       then if node_points
 555              then fetchAndReschedule  [] node_points
 556              else yield [] node_points
 557       else absC AbsCNop)                       `thenC`
 558
 559         -- stack and/or heap checks
 560     thunkChecks label node_points (
 561
 562         -- Overwrite with black hole if necessary
 563     blackHoleIt closure_info node_points        `thenC`
 564
 565     setupUpdate closure_info (                  -- setupUpdate *encloses* the rest
 566
 567         -- Finally, do the business
 568     thunk_code
 569     ))
 570
 571 funWrapper :: ClosureInfo       -- Closure whose code body this is
 572            -> [MagicId]         -- List of argument registers (if any)
 573            -> [(VirtualSpOffset,Int)] -- tagged stack slots
 574            -> CLabel            -- info table for heap check ret.
 575            -> Code              -- Body of function being compiled
 576            -> Code
 577 funWrapper closure_info arg_regs stk_tags info_label fun_body
 578   =     -- Stack overflow check
 579     nodeMustPointToIt (closureLFInfo closure_info)      `thenFC` \ node_points ->
 580     let
 581        emit_gran_macros = opt_GranMacros
 582     in
 583     -- HWL   chu' ngoq:
 584     (if emit_gran_macros
 585       then yield  arg_regs node_points
 586       else absC AbsCNop)                                 `thenC`
 587
 588         -- heap and/or stack checks
 589     fastEntryChecks arg_regs stk_tags info_label node_points (
 590
 591         -- Finally, do the business
 592     fun_body
 593     )
 594 \end{code}
 595
 596
 597 %************************************************************************
 598 %*                                                                      *
 599 \subsubsubsection[update-and-BHs]{Update and black-hole wrappers}
 600 %*                                                                      *
 601 %************************************************************************
 602
 603
 604 \begin{code}
 605 blackHoleIt :: ClosureInfo -> Bool -> Code      -- Only called for closures with no args
 606
 607 blackHoleIt closure_info node_points
 608   = if blackHoleOnEntry closure_info && node_points
 609     then
 610         absC (if closureSingleEntry(closure_info) then
 611                 CMacroStmt UPD_BH_SINGLE_ENTRY [CReg node]
 612               else
 613                 CMacroStmt UPD_BH_UPDATABLE [CReg node])
 614     else
 615         nopC
 616 \end{code}
 617
 618 \begin{code}
 619 setupUpdate :: ClosureInfo -> Code -> Code      -- Only called for closures with no args
 620         -- Nota Bene: this function does not change Node (even if it's a CAF),
 621         -- so that the cost centre in the original closure can still be
 622         -- extracted by a subsequent ENTER_CC_TCL
 623
 624 -- I've tidied up the code for this function, but it should still do the same as
 625 -- it did before (modulo ticky stuff).  KSW 1999-04.
 626 setupUpdate closure_info code
 627  = if closureReEntrant closure_info
 628    then
 629      code
 630    else
 631      case (closureUpdReqd closure_info, isStaticClosure closure_info) of
 632        (False,False) -> profCtrC SLIT("TICK_UPDF_OMITTED") [] `thenC`
 633                         code
 634        (False,True ) -> (if opt_DoTickyProfiling
 635                          then
 636                          -- blackhole the SE CAF
 637                            link_caf seCafBlackHoleClosureInfo `thenFC` \ _ -> nopC
 638                          else
 639                            nopC)                                                       `thenC`
 640                         profCtrC SLIT("TICK_UPD_CAF_BH_SINGLE_ENTRY") [CString cl_name] `thenC`
 641                         profCtrC SLIT("TICK_UPDF_OMITTED") []                           `thenC`
 642                         code
 643        (True ,False) -> pushUpdateFrame (CReg node) code
 644        (True ,True ) -> -- blackhole the (updatable) CAF:
 645                         link_caf cafBlackHoleClosureInfo           `thenFC` \ update_closure ->
 646                         profCtrC SLIT("TICK_UPD_CAF_BH_UPDATABLE") [CString cl_name]    `thenC`
 647                         pushUpdateFrame update_closure code
 648  where
 649    cl_name :: FAST_STRING
 650    cl_name  = (occNameFS . nameOccName . closureName) closure_info
 651
 652    link_caf :: (ClosureInfo -> ClosureInfo)  -- function yielding BH closure_info
 653             -> FCode CAddrMode               -- Returns amode for closure to be updated
 654    link_caf bhCI
 655      = -- To update a CAF we must allocate a black hole, link the CAF onto the
 656        -- CAF list, then update the CAF to point to the fresh black hole.
 657        -- This function returns the address of the black hole, so it can be
 658        -- updated with the new value when available.
 659
 660              -- Alloc black hole specifying CC_HDR(Node) as the cost centre
 661              --   Hack Warning: Using a CLitLit to get CAddrMode !
 662        let
 663            use_cc   = CLitLit SLIT("CCS_HDR(R1.p)") PtrRep
 664            blame_cc = use_cc
 665        in
 666        allocDynClosure (bhCI closure_info) use_cc blame_cc []  `thenFC` \ heap_offset ->
 667        getHpRelOffset heap_offset                              `thenFC` \ hp_rel ->
 668        let  amode = CAddr hp_rel
 669        in
 670        absC (CMacroStmt UPD_CAF [CReg node, amode])            `thenC`
 671        returnFC amode
 672 \end{code}
 673
 674 %************************************************************************
 675 %*                                                                      *
 676 \subsection[CgClosure-Description]{Profiling Closure Description.}
 677 %*                                                                      *
 678 %************************************************************************
 679
 680 For "global" data constructors the description is simply occurrence
 681 name of the data constructor itself (see \ref{CgConTbls-info-tables}).
 682
 683 Otherwise it is determind by @closureDescription@ from the let
 684 binding information.
 685
 686 \begin{code}
 687 closureDescription :: Module            -- Module
 688                    -> Name              -- Id of closure binding
 689                    -> String
 690
 691         -- Not called for StgRhsCon which have global info tables built in
 692         -- CgConTbls.lhs with a description generated from the data constructor
 693
 694 closureDescription mod_name name
 695   = showSDoc (
 696         hcat [char '<',
 697                    pprModule mod_name,
 698                    char '.',
 699                    ppr name,
 700                    char '>'])
 701 \end{code}
 702
 703 \begin{code}
 704 chooseDynCostCentres ccs args fvs body
 705   = let
 706         use_cc -- cost-centre we record in the object
 707           = if currentOrSubsumedCCS ccs
 708             then CReg CurCostCentre
 709             else mkCCostCentreStack ccs
 710
 711         blame_cc -- cost-centre on whom we blame the allocation
 712           = case (args, fvs, body) of
 713               ([], _, StgApp fun [{-no args-}])
 714                 -> mkCCostCentreStack overheadCCS
 715               _ -> use_cc
 716
 717             -- if it's an utterly trivial RHS, then it must be
 718             -- one introduced by boxHigherOrderArgs for profiling,
 719             -- so we charge it to "OVERHEAD".
 720
 721             -- This looks like a HACK to me --SDM
 722     in
 723     (use_cc, blame_cc)
 724 \end{code}
 725
 726
 727
 728 ========================================================================
 729 OLD CODE THAT EMITTED INFORMATON FOR QUANTITATIVE ANALYSIS
 730
 731 It's pretty wierd, so I've nuked it for now.  SLPJ Nov 96
 732
 733 \begin{pseudocode}
 734 getWrapperArgTypeCategories
 735         :: Type                         -- wrapper's type
 736         -> StrictnessInfo bdee          -- strictness info about its args
 737         -> Maybe String
 738
 739 getWrapperArgTypeCategories _ NoStrictnessInfo      = Nothing
 740 getWrapperArgTypeCategories _ BottomGuaranteed
 741   = trace "getWrapperArgTypeCategories:BottomGuaranteed!" Nothing  -- wrong
 742 getWrapperArgTypeCategories _ (StrictnessInfo [] _) = Nothing
 743
 744 getWrapperArgTypeCategories ty (StrictnessInfo arg_info _)
 745   = Just (mkWrapperArgTypeCategories ty arg_info)
 746
 747 mkWrapperArgTypeCategories
 748         :: Type         -- wrapper's type
 749         -> [Demand]     -- info about its arguments
 750         -> String       -- a string saying lots about the args
 751
 752 mkWrapperArgTypeCategories wrapper_ty wrap_info
 753   = case (splitFunTy_maybe wrapper_ty) of { Just (arg_tys,_) ->
 754     map do_one (wrap_info `zip` (map showTypeCategory arg_tys)) }
 755   where
 756     -- ToDo: this needs FIXING UP (it was a hack anyway...)
 757     do_one (WwPrim, _) = 'P'
 758     do_one (WwEnum, _) = 'E'
 759     do_one (WwStrict, arg_ty_char) = arg_ty_char
 760     do_one (WwUnpack _ _ _, arg_ty_char)
 761       = if arg_ty_char `elem` "CIJFDTS"
 762         then toLower arg_ty_char
 763         else if arg_ty_char == '+' then 't'
 764         else trace ("mkWrapp..:funny char:"++[arg_ty_char]) '-'
 765     do_one (other_wrap_info, _) = '-'
 766 \end{pseudocode}
 767