ghc/compiler/codeGen/CgClosure.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
   3 %
   4 \section[CgClosure]{Code generation for closures}
   5
   6 This module provides the support code for @StgToAbstractC@ to deal
   7 with {\em closures} on the RHSs of let(rec)s.  See also
   8 @CgCon@, which deals with constructors.
   9
  10 \begin{code}
  11 #include "HsVersions.h"
  12
  13 module CgClosure ( cgTopRhsClosure, cgRhsClosure ) where
  14
  15 IMP_Ubiq(){-uitous-}
  16 IMPORT_DELOOPER(CgLoop2)        ( cgExpr )
  17
  18 import CgMonad
  19 import AbsCSyn
  20 import StgSyn
  21
  22 import AbsCUtils        ( mkAbstractCs, getAmodeRep )
  23 import CgBindery        ( getCAddrMode, getArgAmodes,
  24                           getCAddrModeAndInfo, bindNewToNode,
  25                           bindNewToAStack, bindNewToBStack,
  26                           bindNewToReg, bindArgsToRegs,
  27                           stableAmodeIdInfo, heapIdInfo, CgIdInfo
  28                         )
  29 import CgCompInfo       ( spARelToInt, spBRelToInt )
  30 import CgUpdate         ( pushUpdateFrame )
  31 import CgHeapery        ( allocDynClosure, heapCheck
  32                           , heapCheckOnly, fetchAndReschedule, yield  -- HWL
  33                         )
  34 import CgRetConv        ( ctrlReturnConvAlg, dataReturnConvAlg,
  35                           CtrlReturnConvention(..), DataReturnConvention(..)
  36                         )
  37 import CgStackery       ( getFinalStackHW, mkVirtStkOffsets,
  38                           adjustRealSps
  39                         )
  40 import CgUsages         ( getVirtSps, setRealAndVirtualSps,
  41                           getSpARelOffset, getSpBRelOffset,
  42                           getHpRelOffset
  43                         )
  44 import CLabel           ( mkClosureLabel, mkConUpdCodePtrVecLabel,
  45                           mkStdUpdCodePtrVecLabel, mkStdUpdVecTblLabel,
  46                           mkErrorStdEntryLabel, mkRednCountsLabel
  47                         )
  48 import ClosureInfo      -- lots and lots of stuff
  49 import CmdLineOpts      ( opt_ForConcurrent, opt_GranMacros )
  50 import CostCentre       ( useCurrentCostCentre, currentOrSubsumedCosts,
  51                           noCostCentreAttached, costsAreSubsumed,
  52                           isCafCC, isDictCC, overheadCostCentre, showCostCentre
  53                         )
  54 import HeapOffs         ( SYN_IE(VirtualHeapOffset) )
  55 import Id               ( idType, idPrimRep,
  56                           showId, getIdStrictness, dataConTag,
  57                           emptyIdSet,
  58                           GenId{-instance Outputable-}
  59                         )
  60 import ListSetOps       ( minusList )
  61 import Maybes           ( maybeToBool )
  62 import Outputable       ( Outputable(..){-instances-} ) -- ToDo:rm
  63 import PprStyle         ( PprStyle(..) )
  64 import PprType          ( GenType{-instance Outputable-}, TyCon{-ditto-} )
  65 import Pretty           ( prettyToUn, ppBesides, ppChar, ppPStr, ppCat, ppStr )
  66 import PrimRep          ( isFollowableRep, PrimRep(..) )
  67 import TyCon            ( isPrimTyCon, tyConDataCons )
  68 import Unpretty         ( uppShow )
  69 import Util             ( isIn, panic, pprPanic, assertPanic, pprTrace{-ToDo:rm-} )
  70
  71 myWrapperMaybe = panic "CgClosure.myWrapperMaybe (ToDo)"
  72 showTypeCategory = panic "CgClosure.showTypeCategory (ToDo)"
  73 getWrapperArgTypeCategories = panic "CgClosure.getWrapperArgTypeCategories (ToDo)"
  74 \end{code}
  75
  76 %********************************************************
  77 %*                                                      *
  78 \subsection[closures-no-free-vars]{Top-level closures}
  79 %*                                                      *
  80 %********************************************************
  81
  82 For closures bound at top level, allocate in static space.
  83 They should have no free variables.
  84
  85 \begin{code}
  86 cgTopRhsClosure :: Id
  87                 -> CostCentre   -- Optional cost centre annotation
  88                 -> StgBinderInfo
  89                 -> [Id]         -- Args
  90                 -> StgExpr
  91                 -> LambdaFormInfo
  92                 -> FCode (Id, CgIdInfo)
  93
  94 cgTopRhsClosure name cc binder_info args body lf_info
  95   =     -- LAY OUT THE OBJECT
  96     let
  97         closure_info = layOutStaticNoFVClosure name lf_info
  98     in
  99
 100         -- GENERATE THE INFO TABLE (IF NECESSARY)
 101     forkClosureBody (closureCodeBody binder_info closure_info
 102                                          cc args body)
 103                                                         `thenC`
 104
 105         -- BUILD VAP INFO TABLES IF NECESSARY
 106         -- Don't build Vap info tables etc for
 107         -- a function whose result is an unboxed type,
 108         -- because we can never have thunks with such a type.
 109     (if closureReturnsUnboxedType closure_info then
 110         nopC
 111     else
 112         let
 113             bind_the_fun = addBindC name cg_id_info     -- It's global!
 114         in
 115         cgVapInfoTables True {- Top level -} bind_the_fun binder_info name args lf_info
 116     ) `thenC`
 117
 118         -- BUILD THE OBJECT (IF NECESSARY)
 119     (if staticClosureRequired name binder_info lf_info
 120      then
 121         let
 122             cost_centre = mkCCostCentre cc
 123         in
 124         absC (CStaticClosure
 125                 closure_label   -- Labelled with the name on lhs of defn
 126                 closure_info
 127                 cost_centre
 128                 [])             -- No fields
 129      else
 130         nopC
 131     ) `thenC`
 132
 133     returnFC (name, cg_id_info)
 134   where
 135     closure_label = mkClosureLabel name
 136     cg_id_info    = stableAmodeIdInfo name (CLbl closure_label PtrRep) lf_info
 137 \end{code}
 138
 139 %********************************************************
 140 %*                                                      *
 141 \subsection[non-top-level-closures]{Non top-level closures}
 142 %*                                                      *
 143 %********************************************************
 144
 145 For closures with free vars, allocate in heap.
 146
 147 ===================== OLD PROBABLY OUT OF DATE COMMENTS =============
 148
 149 -- Closures which (a) have no fvs and (b) have some args (i.e.
 150 -- combinator functions), are allocated statically, just as if they
 151 -- were top-level closures.  We can't get a space leak that way
 152 -- (because they are HNFs) and it saves allocation.
 153
 154 -- Lexical Scoping: Problem
 155 -- These top level function closures will be inherited, possibly
 156 -- to a different cost centre scope set before entering.
 157
 158 -- Evaluation Scoping: ok as already in HNF
 159
 160 -- Should rely on floating mechanism to achieve this floating to top level.
 161 -- As let floating will avoid floating which breaks cost centre attribution
 162 -- everything will be OK.
 163
 164 -- Disabled: because it breaks lexical-scoped cost centre semantics.
 165 -- cgRhsClosure binder cc bi [] upd_flag args@(_:_) body
 166 --  = cgTopRhsClosure binder cc bi upd_flag args body
 167
 168 ===================== END OF OLD PROBABLY OUT OF DATE COMMENTS =============
 169
 170 \begin{code}
 171 cgRhsClosure    :: Id
 172                 -> CostCentre   -- Optional cost centre annotation
 173                 -> StgBinderInfo
 174                 -> [Id]         -- Free vars
 175                 -> [Id]         -- Args
 176                 -> StgExpr
 177                 -> LambdaFormInfo
 178                 -> FCode (Id, CgIdInfo)
 179
 180 cgRhsClosure binder cc binder_info fvs args body lf_info
 181   | maybeToBool maybe_std_thunk         -- AHA!  A STANDARD-FORM THUNK
 182   -- ToDo: check non-primitiveness (ASSERT)
 183   = (
 184         -- LAY OUT THE OBJECT
 185     getArgAmodes std_thunk_payload              `thenFC` \ amodes ->
 186     let
 187         (closure_info, amodes_w_offsets)
 188           = layOutDynClosure binder getAmodeRep amodes lf_info
 189
 190         (use_cc, blame_cc) = chooseDynCostCentres cc args fvs body
 191     in
 192         -- BUILD THE OBJECT
 193     allocDynClosure closure_info use_cc blame_cc amodes_w_offsets
 194     )
 195                 `thenFC` \ heap_offset ->
 196
 197         -- RETURN
 198     returnFC (binder, heapIdInfo binder heap_offset lf_info)
 199
 200   where
 201     maybe_std_thunk        = getStandardFormThunkInfo lf_info
 202     Just std_thunk_payload = maybe_std_thunk
 203 \end{code}
 204
 205 Here's the general case.
 206 \begin{code}
 207 cgRhsClosure binder cc binder_info fvs args body lf_info
 208   = (
 209         -- LAY OUT THE OBJECT
 210         --
 211         -- If the binder is itself a free variable, then don't store
 212         -- it in the closure.  Instead, just bind it to Node on entry.
 213         -- NB we can be sure that Node will point to it, because we
 214         -- havn't told mkClosureLFInfo about this; so if the binder
 215         -- *was* a free var of its RHS, mkClosureLFInfo thinks it *is*
 216         -- stored in the closure itself, so it will make sure that
 217         -- Node points to it...
 218     let
 219         is_elem        = isIn "cgRhsClosure"
 220
 221         binder_is_a_fv = binder `is_elem` fvs
 222         reduced_fvs    = if binder_is_a_fv
 223                          then fvs `minusList` [binder]
 224                          else fvs
 225     in
 226     mapFCs getCAddrModeAndInfo reduced_fvs      `thenFC` \ amodes_and_info ->
 227     let
 228         fvs_w_amodes_and_info         = reduced_fvs `zip` amodes_and_info
 229
 230         closure_info :: ClosureInfo
 231         bind_details :: [((Id, (CAddrMode, LambdaFormInfo)), VirtualHeapOffset)]
 232
 233         (closure_info, bind_details)
 234           = layOutDynClosure binder get_kind fvs_w_amodes_and_info lf_info
 235
 236         bind_fv ((id, (_, lf_info)), offset) = bindNewToNode id offset lf_info
 237
 238         amodes_w_offsets = [(amode,offset) | ((_, (amode,_)), offset) <- bind_details]
 239
 240         get_kind (id, amode_and_info) = idPrimRep id
 241     in
 242         -- BUILD ITS INFO TABLE AND CODE
 243     forkClosureBody (
 244                 -- Bind the fvs
 245             mapCs bind_fv bind_details `thenC`
 246
 247                 -- Bind the binder itself, if it is a free var
 248             (if binder_is_a_fv then
 249                 bindNewToReg binder node lf_info
 250             else
 251                 nopC)                                   `thenC`
 252
 253                 -- Compile the body
 254             closureCodeBody binder_info closure_info cc args body
 255     )   `thenC`
 256
 257         -- BUILD VAP INFO TABLES IF NECESSARY
 258         -- Don't build Vap info tables etc for
 259         -- a function whose result is an unboxed type,
 260         -- because we can never have thunks with such a type.
 261     (if closureReturnsUnboxedType closure_info then
 262         nopC
 263     else
 264         cgVapInfoTables False {- Not top level -} nopC binder_info binder args lf_info
 265     ) `thenC`
 266
 267         -- BUILD THE OBJECT
 268     let
 269         (use_cc, blame_cc) = chooseDynCostCentres cc args fvs body
 270     in
 271     allocDynClosure closure_info use_cc blame_cc amodes_w_offsets
 272     )           `thenFC` \ heap_offset ->
 273
 274         -- RETURN
 275     returnFC (binder, heapIdInfo binder heap_offset lf_info)
 276 \end{code}
 277
 278 @cgVapInfoTables@ generates both Vap info tables, if they are required
 279 at all.  It calls @cgVapInfoTable@ to generate each Vap info table,
 280 along with its entry code.
 281
 282 \begin{code}
 283 -- Don't generate Vap info tables for thunks; only for functions
 284 cgVapInfoTables top_level perhaps_bind_the_fun binder_info fun [{- no args; a thunk! -}] lf_info
 285   = nopC
 286
 287 cgVapInfoTables top_level perhaps_bind_the_fun binder_info fun args lf_info
 288   =     -- BUILD THE STANDARD VAP-ENTRY STUFF IF NECESSARY
 289     (if stdVapRequired binder_info then
 290         cgVapInfoTable perhaps_bind_the_fun Updatable fun args fun_in_payload lf_info
 291     else
 292         nopC
 293     )           `thenC`
 294
 295                 -- BUILD THE NO-UPDATE VAP-ENTRY STUFF IF NECESSARY
 296     (if noUpdVapRequired binder_info then
 297         cgVapInfoTable perhaps_bind_the_fun SingleEntry fun args fun_in_payload lf_info
 298     else
 299         nopC
 300     )
 301
 302   where
 303     fun_in_payload = not top_level
 304
 305 cgVapInfoTable perhaps_bind_the_fun upd_flag fun args fun_in_payload fun_lf_info
 306   = let
 307         -- The vap_entry_rhs is a manufactured STG expression which
 308         -- looks like the RHS of any binding which is going to use the vap-entry
 309         -- point of the function.  Each of these bindings will look like:
 310         --
 311         --      x = [a,b,c] \upd [] -> f a b c
 312         --
 313         -- If f is not top-level, then f is one of the free variables too,
 314         -- hence "payload_ids" isn't the same as "arg_ids".
 315         --
 316         vap_entry_rhs = StgApp (StgVarArg fun) (map StgVarArg args) emptyIdSet
 317                                                                         -- Empty live vars
 318
 319         arg_ids_w_info = [(name,mkLFArgument) | name <- args]
 320         payload_ids_w_info | fun_in_payload = (fun,fun_lf_info) : arg_ids_w_info
 321                            | otherwise      = arg_ids_w_info
 322
 323         payload_ids | fun_in_payload = fun : args               -- Sigh; needed for mkClosureLFInfo
 324                     | otherwise      = args
 325
 326         vap_lf_info   = mkClosureLFInfo False {-not top level-} payload_ids
 327                                         upd_flag [] vap_entry_rhs
 328                 -- It's not top level, even if we're currently compiling a top-level
 329                 -- function, because any VAP *use* of this function will be for a
 330                 -- local thunk, thus
 331                 --              let x = f p q   -- x isn't top level!
 332                 --              in ...
 333
 334         get_kind (id, info) = idPrimRep id
 335
 336         payload_bind_details :: [((Id, LambdaFormInfo), VirtualHeapOffset)]
 337         (closure_info, payload_bind_details) = layOutDynClosure
 338                                                         fun
 339                                                         get_kind payload_ids_w_info
 340                                                         vap_lf_info
 341                 -- The dodgy thing is that we use the "fun" as the
 342                 -- Id to give to layOutDynClosure.  This Id gets embedded in
 343                 -- the closure_info it returns.  But of course, the function doesn't
 344                 -- have the right type to match the Vap closure.  Never mind,
 345                 -- a hack in closureType spots the special case.  Otherwise that
 346                 -- Id is just used for label construction, which is OK.
 347
 348         bind_fv ((id,lf_info), offset) = bindNewToNode id offset lf_info
 349     in
 350
 351         -- BUILD ITS INFO TABLE AND CODE
 352     forkClosureBody (
 353
 354                 -- Bind the fvs; if the fun is not in the payload, then bind_the_fun tells
 355                 -- how to bind it.  If it is in payload it'll be bound by payload_bind_details.
 356             perhaps_bind_the_fun                `thenC`
 357             mapCs bind_fv payload_bind_details  `thenC`
 358
 359                 -- Generate the info table and code
 360             closureCodeBody NoStgBinderInfo
 361                             closure_info
 362                             useCurrentCostCentre
 363                             []  -- No args; it's a thunk
 364                             vap_entry_rhs
 365     )
 366 \end{code}
 367 %************************************************************************
 368 %*                                                                      *
 369 \subsection[code-for-closures]{The code for closures}
 370 %*                                                                      *
 371 %************************************************************************
 372
 373 \begin{code}
 374 closureCodeBody :: StgBinderInfo
 375                 -> ClosureInfo  -- Lots of information about this closure
 376                 -> CostCentre   -- Optional cost centre attached to closure
 377                 -> [Id]
 378                 -> StgExpr
 379                 -> Code
 380 \end{code}
 381
 382 There are two main cases for the code for closures.  If there are {\em
 383 no arguments}, then the closure is a thunk, and not in normal form.
 384 So it should set up an update frame (if it is shared).  Also, it has
 385 no argument satisfaction check, so fast and slow entry-point labels
 386 are the same.
 387
 388 \begin{code}
 389 closureCodeBody binder_info closure_info cc [] body
 390   = -- thunks cannot have a primitive type!
 391 #ifdef DEBUG
 392     let
 393         (has_tycon, tycon)
 394           = case (closureType closure_info) of
 395               Nothing       -> (False, panic "debug")
 396               Just (tc,_,_) -> (True,  tc)
 397     in
 398     if has_tycon && isPrimTyCon tycon then
 399         pprPanic "closureCodeBody:thunk:prim type!" (ppr PprDebug tycon)
 400     else
 401 #endif
 402     getAbsC body_code   `thenFC` \ body_absC ->
 403     moduleName          `thenFC` \ mod_name ->
 404
 405     absC (CClosureInfoAndCode closure_info body_absC Nothing
 406                               stdUpd (cl_descr mod_name)
 407                               (dataConLiveness closure_info))
 408   where
 409     cl_descr mod_name = closureDescription mod_name (closureId closure_info) [] body
 410
 411     body_addr   = CLbl (entryLabelFromCI closure_info) CodePtrRep
 412     body_code   = profCtrC SLIT("ENT_THK") []                   `thenC`
 413                   thunkWrapper closure_info (
 414                         -- We only enter cc after setting up update so that cc
 415                         -- of enclosing scope will be recorded in update frame
 416                         -- CAF/DICT functions will be subsumed by this enclosing cc
 417                     enterCostCentreCode closure_info cc IsThunk `thenC`
 418                     cgExpr body)
 419
 420     stdUpd      = CLbl mkErrorStdEntryLabel CodePtrRep
 421 \end{code}
 422
 423 If there is {\em at least one argument}, then this closure is in
 424 normal form, so there is no need to set up an update frame.  On the
 425 other hand, we do have to check that there are enough args, and
 426 perform an update if not!
 427
 428 The Macros for GrAnSim are produced at the beginning of the
 429 argSatisfactionCheck (by calling fetchAndReschedule).  There info if
 430 Node points to closure is available. -- HWL
 431
 432 \begin{code}
 433 closureCodeBody binder_info closure_info cc all_args body
 434   = getEntryConvention id lf_info
 435                        (map idPrimRep all_args)         `thenFC` \ entry_conv ->
 436     let
 437         is_concurrent = opt_ForConcurrent
 438
 439         stg_arity = length all_args
 440
 441         -- Arg mapping for standard (slow) entry point; all args on stack
 442         (spA_all_args, spB_all_args, all_bxd_w_offsets, all_ubxd_w_offsets)
 443            = mkVirtStkOffsets
 444                 0 0             -- Initial virtual SpA, SpB
 445                 idPrimRep
 446                 all_args
 447
 448         -- Arg mapping for the fast entry point; as many args as poss in
 449         -- registers; the rest on the stack
 450         --      arg_regs are the registers used for arg passing
 451         --      stk_args are the args which are passed on the stack
 452         --
 453         arg_regs = case entry_conv of
 454                 DirectEntry lbl arity regs -> regs
 455                 ViaNode | is_concurrent    -> []
 456                 other                      -> panic "closureCodeBody:arg_regs"
 457
 458         num_arg_regs = length arg_regs
 459
 460         (reg_args, stk_args) = splitAt num_arg_regs all_args
 461
 462         (spA_stk_args, spB_stk_args, stk_bxd_w_offsets, stk_ubxd_w_offsets)
 463           = mkVirtStkOffsets
 464                 0 0             -- Initial virtual SpA, SpB
 465                 idPrimRep
 466                 stk_args
 467
 468         -- HWL; Note: empty list of live regs in slow entry code
 469         -- Old version (reschedule combined with heap check);
 470         -- see argSatisfactionCheck for new version
 471         --slow_entry_code = forceHeapCheck [node] True slow_entry_code'
 472         --                where node = VanillaReg PtrRep 1
 473         --slow_entry_code = forceHeapCheck [] True slow_entry_code'
 474
 475         slow_entry_code
 476           = profCtrC SLIT("ENT_FUN_STD") []                 `thenC`
 477
 478                 -- Bind args, and record expected position of stk ptrs
 479             mapCs bindNewToAStack all_bxd_w_offsets         `thenC`
 480             mapCs bindNewToBStack all_ubxd_w_offsets        `thenC`
 481             setRealAndVirtualSps spA_all_args spB_all_args  `thenC`
 482
 483             argSatisfactionCheck closure_info all_args      `thenC`
 484
 485             -- OK, so there are enough args.  Now we need to stuff as
 486             -- many of them in registers as the fast-entry code
 487             -- expects Note that the zipWith will give up when it hits
 488             -- the end of arg_regs.
 489
 490             mapFCs getCAddrMode all_args                    `thenFC` \ stk_amodes ->
 491             absC (mkAbstractCs (zipWith assign_to_reg arg_regs stk_amodes)) `thenC`
 492
 493             -- Now adjust real stack pointers
 494             adjustRealSps spA_stk_args spB_stk_args             `thenC`
 495
 496             absC (CFallThrough (CLbl fast_label CodePtrRep))
 497
 498         assign_to_reg reg_id amode = CAssign (CReg reg_id) amode
 499
 500         -- HWL
 501         -- Old version (reschedule combined with heap check);
 502         -- see argSatisfactionCheck for new version
 503         -- fast_entry_code = forceHeapCheck [] True fast_entry_code'
 504
 505         fast_entry_code
 506           = profCtrC SLIT("ENT_FUN_DIRECT") [
 507                     CLbl (mkRednCountsLabel id) PtrRep,
 508                     CString (_PK_ (showId PprDebug id)),
 509                     mkIntCLit stg_arity,        -- total # of args
 510                     mkIntCLit spA_stk_args,     -- # passed on A stk
 511                     mkIntCLit spB_stk_args,     -- B stk (rest in regs)
 512                     CString (_PK_ (map (showTypeCategory . idType) all_args)),
 513                     CString (_PK_ (show_wrapper_name wrapper_maybe)),
 514                     CString (_PK_ (show_wrapper_arg_kinds wrapper_maybe))
 515                 ]                       `thenC`
 516
 517                 -- Bind args to regs/stack as appropriate, and
 518                 -- record expected position of sps
 519             bindArgsToRegs reg_args arg_regs                `thenC`
 520             mapCs bindNewToAStack stk_bxd_w_offsets         `thenC`
 521             mapCs bindNewToBStack stk_ubxd_w_offsets        `thenC`
 522             setRealAndVirtualSps spA_stk_args spB_stk_args  `thenC`
 523
 524                 -- Enter the closures cc, if required
 525             enterCostCentreCode closure_info cc IsFunction  `thenC`
 526
 527                 -- Do the business
 528             funWrapper closure_info arg_regs (cgExpr body)
 529     in
 530         -- Make a labelled code-block for the slow and fast entry code
 531     forkAbsC (if slow_code_needed then slow_entry_code else absC AbsCNop)
 532                                 `thenFC` \ slow_abs_c ->
 533     forkAbsC fast_entry_code    `thenFC` \ fast_abs_c ->
 534     moduleName                  `thenFC` \ mod_name ->
 535
 536         -- Now either construct the info table, or put the fast code in alone
 537         -- (We never have slow code without an info table)
 538     absC (
 539       if info_table_needed then
 540         CClosureInfoAndCode closure_info slow_abs_c (Just fast_abs_c)
 541                         stdUpd (cl_descr mod_name)
 542                         (dataConLiveness closure_info)
 543       else
 544         CCodeBlock fast_label fast_abs_c
 545     )
 546   where
 547     lf_info = closureLFInfo closure_info
 548
 549     cl_descr mod_name = closureDescription mod_name id all_args body
 550
 551         -- Figure out what is needed and what isn't
 552     slow_code_needed   = slowFunEntryCodeRequired id binder_info
 553     info_table_needed  = funInfoTableRequired id binder_info lf_info
 554
 555         -- Manufacture labels
 556     id         = closureId closure_info
 557
 558     fast_label = fastLabelFromCI closure_info
 559
 560     stdUpd = CLbl mkErrorStdEntryLabel CodePtrRep
 561
 562     wrapper_maybe = get_ultimate_wrapper Nothing id
 563       where
 564         get_ultimate_wrapper deflt x -- walk all the way up a "wrapper chain"
 565           = case (myWrapperMaybe x) of
 566               Nothing -> deflt
 567               Just xx -> get_ultimate_wrapper (Just xx) xx
 568
 569     show_wrapper_name Nothing   = ""
 570     show_wrapper_name (Just xx) = showId PprDebug xx
 571
 572     show_wrapper_arg_kinds Nothing   = ""
 573     show_wrapper_arg_kinds (Just xx)
 574       = case (getWrapperArgTypeCategories (idType xx) (getIdStrictness xx)) of
 575           Nothing  -> ""
 576           Just str -> str
 577 \end{code}
 578
 579 For lexically scoped profiling we have to load the cost centre from
 580 the closure entered, if the costs are not supposed to be inherited.
 581 This is done immediately on entering the fast entry point.
 582
 583 Load current cost centre from closure, if not inherited.
 584 Node is guaranteed to point to it, if profiling and not inherited.
 585
 586 \begin{code}
 587 data IsThunk = IsThunk | IsFunction -- Bool-like, local
 588 --#ifdef DEBUG
 589         deriving Eq
 590 --#endif
 591
 592 enterCostCentreCode :: ClosureInfo -> CostCentre -> IsThunk -> Code
 593
 594 enterCostCentreCode closure_info cc is_thunk
 595   = costCentresFlag     `thenFC` \ profiling_on ->
 596     if not profiling_on then
 597         nopC
 598     else
 599         ASSERT(not (noCostCentreAttached cc))
 600
 601         if costsAreSubsumed cc then
 602             --ASSERT(isToplevClosure closure_info)
 603             --ASSERT(is_thunk == IsFunction)
 604             (if isToplevClosure closure_info && is_thunk == IsFunction then \x->x else pprTrace "enterCostCenterCode:" (ppCat [ppr PprDebug (is_thunk == IsFunction){-, ppr PprDebug closure_info-}, ppStr (showCostCentre PprDebug False cc)])) $
 605             costCentresC SLIT("ENTER_CC_FSUB") []
 606
 607         else if currentOrSubsumedCosts cc then
 608             -- i.e. current; subsumed dealt with above
 609             -- get CCC out of the closure, where we put it when we alloc'd
 610             case is_thunk of
 611                 IsThunk    -> costCentresC SLIT("ENTER_CC_TCL") [CReg node]
 612                 IsFunction -> costCentresC SLIT("ENTER_CC_FCL") [CReg node]
 613
 614         else if isCafCC cc && isToplevClosure closure_info then
 615             ASSERT(is_thunk == IsThunk)
 616             costCentresC SLIT("ENTER_CC_CAF") [mkCCostCentre cc]
 617
 618         else -- we've got a "real" cost centre right here in our hands...
 619             case is_thunk of
 620                 IsThunk    -> costCentresC SLIT("ENTER_CC_T") [mkCCostCentre cc]
 621                 IsFunction -> if isCafCC cc || isDictCC cc
 622                               then costCentresC SLIT("ENTER_CC_FCAF") [mkCCostCentre cc]
 623                               else costCentresC SLIT("ENTER_CC_FLOAD") [mkCCostCentre cc]
 624 \end{code}
 625
 626 %************************************************************************
 627 %*                                                                      *
 628 \subsubsection[pre-closure-code-stuff]{Pre-closure-code code}
 629 %*                                                                      *
 630 %************************************************************************
 631
 632 The argument-satisfaction check code is placed after binding
 633 the arguments to their stack locations. Hence, the virtual stack
 634 pointer is pointing after all the args, and virtual offset 1 means
 635 the base of frame and hence most distant arg.  Hence
 636 virtual offset 0 is just beyond the most distant argument; the
 637 relative offset of this word tells how many words of arguments
 638 are expected.
 639
 640 \begin{code}
 641 argSatisfactionCheck :: ClosureInfo -> [Id] -> Code
 642
 643 argSatisfactionCheck closure_info [] = nopC
 644
 645 argSatisfactionCheck closure_info args
 646   = -- safest way to determine which stack last arg will be on:
 647     -- look up CAddrMode that last arg is bound to;
 648     -- getAmodeRep;
 649     -- check isFollowableRep.
 650
 651     nodeMustPointToIt (closureLFInfo closure_info)      `thenFC` \ node_points ->
 652
 653     let
 654        emit_gran_macros = opt_GranMacros
 655     in
 656
 657     -- HWL  ngo' ngoq:
 658     -- absC (CMacroStmt GRAN_FETCH [])                  `thenC`
 659     -- forceHeapCheck [] node_points (absC AbsCNop)                     `thenC`
 660     (if emit_gran_macros
 661       then if node_points
 662              then fetchAndReschedule  [] node_points
 663              else yield [] node_points
 664       else absC AbsCNop)                       `thenC`
 665
 666     getCAddrMode (last args)                            `thenFC` \ last_amode ->
 667
 668     if (isFollowableRep (getAmodeRep last_amode)) then
 669         getSpARelOffset 0       `thenFC` \ (SpARel spA off) ->
 670         let
 671             a_rel_int = spARelToInt spA off
 672             a_rel_arg = mkIntCLit a_rel_int
 673         in
 674         ASSERT(a_rel_int /= 0)
 675         if node_points then
 676             absC (CMacroStmt ARGS_CHK_A [a_rel_arg])
 677         else
 678             absC (CMacroStmt ARGS_CHK_A_LOAD_NODE [a_rel_arg, set_Node_to_this])
 679     else
 680         getSpBRelOffset 0       `thenFC` \ (SpBRel spB off) ->
 681         let
 682             b_rel_int = spBRelToInt spB off
 683             b_rel_arg = mkIntCLit b_rel_int
 684         in
 685         ASSERT(b_rel_int /= 0)
 686         if node_points then
 687             absC (CMacroStmt ARGS_CHK_B [b_rel_arg])
 688         else
 689             absC (CMacroStmt ARGS_CHK_B_LOAD_NODE [b_rel_arg, set_Node_to_this])
 690   where
 691     -- We must tell the arg-satis macro whether Node is pointing to
 692     -- the closure or not.  If it isn't so pointing, then we give to
 693     -- the macro the (static) address of the closure.
 694
 695     set_Node_to_this = CLbl (closureLabelFromCI closure_info) PtrRep
 696 \end{code}
 697
 698 %************************************************************************
 699 %*                                                                      *
 700 \subsubsection[closure-code-wrappers]{Wrappers around closure code}
 701 %*                                                                      *
 702 %************************************************************************
 703
 704 \begin{code}
 705 thunkWrapper:: ClosureInfo -> Code -> Code
 706 thunkWrapper closure_info thunk_code
 707   =     -- Stack and heap overflow checks
 708     nodeMustPointToIt (closureLFInfo closure_info)      `thenFC` \ node_points ->
 709
 710     let
 711        emit_gran_macros = opt_GranMacros
 712     in
 713         -- HWL: insert macros for GrAnSim; 2 versions depending on liveness of node
 714         -- (we prefer fetchAndReschedule-style context switches to yield ones)
 715     (if emit_gran_macros
 716       then if node_points
 717              then fetchAndReschedule  [] node_points
 718              else yield [] node_points
 719       else absC AbsCNop)                       `thenC`
 720
 721     stackCheck closure_info [] node_points (    -- stackCheck *encloses* the rest
 722
 723         -- heapCheck must be after stackCheck: if stchk fails
 724         -- new stack space is allocated from the heap which
 725         -- would violate any previous heapCheck
 726
 727     heapCheck [] node_points (                  -- heapCheck *encloses* the rest
 728         -- The "[]" says there are no live argument registers
 729
 730         -- Overwrite with black hole if necessary
 731     blackHoleIt closure_info                    `thenC`
 732
 733     setupUpdate closure_info (                  -- setupUpdate *encloses* the rest
 734
 735         -- Finally, do the business
 736     thunk_code
 737     )))
 738
 739 funWrapper :: ClosureInfo       -- Closure whose code body this is
 740            -> [MagicId]         -- List of argument registers (if any)
 741            -> Code              -- Body of function being compiled
 742            -> Code
 743 funWrapper closure_info arg_regs fun_body
 744   =     -- Stack overflow check
 745     nodeMustPointToIt (closureLFInfo closure_info)      `thenFC` \ node_points ->
 746     let
 747        emit_gran_macros = opt_GranMacros
 748     in
 749     -- HWL   chu' ngoq:
 750     (if emit_gran_macros
 751       then yield  arg_regs node_points
 752       else absC AbsCNop)                                 `thenC`
 753
 754     stackCheck closure_info arg_regs node_points (
 755         -- stackCheck *encloses* the rest
 756
 757     heapCheck arg_regs node_points (
 758         -- heapCheck *encloses* the rest
 759
 760         -- Finally, do the business
 761     fun_body
 762     ))
 763 \end{code}
 764
 765 %************************************************************************
 766 %*                                                                      *
 767 \subsubsubsection[overflow-checks]{Stack and heap overflow wrappers}
 768 %*                                                                      *
 769 %************************************************************************
 770
 771 Assumption: virtual and real stack pointers are currently exactly aligned.
 772
 773 \begin{code}
 774 stackCheck :: ClosureInfo
 775            -> [MagicId]                 -- Live registers
 776            -> Bool                      -- Node required to point after check?
 777            -> Code
 778            -> Code
 779
 780 stackCheck closure_info regs node_reqd code
 781   = getFinalStackHW (\ aHw -> \ bHw ->  -- Both virtual stack offsets
 782
 783     getVirtSps          `thenFC` \ (vSpA, vSpB) ->
 784
 785     let a_headroom_reqd = aHw - vSpA    -- Virtual offsets are positive integers
 786         b_headroom_reqd = bHw - vSpB
 787     in
 788
 789     absC (if (a_headroom_reqd == 0 && b_headroom_reqd == 0) then
 790                 AbsCNop
 791           else
 792                 CMacroStmt STK_CHK [mkIntCLit liveness_mask,
 793                                     mkIntCLit a_headroom_reqd,
 794                                     mkIntCLit b_headroom_reqd,
 795                                     mkIntCLit vSpA,
 796                                     mkIntCLit vSpB,
 797                                     mkIntCLit (if returns_prim_type then 1 else 0),
 798                                     mkIntCLit (if node_reqd         then 1 else 0)]
 799          )
 800         -- The test is *inside* the absC, to avoid black holes!
 801
 802     `thenC` code
 803     )
 804   where
 805     all_regs = if node_reqd then node:regs else regs
 806     liveness_mask = mkLiveRegsMask all_regs
 807
 808     returns_prim_type = closureReturnsUnboxedType closure_info
 809 \end{code}
 810
 811 %************************************************************************
 812 %*                                                                      *
 813 \subsubsubsection[update-and-BHs]{Update and black-hole wrappers}
 814 %*                                                                      *
 815 %************************************************************************
 816
 817
 818 \begin{code}
 819 blackHoleIt :: ClosureInfo -> Code      -- Only called for thunks
 820 blackHoleIt closure_info
 821   = noBlackHolingFlag   `thenFC` \ no_black_holing ->
 822
 823     if (blackHoleOnEntry no_black_holing closure_info)
 824     then
 825         absC (if closureSingleEntry(closure_info) then
 826                 CMacroStmt UPD_BH_SINGLE_ENTRY [CReg node]
 827               else
 828                 CMacroStmt UPD_BH_UPDATABLE [CReg node])
 829         -- Node always points to it; see stg-details
 830     else
 831         nopC
 832 \end{code}
 833
 834 \begin{code}
 835 setupUpdate :: ClosureInfo -> Code -> Code      -- Only called for thunks
 836         -- Nota Bene: this function does not change Node (even if it's a CAF),
 837         -- so that the cost centre in the original closure can still be
 838         -- extracted by a subsequent ENTER_CC_TCL
 839
 840 setupUpdate closure_info code
 841  = if (closureUpdReqd closure_info) then
 842         link_caf_if_needed      `thenFC` \ update_closure ->
 843         pushUpdateFrame update_closure vector code
 844    else
 845         profCtrC SLIT("UPDF_OMITTED") [] `thenC`
 846         code
 847  where
 848    link_caf_if_needed :: FCode CAddrMode        -- Returns amode for closure to be updated
 849    link_caf_if_needed
 850      = if not (isStaticClosure closure_info) then
 851           returnFC (CReg node)
 852        else
 853
 854           -- First we must allocate a black hole, and link the
 855           -- CAF onto the CAF list
 856
 857                 -- Alloc black hole specifying CC_HDR(Node) as the cost centre
 858                 --   Hack Warning: Using a CLitLit to get CAddrMode !
 859           let
 860               use_cc   = CLitLit SLIT("CC_HDR(R1.p)") PtrRep
 861               blame_cc = use_cc
 862           in
 863           allocDynClosure (blackHoleClosureInfo closure_info) use_cc blame_cc []
 864                                                         `thenFC` \ heap_offset ->
 865           getHpRelOffset heap_offset                    `thenFC` \ hp_rel ->
 866           let  amode = CAddr hp_rel
 867           in
 868           absC (CMacroStmt UPD_CAF [CReg node, amode])
 869                                                         `thenC`
 870           returnFC amode
 871
 872    vector
 873      = case (closureType closure_info) of
 874         Nothing -> CReg StdUpdRetVecReg
 875         Just (spec_tycon, _, spec_datacons) ->
 876             case (ctrlReturnConvAlg spec_tycon) of
 877               UnvectoredReturn 1 ->
 878                 let
 879                     spec_data_con = head spec_datacons
 880                     only_tag = dataConTag spec_data_con
 881
 882                     direct = case (dataReturnConvAlg spec_data_con) of
 883                         ReturnInRegs _ -> mkConUpdCodePtrVecLabel spec_tycon only_tag
 884                         ReturnInHeap   -> mkStdUpdCodePtrVecLabel spec_tycon only_tag
 885
 886                     vectored = mkStdUpdVecTblLabel spec_tycon
 887                 in
 888                     CUnVecLbl direct vectored
 889
 890               UnvectoredReturn _ -> CReg StdUpdRetVecReg
 891               VectoredReturn _   -> CLbl (mkStdUpdVecTblLabel spec_tycon) DataPtrRep
 892 \end{code}
 893
 894 %************************************************************************
 895 %*                                                                      *
 896 \subsection[CgClosure-Description]{Profiling Closure Description.}
 897 %*                                                                      *
 898 %************************************************************************
 899
 900 For "global" data constructors the description is simply occurrence
 901 name of the data constructor itself (see \ref{CgConTbls-info-tables}).
 902
 903 Otherwise it is determind by @closureDescription@ from the let
 904 binding information.
 905
 906 \begin{code}
 907 closureDescription :: FAST_STRING       -- Module
 908                    -> Id                -- Id of closure binding
 909                    -> [Id]              -- Args
 910                    -> StgExpr   -- Body
 911                    -> String
 912
 913         -- Not called for StgRhsCon which have global info tables built in
 914         -- CgConTbls.lhs with a description generated from the data constructor
 915
 916 closureDescription mod_name name args body
 917   = uppShow 0 (prettyToUn (
 918         ppBesides [ppChar '<',
 919                    ppPStr mod_name,
 920                    ppChar '.',
 921                    ppr PprDebug name,
 922                    ppChar '>']))
 923 \end{code}
 924
 925 \begin{code}
 926 chooseDynCostCentres cc args fvs body
 927   = let
 928         use_cc -- cost-centre we record in the object
 929           = if currentOrSubsumedCosts cc
 930             then CReg CurCostCentre
 931             else mkCCostCentre cc
 932
 933         blame_cc -- cost-centre on whom we blame the allocation
 934           = case (args, fvs, body) of
 935               ([], [just1], StgApp (StgVarArg fun) [{-no args-}] _)
 936                 | just1 == fun
 937                 -> mkCCostCentre overheadCostCentre
 938               _ -> use_cc
 939
 940             -- if it's an utterly trivial RHS, then it must be
 941             -- one introduced by boxHigherOrderArgs for profiling,
 942             -- so we charge it to "OVERHEAD".
 943     in
 944     (use_cc, blame_cc)
 945 \end{code}