[project @ 1999-06-24 13:04:13 by simonmar]
[ghc-hetmet.git] / ghc / compiler / codeGen / CgClosure.lhs
index fbd57ad..e04a4c2 100644 (file)
@@ -1,7 +1,7 @@
 %
 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
 %
-% $Id: CgClosure.lhs,v 1.25 1999/03/11 11:32:25 simonm Exp $
+% $Id: CgClosure.lhs,v 1.33 1999/06/24 13:04:17 simonmar Exp $
 %
 \section[CgClosure]{Code generation for closures}
 
@@ -22,7 +22,6 @@ import {-# SOURCE #-} CgExpr ( cgExpr )
 import CgMonad
 import AbsCSyn
 import StgSyn
-import BasicTypes      ( TopLevelFlag(..) )
 
 import AbsCUtils       ( mkAbstractCs, getAmodeRep )
 import CgBindery       ( getCAddrMode, getArgAmodes,
@@ -36,15 +35,15 @@ import CgHeapery    ( allocDynClosure,
                          fetchAndReschedule, yield,  -- HWL
                          fastEntryChecks, thunkChecks
                        )
-import CgStackery      ( adjustRealSp, mkTaggedVirtStkOffsets, freeStackSlots )
-import CgUsages                ( setRealAndVirtualSp, getVirtSp,
+import CgStackery      ( mkTaggedVirtStkOffsets, freeStackSlots )
+import CgUsages                ( adjustSpAndHp, setRealAndVirtualSp, getVirtSp,
                          getSpRelOffset, getHpRelOffset
                        )
 import CLabel          ( CLabel, mkClosureLabel, mkFastEntryLabel,
-                         mkRednCountsLabel, mkStdEntryLabel
+                         mkRednCountsLabel, mkInfoTableLabel
                        )
 import ClosureInfo     -- lots and lots of stuff
-import CmdLineOpts     ( opt_GranMacros, opt_SccProfilingOn )
+import CmdLineOpts     ( opt_GranMacros, opt_SccProfilingOn, opt_DoTickyProfiling )
 import CostCentre      
 import Id              ( Id, idName, idType, idPrimRep )
 import Name            ( Name )
@@ -56,6 +55,9 @@ import Util           ( isIn )
 import CmdLineOpts     ( opt_SccProfilingOn )
 import Outputable
 
+import Name             ( nameOccName )
+import OccName          ( occNameFS )
+
 getWrapperArgTypeCategories = panic "CgClosure.getWrapperArgTypeCategories (ToDo)"
 \end{code}
 
@@ -267,12 +269,14 @@ closureCodeBody binder_info closure_info cc [] body
     cl_descr mod_name = closureDescription mod_name (closureName closure_info)
 
     body_label   = entryLabelFromCI closure_info
+    is_box  = case body of { StgApp fun [] -> True; _ -> False }
+
     body_code   = profCtrC SLIT("TICK_ENT_THK") []             `thenC`
                  thunkWrapper closure_info body_label (
                        -- We only enter cc after setting up update so that cc
                        -- of enclosing scope will be recorded in update frame
                        -- CAF/DICT functions will be subsumed by this enclosing cc
-                   enterCostCentreCode closure_info cc IsThunk `thenC`
+                   enterCostCentreCode closure_info cc IsThunk is_box `thenC`
                    cgExpr body)
 \end{code}
 
@@ -353,8 +357,9 @@ closureCodeBody binder_info closure_info cc all_args body
            absC (mkAbstractCs (zipWith assign_to_reg arg_regs stk_amodes)) 
                                                            `thenC`
 
-           -- Now adjust real stack pointers
-           adjustRealSp sp_stk_args                    `thenC`
+           -- Now adjust real stack pointers (no need to adjust Hp,
+           -- but call this function for convenience).
+           adjustSpAndHp sp_stk_args                   `thenC`
 
            absC (CFallThrough (CLbl fast_label CodePtrRep))
 
@@ -367,21 +372,17 @@ closureCodeBody binder_info closure_info cc all_args body
 
        fast_entry_code
          = profCtrC SLIT("TICK_ENT_FUN_DIRECT") [
-                   mkIntCLit stg_arity         -- total # of args
-
-               {-  CLbl (mkRednCountsLabel name) PtrRep,
-                   CString (_PK_ (showSDoc (ppr name))),
+                   CLbl (mkRednCountsLabel name) PtrRep,
+                   mkCString (_PK_ (showSDoc (ppr name))),
                    mkIntCLit stg_arity,        -- total # of args
                    mkIntCLit sp_stk_args,      -- # passed on stk
-                   CString (_PK_ (map (showTypeCategory . idType) all_args)),
-                   CString SLIT(""), CString SLIT("")
-               -}
+                   mkCString (_PK_ (map (showTypeCategory . idType) all_args))
+               ]                       `thenC`
 
 -- Nuked for now; see comment at end of file
 --                 CString (_PK_ (show_wrapper_name wrapper_maybe)),
 --                 CString (_PK_ (show_wrapper_arg_kinds wrapper_maybe))
 
-               ]                       `thenC`
 
                -- Bind args to regs/stack as appropriate, and
                -- record expected position of sps.
@@ -393,10 +394,10 @@ closureCodeBody binder_info closure_info cc all_args body
            freeStackSlots (map fst stk_tags)               `thenC`
 
                -- Enter the closures cc, if required
-           enterCostCentreCode closure_info cc IsFunction  `thenC`
+           enterCostCentreCode closure_info cc IsFunction False `thenC`
 
                -- Do the business
-           funWrapper closure_info arg_regs stk_tags slow_label (cgExpr body)
+           funWrapper closure_info arg_regs stk_tags info_label (cgExpr body)
     in
        -- Make a labelled code-block for the slow and fast entry code
     forkAbsC (if slow_code_needed then slow_entry_code else absC AbsCNop)
@@ -424,7 +425,7 @@ closureCodeBody binder_info closure_info cc all_args body
        -- Manufacture labels
     name       = closureName closure_info
     fast_label = mkFastEntryLabel name stg_arity
-    slow_label = mkStdEntryLabel name
+    info_label = mkInfoTableLabel name
 \end{code}
 
 For lexically scoped profiling we have to load the cost centre from
@@ -440,40 +441,41 @@ data IsThunk = IsThunk | IsFunction -- Bool-like, local
        deriving Eq
 -- #endif
 
-enterCostCentreCode :: ClosureInfo -> CostCentreStack -> IsThunk -> Code
+enterCostCentreCode 
+   :: ClosureInfo -> CostCentreStack
+   -> IsThunk
+   -> Bool     -- is_box: this closure is a special box introduced by SCCfinal
+   -> Code
 
-enterCostCentreCode closure_info ccs is_thunk
+enterCostCentreCode closure_info ccs is_thunk is_box
   = if not opt_SccProfilingOn then
        nopC
     else
        ASSERT(not (noCCSAttached ccs))
 
        if isSubsumedCCS ccs then
-           --ASSERT(isToplevClosure closure_info)
-           --ASSERT(is_thunk == IsFunction)
-           (if isToplevClosure closure_info && is_thunk == IsFunction then \x->x 
-            else pprTrace "enterCostCenterCode:" (hsep [ppr (is_thunk == IsFunction), 
-                                                        ppr ccs])) $
+           ASSERT(isToplevClosure closure_info)
+           ASSERT(is_thunk == IsFunction)
            costCentresC SLIT("ENTER_CCS_FSUB") []
-
        else if isCurrentCCS ccs then 
-           -- get CCC out of the closure, where we put it when we alloc'd
-           case is_thunk of 
-               IsThunk    -> costCentresC SLIT("ENTER_CCS_TCL") [CReg node]
-               IsFunction -> costCentresC SLIT("ENTER_CCS_FCL") [CReg node]
+           if re_entrant && not is_box
+               then costCentresC SLIT("ENTER_CCS_FCL") [CReg node]
+               else costCentresC SLIT("ENTER_CCS_TCL") [CReg node]
 
-       else if isCafCCS ccs && isToplevClosure closure_info then
+       else if isCafCCS ccs then
+           ASSERT(isToplevClosure closure_info)
            ASSERT(is_thunk == IsThunk)
-           costCentresC SLIT("ENTER_CCS_CAF") c_ccs
-
-       else -- we've got a "real" cost centre right here in our hands...
-           case is_thunk of 
-               IsThunk    -> costCentresC SLIT("ENTER_CCS_T") c_ccs
-               IsFunction -> if isCafCCS ccs-- || isDictCC ccs
-                             then costCentresC SLIT("ENTER_CCS_FCAF") c_ccs
-                             else costCentresC SLIT("ENTER_CCS_FLOAD") c_ccs
+               -- might be a PAP, in which case we want to subsume costs
+           if re_entrant
+               then costCentresC SLIT("ENTER_CCS_FSUB") []
+               else costCentresC SLIT("ENTER_CCS_CAF") c_ccs
+
+       else panic "enterCostCentreCode"
+
    where
        c_ccs = [mkCCostCentreStack ccs]
+       re_entrant = closureReEntrant closure_info
 \end{code}
 
 %************************************************************************
@@ -566,10 +568,10 @@ thunkWrapper closure_info label thunk_code
 funWrapper :: ClosureInfo      -- Closure whose code body this is
           -> [MagicId]         -- List of argument registers (if any)
           -> [(VirtualSpOffset,Int)] -- tagged stack slots
-          -> CLabel            -- slow entry point for heap check ret.
+          -> CLabel            -- info table for heap check ret.
           -> Code              -- Body of function being compiled
           -> Code
-funWrapper closure_info arg_regs stk_tags slow_label fun_body
+funWrapper closure_info arg_regs stk_tags info_label fun_body
   =    -- Stack overflow check
     nodeMustPointToIt (closureLFInfo closure_info)     `thenFC` \ node_points ->
     let
@@ -581,7 +583,7 @@ funWrapper closure_info arg_regs stk_tags slow_label fun_body
       else absC AbsCNop)                                 `thenC`
 
         -- heap and/or stack checks
-    fastEntryChecks arg_regs stk_tags slow_label node_points (
+    fastEntryChecks arg_regs stk_tags info_label node_points (
 
        -- Finally, do the business
     fun_body
@@ -597,7 +599,8 @@ funWrapper closure_info arg_regs stk_tags slow_label fun_body
 
 
 \begin{code}
-blackHoleIt :: ClosureInfo -> Bool -> Code     -- Only called for thunks
+blackHoleIt :: ClosureInfo -> Bool -> Code     -- Only called for closures with no args
+
 blackHoleIt closure_info node_points
   = if blackHoleOnEntry closure_info && node_points
     then
@@ -610,42 +613,59 @@ blackHoleIt closure_info node_points
 \end{code}
 
 \begin{code}
-setupUpdate :: ClosureInfo -> Code -> Code     -- Only called for thunks
+setupUpdate :: ClosureInfo -> Code -> Code     -- Only called for closures with no args
        -- Nota Bene: this function does not change Node (even if it's a CAF),
        -- so that the cost centre in the original closure can still be
        -- extracted by a subsequent ENTER_CC_TCL
 
+-- I've tidied up the code for this function, but it should still do the same as
+-- it did before (modulo ticky stuff).  KSW 1999-04.
 setupUpdate closure_info code
- = if (closureUpdReqd closure_info) then
-       link_caf_if_needed      `thenFC` \ update_closure ->
-       pushUpdateFrame update_closure code
+ = if closureReEntrant closure_info
+   then
+     code
    else
-       profCtrC SLIT("TICK_UPDF_OMITTED") [] `thenC`
-       code
+     case (closureUpdReqd closure_info, isStaticClosure closure_info) of
+       (False,False) -> profCtrC SLIT("TICK_UPDF_OMITTED") [] `thenC`
+                       code
+       (False,True ) -> (if opt_DoTickyProfiling
+                         then
+                         -- blackhole the SE CAF
+                           link_caf seCafBlackHoleClosureInfo `thenFC` \ _ -> nopC
+                         else
+                           nopC)                                                       `thenC`
+                        profCtrC SLIT("TICK_UPD_CAF_BH_SINGLE_ENTRY") [mkCString cl_name] `thenC`
+                        profCtrC SLIT("TICK_UPDF_OMITTED") []                           `thenC`
+                       code
+       (True ,False) -> pushUpdateFrame (CReg node) code
+       (True ,True ) -> -- blackhole the (updatable) CAF:
+                        link_caf cafBlackHoleClosureInfo           `thenFC` \ update_closure ->
+                        profCtrC SLIT("TICK_UPD_CAF_BH_UPDATABLE") [mkCString cl_name]    `thenC`
+                        pushUpdateFrame update_closure code
  where
-   link_caf_if_needed :: FCode CAddrMode       -- Returns amode for closure to be updated
-   link_caf_if_needed
-     = if not (isStaticClosure closure_info) then
-         returnFC (CReg node)
-       else
-
-         -- First we must allocate a black hole, and link the
-         -- CAF onto the CAF list
-
-               -- Alloc black hole specifying CC_HDR(Node) as the cost centre
-               --   Hack Warning: Using a CLitLit to get CAddrMode !
-         let
-             use_cc   = CLitLit SLIT("CCS_HDR(R1.p)") PtrRep
-             blame_cc = use_cc
-         in
-         allocDynClosure (blackHoleClosureInfo closure_info) use_cc blame_cc []
-                                                       `thenFC` \ heap_offset ->
-         getHpRelOffset heap_offset                    `thenFC` \ hp_rel ->
-         let  amode = CAddr hp_rel
-         in
-         absC (CMacroStmt UPD_CAF [CReg node, amode])
-                                                       `thenC`
-         returnFC amode
+   cl_name :: FAST_STRING
+   cl_name  = (occNameFS . nameOccName . closureName) closure_info
+
+   link_caf :: (ClosureInfo -> ClosureInfo)  -- function yielding BH closure_info
+            -> FCode CAddrMode              -- Returns amode for closure to be updated
+   link_caf bhCI
+     = -- To update a CAF we must allocate a black hole, link the CAF onto the
+       -- CAF list, then update the CAF to point to the fresh black hole.
+       -- This function returns the address of the black hole, so it can be
+       -- updated with the new value when available.
+
+             -- Alloc black hole specifying CC_HDR(Node) as the cost centre
+             --   Hack Warning: Using a CLitLit to get CAddrMode !
+       let
+           use_cc   = CLitLit SLIT("CCS_HDR(R1.p)") PtrRep
+           blame_cc = use_cc
+       in
+       allocDynClosure (bhCI closure_info) use_cc blame_cc []  `thenFC` \ heap_offset ->
+       getHpRelOffset heap_offset                              `thenFC` \ hp_rel ->
+       let  amode = CAddr hp_rel
+       in
+       absC (CMacroStmt UPD_CAF [CReg node, amode])            `thenC`
+       returnFC amode
 \end{code}
 
 %************************************************************************
@@ -687,8 +707,7 @@ chooseDynCostCentres ccs args fvs body
 
        blame_cc -- cost-centre on whom we blame the allocation
          = case (args, fvs, body) of
-             ([], [just1], StgApp fun [{-no args-}])
-               | just1 == fun
+             ([], _, StgApp fun [{-no args-}])
                -> mkCCostCentreStack overheadCCS
              _ -> use_cc