ghc/compiler/codeGen/CgClosure.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1995
   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, cgSccExpr )
  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
  28                         )
  29 import CgCompInfo       ( spARelToInt, spBRelToInt )
  30 import CgUpdate         ( pushUpdateFrame )
  31 import CgHeapery        ( allocDynClosure, heapCheck
  32                           , heapCheckOnly, fetchAndReschedule, yield  -- HWL
  33                         )
  34 import CgRetConv        ( mkLiveRegsMask,
  35                           ctrlReturnConvAlg, dataReturnConvAlg,
  36                           CtrlReturnConvention(..), DataReturnConvention(..)
  37                         )
  38 import CgStackery       ( getFinalStackHW, mkVirtStkOffsets,
  39                           adjustRealSps
  40                         )
  41 import CgUsages         ( getVirtSps, setRealAndVirtualSps,
  42                           getSpARelOffset, getSpBRelOffset,
  43                           getHpRelOffset
  44                         )
  45 import CLabel           ( mkClosureLabel, mkConUpdCodePtrVecLabel,
  46                           mkStdUpdCodePtrVecLabel, mkStdUpdVecTblLabel,
  47                           mkErrorStdEntryLabel, mkRednCountsLabel
  48                         )
  49 import ClosureInfo      -- lots and lots of stuff
  50 import CmdLineOpts      ( opt_ForConcurrent, opt_GranMacros )
  51 import CostCentre       ( useCurrentCostCentre, currentOrSubsumedCosts,
  52                           noCostCentreAttached, costsAreSubsumed,
  53                           isCafCC, overheadCostCentre
  54                         )
  55 import HeapOffs         ( VirtualHeapOffset(..) )
  56 import Id               ( idType, idPrimRep,
  57                           showId, getIdStrictness, dataConTag,
  58                           emptyIdSet,
  59                           GenId{-instance Outputable-}
  60                         )
  61 import ListSetOps       ( minusList )
  62 import Maybes           ( maybeToBool )
  63 import PprStyle         ( PprStyle(..) )
  64 import PprType          ( GenType{-instance Outputable-}, TyCon{-ditto-} )
  65 import Pretty           ( prettyToUn, ppBesides, ppChar, ppPStr )
  66 import PrimRep          ( isFollowableRep, PrimRep(..) )
  67 import TyCon            ( isPrimTyCon, tyConDataCons )
  68 import Unpretty         ( uppShow )
  69 import Util             ( isIn, panic, pprPanic, assertPanic )
  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                   enterCostCentreCode closure_info cc IsThunk   `thenC`
 414                   thunkWrapper closure_info (cgSccExpr body)
 415
 416     stdUpd      = CLbl mkErrorStdEntryLabel CodePtrRep
 417 \end{code}
 418
 419 If there is {\em at least one argument}, then this closure is in
 420 normal form, so there is no need to set up an update frame.  On the
 421 other hand, we do have to check that there are enough args, and
 422 perform an update if not!
 423
 424 The Macros for GrAnSim are produced at the beginning of the
 425 argSatisfactionCheck (by calling fetchAndReschedule).  There info if
 426 Node points to closure is available. -- HWL
 427
 428 \begin{code}
 429 closureCodeBody binder_info closure_info cc all_args body
 430   = getEntryConvention id lf_info
 431                        (map idPrimRep all_args)         `thenFC` \ entry_conv ->
 432     let
 433         is_concurrent = opt_ForConcurrent
 434
 435         stg_arity = length all_args
 436
 437         -- Arg mapping for standard (slow) entry point; all args on stack
 438         (spA_all_args, spB_all_args, all_bxd_w_offsets, all_ubxd_w_offsets)
 439            = mkVirtStkOffsets
 440                 0 0             -- Initial virtual SpA, SpB
 441                 idPrimRep
 442                 all_args
 443
 444         -- Arg mapping for the fast entry point; as many args as poss in
 445         -- registers; the rest on the stack
 446         --      arg_regs are the registers used for arg passing
 447         --      stk_args are the args which are passed on the stack
 448         --
 449         arg_regs = case entry_conv of
 450                 DirectEntry lbl arity regs -> regs
 451                 ViaNode | is_concurrent    -> []
 452                 other                      -> panic "closureCodeBody:arg_regs"
 453
 454         num_arg_regs = length arg_regs
 455
 456         (reg_args, stk_args) = splitAt num_arg_regs all_args
 457
 458         (spA_stk_args, spB_stk_args, stk_bxd_w_offsets, stk_ubxd_w_offsets)
 459           = mkVirtStkOffsets
 460                 0 0             -- Initial virtual SpA, SpB
 461                 idPrimRep
 462                 stk_args
 463
 464         -- HWL; Note: empty list of live regs in slow entry code
 465         -- Old version (reschedule combined with heap check);
 466         -- see argSatisfactionCheck for new version
 467         --slow_entry_code = forceHeapCheck [node] True slow_entry_code'
 468         --                where node = VanillaReg PtrRep 1
 469         --slow_entry_code = forceHeapCheck [] True slow_entry_code'
 470
 471         slow_entry_code
 472           = profCtrC SLIT("ENT_FUN_STD") []                 `thenC`
 473
 474                 -- Bind args, and record expected position of stk ptrs
 475             mapCs bindNewToAStack all_bxd_w_offsets         `thenC`
 476             mapCs bindNewToBStack all_ubxd_w_offsets        `thenC`
 477             setRealAndVirtualSps spA_all_args spB_all_args  `thenC`
 478
 479             argSatisfactionCheck closure_info all_args      `thenC`
 480
 481             -- OK, so there are enough args.  Now we need to stuff as
 482             -- many of them in registers as the fast-entry code
 483             -- expects Note that the zipWith will give up when it hits
 484             -- the end of arg_regs.
 485
 486             mapFCs getCAddrMode all_args                    `thenFC` \ stk_amodes ->
 487             absC (mkAbstractCs (zipWith assign_to_reg arg_regs stk_amodes)) `thenC`
 488
 489             -- Now adjust real stack pointers
 490             adjustRealSps spA_stk_args spB_stk_args             `thenC`
 491
 492             absC (CFallThrough (CLbl fast_label CodePtrRep))
 493
 494         assign_to_reg reg_id amode = CAssign (CReg reg_id) amode
 495
 496         -- HWL
 497         -- Old version (reschedule combined with heap check);
 498         -- see argSatisfactionCheck for new version
 499         -- fast_entry_code = forceHeapCheck [] True fast_entry_code'
 500
 501         fast_entry_code
 502           = profCtrC SLIT("ENT_FUN_DIRECT") [
 503                     CLbl (mkRednCountsLabel id) PtrRep,
 504                     CString (_PK_ (showId PprDebug id)),
 505                     mkIntCLit stg_arity,        -- total # of args
 506                     mkIntCLit spA_stk_args,     -- # passed on A stk
 507                     mkIntCLit spB_stk_args,     -- B stk (rest in regs)
 508                     CString (_PK_ (map (showTypeCategory . idType) all_args)),
 509                     CString (_PK_ (show_wrapper_name wrapper_maybe)),
 510                     CString (_PK_ (show_wrapper_arg_kinds wrapper_maybe))
 511                 ]                       `thenC`
 512
 513                 -- Bind args to regs/stack as appropriate, and
 514                 -- record expected position of sps
 515             bindArgsToRegs reg_args arg_regs                `thenC`
 516             mapCs bindNewToAStack stk_bxd_w_offsets         `thenC`
 517             mapCs bindNewToBStack stk_ubxd_w_offsets        `thenC`
 518             setRealAndVirtualSps spA_stk_args spB_stk_args  `thenC`
 519
 520                 -- Enter the closures cc, if required
 521             enterCostCentreCode closure_info cc IsFunction  `thenC`
 522
 523                 -- Do the business
 524             funWrapper closure_info arg_regs (cgExpr body)
 525     in
 526         -- Make a labelled code-block for the slow and fast entry code
 527     forkAbsC (if slow_code_needed then slow_entry_code else absC AbsCNop)
 528                                 `thenFC` \ slow_abs_c ->
 529     forkAbsC fast_entry_code    `thenFC` \ fast_abs_c ->
 530     moduleName                  `thenFC` \ mod_name ->
 531
 532         -- Now either construct the info table, or put the fast code in alone
 533         -- (We never have slow code without an info table)
 534     absC (
 535       if info_table_needed then
 536         CClosureInfoAndCode closure_info slow_abs_c (Just fast_abs_c)
 537                         stdUpd (cl_descr mod_name)
 538                         (dataConLiveness closure_info)
 539       else
 540         CCodeBlock fast_label fast_abs_c
 541     )
 542   where
 543     lf_info = closureLFInfo closure_info
 544
 545     cl_descr mod_name = closureDescription mod_name id all_args body
 546
 547         -- Figure out what is needed and what isn't
 548     slow_code_needed   = slowFunEntryCodeRequired id binder_info
 549     info_table_needed  = funInfoTableRequired id binder_info lf_info
 550
 551         -- Manufacture labels
 552     id         = closureId closure_info
 553
 554     fast_label = fastLabelFromCI closure_info
 555
 556     stdUpd = CLbl mkErrorStdEntryLabel CodePtrRep
 557
 558     wrapper_maybe = get_ultimate_wrapper Nothing id
 559       where
 560         get_ultimate_wrapper deflt x -- walk all the way up a "wrapper chain"
 561           = case (myWrapperMaybe x) of
 562               Nothing -> deflt
 563               Just xx -> get_ultimate_wrapper (Just xx) xx
 564
 565     show_wrapper_name Nothing   = ""
 566     show_wrapper_name (Just xx) = showId PprDebug xx
 567
 568     show_wrapper_arg_kinds Nothing   = ""
 569     show_wrapper_arg_kinds (Just xx)
 570       = case (getWrapperArgTypeCategories (idType xx) (getIdStrictness xx)) of
 571           Nothing  -> ""
 572           Just str -> str
 573 \end{code}
 574
 575 For lexically scoped profiling we have to load the cost centre from
 576 the closure entered, if the costs are not supposed to be inherited.
 577 This is done immediately on entering the fast entry point.
 578
 579 Load current cost centre from closure, if not inherited.
 580 Node is guaranteed to point to it, if profiling and not inherited.
 581
 582 \begin{code}
 583 data IsThunk = IsThunk | IsFunction -- Bool-like, local
 584
 585 enterCostCentreCode :: ClosureInfo -> CostCentre -> IsThunk -> Code
 586
 587 enterCostCentreCode closure_info cc is_thunk
 588   = costCentresFlag     `thenFC` \ profiling_on ->
 589     if not profiling_on then
 590         nopC
 591     else -- down to business
 592         ASSERT(not (noCostCentreAttached cc))
 593
 594         if costsAreSubsumed cc then
 595             nopC
 596
 597         else if is_current_CC cc then -- fish the CC out of the closure,
 598                                       -- where we put it when we alloc'd;
 599                                       -- NB: chk defn of "is_current_CC"
 600                                       -- if you go to change this! (WDP 94/12)
 601             costCentresC
 602                 (case is_thunk of
 603                    IsThunk    -> SLIT("ENTER_CC_TCL")
 604                    IsFunction -> SLIT("ENTER_CC_FCL"))
 605                 [CReg node]
 606
 607         else if isCafCC cc then
 608             costCentresC
 609                 SLIT("ENTER_CC_CAF")
 610                 [mkCCostCentre cc]
 611
 612         else -- we've got a "real" cost centre right here in our hands...
 613             costCentresC
 614                 (case is_thunk of
 615                    IsThunk    -> SLIT("ENTER_CC_T")
 616                    IsFunction -> SLIT("ENTER_CC_F"))
 617                 [mkCCostCentre cc]
 618   where
 619     is_current_CC cc
 620       = currentOrSubsumedCosts cc
 621         -- but we've already ruled out "subsumed", so it must be "current"!
 622 \end{code}
 623
 624 %************************************************************************
 625 %*                                                                      *
 626 \subsubsection[pre-closure-code-stuff]{Pre-closure-code code}
 627 %*                                                                      *
 628 %************************************************************************
 629
 630 The argument-satisfaction check code is placed after binding
 631 the arguments to their stack locations. Hence, the virtual stack
 632 pointer is pointing after all the args, and virtual offset 1 means
 633 the base of frame and hence most distant arg.  Hence
 634 virtual offset 0 is just beyond the most distant argument; the
 635 relative offset of this word tells how many words of arguments
 636 are expected.
 637
 638 \begin{code}
 639 argSatisfactionCheck :: ClosureInfo -> [Id] -> Code
 640
 641 argSatisfactionCheck closure_info [] = nopC
 642
 643 argSatisfactionCheck closure_info args
 644   = -- safest way to determine which stack last arg will be on:
 645     -- look up CAddrMode that last arg is bound to;
 646     -- getAmodeRep;
 647     -- check isFollowableRep.
 648
 649     nodeMustPointToIt (closureLFInfo closure_info)      `thenFC` \ node_points ->
 650
 651     let
 652        emit_gran_macros = opt_GranMacros
 653     in
 654
 655     -- HWL  ngo' ngoq:
 656     -- absC (CMacroStmt GRAN_FETCH [])                  `thenC`
 657     -- forceHeapCheck [] node_points (absC AbsCNop)                     `thenC`
 658     (if emit_gran_macros
 659       then if node_points
 660              then fetchAndReschedule  [] node_points
 661              else yield [] node_points
 662       else absC AbsCNop)                       `thenC`
 663
 664     getCAddrMode (last args)                            `thenFC` \ last_amode ->
 665
 666     if (isFollowableRep (getAmodeRep last_amode)) then
 667         getSpARelOffset 0       `thenFC` \ (SpARel spA off) ->
 668         let
 669             a_rel_int = spARelToInt spA off
 670             a_rel_arg = mkIntCLit a_rel_int
 671         in
 672         ASSERT(a_rel_int /= 0)
 673         if node_points then
 674             absC (CMacroStmt ARGS_CHK_A [a_rel_arg])
 675         else
 676             absC (CMacroStmt ARGS_CHK_A_LOAD_NODE [a_rel_arg, set_Node_to_this])
 677     else
 678         getSpBRelOffset 0       `thenFC` \ (SpBRel spB off) ->
 679         let
 680             b_rel_int = spBRelToInt spB off
 681             b_rel_arg = mkIntCLit b_rel_int
 682         in
 683         ASSERT(b_rel_int /= 0)
 684         if node_points then
 685             absC (CMacroStmt ARGS_CHK_B [b_rel_arg])
 686         else
 687             absC (CMacroStmt ARGS_CHK_B_LOAD_NODE [b_rel_arg, set_Node_to_this])
 688   where
 689     -- We must tell the arg-satis macro whether Node is pointing to
 690     -- the closure or not.  If it isn't so pointing, then we give to
 691     -- the macro the (static) address of the closure.
 692
 693     set_Node_to_this = CLbl (closureLabelFromCI closure_info) PtrRep
 694 \end{code}
 695
 696 %************************************************************************
 697 %*                                                                      *
 698 \subsubsection[closure-code-wrappers]{Wrappers around closure code}
 699 %*                                                                      *
 700 %************************************************************************
 701
 702 \begin{code}
 703 thunkWrapper:: ClosureInfo -> Code -> Code
 704 thunkWrapper closure_info thunk_code
 705   =     -- Stack and heap overflow checks
 706     nodeMustPointToIt (closureLFInfo closure_info)      `thenFC` \ node_points ->
 707
 708     let
 709        emit_gran_macros = opt_GranMacros
 710     in
 711     -- HWL: insert macros for GrAnSim; 2 versions depending on liveness of node
 712     -- (we prefer fetchAndReschedule-style context switches to yield ones)
 713     (if emit_gran_macros
 714       then if node_points
 715              then fetchAndReschedule  [] node_points
 716              else yield [] node_points
 717       else absC AbsCNop)                       `thenC`
 718
 719     stackCheck closure_info [] node_points (    -- stackCheck *encloses* the rest
 720
 721     -- Must be after stackCheck: if stchk fails new stack
 722     -- space has to be allocated from the heap
 723
 724     heapCheck [] node_points (
 725                                         -- heapCheck *encloses* the rest
 726         -- The "[]" says there are no live argument registers
 727
 728         -- Overwrite with black hole if necessary
 729     blackHoleIt closure_info                            `thenC`
 730
 731         -- Push update frame if necessary
 732     setupUpdate closure_info (          -- setupUpdate *encloses* the rest
 733         thunk_code
 734     )))
 735
 736 funWrapper :: ClosureInfo       -- Closure whose code body this is
 737            -> [MagicId]         -- List of argument registers (if any)
 738            -> Code              -- Body of function being compiled
 739            -> Code
 740 funWrapper closure_info arg_regs fun_body
 741   =     -- Stack overflow check
 742     nodeMustPointToIt (closureLFInfo closure_info)      `thenFC` \ node_points ->
 743     let
 744        emit_gran_macros = opt_GranMacros
 745     in
 746     -- HWL   chu' ngoq:
 747     (if emit_gran_macros
 748       then yield  arg_regs node_points
 749       else absC AbsCNop)                                 `thenC`
 750
 751     stackCheck closure_info arg_regs node_points (      -- stackCheck *encloses* the rest
 752
 753         -- Heap overflow check
 754     heapCheck arg_regs node_points (
 755                                         -- heapCheck *encloses* the rest
 756
 757         -- Finally, do the business
 758     fun_body
 759     ))
 760 \end{code}
 761
 762 %************************************************************************
 763 %*                                                                      *
 764 \subsubsubsection[overflow-checks]{Stack and heap overflow wrappers}
 765 %*                                                                      *
 766 %************************************************************************
 767
 768 Assumption: virtual and real stack pointers are currently exactly aligned.
 769
 770 \begin{code}
 771 stackCheck :: ClosureInfo
 772            -> [MagicId]                 -- Live registers
 773            -> Bool                      -- Node required to point after check?
 774            -> Code
 775            -> Code
 776
 777 stackCheck closure_info regs node_reqd code
 778   = getFinalStackHW (\ aHw -> \ bHw ->  -- Both virtual stack offsets
 779
 780     getVirtSps          `thenFC` \ (vSpA, vSpB) ->
 781
 782     let a_headroom_reqd = aHw - vSpA    -- Virtual offsets are positive integers
 783         b_headroom_reqd = bHw - vSpB
 784     in
 785
 786     absC (if (a_headroom_reqd == 0 && b_headroom_reqd == 0) then
 787                 AbsCNop
 788           else
 789                 CMacroStmt STK_CHK [mkIntCLit liveness_mask,
 790                                     mkIntCLit a_headroom_reqd,
 791                                     mkIntCLit b_headroom_reqd,
 792                                     mkIntCLit vSpA,
 793                                     mkIntCLit vSpB,
 794                                     mkIntCLit (if returns_prim_type then 1 else 0),
 795                                     mkIntCLit (if node_reqd         then 1 else 0)]
 796          )
 797         -- The test is *inside* the absC, to avoid black holes!
 798
 799     `thenC` code
 800     )
 801   where
 802     all_regs = if node_reqd then node:regs else regs
 803     liveness_mask = mkLiveRegsMask all_regs
 804
 805     returns_prim_type = closureReturnsUnboxedType closure_info
 806 \end{code}
 807
 808 %************************************************************************
 809 %*                                                                      *
 810 \subsubsubsection[update-and-BHs]{Update and black-hole wrappers}
 811 %*                                                                      *
 812 %************************************************************************
 813
 814
 815 \begin{code}
 816 blackHoleIt :: ClosureInfo -> Code      -- Only called for thunks
 817 blackHoleIt closure_info
 818   = noBlackHolingFlag   `thenFC` \ no_black_holing ->
 819
 820     if (blackHoleOnEntry no_black_holing closure_info)
 821     then
 822         absC (if closureSingleEntry(closure_info) then
 823                 CMacroStmt UPD_BH_SINGLE_ENTRY [CReg node]
 824               else
 825                 CMacroStmt UPD_BH_UPDATABLE [CReg node])
 826         -- Node always points to it; see stg-details
 827     else
 828         nopC
 829 \end{code}
 830
 831 \begin{code}
 832 setupUpdate :: ClosureInfo -> Code -> Code      -- Only called for thunks
 833         -- Nota Bene: this function does not change Node (even if it's a CAF),
 834         -- so that the cost centre in the original closure can still be
 835         -- extracted by a subsequent ENTER_CC_TCL
 836
 837 setupUpdate closure_info code
 838  = if (closureUpdReqd closure_info) then
 839         link_caf_if_needed      `thenFC` \ update_closure ->
 840         pushUpdateFrame update_closure vector code
 841    else
 842         profCtrC SLIT("UPDF_OMITTED") [] `thenC`
 843         code
 844  where
 845    link_caf_if_needed :: FCode CAddrMode        -- Returns amode for closure to be updated
 846    link_caf_if_needed
 847      = if not (isStaticClosure closure_info) then
 848           returnFC (CReg node)
 849        else
 850
 851           -- First we must allocate a black hole, and link the
 852           -- CAF onto the CAF list
 853
 854                 -- Alloc black hole specifying CC_HDR(Node) as the cost centre
 855                 --   Hack Warning: Using a CLitLit to get CAddrMode !
 856           let
 857               use_cc   = CLitLit SLIT("CC_HDR(R1.p)") PtrRep
 858               blame_cc = use_cc
 859           in
 860           allocDynClosure (blackHoleClosureInfo closure_info) use_cc blame_cc []
 861                                                         `thenFC` \ heap_offset ->
 862           getHpRelOffset heap_offset                    `thenFC` \ hp_rel ->
 863           let  amode = CAddr hp_rel
 864           in
 865           absC (CMacroStmt UPD_CAF [CReg node, amode])
 866                                                         `thenC`
 867           returnFC amode
 868
 869    vector
 870      = case (closureType closure_info) of
 871         Nothing -> CReg StdUpdRetVecReg
 872         Just (spec_tycon, _, spec_datacons) ->
 873             case (ctrlReturnConvAlg spec_tycon) of
 874               UnvectoredReturn 1 ->
 875                 let
 876                     spec_data_con = head spec_datacons
 877                     only_tag = dataConTag spec_data_con
 878
 879                     direct = case (dataReturnConvAlg spec_data_con) of
 880                         ReturnInRegs _ -> mkConUpdCodePtrVecLabel spec_tycon only_tag
 881                         ReturnInHeap   -> mkStdUpdCodePtrVecLabel spec_tycon only_tag
 882
 883                     vectored = mkStdUpdVecTblLabel spec_tycon
 884                 in
 885                     CUnVecLbl direct vectored
 886
 887               UnvectoredReturn _ -> CReg StdUpdRetVecReg
 888               VectoredReturn _   -> CLbl (mkStdUpdVecTblLabel spec_tycon) DataPtrRep
 889 \end{code}
 890
 891 %************************************************************************
 892 %*                                                                      *
 893 \subsection[CgClosure-Description]{Profiling Closure Description.}
 894 %*                                                                      *
 895 %************************************************************************
 896
 897 For "global" data constructors the description is simply occurrence
 898 name of the data constructor itself (see \ref{CgConTbls-info-tables}).
 899
 900 Otherwise it is determind by @closureDescription@ from the let
 901 binding information.
 902
 903 \begin{code}
 904 closureDescription :: FAST_STRING       -- Module
 905                    -> Id                -- Id of closure binding
 906                    -> [Id]              -- Args
 907                    -> StgExpr   -- Body
 908                    -> String
 909
 910         -- Not called for StgRhsCon which have global info tables built in
 911         -- CgConTbls.lhs with a description generated from the data constructor
 912
 913 closureDescription mod_name name args body
 914   = uppShow 0 (prettyToUn (
 915         ppBesides [ppChar '<',
 916                    ppPStr mod_name,
 917                    ppChar '.',
 918                    ppr PprDebug name,
 919                    ppChar '>']))
 920 \end{code}
 921
 922 \begin{code}
 923 chooseDynCostCentres cc args fvs body
 924   = let
 925         use_cc -- cost-centre we record in the object
 926           = if currentOrSubsumedCosts cc
 927             then CReg CurCostCentre
 928             else mkCCostCentre cc
 929
 930         blame_cc -- cost-centre on whom we blame the allocation
 931           = case (args, fvs, body) of
 932               ([], [just1], StgApp (StgVarArg fun) [{-no args-}] _)
 933                 | just1 == fun
 934                 -> mkCCostCentre overheadCostCentre
 935               _ -> use_cc
 936             -- if it's an utterly trivial RHS, then it must be
 937             -- one introduced by boxHigherOrderArgs for profiling,
 938             -- so we charge it to "OVERHEAD".
 939     in
 940     (use_cc, blame_cc)
 941 \end{code}