ffi 0.4.0 → 0.5.0

data/ext/ffi_c/MethodHandle.c

@@ -0,0 +1,346 @@
+/*
+ * 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:
+ *
+ * * 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 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.
+ */
+
+#include <sys/param.h>
+#include <sys/types.h>
+#ifndef _WIN32
+#  include <sys/mman.h>
+#endif
+#include <stdio.h>
+#include <stdint.h>
+#include <stdbool.h>
+#ifndef _WIN32
+#  include <unistd.h>
+#endif
+#include <errno.h>
+#include <ruby.h>
+#if defined(HAVE_NATIVETHREAD) && !defined(_WIN32) && !defined(__WIN32__)
+# include <pthread.h>
+#endif
+
+#include <ffi.h>
+#include "rbffi.h"
+#include "compat.h"
+
+#include "Function.h"
+#include "Types.h"
+#include "Type.h"
+#include "LastError.h"
+#include "Call.h"
+#include "ClosurePool.h"
+#include "MethodHandle.h"
+
+
+#define MAX_METHOD_FIXED_ARITY (6)
+
+#if defined(HAVE_NATIVETHREAD) && !defined(_WIN32) && !defined(__WIN32__)
+#  define USE_PTHREAD_LOCAL
+#endif
+
+#ifndef roundup
+#  define roundup(x, y)   ((((x)+((y)-1))/(y))*(y))
+#endif
+#ifdef _WIN32
+  typedef char* caddr_t;
+#endif
+
+#ifdef USE_RAW
+#  define METHOD_CLOSURE ffi_raw_closure
+#  define METHOD_PARAMS ffi_raw*
+#else
+#  define METHOD_CLOSURE ffi_closure
+#  define METHOD_PARAMS void**
+#endif
+
+
+
+static bool prep_trampoline(void* ctx, void* code, Closure* closure, char* errmsg, size_t errmsgsize);
+static int trampoline_size(void);
+
+#if defined(__x86_64__) && defined(__GNUC__)
+# define CUSTOM_TRAMPOLINE 1
+#endif
+
+
+struct MethodHandle {
+    Closure* closure;
+};
+
+static ClosurePool* defaultClosurePool;
+
+
+MethodHandle*
+rbffi_MethodHandle_Alloc(FunctionType* fnInfo, void* function)
+{
+    MethodHandle* handle;
+    Closure* closure = rbffi_Closure_Alloc(defaultClosurePool);
+    if (closure == NULL) {
+        rb_raise(rb_eNoMemError, "failed to allocate closure from pool");
+        return NULL;
+    }
+
+    handle = xcalloc(1, sizeof(*handle));
+    handle->closure = closure;
+    closure->info = fnInfo;
+    closure->function = function;
+
+    return handle;
+}
+
+void
+rbffi_MethodHandle_Free(MethodHandle* handle)
+{
+    if (handle != NULL) {
+        rbffi_Closure_Free(handle->closure);
+    }
+}
+
+void*
+rbffi_MethodHandle_CodeAddress(MethodHandle* handle)
+{
+    return handle->closure->code;
+}
+
+#ifndef CUSTOM_TRAMPOLINE
+static void attached_method_invoke(ffi_cif* cif, void* retval, METHOD_PARAMS parameters, void* user_data);
+
+static ffi_type* methodHandleParamTypes[] = {
+    &ffi_type_sint,
+    &ffi_type_pointer,
+    &ffi_type_ulong,
+};
+
+static ffi_cif mh_cif;
+
+static bool
+prep_trampoline(void* ctx, void* code, Closure* closure, char* errmsg, size_t errmsgsize)
+{
+    ffi_status ffiStatus;
+
+#if defined(USE_RAW)
+    ffiStatus = ffi_prep_raw_closure(code, &mh_cif, attached_method_invoke, closure);
+#else
+    ffiStatus = ffi_prep_closure(code, &mh_cif, attached_method_invoke, closure);
+#endif
+    if (ffiStatus != FFI_OK) {
+        snprintf(errmsg, errmsgsize, "ffi_prep_closure failed.  status=%#x", ffiStatus);
+        return false;
+    }
+
+    return true;
+}
+
+
+static int
+trampoline_size(void)
+{
+    return sizeof(METHOD_CLOSURE);
+}
+
+/*
+ * attached_method_vinvoke is used functions with more than 6 parameters, or
+ * with struct param or return values
+ */
+static void
+attached_method_invoke(ffi_cif* cif, void* mretval, METHOD_PARAMS parameters, void* user_data)
+{
+    Closure* handle =  (Closure *) user_data;
+    FunctionType* fnInfo = (FunctionType *) handle->info;
+
+#ifdef USE_RAW
+    int argc = parameters[0].sint;
+    VALUE* argv = *(VALUE **) &parameters[1];
+#else
+    int argc = *(ffi_sarg *) parameters[0];
+    VALUE* argv = *(VALUE **) parameters[1];
+#endif
+
+    *(VALUE *) mretval = (*fnInfo->invoke)(argc, argv, handle->function, fnInfo);
+}
+
+#endif
+
+
+
+#if defined(CUSTOM_TRAMPOLINE)
+#if defined(__x86_64__)
+
+static VALUE custom_trampoline(int argc, VALUE* argv, VALUE self, Closure*);
+
+#define TRAMPOLINE_CTX_MAGIC (0xfee1deadcafebabe)
+#define TRAMPOLINE_FUN_MAGIC (0xfeedfacebeeff00d)
+
+/*
+ * This is a hand-coded trampoline to speedup entry from ruby to the FFI translation
+ * layer for x86_64 arches.
+ *
+ * Since a ruby function has exactly 3 arguments, and the first 6 arguments are
+ * passed in registers for x86_64, we can tack on a context pointer by simply
+ * putting a value in %rcx, then jumping to the C trampoline code.
+ *
+ * This results in approx a 30% speedup for x86_64 FFI dispatch
+ */
+asm(
+    ".text\n\t"
+    ".globl ffi_trampoline\n\t"
+    ".globl _ffi_trampoline\n\t"
+    "ffi_trampoline:\n\t"
+    "_ffi_trampoline:\n\t"
+    "movabsq $0xfee1deadcafebabe, %rcx\n\t"
+    "movabsq $0xfeedfacebeeff00d, %r11\n\t"
+    "jmpq *%r11\n\t"
+    ".globl ffi_trampoline_end\n\t"
+    "ffi_trampoline_end:\n\t"
+    ".globl _ffi_trampoline_end\n\t"
+    "_ffi_trampoline_end:\n\t"
+);
+
+static VALUE
+custom_trampoline(int argc, VALUE* argv, VALUE self, Closure* handle)
+{
+    FunctionType* fnInfo = (FunctionType *) handle->info;
+    return (*fnInfo->invoke)(argc, argv, handle->function, fnInfo);
+}
+
+#elif defined(__i386__) && 0
+
+static VALUE custom_trampoline(caddr_t args, Closure*);
+#define TRAMPOLINE_CTX_MAGIC (0xfee1dead)
+#define TRAMPOLINE_FUN_MAGIC (0xbeefcafe)
+
+/*
+ * This is a hand-coded trampoline to speedup entry from ruby to the FFI translation
+ * layer for i386 arches.
+ *
+ * This does not make a discernable difference vs a raw closure, so for now,
+ * it is not enabled.
+ */
+asm(
+    ".text\n\t"
+    ".globl ffi_trampoline\n\t"
+    ".globl _ffi_trampoline\n\t"
+    "ffi_trampoline:\n\t"
+    "_ffi_trampoline:\n\t"
+    "subl    $12, %esp\n\t"
+    "leal    16(%esp), %eax\n\t"
+    "movl    %eax, (%esp)\n\t"
+    "movl    $0xfee1dead, 4(%esp)\n\t"
+    "movl    $0xbeefcafe, %eax\n\t"
+    "call    *%eax\n\t"
+    "addl    $12, %esp\n\t"
+    "ret\n\t"
+    ".globl ffi_trampoline_end\n\t"
+    "ffi_trampoline_end:\n\t"
+    ".globl _ffi_trampoline_end\n\t"
+    "_ffi_trampoline_end:\n\t"
+);
+
+static VALUE
+custom_trampoline(caddr_t args, Closure* handle)
+{
+    FunctionType* fnInfo = (FunctionType *) handle->info;
+    return (*fnInfo->invoke)(*(int *) args, *(VALUE **) (args + 4), handle->function, fnInfo);
+}
+
+#endif /* __x86_64__ else __i386__ */
+
+extern void ffi_trampoline(int argc, VALUE* argv, VALUE self);
+extern void ffi_trampoline_end(void);
+static int trampoline_offsets(int *, int *);
+
+static int trampoline_ctx_offset, trampoline_func_offset;
+
+static int
+trampoline_offset(int off, const long value)
+{
+    caddr_t ptr;
+    for (ptr = (caddr_t) &ffi_trampoline + off; ptr < (caddr_t) &ffi_trampoline_end; ++ptr) {
+        if (*(long *) ptr == value) {
+            return ptr - (caddr_t) &ffi_trampoline;
+        }
+    }
+
+    return -1;
+}
+
+static int
+trampoline_offsets(int* ctxOffset, int* fnOffset)
+{
+    *ctxOffset = trampoline_offset(0, TRAMPOLINE_CTX_MAGIC);
+    if (*ctxOffset == -1) {
+        return -1;
+    }
+
+    *fnOffset = trampoline_offset(0, TRAMPOLINE_FUN_MAGIC);
+    if (*fnOffset == -1) {
+        return -1;
+    }
+
+    return 0;
+}
+
+static bool
+prep_trampoline(void* ctx, void* code, Closure* closure, char* errmsg, size_t errmsgsize)
+{
+    caddr_t ptr = (caddr_t) code;
+
+    memcpy(ptr, &ffi_trampoline, trampoline_size());
+    // Patch the context and function addresses into the stub code
+    *(intptr_t *)(ptr + trampoline_ctx_offset) = (intptr_t) closure;
+    *(intptr_t *)(ptr + trampoline_func_offset) = (intptr_t) custom_trampoline;
+
+    return true;
+}
+
+static int
+trampoline_size(void)
+{
+    return (caddr_t) &ffi_trampoline_end - (caddr_t) &ffi_trampoline;
+}
+
+#endif /* CUSTOM_TRAMPOLINE */
+
+
+void
+rbffi_MethodHandle_Init(VALUE module)
+{
+    defaultClosurePool = rbffi_ClosurePool_New(trampoline_size(), prep_trampoline, NULL);
+
+#if defined(CUSTOM_TRAMPOLINE)
+    if (trampoline_offsets(&trampoline_ctx_offset, &trampoline_func_offset) != 0) {
+        rb_raise(rb_eFatal, "Could not locate offsets in trampoline code");
+    }
+#else
+    ffi_status ffiStatus = ffi_prep_cif(&mh_cif, FFI_DEFAULT_ABI, 3, &ffi_type_ulong,
+            methodHandleParamTypes);
+    if (ffiStatus != FFI_OK) {
+        rb_raise(rb_eFatal, "ffi_prep_cif failed.  status=%#x", ffiStatus);
+    }
+
+#endif
+}
+

data/ext/ffi_c/MethodHandle.h

@@ -0,0 +1,53 @@
+/*
+ * 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:
+ *
+ * * 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 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.
+ */
+
+#ifndef _METHODHANDLE_H
+#define	_METHODHANDLE_H
+
+#ifdef	__cplusplus
+extern "C" {
+#endif
+
+#include <ruby.h>
+#include "Function.h"
+
+    
+typedef struct MethodHandlePool MethodHandlePool;
+typedef struct MethodHandle MethodHandle;
+
+
+MethodHandle* rbffi_MethodHandle_Alloc(FunctionType* fnInfo, void* function);
+void rbffi_MethodHandle_Free(MethodHandle* handle);
+void* rbffi_MethodHandle_CodeAddress(MethodHandle* handle);
+void rbffi_MethodHandle_Init(VALUE module);
+
+#ifdef	__cplusplus
+}
+#endif
+
+#endif	/* _METHODHANDLE_H */
+

data/ext/ffi_c/Pointer.c

@@ -1,3 +1,31 @@
+/*
+ * Copyright (c) 2008, 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:
+ *
+ * * 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 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.
+ */
+
 #include <stdbool.h>
 #include <stdint.h>
 #include <limits.h>
@@ -13,7 +41,9 @@ typedef struct Pointer {
 
 #define POINTER(obj) rbffi_AbstractMemory_Cast((obj), rbffi_PointerClass)
 
-VALUE rbffi_PointerClass;
+VALUE rbffi_PointerClass = Qnil;
+VALUE rbffi_NullPointerSingleton = Qnil;
+
 static void ptr_mark(Pointer* ptr);
 
 VALUE
@@ -30,6 +60,8 @@ rbffi_Pointer_NewInstance(void* addr)
     p->memory.address = addr;
     p->memory.size = LONG_MAX;
     p->memory.ops = &rbffi_AbstractMemoryOps;
+    p->memory.access = (addr == NULL) ? 0 : (MEM_RD | MEM_WR);
+    p->memory.typeSize = 1;
     p->parent = Qnil;
 
     return obj;
@@ -41,9 +73,10 @@ ptr_allocate(VALUE klass)
     Pointer* p;
     VALUE obj;
 
-    obj = Data_Make_Struct(rbffi_PointerClass, Pointer, NULL, -1, p);
+    obj = Data_Make_Struct(klass, Pointer, NULL, -1, p);
     p->parent = Qnil;
     p->memory.ops = &rbffi_AbstractMemoryOps;
+    p->memory.access = MEM_RD | MEM_WR;
 
     return obj;
 }
@@ -52,28 +85,48 @@ static VALUE
 ptr_initialize(int argc, VALUE* argv, VALUE self)
 {
     Pointer* p;
-    VALUE type, address;
+    VALUE rbType = Qnil, rbAddress = Qnil;
+    int typeSize = 1;
 
     Data_Get_Struct(self, Pointer, p);
 
-    switch (rb_scan_args(argc, argv, "11", &type, &address)) {
+    switch (rb_scan_args(argc, argv, "11", &rbType, &rbAddress)) {
         case 1:
-            p->memory.address = (void*)(uintptr_t) NUM2LL(type);
-            // FIXME set type_size to 1
+            rbAddress = rbType;
+            typeSize = 1;
             break;
         case 2:
-            p->memory.address = (void*)(uintptr_t) NUM2LL(address);
-            // FIXME set type_size to rbffi_type_size(type)
+            typeSize = rbffi_type_size(rbType);
             break;
         default:
             rb_raise(rb_eArgError, "Invalid arguments");
     }
-    if (p->memory.address == NULL) {
-        p->memory.ops = &rbffi_NullPointerOps;
+
+    switch (TYPE(rbAddress)) {
+        case T_FIXNUM:
+        case T_BIGNUM:
+            p->memory.address = (void*) (uintptr_t) NUM2LL(rbAddress);
+            p->memory.size = LONG_MAX;
+            if (p->memory.address == NULL) {
+                p->memory.access = 0;
+            }
+            break;
+
+        default:
+            if (rb_obj_is_kind_of(rbAddress, rbffi_PointerClass)) {
+                Pointer* orig;
+
+                p->parent = rbAddress;
+                Data_Get_Struct(rbAddress, Pointer, orig);
+                p->memory = orig->memory;
+            } else {
+                rb_raise(rb_eTypeError, "wrong argument type, expected Integer or FFI::Pointer");
+            }
+            break;
     }
 
-    p->memory.size = LONG_MAX;
-    
+    p->memory.typeSize = typeSize;
+
     return self;
 }
 
@@ -94,6 +147,8 @@ ptr_plus(VALUE self, VALUE offset)
     p->memory.address = ptr->address + off;
     p->memory.size = ptr->size == LONG_MAX ? LONG_MAX : ptr->size - off;
     p->memory.ops = &rbffi_AbstractMemoryOps;
+    p->memory.access = ptr->access;
+    p->memory.typeSize = ptr->typeSize;
     p->parent = self;
 
     return retval;
@@ -106,7 +161,7 @@ ptr_inspect(VALUE self)
     char tmp[100];
 
     Data_Get_Struct(self, Pointer, ptr);
-    snprintf(tmp, sizeof(tmp), "#<Native Pointer address=%p>", ptr->memory.address);
+    snprintf(tmp, sizeof(tmp), "#<FFI::Pointer address=%p>", ptr->memory.address);
 
     return rb_str_new2(tmp);
 }
@@ -150,6 +205,8 @@ ptr_mark(Pointer* ptr)
 void
 rbffi_Pointer_Init(VALUE moduleFFI)
 {
+    VALUE rbNullAddress = ULL2NUM(0);
+
     rbffi_PointerClass = rb_define_class_under(moduleFFI, "Pointer", rbffi_AbstractMemoryClass);
     rb_global_variable(&rbffi_PointerClass);
 
@@ -161,4 +218,7 @@ rbffi_Pointer_Init(VALUE moduleFFI)
     rb_define_method(rbffi_PointerClass, "address", ptr_address, 0);
     rb_define_alias(rbffi_PointerClass, "to_i", "address");
     rb_define_method(rbffi_PointerClass, "==", ptr_equals, 1);
+
+    rbffi_NullPointerSingleton = rb_class_new_instance(1, &rbNullAddress, rbffi_PointerClass);
+    rb_define_const(rbffi_PointerClass, "NULL", rbffi_NullPointerSingleton);
 }