[GR-19220] Implement rb_get_alloc_func and spec related functions (#1874).

PullRequest: truffleruby/1232

Author: eregon

CHANGELOG.md

@@ -81,6 +81,7 @@ Compatibility:
 * Implemented `rb_module_new`, `rb_define_class_id`, `rb_define_module_id`, (#1876, @chrisseaton).
 * Implemented `-n` CLI option (#1532).
 * Cache the `Symbol` of method names in call nodes only when needed (#1872).
+* Implemented `rb_get_alloc_func` and related functions (#1874, @XrXr).
 
 Performance:
 

lib/truffle/truffle/cext.rb

@@ -14,6 +14,7 @@ module Truffle::CExt
   DATA_HOLDER = Object.new
   DATA_MEMSIZER = Object.new
   RB_TYPE = Object.new
+  ALLOCATOR_FUNC = Object.new
 
   extend self
 
@@ -350,13 +351,14 @@ def rb_tr_find_type(value)
     when Symbol
       T_SYMBOL
     when Integer
-      #rb_tr_cached_type. The final type must be calculated for each number.
+      # See #rb_tr_cached_type, the final type must be calculated for each number.
       T_FIXNUM
     when Time
       T_DATA
     when Data
       T_DATA
     when BasicObject
+      # See #rb_tr_cached_type, the final type must be calculated for each object.
       T_NONE
     else
       raise "unknown type #{value.class}"
@@ -1282,17 +1284,37 @@ def rb_eval_string(str)
     eval(str)
   end
 
+  def rb_newobj_of(ruby_class)
+    ruby_class.__send__(:__layout_allocate__)
+  end
+
   def rb_define_alloc_func(ruby_class, function)
     ruby_class.singleton_class.define_method(:__allocate__) do
       TrufflePrimitive.cext_unwrap(TrufflePrimitive.call_with_c_mutex(function, [TrufflePrimitive.cext_wrap(self)]))
     end
     class << ruby_class
       private :__allocate__
     end
+    hidden_variable_set(ruby_class.singleton_class, ALLOCATOR_FUNC, function)
+  end
+
+  def rb_get_alloc_func(ruby_class)
+    return nil unless Class === ruby_class
+    begin
+      allocate_method = ruby_class.method(:__allocate__).owner
+    rescue NameError
+      nil
+    else
+      hidden_variable_get(allocate_method, ALLOCATOR_FUNC)
+    end
   end
 
   def rb_undef_alloc_func(ruby_class)
     ruby_class.singleton_class.send(:undef_method, :__allocate__)
+  rescue NameError
+    nil # it's fine to call this on a class that doesn't have an allocator
+  else
+    hidden_variable_set(ruby_class.singleton_class, ALLOCATOR_FUNC, nil)
   end
 
   def rb_alias(mod, new_name, old_name)
@@ -1436,11 +1458,9 @@ def rb_nativethread_lock_destroy(lock)
     NATIVETHREAD_LOCKS.delete(lock)
   end
 
-  BASIC_OBJECT_ALLOCATE = BasicObject.method(:__allocate__).unbind
-
   def rb_data_object_wrap(ruby_class, data, mark, free)
     ruby_class = Object unless ruby_class
-    object = BASIC_OBJECT_ALLOCATE.bind(ruby_class).call
+    object = ruby_class.__send__(:__layout_allocate__)
     data_holder = DataHolder.new(data)
     hidden_variable_set object, DATA_HOLDER, data_holder
     ObjectSpace.define_finalizer object, data_finalizer(free, data_holder) unless free.nil?
@@ -1450,7 +1470,7 @@ def rb_data_object_wrap(ruby_class, data, mark, free)
 
   def rb_data_typed_object_wrap(ruby_class, data, data_type, mark, free, size)
     ruby_class = Object unless ruby_class
-    object = BASIC_OBJECT_ALLOCATE.bind(ruby_class).call
+    object = ruby_class.__send__(:__layout_allocate__)
     data_holder = DataHolder.new(data)
     hidden_variable_set object, :data_type, data_type
     hidden_variable_set object, DATA_HOLDER, data_holder

spec/ruby/optional/capi/ext/object_spec.c

@@ -345,6 +345,39 @@ static VALUE object_spec_rb_class_inherited_p(VALUE self, VALUE mod, VALUE arg)
   return rb_class_inherited_p(mod, arg);
 }
 
+static VALUE speced_allocator(VALUE klass) {
+  VALUE flags = 0;
+  if (rb_class_inherited_p(klass, rb_cString)) {
+    flags = T_STRING;
+  } else if (rb_class_inherited_p(klass, rb_cArray)) {
+    flags = T_ARRAY;
+  } else {
+    flags = T_OBJECT;
+  }
+  VALUE instance = rb_newobj_of(klass, flags);
+  rb_iv_set(instance, "@from_custom_allocator", Qtrue);
+  return instance;
+}
+
+static VALUE define_alloc_func(VALUE self, VALUE klass) {
+  rb_define_alloc_func(klass, speced_allocator);
+  return Qnil;
+}
+
+static VALUE undef_alloc_func(VALUE self, VALUE klass) {
+  rb_undef_alloc_func(klass);
+  return Qnil;
+}
+
+static VALUE speced_allocator_p(VALUE self, VALUE klass) {
+  rb_alloc_func_t allocator = rb_get_alloc_func(klass);
+  return (allocator == speced_allocator) ? Qtrue : Qfalse;
+}
+
+static VALUE custom_alloc_func_p(VALUE self, VALUE klass) {
+  rb_alloc_func_t allocator = rb_get_alloc_func(klass);
+  return allocator ? Qtrue : Qfalse;
+}
 
 void Init_object_spec(void) {
   VALUE cls = rb_define_class("CApiObjectSpecs", rb_cObject);
@@ -412,6 +445,10 @@ void Init_object_spec(void) {
   rb_define_method(cls, "rb_ivar_defined", object_spec_rb_ivar_defined, 2);
   rb_define_method(cls, "rb_copy_generic_ivar", object_spec_rb_copy_generic_ivar, 2);
   rb_define_method(cls, "rb_free_generic_ivar", object_spec_rb_free_generic_ivar, 1);
+  rb_define_method(cls, "rb_define_alloc_func", define_alloc_func, 1);
+  rb_define_method(cls, "rb_undef_alloc_func", undef_alloc_func, 1);
+  rb_define_method(cls, "speced_allocator?", speced_allocator_p, 1);
+  rb_define_method(cls, "custom_alloc_func?", custom_alloc_func_p, 1);
 }
 
 #ifdef __cplusplus

spec/ruby/optional/capi/object_spec.rb

@@ -892,4 +892,78 @@ def reach
       end
     end
   end
+
+  describe "allocator accessors" do
+    describe "rb_define_alloc_func" do
+      it "sets up the allocator" do
+        klass = Class.new
+        @o.rb_define_alloc_func(klass)
+        obj = klass.allocate
+        obj.class.should.equal?(klass)
+        obj.should have_instance_variable(:@from_custom_allocator)
+      end
+
+      it "sets up the allocator for a subclass of String" do
+        klass = Class.new(String)
+        @o.rb_define_alloc_func(klass)
+        obj = klass.allocate
+        obj.class.should.equal?(klass)
+        obj.should have_instance_variable(:@from_custom_allocator)
+        obj.should == ""
+      end
+
+      it "sets up the allocator for a subclass of Array" do
+        klass = Class.new(Array)
+        @o.rb_define_alloc_func(klass)
+        obj = klass.allocate
+        obj.class.should.equal?(klass)
+        obj.should have_instance_variable(:@from_custom_allocator)
+        obj.should == []
+      end
+    end
+
+    describe "rb_get_alloc_func" do
+      it "gets the allocator that is defined directly on a class" do
+        klass = Class.new
+        @o.rb_define_alloc_func(klass)
+        @o.speced_allocator?(Object).should == false
+        @o.speced_allocator?(klass).should == true
+      end
+
+      it "gets the allocator that is inherited" do
+        parent = Class.new
+        @o.rb_define_alloc_func(parent)
+        klass = Class.new(parent)
+        @o.speced_allocator?(Object).should == false
+        @o.speced_allocator?(klass).should == true
+      end
+    end
+
+    describe "rb_undef_alloc_func" do
+      it "makes rb_get_alloc_func() return NULL for a class without a custom allocator" do
+        klass = Class.new
+        @o.rb_undef_alloc_func(klass)
+        @o.custom_alloc_func?(klass).should == false
+      end
+
+      it "undefs the allocator for the class" do
+        klass = Class.new
+        @o.rb_define_alloc_func(klass)
+        @o.speced_allocator?(klass).should == true
+        @o.rb_undef_alloc_func(klass)
+        @o.custom_alloc_func?(klass).should == false
+      end
+
+      it "undefs the allocator for a class that inherits a allocator" do
+        parent = Class.new
+        @o.rb_define_alloc_func(parent)
+        klass = Class.new(parent)
+        @o.speced_allocator?(klass).should == true
+        @o.rb_undef_alloc_func(klass)
+        @o.custom_alloc_func?(klass).should == false
+
+        @o.speced_allocator?(parent).should == true
+      end
+    end
+  end
 end

spec/tags/core/process/exec_tags.txt

@@ -20,3 +20,4 @@ slow:Process.exec with a command array raises an ArgumentError if the Array does
 slow:Process.exec with an options Hash with Integer option keys maps the key to a file descriptor in the child that inherits the file descriptor from the parent specified by the value
 slow:Process.exec with an options Hash with Integer option keys lets the process after exec have specified file descriptor despite close_on_exec
 slow:Process.exec with an options Hash with Integer option keys sets close_on_exec to false on specified fd even when it fails
+jvm(transient, JDK11, since PR 1232):Process.exec with an options Hash with Integer option keys maps the key to a file descriptor in the child that inherits the file descriptor from the parent specified by the value

src/main/c/cext/ruby.c

@@ -3698,7 +3698,7 @@ void rb_remove_method_id(VALUE klass, ID mid) {
 }
 
 rb_alloc_func_t rb_get_alloc_func(VALUE klass) {
-  rb_tr_error("rb_get_alloc_func not implemented");
+  return RUBY_CEXT_INVOKE_NO_WRAP("rb_get_alloc_func", klass);
 }
 
 void rb_clear_constant_cache(void) {
@@ -4680,7 +4680,8 @@ VALUE rb_newobj(void) {
 }
 
 VALUE rb_newobj_of(VALUE klass, VALUE flags) {
-  rb_tr_error("rb_newobj_of not implemented");
+  // ignore flags for now
+  return RUBY_CEXT_INVOKE("rb_newobj_of", klass);
 }
 
 VALUE rb_obj_setup(VALUE obj, VALUE klass, VALUE type) {

src/main/java/org/truffleruby/core/array/ArrayNodes.java

@@ -86,7 +86,7 @@
 @CoreModule(value = "Array", isClass = true)
 public abstract class ArrayNodes {
 
-    @CoreMethod(names = "__allocate__", constructor = true, visibility = Visibility.PRIVATE)
+    @CoreMethod(names = { "__allocate__", "__layout_allocate__" }, constructor = true, visibility = Visibility.PRIVATE)
     public abstract static class AllocateNode extends CoreMethodArrayArgumentsNode {
 
         @Child private AllocateObjectNode allocateNode = AllocateObjectNode.create();

src/main/java/org/truffleruby/core/basicobject/BasicObjectNodes.java

@@ -509,7 +509,7 @@ protected Object send(VirtualFrame frame, Object self, Object name, Object[] arg
     // MRI names it the "allocator function" and it's associated per class and follows the ancestor
     // chain. We use a normal Ruby method, different that Class#allocate as Class#allocate
     // must be able to instantiate any Ruby object and should not be overridden.
-    @CoreMethod(names = "__allocate__", constructor = true, visibility = Visibility.PRIVATE)
+    @CoreMethod(names = { "__allocate__", "__layout_allocate__" }, constructor = true, visibility = Visibility.PRIVATE)
     public abstract static class AllocateNode extends CoreMethodArrayArgumentsNode {
 
         @Child private AllocateObjectNode allocateObjectNode = AllocateObjectNode.create();

src/main/java/org/truffleruby/core/binding/BindingNodes.java

@@ -391,7 +391,7 @@ protected Object sourceLocation(DynamicObject binding,
         }
     }
 
-    @CoreMethod(names = "__allocate__", constructor = true, visibility = Visibility.PRIVATE)
+    @CoreMethod(names = { "__allocate__", "__layout_allocate__" }, constructor = true, visibility = Visibility.PRIVATE)
     public abstract static class AllocateNode extends UnaryCoreMethodNode {
 
         @TruffleBoundary

src/main/java/org/truffleruby/core/encoding/EncodingConverterNodes.java

@@ -147,7 +147,7 @@ private int toJCodingFlags(int flags) {
 
     }
 
-    @CoreMethod(names = "__allocate__", constructor = true, visibility = Visibility.PRIVATE)
+    @CoreMethod(names = { "__allocate__", "__layout_allocate__" }, constructor = true, visibility = Visibility.PRIVATE)
     public abstract static class AllocateNode extends CoreMethodArrayArgumentsNode {
 
         @Child private AllocateObjectNode allocateNode = AllocateObjectNode.create();