DataflowError.withDefaultTrace has BranchProfile as parameter

Akirathan · Akirathan · commit 482d93a87c7c · 2024-10-16T13:35:07.000+02:00
diff --git a/engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/error/ThrowErrorNode.java b/engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/error/ThrowErrorNode.java
@@ -2,6 +2,7 @@
 
 import com.oracle.truffle.api.frame.VirtualFrame;
 import com.oracle.truffle.api.nodes.Node;
+import com.oracle.truffle.api.profiles.BranchProfile;
 import org.enso.interpreter.dsl.BuiltinMethod;
 import org.enso.interpreter.runtime.error.DataflowError;
 import org.enso.interpreter.runtime.state.State;
@@ -12,7 +13,9 @@
     description = "Returns a new value error with given payload.",
     inlineable = true)
 public class ThrowErrorNode extends Node {
+  private final BranchProfile attachFullStackTraceProfile = BranchProfile.create();
+
   public Object execute(VirtualFrame giveMeAStackFrame, State state, Object payload) {
-    return DataflowError.withDefaultTrace(state, payload, this);
+    return DataflowError.withDefaultTrace(state, payload, this, attachFullStackTraceProfile);
   }
 }
diff --git a/engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/number/decimal/FloatNode.java b/engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/number/decimal/FloatNode.java
@@ -4,6 +4,7 @@
 import com.oracle.truffle.api.interop.TruffleObject;
 import com.oracle.truffle.api.interop.UnsupportedMessageException;
 import com.oracle.truffle.api.nodes.Node;
+import com.oracle.truffle.api.profiles.BranchProfile;
 import org.enso.interpreter.node.expression.builtin.number.utils.ToEnsoNumberNode;
 import org.enso.interpreter.runtime.EnsoContext;
 import org.enso.interpreter.runtime.error.DataflowError;
@@ -12,6 +13,7 @@
 
 abstract class FloatNode extends Node {
   static final String INTEROP_LIMIT = "3";
+  private final BranchProfile attachFullStackTraceProfile = BranchProfile.create();
 
   final boolean isForeignNumber(InteropLibrary iop, TruffleObject obj) {
     if (obj instanceof EnsoBigInteger) {
@@ -48,6 +50,6 @@ final PanicException panicOtherwise(double self, Object that) {
   final DataflowError incomparableError(Object self, Object that) {
     var builtins = EnsoContext.get(this).getBuiltins();
     var incomparableErr = builtins.error().makeIncomparableValues(self, that);
-    return DataflowError.withDefaultTrace(incomparableErr, this);
+    return DataflowError.withDefaultTrace(incomparableErr, this, attachFullStackTraceProfile);
   }
 }
diff --git a/engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/number/integer/BitShiftNode.java b/engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/number/integer/BitShiftNode.java
@@ -2,13 +2,15 @@
 
 import com.oracle.truffle.api.dsl.Cached;
 import com.oracle.truffle.api.dsl.Cached.Exclusive;
+import com.oracle.truffle.api.dsl.Cached.Shared;
 import com.oracle.truffle.api.dsl.Fallback;
 import com.oracle.truffle.api.dsl.ImportStatic;
 import com.oracle.truffle.api.dsl.NeverDefault;
 import com.oracle.truffle.api.dsl.Specialization;
 import com.oracle.truffle.api.interop.InteropLibrary;
 import com.oracle.truffle.api.interop.TruffleObject;
 import com.oracle.truffle.api.library.CachedLibrary;
+import com.oracle.truffle.api.profiles.BranchProfile;
 import com.oracle.truffle.api.profiles.CountingConditionProfile;
 import org.enso.interpreter.dsl.BuiltinMethod;
 import org.enso.interpreter.node.expression.builtin.number.utils.BigIntegerOps;
@@ -40,14 +42,17 @@ long doLongShiftLeft(long self, long that) {
   }
 
   @Specialization(guards = "that >= 0", replaces = "doLongShiftLeft")
-  Object doLongShiftLeftExplicit(long self, long that) {
+  Object doLongShiftLeftExplicit(
+      long self, long that, @Shared @Cached BranchProfile attachFullStackTraceProfile) {
     if (canShiftLeftInLongProfile.profile(canShiftLeftInLong(self, that))) {
       return doLongShiftLeft(self, that);
     } else if (positiveFitsInInt.profile(BigIntegerOps.fitsInInt(that))) {
       return toEnsoNumberNode.execute(BigIntegerOps.bitShiftLeft(self, (int) that));
     } else {
       return DataflowError.withDefaultTrace(
-          EnsoContext.get(this).getBuiltins().error().getShiftAmountTooLargeError(), this);
+          EnsoContext.get(this).getBuiltins().error().getShiftAmountTooLargeError(),
+          this,
+          attachFullStackTraceProfile);
     }
   }
 
@@ -70,13 +75,16 @@ long doLongShiftRightExplicit(long self, long that) {
   }
 
   @Specialization
-  Object doBigInteger(long self, EnsoBigInteger that) {
+  Object doBigInteger(
+      long self, EnsoBigInteger that, @Cached BranchProfile attachFullStackTraceProfile) {
     if (!BigIntegerOps.nonNegative(that.getValue())) {
       return self >= 0 ? 0L : -1L;
     } else {
       // Note [Well-Formed BigIntegers]
       return DataflowError.withDefaultTrace(
-          EnsoContext.get(this).getBuiltins().error().getShiftAmountTooLargeError(), this);
+          EnsoContext.get(this).getBuiltins().error().getShiftAmountTooLargeError(),
+          this,
+          attachFullStackTraceProfile);
     }
   }
 
@@ -89,12 +97,15 @@ EnsoBigInteger doBigIntShiftLeft(EnsoBigInteger self, long that) {
   Object doBigIntShiftLeftExplicit(
       EnsoBigInteger self,
       long that,
-      @Exclusive @Cached CountingConditionProfile fitsInIntProfileLeftShift) {
+      @Exclusive @Cached CountingConditionProfile fitsInIntProfileLeftShift,
+      @Cached BranchProfile attachFullStackTraceProfile) {
     if (fitsInIntProfileLeftShift.profile(BigIntegerOps.fitsInInt(that))) {
       return doBigIntShiftLeft(self, that);
     } else {
       return DataflowError.withDefaultTrace(
-          EnsoContext.get(this).getBuiltins().error().getShiftAmountTooLargeError(), this);
+          EnsoContext.get(this).getBuiltins().error().getShiftAmountTooLargeError(),
+          this,
+          attachFullStackTraceProfile);
     }
   }
 
@@ -116,12 +127,17 @@ Object doBigIntShiftRightExplicit(
   }
 
   @Specialization
-  Object doBigIntThat(EnsoBigInteger self, EnsoBigInteger that) {
+  Object doBigIntThat(
+      EnsoBigInteger self,
+      EnsoBigInteger that,
+      @Shared @Cached BranchProfile attachFullStackTraceProfile) {
     if (!BigIntegerOps.nonNegative(that.getValue())) {
       return BigIntegerOps.nonNegative(self.getValue()) ? 0L : -1L;
     } else {
       return DataflowError.withDefaultTrace(
-          EnsoContext.get(this).getBuiltins().error().getShiftAmountTooLargeError(), this);
+          EnsoContext.get(this).getBuiltins().error().getShiftAmountTooLargeError(),
+          this,
+          attachFullStackTraceProfile);
     }
   }
 
diff --git a/engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/number/integer/GreaterNode.java b/engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/number/integer/GreaterNode.java
@@ -6,6 +6,7 @@
 import com.oracle.truffle.api.interop.InteropLibrary;
 import com.oracle.truffle.api.interop.TruffleObject;
 import com.oracle.truffle.api.library.CachedLibrary;
+import com.oracle.truffle.api.profiles.BranchProfile;
 import org.enso.interpreter.dsl.BuiltinMethod;
 import org.enso.interpreter.node.expression.builtin.number.utils.BigIntegerOps;
 import org.enso.interpreter.runtime.EnsoContext;
@@ -61,9 +62,9 @@ Object doInterop(
   }
 
   @Fallback
-  Object doOther(Object self, Object that) {
+  Object doOther(Object self, Object that, @Cached BranchProfile attachFullStackTraceProfile) {
     var builtins = EnsoContext.get(this).getBuiltins();
     var incomparableValsErr = builtins.error().makeIncomparableValues(self, that);
-    return DataflowError.withDefaultTrace(incomparableValsErr, this);
+    return DataflowError.withDefaultTrace(incomparableValsErr, this, attachFullStackTraceProfile);
   }
 }
diff --git a/engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/number/integer/GreaterOrEqualNode.java b/engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/number/integer/GreaterOrEqualNode.java
@@ -6,6 +6,7 @@
 import com.oracle.truffle.api.interop.InteropLibrary;
 import com.oracle.truffle.api.interop.TruffleObject;
 import com.oracle.truffle.api.library.CachedLibrary;
+import com.oracle.truffle.api.profiles.BranchProfile;
 import org.enso.interpreter.dsl.BuiltinMethod;
 import org.enso.interpreter.node.expression.builtin.number.utils.BigIntegerOps;
 import org.enso.interpreter.runtime.EnsoContext;
@@ -61,9 +62,9 @@ Object doInterop(
   }
 
   @Fallback
-  Object doOther(Object self, Object that) {
+  Object doOther(Object self, Object that, @Cached BranchProfile attachFullStackTraceProfile) {
     var builtins = EnsoContext.get(this).getBuiltins();
     var incomparableValsErr = builtins.error().makeIncomparableValues(self, that);
-    return DataflowError.withDefaultTrace(incomparableValsErr, this);
+    return DataflowError.withDefaultTrace(incomparableValsErr, this, attachFullStackTraceProfile);
   }
 }
diff --git a/engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/number/integer/LessNode.java b/engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/number/integer/LessNode.java
@@ -6,6 +6,7 @@
 import com.oracle.truffle.api.interop.InteropLibrary;
 import com.oracle.truffle.api.interop.TruffleObject;
 import com.oracle.truffle.api.library.CachedLibrary;
+import com.oracle.truffle.api.profiles.BranchProfile;
 import org.enso.interpreter.dsl.BuiltinMethod;
 import org.enso.interpreter.node.expression.builtin.number.utils.BigIntegerOps;
 import org.enso.interpreter.runtime.EnsoContext;
@@ -61,9 +62,9 @@ Object doInterop(
   }
 
   @Fallback
-  Object doOther(Object self, Object that) {
+  Object doOther(Object self, Object that, @Cached BranchProfile attachFullStackTraceProfile) {
     var builtins = EnsoContext.get(this).getBuiltins();
     var incomparableValsErr = builtins.error().makeIncomparableValues(self, that);
-    return DataflowError.withDefaultTrace(incomparableValsErr, this);
+    return DataflowError.withDefaultTrace(incomparableValsErr, this, attachFullStackTraceProfile);
   }
 }
diff --git a/engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/number/integer/LessOrEqualNode.java b/engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/number/integer/LessOrEqualNode.java
@@ -6,6 +6,7 @@
 import com.oracle.truffle.api.interop.InteropLibrary;
 import com.oracle.truffle.api.interop.TruffleObject;
 import com.oracle.truffle.api.library.CachedLibrary;
+import com.oracle.truffle.api.profiles.BranchProfile;
 import org.enso.interpreter.dsl.BuiltinMethod;
 import org.enso.interpreter.node.expression.builtin.number.utils.BigIntegerOps;
 import org.enso.interpreter.runtime.EnsoContext;
@@ -62,9 +63,9 @@ Object doInterop(
   }
 
   @Fallback
-  Object doOther(Object self, Object that) {
+  Object doOther(Object self, Object that, @Cached BranchProfile attachFullStackTraceProfile) {
     var builtins = EnsoContext.get(this).getBuiltins();
     var incomparableValsErr = builtins.error().makeIncomparableValues(self, that);
-    return DataflowError.withDefaultTrace(incomparableValsErr, this);
+    return DataflowError.withDefaultTrace(incomparableValsErr, this, attachFullStackTraceProfile);
   }
 }
diff --git a/engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/number/integer/ModNode.java b/engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/number/integer/ModNode.java
@@ -7,6 +7,7 @@
 import com.oracle.truffle.api.interop.InteropLibrary;
 import com.oracle.truffle.api.interop.TruffleObject;
 import com.oracle.truffle.api.library.CachedLibrary;
+import com.oracle.truffle.api.profiles.BranchProfile;
 import java.math.BigInteger;
 import org.enso.interpreter.dsl.BuiltinMethod;
 import org.enso.interpreter.node.expression.builtin.number.utils.BigIntegerOps;
@@ -53,12 +54,14 @@ Object doBigInteger(long self, EnsoBigInteger that) {
   }
 
   @Specialization
-  Object doLong(EnsoBigInteger self, long that) {
+  Object doLong(EnsoBigInteger self, long that, @Cached BranchProfile attachFullStackTraceProfile) {
     try {
       return toEnsoNumberNode.execute(BigIntegerOps.modulo(self.getValue(), that));
     } catch (ArithmeticException e) {
       return DataflowError.withDefaultTrace(
-          EnsoContext.get(this).getBuiltins().error().getDivideByZeroError(), this);
+          EnsoContext.get(this).getBuiltins().error().getDivideByZeroError(),
+          this,
+          attachFullStackTraceProfile);
     }
   }
 
diff --git a/engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/number/integer/ParseIntegerNode.java b/engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/number/integer/ParseIntegerNode.java
@@ -20,6 +20,7 @@ public final class ParseIntegerNode extends IntegerNode {
   @Child ToJavaStringNode toJavaString = ToJavaStringNode.build();
   private final BranchProfile noEx1 = BranchProfile.create();
   private final BranchProfile noEx2 = BranchProfile.create();
+  private final BranchProfile attachFullStackTraceProfile = BranchProfile.create();
 
   Object execute(Text value, long radix) {
     var r = Math.toIntExact(radix);
@@ -36,7 +37,7 @@ Object execute(Text value, long radix) {
       noEx2.enter();
       var errors = EnsoContext.get(this).getBuiltins().error();
       var err = errors.makeNumberParseError(ex.getMessage());
-      return DataflowError.withDefaultTrace(err, this);
+      return DataflowError.withDefaultTrace(err, this, attachFullStackTraceProfile);
     }
   }
 }
diff --git a/engine/runtime/src/main/java/org/enso/interpreter/node/expression/constant/LazyObjectNode.java b/engine/runtime/src/main/java/org/enso/interpreter/node/expression/constant/LazyObjectNode.java
@@ -3,6 +3,7 @@
 import com.oracle.truffle.api.frame.VirtualFrame;
 import com.oracle.truffle.api.interop.TruffleObject;
 import com.oracle.truffle.api.nodes.NodeInfo;
+import com.oracle.truffle.api.profiles.BranchProfile;
 import java.util.function.Supplier;
 import org.enso.interpreter.node.ExpressionNode;
 import org.enso.interpreter.runtime.data.text.Text;
@@ -16,6 +17,7 @@ public final class LazyObjectNode extends ExpressionNode {
 
   private final String error;
   private final CachingSupplier<? extends Object> supply;
+  private final BranchProfile attachFullStackTraceProfile = BranchProfile.create();
 
   private LazyObjectNode(String error, Supplier<? extends Object> supply) {
     this.error = error;
@@ -39,6 +41,6 @@ public Object executeGeneric(VirtualFrame frame) {
     if (result instanceof TruffleObject) {
       return result;
     }
-    return DataflowError.withDefaultTrace(Text.create(error), this);
+    return DataflowError.withDefaultTrace(Text.create(error), this, attachFullStackTraceProfile);
   }
 }
diff --git a/engine/runtime/src/main/java/org/enso/interpreter/runtime/data/hash/HashMapRemoveNode.java b/engine/runtime/src/main/java/org/enso/interpreter/runtime/data/hash/HashMapRemoveNode.java
@@ -13,6 +13,7 @@
 import com.oracle.truffle.api.interop.UnsupportedMessageException;
 import com.oracle.truffle.api.library.CachedLibrary;
 import com.oracle.truffle.api.nodes.Node;
+import com.oracle.truffle.api.profiles.BranchProfile;
 import org.enso.interpreter.dsl.BuiltinMethod;
 import org.enso.interpreter.node.expression.builtin.meta.EqualsNode;
 import org.enso.interpreter.node.expression.builtin.meta.HashCodeNode;
@@ -39,12 +40,13 @@ EnsoHashMap removeFromEnsoMap(
       EnsoHashMap ensoMap,
       Object key,
       @Shared("hash") @Cached HashCodeNode hashCodeNode,
-      @Shared("equals") @Cached EqualsNode equalsNode) {
+      @Shared("equals") @Cached EqualsNode equalsNode,
+      @Cached BranchProfile attachFullStackTraceProfile) {
     var mapBuilder = ensoMap.getMapBuilder(frame, false, hashCodeNode, equalsNode);
     if (mapBuilder.remove(frame, key, hashCodeNode, equalsNode)) {
       return mapBuilder.build();
     } else {
-      throw DataflowError.withDefaultTrace("No such key", null);
+      throw DataflowError.withDefaultTrace("No such key", null, attachFullStackTraceProfile);
     }
   }
 
diff --git a/engine/runtime/src/main/java/org/enso/interpreter/runtime/error/DataflowError.java b/engine/runtime/src/main/java/org/enso/interpreter/runtime/error/DataflowError.java
@@ -15,6 +15,7 @@
 import com.oracle.truffle.api.library.ExportLibrary;
 import com.oracle.truffle.api.library.ExportMessage;
 import com.oracle.truffle.api.nodes.Node;
+import com.oracle.truffle.api.profiles.BranchProfile;
 import java.util.Objects;
 import org.enso.interpreter.node.callable.IndirectInvokeMethodNode;
 import org.enso.interpreter.node.expression.builtin.text.util.TypeToDisplayTextNode;
@@ -49,16 +50,19 @@ public final class DataflowError extends AbstractTruffleException implements Ens
    *
    * @param payload the user-provided value carried by the error
    * @param location the node in which the error was created
+   * @param attachFullStackTraceProfile
    * @return a new dataflow error
    */
-  public static DataflowError withDefaultTrace(State state, Object payload, Node location) {
+  public static DataflowError withDefaultTrace(
+      State state, Object payload, Node location, BranchProfile attachFullStackTraceProfile) {
     assert payload != null;
     boolean attachFullStackTrace =
         state == null
             || EnsoContext.get(location)
                 .getExecutionEnvironment()
                 .hasContextEnabled("Dataflow_Stack_Trace");
     if (attachFullStackTrace) {
+      attachFullStackTraceProfile.enter();
       var result = new DataflowError(payload, UNLIMITED_STACK_TRACE, location);
       TruffleStackTrace.fillIn(result);
       return result;
@@ -68,8 +72,13 @@ public static DataflowError withDefaultTrace(State state, Object payload, Node l
     }
   }
 
+  public static DataflowError withDefaultTrace(
+      Object payload, Node location, BranchProfile attachFullStackTraceProfile) {
+    return withDefaultTrace(null, payload, location, attachFullStackTraceProfile);
+  }
+
   public static DataflowError withDefaultTrace(Object payload, Node location) {
-    return withDefaultTrace(null, payload, location);
+    return withDefaultTrace(null, payload, location, BranchProfile.getUncached());
   }
 
   /**

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`	`import com.oracle.truffle.api.interop.InteropLibrary;`
`7`	`7`	`import com.oracle.truffle.api.interop.TruffleObject;`
`8`	`8`	`import com.oracle.truffle.api.library.CachedLibrary;`
	`9`	`+import com.oracle.truffle.api.profiles.BranchProfile;`
`9`	`10`	`import org.enso.interpreter.dsl.BuiltinMethod;`
`10`	`11`	`import org.enso.interpreter.node.expression.builtin.number.utils.BigIntegerOps;`
`11`	`12`	`import org.enso.interpreter.runtime.EnsoContext;`
`@@ -61,9 +62,9 @@ Object doInterop(`
`61`	`62`	`}`
`62`	`63`
`63`	`64`	`@Fallback`
`64`		`- Object doOther(Object self, Object that) {`
	`65`	`+ Object doOther(Object self, Object that, @Cached BranchProfile attachFullStackTraceProfile) {`
`65`	`66`	`var builtins = EnsoContext.get(this).getBuiltins();`
`66`	`67`	`var incomparableValsErr = builtins.error().makeIncomparableValues(self, that);`
`67`		`- return DataflowError.withDefaultTrace(incomparableValsErr, this);`
	`68`	`+ return DataflowError.withDefaultTrace(incomparableValsErr, this, attachFullStackTraceProfile);`
`68`	`69`	`}`
`69`	`70`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@ public final class ParseIntegerNode extends IntegerNode {`
`20`	`20`	`@Child ToJavaStringNode toJavaString = ToJavaStringNode.build();`
`21`	`21`	`private final BranchProfile noEx1 = BranchProfile.create();`
`22`	`22`	`private final BranchProfile noEx2 = BranchProfile.create();`
	`23`	`+ private final BranchProfile attachFullStackTraceProfile = BranchProfile.create();`
`23`	`24`
`24`	`25`	`Object execute(Text value, long radix) {`
`25`	`26`	`var r = Math.toIntExact(radix);`
`@@ -36,7 +37,7 @@ Object execute(Text value, long radix) {`
`36`	`37`	`noEx2.enter();`
`37`	`38`	`var errors = EnsoContext.get(this).getBuiltins().error();`
`38`	`39`	`var err = errors.makeNumberParseError(ex.getMessage());`
`39`		`- return DataflowError.withDefaultTrace(err, this);`
	`40`	`+ return DataflowError.withDefaultTrace(err, this, attachFullStackTraceProfile);`
`40`	`41`	`}`
`41`	`42`	`}`
`42`	`43`	`}`