Merge branch 'topic/opt_clean' into 'master'

LKQL JIT optimization

See merge request eng/libadalang/langkit-query-language!506

Author: HugoGGuerrier

lkql/build/railroad-diagrams/term.svg

@@ -1,6 +1,5 @@
 lexer lkql_lexer {
 
-    BigLongRArrow
     @trivia()
     Whitespace <- p"[ \\t\\n\\r]"
     Dot <- "."
@@ -39,57 +38,32 @@ lexer lkql_lexer {
     LArrow <- "<-"
     BigRArrow <- "=>"
     Box <- "<>"
-    @symbol()
-    Let <- "let"
-    @symbol()
-    SelectTok <- "select"
-    @symbol()
-    FromTok <- "from"
-    @symbol()
-    ThroughTok <- "through"
-    @symbol()
-    When <- "when"
-    @symbol()
-    Val <- "val"
-    @symbol()
-    Fun <- "fun"
-    @symbol()
-    Import <- "import"
-    @symbol()
-    Selector <- "selector"
-    @symbol()
-    Match <- "match"
-    @symbol()
-    Rec <- "rec"
-    @symbol()
-    For <- "for"
-    @symbol()
-    Skip <- "skip"
-    @symbol()
-    Is <- "is"
-    @symbol()
-    In <- "in"
-    @symbol()
-    TrueLit <- "true"
-    @symbol()
-    FalseLit <- "false"
-    @symbol()
-    If <- "if"
-    @symbol()
-    Else <- "else"
-    @symbol()
-    Then <- "then"
-    @symbol()
-    Not <- "not"
-    @symbol()
-    Null <- "null"
-    @symbol()
-    New <- "new"
+    @symbol() Let <- "let"
+    @symbol() SelectTok <- "select"
+    @symbol() FromTok <- "from"
+    @symbol() ThroughTok <- "through"
+    @symbol() When <- "when"
+    @symbol() Val <- "val"
+    @symbol() Fun <- "fun"
+    @symbol() Import <- "import"
+    @symbol() Selector <- "selector"
+    @symbol() Match <- "match"
+    @symbol() Rec <- "rec"
+    @symbol() For <- "for"
+    @symbol() Skip <- "skip"
+    @symbol() Is <- "is"
+    @symbol() In <- "in"
+    @symbol() TrueLit <- "true"
+    @symbol() FalseLit <- "false"
+    @symbol() If <- "if"
+    @symbol() Else <- "else"
+    @symbol() Then <- "then"
+    @symbol() Not <- "not"
+    @symbol() Null <- "null"
+    @symbol() New <- "new"
     Integer <- p"[0-9]+"
-    @symbol()
-    Identifier <- p"[a-z][A-Za-z0-9_]*"
-    @symbol()
-    UpperIdentifier <- p"[A-Za-z][A-Za-z0-9_]*"
+    @symbol() Identifier <- p"[a-z][A-Za-z0-9_]*"
+    @symbol() UpperIdentifier <- p"[A-Za-z][A-Za-z0-9_]*"
     String <- p"\"(\\\\.|[^\"])*\""
     @trivia()
     Comment <- p"#(.?)+"
@@ -245,10 +219,10 @@ grammar lkql_grammar {
         | string_literal
         | block_string_literal
         | bool_literal
-        | unit_literal
         | NullLiteral("null")
         | integer
         | anonymous_function
+        | unit_literal
         | pick("(" expr ")")
         | if_then_else
         | block_expr

lkql/lkql.lkt

@@ -4,6 +4,8 @@
 |" These functions may be moved in the future in Libadalang or LKQL's builtin
 |" library.
 
+import stdlib_internal
+
 selector super_types
     |" Yields the chain of super types of the given type, as viewed from that
     |" type. Hence, for a type T which public view derives from a type A but
@@ -33,15 +35,10 @@ selector semantic_parent
     | null     => ()
     | *        => rec(this.p_semantic_parent())
 
-selector children_no_nested
+fun children_no_nested(node) =
     |" Return all children nodes starting from a base subprogram body, but not
     |" entering in nested bodies.
-
-    | BodyNode =>
-        # Don't recurse on bodies except if it's the root node (depth == 0)
-        rec(*if depth == 0 then this.children else [])
-    | null     => ()
-    | *        => rec(*this.children)
+    stdlib_internal.children_no_nested_implem((node, true))
 
 fun all(iterable) =
     |" Return whether all elements in the given iterable are truthy

lkql_checker/share/lkql/stdlib.lkql

@@ -0,0 +1,9 @@
+selector children_no_nested_implem
+    |" Internal implementation selector for `children_no_nested`
+    # Don't recurse on bodies except if it's the root node (depth == 0)
+    | (BodyNode, false) => rec(())
+    | (n@AdaNode, *) => rec(*[(c, false) for c in n.children], *n.children)
+
+    # TODO: This branch shouldn't ever be taken, but we miss a raise expression
+    # to verify it
+    | *     => rec(())

lkql_checker/share/lkql/stdlib_internal.lkql

@@ -12,7 +12,16 @@
 /** This class is the base for all Truffle benchmarks. */
 @Warmup(iterations = 5, time = 1)
 @Measurement(iterations = 5, time = 1)
-@Fork(value = 1, jvmArgsAppend = "-Dgraalvm.locatorDisabled=true")
+@Fork(
+    value = 1,
+    jvmArgsAppend = {
+        "-Dgraalvm.locatorDisabled=true",
+        // NOTE: If you need to debug truffle benchmarks you can add the following options
+        // "-Dgraal.Dump=Truffle:1",
+        // "-Dgraal.PrintGraph=Network",
+        "--add-opens=org.graalvm.truffle/com.oracle.truffle.api.strings=ALL-UNNAMED",
+    }
+)
 @BenchmarkMode(Mode.AverageTime)
 @OutputTimeUnit(TimeUnit.MICROSECONDS)
 @State(Scope.Benchmark)
@@ -27,9 +36,18 @@ public class TruffleBenchmark {
 
     @Setup
     public void setup() {
-        this.context = Context.create();
+        final var contextBuilder = Context.newBuilder("lkql", "js", "sl");
+        configure(contextBuilder);
+        context = contextBuilder.build();
+        pre();
     }
 
+    /** Provide a hook to pass custom options to the contextBuilder in benchmarks */
+    public void configure(Context.Builder contextBuilder) {}
+
+    /** Provide a hook to run arbitrary setup code before running the benchmark */
+    public void pre() {}
+
     @TearDown
     public void tearDown() {
         this.context.close();

lkql_jit/benchmarks/src/test/java/com/adacore/lkql_jit/TruffleBenchmark.java

@@ -0,0 +1,64 @@
+//
+//  Copyright (C) 2005-2025, AdaCore
+//  SPDX-License-Identifier: GPL-3.0-or-later
+//
+
+package com.adacore.lkql_jit.benchmarks;
+
+import com.adacore.lkql_jit.TruffleBenchmark;
+import org.openjdk.jmh.annotations.Benchmark;
+
+public class ClosureBenchmark extends TruffleBenchmark {
+
+    private static final String lkqlClosure =
+        """
+        fun foo(v) = {
+            fun bar(w) = {
+                fun baz(x) = {
+                    v + w + x
+                };
+                baz
+            };
+            bar
+        }
+
+        val clos = foo(12)(13)
+        fun r() = clos(14)
+        repeat(1000000, r)
+            """;
+
+    private static final String jsClosure =
+        """
+        function foo(v) {
+            function bar(w) {
+                function baz(x) {
+                    return v + w + x;
+                }
+                return baz;
+            }
+            return bar;
+        }
+
+        var clos = foo(12)(13)
+
+        function r() {
+            return clos(14)
+        }
+
+        for (let i = 0; i < 1000000; i++) {
+            r()
+        }
+            """;
+
+    // ----- Benchmark methods -----
+
+    @Benchmark
+    public void truffle_lkql() {
+        this.context.eval("lkql", lkqlClosure);
+    }
+
+    @Benchmark
+    public void truffle_js() {
+        this.context.eval("js", jsClosure);
+    }
+}

lkql_jit/benchmarks/src/test/java/com/adacore/lkql_jit/benchmarks/ClosureBenchmark.java

@@ -0,0 +1,54 @@
+//
+//  Copyright (C) 2005-2025, AdaCore
+//  SPDX-License-Identifier: GPL-3.0-or-later
+//
+
+package com.adacore.lkql_jit.benchmarks;
+
+import com.adacore.lkql_jit.TruffleBenchmark;
+import org.openjdk.jmh.annotations.Benchmark;
+
+public class ClosureCreationBenchmark extends TruffleBenchmark {
+
+    @Benchmark
+    public void truffle_js() {
+        this.context.eval(
+                "js",
+                """
+                function foo(v) {
+                    function bar(w) {
+                        function baz(x) {
+                            return v + w + x;
+                        }
+                        return baz;
+                    }
+                    return bar;
+                }
+
+                for (let i = 0; i < 10000; i++) {
+                    foo(12)(13)(14)
+                }
+                        """
+            );
+    }
+
+    @Benchmark
+    public void truffle_lkql() {
+        this.context.eval(
+                "lkql",
+                """
+                fun foo(v) = {
+                    fun bar(w) = {
+                        fun baz(x) = {
+                            v + w + x
+                        };
+                        baz
+                    };
+                    bar
+                }
+
+                repeat(10000, () => foo(12)(13)(14))
+                        """
+            );
+    }
+}

lkql_jit/benchmarks/src/test/java/com/adacore/lkql_jit/benchmarks/ClosureCreationBenchmark.java

@@ -32,9 +32,7 @@ public abstract class BaseLKQLChecker extends AbstractLanguageLauncher {
     public static final String checkerSource =
         """
         val analysis_units = specified_units()
-        val roots = [unit.root for unit in analysis_units]
-
-        map(roots, (root) => node_checker(root))
+        map(analysis_units, (unit) => node_checker(unit.root))
         map(analysis_units, (unit) => unit_checker(unit))
         """;