ffi 1.17.0 → 1.17.4

data/ext/ffi_c/libffi/src/{wasm32 → wasm}/ffitarget.h

@@ -42,14 +42,31 @@ typedef void (*ffi_fp)(void);
 
 typedef enum ffi_abi {
   FFI_FIRST_ABI = 0,
+#if __SIZEOF_POINTER__ == 4
   FFI_WASM32, // "raw", no structures, varargs, or closures (not implemented!)
   FFI_WASM32_EMSCRIPTEN, // structures, varargs, and split 64-bit params
+#elif __SIZEOF_POINTER__ == 8
+  FFI_WASM64,
+  FFI_WASM64_EMSCRIPTEN,
+#else
+#error "Unknown pointer size"
+#endif
   FFI_LAST_ABI,
+#if __SIZEOF_POINTER__ == 4
 #ifdef __EMSCRIPTEN__
   FFI_DEFAULT_ABI = FFI_WASM32_EMSCRIPTEN
 #else
   FFI_DEFAULT_ABI = FFI_WASM32
 #endif
+#elif __SIZEOF_POINTER__ == 8
+#ifdef __EMSCRIPTEN__
+  FFI_DEFAULT_ABI = FFI_WASM64_EMSCRIPTEN
+#else
+  FFI_DEFAULT_ABI = FFI_WASM64
+#endif
+#else
+#error "Unknown pointer size"
+#endif
 } ffi_abi;
 
 #define FFI_CLOSURES 1

data/ext/ffi_c/libffi/src/x86/ffi.c

@@ -118,7 +118,7 @@ ffi_prep_cif_machdep(ffi_cif *cif)
       break;
     case FFI_TYPE_STRUCT:
       {
-#ifdef X86_WIN32
+#if defined(X86_WIN32) || defined(X86_DARWIN)
         size_t size = cif->rtype->size;
         if (size == 1)
           flags = X86_RET_STRUCT_1B;
@@ -270,6 +270,9 @@ extern void FFI_DECLARE_FASTCALL ffi_call_i386(struct call_frame *, char *) FFI_
 #if defined(_MSC_VER)
 #pragma runtime_checks("s", off)
 #endif
+/* n.b. ffi_call_unix64 will steal the alloca'd `stack` variable here for use
+   _as its own stack_ - so we need to compile this function without ASAN */
+FFI_ASAN_NO_SANITIZE
 static void
 ffi_call_int (ffi_cif *cif, void (*fn)(void), void *rvalue,
 	      void **avalue, void *closure)

data/ext/ffi_c/libffi/src/x86/ffi64.c

@@ -557,6 +557,9 @@ ffi_prep_cif_machdep (ffi_cif *cif)
   return FFI_OK;
 }
 
+/* n.b. ffi_call_unix64 will steal the alloca'd `stack` variable here for use
+   _as its own stack_ - so we need to compile this function without ASAN */
+FFI_ASAN_NO_SANITIZE
 static void
 ffi_call_int (ffi_cif *cif, void (*fn)(void), void *rvalue,
 	      void **avalue, void *closure)
@@ -651,7 +654,7 @@ ffi_call_int (ffi_cif *cif, void (*fn)(void), void *rvalue,
 		      break;
 		    default:
 		      reg_args->gpr[gprcount] = 0;
-		      memcpy (&reg_args->gpr[gprcount], a, size);
+		      memcpy (&reg_args->gpr[gprcount], a, size <= 8 ? size : 8);
 		    }
 		  gprcount++;
 		  break;

data/ext/ffi_c/libffi/src/x86/ffitarget.h

@@ -41,9 +41,6 @@
 
 #if defined (X86_64) && defined (__i386__)
 #undef X86_64
-#warning ******************************************************
-#warning ********** X86 IS DEFINED ****************************
-#warning ******************************************************
 #define X86
 #endif
 

data/ext/ffi_c/libffi/src/x86/sysv.S

@@ -458,9 +458,7 @@ L(UW24):
 L(UW25):
 	# cfi_def_cfa_offset(closure_FS + 4)
 	FFI_CLOSURE_SAVE_REGS
-	movl	closure_FS-4(%esp), %ecx	/* load retaddr */
-	movl	closure_FS(%esp), %eax		/* load closure */
-	movl	%ecx, closure_FS(%esp)		/* move retaddr */
+	movl	closure_FS-4(%esp), %eax	/* load closure */
 	jmp	L(do_closure_REGISTER)
 L(UW26):
 	# cfi_endproc

data/ext/ffi_c/libffi/src/x86/sysv_intel.S

@@ -394,9 +394,7 @@ L(UW24):
 L(UW25):
 	/* cfi_def_cfa_offset(closure_FS + 4) */
 	FFI_CLOSURE_SAVE_REGS
-	mov	ecx, [esp+closure_FS-4] 	/* load retaddr */
-	mov	eax, [esp+closure_FS]		/* load closure */
-	mov	[esp+closure_FS], ecx		/* move retaddr */
+	mov	eax, [esp+closure_FS-4] 	/* load closure */
 	jmp	L(do_closure_REGISTER)
 L(UW26):
 	/* cfi_endproc */

data/ext/ffi_c/libffi/testsuite/Makefile.in

@@ -174,6 +174,8 @@ EGREP = @EGREP@
 ETAGS = @ETAGS@
 EXEEXT = @EXEEXT@
 FFI_EXEC_TRAMPOLINE_TABLE = @FFI_EXEC_TRAMPOLINE_TABLE@
+FFI_VERSION_NUMBER = @FFI_VERSION_NUMBER@
+FFI_VERSION_STRING = @FFI_VERSION_STRING@
 FGREP = @FGREP@
 FILECMD = @FILECMD@
 GREP = @GREP@
@@ -224,6 +226,7 @@ TARGET = @TARGET@
 TARGETDIR = @TARGETDIR@
 TARGET_OBJ = @TARGET_OBJ@
 VERSION = @VERSION@
+WASM64_MEMORY64 = @WASM64_MEMORY64@
 abs_builddir = @abs_builddir@
 abs_srcdir = @abs_srcdir@
 abs_top_builddir = @abs_top_builddir@
@@ -232,6 +235,7 @@ ac_ct_AR = @ac_ct_AR@
 ac_ct_CC = @ac_ct_CC@
 ac_ct_CXX = @ac_ct_CXX@
 ac_ct_DUMPBIN = @ac_ct_DUMPBIN@
+ac_ct_READELF = @ac_ct_READELF@
 am__include = @am__include@
 am__leading_dot = @am__leading_dot@
 am__quote = @am__quote@
@@ -301,8 +305,8 @@ EXTRA_DIST = config/default.exp emscripten/build.sh emscripten/conftest.py \
 	libffi.call/float1.c libffi.call/float2.c libffi.call/float3.c \
 	libffi.call/float4.c libffi.call/float_va.c libffi.call/many.c \
 	libffi.call/many2.c libffi.call/many_double.c libffi.call/many_mixed.c \
-	libffi.call/negint.c libffi.call/offsets.c libffi.call/pr1172638.c \
-	libffi.call/promotion.c libffi.call/pyobjc_tc.c libffi.call/return_dbl.c \
+	libffi.call/negint.c libffi.call/offsets.c libffi.call/overread.c \
+	libffi.call/pr1172638.c libffi.call/promotion.c libffi.call/pyobjc_tc.c libffi.call/return_dbl.c \
 	libffi.call/return_dbl1.c libffi.call/return_dbl2.c libffi.call/return_fl.c \
 	libffi.call/return_fl1.c libffi.call/return_fl2.c libffi.call/return_fl3.c \
 	libffi.call/return_ldl.c libffi.call/return_ll.c libffi.call/return_ll1.c \
@@ -315,10 +319,11 @@ EXTRA_DIST = config/default.exp emscripten/build.sh emscripten/conftest.py \
 	libffi.call/struct9.c libffi.call/struct_by_value_2.c libffi.call/struct_by_value_3.c \
 	libffi.call/struct_by_value_3f.c libffi.call/struct_by_value_4.c libffi.call/struct_by_value_4f.c \
 	libffi.call/struct_by_value_big.c libffi.call/struct_by_value_small.c libffi.call/struct_return_2H.c \
+	libffi.call/struct_int_float.c libffi.call/longjmp.c \
 	libffi.call/struct_return_8H.c libffi.call/uninitialized.c libffi.call/va_1.c \
 	libffi.call/va_2.c libffi.call/va_3.c libffi.call/va_struct1.c \
 	libffi.call/va_struct2.c libffi.call/va_struct3.c libffi.call/callback.c \
-	libffi.call/callback2.c libffi.call/callback3.c libffi.call/callback4.c \
+	libffi.call/callback2.c libffi.call/callback3.c libffi.call/callback4.c libffi.call/x32.c \
 	libffi.closures/closure.exp libffi.closures/closure_fn0.c libffi.closures/closure_fn1.c \
 	libffi.closures/closure_fn2.c libffi.closures/closure_fn3.c libffi.closures/closure_fn4.c \
 	libffi.closures/closure_fn5.c libffi.closures/closure_fn6.c libffi.closures/closure_loc_fn0.c \
@@ -368,7 +373,8 @@ EXTRA_DIST = config/default.exp emscripten/build.sh emscripten/conftest.py \
 	libffi.complex/return_complex2_float.c libffi.complex/return_complex2_longdouble.c libffi.complex/return_complex_double.c \
 	libffi.complex/return_complex_float.c libffi.complex/return_complex_longdouble.c libffi.go/aa-direct.c \
 	libffi.go/closure1.c libffi.go/ffitest.h libffi.go/go.exp \
-	libffi.go/static-chain.h Makefile.am Makefile.in
+	libffi.go/static-chain.h Makefile.am Makefile.in \
+	libffi.threads/ffitest.h libffi.threads/threads.exp libffi.threads/tsan.c
 
 all: all-am
 

data/ext/ffi_c/libffi.mk

@@ -16,3 +16,8 @@ $(LIBFFI):
 		sh $(LIBFFI_CONFIGURE) $(LIBFFI_HOST) > /dev/null; \
 	fi
 	$(MAKE) -C "$(LIBFFI_BUILD_DIR)"
+
+install: install-cleanup
+
+install-cleanup: $(DLLIB)
+	rm -rf "$(LIBFFI_BUILD_DIR)"

data/ffi.gemspec

@@ -15,13 +15,16 @@ Gem::Specification.new do |s|
     s.metadata['wiki_uri'] = 'https://github.com/ffi/ffi/wiki'
     s.metadata['source_code_uri'] = 'https://github.com/ffi/ffi/'
     s.metadata['mailing_list_uri'] = 'http://groups.google.com/group/ruby-ffi'
+    s.metadata['rubygems_mfa_required'] = 'true'
   end
   s.files = `git ls-files -z`.split("\x0").reject do |f|
-    f =~ /^(\.|bench|gen|libtest|nbproject|spec)/
+    f =~ /^(\.|bench|gen|libtest|nbproject|spec|rakelib)/
   end
 
   # Add libffi git files
-  lfs = `git --git-dir ext/ffi_c/libffi/.git ls-files -z`.split("\x0")
+  lfs = `git --git-dir ext/ffi_c/libffi/.git ls-files -z`.split("\x0").reject do |f|
+    f =~ /^(\.|testsuite)/
+  end
   # Add autoconf generated files of libffi
   lfs += %w[ compile configure config.guess config.sub install-sh ltmain.sh missing fficonfig.h.in ]
   # Add automake generated files of libffi
@@ -35,8 +38,6 @@ Gem::Specification.new do |s|
   s.license = 'BSD-3-Clause'
   s.require_paths << 'ext/ffi_c'
   s.required_ruby_version = '>= 2.5'
-  s.add_development_dependency 'rake', '~> 13.0'
-  s.add_development_dependency 'rake-compiler', '~> 1.1'
-  s.add_development_dependency 'rake-compiler-dock', '~> 1.0'
-  s.add_development_dependency 'rspec', '~> 2.14.1'
+
+  s.metadata['msys2_mingw_dependencies'] = 'libffi'
 end

data/lib/ffi/autopointer.rb

@@ -89,6 +89,12 @@ module FFI
       self
     end
 
+    def dup
+      raise RuntimeError, "cannot duplicate FFI::AutoPointer"
+    end
+
+    alias clone dup
+
     # @return [nil]
     # Free the pointer.
     def free

data/lib/ffi/compat.rb

@@ -40,4 +40,15 @@ module FFI
       obj.freeze
     end
   end
+
+  if defined?(Ractor.shareable_proc)
+    # This is for FFI internal use only.
+    def self.shareable_proc(**kwargs, &block)
+      Ractor.shareable_proc(**kwargs, &block)
+    end
+  else
+    def self.shareable_proc(**_kwargs, &block)
+      block
+    end
+  end
 end

data/lib/ffi/ffi.rb

@@ -48,3 +48,62 @@ require 'ffi/variadic'
 require 'ffi/enum'
 require 'ffi/version'
 require 'ffi/function'
+
+module FFI
+  module ModernForkTracking
+    def _fork
+      pid = super
+      if pid == 0
+        FFI._async_cb_dispatcher_atfork_child
+      end
+      pid
+    end
+  end
+
+  module LegacyForkTracking
+    module KernelExt
+      def fork
+        if block_given?
+          super do
+            FFI._async_cb_dispatcher_atfork_child
+            yield
+          end
+        else
+          pid = super
+          FFI._async_cb_dispatcher_atfork_child if pid.nil?
+          pid
+        end
+      end
+    end
+
+    module KernelExtPrivate
+      include KernelExt
+      private :fork
+    end
+
+    module IOExt
+      def popen(*args)
+        return super unless args[0] == '-'
+
+        super(*args) do |pipe|
+          FFI._async_cb_dispatcher_atfork_child if pipe.nil?
+          yield pipe
+        end
+      end
+      ruby2_keywords :popen if respond_to?(:ruby2_keywords)
+    end
+  end
+
+  if Process.respond_to?(:_fork)
+    # The nice Ruby 3.1+ way of doing things
+    ::Process.singleton_class.prepend(ModernForkTracking)
+  elsif Process.respond_to?(:fork)
+    # Barf. Old CRuby.
+    # Most of the inspiration for how to do this was stolen from ActiveSupport.
+    ::Object.prepend(LegacyForkTracking::KernelExtPrivate)
+    ::Object.singleton_class.prepend(LegacyForkTracking::KernelExt)
+    ::Kernel.prepend(LegacyForkTracking::KernelExtPrivate)
+    ::Kernel.singleton_class.prepend(LegacyForkTracking::KernelExt)
+    ::IO.singleton_class.prepend(LegacyForkTracking::IOExt)
+  end
+end

data/lib/ffi/function.rb

@@ -51,6 +51,29 @@ module FFI
       end
     end
 
+    if RUBY_PLATFORM == 'aarch64-mingw-ucrt'
+      # Use a workaround for https://github.com/libffi/libffi/issues/905
+      def attach(mod, name)
+        this = self
+        body = proc do |*args, &block|
+          this.call(*args, &block)
+        end
+
+        mod.define_method(name, body)
+        mod.define_singleton_method(name, body)
+
+        # Store function Proc's for re-definition as Ractor-shareable in Library#freeze
+        funcs = mod.instance_variable_get("@ffi_function_procs")
+        unless funcs
+          funcs = {}
+          mod.instance_variable_set("@ffi_function_procs", funcs)
+        end
+        funcs[name] = self
+
+        self
+      end
+    end
+
     # Stash the Function in a module variable so it can be inspected by attached_functions.
     # On CRuby it also ensures that it does not get garbage collected.
     module RegisterAttach

data/lib/ffi/library.rb

@@ -287,7 +287,7 @@ module FFI
       if type.is_a?(Class) && type < FFI::Struct
         # If it is a global struct, just attach directly to the pointer
         s = s = type.new(address) # Assigning twice to suppress unused variable warning
-        self.module_eval <<-code, __FILE__, __LINE__
+        self.module_eval(<<-code, __FILE__, __LINE__)
           @ffi_gsvars = {} unless defined?(@ffi_gsvars)
           @ffi_gsvars[#{mname.inspect}] = s
           def self.#{mname}
@@ -302,7 +302,7 @@ module FFI
         #
         # Attach to this module as mname/mname=
         #
-        self.module_eval <<-code, __FILE__, __LINE__
+        self.module_eval(<<-code, __FILE__, __LINE__)
           @ffi_gvars = {} unless defined?(@ffi_gvars)
           @ffi_gvars[#{mname.inspect}] = s
           def self.#{mname}
@@ -564,12 +564,28 @@ module FFI
     # Freeze all definitions of the module
     #
     # This freezes the module's definitions, so that it can be used in a Ractor.
-    # No further methods or variables can be attached and no further enums or typedefs can be created in this module afterwards.
+    # No further functions or variables can be attached and no further enums or typedefs can be created in this module afterwards.
     def freeze
+      # @ffi_function_procs is only used on aarch64-mingw-ucrt
+      instance_variable_get("@ffi_function_procs")&.each do |name, func|
+        # Redefine attached functions as Ractor-shareable.
+        # The function Proc can't be shareable from the beginning, since it references enums and typedefs.
+        this = FFI.make_shareable(func)
+        body = FFI.shareable_proc(self: nil) do |*args, &block|
+          this.call(*args, &block)
+        end
+        undef_method(name)
+        singleton_class.undef_method(name)
+
+        define_method(name, body)
+        define_singleton_method(name, body)
+      end
+
       instance_variables.each do |name|
         var = instance_variable_get(name)
         FFI.make_shareable(var)
       end
+      super
       nil
     end
   end

data/lib/ffi/struct_by_reference.rb

@@ -44,7 +44,7 @@ module FFI
     end
 
     # Always get {FFI::Type}::POINTER.
-    def native_type
+    def native_type(_type = nil)
       FFI::Type::POINTER
     end
 

data/lib/ffi/version.rb

@@ -1,3 +1,3 @@
 module FFI
-  VERSION = '1.17.0'
+  VERSION = '1.17.4'
 end

data/samples/hello_ractor.rb

@@ -1,5 +1,13 @@
+# See the ffi wiki for how to use FFI with Ractors:
+# https://github.com/ffi/ffi/wiki/Ractors
+
 require 'ffi'
 
+class Ractor
+  # compat with Ruby-3.4 and older
+  alias value take unless method_defined? :value
+end
+
 module Foo
   extend FFI::Library
   ffi_lib FFI::Library::LIBC
@@ -8,4 +16,4 @@ module Foo
 end
 Ractor.new do
   Foo.cputs("Hello, World via libc puts using FFI in a Ractor")
-end.take
+end.value

data/samples/qsort_ractor.rb

@@ -1,5 +1,13 @@
+# See the ffi wiki for how to use FFI with Ractors:
+# https://github.com/ffi/ffi/wiki/Ractors
+
 require 'ffi'
 
+class Ractor
+  # compat with Ruby-3.4 and older
+  alias value take unless method_defined? :value
+end
+
 module LibC
   extend FFI::Library
   ffi_lib FFI::Library::LIBC
@@ -23,6 +31,6 @@ res = Ractor.new(p) do |p|
     i1 < i2 ? -1 : i1 > i2 ? 1 : 0
   end
   puts "After qsort #{p.get_array_of_int32(0, 3).join(', ')}"
-end.take
+end.value
 
 puts "After ractor termination #{p.get_array_of_int32(0, 3).join(', ')}"

data/sig/ffi/auto_pointer.rbs

@@ -12,8 +12,7 @@ module FFI
       def release: (Pointer ptr) -> void
     end
 
-    def initialize: (Pointer pointer, Method | ^(self) -> void | Releaser::_Proc[self] callable) -> self
-                # | (Pointer pointer) { (self) -> void } -> self # https://github.com/ffi/ffi/issues/1071
+    def initialize: (Pointer pointer, Method | ^(instance) -> void | Releaser::_Proc[instance] callable) -> self
                   | (Pointer pointer) -> self # where class < `def self.release: (instance pointer) -> void`
 
     extend DataConverter[Pointer, instance, nil]

data/sig/ffi/errno.rbs

@@ -0,0 +1,8 @@
+module FFI
+  module LastError
+    def self?.error: () -> Integer
+    def self?.error=: (Integer) -> Integer
+    def self?.winapi_error: () -> Integer?
+    def self?.winapi_error=: (Integer? error) -> void
+  end
+end

data/sig/ffi/library.rbs

@@ -33,7 +33,7 @@ module FFI
     def find_type: (ffi_lib_type t) -> Type
     def freeze: () -> void
     def function_names: (_ToS name, Array[Type | singleton(Struct)] arg_types) -> Array[String]
-    def typedef: [T < Type] (T old, Symbol | DataConverter add, ?untyped) -> T
+    def typedef: [T < Type, N, R, C] (T old, Symbol | DataConverter[N, R, C] add, ?untyped) -> T
                | (Symbol old, Symbol add, ?untyped) -> (Type | Enum)
                | [X < DataConverter[N, R, C], N, R, C] (X old, Symbol add, ?untyped) -> Type::Mapped[X, N, R, C]
                | (:enum old, Array[Symbol | Integer] add, ?untyped) -> Enum

data/sig/ffi/platform.rbs

@@ -0,0 +1,49 @@
+module FFI
+  class PlatformError < LoadError
+  end
+
+  module Platform
+    OS: String
+
+    OSVERSION: Integer
+
+    CPU: String
+
+    ARCH: String
+
+    IS_GNU: bool
+    IS_LINUX: bool
+    IS_MAC: bool
+    IS_FREEBSD: bool
+    IS_NETBSD: bool
+    IS_OPENBSD: bool
+    IS_DRAGONFLYBSD: bool
+    IS_SOLARIS: bool
+    IS_WINDOWS: bool
+    IS_BSD: bool
+
+    NAME: String
+
+    CONF_DIR: String
+
+    LIBPREFIX: String
+
+    LIBSUFFIX: String
+
+    LIBC: String
+
+    LITTLE_ENDIAN: Integer
+
+    BIG_ENDIAN: Integer
+
+    def self.bsd?: () -> bool
+    def self.windows?: () -> bool
+    def self.mac?: () -> bool
+    def self.solaris?: () -> bool
+    def self.unix?: () -> bool
+
+    private
+
+    def self.is_os: (String os) -> bool
+  end
+end

data/sig/ffi/struct.rbs

@@ -4,7 +4,7 @@ module FFI
 
     type ptr = Type::Mapped[
       StructByReference[Struct[AbstractMemory, untyped], AbstractMemory],
-      AbstractMemory, instance, untyped
+      AbstractMemory, Struct[AbstractMemory, untyped], untyped
     ]
     def self.ptr: (?untyped flags) -> ptr # https://github.com/ffi/ffi/issues/1073
     alias self.by_ref self.ptr
@@ -22,7 +22,7 @@ module FFI
 
     def self.auto_ptr: () -> Type::Mapped[
         ManagedStructConverter[ManagedStruct[AutoPointer, untyped], AutoPointer],
-        Pointer, instance, untyped
+        Pointer, ManagedStruct[AutoPointer, untyped], untyped
       ]
     def self.layout: (*layout | Integer) -> StructLayout
               | (Hash[Symbol, layout]) -> StructLayout

data/sig/ffi/struct_by_reference.rbs

@@ -5,7 +5,7 @@ module FFI
 
     def initialize: (S struct_class) -> void
     def from_native: (P value, untyped ctx) -> S
-    def native_type: () -> Type::Builtin
+    def native_type: (?ffi_auto_type? type) -> Type
     def to_native: (S? value, untyped ctx) -> P
   end
 end

data/sig/ffi.rbs

@@ -14,9 +14,12 @@ module FFI
   CURRENT_PROCESS: current_process
   USE_THIS_PROCESS_AS_LIBRARY: current_process
 
+  class NotFoundError < LoadError
+  end
+
   private def self.custom_typedefs: () -> type_map
   def self.errno: () -> Integer
-  def self.errno=: (Integer) -> nil
+  def self.errno=: (Integer) -> Integer
   def self.find_type: (ffi_auto_type name, ?type_map? type_map) -> Type
   def self.make_shareable: [T] (T obj) -> T
   def self.map_library_name: (_ToS lib) -> String