ffi 1.1.6.pre2 → 1.2.0.dev

data/README.md

@@ -0,0 +1,104 @@
+# ruby-ffi http://wiki.github.com/ffi/ffi
+
+## Description
+
+Ruby-FFI is a ruby extension for programmatically loading dynamic
+libraries, binding functions within them, and calling those functions
+from Ruby code. Moreover, a Ruby-FFI extension works without changes
+on Ruby and JRuby. Discover why should you write your next extension
+using Ruby-FFI [here](http://wiki.github.com/ffi/ffi/why-use-ffi).
+
+## Features/problems
+
+* Intuitive DSL
+* Supports all C native types
+* C structs (also nested), enums and global variables
+* Callbacks from C to ruby
+* Automatic garbage collection of native memory
+
+## Synopsis
+
+```ruby
+require 'ffi'
+
+module MyLib
+extend FFI::Library
+ffi_lib 'c'
+attach_function :puts, [ :string ], :int
+end
+
+MyLib.puts 'Hello, World using libc!'
+```
+
+For less minimalistic and more sane examples you may look at:
+
+* the samples/ folder
+* the examples on the [wiki](http://wiki.github.com/ffi/ffi)
+* the projects using FFI listed on this page (http://wiki.github.com/ffi/ffi/projects-using-ffi)
+
+## Requirements
+
+* You need a sane building environment in order to compile the extension.
+
+## Installation
+
+From rubygems:
+
+    [sudo] gem install ffi
+
+or from the git repository on github:
+
+    git clone git://github.com/ffi/ffi.git
+    cd ffi
+    rake gem:install
+
+## License
+
+See LICENSE file.
+
+## Credits
+
+The following people have submitted code, bug reports, or otherwide contributed to the success of this project:
+
+* Alban Peignier <alban.peignier@free.fr>
+* Aman Gupta <aman@tmm1.net>
+* Andrea Fazzi <andrea.fazzi@alcacoop.it>
+* Andreas Niederl <rico32@gmx.net>
+* Andrew Cholakian <andrew@andrewvc.com>
+* Antonio Terceiro <terceiro@softwarelivre.org>
+* Brian Candler <B.Candler@pobox.com>
+* Brian D. Burns <burns180@gmail.com>
+* Bryan Kearney <bkearney@redhat.com>
+* Charlie Savage <cfis@zerista.com>
+* Chikanaga Tomoyuki <nagachika00@gmail.com>
+* Hongli Lai <hongli@phusion.nl>
+* Ian MacLeod <ian@nevir.net>
+* Jake Douglas <jake@shiftedlabs.com>
+* Jean-Dominique Morani <jdmorani@mac.com>
+* Jeremy Hinegardner <jeremy@hinegardner.org>
+* Jesús García Sáez <blaxter@gmail.com>
+* Joe Khoobyar <joe@ankhcraft.com>
+* Jurij Smakov <jurij@wooyd.org>
+* KISHIMOTO, Makoto <ksmakoto@dd.iij4u.or.jp>
+* Kim Burgestrand <kim@burgestrand.se>
+* Lars Kanis <kanis@comcard.de>
+* Luc Heinrich <luc@honk-honk.com>
+* Luis Lavena <luislavena@gmail.com>
+* Matijs van Zuijlen <matijs@matijs.net>
+* Matthew King <automatthew@gmail.com>
+* Mike Dalessio <mike.dalessio@gmail.com>
+* NARUSE, Yui <naruse@airemix.jp>
+* Park Heesob <phasis@gmail.com>
+* Shin Yee <shinyee@speedgocomputing.com>
+* Stephen Bannasch <stephen.bannasch@gmail.com>
+* Suraj N. Kurapati <sunaku@gmail.com>
+* Sylvain Daubert <sylvain.daubert@laposte.net>
+* Victor Costan
+* beoran@gmail.com
+* ctide <christide@christide.com>
+* emboss <Martin.Bosslet@googlemail.com>
+* hobophobe <unusualtears@gmail.com>
+* meh <meh@paranoici.org>
+* postmodern <postmodern.mod3@gmail.com>
+* wycats@gmail.com <wycats@gmail.com>
+* Wayne Meissner <wmeissner@gmail.com>

data/Rakefile

@@ -1,4 +1,5 @@
 require 'rubygems'
+require 'rubygems/package_task'
 require 'rbconfig'
 
 USE_RAKE_COMPILER = (RUBY_PLATFORM =~ /java/) ? false : true
@@ -11,7 +12,6 @@ require 'date'
 require 'fileutils'
 require 'rbconfig'
 
-load 'tasks/setup.rb'
 
 LIBEXT = case RbConfig::CONFIG['host_os'].downcase
   when /darwin/
@@ -64,7 +64,7 @@ OS = case RbConfig::CONFIG['host_os'].downcase
     RbConfig::CONFIG['host_os'].downcase
   end
 
-CC=ENV['CC'] || RbConfig::CONFIG['CC'] || "gcc"
+CC = ENV['CC'] || RbConfig::CONFIG['CC'] || "gcc"
 
 GMAKE = system('which gmake >/dev/null') && 'gmake' || 'make'
 
@@ -72,47 +72,13 @@ LIBTEST = "build/libtest.#{LIBEXT}"
 BUILD_DIR = "build"
 BUILD_EXT_DIR = File.join(BUILD_DIR, "#{RbConfig::CONFIG['arch']}", 'ffi_c', RUBY_VERSION)
 
-# Project general information
-PROJ.name = 'ffi'
-PROJ.authors = 'Wayne Meissner'
-PROJ.email = 'wmeissner@gmail.com'
-PROJ.url = 'http://wiki.github.com/ffi/ffi'
-PROJ.version = '1.1.6.pre2'
-PROJ.rubyforge.name = 'ffi'
-PROJ.readme_file = 'README.rdoc'
+gem_spec = eval(IO.read('ffi.gemspec'))
 
-# Annoucement
-PROJ.ann.paragraphs << 'FEATURES' << 'SYNOPSIS' << 'REQUIREMENTS' << 'DOWNLOAD/INSTALL' << 'CREDITS' << 'LICENSE'
-
-PROJ.ann.email[:from] = 'andrea.fazzi@alcacoop.it'
-PROJ.ann.email[:to] = ['ruby-ffi@googlegroups.com']
-PROJ.ann.email[:server] = 'smtp.gmail.com'
-
-# Gem specifications
-PROJ.gem.need_tar = false
-PROJ.gem.files = %w(History.txt LICENSE README.rdoc Rakefile) + Dir.glob("{ext,gen,lib,spec,tasks}/**/*")
-PROJ.gem.platform = Gem::Platform::RUBY
-#PROJ.gem.required_ruby_version = ">= 1.9.2"
-
-# Override Mr. Bones autogenerated extensions and force ours in
-PROJ.gem.extras['extensions'] = %w(ext/ffi_c/extconf.rb)
-#PROJ.gem.extras['required_ruby_version'] = ">= 1.9.2"
-
-# RDoc
-PROJ.rdoc.exclude << '^ext\/'
-PROJ.rdoc.opts << '-x' << 'ext'
-
-# Ruby
-PROJ.ruby_opts = []
-PROJ.ruby_opts << '-I' << BUILD_EXT_DIR unless RUBY_PLATFORM == "java"
-
-# RSpec
-PROJ.spec.files.exclude /rbx/
-PROJ.spec.opts << '--color' << '-fs'
-
-# Dependencies
-
-#depend_on 'rake', '>=0.8.7'
+Gem::PackageTask.new(gem_spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+  pkg.package_dir = 'pkg'
+end
 
 TEST_DEPS = [ LIBTEST ]
 if RUBY_PLATFORM == "java"
@@ -144,6 +110,11 @@ task :package => 'gem:package'
 desc "Install the gem locally"
 task :install => 'gem:install'
 
+namespace :gem do
+  task :install => :gem do
+    ruby %{ -S gem install pkg/ffi-#{gem_spec.version}.gem }
+  end
+end
 
 desc "Clean all built files"
 task :distclean => :clobber do
@@ -158,7 +129,7 @@ end
 
 
 desc "Build the native test lib"
-task "build/libtest.#{LIBEXT}" do
+file "build/libtest.#{LIBEXT}" => FileList['libtest/**/*.[ch]'] do
   sh %{#{GMAKE} -f libtest/GNUmakefile CPU=#{CPU} OS=#{OS} }
 end
 
@@ -194,3 +165,25 @@ task :default => :specs
 task 'gem:win32' do
   sh("rake cross native gem RUBY_CC_VERSION='1.8.7:1.9.3'") || raise("win32 build failed!")
 end
+
+
+if USE_RAKE_COMPILER
+  Rake::ExtensionTask.new('ffi_c', gem_spec) do |ext|
+    ext.name = 'ffi_c'                                        # indicate the name of the extension.
+    # ext.lib_dir = BUILD_DIR                                 # put binaries into this folder.
+    ext.tmp_dir = BUILD_DIR                                   # temporary folder used during compilation.
+    ext.cross_compile = true                                  # enable cross compilation (requires cross compile toolchain)
+    ext.cross_platform = 'i386-mingw32'                       # forces the Windows platform instead of the default one
+  end
+end
+
+begin
+  require 'yard'
+
+  namespace :doc do
+    YARD::Rake::YardocTask.new do |yard|
+    end
+  end
+rescue LoadError
+  warn "[warn] YARD unavailable"
+end

data/ext/ffi_c/AbstractMemory.c

@@ -431,6 +431,11 @@ memory_put_string(VALUE self, VALUE offset, VALUE str)
 
     checkWrite(ptr);
     checkBounds(ptr, off, len + 1);
+    
+    if (rb_safe_level() >= 1 && OBJ_TAINTED(str)) {
+        rb_raise(rb_eSecurityError, "Writing unsafe string to memory");
+        return Qnil;
+    }
 
     memcpy(ptr->address + off, RSTRING_PTR(str), len);
     *((char *) ptr->address + off + len) = '\0';
@@ -646,24 +651,25 @@ memory_op_put_strptr(AbstractMemory* ptr, long offset, VALUE value)
 
 static MemoryOp memory_op_strptr = { memory_op_get_strptr, memory_op_put_strptr };
 
+//static MemoryOp memory_op_pointer = { memory_op_get_pointer, memory_op_put_pointer };
 
 MemoryOps rbffi_AbstractMemoryOps = {
-    &memory_op_int8, /*.int8 */
-    &memory_op_uint8, /* .uint8 */
-    &memory_op_int16, /* .int16 */
-    &memory_op_uint16, /* .uint16 */
-    &memory_op_int32, /* .int32 */
-    &memory_op_uint32, /* .uint32 */
-    &memory_op_int64, /* .int64 */
-    &memory_op_uint64, /* .uint64 */
-    &memory_op_long, /* .slong */
-    &memory_op_ulong, /* .uslong */
-    &memory_op_float32, /* .float32 */
-    &memory_op_float64, /* .float64 */
-    &memory_op_longdouble, /* .longdouble */
-    &memory_op_pointer, /* .pointer */
-    &memory_op_strptr, /* .strptr */
-    &memory_op_bool /* .boolOp */
+    &memory_op_int8, //.int8
+    &memory_op_uint8, //.uint8
+    &memory_op_int16, //.int16
+    &memory_op_uint16, //.uint16
+    &memory_op_int32, //.int32
+    &memory_op_uint32, //.uint32
+    &memory_op_int64, //.int64
+    &memory_op_uint64, //.uint64
+    &memory_op_long, //.slong
+    &memory_op_ulong, //.uslong
+    &memory_op_float32, //.float32
+    &memory_op_float64, //.float64
+    &memory_op_longdouble, //.longdouble
+    &memory_op_pointer, //.pointer
+    &memory_op_strptr, //.strptr
+    &memory_op_bool //.boolOp
 };
 
 void

data/ext/ffi_c/AbstractMemory.h

@@ -70,7 +70,7 @@ typedef struct {
 } MemoryOps;
 
 struct AbstractMemory_ {
-    char* address; /* Use char* instead of void* to ensure adding to it works correctly */
+    char* address; // Use char* instead of void* to ensure adding to it works correctly
     long size;
     int flags;
     int typeSize;

data/ext/ffi_c/Buffer.c

@@ -41,7 +41,7 @@ typedef struct Buffer {
     union {
         VALUE rbParent; /* link to parent buffer */
         char* storage; /* start of malloc area */
-        long embed[BUFFER_EMBED_MAXLEN / sizeof(long)]; /* storage for tiny allocations */
+        long embed[BUFFER_EMBED_MAXLEN / sizeof(long)]; // storage for tiny allocations
     } data;
 } Buffer;
 
@@ -151,7 +151,7 @@ buffer_initialize_copy(VALUE self, VALUE other)
     dst->memory.size = src->size;
     dst->memory.typeSize = src->typeSize;
     
-    /* finally, copy the actual buffer contents */
+    // finally, copy the actual buffer contents
     memcpy(dst->memory.address, src->address, src->size);
 
     return self;

data/ext/ffi_c/Call.c

@@ -314,10 +314,8 @@ rbffi_CallFunction(int argc, VALUE* argv, void* function, FunctionType* fnInfo)
     if (unlikely(fnInfo->blocking)) {
         BlockingCall* bc;
 
-        /*
-         * due to the way thread switching works on older ruby variants, we
-         * cannot allocate anything passed to the blocking function on the stack
-         */
+        // due to the way thread switching works on older ruby variants, we
+        // cannot allocate anything passed to the blocking function on the stack
         ffiValues = ALLOC_N(void *, fnInfo->parameterCount);
         params = ALLOC_N(FFIStorage, fnInfo->parameterCount);
         bc = ALLOC_N(BlockingCall, 1);
@@ -377,7 +375,10 @@ getPointer(VALUE value, int type)
         return memory != NULL ? memory->address : NULL;
 
     } else if (type == T_STRING) {
-        
+
+        if (rb_safe_level() >= 1 && OBJ_TAINTED(value)) {
+            rb_raise(rb_eSecurityError, "Unsafe string parameter");
+        }
         return StringValuePtr(value);
 
     } else if (type == T_NIL) {
@@ -431,13 +432,14 @@ callback_param(VALUE proc, VALUE cbInfo)
         return NULL ;
     }
 
-    /* Handle Function pointers here */
+    // Handle Function pointers here
     if (rb_obj_is_kind_of(proc, rbffi_FunctionClass)) {
         AbstractMemory* ptr;
         Data_Get_Struct(proc, AbstractMemory, ptr);
         return ptr->address;
     }
 
+    //callback = rbffi_NativeCallback_ForProc(proc, cbInfo);
     callback = rbffi_Function_ForProc(cbInfo, proc);
     RB_GC_GUARD(callback);
 

data/ext/ffi_c/ClosurePool.c

@@ -206,7 +206,7 @@ rbffi_Closure_Free(Closure* closure)
     if (closure != NULL) {
         ClosurePool* pool = closure->pool;
         long refcnt;
-        /* Just push it on the front of the free list */
+        // Just push it on the front of the free list
         closure->next = pool->list;
         pool->list = closure;
         refcnt = --(pool->refcnt);

data/ext/ffi_c/DynamicLibrary.c

@@ -155,7 +155,7 @@ library_dlerror(VALUE self)
 static void
 library_free(Library* library)
 {
-    /* dlclose() on MacOS tends to segfault - avoid it */
+    // dlclose() on MacOS tends to segfault - avoid it
 #ifndef __APPLE__
     if (library->handle != NULL) {
         dl_close(library->handle);
@@ -270,7 +270,7 @@ rbffi_DynamicLibrary_Init(VALUE moduleFFI)
      * Document-const: FFI::NativeLibrary
      * Backward compatibility for FFI::DynamicLibrary
      */
-    rb_define_const(moduleFFI, "NativeLibrary", LibraryClass); /* backwards compat library */
+    rb_define_const(moduleFFI, "NativeLibrary", LibraryClass); // backwards compat library
     rb_define_alloc_func(LibraryClass, library_allocate);
     rb_define_singleton_method(LibraryClass, "open", library_open, 2);
     rb_define_singleton_method(LibraryClass, "last_error", library_dlerror, 0);

data/ext/ffi_c/Function.c

@@ -199,11 +199,11 @@ function_initialize(int argc, VALUE* argv, VALUE self)
 
     nargs = rb_scan_args(argc, argv, "22", &rbReturnType, &rbParamTypes, &rbProc, &rbOptions);
 
-    /*
-     * Callback with block,
-     * e.g. Function.new(:int, [ :int ]) { |i| blah }
-     * or   Function.new(:int, [ :int ], { :convention => :stdcall }) { |i| blah }
-     */
+    //
+    // Callback with block,
+    // e.g. Function.new(:int, [ :int ]) { |i| blah }
+    // or   Function.new(:int, [ :int ], { :convention => :stdcall }) { |i| blah }
+    //
     if (rb_block_given_p()) {
         if (nargs > 3) {
             rb_raise(rb_eArgError, "cannot create function with both proc/address and block");
@@ -211,12 +211,11 @@ function_initialize(int argc, VALUE* argv, VALUE self)
         rbOptions = rbProc;
         rbProc = rb_block_proc();
     } else {
-        /* Callback with proc, or Function with address
-         * e.g. Function.new(:int, [ :int ], Proc.new { |i| })
-         *      Function.new(:int, [ :int ], Proc.new { |i| }, { :convention => :stdcall })
-         *      Function.new(:int, [ :int ], addr)
-         *      Function.new(:int, [ :int ], addr, { :convention => :stdcall })
-         */
+        // Callback with proc, or Function with address
+        // e.g. Function.new(:int, [ :int ], Proc.new { |i| })
+        //      Function.new(:int, [ :int ], Proc.new { |i| }, { :convention => :stdcall })
+        //      Function.new(:int, [ :int ], addr)
+        //      Function.new(:int, [ :int ], addr, { :convention => :stdcall })
     }
     
     infoArgv[0] = rbReturnType;
@@ -382,9 +381,9 @@ function_attach(VALUE self, VALUE module, VALUE name)
         fn->methodHandle = rbffi_MethodHandle_Alloc(fn->info, fn->base.memory.address);
     }
 
-    /*
-     * Stash the Function in a module variable so it does not get garbage collected
-     */
+    //
+    // Stash the Function in a module variable so it does not get garbage collected
+    //
     snprintf(var, sizeof(var), "@@%s", StringValueCStr(name));
     rb_cv_set(module, var, self);
 
@@ -471,7 +470,7 @@ callback_invoke(ffi_cif* cif, void* retval, void** parameters, void* user_data)
         pthread_mutex_init(&cb.async_mutex, NULL);
         pthread_cond_init(&cb.async_cond, NULL);
 
-        /* Now signal the async callback thread */
+        // Now signal the async callback thread
         pthread_mutex_lock(&async_cb_mutex);
         empty = async_cb_list == NULL;
         cb.next = async_cb_list;
@@ -479,7 +478,7 @@ callback_invoke(ffi_cif* cif, void* retval, void** parameters, void* user_data)
         pthread_mutex_unlock(&async_cb_mutex);
 
 #if !defined(HAVE_RB_THREAD_BLOCKING_REGION)
-        /* Only signal if the list was empty */
+        // Only signal if the list was empty
         if (empty) {
             char c;
             write(async_cb_pipe[1], &c, 1);
@@ -488,7 +487,7 @@ callback_invoke(ffi_cif* cif, void* retval, void** parameters, void* user_data)
         pthread_cond_signal(&async_cb_cond);
 #endif
 
-        /* Wait for the thread executing the ruby callback to signal it is done */
+        // Wait for the thread executing the ruby callback to signal it is done
         pthread_mutex_lock(&cb.async_mutex);
         while (!cb.done) {
             pthread_cond_wait(&cb.async_cond, &cb.async_mutex);
@@ -503,7 +502,7 @@ callback_invoke(ffi_cif* cif, void* retval, void** parameters, void* user_data)
 
         cb.async_event = CreateEvent(NULL, FALSE, FALSE, NULL);
 
-        /* Now signal the async callback thread */
+        // Now signal the async callback thread
         EnterCriticalSection(&async_cb_lock);
         empty = async_cb_list == NULL;
         cb.next = async_cb_list;
@@ -511,7 +510,7 @@ callback_invoke(ffi_cif* cif, void* retval, void** parameters, void* user_data)
         LeaveCriticalSection(&async_cb_lock);
 
 #if !defined(HAVE_RB_THREAD_BLOCKING_REGION)
-        /* Only signal if the list was empty */
+        // Only signal if the list was empty
         if (empty) {
             char c;
             write(async_cb_pipe[1], &c, 1);
@@ -520,7 +519,7 @@ callback_invoke(ffi_cif* cif, void* retval, void** parameters, void* user_data)
         SetEvent(async_cb_cond);
 #endif
 
-        /* Wait for the thread executing the ruby callback to signal it is done */
+        // Wait for the thread executing the ruby callback to signal it is done
         WaitForSingleObject(cb.async_event, INFINITE);
         CloseHandle(cb.async_event);
 #endif
@@ -546,7 +545,7 @@ async_cb_event(void* unused)
     while (!w.stop) {
         rb_thread_blocking_region(async_cb_wait, &w, async_cb_stop, &w);
         if (w.cb != NULL) {
-            /* Start up a new ruby thread to run the ruby callback */
+            // Start up a new ruby thread to run the ruby callback
             rb_thread_create(async_cb_call, w.cb);
         }
     }
@@ -575,7 +574,7 @@ async_cb_event(void* unused)
 
         while (cb != NULL) {
             struct gvl_callback* next = cb->next;
-            /* Start up a new ruby thread to run the ruby callback */
+            // Start up a new ruby thread to run the ruby callback
             rb_thread_create(async_cb_call, cb);
             cb = next;
         }
@@ -607,7 +606,7 @@ async_cb_event(void* unused)
 
         while (cb != NULL) {
             struct gvl_callback* next = cb->next;
-            /* Start up a new ruby thread to run the ruby callback */
+            // Start up a new ruby thread to run the ruby callback
             rb_thread_create(async_cb_call, cb);
             cb = next;
         }
@@ -697,7 +696,7 @@ async_cb_call(void *data)
 
     callback_with_gvl(cb);
 
-    /* Signal the original native thread that the ruby code has completed */
+    // Signal the original native thread that the ruby code has completed
 #ifdef _WIN32
     SetEvent(cb->async_event);
 #else
@@ -800,7 +799,7 @@ callback_with_gvl(void* data)
                 break;
         }
 
-        /* Convert the native value into a custom ruby value */
+        // Convert the native value into a custom ruby value
         if (unlikely(cbInfo->parameterTypes[i]->nativeType == NATIVE_MAPPED)) {
             VALUE values[] = { param, Qnil };
             param = rb_funcall2(((MappedType *) cbInfo->parameterTypes[i])->rbConverter, id_from_native, 2, values);
@@ -854,7 +853,7 @@ callback_with_gvl(void* data)
             if (TYPE(rbReturnValue) == T_DATA && rb_obj_is_kind_of(rbReturnValue, rbffi_PointerClass)) {
                 *((void **) retval) = ((AbstractMemory *) DATA_PTR(rbReturnValue))->address;
             } else {
-                /* Default to returning NULL if not a value pointer object.  handles nil case as well */
+                // Default to returning NULL if not a value pointer object.  handles nil case as well
                 *((void **) retval) = NULL;
             }
             break;