ffi 1.15.5 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6f15f4e38ad34949be88341216eed2ea132c4e5763d333c20c240491b033ff6
-  data.tar.gz: deefb7285ccae7d7248ee2697709e859d4c0017e3aab7e183ce7fc2a824bd395
+  metadata.gz: 482fe808cf14286b91be92938712e98f6332021d2773268f96ac583b5c264fc9
+  data.tar.gz: f89f881dd5e337ec5ec815e9977158b54ead3a2480bc03fd2591477c7872d29e
 SHA512:
-  metadata.gz: 7b2c32adb0af3689632c9b6113389245dba13d5f9e622efd2f322b0226933185ae0fbc128cb33c278dd2ef7fddda106fe8158904e95d1fa7d53b14ff72722ff6
-  data.tar.gz: 60ca6ad01c3d977b8b6efe0329683d4105cae8147848c9fcb0cabe643f5957e7a6ab6a06716e1f579ada6e0c3795f4fd4c0f16bda783342310a305423a5d7a60
+  metadata.gz: 877625d5994e1b456e8cf12a68647ce4e9d64efac2239c7a4e1806406b803fad5c1138ba0ad7e8b34ac6b8ebfeaed9f469381291f394527c523c4db8f36bd976
+  data.tar.gz: 8d78610fc0c110ad7d6da40158dab176d815c8008a1276865b9112a44b46e1d43816db7430f9ab991671e4e8fad4dec0880fa259e2e2c83afaf916f59b7bb5c9

data/CHANGELOG.md

@@ -1,3 +1,121 @@
+1.17.0 / 2024-06-02
+-------------------
+
+Fixed:
+* Add FFI::AbstractMemory#read_array_of_string . It was defined but not exposed to Ruby nor tested. #1070
+
+
+1.17.0.rc2 / 2024-04-22
+-------------------
+
+Fixed:
+* Add missing write barriers to StructLayout#initialize causing a segfault with GC.stress. #1079
+
+
+1.17.0.rc1 / 2024-04-08
+-------------------
+
+Fixed:
+* Fix type definitions on `aarch64-linux`. #1067, #1066
+* Use RB_TEST for `Pointer.autorelease=` . #1065
+  So that `false` and `nil` are treated as falsey and anything else as truthy.
+* Replace Fixnum by Integer. #1064
+  Fixnum is no longer present in the ruby language.
+* Update `FFI::NativeType` doc. #1061
+* Store FFI::Type::Mapped of FFI::StrPtrConverter in global instead of custom type map
+* Various documentation fixes. #1042
+* Update `FFI::Pointer#==` to return `false` if a pointer is compared to a non-pointer object, which is the expected behavior. #1083
+* Avoid warning about undefined wariable `@ffi_functions` #1085
+* Fix a very unlikely GC bug when using a callback block. # 1089
+
+Added:
+* Provide binary gems for many platforms. #990
+* Add Windows fat binary gem for Ruby-3.3
+* Add RBS type definitions for many user facing parts of the FFI API. #1042
+* Improve fallback search path logic. #1088
+  Respect LD_LIBRARY_PATH and DYLD_LIBRARY_PATH on Macos.
+* Update libffi to current git master branch.
+
+Removed:
+* Remove `enum CHAR_ARRAY` which is no longer used. #1063
+
+
+1.16.3 / 2023-10-04
+-------------------
+
+Fixed:
+* Fix gcc error when building on CentOS 7. #1052
+* Avoid trying to store new DataConverter type in frozen TypeDefs hash. #1057
+
+
+1.16.2 / 2023-09-25
+-------------------
+
+Fixed:
+* Handle null pointer crash after fork. #1051
+
+
+1.16.1 / 2023-09-24
+-------------------
+
+Fixed:
+* Fix compiling the builtin libffi. #1049
+
+
+1.16.0 / 2023-09-23
+-------------------
+
+Fixed:
+* Fix an issue with signed bitmasks when using flags on the most significant bit. #949
+* Fix FFI::Pointer#initialize using NUM2LL instead of NUM2ULL.
+* Fix FFI::Type#inspect to properly display the constant name. #1002
+* Use libffi closure allocations on hppa-Linux. #1017
+  Previously they would segfault.
+* Fix class name of Symbol#inspect.
+* Fix MSVC support of libtest. #1028
+* Fix attach_function of functions ending in ? or ! #971
+
+Added:
+* Convert all C-based classes to TypedData and use write barriers. #994, #995, #996, #997, #998, #999, #1000, #1001, #1003, #1004, #1005, #1006, #1007, #1008, #1009, #1010, #1011, #1012
+  This results in less pressure on the garbage collector, since the objects can be promoted to the old generation, which means they only get marked on major GC.
+* Implement `ObjectSpace.memsize_of()` of all C-based classes.
+* Make FFI Ractor compatible. #1023
+  Modules extended per `extend FFI::Library` need to be frozen in order to be used by non-main Ractors.
+  This can be done by calling `freeze` below of all C interface definitions.
+  * In a Ractor it's possible to:
+    * load DLLs and call its functions, access its global variables
+    * use builtin typedefs
+    * use and modify ractor local typedefs
+    * define callbacks
+    * receive async callbacks from non-ruby threads
+    * use frozen FFI::Library based modules with all attributes (enums, structs, typedefs, functions, callbacks)
+    * invoke frozen functions and callbacks defined in the main Ractor
+    * use FFI::Struct definitions from the main Ractor
+  * In a Ractor it's impossible to:
+    * create new FFI::Library based modules
+    * create new FFI::Struct definitions
+    * use custom global typedefs
+    * use non-frozen FFI::Library based modules
+* Allow type retrieval of attached functions+variables. #1023
+* Make FFI classes `GC.compact` friendly. #1021
+* Update libffi and disable custom trampoline when using libffi closure allocation. #1020
+  This is because libffi changed the way how closures are allocated to static trampolines.
+* Add types.conf for loongarch64-linux. #943
+* Add types.conf for sw_64-linux (Shen Wei 64-bit, based on Alpha).  #1018
+* Add support for aarch64-windows. #1035
+* Windows: Update LoadLibrary error message to include error code. #1026
+* Allow private release method for FFI::ManagedStruct and FFI::AutoPointer. #1029
+* Add support for passing ABI version to FFI.map_library_name. #963
+  This adds the new class FFI::LibraryPath .
+* Add support for ruby-3.2 to windows binary gem. #1047
+* Enable debug symbols for `rake compile` builds to ease debugging. #1048
+
+Removed:
+* Remove allocator of AbstractMemory. #1013
+  This disables AbstractMemory.new, which has no practical use.
+* Remove unused FFI::SizeTypes. #1022
+
+
 1.15.5 / 2022-01-10
 -------------------
 

data/Gemfile

@@ -1,14 +1,21 @@
 source 'https://rubygems.org'
 
 group :development do
+  gem 'bigdecimal' # necessary on ruby-3.3+
+  gem 'bundler', '>= 1.16', '< 3'
   gem 'rake', '~> 13.0'
-  gem 'rake-compiler', '~> 1.0.3'
-  gem 'rake-compiler-dock', '~> 1.0'
+  gem 'rake-compiler', '~> 1.1'
+  gem 'rake-compiler-dock', '~> 1.0.pre'
   gem 'rspec', '~> 3.0'
-  gem 'bundler', '>= 1.16', '< 3'
 end
 
 group :doc do
   gem 'kramdown'
   gem 'yard', '~> 0.9'
 end
+
+group :type_check do
+  if RUBY_VERSION >= "2.6" && %w[ ruby truffleruby ].include?(RUBY_ENGINE)
+    gem 'rbs', '~> 3.0'
+  end
+end

data/README.md

@@ -1,4 +1,4 @@
-# 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)
+# Ruby-FFI https://github.com/ffi/ffi/wiki
 
 ## Description
 
@@ -15,6 +15,7 @@ using Ruby-FFI](https://github.com/ffi/ffi/wiki/why-use-ffi).
 * C structs (also nested), enums and global variables
 * Callbacks from C to Ruby
 * Automatic garbage collection of native memory
+* Usable in Ractor: [How-to-use-FFI-in-Ruby-Ractors](https://github.com/ffi/ffi/wiki/Ractors)
 
 ## Synopsis
 
@@ -62,7 +63,7 @@ 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
@@ -113,7 +114,7 @@ The following people have submitted code, bug reports, or otherwise contributed
 * Jurij Smakov <jurij@wooyd.org>
 * KISHIMOTO, Makoto <ksmakoto@dd.iij4u.or.jp>
 * Kim Burgestrand <kim@burgestrand.se>
-* Lars Kanis <kanis@comcard.de>
+* Lars Kanis <lars@greiz-reinsdorf.de>
 * Luc Heinrich <luc@honk-honk.com>
 * Luis Lavena <luislavena@gmail.com>
 * Matijs van Zuijlen <matijs@matijs.net>

data/Rakefile

@@ -1,7 +1,7 @@
 require 'rbconfig'
 require 'date'
 require 'fileutils'
-require 'rbconfig'
+require 'yaml'
 require 'rspec/core/rake_task'
 require 'rubygems/package_task'
 require 'rake/extensiontask'
@@ -13,7 +13,7 @@ BUILD_EXT_DIR = File.join(BUILD_DIR, "#{RbConfig::CONFIG['arch']}", 'ffi_c', RUB
 
 gem_spec = Bundler.load_gemspec('ffi.gemspec')
 
-RSpec::Core::RakeTask.new(:spec => :compile) do |config|
+RSpec::Core::RakeTask.new(:spec) do |config|
   config.rspec_opts = YAML.load_file 'spec/spec.opts'
 end
 
@@ -30,9 +30,8 @@ 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 "pkg/ffi-*-*/"
+CLEAN.include 'lib/{2,3}.*'
 
 # clean all shipped files, that are not in git
 CLEAN.include(
@@ -85,8 +84,22 @@ end
 task 'gem:java' => 'java:gem'
 
 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]
+# Register binary gems to be pushed to rubygems.org
+Bundler::GemHelper.instance.cross_platforms = %w[
+  x86-mingw32
+  x64-mingw-ucrt
+  x64-mingw32
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-linux-gnu
+  x86_64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  x86_64-darwin
+  arm64-darwin
+]
 
 if RUBY_ENGINE == 'ruby' || RUBY_ENGINE == 'rbx'
   require 'rake/extensiontask'
@@ -99,6 +112,8 @@ if RUBY_ENGINE == 'ruby' || RUBY_ENGINE == 'rbx'
     ext.cross_compiling do |spec|
       spec.files.reject! { |path| File.fnmatch?('ext/*', path) }
     end
+    # Enable debug info for 'rake compile' but not for 'gem install'
+    ext.config_options << "--enable-debug"
 
   end
 else
@@ -121,9 +136,9 @@ namespace "gem" do
     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/}
+        #{ "sudo apt-get update && sudo apt-get install -y libltdl-dev &&" if plat !~ /linux/ }
+        bundle --local &&
+        rake native:#{plat} pkg/#{gem_spec.full_name}-#{plat}.gem MAKE='nice make -j`nproc`' RUBY_CC_VERSION=${RUBY_CC_VERSION/:2.4.0/}
       EOT
     end
   end