ffi 1.11.3 → 1.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 644662e700692019ada112b10a164622c08978bbe2aecfeb38205a43df099e28
-  data.tar.gz: 8699b821c2200c62c49c4265d5ce8b67862f53d71e1a2862b41ed5f44eedad87
+  metadata.gz: c60b8c22daf207353adea897b6142f65ea1bbfcac447ee7da373547d7212c19a
+  data.tar.gz: 7e3438808bbff423f8cd989e44e2c4288e25bf80d96f04c906617f35eab9846a
 SHA512:
-  metadata.gz: 6aee46baf520f91e112a1fdcd40218f51f100b50f56d126a94982d341f38919f3f550831db1c9da569d8457c2b50707654681b06ae6cae48ac4597d927b0569d
-  data.tar.gz: c728916db8dad5ec04403ab9cead139b870f56d3e0a34f0b08ec467f9a153c1f29d2f9ad2e30bb3056476a4dd3d42edebfdfbd9f88477f9e08862601cb3277a0
+  metadata.gz: 439d1b680a2a6d30ebb5957884cc5aad39f708df6fc8616b08ebe5bfa761123bacfe68f3de09773d84f3f521ed40cb0a4844de61a64d5bc9217c7ed3e165f5e9
+  data.tar.gz: 866123b57649213c4bef30f5183955fe443a75e7b4cd57e16048559e5326507540182c86a9b149f64431ff06322066bfb70d3e1ca97e7246fa78425e086bf278

data/.travis.yml

@@ -23,6 +23,8 @@ matrix:
   allow_failures:
     - os: osx
       rvm: ruby-head
+    - os: osx
+      rvm: 2.3.8
   include:
     - name: powerpc
       language: generic

data/CHANGELOG.md

@@ -1,3 +1,30 @@
+1.12.2 / 2020-02-01
+-------------------
+
+* Fix possible segfault at FFI::Struct#[] and []= after GC.compact . #742
+
+
+1.12.1 / 2020-01-14
+-------------------
+
+Added:
+* Add binary gem support for ruby-2.7 on Windows
+
+
+1.12.0 / 2020-01-14
+-------------------
+
+Added:
+* FFI::VERSION is defined as part of `require 'ffi'` now.
+  It is no longer necessary to `require 'ffi/version'` .
+
+Changed:
+* Update libffi to latest master.
+
+Deprecated:
+* Overwriting struct layouts is now warned and will be disallowed in ffi-2.0. #734, #735
+
+
 1.11.3 / 2019-11-25
 -------------------
 

data/Gemfile

@@ -1,9 +1,9 @@
 source 'https://rubygems.org'
 
 group :development do
-  gem 'rake', '~> 12.1'
+  gem 'rake', '~> 13.0'
   gem 'rake-compiler', '~> 1.0.3'
-  gem 'rake-compiler-dock', '~> 0.7.0'
+  gem 'rake-compiler-dock', '~> 1.0'
   gem 'rspec', '~> 3.0'
   gem 'rubygems-tasks', '~> 0.2.4', :require => 'rubygems/tasks'
   gem "rubysl", "~> 2.0", :platforms => 'rbx'

data/README.md

@@ -38,10 +38,19 @@ For less minimalistic and more examples you may look at:
 
 ## Requirements
 
-When installing the gem on CRuby (MRI) or Rubinius, you will need:
+When installing the gem on CRuby (MRI), you will need:
 * A C compiler (e.g., Xcode on macOS, `gcc` or `clang` on everything else)
+Optionally (speeds up installation):
 * The `libffi` library and development headers - this is commonly in the `libffi-dev` or `libffi-devel` packages
 
+The ffi gem comes with a builtin libffi version, which is used, when the system libffi library is not available or too old.
+Use of the system libffi can be enforced by:
+```
+gem install ffi -- --enable-system-libffi        # to install the gem manually
+bundle config build.ffi --enable-system-libffi   # for bundle install
+```
+or prevented by `--disable-system-libffi`.
+
 On Linux systems running with [PaX](https://en.wikipedia.org/wiki/PaX) (Gentoo, Alpine, etc.), FFI may trigger `mprotect` errors. You may need to disable [mprotect](https://en.wikibooks.org/wiki/Grsecurity/Appendix/Grsecurity_and_PaX_Configuration_Options#Restrict_mprotect.28.29) for ruby (`paxctl -m [/path/to/ruby]`) for the time being until a solution is found.
 
 On FreeBSD systems pkgconf must be installed for the gem to be able to compile using clang. Install either via packages `pkg install pkgconf` or from ports via `devel/pkgconf`.

data/ext/ffi_c/Struct.c

@@ -90,7 +90,7 @@ struct_allocate(VALUE klass)
 {
     Struct* s;
     VALUE obj = Data_Make_Struct(klass, Struct, struct_mark, struct_free, s);
-    
+
     s->rbPointer = Qnil;
     s->rbLayout = Qnil;
 
@@ -112,7 +112,7 @@ struct_initialize(int argc, VALUE* argv, VALUE self)
     int nargs;
 
     Data_Get_Struct(self, Struct, s);
-    
+
     nargs = rb_scan_args(argc, argv, "01*", &rbPointer, &rest);
 
     /* Call up into ruby code to adjust the layout */
@@ -127,7 +127,7 @@ struct_initialize(int argc, VALUE* argv, VALUE self)
     }
 
     Data_Get_Struct(s->rbLayout, StructLayout, s->layout);
-    
+
     if (rbPointer != Qnil) {
         s->pointer = MEMORY(rbPointer);
         s->rbPointer = rbPointer;
@@ -148,16 +148,16 @@ struct_initialize_copy(VALUE self, VALUE other)
 {
     Struct* src;
     Struct* dst;
-    
+
     Data_Get_Struct(self, Struct, dst);
     Data_Get_Struct(other, Struct, src);
     if (dst == src) {
         return self;
     }
-    
+
     dst->rbLayout = src->rbLayout;
     dst->layout = src->layout;
-    
+
     /*
      * A new MemoryPointer instance is allocated here instead of just calling
      * #dup on rbPointer, since the Pointer may not know its length, or may
@@ -176,7 +176,7 @@ struct_initialize_copy(VALUE self, VALUE other)
         dst->rbReferences = ALLOC_N(VALUE, dst->layout->referenceFieldCount);
         memcpy(dst->rbReferences, src->rbReferences, dst->layout->referenceFieldCount * sizeof(VALUE));
     }
-        
+
     return self;
 }
 
@@ -279,24 +279,25 @@ store_reference_value(StructField* f, Struct* s, VALUE value)
 }
 
 
-static VALUE
+static StructField *
 struct_field(Struct* s, VALUE fieldName)
 {
     StructLayout* layout = s->layout;
-    VALUE rbField;
-
-    if (likely(SYMBOL_P(fieldName) && st_lookup(layout->fieldSymbolTable, fieldName, (st_data_t *) &rbField))) {
-        return rbField;
-    }
-
-    // TODO does this ever return anything?
-    rbField = rb_hash_aref(layout->rbFieldMap, fieldName);
-    if (rbField == Qnil) {
-        VALUE str = rb_funcall2(fieldName, id_to_s, 0, NULL);
-        rb_raise(rb_eArgError, "No such field '%s'", StringValuePtr(str));
+    struct field_cache_entry *p_ce = FIELD_CACHE_LOOKUP(layout, fieldName);
+
+    /* Do a hash lookup only if cache entry is empty or fieldName is unexpected? */
+    if (unlikely(!SYMBOL_P(fieldName) || !p_ce->fieldName || p_ce->fieldName != fieldName)) {
+        VALUE rbField = rb_hash_aref(layout->rbFieldMap, fieldName);
+        if (unlikely(NIL_P(rbField))) {
+            VALUE str = rb_funcall2(fieldName, id_to_s, 0, NULL);
+            rb_raise(rb_eArgError, "No such field '%s'", StringValuePtr(str));
+        }
+        /* Write the retrieved coder to the cache */
+        p_ce->fieldName = fieldName;
+        p_ce->field = (StructField *) DATA_PTR(rbField);
     }
 
-    return rbField;
+    return p_ce->field;
 }
 
 /*
@@ -308,22 +309,19 @@ static VALUE
 struct_aref(VALUE self, VALUE fieldName)
 {
     Struct* s;
-    VALUE rbField;
     StructField* f;
 
     s = struct_validate(self);
 
-    rbField = struct_field(s, fieldName);
-    f = (StructField *) DATA_PTR(rbField);
-
+    f = struct_field(s, fieldName);
     if (f->get != NULL) {
         return (*f->get)(f, s);
-    
+
     } else if (f->memoryOp != NULL) {
         return (*f->memoryOp->get)(s->pointer, f->offset);
 
     } else {
-    
+        VALUE rbField = rb_hash_aref(s->layout->rbFieldMap, fieldName);
         /* call up to the ruby code to fetch the value */
         return rb_funcall2(rbField, id_get, 1, &s->rbPointer);
     }
@@ -340,22 +338,20 @@ static VALUE
 struct_aset(VALUE self, VALUE fieldName, VALUE value)
 {
     Struct* s;
-    VALUE rbField;
     StructField* f;
 
-
     s = struct_validate(self);
 
-    rbField = struct_field(s, fieldName);
-    f = (StructField *) DATA_PTR(rbField);
+    f = struct_field(s, fieldName);
     if (f->put != NULL) {
         (*f->put)(f, s, value);
 
     } else if (f->memoryOp != NULL) {
 
         (*f->memoryOp->put)(s->pointer, f->offset, value);
-    
+
     } else {
+        VALUE rbField = rb_hash_aref(s->layout->rbFieldMap, fieldName);
         /* call up to the ruby code to set the value */
         VALUE argv[2];
         argv[0] = s->rbPointer;
@@ -366,7 +362,7 @@ struct_aset(VALUE self, VALUE fieldName, VALUE value)
     if (f->referenceRequired) {
         store_reference_value(f, s, value);
     }
-    
+
     return value;
 }
 
@@ -389,7 +385,7 @@ struct_set_pointer(VALUE self, VALUE pointer)
         return Qnil;
     }
 
-    
+
     Data_Get_Struct(self, Struct, s);
     Data_Get_Struct(pointer, AbstractMemory, memory);
     layout = struct_layout(self);
@@ -398,7 +394,7 @@ struct_set_pointer(VALUE self, VALUE pointer)
         rb_raise(rb_eArgError, "memory of %ld bytes too small for struct %s (expected at least %ld)",
                 memory->size, rb_obj_classname(self), (long) layout->base.ffiType->size);
     }
-    
+
     s->pointer = MEMORY(pointer);
     s->rbPointer = pointer;
     rb_ivar_set(self, id_pointer_ivar, pointer);
@@ -491,7 +487,7 @@ struct_order(int argc, VALUE* argv, VALUE self)
         VALUE retval = rb_obj_dup(self);
         VALUE rbPointer = rb_funcall2(s->rbPointer, rb_intern("order"), argc, argv);
         struct_set_pointer(retval, rbPointer);
-        
+
         return retval;
     }
 }
@@ -527,7 +523,7 @@ static VALUE
 inline_array_initialize(VALUE self, VALUE rbMemory, VALUE rbField)
 {
     InlineArray* array;
-    
+
     Data_Get_Struct(self, InlineArray, array);
     array->rbMemory = rbMemory;
     array->rbField = rbField;
@@ -536,12 +532,12 @@ inline_array_initialize(VALUE self, VALUE rbMemory, VALUE rbField)
     Data_Get_Struct(rbField, StructField, array->field);
     Data_Get_Struct(array->field->rbType, ArrayType, array->arrayType);
     Data_Get_Struct(array->arrayType->rbComponentType, Type, array->componentType);
-    
+
     array->op = get_memory_op(array->componentType);
     if (array->op == NULL && array->componentType->nativeType == NATIVE_MAPPED) {
         array->op = get_memory_op(((MappedType *) array->componentType)->type);
     }
-    
+
     array->length = array->arrayType->length;
 
     return self;
@@ -585,15 +581,15 @@ inline_array_aref(VALUE self, VALUE rbIndex)
     Data_Get_Struct(self, InlineArray, array);
 
     if (array->op != NULL) {
-        VALUE rbNativeValue = array->op->get(array->memory, 
+        VALUE rbNativeValue = array->op->get(array->memory,
                 inline_array_offset(array, NUM2INT(rbIndex)));
         if (unlikely(array->componentType->nativeType == NATIVE_MAPPED)) {
-            return rb_funcall(((MappedType *) array->componentType)->rbConverter, 
+            return rb_funcall(((MappedType *) array->componentType)->rbConverter,
                     rb_intern("from_native"), 2, rbNativeValue, Qnil);
         } else {
-            return rbNativeValue; 
+            return rbNativeValue;
         }
-        
+
     } else if (array->componentType->nativeType == NATIVE_STRUCT) {
         VALUE rbOffset = INT2NUM(inline_array_offset(array, NUM2INT(rbIndex)));
         VALUE rbLength = INT2NUM(array->componentType->ffiType->size);
@@ -622,12 +618,12 @@ inline_array_aset(VALUE self, VALUE rbIndex, VALUE rbValue)
 
     if (array->op != NULL) {
         if (unlikely(array->componentType->nativeType == NATIVE_MAPPED)) {
-            rbValue = rb_funcall(((MappedType *) array->componentType)->rbConverter, 
+            rbValue = rb_funcall(((MappedType *) array->componentType)->rbConverter,
                     rb_intern("to_native"), 2, rbValue, Qnil);
         }
         array->op->put(array->memory, inline_array_offset(array, NUM2INT(rbIndex)),
             rbValue);
-        
+
     } else if (array->componentType->nativeType == NATIVE_STRUCT) {
         int offset = inline_array_offset(array, NUM2INT(rbIndex));
         Struct* s;
@@ -665,11 +661,11 @@ static VALUE
 inline_array_each(VALUE self)
 {
     InlineArray* array;
-    
+
     int i;
 
     Data_Get_Struct(self, InlineArray, array);
-    
+
     for (i = 0; i < array->length; ++i) {
         rb_yield(inline_array_aref(self, INT2FIX(i)));
     }
@@ -692,7 +688,7 @@ inline_array_to_a(VALUE self)
     Data_Get_Struct(self, InlineArray, array);
     obj = rb_ary_new2(array->length);
 
-    
+
     for (i = 0; i < array->length; ++i) {
         rb_ary_push(obj, inline_array_aref(self, INT2FIX(i)));
     }
@@ -713,7 +709,7 @@ inline_array_to_s(VALUE self)
     VALUE argv[2];
 
     Data_Get_Struct(self, InlineArray, array);
- 
+
     if (array->componentType->nativeType != NATIVE_INT8 && array->componentType->nativeType != NATIVE_UINT8) {
         VALUE dummy = Qnil;
         return rb_call_super(0, &dummy);
@@ -734,7 +730,7 @@ static VALUE
 inline_array_to_ptr(VALUE self)
 {
     InlineArray* array;
-    
+
     Data_Get_Struct(self, InlineArray, array);
 
     return rb_funcall(array->rbMemory, rb_intern("slice"), 2,
@@ -778,7 +774,7 @@ rbffi_Struct_Init(VALUE moduleFFI)
     /*
      * Document-class: FFI::StructLayout::CharArray < FFI::Struct::InlineArray
      */
-    rbffi_StructLayoutCharArrayClass = rb_define_class_under(rbffi_StructLayoutClass, "CharArray", 
+    rbffi_StructLayoutCharArrayClass = rb_define_class_under(rbffi_StructLayoutClass, "CharArray",
                                                              rbffi_StructInlineArrayClass);
     rb_global_variable(&rbffi_StructLayoutCharArrayClass);
 
@@ -787,7 +783,7 @@ rbffi_Struct_Init(VALUE moduleFFI)
     rb_define_method(StructClass, "initialize", struct_initialize, -1);
     rb_define_method(StructClass, "initialize_copy", struct_initialize_copy, 1);
     rb_define_method(StructClass, "order", struct_order, -1);
-    
+
     rb_define_alias(rb_singleton_class(StructClass), "alloc_in", "new");
     rb_define_alias(rb_singleton_class(StructClass), "alloc_out", "new");
     rb_define_alias(rb_singleton_class(StructClass), "alloc_inout", "new");

data/ext/ffi_c/Struct.h

@@ -34,11 +34,7 @@
 #include "extconf.h"
 #include "AbstractMemory.h"
 #include "Type.h"
-#ifdef RUBY_1_9
 #include <ruby/st.h>
-#else
-#include <st.h>
-#endif
 
 #ifdef	__cplusplus
 extern "C" {
@@ -73,11 +69,21 @@ extern "C" {
         int size;
         int align;
         ffi_type** ffiTypes;
-        struct st_table* fieldSymbolTable;
+
+        /*
+        * We use the fieldName's minor 8 Bits as index to a 256 entry cache.
+        * This avoids full ruby hash lookups for repeated lookups.
+        */
+        #define FIELD_CACHE_LOOKUP(this, sym) ( &(this)->cache_row[((sym) >> 8) & 0xff] )
+
+        struct field_cache_entry {
+          VALUE fieldName;
+          StructField *field;
+        } cache_row[0x100];
 
         /** The number of reference tracking fields in this struct */
         int referenceFieldCount;
-        
+
         VALUE rbFieldNames;
         VALUE rbFieldMap;
         VALUE rbFields;

data/ext/ffi_c/StructLayout.c

@@ -138,7 +138,7 @@ struct_field_initialize(int argc, VALUE* argv, VALUE self)
                         && RTEST(rb_funcall2(rbType, rb_intern("reference_required?"), 0, NULL)));
             break;
     }
-    
+
     return self;
 }
 
@@ -239,7 +239,7 @@ static VALUE
 struct_field_put(VALUE self, VALUE pointer, VALUE value)
 {
     StructField* f;
-    
+
     Data_Get_Struct(self, StructField, f);
     if (f->memoryOp == NULL) {
         rb_raise(rb_eArgError, "put not supported for %s", rb_obj_classname(f->rbType));
@@ -261,7 +261,7 @@ static VALUE
 function_field_get(VALUE self, VALUE pointer)
 {
     StructField* f;
-    
+
     Data_Get_Struct(self, StructField, f);
 
     return rbffi_Function_NewInstance(f->rbType, (*rbffi_AbstractMemoryOps.pointer->get)(MEMORY(pointer), f->offset));
@@ -272,7 +272,7 @@ function_field_get(VALUE self, VALUE pointer)
  * @param [AbstractMemory] pointer pointer to a {Struct}
  * @param [Function, Proc] proc
  * @return [Function]
- * Set a {Function} to memory pointed by +pointer+ as a function. 
+ * Set a {Function} to memory pointed by +pointer+ as a function.
  *
  * If a Proc is submitted as +proc+, it is automatically transformed to a {Function}.
  */
@@ -339,11 +339,11 @@ array_field_put(VALUE self, VALUE pointer, VALUE value)
 {
     StructField* f;
     ArrayType* array;
-    
+
 
     Data_Get_Struct(self, StructField, f);
     Data_Get_Struct(f->rbType, ArrayType, array);
-    
+
     if (isCharArray(array) && rb_obj_is_instance_of(value, rb_cString)) {
         VALUE argv[2];
 
@@ -419,7 +419,6 @@ struct_layout_allocate(VALUE klass)
     layout->rbFieldMap = Qnil;
     layout->rbFieldNames = Qnil;
     layout->rbFields = Qnil;
-    layout->fieldSymbolTable = st_init_numtable();
     layout->base.ffiType = xcalloc(1, sizeof(*layout->base.ffiType));
     layout->base.ffiType->size = 0;
     layout->base.ffiType->alignment = 0;
@@ -488,7 +487,6 @@ struct_layout_initialize(VALUE self, VALUE fields, VALUE size, VALUE align)
 
 
         layout->ffiTypes[i] = ftype->size > 0 ? ftype : NULL;
-        st_insert(layout->fieldSymbolTable, rbName, rbField);
         rb_hash_aset(layout->rbFieldMap, rbName, rbField);
         rb_ary_push(layout->rbFields, rbField);
         rb_ary_push(layout->rbFieldNames, rbName);
@@ -501,14 +499,14 @@ struct_layout_initialize(VALUE self, VALUE fields, VALUE size, VALUE align)
     return self;
 }
 
-/* 
+/*
  * call-seq: [](field)
  * @param [Symbol] field
  * @return [StructLayout::Field]
  * Get a field from the layout.
  */
 static VALUE
-struct_layout_union_bang(VALUE self) 
+struct_layout_union_bang(VALUE self)
 {
     const ffi_type *alignment_types[] = { &ffi_type_sint8, &ffi_type_sint16, &ffi_type_sint32, &ffi_type_sint64,
                                           &ffi_type_float, &ffi_type_double, &ffi_type_longdouble, NULL };
@@ -602,6 +600,10 @@ struct_layout_mark(StructLayout *layout)
     rb_gc_mark(layout->rbFieldMap);
     rb_gc_mark(layout->rbFieldNames);
     rb_gc_mark(layout->rbFields);
+    /* Clear the cache, to be safe from changes of fieldName VALUE by GC.compact.
+     * TODO: Move cache clearing to compactation callback provided by Ruby-2.7+.
+     */
+    memset(&layout->cache_row, 0, sizeof(layout->cache_row));
 }
 
 static void
@@ -610,7 +612,6 @@ struct_layout_free(StructLayout *layout)
     xfree(layout->ffiTypes);
     xfree(layout->base.ffiType);
     xfree(layout->fields);
-    st_free_table(layout->fieldSymbolTable);
     xfree(layout);
 }
 
@@ -627,7 +628,7 @@ rbffi_StructLayout_Init(VALUE moduleFFI)
      */
     rbffi_StructLayoutClass = rb_define_class_under(moduleFFI, "StructLayout", ffi_Type);
     rb_global_variable(&rbffi_StructLayoutClass);
-    
+
     /*
      * Document-class: FFI::StructLayout::Field
      * A field in a {StructLayout}.