[GR-28932] Add support for always-inlined builtins and always inline #__send__, #send and #public_send

PullRequest: truffleruby/2392

Author: eregon

spec/ruby/core/kernel/public_send_spec.rb

@@ -104,5 +104,13 @@ def bar
     }.should raise_error(NoMethodError)
   end
 
+  it "includes `public_send` in the backtrace when passed not enough arguments" do
+    -> { public_send() }.should raise_error(ArgumentError) { |e| e.backtrace[0].should.include?("`public_send'") }
+  end
+
+  it "includes `public_send` in the backtrace when passed a single incorrect argument" do
+    -> { public_send(Object.new) }.should raise_error(TypeError) { |e| e.backtrace[0].should.include?("`public_send'") }
+  end
+
   it_behaves_like :basicobject_send, :public_send
 end

spec/truffle/always_inlined_spec.rb

@@ -0,0 +1,79 @@
+# Copyright (c) 2021 Oracle and/or its affiliates. All rights reserved. This
+# code is released under a tri EPL/GPL/LGPL license. You can use it,
+# redistribute it and/or modify it under the terms of the:
+#
+# Eclipse Public License version 2.0, or
+# GNU General Public License version 2, or
+# GNU Lesser General Public License version 2.1.
+
+require_relative '../ruby/spec_helper'
+
+# This spec can also run on CRuby, for comparison
+describe "Always-inlined core methods" do
+  describe "are part of the backtrace if the error happens inside that core method" do
+    it "for #public_send" do
+      -> {
+        public_send()
+      }.should raise_error(ArgumentError) { |e| e.backtrace_locations[0].label.should == 'public_send' }
+      -> {
+        public_send(Object.new)
+      }.should raise_error(TypeError) { |e| e.backtrace_locations[0].label.should == 'public_send' }
+    end
+
+    guard -> { RUBY_ENGINE != "ruby" } do
+      it "for #send" do
+        -> {
+          send()
+        }.should raise_error(ArgumentError) { |e| e.backtrace_locations[0].label.should == '__send__' }
+        -> {
+          send(Object.new)
+        }.should raise_error(TypeError) { |e| e.backtrace_locations[0].label.should == '__send__' }
+      end
+
+      it "for #__send__" do
+        -> {
+          __send__()
+        }.should raise_error(ArgumentError) { |e| e.backtrace_locations[0].label.should == '__send__' }
+        -> {
+          __send__(Object.new)
+        }.should raise_error(TypeError) { |e| e.backtrace_locations[0].label.should == '__send__' }
+      end
+    end
+  end
+
+  describe "are not part of the backtrace if the error happens in a different method" do
+    it "for #public_send" do
+      -> {
+        public_send(:yield_self) { raise "foo" }
+      }.should raise_error(RuntimeError, "foo") { |e|
+        e.backtrace_locations[0].label.should.start_with?('block (5 levels)')
+        e.backtrace_locations[1].label.should == 'yield_self'
+        if RUBY_ENGINE == 'ruby'
+          e.backtrace_locations[2].label.should == 'public_send'
+        else
+          e.backtrace_locations[2].label.should.start_with?('block (4 levels)')
+        end
+      }
+    end
+
+    it "for #send" do
+      -> {
+        send(:yield_self) { raise "foo" }
+      }.should raise_error(RuntimeError, "foo") { |e|
+        e.backtrace_locations[0].label.should.start_with?('block (5 levels)')
+        e.backtrace_locations[1].label.should == 'yield_self'
+        e.backtrace_locations[2].label.should.start_with?('block (4 levels)')
+      }
+    end
+
+    it "for #__send__" do
+      -> {
+        __send__(:yield_self) { raise "foo" }
+      }.should raise_error(RuntimeError, "foo") { |e|
+        e.backtrace_locations[0].label.should.start_with?('block (5 levels)')
+        e.backtrace_locations[1].label.should == 'yield_self'
+        e.backtrace_locations[2].label.should.start_with?('block (4 levels)')
+      }
+    end
+  end
+end

spec/truffle/binding/of_caller_spec.rb

@@ -14,6 +14,10 @@ def binding_of_caller
     Truffle::Binding.of_caller
   end
 
+  def binding_of_caller_through_send
+    Truffle::Binding.send(:of_caller)
+  end
+
   #it "returns nil if there is no caller"
   #end
 
@@ -34,7 +38,7 @@ def binding_of_caller
 
   it "works through #send" do
     x = 14 # rubocop:disable Lint/UselessAssignment
-    Truffle::Binding.send(:of_caller).local_variable_get(:x).should == 14
+    binding_of_caller_through_send.local_variable_get(:x).should == 14
   end
 
 end

spec/truffle/boot/source_of_caller_spec.rb

@@ -14,6 +14,10 @@ def source_of_caller
     Truffle::Boot.source_of_caller
   end
 
+  def source_of_caller_through_send
+    Truffle::Boot.send(:source_of_caller)
+  end
+
   #it "returns nil if there is no caller"
   #end
 
@@ -26,7 +30,7 @@ def source_of_caller
   end
 
   it "works through #send" do
-    Truffle::Boot.send(:source_of_caller).should == __FILE__
+    source_of_caller_through_send.should == __FILE__
   end
 
 end

src/annotations/java/org/truffleruby/builtins/CoreMethod.java

@@ -38,6 +38,8 @@
      * both a singleton method and instance method. */
     boolean isModuleFunction() default false;
 
+    boolean alwaysInlined() default false;
+
     boolean needsSelf() default true;
 
     int required() default 0;

src/main/java/org/truffleruby/RubyContext.java

@@ -460,6 +460,22 @@ public Object send(Node currentNode, Object object, String methodName, Object...
         }
     }
 
+    @TruffleBoundary
+    public static Object indirectCallWithCallNode(Node currentNode, RootCallTarget callTarget,
+            Object... frameArguments) {
+        if (currentNode.isAdoptable()) {
+            final EncapsulatingNodeReference callNodeRef = EncapsulatingNodeReference.getCurrent();
+            final Node prev = callNodeRef.set(currentNode);
+            try {
+                return IndirectCallNode.getUncached().call(callTarget, frameArguments);
+            } finally {
+                callNodeRef.set(prev);
+            }
+        } else {
+            return IndirectCallNode.getUncached().call(callTarget, frameArguments);
+        }
+    }
+
     public void finalizeContext() {
         if (!initialized) {
             // The RubyContext will be finalized and disposed if patching fails (potentially for

src/main/java/org/truffleruby/builtins/BuiltinsClasses.java

@@ -146,7 +146,7 @@
 import org.truffleruby.interop.InteropNodesFactory;
 import org.truffleruby.interop.PolyglotNodesBuiltins;
 import org.truffleruby.interop.PolyglotNodesFactory;
-import org.truffleruby.language.RubyNode;
+import org.truffleruby.language.RubyBaseNode;
 import org.truffleruby.language.TruffleBootNodesBuiltins;
 import org.truffleruby.language.TruffleBootNodesFactory;
 import org.truffleruby.stdlib.CoverageNodesBuiltins;
@@ -321,7 +321,7 @@ public static void setupBuiltinsLazyPrimitives(PrimitiveManager primitiveManager
     }
 
     // Sorted alphabetically to avoid duplicates
-    public static List<List<? extends NodeFactory<? extends RubyNode>>> getCoreNodeFactories() {
+    public static List<List<? extends NodeFactory<? extends RubyBaseNode>>> getCoreNodeFactories() {
         return Arrays.asList(
                 ArrayIndexNodesFactory.getFactories(),
                 ArrayNodesFactory.getFactories(),