ffi 1.17.2 → 1.17.4

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/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.2'
+  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,7 +12,7 @@ module FFI
       def release: (Pointer ptr) -> void
     end
 
-    def initialize: (Pointer pointer, Method | ^(self) -> void | Releaser::_Proc[self] callable) -> self
+    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/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