ffi 1.9.25 → 1.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf13d7fccdcd65b73b5286e04fc25a174b7b855ab1803995eaa4564d5d65456a
-  data.tar.gz: 187c8d21dd770d08e7e123ead2a727fc3e9e384d35ff2b5d37fc3a0df712f37e
+  metadata.gz: c60b8c22daf207353adea897b6142f65ea1bbfcac447ee7da373547d7212c19a
+  data.tar.gz: 7e3438808bbff423f8cd989e44e2c4288e25bf80d96f04c906617f35eab9846a
 SHA512:
-  metadata.gz: 06eb5d5d2c033e0b7ade6d75957f835d7831aca9b492ac752e7d2b4760707ecb07981e1cd366f0059b67c1b2f3a9b5964e70388d123f4997efa0f5c691baede8
-  data.tar.gz: e050bf8673f3bb19afbe78646f18f452c4fa2d70fc2a8f9f8efb073cd0658f6a7e0f1737dd6a05076422533ecf22e9952f08d407bdd0480bbde31fd55eef52de
+  metadata.gz: 439d1b680a2a6d30ebb5957884cc5aad39f708df6fc8616b08ebe5bfa761123bacfe68f3de09773d84f3f521ed40cb0a4844de61a64d5bc9217c7ed3e165f5e9
+  data.tar.gz: 866123b57649213c4bef30f5183955fe443a75e7b4cd57e16048559e5326507540182c86a9b149f64431ff06322066bfb70d3e1ca97e7246fa78425e086bf278

data/{appveyor.yml → .appveyor.yml}

@@ -8,15 +8,20 @@ install:
       }
   - ridk version
   - gem --version
-  - gem install bundler --quiet --no-ri --no-rdoc
+  - gem install bundler --quiet --no-document
   - 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: 26
+      EXTCONFOPTS: "--enable-system-libffi"

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
+	branch = master

data/.travis.yml

@@ -1,52 +1,44 @@
 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
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1
-  - 2.2.8
-  - 2.3.5
-  - 2.4.3
-  - 2.5.0
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
   - ruby-head
-  - rbx
-  - system
+
 env:
   - CC=gcc
   - CC=clang
 matrix:
   allow_failures:
-    - rvm: system
-    - os: osx
-      rvm: 2.0.0
     - os: osx
       rvm: ruby-head
-    - rvm: rbx
-    - rvm: rbx-head
-    - rvm: 1.9.3
-  exclude: # ruby 2.4.2 needs build with xcode9 or later on osx
     - os: osx
-      rvm: 2.4.2
+      rvm: 2.3.8
   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,106 @@
+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
+-------------------
+
+Removed:
+* Remove support for tainted objects which cause deprecation warnings in ruby-2.7. #730
+
+
+1.11.2 / 2019-11-11
+-------------------
+
+Added:
+* Add DragonFlyBSD as a platform. #724
+
+Changed:
+* Sort all types.conf files, so that files and changes are easier to compare.
+* Regenerated type conf for freebsd12 and x86_64-linux targets. #722
+* Remove MACOSX_DEPLOYMENT_TARGET that was targeting very old version 10.4. #647
+* Fix library name mangling for non glibc Linux/UNIX. #727
+* Fix compiler warnings raised by ruby-2.7
+* Update libffi to latest master.
+
+
+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
+-------------------
+This version was yanked on 2019-05-20 to fix an install issue on ruby-1.9.3. #700
+
+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
+-------------------
+
+Added:
+* Add /opt/local/lib/ to ffi's fallback library search path. #638
+* Add binary gem support for ruby-2.6 on Windows
+* Add FreeBSD on AArch64 and ARM support. #644
+* Add FFI::LastError.winapi_error on Windows native or Cygwin. #633
+
+Changed:
+* Update to rake-compiler-dock-0.7.0
+* Use 64-bit inodes on FreeBSD >= 12. #644
+* Switch time_t and suseconds_t types to long on FreeBSD. #627
+* Make register_t long_long on 64-bit FreeBSD. #644
+* Fix Pointer#write_array_of_type #637
+
+Removed:
+* Drop binary gem support for ruby-2.0 and 2.1 on Windows
+
+
 1.9.25 / 2018-06-03
 -------------------
 
@@ -9,6 +112,10 @@ Changed:
 1.9.24 / 2018-06-02
 -------------------
 
+Security Note:
+
+This update addresses vulnerability CVE-2018-1000201: DLL loading issue which can be hijacked on Windows OS, when a Symbol is used as DLL name instead of a String. Found by Matthew Bush.
+
 Added:
 * Added a CHANGELOG file
 * Add mips64(eb) support, and mips r6 support. (#601)

data/Gemfile

@@ -1,9 +1,9 @@
 source 'https://rubygems.org'
 
 group :development do
-  gem 'rake', '~> 10.1'
+  gem 'rake', '~> 13.0'
   gem 'rake-compiler', '~> 1.0.3'
-  gem 'rake-compiler-dock', '~> 0.6.2'
+  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

@@ -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,32 @@ 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), 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
 
-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.
+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`.
+
+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 +73,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 +85,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}}
@@ -162,7 +88,6 @@ namespace 'java' do
     s.summary = gem_spec.summary
     s.description = gem_spec.description
     s.files = %w(LICENSE COPYING README.md CHANGELOG.md Rakefile)
-    s.has_rdoc = false
     s.license = gem_spec.license
     s.platform = 'java'
   end
@@ -176,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.
@@ -199,12 +124,13 @@ if USE_RAKE_COMPILER
       sh "x86_64-w64-mingw32-strip -S build/x64-mingw32/stage/lib/#{ruby_version[/^\d+\.\d+/]}/ffi_c.so"
     end
   end
+end
 
-  desc "build a windows gem without all the ceremony."
-  task "gem:windows" do
-    require "rake_compiler_dock"
-    RakeCompilerDock.sh "sudo apt-get update && sudo apt-get install -y libltdl-dev && bundle && rake cross native gem MAKE='nice make -j`nproc`'"
-  end
+desc "build a windows gem without all the ceremony"
+task "gem:windows" do
+  require "rake_compiler_dock"
+  sh "bundle package"
+  RakeCompilerDock.sh "sudo apt-get update && sudo apt-get install -y libltdl-dev && bundle --local && rake cross native gem MAKE='nice make -j`nproc`'"
 end
 
 directory "ext/ffi_c/libffi"
@@ -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")
 
@@ -249,6 +176,7 @@ file types_conf => File.join("lib", "ffi", "version.rb") do |task|
   end
 end
 
+desc "Create or update type information for platform #{FFI::Platform::NAME}"
 task :types_conf => types_conf do
 end
 

data/ext/ffi_c/AbstractMemory.c

@@ -417,7 +417,7 @@ memory_get_string(int argc, VALUE* argv, VALUE self)
     checkBounds(ptr, off, len);
 
     end = memchr(ptr->address + off, 0, len);
-    return rb_tainted_str_new((char *) ptr->address + off,
+    return rb_str_new((char *) ptr->address + off,
             (end != NULL ? end - ptr->address - off : len));
 }
 
@@ -453,7 +453,7 @@ memory_get_array_of_string(int argc, VALUE* argv, VALUE self)
         
         for (i = 0; i < count; ++i) {
             const char* strptr = *((const char**) (ptr->address + off) + i);
-            rb_ary_push(retVal, (strptr == NULL ? Qnil : rb_tainted_str_new2(strptr)));
+            rb_ary_push(retVal, (strptr == NULL ? Qnil : rb_str_new2(strptr)));
         }
 
     } else {
@@ -463,7 +463,7 @@ memory_get_array_of_string(int argc, VALUE* argv, VALUE self)
             if (strptr == NULL) {
                 break;
             }
-            rb_ary_push(retVal, rb_tainted_str_new2(strptr));
+            rb_ary_push(retVal, rb_str_new2(strptr));
         }
     }
 
@@ -542,7 +542,7 @@ memory_get_bytes(VALUE self, VALUE offset, VALUE length)
     checkRead(ptr);
     checkBounds(ptr, off, len);
     
-    return rb_tainted_str_new((char *) ptr->address + off, len);
+    return rb_str_new((char *) ptr->address + off, len);
 }
 
 /*
@@ -583,10 +583,6 @@ memory_put_bytes(int argc, VALUE* argv, VALUE self)
     checkWrite(ptr);
     checkBounds(ptr, off, len);
 
-    if (rb_safe_level() >= 1 && OBJ_TAINTED(str)) {
-        rb_raise(rb_eSecurityError, "Writing unsafe string to memory");
-        return Qnil;
-    }
     memcpy(ptr->address + off, RSTRING_PTR(str) + idx, len);
 
     return self;
@@ -718,7 +714,7 @@ memory_op_get_strptr(AbstractMemory* ptr, long offset)
         memcpy(&tmp, ptr->address + offset, sizeof(tmp));
     }
 
-    return tmp != NULL ? rb_tainted_str_new2(tmp) : Qnil;
+    return tmp != NULL ? rb_str_new2(tmp) : Qnil;
 }
 
 static void