ffi 1.10.0 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 108ea9d730d92bf5994912324af1cd21b23256c575d0344a7884990d8307baa7
-  data.tar.gz: be60f268828396e8b67d1329ac95b136f4f03a229d37f95f73d35dcd1fb8908c
+  metadata.gz: 041f37e7f1d2ed3857caabe7c68a68d3d8a9b403c5d03e8df59d0277a48f17e2
+  data.tar.gz: 4c9bcdce1d0ba85318109bb074a0e19c87f5c004440a491d5f532ac2ec20b82c
 SHA512:
-  metadata.gz: eed04778f789f4216f78466bc8fb3f30efa96f3da66720fe3fcce1f5eba01213387c20fe0eb1bcd73146931cefdc68133a3d6a1723b921e1ce00adb58e8e6440
-  data.tar.gz: 8c8c96560189bce8d0a95513872028692b89d181ed8ba68752085cbcac2cf957bde9b00c6666946646849acea167b300c28727fd9669098cfb83514fbcf29474
+  metadata.gz: 4ae610d83039e9edc3ce4fe3708319cc4c1fc0d8d6dbddc96b4f4b51eec5875fb9052adfce7620664707a73696f3d17c4c1c956037ac252e1924a36fde57ad4c
+  data.tar.gz: 3a745c80a61c816826ded2c3e29eb13746e1686edcd14f98d06d012d31352b7eaf30e15d9517e662a80beb65f48e1af6e0bceddbf23346d3268ccf6d6ea820ea

data/.gitignore

@@ -20,3 +20,6 @@ vendor
 Gemfile.lock
 types_log
 *.gem
+embed-test.log
+spec/ffi/embed-test/ext/Makefile
+spec/ffi/embed-test/ext/embed_test.bundle

data/.gitmodules

@@ -1,3 +1,4 @@
 [submodule "ext/ffi_c/libffi"]
 	path = ext/ffi_c/libffi
-	url = https://github.com/libffi/libffi.git
+	url = https://github.com/larskanis/libffi.git
+	branch = fix-stdcall

data/.travis.yml

@@ -1,12 +1,11 @@
 dist: trusty
-sudo: false
 group: beta
 language: ruby
-before_install:
-  - gem install bundler
+
 script:
   - bundle exec rake compile || bundle exec rake compile
   - bundle exec rake test
+  - ITER=10 bundle exec rake bench:all
 os:
   - linux
   - osx
@@ -16,28 +15,28 @@ rvm:
   - 2.5.3
   - 2.6.0
   - ruby-head
-  - system
+
 env:
   - CC=gcc
   - CC=clang
 matrix:
   allow_failures:
-    - rvm: system
     - os: osx
       rvm: ruby-head
-  exclude: # ruby 2.4.2 needs build with xcode9 or later on osx
-    - os: osx
-      rvm: 2.4.2
   include:
-    - os: osx
-      osx_image: xcode9.1
-      rvm: 2.4.2
-      env:
-      - CC=gcc
-    - os: osx
-      osx_image: xcode9.1
-      rvm: 2.4.2
-      env:
-      - CC=clang
+    - name: powerpc
+      language: generic
+      before_install: |
+        docker run --rm --privileged multiarch/qemu-user-static:register --reset &&
+          docker build --rm -t ffi-powerpc -f spec/env/Dockerfile.powerpc .
+      script: |
+        docker run --rm -t -v `pwd`:/ffi ffi-powerpc
+    - name: armhf
+      language: generic
+      before_install: |
+        docker run --rm --privileged multiarch/qemu-user-static:register --reset &&
+          docker build --rm -t ffi-armhf -f spec/env/Dockerfile.armhf .
+      script: |
+        docker run --rm -t -v `pwd`:/ffi ffi-armhf
 after_failure:
   - "find build -name mkmf.log | xargs cat"

data/CHANGELOG.md

@@ -1,3 +1,36 @@
+1.11.1 / 2019-05-20
+-------------------
+
+Changed:
+* Raise required ruby version to >=2.0. #699, #700
+* Fix a possible linker error on ruby < 2.3 on Linux.
+
+
+1.11.0 / 2019-05-17
+-------------------
+
+Added:
+* Add ability to disable or force use of system libffi. #669
+  Use like `gem inst ffi -- --enable-system-libffi` .
+* Add ability to call FFI callbacks from outside of FFI call frame. #584
+* Add proper documentation to FFI::Generator and ::Task
+* Add gemspec metadata. #696, #698
+
+Changed:
+* Fix stdcall on Win32. #649, #669
+* Fix load paths for FFI::Generator::Task
+* Fix FFI::Pointer#read_string(0) to return a binary String. #692
+* Fix benchmark suite so that it runs on ruby-2.x
+* Move FFI::Platform::CPU from C to Ruby. #663
+* Move FFI::StructByReference to Ruby. #681
+* Move FFI::DataConverter to Ruby (#661)
+* Various cleanups and improvements of specs and benchmarks
+
+Removed:
+* Remove ruby-1.8 and 1.9 compatibility code. #683
+* Remove unused spec files. #684
+
+
 1.10.0 / 2019-01-06
 -------------------
 

data/Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 
 group :development do
-  gem 'rake', '~> 10.1'
+  gem 'rake', '~> 12.1'
   gem 'rake-compiler', '~> 1.0.3'
   gem 'rake-compiler-dock', '~> 0.7.0'
   gem 'rspec', '~> 3.0'

data/README.md

@@ -1,19 +1,19 @@
-# ruby-ffi https://wiki.github.com/ffi/ffi [![Build Status](https://travis-ci.org/ffi/ffi.png?branch=master)](https://travis-ci.org/ffi/ffi) [![Build status Windows](https://ci.appveyor.com/api/projects/status/r8wxn1sd4s794gg1/branch/master?svg=true)](https://ci.appveyor.com/project/larskanis/ffi-aofqa/branch/master)
+# Ruby-FFI https://github.com/ffi/ffi/wiki [![Build Status](https://travis-ci.org/ffi/ffi.svg?branch=master)](https://travis-ci.org/ffi/ffi) [![Build status Windows](https://ci.appveyor.com/api/projects/status/r8wxn1sd4s794gg1/branch/master?svg=true)](https://ci.appveyor.com/project/larskanis/ffi-aofqa/branch/master)
 
 ## Description
 
-Ruby-FFI is a ruby extension for programmatically loading dynamic
+Ruby-FFI is a gem for programmatically loading dynamically-linked native
 libraries, binding functions within them, and calling those functions
 from Ruby code. Moreover, a Ruby-FFI extension works without changes
-on Ruby and JRuby. [Discover why you should write your next extension
-using Ruby-FFI](https://wiki.github.com/ffi/ffi/why-use-ffi).
+on CRuby (MRI), JRuby, Rubinius and TruffleRuby. [Discover why you should write your next extension
+using Ruby-FFI](https://github.com/ffi/ffi/wiki/why-use-ffi).
 
-## Features/problems
+## Features
 
 * Intuitive DSL
 * Supports all C native types
 * C structs (also nested), enums and global variables
-* Callbacks from C to ruby
+* Callbacks from C to Ruby
 * Automatic garbage collection of native memory
 
 ## Synopsis
@@ -30,20 +30,23 @@ end
 MyLib.puts 'Hello, World using libc!'
 ```
 
-For less minimalistic and more sane examples you may look at:
+For less minimalistic and more examples you may look at:
 
-* the samples/ folder
-* the examples on the [wiki](https://wiki.github.com/ffi/ffi)
-* the projects using FFI listed on this page (https://wiki.github.com/ffi/ffi/projects-using-ffi)
+* the `samples/` folder
+* the examples on the [wiki](https://github.com/ffi/ffi/wiki)
+* the projects using FFI listed on the wiki: https://github.com/ffi/ffi/wiki/projects-using-ffi
 
 ## Requirements
 
-You need a sane building environment in order to compile the extension.
-At a minimum, you will need:
-* A C compiler (e.g. Xcode on OSX, gcc on everything else)
-* libffi development library - this is commonly in the libffi-dev or libffi-devel
+When installing the gem on CRuby (MRI) or Rubinius, you will need:
+* A C compiler (e.g., Xcode on macOS, `gcc` or `clang` on everything else)
+* The `libffi` library and development headers - this is commonly in the `libffi-dev` or `libffi-devel` packages
 
-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 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`.
+
+On JRuby and TruffleRuby, there are no requirements to install the FFI gem, and `require 'ffi'` works even without installing the gem (i.e., the gem is preinstalled on these implementations).
 
 ## Installation
 
@@ -61,8 +64,7 @@ or from the git repository on github:
 ## License
 
 The ffi library is covered by the BSD license, also see the LICENSE file.
-The specs are shared with Rubyspec and are licensed by the same license
-as Rubyspec, see the LICENSE.SPECS file.
+The specs are covered by the same license as [ruby/spec](https://github.com/ruby/spec), the MIT license.
 
 ## Credits
 
@@ -74,6 +76,7 @@ The following people have submitted code, bug reports, or otherwise contributed
 * Andreas Niederl <rico32@gmx.net>
 * Andrew Cholakian <andrew@andrewvc.com>
 * Antonio Terceiro <terceiro@softwarelivre.org>
+* Benoit Daloze <eregontp@gmail.com>
 * Brian Candler <B.Candler@pobox.com>
 * Brian D. Burns <burns180@gmail.com>
 * Bryan Kearney <bkearney@redhat.com>

data/Rakefile

@@ -3,82 +3,16 @@ require 'rbconfig'
 require 'rake/clean'
 require File.expand_path("./lib/ffi/version")
 
-USE_RAKE_COMPILER = (RUBY_PLATFORM =~ /java/) ? false : true
-if USE_RAKE_COMPILER
-  require 'rake/extensiontask'
-end
-
 require 'date'
 require 'fileutils'
 require 'rbconfig'
 require 'rspec/core/rake_task'
 require 'rubygems/package_task'
 
-LIBEXT = case RbConfig::CONFIG['host_os'].downcase
-  when /darwin/
-    "dylib"
-  when /mswin|mingw/
-    "dll"
-  else
-    RbConfig::CONFIG['DLEXT']
-  end
-
-CPU = case RbConfig::CONFIG['host_cpu'].downcase
-  when /i[3456]86/
-    # Darwin always reports i686, even when running in 64bit mode
-    if RbConfig::CONFIG['host_os'] =~ /darwin/ && 0xfee1deadbeef.is_a?(Fixnum)
-      "x86_64"
-    else
-      "i386"
-    end
-
-  when /amd64|x86_64/
-    "x86_64"
-
-  when /ppc64|powerpc64/
-    "powerpc64"
-
-  when /ppc|powerpc/
-    "powerpc"
-
-  when /^arm/
-    "arm"
-
-  else
-    RbConfig::CONFIG['host_cpu']
-  end
-
-OS = case RbConfig::CONFIG['host_os'].downcase
-  when /linux/
-    "linux"
-  when /darwin/
-    "darwin"
-  when /freebsd/
-    "freebsd"
-  when /openbsd/
-    "openbsd"
-  when /sunos|solaris/
-    "solaris"
-  when /mswin|mingw/
-    "win32"
-  else
-    RbConfig::CONFIG['host_os'].downcase
-  end
-
-def which(name)
-  exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
-  ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-    exts.each do |ext|
-      app = File.join(path, name+ext)
-      return app if File.executable? app
-    end
-  end
-  nil
+def java?
+  /java/ === RUBY_PLATFORM
 end
 
-GMAKE = which('gmake').nil? ? 'make' : 'gmake'
-
-LIBTEST = "build/libtest.#{LIBEXT}"
 BUILD_DIR = "build"
 BUILD_EXT_DIR = File.join(BUILD_DIR, "#{RbConfig::CONFIG['arch']}", 'ffi_c', RUBY_VERSION)
 
@@ -86,7 +20,7 @@ def gem_spec
   @gem_spec ||= Gem::Specification.load('ffi.gemspec')
 end
 
-TEST_DEPS = [ LIBTEST ]
+TEST_DEPS = []
 if RUBY_PLATFORM == "java"
   RSpec::Core::RakeTask.new(:spec) do |config|
     config.rspec_opts = YAML.load_file 'spec/spec.opts'
@@ -110,30 +44,22 @@ CLEAN.include 'build'
 CLEAN.include 'conftest.dSYM'
 CLEAN.include 'spec/ffi/fixtures/libtest.{dylib,so,dll}'
 CLEAN.include 'spec/ffi/fixtures/*.o'
+CLEAN.include 'spec/ffi/embed-test/ext/*.{o,def}'
+CLEAN.include 'spec/ffi/embed-test/ext/Makefile'
 CLEAN.include "pkg/ffi-*-{mingw32,java}"
 CLEAN.include 'lib/1.*'
 CLEAN.include 'lib/2.*'
-CLEAN.include 'bin'
 
 task :distclean => :clobber
 
-desc "Build the native test lib"
-file "build/libtest.#{LIBEXT}" => FileList['libtest/**/*.[ch]'] do
-  sh %{#{GMAKE} -f libtest/GNUmakefile CPU=#{CPU} OS=#{OS} }
-end
-
-
-desc "Build test helper lib"
-task :libtest => "build/libtest.#{LIBEXT}"
-
 desc "Test the extension"
 task :test => [ :spec ]
 
 
 namespace :bench do
   ITER = ENV['ITER'] ? ENV['ITER'].to_i : 100000
-  bench_libs = "-Ilib -I#{BUILD_DIR}" unless RUBY_PLATFORM == "java"
-  bench_files = Dir["bench/bench_*.rb"].reject { |f| f == "bench_helper.rb" }
+  bench_libs = "-Ilib" unless RUBY_PLATFORM == "java"
+  bench_files = Dir["bench/bench_*.rb"].reject { |f| f == "bench/bench_helper.rb" }
   bench_files.each do |bench|
     task File.basename(bench, ".rb")[6..-1] => TEST_DEPS do
       sh %{#{Gem.ruby} #{bench_libs} #{bench} #{ITER}}
@@ -175,8 +101,8 @@ end
 
 task 'gem:java' => 'java:gem'
 
-
-if USE_RAKE_COMPILER
+unless java?
+  require 'rake/extensiontask'
   Rake::ExtensionTask.new('ffi_c', gem_spec) do |ext|
     ext.name = 'ffi_c'                                        # indicate the name of the extension.
     # ext.lib_dir = BUILD_DIR                                 # put binaries into this folder.
@@ -212,6 +138,7 @@ file "ext/ffi_c/libffi/autogen.sh" => "ext/ffi_c/libffi" do
   warn "Downloading libffi ..."
   sh "git submodule update --init --recursive"
 end
+task :libffi => "ext/ffi_c/libffi/autogen.sh"
 
 LIBFFI_GIT_FILES = `git --git-dir ext/ffi_c/libffi/.git ls-files -z`.split("\x0")
 

data/appveyor.yml

@@ -12,11 +12,16 @@ install:
   - bundle install
 build: off
 build_script:
-  - bundle exec rake compile || bundle exec rake compile
+  - bundle exec rake libffi compile -- %EXTCONFOPTS% || bundle exec rake compile -- %EXTCONFOPTS%
 test_script:
   - bundle exec rake test
 environment:
   matrix:
     - RUBYVER: "head-x64"
+      EXTCONFOPTS: "--disable-system-libffi"
     - RUBYVER: 24
+      EXTCONFOPTS: "--disable-system-libffi"
     - RUBYVER: 25-x64
+      EXTCONFOPTS: "--enable-system-libffi"
+    - RUBYVER: 25
+      EXTCONFOPTS: "--enable-system-libffi"

data/ext/ffi_c/Call.c

@@ -43,10 +43,8 @@
 #endif
 #include <errno.h>
 #include <ruby.h>
-#if defined(HAVE_RUBY_THREAD_H)
 #include <ruby/thread.h>
-#endif
-#if defined(HAVE_NATIVETHREAD) && (defined(HAVE_RB_THREAD_BLOCKING_REGION) || defined(HAVE_RB_THREAD_CALL_WITHOUT_GVL)) && !defined(_WIN32)
+#if defined(HAVE_NATIVETHREAD) && !defined(_WIN32)
 #  include <signal.h>
 #  include <pthread.h>
 #endif
@@ -116,7 +114,7 @@ rbffi_SetupCallParams(int argc, VALUE* argv, int paramCount, Type** paramTypes,
         Type* paramType = paramTypes[i];
         int type;
 
-        
+
         if (unlikely(paramType->nativeType == NATIVE_MAPPED)) {
             VALUE values[] = { argv[argidx], Qnil };
             argv[argidx] = rb_funcall2(((MappedType *) paramType)->rbConverter, id_to_native, 2, values);
@@ -297,8 +295,8 @@ rbffi_SetupCallParams(int argc, VALUE* argv, int paramCount, Type** paramTypes,
 
             case NATIVE_STRING:
                 if (type == T_NIL) {
-                    param->ptr = NULL; 
-                
+                    param->ptr = NULL;
+
                 } else {
                     if (rb_safe_level() >= 1 && OBJ_TAINTED(argv[argidx])) {
                         rb_raise(rb_eSecurityError, "Unsafe string parameter");
@@ -345,9 +343,13 @@ static void *
 call_blocking_function(void* data)
 {
     rbffi_blocking_call_t* b = (rbffi_blocking_call_t *) data;
+#ifndef HAVE_RUBY_THREAD_HAS_GVL_P
     b->frame->has_gvl = false;
+#endif
     ffi_call(&b->cif, FFI_FN(b->function), b->retval, b->ffiValues);
+#ifndef HAVE_RUBY_THREAD_HAS_GVL_P
     b->frame->has_gvl = true;
+#endif
 
     return NULL;
 }
@@ -355,7 +357,7 @@ call_blocking_function(void* data)
 VALUE
 rbffi_do_blocking_call(void *data)
 {
-    rbffi_thread_blocking_region(call_blocking_function, data, (void *) -1, NULL);
+    rb_thread_call_without_gvl(call_blocking_function, data, (void *) -1, NULL);
 
     return Qnil;
 }
@@ -376,28 +378,17 @@ rbffi_CallFunction(int argc, VALUE* argv, void* function, FunctionType* fnInfo)
     FFIStorage* params;
     VALUE rbReturnValue;
     rbffi_frame_t frame = { 0 };
-    
+
     retval = alloca(MAX(fnInfo->ffi_cif.rtype->size, FFI_SIZEOF_ARG));
-    
+
     if (unlikely(fnInfo->blocking)) {
         rbffi_blocking_call_t* bc;
 
-        /*
-         * due to the way thread switching works on older ruby variants, we
-         * cannot allocate anything passed to the blocking function on the stack
-         */
-#if defined(HAVE_RB_THREAD_BLOCKING_REGION) || defined(HAVE_RB_THREAD_CALL_WITHOUT_GVL)
+        /* allocate information passed to the blocking function on the stack */
         ffiValues = ALLOCA_N(void *, fnInfo->parameterCount);
         params = ALLOCA_N(FFIStorage, fnInfo->parameterCount);
         bc = ALLOCA_N(rbffi_blocking_call_t, 1);
         bc->retval = retval;
-#else
-        ffiValues = ALLOC_N(void *, fnInfo->parameterCount);
-        params = ALLOC_N(FFIStorage, fnInfo->parameterCount);
-        bc = ALLOC_N(rbffi_blocking_call_t, 1);
-        bc->retval = xmalloc(MAX(fnInfo->ffi_cif.rtype->size, FFI_SIZEOF_ARG));
-        bc->stkretval = retval;
-#endif
         bc->cif = fnInfo->ffi_cif;
         bc->function = function;
         bc->ffiValues = ffiValues;
@@ -408,18 +399,10 @@ rbffi_CallFunction(int argc, VALUE* argv, void* function, FunctionType* fnInfo)
             fnInfo->parameterCount, fnInfo->parameterTypes, params, ffiValues,
             fnInfo->callbackParameters, fnInfo->callbackCount, fnInfo->rbEnums);
 
-        rbffi_frame_push(&frame); 
+        rbffi_frame_push(&frame);
         rb_rescue2(rbffi_do_blocking_call, (VALUE) bc, rbffi_save_frame_exception, (VALUE) &frame, rb_eException, (VALUE) 0);
         rbffi_frame_pop(&frame);
 
-#if !(defined(HAVE_RB_THREAD_BLOCKING_REGION) || defined(HAVE_RB_THREAD_CALL_WITHOUT_GVL))
-        memcpy(bc->stkretval, bc->retval, MAX(bc->cif.rtype->size, FFI_SIZEOF_ARG));
-        xfree(bc->params);
-        xfree(bc->ffiValues);
-        xfree(bc->retval);
-        xfree(bc);
-#endif
-    
     } else {
 
         ffiValues = ALLOCA_N(void *, fnInfo->parameterCount);
@@ -436,7 +419,7 @@ rbffi_CallFunction(int argc, VALUE* argv, void* function, FunctionType* fnInfo)
 
     if (unlikely(!fnInfo->ignoreErrno)) {
         rbffi_save_errno();
-    }    
+    }
 
     if (RTEST(frame.exc) && frame.exc != Qnil) {
         rb_exc_raise(frame.exc);
@@ -444,7 +427,7 @@ rbffi_CallFunction(int argc, VALUE* argv, void* function, FunctionType* fnInfo)
 
     RB_GC_GUARD(rbReturnValue) = rbffi_NativeValue_ToRuby(fnInfo->returnType, fnInfo->rbReturnType, retval);
     RB_GC_GUARD(fnInfo->rbReturnType);
-    
+
     return rbReturnValue;
 }
 
@@ -461,7 +444,7 @@ getPointer(VALUE value, int type)
         return memory != NULL ? memory->address : NULL;
 
     } else if (type == T_STRING) {
-        
+
         return StringValuePtr(value);
 
     } else if (type == T_NIL) {