CHANGELOG.md

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

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

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

Changed:

• Revert closures via libffi. This re-adds ClosurePool and fixes compat with SELinux enabled systems. #621

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)

Changed:

• Update libffi to latest changes on master.
• Don't search in hardcoded /usr paths on Windows.
• Don't treat Symbol args different to Strings in ffi_lib.
• Make sure size_t is defined in Thread.c. Fixes #609

1.9.23 / 2018-02-25

Changed:

• Fix unnecessary rebuild of configure in darwin multi arch. Fixes #605

1.9.22 / 2018-02-22

Changed:

• Update libffi to latest changes on master.
• Update detection of system libffi to match new requirements. Fixes #617
• Prefer bundled libffi over system libffi on Mac OS.
• Do closures via libffi. This removes ClosurePool and fixes compat with PaX. #540
• Use a more deterministic gem packaging.
• Fix unnecessary update of autoconf files at gem install.

1.9.21 / 2018-02-06

Added:

• Ruby-2.5 support by Windows binary gems. Fixes #598
• Add missing win64 types.
• Added support for Bitmask. (#573)
• Add support for MSYS2 (#572) and Sparc64 Linux. (#574)

Changed:

• Fix read_string to not throw an error on length 0.
• Don't use absolute paths for sh and env. Fixes usage on Adroid #528
• Use Ruby implementation for which for better compat with Windows. Fixes #315
• Fix compatibility with PPC64LE platform. (#577)
• Normalize sparc64 to sparcv9. (#575)

Removed:

• Drop Ruby 1.8.7 support (#480)

1.9.18 / 2017-03-03

Added:

• Add compatibility with Ruby-2.4.

Changed:

• Add missing shlwapi.h include to fix Windows build.
• Avoid undefined behaviour of LoadLibrary() on Windows. #553

1.9.17 / 2017-01-13