ffi 1.9.24 → 1.16.3

data/lib/ffi/struct_layout.rb

@@ -0,0 +1,96 @@
+#
+# Copyright (C) 2008-2010 Wayne Meissner
+# Copyright (C) 2008, 2009 Andrea Fazzi
+# Copyright (C) 2008, 2009 Luc Heinrich
+#
+# This file is part of ruby-ffi.
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the Ruby FFI project nor the names of its contributors
+#   may be used to endorse or promote products derived from this software
+#   without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+
+module FFI
+
+  class StructLayout
+
+    # @return [Array<Array(Symbol, Numeric)>
+    # Get an array of tuples (field name, offset of the field).
+    def offsets
+      members.map { |m| [ m, self[m].offset ] }
+    end
+
+    # @return [Numeric]
+    # Get the offset of a field.
+    def offset_of(field_name)
+      self[field_name].offset
+    end
+
+    # An enum {Field} in a {StructLayout}.
+    class Enum < Field
+
+      # @param [AbstractMemory] ptr pointer on a {Struct}
+      # @return [Object]
+      # Get an object of type {#type} from memory pointed by +ptr+.
+      def get(ptr)
+        type.find(ptr.get_int(offset))
+      end
+
+      # @param [AbstractMemory] ptr pointer on a {Struct}
+      # @param  value
+      # @return [nil]
+      # Set +value+ into memory pointed by +ptr+.
+      def put(ptr, value)
+        ptr.put_int(offset, type.find(value))
+      end
+
+    end
+
+    class InnerStruct < Field
+      def get(ptr)
+        type.struct_class.new(ptr.slice(self.offset, self.size))
+      end
+
+     def put(ptr, value)
+       raise TypeError, "wrong value type (expected #{type.struct_class})" unless value.is_a?(type.struct_class)
+       ptr.slice(self.offset, self.size).__copy_from__(value.pointer, self.size)
+     end
+    end
+
+    class Mapped < Field
+      def initialize(name, offset, type, orig_field)
+        @orig_field = orig_field
+        super(name, offset, type)
+      end
+
+      def get(ptr)
+        type.from_native(@orig_field.get(ptr), nil)
+      end
+
+      def put(ptr, value)
+        @orig_field.put(ptr, type.to_native(value, nil))
+      end
+    end
+  end
+end

data/lib/ffi/struct_layout_builder.rb

@@ -112,7 +112,7 @@ module FFI
       Type::FLOAT64,
       Type::LONGDOUBLE,
       Type::BOOL,
-    ]
+    ].freeze
 
     # @param [String, Symbol] name name of the field
     # @param [Array, DataConverter, Struct, StructLayout::Field, Symbol, Type] type type of the field

data/lib/ffi/tools/const_generator.rb

@@ -6,6 +6,7 @@ module FFI
   # ConstGenerator turns C constants into ruby values.
   #
   # @example a simple example for stdio
+  #  require 'ffi/tools/const_generator'
   #  cg = FFI::ConstGenerator.new('stdio') do |gen|
   #    gen.const(:SEEK_SET)
   #    gen.const('SEEK_CUR')
@@ -25,10 +26,10 @@ module FFI
     #
     # The only option is +:required+, which if set to +true+ raises an error if a
     # constant you have requested was not found.
-    # 
+    #
     # @param [#to_s] prefix
     # @param [Hash] options
-    # @return 
+    # @return
     # @option options [Boolean] :required
     # @overload initialize(prefix, options)
     # @overload initialize(prefix, options) { |gen| ... }
@@ -79,7 +80,7 @@ module FFI
     #  @param [#call] converter convert the value from a string to the appropriate
     #   type for {#to_ruby}.
     # @overload const(name, format=nil, cast='', ruby_name=nil) { |value| ... }
-    #  Use a converter block. This block convert the value from a string to the 
+    #  Use a converter block. This block convert the value from a string to the
     #  appropriate type for {#to_ruby}.
     #  @yieldparam value constant value
     def const(name, format = nil, cast = '', ruby_name = nil, converter = nil,
@@ -104,9 +105,10 @@ module FFI
     # @return [nil]
     # @raise if a constant is missing and +:required+ was set to +true+ (see {#initialize})
     def calculate(options = {})
-      binary = File.join Dir.tmpdir, "rb_const_gen_bin_#{Process.pid}"
+      binary_path = nil
 
       Tempfile.open("#{@prefix}.const_generator") do |f|
+        binary_path = f.path + ".bin"
         @includes.each do |inc|
           f.puts "#include <#{inc}>"
         end
@@ -123,7 +125,8 @@ module FFI
         f.puts "\n\treturn 0;\n}"
         f.flush
 
-        output = `gcc #{options[:cppflags]} -D_DARWIN_USE_64_BIT_INODE -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64 -x c -Wall -Werror #{f.path} -o #{binary} 2>&1`
+        cc = ENV['CC'] || 'gcc'
+        output = `#{cc} #{options[:cppflags]} -D_DARWIN_USE_64_BIT_INODE -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64 -x c -Wall -Werror #{f.path} -o #{binary_path} 2>&1`
 
         unless $?.success? then
           output = output.split("\n").map { |l| "\t#{l}" }.join "\n"
@@ -131,8 +134,8 @@ module FFI
         end
       end
 
-      output = `#{binary}`
-      File.unlink(binary + (FFI::Platform.windows? ? ".exe" : ""))
+      output = `#{binary_path}`
+      File.unlink(binary_path + (FFI::Platform.windows? ? ".exe" : ""))
       output.each_line do |line|
         line =~ /^(\S+)\s(.*)$/
         const = @constants[$1]
@@ -224,6 +227,6 @@ module FFI
       "#{ruby_name} = #{converted_value}"
     end
 
-  end  
+  end
 
 end

data/lib/ffi/tools/generator.rb

@@ -1,6 +1,51 @@
+require 'ffi/tools/struct_generator'
+require 'ffi/tools/const_generator'
+
 module FFI
 
-  # @private
+  ##
+  # Generate files with C structs for FFI::Struct and C constants.
+  #
+  # == A simple example
+  #
+  # In file +zlib.rb.ffi+:
+  #   module Zlib
+  #     @@@
+  #     constants do |c|
+  #       c.include "zlib.h"
+  #       c.const :ZLIB_VERNUM
+  #     end
+  #     @@@
+  #
+  #     class ZStream < FFI::Struct
+  #
+  #       struct do |s|
+  #         s.name "struct z_stream_s"
+  #         s.include "zlib.h"
+  #
+  #         s.field :next_in,   :pointer
+  #         s.field :avail_in,  :uint
+  #         s.field :total_in,  :ulong
+  #       end
+  #       @@@
+  #     end
+  #   end
+  #
+  # Translate the file:
+  #   require "ffi/tools/generator"
+  #   FFI::Generator.new "zlib.rb.ffi", "zlib.rb"
+  #
+  # Generates the file +zlib.rb+ with constant values and offsets:
+  #   module Zlib
+  #   ZLIB_VERNUM = 4784
+  #
+  #   class ZStream < FFI::Struct
+  #     layout :next_in, :pointer, 0,
+  #            :avail_in, :uint, 8,
+  #            :total_in, :ulong, 16
+  #   end
+  #
+  # @see FFI::Generator::Task for easy integration in a Rakefile
   class Generator
 
     def initialize(ffi_name, rb_name, options = {})
@@ -34,7 +79,7 @@ module FFI
       end
 
       open @rb_name, 'w' do |f|
-        f.puts "# This file is generated by rake. Do not edit."
+        f.puts "# This file is generated from `#{@ffi_name}'. Do not edit."
         f.puts
         f.puts new_file
       end

data/lib/ffi/tools/generator_task.rb

@@ -1,25 +1,21 @@
-begin
-  require 'ffi/struct_generator'
-  require 'ffi/const_generator'
-  require 'ffi/generator'
-rescue LoadError
-  # from Rakefile
-  require 'lib/ffi/struct_generator'
-  require 'lib/ffi/const_generator'
-  require 'lib/ffi/generator'
-end
-
+require 'ffi/tools/generator'
 require 'rake'
 require 'rake/tasklib'
-require 'tempfile'
 
 ##
-# Rake task that calculates C structs for FFI::Struct.
-
-# @private
+# Add Rake tasks that generate files with C structs for FFI::Struct and C constants.
+#
+# @example a simple example for your Rakefile
+#   require "ffi/tools/generator_task"
+#   # Add a task to generate my_object.rb out of my_object.rb.ffi
+#   FFI::Generator::Task.new ["my_object.rb"], cflags: "-I/usr/local/mylibrary"
+#
+# The generated files are also added to the 'clear' task.
+#
+# @see FFI::Generator for a description of the file content
 class FFI::Generator::Task < Rake::TaskLib
 
-  def initialize(rb_names)
+  def initialize(rb_names, options={})
     task :clean do rm_f rb_names end
 
     rb_names.each do |rb_name|
@@ -28,7 +24,7 @@ class FFI::Generator::Task < Rake::TaskLib
       file rb_name => ffi_name do |t|
         puts "Generating #{rb_name}..." if Rake.application.options.trace
 
-        FFI::Generator.new ffi_name, rb_name
+        FFI::Generator.new ffi_name, rb_name, options
       end
     end
   end

data/lib/ffi/tools/struct_generator.rb

@@ -7,15 +7,15 @@ module FFI
   #
   # Given the @@@ portion in:
   #
-  #   module Zlib::ZStream < FFI::Struct
+  #   class Zlib::ZStream < FFI::Struct
   #     @@@
   #     name "struct z_stream_s"
   #     include "zlib.h"
-  #   
+  #
   #     field :next_in,   :pointer
   #     field :avail_in,  :uint
   #     field :total_in,  :ulong
-  #   
+  #
   #     # ...
   #     @@@
   #   end
@@ -82,7 +82,8 @@ module FFI
         f.puts "\n  return 0;\n}"
         f.flush
 
-        output = `gcc #{options[:cppflags]} #{options[:cflags]} -D_DARWIN_USE_64_BIT_INODE -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64 -x c -Wall -Werror #{f.path} -o #{binary} 2>&1`
+        cc = ENV['CC'] || 'gcc'
+        output = `#{cc} #{options[:cppflags]} #{options[:cflags]} -D_DARWIN_USE_64_BIT_INODE -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64 -x c -Wall -Werror #{f.path} -o #{binary} 2>&1`
 
         unless $?.success? then
           @found = false
@@ -90,7 +91,7 @@ module FFI
           raise "Compilation error generating struct #{@name} (#{@struct_name}):\n#{output}"
         end
       end
-      
+
       output = `#{binary}`.split "\n"
       File.unlink(binary + (FFI::Platform.windows? ? ".exe" : ""))
       sizeof = output.shift

data/lib/ffi/tools/types_generator.rb

@@ -47,9 +47,12 @@ module FFI
       typedefs = nil
       Tempfile.open 'ffi_types_generator' do |io|
         io.puts <<-C
+#include <stdint.h>
+#include <stddef.h>
 #include <sys/types.h>
 #if !(defined(WIN32))
 #include <sys/socket.h>
+#include <netinet/in.h>
 #include <sys/resource.h>
 #endif
         C
@@ -66,7 +69,7 @@ module FFI
         end
       end
 
-      code = ""
+      code = []
 
       typedefs.each_line do |type|
         # We only care about single line typedef
@@ -116,18 +119,18 @@ module FFI
         end
 
         if type = TYPE_MAP[def_type]
-          code << "rbx.platform.typedef.#{final_type} = #{type}\n"
+          code << "rbx.platform.typedef.#{final_type} = #{type}"
           TYPE_MAP[final_type] = TYPE_MAP[def_type]
         else
           # Fallback to an ordinary pointer if we don't know the type
           if def_type =~ /\*/
-            code << "rbx.platform.typedef.#{final_type} = pointer\n"
+            code << "rbx.platform.typedef.#{final_type} = pointer"
             TYPE_MAP[final_type] = :pointer
           end
         end
       end
 
-      code
+      code.sort.join("\n")
     end
   end
 end

data/lib/ffi/types.rb

@@ -33,12 +33,24 @@
 # see {file:README}
 module FFI
 
+  unless defined?(self.custom_typedefs)
+    # Truffleruby and JRuby don't support Ractor so far.
+    # So they don't need separation between builtin and custom types.
+    def self.custom_typedefs
+      TypeDefs
+    end
+    writable_typemap = true
+  end
+
   # @param [Type, DataConverter, Symbol] old type definition used by {FFI.find_type}
   # @param [Symbol] add new type definition's name to add
   # @return [Type]
   # Add a definition type to type definitions.
+  #
+  # The type definition is local per Ractor.
   def self.typedef(old, add)
-    TypeDefs[add] = self.find_type(old)
+    tm = custom_typedefs
+    tm[add] = self.find_type(old)
   end
 
   # (see FFI.typedef)
@@ -46,6 +58,14 @@ module FFI
     typedef old, add
   end
 
+  class << self
+    private def __typedef(old, add)
+      TypeDefs[add] = self.find_type(old)
+    end
+
+    private :custom_typedefs
+  end
+
 
   # @param [Type, DataConverter, Symbol] name
   # @param [Hash] type_map if nil, {FFI::TypeDefs} is used
@@ -57,14 +77,18 @@ module FFI
     if name.is_a?(Type)
       name
 
-    elsif type_map && type_map.has_key?(name)
+    elsif type_map&.has_key?(name)
       type_map[name]
 
+    elsif (tm=custom_typedefs).has_key?(name)
+      tm[name]
+
     elsif TypeDefs.has_key?(name)
       TypeDefs[name]
 
     elsif name.is_a?(DataConverter)
-      (type_map || TypeDefs)[name] = Type::Mapped.new(name)
+      tm = (type_map || custom_typedefs)
+      tm[name] = Type::Mapped.new(name)
     else
       raise TypeError, "unable to resolve type '#{name}'"
     end
@@ -152,7 +176,7 @@ module FFI
   # also allow to work with the pointer itself. This is useful when you want
   # a Ruby string already containing a copy of the data, but also the pointer
   # to the data for you to do something with it, like freeing it, in case the
-  # library handed the memory to off to the caller (Ruby-FFI).
+  # library handed the memory off to the caller (Ruby-FFI).
   #
   # It's {typedef}'d as +:strptr+.
   class StrPtrConverter
@@ -168,7 +192,7 @@ module FFI
     end
   end
 
-  typedef(StrPtrConverter, :strptr)
+  __typedef(StrPtrConverter, :strptr)
 
   # @param type +type+ is an instance of class accepted by {FFI.find_type}
   # @return [Numeric]
@@ -184,11 +208,13 @@ module FFI
       f.each_line { |line|
         if line.index(prefix) == 0
           new_type, orig_type = line.chomp.slice(prefix.length..-1).split(/\s*=\s*/)
-          typedef(orig_type.to_sym, new_type.to_sym)
+          __typedef(orig_type.to_sym, new_type.to_sym)
         end
       }
     end
-    typedef :pointer, :caddr_t
+    __typedef :pointer, :caddr_t
   rescue Errno::ENOENT
   end
+
+  FFI.make_shareable(TypeDefs) unless writable_typemap
 end

data/lib/ffi/variadic.rb

@@ -31,16 +31,7 @@
 #
 
 module FFI
-  class VariadicInvoker    
-    def init(arg_types, type_map)
-      @fixed = Array.new
-      @type_map = type_map
-      arg_types.each_with_index do |type, i|
-        @fixed << type unless type == Type::VARARGS
-      end
-    end
-
-
+  class VariadicInvoker
     def call(*args, &block)
       param_types = Array.new(@fixed)
       param_values = Array.new
@@ -63,16 +54,27 @@ module FFI
       invoker = self
       params = "*args"
       call = "call"
-      mod.module_eval <<-code
-      @@#{mname} = invoker
-      def self.#{mname}(#{params})
-        @@#{mname}.#{call}(#{params})
-      end
-      def #{mname}(#{params})
-        @@#{mname}.#{call}(#{params})
-      end
+      mname = mname.to_sym
+      mod.module_eval <<-code, __FILE__, __LINE__
+        @ffi_functions = {} unless defined?(@ffi_functions)
+        @ffi_functions[#{mname.inspect}] = invoker
+
+        def self.#{mname}(#{params})
+          @ffi_functions[#{mname.inspect}].#{call}(#{params})
+        end
+
+        define_method(#{mname.inspect}, &method(#{mname.inspect}))
       code
       invoker
     end
+
+    # Retrieve Array of parameter types
+    #
+    # This method returns an Array of FFI types accepted as function parameters.
+    #
+    # @return [Array<FFI::Type>]
+    def param_types
+      [*@fixed, Type::Builtin::VARARGS]
+    end
   end
 end

data/lib/ffi/version.rb

@@ -1,3 +1,3 @@
 module FFI
-  VERSION = '1.9.24'
+  VERSION = '1.16.3'
 end

data/lib/ffi.rb

@@ -1,5 +1,4 @@
-if !defined?(RUBY_ENGINE) || RUBY_ENGINE == 'ruby' || RUBY_ENGINE == 'rbx'
-  Object.send(:remove_const, :FFI) if defined?(::FFI)
+if RUBY_ENGINE == 'ruby'
   begin
     require RUBY_VERSION.split('.')[0, 2].join('.') + '/ffi_c'
   rescue Exception
@@ -8,7 +7,15 @@ if !defined?(RUBY_ENGINE) || RUBY_ENGINE == 'ruby' || RUBY_ENGINE == 'rbx'
 
   require 'ffi/ffi'
 
-elsif defined?(RUBY_ENGINE)
+elsif RUBY_ENGINE == 'jruby' && (RUBY_ENGINE_VERSION.split('.').map(&:to_i) <=> [9, 2, 20]) >= 0
+  JRuby::Util.load_ext("org.jruby.ext.ffi.FFIService")
+  require 'ffi/ffi'
+
+elsif RUBY_ENGINE == 'truffleruby' && (RUBY_ENGINE_VERSION.split('.').map(&:to_i) <=> [20, 1, 0]) >= 0
+  require 'truffleruby/ffi_backend'
+  require 'ffi/ffi'
+
+else
   # Remove the ffi gem dir from the load path, then reload the internal ffi implementation
   $LOAD_PATH.delete(File.dirname(__FILE__))
   $LOAD_PATH.delete(File.join(File.dirname(__FILE__), 'ffi'))

data/rakelib/ffi_gem_helper.rb

@@ -0,0 +1,65 @@
+require 'bundler'
+require 'bundler/gem_helper'
+
+class FfiGemHelper < Bundler::GemHelper
+  attr_accessor :cross_platforms
+
+  def install
+    super
+
+    task "release:guard_clean" => ["release:update_history"]
+
+    task "release:update_history" do
+      update_history
+    end
+
+    task "release:rubygem_push" => ["gem:native", "gem:java"]
+  end
+
+  def hfile
+    "CHANGELOG.md"
+  end
+
+  def headline
+    '([^\w]*)(\d+\.\d+\.\d+(?:\.\w+)?)([^\w]+)([2Y][0Y][0-9Y][0-9Y]-[0-1M][0-9M]-[0-3D][0-9D])([^\w]*|$)'
+  end
+
+  def reldate
+    Time.now.strftime("%Y-%m-%d")
+  end
+
+  def update_history
+    hin = File.read(hfile)
+    hout = hin.sub(/#{headline}/) do
+      raise "#{hfile} isn't up-to-date for version #{version}" unless $2==version.to_s
+      $1 + $2 + $3 + reldate + $5
+    end
+    if hout != hin
+      Bundler.ui.confirm "Updating #{hfile} for release."
+      File.write(hfile, hout)
+      Rake::FileUtilsExt.sh "git", "commit", hfile, "-m", "Update release date in #{hfile}"
+    end
+  end
+
+  def tag_version
+    Bundler.ui.confirm "Tag release with annotation:"
+    m = File.read(hfile).match(/(?<annotation>#{headline}.*?)#{headline}/m) || raise("Unable to find release notes in #{hfile}")
+    Bundler.ui.info(m[:annotation].gsub(/^/, "    "))
+    IO.popen(["git", "tag", "--file=-", version_tag], "w") do |fd|
+      fd.write m[:annotation]
+    end
+    yield if block_given?
+  rescue
+    Bundler.ui.error "Untagging #{version_tag} due to error."
+    sh_with_code "git tag -d #{version_tag}"
+    raise
+  end
+
+  def rubygem_push(path)
+    cross_platforms.each do |ruby_platform|
+      super(path.gsub(/\.gem\z/, "-#{ruby_platform}.gem"))
+    end
+    super(path.gsub(/\.gem\z/, "-java.gem"))
+    super(path)
+  end
+end

data/samples/getlogin.rb

@@ -1,5 +1,5 @@
-require 'rubygems'
 require 'ffi'
+
 module Foo
   extend FFI::Library
   ffi_lib FFI::Library::LIBC

data/samples/getpid.rb

@@ -1,5 +1,5 @@
-require 'rubygems'
 require 'ffi'
+
 module Foo
   extend FFI::Library
   ffi_lib FFI::Library::LIBC

data/samples/gettimeofday.rb

@@ -1,16 +1,16 @@
-require 'rubygems'
 require 'ffi'
+require 'rbconfig'
+
 class Timeval < FFI::Struct
-  rb_maj, rb_min, rb_micro = RUBY_VERSION.split('.')
-  if rb_maj.to_i >= 1 && rb_min.to_i >= 9 || RUBY_PLATFORM =~ /java/
-    layout :tv_sec => :ulong, :tv_usec => :ulong
-  else
-    layout :tv_sec, :ulong, 0, :tv_usec, :ulong, 4
-  end
+  layout tv_sec: :ulong, tv_usec: :ulong
 end
 module LibC
   extend FFI::Library
-  ffi_lib FFI::Library::LIBC
+  if FFI::Platform.windows?
+    ffi_lib RbConfig::CONFIG["LIBRUBY_SO"]
+  else
+    ffi_lib FFI::Library::LIBC
+  end
   attach_function :gettimeofday, [ :pointer, :pointer ], :int
 end
 t = Timeval.new

data/samples/hello.rb

@@ -1,4 +1,5 @@
-require File.expand_path(File.join(File.dirname(__FILE__), "sample_helper"))
+require 'ffi'
+
 module Foo
   extend FFI::Library
   ffi_lib FFI::Library::LIBC

data/samples/hello_ractor.rb

@@ -0,0 +1,11 @@
+require 'ffi'
+
+module Foo
+  extend FFI::Library
+  ffi_lib FFI::Library::LIBC
+  attach_function("cputs", "puts", [ :string ], :int)
+  freeze
+end
+Ractor.new do
+  Foo.cputs("Hello, World via libc puts using FFI in a Ractor")
+end.take

data/samples/inotify.rb

@@ -1,5 +1,5 @@
-require 'rubygems'
 require 'ffi'
+
 module Inotify
   extend FFI::Library
   ffi_lib FFI::Library::LIBC