CNF: Silence pointer fix-up message unless gc debugging is enabled
[ghc.git] / rts / Apply.cmm
index b89abea..f14bb8f 100644 (file)
@@ -22,7 +22,7 @@
 STRING(stg_ap_0_ret_str,"stg_ap_0_ret... ")
 
 stg_ap_0_fast ( P_ fun )
-{ 
+{
     IF_DEBUG(apply,
         ccall debugBelch(stg_ap_0_ret_str);
         ccall printClosure(R1 "ptr"));
@@ -30,7 +30,159 @@ stg_ap_0_fast ( P_ fun )
     IF_DEBUG(sanity,
         ccall checkStackFrame(Sp "ptr"));
 
+#if !defined(PROFILING)
+
     ENTER(fun);
+
+#else
+
+/*
+  Note [Evaluating functions with profiling]
+
+  If we evaluate something like
+
+    let f = {-# SCC "f" #-} g
+
+  where g is a function, then updating the thunk for f to point to g
+  would be incorrect: we've lost the SCC annotation.  In general, when
+  we evaluate a function and the current CCS is different from the one
+  stored in the function, we need to return a function with the
+  correct CCS in it.
+
+  The mechanism we use to wrap the function is to create a
+  zero-argument PAP as a proxy object to hold the new CCS, and return
+  that.
+
+  If the closure we evaluated is itself a PAP, we cannot make a nested
+  PAP, so we copy the original PAP and set the CCS in the new PAP to
+  enterFunCCS(pap->header.prof.ccs).
+*/
+
+again:
+    W_  info;
+    W_ untaggedfun;
+    W_ arity;
+    untaggedfun = UNTAG(fun);
+    info = %INFO_PTR(untaggedfun);
+    switch [INVALID_OBJECT .. N_CLOSURE_TYPES]
+        (TO_W_( %INFO_TYPE(%STD_INFO(info)) )) {
+        case
+            IND,
+            IND_STATIC:
+        {
+            fun = StgInd_indirectee(fun);
+            goto again;
+        }
+        case BCO:
+        {
+            arity = TO_W_(StgBCO_arity(untaggedfun));
+            goto dofun;
+        }
+        case
+            FUN,
+            FUN_1_0,
+            FUN_0_1,
+            FUN_2_0,
+            FUN_1_1,
+            FUN_0_2,
+            FUN_STATIC:
+        {
+            arity = TO_W_(StgFunInfoExtra_arity(%FUN_INFO(info)));
+        dofun:
+            if (CCCS == StgHeader_ccs(untaggedfun)) {
+                return (fun);
+            } else {
+                // We're going to build a new PAP, with zero extra
+                // arguments and therefore the same arity as the
+                // original function.  In other words, we're using a
+                // zero-argument PAP as an indirection to the
+                // function, so that we can attach a different CCS to
+                // it.
+                HP_CHK_GEN(SIZEOF_StgPAP);
+                TICK_ALLOC_PAP(SIZEOF_StgPAP, 0);
+                // attribute this allocation to the "overhead of profiling"
+                CCS_ALLOC(BYTES_TO_WDS(SIZEOF_StgPAP), CCS_OVERHEAD);
+                P_ pap;
+                pap = Hp - SIZEOF_StgPAP + WDS(1);
+                SET_HDR(pap, stg_PAP_info, CCCS);
+                StgPAP_arity(pap) = arity;
+                StgPAP_fun(pap)   = fun;
+                StgPAP_n_args(pap) = 0;
+                return (pap);
+            }
+        }
+        case PAP:
+        {
+            if (CCCS == StgHeader_ccs(untaggedfun)) {
+                return (fun);
+            } else {
+                // We're going to copy this PAP, and put the new CCS in it
+                fun = untaggedfun;
+                W_ size;
+                size = SIZEOF_StgPAP + WDS(TO_W_(StgPAP_n_args(fun)));
+                HP_CHK_GEN(size);
+                TICK_ALLOC_PAP(size, 0);
+                // attribute this allocation to the "overhead of profiling"
+                CCS_ALLOC(BYTES_TO_WDS(SIZEOF_StgPAP), CCS_OVERHEAD);
+                P_ pap;
+                pap = Hp - size + WDS(1);
+                // We'll lose the original PAP, so we should enter its CCS
+                ccall enterFunCCS(BaseReg "ptr", StgHeader_ccs(fun) "ptr");
+                SET_HDR(pap, stg_PAP_info, CCCS);
+                StgPAP_arity(pap) = StgPAP_arity(fun);
+                StgPAP_n_args(pap) = StgPAP_n_args(fun);
+                StgPAP_fun(pap)   = StgPAP_fun(fun);
+                W_ i;
+                i = TO_W_(StgPAP_n_args(fun));
+            loop:
+                if (i == 0) {
+                    return (pap);
+                }
+                i = i - 1;
+                StgPAP_payload(pap,i) = StgPAP_payload(fun,i);
+                goto loop;
+            }
+        }
+        case AP,
+             AP_STACK,
+             BLACKHOLE,
+             WHITEHOLE,
+             THUNK,
+             THUNK_1_0,
+             THUNK_0_1,
+             THUNK_2_0,
+             THUNK_1_1,
+             THUNK_0_2,
+             THUNK_STATIC,
+             THUNK_SELECTOR:
+        {
+            // We have a thunk of some kind, so evaluate it.
+
+            // The thunk might evaluate to a function, so we have to
+            // come back here again to adjust its CCS if necessary.
+            // Therefore we need to push a stack frame to look at the
+            // function that gets returned (a stg_restore_ccs_eval
+            // frame), and therefore we need a stack check.
+            STK_CHK_GEN();
+
+            // We can't use the value of 'info' any more, because if
+            // STK_CHK_GEN() did a GC then the closure we're looking
+            // at may have changed, e.g. a THUNK_SELECTOR may have
+            // been evaluated by the GC.  So we reload the info
+            // pointer now.
+            untaggedfun = UNTAG(fun);
+            info = %INFO_PTR(untaggedfun);
+
+            jump %ENTRY_CODE(info)
+                (stg_restore_cccs_eval_info, CCCS)
+                (untaggedfun);
+        }
+        default:
+        {
+            jump %ENTRY_CODE(info) (UNTAG(fun));
+        }
+    }
+#endif
 }
 
 /* -----------------------------------------------------------------------------
@@ -55,12 +207,12 @@ stg_ap_0_fast ( P_ fun )
 
 INFO_TABLE(stg_PAP,/*special layout*/0,0,PAP,"PAP","PAP")
 {  ccall barf("PAP object entered!") never returns; }
-    
+
 stg_PAP_apply /* no args => explicit stack */
 {
   W_ Words;
   W_ pap;
-    
+
   pap = R1;
 
   Words = TO_W_(StgPAP_n_args(pap));
@@ -70,11 +222,11 @@ stg_PAP_apply /* no args => explicit stack */
   // We have a hand-rolled stack check fragment here, because none of
   // the canned ones suit this situation.
   //
-  if ((Sp - WDS(Words)) < SpLim) {
+  if (Sp - (WDS(Words) + 2/* see ARG_BCO below */) < SpLim) {
       // there is a return address in R2 in the event of a
       // stack check failure.  The various stg_apply functions arrange
       // this before calling stg_PAP_entry.
-      Sp_adj(-1); 
+      Sp_adj(-1);
       Sp(0) = R2;
       jump stg_gc_unpt_r1 [R1];
   }
@@ -83,11 +235,11 @@ stg_PAP_apply /* no args => explicit stack */
   // profiling
   TICK_ENT_PAP();
   LDV_ENTER(pap);
-#ifdef PROFILING
+#if defined(PROFILING)
   ccall enterFunCCS(BaseReg "ptr", StgHeader_ccs(pap) "ptr");
 #endif
 
-  // Reload the stack 
+  // Reload the stack
   W_ i;
   W_ p;
   p = pap + SIZEOF_StgHeader + OFFSET_StgPAP_payload;
@@ -105,21 +257,21 @@ for:
 /* DEBUGGING CODE, ensures that arity 1 and 2 functions are entered tagged
   if (TO_W_(StgFunInfoExtra_arity(%FUN_INFO(%INFO_PTR(UNTAG(R1))))) == 1 ) {
     if (GETTAG(R1)!=1) {
-       W_[0]=1;
+        W_[0]=1;
     }
   }
 
   if (TO_W_(StgFunInfoExtra_arity(%FUN_INFO(%INFO_PTR(UNTAG(R1))))) == 2 ) {
     if (GETTAG(R1)!=2) {
-       W_[0]=1;
+        W_[0]=1;
     }
   }
 */
 
-  // Off we go! 
+  // Off we go!
   TICK_ENT_VIA_NODE();
 
-#ifdef NO_ARG_REGS
+#if defined(NO_ARG_REGS)
   jump %GET_ENTRY(UNTAG(R1)) [R1];
 #else
       W_ info;
@@ -133,12 +285,12 @@ for:
           jump StgFunInfoExtra_slow_apply(info) [R1];
       }
       if (type == ARG_BCO) {
-         Sp_adj(-2);
-         Sp(1) = R1;
-         Sp(0) = stg_apply_interp_info;
+          Sp_adj(-2);
+          Sp(1) = R1;
+          Sp(0) = stg_apply_interp_info;
           jump stg_yield_to_interpreter [];
       }
-      jump W_[stg_ap_stack_entries + 
+      jump W_[stg_ap_stack_entries +
                 WDS(TO_W_(StgFunInfoExtra_fun_type(info)))] [R1];
 #endif
 }
@@ -157,18 +309,20 @@ INFO_TABLE(stg_AP,/*special layout*/0,0,AP,"AP","AP")
 {
   W_ Words;
   W_ ap;
-    
+
   ap = R1;
-  
+
   Words = TO_W_(StgAP_n_args(ap));
 
-  /* 
+  /*
    * Check for stack overflow.  IMPORTANT: use a _ENTER check here,
    * because if the check fails, we might end up blackholing this very
    * closure, in which case we must enter the blackhole on return rather
    * than continuing to evaluate the now-defunct closure.
    */
-  STK_CHK_ENTER(WDS(Words) + SIZEOF_StgUpdateFrame, R1);
+  STK_CHK_ENTER(WDS(Words) +
+                SIZEOF_StgUpdateFrame +
+                2/* see ARG_BCO below */, R1);
 
   PUSH_UPD_FRAME(Sp - SIZEOF_StgUpdateFrame, R1);
   Sp = Sp - SIZEOF_StgUpdateFrame - WDS(Words);
@@ -192,10 +346,10 @@ for:
 
   R1 = StgAP_fun(ap);
 
-  // Off we go! 
+  // Off we go!
   TICK_ENT_VIA_NODE();
 
-#ifdef NO_ARG_REGS
+#if defined(NO_ARG_REGS)
   jump %GET_ENTRY(UNTAG(R1)) [R1];
 #else
       W_ info;
@@ -209,18 +363,18 @@ for:
           jump StgFunInfoExtra_slow_apply(info) [R1];
       }
       if (type == ARG_BCO) {
-         Sp_adj(-2);
-         Sp(1) = R1;
-         Sp(0) = stg_apply_interp_info;
+          Sp_adj(-2);
+          Sp(1) = R1;
+          Sp(0) = stg_apply_interp_info;
           jump stg_yield_to_interpreter [];
       }
-      jump W_[stg_ap_stack_entries + 
+      jump W_[stg_ap_stack_entries +
                 WDS(TO_W_(StgFunInfoExtra_fun_type(info)))] [R1];
 #endif
 }
 
 /* AP_NOUPD is exactly like AP, except that no update frame is pushed.
-   Use for thunks that are guaranteed to be entered once only, such as 
+   Use for thunks that are guaranteed to be entered once only, such as
    those generated by the byte-code compiler for inserting breakpoints. */
 
 INFO_TABLE(stg_AP_NOUPD,/*special layout*/0,0,AP,"AP_NOUPD","AP_NOUPD")
@@ -228,18 +382,19 @@ INFO_TABLE(stg_AP_NOUPD,/*special layout*/0,0,AP,"AP_NOUPD","AP_NOUPD")
 {
   W_ Words;
   W_ ap;
-    
+
   ap = R1;
-  
+
   Words = TO_W_(StgAP_n_args(ap));
 
-  /* 
+  /*
    * Check for stack overflow.  IMPORTANT: use a _ENTER check here,
    * because if the check fails, we might end up blackholing this very
    * closure, in which case we must enter the blackhole on return rather
    * than continuing to evaluate the now-defunct closure.
    */
-  STK_CHK_ENTER(WDS(Words), R1);
+  STK_CHK_ENTER(WDS(Words) +
+                2/* see ARG_BCO below */, R1);
   Sp = Sp - WDS(Words);
 
   TICK_ENT_AP();
@@ -261,10 +416,10 @@ for:
 
   R1 = StgAP_fun(ap);
 
-  // Off we go! 
+  // Off we go!
   TICK_ENT_VIA_NODE();
 
-#ifdef NO_ARG_REGS
+#if defined(NO_ARG_REGS)
   jump %GET_ENTRY(UNTAG(R1)) [R1];
 #else
       W_ info;
@@ -278,12 +433,12 @@ for:
           jump StgFunInfoExtra_slow_apply(info) [R1];
       }
       if (type == ARG_BCO) {
-         Sp_adj(-2);
-         Sp(1) = R1;
-         Sp(0) = stg_apply_interp_info;
+          Sp_adj(-2);
+          Sp(1) = R1;
+          Sp(0) = stg_apply_interp_info;
           jump stg_yield_to_interpreter [];
       }
-      jump W_[stg_ap_stack_entries + 
+      jump W_[stg_ap_stack_entries +
                 WDS(TO_W_(StgFunInfoExtra_fun_type(info)))] [R1];
 #endif
 }
@@ -306,10 +461,10 @@ INFO_TABLE(stg_AP_STACK,/*special layout*/0,0,AP_STACK,"AP_STACK","AP_STACK")
   W_ ap;
 
   ap = R1;
-  
+
   Words = StgAP_STACK_size(ap);
 
-  /* 
+  /*
    * Check for stack overflow.  IMPORTANT: use a _ENTER check here,
    * because if the check fails, we might end up blackholing this very
    * closure, in which case we must enter the blackhole on return rather
@@ -359,10 +514,10 @@ INFO_TABLE(stg_AP_STACK_NOUPD,/*special layout*/0,0,AP_STACK,
   W_ ap;
 
   ap = R1;
-  
+
   Words = StgAP_STACK_size(ap);
 
-  /* 
+  /*
    * Check for stack overflow.  IMPORTANT: use a _NP check here,
    * because if the check fails, we might end up blackholing this very
    * closure, in which case we must enter the blackhole on return rather