ffi 1.10.0 → 1.15.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 108ea9d730d92bf5994912324af1cd21b23256c575d0344a7884990d8307baa7
-  data.tar.gz: be60f268828396e8b67d1329ac95b136f4f03a229d37f95f73d35dcd1fb8908c
+  metadata.gz: d6f15f4e38ad34949be88341216eed2ea132c4e5763d333c20c240491b033ff6
+  data.tar.gz: deefb7285ccae7d7248ee2697709e859d4c0017e3aab7e183ce7fc2a824bd395
 SHA512:
-  metadata.gz: eed04778f789f4216f78466bc8fb3f30efa96f3da66720fe3fcce1f5eba01213387c20fe0eb1bcd73146931cefdc68133a3d6a1723b921e1ce00adb58e8e6440
-  data.tar.gz: 8c8c96560189bce8d0a95513872028692b89d181ed8ba68752085cbcac2cf957bde9b00c6666946646849acea167b300c28727fd9669098cfb83514fbcf29474
+  metadata.gz: 7b2c32adb0af3689632c9b6113389245dba13d5f9e622efd2f322b0226933185ae0fbc128cb33c278dd2ef7fddda106fe8158904e95d1fa7d53b14ff72722ff6
+  data.tar.gz: 60ca6ad01c3d977b8b6efe0329683d4105cae8147848c9fcb0cabe643f5957e7a6ab6a06716e1f579ada6e0c3795f4fd4c0f16bda783342310a305423a5d7a60

data/CHANGELOG.md

@@ -1,3 +1,243 @@
+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
+-------------------
+
+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
 -------------------
 

data/Gemfile

@@ -1,12 +1,11 @@
 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.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,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.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
 
-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,39 +30,62 @@ 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
 
 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.
-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 +97,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>