ffi 0.6.4 → 1.0.0

data/ext/ffi_c/Call.h

@@ -69,7 +69,7 @@ typedef union {
 
 extern void rbffi_Call_Init(VALUE moduleFFI);
 
-extern void rbffi_SetupCallParams(int argc, VALUE* argv, int paramCount, NativeType* paramTypes,
+extern void rbffi_SetupCallParams(int argc, VALUE* argv, int paramCount, Type** paramTypes,
         FFIStorage* paramStorage, void** ffiValues,
         VALUE* callbackParameters, int callbackCount, VALUE enums);
 

data/ext/ffi_c/DataConverter.c

@@ -0,0 +1,62 @@
+
+#include <ruby.h>
+
+#include <ffi.h>
+#include "rbffi.h"
+
+#include "Type.h"
+#include "MappedType.h"
+
+
+VALUE rbffi_DataConverterClass = Qnil;
+static ID id_native_type_ivar;
+
+static VALUE
+conv_native_type(int argc, VALUE* argv, VALUE self)
+{
+    if (argc == 0) {
+        if (!rb_ivar_defined(self, id_native_type_ivar)) {
+            rb_raise(rb_eNotImpError, "native_type method not overridden and no native_type set");
+        }
+
+        return rb_ivar_get(self, id_native_type_ivar);
+
+    } else if (argc == 1) {
+        VALUE type = rbffi_Type_Find(argv[0]);
+
+        rb_ivar_set(self, id_native_type_ivar, type);
+
+        return type;
+
+    } else {
+        rb_raise(rb_eArgError, "incorrect arguments");
+    }
+}
+
+static VALUE
+conv_to_native(VALUE self, VALUE value, VALUE ctx)
+{
+    return value;
+}
+
+static VALUE
+conv_from_native(VALUE self, VALUE value, VALUE ctx)
+{
+    return value;
+}
+
+
+
+void
+rbffi_DataConverter_Init(VALUE moduleFFI)
+{
+    rbffi_DataConverterClass = rb_define_module_under(moduleFFI, "DataConverter");
+
+    rb_define_method(rbffi_DataConverterClass, "native_type", conv_native_type, -1);
+    rb_define_method(rbffi_DataConverterClass, "to_native", conv_to_native, 2);
+    rb_define_method(rbffi_DataConverterClass, "from_native", conv_from_native, 2);
+
+    id_native_type_ivar = rb_intern("@native_type");
+}
+
+

data/ext/ffi_c/DynamicLibrary.c

@@ -1,3 +1,23 @@
+/*
+ * Copyright (c) 2008-2010 Wayne Meissner
+ *
+ * All rights reserved.
+ *
+ * This file is part of ruby-ffi.
+ *
+ * This code is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License version 3 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
+ * version 3 for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with this work.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
 #include <sys/types.h>
 #include <stdio.h>
 #include <stdint.h>
@@ -156,7 +176,7 @@ symbol_new(VALUE library, void* address, VALUE name)
     sym->memory.address = address;
     sym->memory.size = LONG_MAX;
     sym->memory.typeSize = 1;
-    sym->memory.access = MEM_RD | MEM_WR;
+    sym->memory.flags = MEM_RD | MEM_WR;
     sym->library = library;
     sym->name = name;
 

data/ext/ffi_c/Function.c

@@ -1,28 +1,21 @@
 /*
  * Copyright (c) 2009, Wayne Meissner
+
  * All rights reserved.
  *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
+ * This file is part of ruby-ffi.
+ *
+ * This code is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License version 3 only, as
+ * published by the Free Software Foundation.
  *
- * * 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.
- * * The name of the author or authors may not be used to endorse or promote
- *   products derived from this software without specific prior written permission.
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
+ * version 3 for more details.
  *
- * 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.
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with this work.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #include "MethodHandle.h"
@@ -39,6 +32,10 @@
 #include <ruby.h>
 
 #include <ffi.h>
+#if defined(HAVE_NATIVETHREAD) && !defined(_WIN32)
+#include <pthread.h>
+#endif
+
 #include "rbffi.h"
 #include "compat.h"
 
@@ -51,6 +48,7 @@
 #include "Call.h"
 #include "ClosurePool.h"
 #include "Function.h"
+#include "MappedType.h"
 
 typedef struct Function_ {
     AbstractMemory memory;
@@ -67,10 +65,60 @@ static void function_free(Function *);
 static VALUE function_init(VALUE self, VALUE rbFunctionInfo, VALUE rbProc);
 static void callback_invoke(ffi_cif* cif, void* retval, void** parameters, void* user_data);
 static bool callback_prep(void* ctx, void* code, Closure* closure, char* errmsg, size_t errmsgsize);
+static void* callback_with_gvl(void* data);
+
+#if defined(HAVE_NATIVETHREAD) && defined(HAVE_RB_THREAD_BLOCKING_REGION)
+# define DEFER_ASYNC_CALLBACK 1
+#endif
+
+#if defined(DEFER_ASYNC_CALLBACK)
+static VALUE async_cb_event(void);
+static VALUE async_cb_call(void *);
+#endif
+
+#if defined(HAVE_NATIVETHREAD) && defined (HAVE_RB_THREAD_BLOCKING_REGION)
+#  define DEFER_ASYNC_CALLBACK
+#endif
+
+#ifdef HAVE_RUBY_THREAD_HAS_GVL_P
+extern int ruby_thread_has_gvl_p(void);
+#endif
+
+#ifdef HAVE_RB_THREAD_CALL_WITH_GVL
+extern void *rb_thread_call_with_gvl(void *(*func)(void *), void *data1);
+#endif
 
 VALUE rbffi_FunctionClass = Qnil;
 
-static ID id_call = 0, id_cbtable = 0, id_cb_ref = 0;
+#if defined(DEFER_ASYNC_CALLBACK)
+static VALUE async_cb_thread = Qnil;
+#endif
+
+static ID id_call = 0, id_to_native = 0, id_from_native = 0, id_cbtable = 0, id_cb_ref = 0;
+
+struct gvl_callback {
+    Closure* closure;
+    void*    retval;
+    void**   parameters;
+
+#if defined(DEFER_ASYNC_CALLBACK)
+    struct gvl_callback* next;
+# ifndef _WIN32
+    pthread_cond_t async_cond;
+    pthread_mutex_t async_mutex;
+# endif
+#endif
+};
+
+
+#if defined(DEFER_ASYNC_CALLBACK)
+static struct gvl_callback* async_cb_list = NULL;
+# ifndef _WIN32
+static pthread_mutex_t async_cb_mutex = PTHREAD_MUTEX_INITIALIZER;
+static pthread_cond_t async_cb_cond = PTHREAD_COND_INITIALIZER;
+# endif
+#endif
+
 
 static VALUE
 function_allocate(VALUE klass)
@@ -80,7 +128,7 @@ function_allocate(VALUE klass)
 
     obj = Data_Make_Struct(klass, Function, function_mark, function_free, fn);
 
-    fn->memory.access = MEM_RD;
+    fn->memory.flags = MEM_RD;
 
     fn->rbProc = Qnil;
     fn->rbFunctionInfo = Qnil;
@@ -215,6 +263,12 @@ function_init(VALUE self, VALUE rbFunctionInfo, VALUE rbProc)
             }
         }
 
+#if defined(DEFER_ASYNC_CALLBACK)
+        if (async_cb_thread == Qnil) {
+            async_cb_thread = rb_thread_create(async_cb_event, NULL);
+        }
+#endif
+
         fn->closure = rbffi_Closure_Alloc(fn->info->closurePool);
         fn->closure->info = fn;
         fn->memory.address = fn->closure->code;
@@ -222,7 +276,8 @@ function_init(VALUE self, VALUE rbFunctionInfo, VALUE rbProc)
         fn->autorelease = true;
 
     } else {
-        rb_raise(rb_eTypeError, "wrong argument type.  Expected pointer or proc");
+        rb_raise(rb_eTypeError, "wrong argument type %s, expected pointer or proc",
+                rb_obj_classname(rbProc));
     }
     
     fn->rbProc = rbProc;
@@ -320,17 +375,147 @@ function_release(VALUE self)
 static void
 callback_invoke(ffi_cif* cif, void* retval, void** parameters, void* user_data)
 {
-    Closure* closure = (Closure *) user_data;
-    Function* fn = (Function *) closure->info;
+    struct gvl_callback cb;
+    cb.closure = (Closure *) user_data;
+    cb.retval = retval;
+    cb.parameters = parameters;
+
+#ifdef HAVE_RUBY_THREAD_HAS_GVL_P
+    if (ruby_thread_has_gvl_p()) {
+#else
+    if (1) {
+#endif
+        callback_with_gvl(&cb);
+    
+#if defined(HAVE_RUBY_NATIVE_THREAD_P) && defined (HAVE_RB_THREAD_CALL_WITH_GVL)
+    } else if (ruby_native_thread_p()) {
+        rb_thread_call_with_gvl(callback_with_gvl, &cb);
+#endif
+#if defined(DEFER_ASYNC_CALLBACK) && !defined(_WIN32)
+    } else {
+        pthread_mutex_init(&cb.async_mutex, NULL);
+        pthread_cond_init(&cb.async_cond, NULL);
+
+        pthread_mutex_lock(&cb.async_mutex);
+
+        // Now signal the async callback thread
+        pthread_mutex_lock(&async_cb_mutex);
+        cb.next = async_cb_list;
+        async_cb_list = &cb;
+        pthread_cond_signal(&async_cb_cond);
+        pthread_mutex_unlock(&async_cb_mutex);
+
+        // Wait for the thread executing the ruby callback to signal it is done
+        pthread_cond_wait(&cb.async_cond, &cb.async_mutex);
+#endif
+    }
+}
+
+#if defined(DEFER_ASYNC_CALLBACK)
+struct async_wait {
+    void* cb;
+    bool stop;
+};
+
+static VALUE async_cb_wait(void *);
+static void async_cb_stop(void *);
+
+static VALUE
+async_cb_event(void)
+{
+    struct async_wait w = { 0 };
+
+    w.stop = false;
+    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
+            rb_thread_create(async_cb_call, w.cb);
+        }
+    }
+    
+    return Qnil;
+}
+
+static VALUE
+async_cb_wait(void *data)
+{
+    struct async_wait* w = (struct async_wait *) data;
+
+    w->cb = NULL;
+
+    pthread_mutex_lock(&async_cb_mutex);
+
+    while (!w->stop && async_cb_list == NULL) {
+        pthread_cond_wait(&async_cb_cond, &async_cb_mutex);
+    }
+    
+    if (async_cb_list != NULL) {
+        w->cb = async_cb_list;
+        async_cb_list = async_cb_list->next;
+    }
+
+    pthread_mutex_unlock(&async_cb_mutex);
+    
+    return Qnil;
+}
+
+static void
+async_cb_stop(void *data)
+{
+    struct async_wait* w = (struct async_wait *) data;
+
+    pthread_mutex_lock(&async_cb_mutex);
+    w->stop = true;
+    pthread_cond_signal(&async_cb_cond);
+    pthread_mutex_unlock(&async_cb_mutex);
+}
+
+static VALUE
+async_cb_call(void *data)
+{
+    struct gvl_callback* cb = (struct gvl_callback *) data;
+
+    callback_with_gvl(cb);
+
+    // Signal the original native thread that the ruby code has completed
+    pthread_mutex_lock(&cb->async_mutex);
+    pthread_cond_signal(&cb->async_cond);
+    pthread_mutex_unlock(&cb->async_mutex);
+
+    return Qnil;
+}
+
+#endif
+
+
+static void*
+callback_with_gvl(void* data)
+{
+    struct gvl_callback* cb = (struct gvl_callback *) data;
+
+    Function* fn = (Function *) cb->closure->info;
     FunctionType *cbInfo = fn->info;
+    Type* returnType = cbInfo->returnType;
+    void* retval = cb->retval;
+    void** parameters = cb->parameters;
     VALUE* rbParams;
+    VALUE rbReturnType = cbInfo->rbReturnType;
     VALUE rbReturnValue;
     int i;
 
     rbParams = ALLOCA_N(VALUE, cbInfo->parameterCount);
     for (i = 0; i < cbInfo->parameterCount; ++i) {
         VALUE param;
-        switch (cbInfo->parameterTypes[i]->nativeType) {
+        Type* paramType = cbInfo->parameterTypes[i];
+        VALUE rbParamType = rb_ary_entry(cbInfo->rbParameterTypes, i);
+
+        if (unlikely(paramType->nativeType == NATIVE_MAPPED)) {
+            paramType = ((MappedType *) paramType)->type;
+            rbParamType = ((MappedType *) paramType)->rbType;
+        }
+
+        switch (paramType->nativeType) {
             case NATIVE_INT8:
                 param = INT2NUM(*(int8_t *) parameters[i]);
                 break;
@@ -379,19 +564,36 @@ callback_invoke(ffi_cif* cif, void* retval, void** parameters, void* user_data)
 
             case NATIVE_FUNCTION:
             case NATIVE_CALLBACK:
-                param = rbffi_NativeValue_ToRuby(cbInfo->parameterTypes[i],
-                     rb_ary_entry(cbInfo->rbParameterTypes, i), parameters[i], Qnil);
+            case NATIVE_STRUCT:
+                param = rbffi_NativeValue_ToRuby(paramType, rbParamType, parameters[i], Qnil);
                 break;
+
             default:
                 param = Qnil;
                 break;
         }
+
+        // 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);
+        }
+
         rbParams[i] = param;
     }
+
     rbReturnValue = rb_funcall2(fn->rbProc, id_call, cbInfo->parameterCount, rbParams);
+    
+    if (unlikely(returnType->nativeType == NATIVE_MAPPED)) {
+        VALUE values[] = { rbReturnValue, Qnil };
+        rbReturnValue = rb_funcall2(((MappedType *) returnType)->rbConverter, id_to_native, 2, values);
+        rbReturnType = ((MappedType *) returnType)->rbType;
+        returnType = ((MappedType* ) returnType)->type;
+    }
+
     if (rbReturnValue == Qnil || TYPE(rbReturnValue) == T_NIL) {
-        memset(retval, 0, cbInfo->ffiReturnType->size);
-    } else switch (cbInfo->returnType->nativeType) {
+        memset(retval, 0, returnType->ffiType->size);
+    } else switch (returnType->nativeType) {
         case NATIVE_INT8:
         case NATIVE_INT16:
         case NATIVE_INT32:
@@ -442,7 +644,7 @@ callback_invoke(ffi_cif* cif, void* retval, void** parameters, void* user_data)
             } else if (rb_obj_is_kind_of(rbReturnValue, rb_cProc) || rb_respond_to(rbReturnValue, id_call)) {
                 VALUE function;
 
-                function = rbffi_Function_ForProc(cbInfo->rbReturnType, rbReturnValue);
+                function = rbffi_Function_ForProc(rbReturnType, rbReturnValue);
 
                 *((void **) retval) = ((AbstractMemory *) DATA_PTR(function))->address;
             } else {
@@ -450,10 +652,28 @@ callback_invoke(ffi_cif* cif, void* retval, void** parameters, void* user_data)
             }
             break;
 
+        case NATIVE_STRUCT:
+            if (TYPE(rbReturnValue) == T_DATA && rb_obj_is_kind_of(rbReturnValue, rbffi_StructClass)) {
+                AbstractMemory* memory = ((Struct *) DATA_PTR(rbReturnValue))->pointer;
+
+                if (memory->address != NULL) {
+                    memcpy(retval, memory->address, returnType->ffiType->size);
+
+                } else {
+                    memset(retval, 0, returnType->ffiType->size);
+                }
+                
+            } else {
+                memset(retval, 0, returnType->ffiType->size);
+            }
+            break;
+
         default:
             *((ffi_arg *) retval) = 0;
             break;
     }
+
+    return NULL;
 }
 
 
@@ -492,5 +712,7 @@ rbffi_Function_Init(VALUE moduleFFI)
     id_call = rb_intern("call");
     id_cbtable = rb_intern("@__ffi_callback_table__");
     id_cb_ref = rb_intern("@__ffi_callback__");
+    id_to_native = rb_intern("to_native");
+    id_from_native = rb_intern("from_native");
 }