Use `BuiltinRootNode.ArgNode` to extract argument for a builtin method #12201

JaroslavTulach · 2025-01-30T19:57:35Z

Pull Request Description

as Polish to_text on intersection types #12192 (comment) states:
there is a need to extract values from EnsoMultiValue in the "builtin method prelude code"
to enable specializations based on type of arguments, we need to wrap such prelude by a Node
hence introducing ArgNode & co.
it kinda replaces the "static code emitted" by annotation processor
with Truffle @Specializations done inside of ArgNode
making this all more Truffle-like

Checklist

Please ensure that the following checklist has been satisfied before submitting the PR:

All code follows the
Scala,
Java,
Unit tests keep running
Engine benchmarks are OK: https://github.com/enso-org/enso/actions/runs/13068031263
Libs benchmarks are OK

JaroslavTulach · 2025-01-31T07:02:12Z

engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/Boolean.java

-public class Boolean extends Builtin {
+public final class Boolean extends Builtin {
+  public Boolean() {
+    super(java.lang.Boolean.class);


Now we attempt to provide a representationType to each Builtin. That way we can deduce from signature methods having argument like boolean that the desired builtin is Boolean and the Enso type should be Standard.Base.Data.Boolean.Boolean. With that information we can extract (via CastToNode) such a type from EnsoMultiValue....

JaroslavTulach · 2025-01-31T08:38:48Z

Right now there are two dataflow errors:

sbt:enso> runEngineDistribution --run test/Base_Tests/src/Semantic/Warnings_Spec.enso should.be.allowed.in.Vector|should.be.preserved.after.operations.on.Vector

[FAILED] Dataflow Warnings: [0/2, 770ms]

    - [FAILED] should be allowed in Vector [522ms]
        Reason: ['d', 'b', 'a'] did not equal [(Map_Error.Error 1 'b'), (Map_Error.Error 0 'a'), 'd']; first difference at index 0  (at Base_Tests/src/Semantic/Warnings_Spec.enso:272:9-126).


    - [FAILED] should be preserved after operations on Vector [248ms]
        Reason: ['warn4', 'warn3', 'warn2', 'warn1'] did not equal [(Map_Error.Error 3 'warn4'), (Map_Error.Error 2 'warn3'), (Map_Error.Error 1 'warn2'), (Map_Error.Error 0 'warn1')]; first difference at index 0  (at Base_Tests/src/Semantic/Warnings_Spec.enso:284:9-191).

I was debugging thru it, but I don't think I get any idea what can be the problem? Maybe something with wrapping errors? But why?

JaroslavTulach · 2025-01-31T08:41:08Z

Currently there are two failures:

Again, I am not really sure why at present.

JaroslavTulach · 2025-01-31T08:42:31Z

engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/Polyglot.java

@@ -3,4 +3,8 @@
 import org.enso.interpreter.dsl.BuiltinType;

 @BuiltinType
-public class Polyglot extends Builtin {}
+public final class Polyglot extends Builtin {
+  public Polyglot() {


I'd say we have way too many Builtins. Not sure why Polyglot or Debug should be builtin types at all!?

JaroslavTulach · 2025-01-31T08:45:39Z

engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/BuiltinRootNode.java

+      }
+      if (is(REQUIRES_CAST)) {
+        var ctx = EnsoContext.get(this);
+        if (this.ensoType == null) {


The first time ArgNode is requested to "cast", it searches for the ensoType representing the value of the argument. It would be better to do this when the ArgNode is being created, but it may be too early (before Standard.Base types are loaded in), so I haven't even tried.

Opinions?

JaroslavTulach · 2025-01-31T08:46:17Z

I believe the code is in shape to receive some inception review.

Akirathan

Generally looks like a good idea. Before merging, please don't forget to benchmark it. I am interested what will be the impact on performance.

lib/scala/interpreter-dsl/src/main/java/org/enso/interpreter/dsl/BuiltinsProcessor.java

engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/BuiltinRootNode.java

Akirathan · 2025-02-03T10:48:40Z

engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/BuiltinRootNode.java

+        flags |= IS_SELF;
+      }
+      if (isArray) {
+        flags |= IS_ARRAY;


What is the purpose of IS_ARRAY? It seems that it is not used anywhere

I have no idea! All I know: it was there. CCing @hubertp.

Run whole test/Base_Tests with NI #10296

Maybe it is unused since I removed StandardOption array support.

…nArgNode11827

…into wip/jtulach/BuiltinArgNode11827

…nArgNode11827

JaroslavTulach · 2025-02-04T08:43:33Z

test/Base_Tests/src/Semantic/Warnings_Spec.enso


        slice = res.slice 1 4
-        Warning.get_all slice wrap_errors=True . map .value . should_equal [(Map_Error.Error 3 'warn4'), (Map_Error.Error 2 'warn3'), (Map_Error.Error 1 'warn2'), (Map_Error.Error 0 'warn1')]
+        slice_warn = Warning.get_all slice wrap_errors=True


We need 91d3584 for this slice checks to pass:

slice itself hasWarnings, but only internally

slice isn't wrapped with WithWarnings

the checks here rely on slice having the warnings only internally

I am not sure whether checking only for WithWarnings is desirable behavior or just an oversight caused by the generator code being written sooner than WarningsLibrary introduced. Options, @hubertp?

…nArgNode11827

Use BuiltinRootNode.ArgNode to extract argument for a builtin method

e261e8d

JaroslavTulach added the CI: No changelog needed Do not require a changelog entry for this PR. label Jan 30, 2025

JaroslavTulach self-assigned this Jan 30, 2025

JaroslavTulach requested review from 4e6, hubertp and Akirathan as code owners January 30, 2025 19:57

JaroslavTulach marked this pull request as draft January 30, 2025 19:57

JaroslavTulach added the CI: Clean build required CI runners will be cleaned before and after this PR is built. label Jan 30, 2025

Gathering info from all arguments via ArgContext

5847b0f

enso-bot bot mentioned this pull request Jan 31, 2025

Calling a method that returns 'itself' on a multi-value should not lose multi-value structure? #12143

Closed

JaroslavTulach mentioned this pull request Jan 31, 2025

Polish to_text on intersection types #12192

Draft

3 tasks

JaroslavTulach added 6 commits January 31, 2025 04:47

Compressing flags into a byte

b646932

Only convert when is(REQUIRES_CAST)

20fa9c3

Process warnings in ArgNode

731f3bb

Generate ArgNode for each positional argument

ecb74c5

Cleaning up to address IDE's lints

0925fa2

Allow null return value from processArgument

24fe8da

JaroslavTulach commented Jan 31, 2025

View reviewed changes

JaroslavTulach requested a review from GregoryTravis January 31, 2025 08:35

JaroslavTulach commented Jan 31, 2025

View reviewed changes

JaroslavTulach marked this pull request as ready for review January 31, 2025 08:46

Removing unused variable

f60457c

Akirathan approved these changes Feb 3, 2025

View reviewed changes

JaroslavTulach added 3 commits February 3, 2025 15:23

Merge remote-tracking branch 'origin/develop' into wip/jtulach/Builti…

feb75d0

…nArgNode11827

Removing commented out code

8f652cb

Merge branch 'wip/jtulach/BuiltinArgNode11827' of enso:enso-org/enso …

01be17a

…into wip/jtulach/BuiltinArgNode11827

JaroslavTulach added 3 commits February 4, 2025 07:25

Merge remote-tracking branch 'origin/develop' into wip/jtulach/Builti…

f0480f7

…nArgNode11827

Insert the node when adding it as a @child

e2571a1

Only process WithWarnings to be compatible with Warnings_Spec

91d3584

JaroslavTulach requested review from jdunkerley, radeusgd, AdRiley and marthasharkey as code owners February 4, 2025 08:38

JaroslavTulach commented Feb 4, 2025

View reviewed changes

JaroslavTulach added 5 commits February 4, 2025 10:18

Introducing generateArguments again

847bd99

Fixing RuntimeErrorsTest

7be3262

Avoid cast when type is Object

d6d859a

Throw the sentinal to make RuntimeVisualizationsTest happier

4ca2226

Only generate ArgNode for positional argument

13fc5fe

JaroslavTulach mentioned this pull request Feb 4, 2025

Fix artifact upload in benchmark jobs #12226

Merged

6 tasks

Merge remote-tracking branch 'origin/develop' into wip/jtulach/Builti…

3579139

…nArgNode11827

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use `BuiltinRootNode.ArgNode` to extract argument for a builtin method #12201

Use `BuiltinRootNode.ArgNode` to extract argument for a builtin method #12201

JaroslavTulach commented Jan 30, 2025 •

edited

Loading

JaroslavTulach Jan 31, 2025

JaroslavTulach commented Jan 31, 2025

JaroslavTulach commented Jan 31, 2025

JaroslavTulach Jan 31, 2025

JaroslavTulach Jan 31, 2025

JaroslavTulach commented Jan 31, 2025 •

edited

Loading

Akirathan left a comment

Akirathan Feb 3, 2025

JaroslavTulach Feb 3, 2025 •

edited

Loading

JaroslavTulach Feb 4, 2025 •

edited

Loading

Use BuiltinRootNode.ArgNode to extract argument for a builtin method #12201

Are you sure you want to change the base?

Use BuiltinRootNode.ArgNode to extract argument for a builtin method #12201

Conversation

JaroslavTulach commented Jan 30, 2025 • edited Loading

Pull Request Description

Checklist

JaroslavTulach Jan 31, 2025

Choose a reason for hiding this comment

JaroslavTulach commented Jan 31, 2025

JaroslavTulach commented Jan 31, 2025

JaroslavTulach Jan 31, 2025

Choose a reason for hiding this comment

JaroslavTulach Jan 31, 2025

Choose a reason for hiding this comment

JaroslavTulach commented Jan 31, 2025 • edited Loading

Akirathan left a comment

Choose a reason for hiding this comment

Akirathan Feb 3, 2025

Choose a reason for hiding this comment

JaroslavTulach Feb 3, 2025 • edited Loading

Choose a reason for hiding this comment

JaroslavTulach Feb 4, 2025 • edited Loading

Choose a reason for hiding this comment

Use `BuiltinRootNode.ArgNode` to extract argument for a builtin method #12201

Use `BuiltinRootNode.ArgNode` to extract argument for a builtin method #12201

JaroslavTulach commented Jan 30, 2025 •

edited

Loading

JaroslavTulach commented Jan 31, 2025 •

edited

Loading

JaroslavTulach Feb 3, 2025 •

edited

Loading

JaroslavTulach Feb 4, 2025 •

edited

Loading