[GR-15903] [GR-15993] Fix FFI coercion and add missing FFI::Pointer#clear.

PullRequest: truffleruby/854

Author: eregon

CHANGELOG.md

@@ -11,11 +11,13 @@ Bug fixes:
 * Calling `Kernel#raise` with a raised exception will no longer set the cause of the exception to itself (#1682).
 * Return a `FFI::Function` correctly for functions returning a callback.
 * Convert to intuitive Ruby exceptions when INVOKE fails (#1690).
+* Implemented `FFI::Pointer#clear` (#1687).
 
 Compatibility
 
 * `String#-@` now performs string deduplication (#1608).
 * `Hash#merge` now preserves the key order from the original hash for merged values (#1650).
+* Coerce values given to `FFI::Pointer` methods.
 
 Changes:
 

spec/ffi/struct_spec.rb

@@ -129,6 +129,19 @@ class StringMember < FFI::Struct
     expect(s[:string]).to be_nil
   end
 
+  it "Struct#clear sets the memory to zero" do
+    klass = Class.new(FFI::Struct) do
+      layout :a, :int, :b, :long
+    end
+
+    s = klass.new
+    s[:a] = 1
+    s[:b] = 2
+    s.clear
+    expect(s[:a]).to eq(0)
+    expect(s[:b]).to eq(0)
+  end
+
   it "Struct#layout works with :name, :type pairs" do
     class PairLayout < FFI::Struct
       layout :a, :int, :b, :long_long
@@ -326,6 +339,17 @@ def test_num_field(type, v)
     expect(s.pointer.send("get_#{type.to_s}", 0)).to eq(v)
     s.pointer.send("put_#{type.to_s}", 0, 0)
     expect(s[:v]).to eq(0)
+
+    # Test coercion
+    obj = double("coerce")
+    expect(obj).to receive(:to_int).and_return(v)
+    s[:v] = obj
+    expect(s.pointer.send("get_#{type.to_s}", 0)).to eq(v)
+
+    zero = double("zero")
+    expect(zero).to receive(:to_int).and_return(0)
+    s.pointer.send("put_#{type.to_s}", 0, zero)
+    expect(s[:v]).to eq(0)
   end
   def self.int_field_test(type, values)
     values.each do |v|
@@ -358,6 +382,15 @@ def self.int_field_test(type, values)
     value = 1.23456
     s[:v] = value
     expect((s.pointer.get_float(0) - value).abs).to be < 0.0001
+
+    # Test coercion
+    obj = double("coerce")
+    expect(obj).to receive(:to_f).and_return(42.0)
+    s[:v] = obj
+    expect((s.pointer.get_float(0) - 42.0).abs).to be < 0.0001
+
+    s.pointer.put_float(0, 1.0)
+    expect(s.pointer.get_float(0)).to eq(1.0)
   end
 
   it ":double field r/w" do
@@ -368,6 +401,15 @@ def self.int_field_test(type, values)
     value = 1.23456
     s[:v] = value
     expect((s.pointer.get_double(0) - value).abs).to be < 0.0001
+
+    # Test coercion
+    obj = double("coerce")
+    expect(obj).to receive(:to_f).and_return(42.0)
+    s[:v] = obj
+    expect((s.pointer.get_double(0) - 42.0).abs).to be < 0.0001
+
+    s.pointer.put_double(0, 1.0)
+    expect(s.pointer.get_double(0)).to eq(1.0)
   end
   module EnumFields
     extend FFI::Library

src/main/ruby/core/truffle/ffi/pointer.rb

@@ -86,6 +86,11 @@ def initialize_copy(from)
       self
     end
 
+    def clear
+      raise RuntimeError, 'cannot clear unbounded memory area' unless @total
+      Truffle.invoke_primitive :pointer_clear, self, @total
+    end
+
     def inspect
       # Don't have this print the data at the location. It can crash everything.
       addr = address()

src/main/ruby/core/truffle/ffi/pointer_access.rb

@@ -45,7 +45,7 @@ def read_char
   alias :read_int8 :read_char
 
   def write_char(value)
-    Truffle.invoke_primitive :pointer_write_char, address, value
+    Truffle.invoke_primitive :pointer_write_char, address, Truffle::Type.rb_to_int(value)
     self
   end
   alias :write_int8 :write_char
@@ -56,7 +56,7 @@ def get_char(offset)
   alias :get_int8 :get_char
 
   def put_char(offset, value)
-    Truffle.invoke_primitive :pointer_write_char, address + offset, value
+    Truffle.invoke_primitive :pointer_write_char, address + offset, Truffle::Type.rb_to_int(value)
     self
   end
   alias :put_int8 :put_char
@@ -70,7 +70,7 @@ def read_array_of_char(length)
 
   def write_array_of_char(ary)
     ary.each_with_index do |value, i|
-      Truffle.invoke_primitive :pointer_write_char, address + (i * 1), value
+      Truffle.invoke_primitive :pointer_write_char, address + (i * 1), Truffle::Type.rb_to_int(value)
     end
     self
   end
@@ -95,7 +95,7 @@ def read_uchar
   alias :read_uint8 :read_uchar
 
   def write_uchar(value)
-    Truffle.invoke_primitive :pointer_write_uchar, address, value
+    Truffle.invoke_primitive :pointer_write_uchar, address, Truffle::Type.rb_to_int(value)
     self
   end
   alias :write_uint8 :write_uchar
@@ -106,7 +106,7 @@ def get_uchar(offset)
   alias :get_uint8 :get_uchar
 
   def put_uchar(offset, value)
-    Truffle.invoke_primitive :pointer_write_uchar, address + offset, value
+    Truffle.invoke_primitive :pointer_write_uchar, address + offset, Truffle::Type.rb_to_int(value)
     self
   end
   alias :put_uint8 :put_uchar
@@ -120,7 +120,7 @@ def read_array_of_uchar(length)
 
   def write_array_of_uchar(ary)
     ary.each_with_index do |value, i|
-      Truffle.invoke_primitive :pointer_write_uchar, address + (i * 1), value
+      Truffle.invoke_primitive :pointer_write_uchar, address + (i * 1), Truffle::Type.rb_to_int(value)
     end
     self
   end
@@ -145,7 +145,7 @@ def read_short
   alias :read_int16 :read_short
 
   def write_short(value)
-    Truffle.invoke_primitive :pointer_write_short, address, value
+    Truffle.invoke_primitive :pointer_write_short, address, Truffle::Type.rb_to_int(value)
     self
   end
   alias :write_int16 :write_short
@@ -156,7 +156,7 @@ def get_short(offset)
   alias :get_int16 :get_short
 
   def put_short(offset, value)
-    Truffle.invoke_primitive :pointer_write_short, address + offset, value
+    Truffle.invoke_primitive :pointer_write_short, address + offset, Truffle::Type.rb_to_int(value)
     self
   end
   alias :put_int16 :put_short
@@ -170,7 +170,7 @@ def read_array_of_short(length)
 
   def write_array_of_short(ary)
     ary.each_with_index do |value, i|
-      Truffle.invoke_primitive :pointer_write_short, address + (i * 2), value
+      Truffle.invoke_primitive :pointer_write_short, address + (i * 2), Truffle::Type.rb_to_int(value)
     end
     self
   end
@@ -195,7 +195,7 @@ def read_ushort
   alias :read_uint16 :read_ushort
 
   def write_ushort(value)
-    Truffle.invoke_primitive :pointer_write_ushort, address, value
+    Truffle.invoke_primitive :pointer_write_ushort, address, Truffle::Type.rb_to_int(value)
     self
   end
   alias :write_uint16 :write_ushort
@@ -206,7 +206,7 @@ def get_ushort(offset)
   alias :get_uint16 :get_ushort
 
   def put_ushort(offset, value)
-    Truffle.invoke_primitive :pointer_write_ushort, address + offset, value
+    Truffle.invoke_primitive :pointer_write_ushort, address + offset, Truffle::Type.rb_to_int(value)
     self
   end
   alias :put_uint16 :put_ushort
@@ -220,7 +220,7 @@ def read_array_of_ushort(length)
 
   def write_array_of_ushort(ary)
     ary.each_with_index do |value, i|
-      Truffle.invoke_primitive :pointer_write_ushort, address + (i * 2), value
+      Truffle.invoke_primitive :pointer_write_ushort, address + (i * 2), Truffle::Type.rb_to_int(value)
     end
     self
   end
@@ -245,7 +245,7 @@ def read_int
   alias :read_int32 :read_int
 
   def write_int(value)
-    Truffle.invoke_primitive :pointer_write_int, address, value
+    Truffle.invoke_primitive :pointer_write_int, address, Truffle::Type.rb_to_int(value)
     self
   end
   alias :write_int32 :write_int
@@ -256,7 +256,7 @@ def get_int(offset)
   alias :get_int32 :get_int
 
   def put_int(offset, value)
-    Truffle.invoke_primitive :pointer_write_int, address + offset, value
+    Truffle.invoke_primitive :pointer_write_int, address + offset, Truffle::Type.rb_to_int(value)
     self
   end
   alias :put_int32 :put_int
@@ -270,7 +270,7 @@ def read_array_of_int(length)
 
   def write_array_of_int(ary)
     ary.each_with_index do |value, i|
-      Truffle.invoke_primitive :pointer_write_int, address + (i * 4), value
+      Truffle.invoke_primitive :pointer_write_int, address + (i * 4), Truffle::Type.rb_to_int(value)
     end
     self
   end
@@ -295,7 +295,7 @@ def read_uint
   alias :read_uint32 :read_uint
 
   def write_uint(value)
-    Truffle.invoke_primitive :pointer_write_uint, address, value
+    Truffle.invoke_primitive :pointer_write_uint, address, Truffle::Type.rb_to_int(value)
     self
   end
   alias :write_uint32 :write_uint
@@ -306,7 +306,7 @@ def get_uint(offset)
   alias :get_uint32 :get_uint
 
   def put_uint(offset, value)
-    Truffle.invoke_primitive :pointer_write_uint, address + offset, value
+    Truffle.invoke_primitive :pointer_write_uint, address + offset, Truffle::Type.rb_to_int(value)
     self
   end
   alias :put_uint32 :put_uint
@@ -320,7 +320,7 @@ def read_array_of_uint(length)
 
   def write_array_of_uint(ary)
     ary.each_with_index do |value, i|
-      Truffle.invoke_primitive :pointer_write_uint, address + (i * 4), value
+      Truffle.invoke_primitive :pointer_write_uint, address + (i * 4), Truffle::Type.rb_to_int(value)
     end
     self
   end
@@ -346,7 +346,7 @@ def read_long
   alias :read_long_long :read_long
 
   def write_long(value)
-    Truffle.invoke_primitive :pointer_write_long, address, value
+    Truffle.invoke_primitive :pointer_write_long, address, Truffle::Type.rb_to_int(value)
     self
   end
   alias :write_int64 :write_long
@@ -359,7 +359,7 @@ def get_long(offset)
   alias :get_long_long :get_long
 
   def put_long(offset, value)
-    Truffle.invoke_primitive :pointer_write_long, address + offset, value
+    Truffle.invoke_primitive :pointer_write_long, address + offset, Truffle::Type.rb_to_int(value)
     self
   end
   alias :put_int64 :put_long
@@ -375,7 +375,7 @@ def read_array_of_long(length)
 
   def write_array_of_long(ary)
     ary.each_with_index do |value, i|
-      Truffle.invoke_primitive :pointer_write_long, address + (i * 8), value
+      Truffle.invoke_primitive :pointer_write_long, address + (i * 8), Truffle::Type.rb_to_int(value)
     end
     self
   end
@@ -404,7 +404,7 @@ def read_ulong
   alias :read_ulong_long :read_ulong
 
   def write_ulong(value)
-    Truffle.invoke_primitive :pointer_write_ulong, address, value
+    Truffle.invoke_primitive :pointer_write_ulong, address, Truffle::Type.rb_to_int(value)
     self
   end
   alias :write_uint64 :write_ulong
@@ -417,7 +417,7 @@ def get_ulong(offset)
   alias :get_ulong_long :get_ulong
 
   def put_ulong(offset, value)
-    Truffle.invoke_primitive :pointer_write_ulong, address + offset, value
+    Truffle.invoke_primitive :pointer_write_ulong, address + offset, Truffle::Type.rb_to_int(value)
     self
   end
   alias :put_uint64 :put_ulong
@@ -433,7 +433,7 @@ def read_array_of_ulong(length)
 
   def write_array_of_ulong(ary)
     ary.each_with_index do |value, i|
-      Truffle.invoke_primitive :pointer_write_ulong, address + (i * 8), value
+      Truffle.invoke_primitive :pointer_write_ulong, address + (i * 8), Truffle::Type.rb_to_int(value)
     end
     self
   end
@@ -461,7 +461,7 @@ def read_float
   alias :read_float32 :read_float
 
   def write_float(value)
-    Truffle.invoke_primitive :pointer_write_float, address, value
+    Truffle.invoke_primitive :pointer_write_float, address, Truffle::Type.rb_to_f(value)
     self
   end
   alias :write_float32 :write_float
@@ -472,7 +472,7 @@ def get_float(offset)
   alias :get_float32 :get_float
 
   def put_float(offset, value)
-    Truffle.invoke_primitive :pointer_write_float, address + offset, value
+    Truffle.invoke_primitive :pointer_write_float, address + offset, Truffle::Type.rb_to_f(value)
     self
   end
   alias :put_float32 :put_float
@@ -486,7 +486,7 @@ def read_array_of_float(length)
 
   def write_array_of_float(ary)
     ary.each_with_index do |value, i|
-      Truffle.invoke_primitive :pointer_write_float, address + (i * 4), value
+      Truffle.invoke_primitive :pointer_write_float, address + (i * 4), Truffle::Type.rb_to_f(value)
     end
     self
   end
@@ -511,7 +511,7 @@ def read_double
   alias :read_float64 :read_double
 
   def write_double(value)
-    Truffle.invoke_primitive :pointer_write_double, address, value
+    Truffle.invoke_primitive :pointer_write_double, address, Truffle::Type.rb_to_f(value)
     self
   end
   alias :write_float64 :write_double
@@ -522,7 +522,7 @@ def get_double(offset)
   alias :get_float64 :get_double
 
   def put_double(offset, value)
-    Truffle.invoke_primitive :pointer_write_double, address + offset, value
+    Truffle.invoke_primitive :pointer_write_double, address + offset, Truffle::Type.rb_to_f(value)
     self
   end
   alias :put_float64 :put_double
@@ -536,7 +536,7 @@ def read_array_of_double(length)
 
   def write_array_of_double(ary)
     ary.each_with_index do |value, i|
-      Truffle.invoke_primitive :pointer_write_double, address + (i * 8), value
+      Truffle.invoke_primitive :pointer_write_double, address + (i * 8), Truffle::Type.rb_to_f(value)
     end
     self
   end