ffi 1.11.1 → 1.15.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 041f37e7f1d2ed3857caabe7c68a68d3d8a9b403c5d03e8df59d0277a48f17e2
-  data.tar.gz: 4c9bcdce1d0ba85318109bb074a0e19c87f5c004440a491d5f532ac2ec20b82c
+  metadata.gz: d6f15f4e38ad34949be88341216eed2ea132c4e5763d333c20c240491b033ff6
+  data.tar.gz: deefb7285ccae7d7248ee2697709e859d4c0017e3aab7e183ce7fc2a824bd395
 SHA512:
-  metadata.gz: 4ae610d83039e9edc3ce4fe3708319cc4c1fc0d8d6dbddc96b4f4b51eec5875fb9052adfce7620664707a73696f3d17c4c1c956037ac252e1924a36fde57ad4c
-  data.tar.gz: 3a745c80a61c816826ded2c3e29eb13746e1686edcd14f98d06d012d31352b7eaf30e15d9517e662a80beb65f48e1af6e0bceddbf23346d3268ccf6d6ea820ea
+  metadata.gz: 7b2c32adb0af3689632c9b6113389245dba13d5f9e622efd2f322b0226933185ae0fbc128cb33c278dd2ef7fddda106fe8158904e95d1fa7d53b14ff72722ff6
+  data.tar.gz: 60ca6ad01c3d977b8b6efe0329683d4105cae8147848c9fcb0cabe643f5957e7a6ab6a06716e1f579ada6e0c3795f4fd4c0f16bda783342310a305423a5d7a60

data/CHANGELOG.md

@@ -1,3 +1,209 @@
+1.15.5 / 2022-01-10
+-------------------
+
+Fixed:
+* Fix long double argument or return values on 32bit i686. #849
+* FFI::ConstGenerator: avoid usage of the same binary file simultaneously. #929
+
+Added:
+* Add Windows fat binary gem for Ruby-3.1
+
+Removed:
+* Remove Windows fat binary gem for Ruby < 2.4
+
+
+1.15.4 / 2021-09-01
+-------------------
+
+Fixed:
+* Fix build for uClibc. #913
+* Correct module lookup when including `ffi-module` gem. #912
+
+Changed:
+* Use ruby code of the ffi gem in JRuby-9.2.20+. #915
+
+
+1.15.3 / 2021-06-16
+-------------------
+
+Fixed:
+* Fix temporary packaging issue with libffi. #904
+
+
+1.15.2 / 2021-06-16
+-------------------
+
+Added:
+* Add support for Windows MINGW-UCRT build. #903
+* Add `/opt/homebrew/lib/` to fallback search paths to improve homebrew support. #880 #882
+
+Changed:
+* Regenerate `types.conf` for FreeBSD12 aarch64. #902
+
+
+1.15.1 / 2021-05-22
+-------------------
+
+Fixed:
+* Append -pthread to linker options. #893
+* Use arm or aarch64 to identify Apple ARM CPU arch. #899
+* Allow overriding `gcc` with the `CC` env var in `const_generator.rb` and `struct_generator.rb`. #897
+
+
+1.15.0 / 2021-03-05
+-------------------
+
+Fixed:
+* Fix MSVC build
+* Fix async callbacks in conjunction with fork(). #884
+
+Added:
+* Allow to pass callbacks in varargs. #885
+* Name the threads for FFI callback dispatcher and async thread calls for easier debugging. #883
+  The name can be retrieved by Thread.name and is shown by Thread.list.inspect etc.
+  Even gdb shows the thread name on supported operating systems.
+* Add types.conf for powerpc64le-linux
+* Add types.conf for riscv64-linux
+* More release automation of ffi gems
+
+Changed:
+* Switch from rubygems-tasks to bundler/gem_helper
+
+Removed:
+* Remove unused VariadicInvoker#init
+
+
+1.14.2 / 2020-12-21
+-------------------
+
+Fixed:
+* Fix builtin libffi on newer Ubuntu caused by an outdated Makefile.in . #863
+
+
+1.14.1 / 2020-12-19
+-------------------
+
+Changed:
+* Revert changes to FFI::Pointer#write_string made in ffi-1.14.0.
+  It breaks compatibilty in a way that can cause hard to find errors. #857
+
+
+1.14.0 / 2020-12-18
+-------------------
+
+Added:
+* Add types.conf for x86_64-msys, x86_64-haiku, aarch64-openbsd and aarch64-darwin (alias arm64-darwin)
+* Add method AbstractMemory#size_limit? . #829
+* Add new extconf option --enable-libffi-alloc which is enabled per default on Apple M1 (arm64-darwin).
+
+Changed:
+* Do NULL pointer check only when array length > 0 . #305
+* Raise an error on an unknown order argument. #830
+* Change FFI::Pointer#write_string to terminate with a NUL byte like other string methods. #805
+* Update bundled libffi to latest master.
+
+Removed:
+* Remove win32/stdint.h and stdbool.h because of copyright issue.  #693
+
+Fixed:
+* Fix possible UTF-8 load error in loader script interpretation. #792
+* Fix segfault on non-array argument to #write_array_of_*
+* Fix memory leak in MethodHandle . #815
+* Fix possible segfault in combination with fiddle or other libffi using gems . #835
+* Fix possibility to use ffi ruby gem with JRuby-9.3 . #763
+* Fix a GC issue, when a callback Proc is used on more than 2 callback signatures. #820
+
+
+1.13.1 / 2020-06-09
+-------------------
+
+Changed:
+* Revert use of `ucrtbase.dll` as default C library on Windows-MINGW.
+  `ucrtbase.dll` is still used on MSWIN target. #790
+* Test for `ffi_prep_closure_loc()` to make sure we can use this function.
+  This fixes incorrect use of system libffi on MacOS Mojave (10.14). #787
+* Update types.conf on x86_64-dragonflybsd
+
+
+1.13.0 / 2020-06-01
+-------------------
+
+Added:
+* Add TruffleRuby support. Almost all specs are running on TruffleRuby and succeed. #768
+* Add ruby source files to the java gem. This allows to ship the Ruby library code per platform java gem and add it as a default gem to JRuby. #763
+* Add FFI::Platform::LONG_DOUBLE_SIZE
+* Add bounds checks for writing to an inline char[] . #756
+* Add long double as callback return value. #771
+* Update type definitions and add types from stdint.h and stddef.h on i386-windows, x86_64-windows, x86_64-darwin, x86_64-linux, arm-linux, powerpc-linux. #749
+* Add new type definitions for powerpc-openbsd and sparcv9-openbsd. #775, #778
+
+Changed:
+* Raise required ruby version to >= 2.3.
+* Lots of cleanups and improvements in library, specs and benchmarks.
+* Fix a lot of compiler warnings at the C-extension
+* Fix several install issues on MacOS:
+  * Look for libffi in SDK paths, since recent versions of macOS removed it from `/usr/include` . #757
+  * Fix error `ld: library not found for -lgcc_s.10.4`
+  * Don't built for i386 architecture as it is deprecated
+* Several fixes for MSVC build on Windows. #779
+* Use `ucrtbase.dll` as default C library on Windows instead of old `msvcrt.dll`. #779
+* Update builtin libffi to fix a Powerpc issue with parameters of type long
+* Allow unmodified sourcing of (the ruby code of) this gem in JRuby and TruffleRuby as a default gem. #747
+* Improve check to detect if a module has a #find_type method suitable for FFI. This fixes compatibility with stdlib `mkmf` . #776
+
+Removed:
+* Reject callback with `:string` return type at definition, because it didn't work so far and is not save to use. #751, #782
+
+
+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
 -------------------
 
@@ -8,6 +214,7 @@ Changed:
 
 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

data/Gemfile

@@ -1,12 +1,11 @@
 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'
+  gem 'bundler', '>= 1.16', '< 3'
 end
 
 group :doc do

data/README.md

@@ -1,4 +1,4 @@
-# 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)
+# Ruby-FFI https://github.com/ffi/ffi/wiki [![Build Status](https://travis-ci.com/ffi/ffi.svg?branch=master)](https://travis-ci.com/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
 
@@ -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`.
@@ -53,14 +62,26 @@ On JRuby and TruffleRuby, there are no requirements to install the FFI gem, and
 From rubygems:
 
     [sudo] gem install ffi
+    
+From a Gemfile using git or GitHub
+
+    gem 'ffi', github: 'ffi/ffi', submodules: true
 
 or from the git repository on github:
 
     git clone git://github.com/ffi/ffi.git
-    git submodule update --init --recursive
     cd ffi
+    git submodule update --init --recursive
+    bundle install
     rake install
 
+### Install options:
+
+* `--enable-system-libffi` : Force usage of system libffi
+* `--disable-system-libffi` : Force usage of builtin libffi
+* `--enable-libffi-alloc` : Force closure allocation by libffi
+* `--disable-libffi-alloc` : Force closure allocation by builtin method
+
 ## License
 
 The ffi library is covered by the BSD license, also see the LICENSE file.

data/Rakefile

@@ -1,40 +1,24 @@
-require 'rubygems/tasks'
 require 'rbconfig'
-require 'rake/clean'
-require File.expand_path("./lib/ffi/version")
-
 require 'date'
 require 'fileutils'
 require 'rbconfig'
 require 'rspec/core/rake_task'
 require 'rubygems/package_task'
-
-def java?
-  /java/ === RUBY_PLATFORM
-end
+require 'rake/extensiontask'
+require_relative "lib/ffi/version"
+require_relative "rakelib/ffi_gem_helper"
 
 BUILD_DIR = "build"
 BUILD_EXT_DIR = File.join(BUILD_DIR, "#{RbConfig::CONFIG['arch']}", 'ffi_c', RUBY_VERSION)
 
-def gem_spec
-  @gem_spec ||= Gem::Specification.load('ffi.gemspec')
-end
-
-TEST_DEPS = []
-if RUBY_PLATFORM == "java"
-  RSpec::Core::RakeTask.new(:spec) do |config|
-    config.rspec_opts = YAML.load_file 'spec/spec.opts'
-  end
-else
-  RSpec::Core::RakeTask.new(:spec => :compile) do |config|
-    config.rspec_opts = YAML.load_file 'spec/spec.opts'
-  end
+gem_spec = Bundler.load_gemspec('ffi.gemspec')
 
-  TEST_DEPS.unshift :compile
+RSpec::Core::RakeTask.new(:spec => :compile) do |config|
+  config.rspec_opts = YAML.load_file 'spec/spec.opts'
 end
 
 desc "Build all packages"
-task :package => %w[ gem:java gem:windows ]
+task :package => %w[ gem:java gem:native ]
 
 CLOBBER.include 'lib/ffi/types.conf'
 CLOBBER.include 'pkg'
@@ -50,6 +34,13 @@ CLEAN.include "pkg/ffi-*-{mingw32,java}"
 CLEAN.include 'lib/1.*'
 CLEAN.include 'lib/2.*'
 
+# clean all shipped files, that are not in git
+CLEAN.include(
+    gem_spec.files -
+    `git --git-dir ext/ffi_c/libffi/.git ls-files -z`.split("\x0").map { |f| File.join("ext/ffi_c/libffi", f) } -
+    `git ls-files -z`.split("\x0")
+)
+
 task :distclean => :clobber
 
 desc "Test the extension"
@@ -58,37 +49,29 @@ task :test => [ :spec ]
 
 namespace :bench do
   ITER = ENV['ITER'] ? ENV['ITER'].to_i : 100000
-  bench_libs = "-Ilib" unless RUBY_PLATFORM == "java"
-  bench_files = Dir["bench/bench_*.rb"].reject { |f| f == "bench/bench_helper.rb" }
+  bench_files = Dir["bench/bench_*.rb"].sort.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}}
+    task File.basename(bench, ".rb")[6..-1] => :compile do
+      sh %{#{Gem.ruby} #{bench} #{ITER}}
     end
   end
-  task :all => TEST_DEPS do
+  task :all => :compile do
     bench_files.each do |bench|
-      sh %{#{Gem.ruby} #{bench_libs} #{bench}}
+      sh %{#{Gem.ruby} #{bench}}
     end
   end
 end
 
-task 'spec:run' => TEST_DEPS
-task 'spec:specdoc' => TEST_DEPS
+task 'spec:run' => :compile
+task 'spec:specdoc' => :compile
 
 task :default => :spec
 
 namespace 'java' do
 
-  java_gem_spec = Gem::Specification.new do |s|
-    s.name = gem_spec.name
-    s.version = gem_spec.version
-    s.author = gem_spec.author
-    s.email = gem_spec.email
-    s.homepage = gem_spec.homepage
-    s.summary = gem_spec.summary
-    s.description = gem_spec.description
-    s.files = %w(LICENSE COPYING README.md CHANGELOG.md Rakefile)
-    s.license = gem_spec.license
+  java_gem_spec = gem_spec.dup.tap do |s|
+    s.files.reject! { |f| File.fnmatch?("ext/*", f) }
+    s.extensions = []
     s.platform = 'java'
   end
 
@@ -101,36 +84,49 @@ end
 
 task 'gem:java' => 'java:gem'
 
-unless java?
+FfiGemHelper.install_tasks
+# Register windows gems to be pushed to rubygems.org
+Bundler::GemHelper.instance.cross_platforms = %w[x86-mingw32 x64-mingw-ucrt x64-mingw32]
+
+if RUBY_ENGINE == 'ruby' || RUBY_ENGINE == 'rbx'
   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.
     ext.tmp_dir = BUILD_DIR                                   # temporary folder used during compilation.
     ext.cross_compile = true                                  # enable cross compilation (requires cross compile toolchain)
-    ext.cross_platform = %w[i386-mingw32 x64-mingw32]                     # forces the Windows platform instead of the default one
+    ext.cross_platform = Bundler::GemHelper.instance.cross_platforms
     ext.cross_compiling do |spec|
       spec.files.reject! { |path| File.fnmatch?('ext/*', path) }
     end
+
+  end
+else
+  task :compile do
+    STDERR.puts "Nothing to compile on #{RUBY_ENGINE}"
   end
+end
 
-  # To reduce the gem file size strip mingw32 dlls before packaging
-  ENV['RUBY_CC_VERSION'].to_s.split(':').each do |ruby_version|
-    task "build/i386-mingw32/stage/lib/#{ruby_version[/^\d+\.\d+/]}/ffi_c.so" do |t|
-      sh "i686-w64-mingw32-strip -S build/i386-mingw32/stage/lib/#{ruby_version[/^\d+\.\d+/]}/ffi_c.so"
-    end
 
-    task "build/x64-mingw32/stage/lib/#{ruby_version[/^\d+\.\d+/]}/ffi_c.so" do |t|
-      sh "x86_64-w64-mingw32-strip -S build/x64-mingw32/stage/lib/#{ruby_version[/^\d+\.\d+/]}/ffi_c.so"
-    end
+namespace "gem" do
+  task 'prepare' do
+    require 'rake_compiler_dock'
+    sh "bundle package --all"
   end
-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`'"
+  Bundler::GemHelper.instance.cross_platforms.each do |plat|
+    desc "Build all native binary gems in parallel"
+    multitask 'native' => plat
+
+    desc "Build the native gem for #{plat}"
+    task plat => ['prepare', 'build'] do
+      RakeCompilerDock.sh <<-EOT, platform: plat
+        sudo apt-get update &&
+        sudo apt-get install -y libltdl-dev && bundle --local &&
+        rake cross native gem MAKE='nice make -j`nproc`' RUBY_CC_VERSION=${RUBY_CC_VERSION/:2.2.2/}
+      EOT
+    end
+  end
 end
 
 directory "ext/ffi_c/libffi"
@@ -142,7 +138,7 @@ task :libffi => "ext/ffi_c/libffi/autogen.sh"
 
 LIBFFI_GIT_FILES = `git --git-dir ext/ffi_c/libffi/.git ls-files -z`.split("\x0")
 
-# Generate files in gemspec but not in libffi's git repo by running autogen.sh
+# Generate files which are in the gemspec but not in libffi's git repo by running autogen.sh
 gem_spec.files.select do |f|
   f =~ /ext\/ffi_c\/libffi\/(.*)/ && !LIBFFI_GIT_FILES.include?($1)
 end.each do |f|
@@ -158,16 +154,20 @@ end.each do |f|
   end
 end
 
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'lib')
-require 'ffi/platform'
+# Make sure we have all gemspec files before packaging
+task :build => gem_spec.files
+task :gem => :build
+
+
+require_relative "lib/ffi/platform"
 types_conf = File.expand_path(File.join(FFI::Platform::CONF_DIR, 'types.conf'))
 logfile = File.join(File.dirname(__FILE__), 'types_log')
 
-file types_conf => File.join("lib", "ffi", "version.rb") do |task|
+task types_conf do |task|
   require 'fileutils'
-  require 'ffi/tools/types_generator'
+  require_relative "lib/ffi/tools/types_generator"
   options = {}
-  FileUtils.mkdir_p(File.dirname(task.name), { :mode => 0755 })
+  FileUtils.mkdir_p(File.dirname(task.name), mode: 0755 )
   File.open(task.name, File::CREAT|File::TRUNC|File::RDWR, 0644) do |f|
     f.puts FFI::TypesGenerator.generate(options)
   end
@@ -176,12 +176,8 @@ file types_conf => File.join("lib", "ffi", "version.rb") do |task|
   end
 end
 
-task :types_conf => types_conf do
-end
-
-Gem::Tasks.new do |t|
-  t.scm.tag.format = '%s'
-end
+desc "Create or update type information for platform #{FFI::Platform::NAME}"
+task :types_conf => types_conf
 
 begin
   require 'yard'