remogatto-ffi 0.5.0

data/ext/ffi_c/Types.h

@@ -0,0 +1,85 @@
+/*
+ * Copyright (c) 2008, 2009, Wayne Meissner
+ * Copyright (c) 2009, Luc Heinrich <luc@honk-honk.com>
+ *
+ * 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 RBFFI_TYPES_H
+#define	RBFFI_TYPES_H
+
+#ifdef	__cplusplus
+extern "C" {
+#endif
+
+typedef enum {
+    NATIVE_VOID,
+    NATIVE_INT8,
+    NATIVE_UINT8,
+    NATIVE_INT16,
+    NATIVE_UINT16,
+    NATIVE_INT32,
+    NATIVE_UINT32,
+    NATIVE_INT64,
+    NATIVE_UINT64,
+    NATIVE_FLOAT32,
+    NATIVE_FLOAT64,
+    NATIVE_POINTER,
+    NATIVE_CALLBACK,
+    NATIVE_FUNCTION,
+    NATIVE_BUFFER_IN,
+    NATIVE_BUFFER_OUT,
+    NATIVE_BUFFER_INOUT,
+    NATIVE_CHAR_ARRAY,
+    NATIVE_BOOL,
+    
+    /**
+     * An immutable string.  Nul terminated, but only copies in to the native function
+     */
+    NATIVE_STRING,
+    /** A Rubinus :string arg - copies data both ways, and nul terminates */
+    NATIVE_RBXSTRING,
+    /** The function takes a variable number of arguments */
+    NATIVE_VARARGS,
+    /** A typedef-ed enum */
+    NATIVE_ENUM,
+    /** Struct-by-value param or result */
+    NATIVE_STRUCT,
+    /** An array type definition */
+    NATIVE_ARRAY,
+} NativeType;
+
+#include <ffi.h>
+#include "Type.h"
+
+VALUE rbffi_NativeValue_ToRuby(Type* type, VALUE rbType, const void* ptr, VALUE enums);
+void rbffi_Types_Init(VALUE moduleFFI);
+
+#ifdef	__cplusplus
+}
+#endif
+
+#endif	/* RBFFI_TYPES_H */
+

data/ext/ffi_c/Variadic.c

@@ -0,0 +1,260 @@
+/*
+ * 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 <sys/param.h>
+#include <sys/types.h>
+
+#include <stdio.h>
+#include <stdint.h>
+#include <stdbool.h>
+#include <ruby.h>
+
+#include <ffi.h>
+#include "rbffi.h"
+#include "compat.h"
+
+#include "AbstractMemory.h"
+#include "Pointer.h"
+#include "Types.h"
+#include "Type.h"
+#include "LastError.h"
+#include "MethodHandle.h"
+#include "Call.h"
+
+typedef struct VariadicInvoker_ {
+    VALUE rbAddress;
+    VALUE rbReturnType;
+    VALUE rbEnums;
+
+    Type* returnType;
+    ffi_abi abi;
+    void* function;
+    int paramCount;
+} VariadicInvoker;
+
+
+static VALUE variadic_allocate(VALUE klass);
+static VALUE variadic_initialize(VALUE self, VALUE rbFunction, VALUE rbParameterTypes,
+        VALUE rbReturnType, VALUE options);
+static void variadic_mark(VariadicInvoker *);
+
+static VALUE classVariadicInvoker = Qnil;
+
+
+static VALUE
+variadic_allocate(VALUE klass)
+{
+    VariadicInvoker *invoker;
+    VALUE obj = Data_Make_Struct(klass, VariadicInvoker, variadic_mark, -1, invoker);
+
+    invoker->rbAddress = Qnil;
+    invoker->rbEnums = Qnil;
+    invoker->rbReturnType = Qnil;
+
+    return obj;
+}
+
+static void
+variadic_mark(VariadicInvoker *invoker)
+{
+    rb_gc_mark(invoker->rbEnums);
+    rb_gc_mark(invoker->rbAddress);
+    rb_gc_mark(invoker->rbReturnType);
+}
+
+static VALUE
+variadic_initialize(VALUE self, VALUE rbFunction, VALUE rbParameterTypes, VALUE rbReturnType, VALUE options)
+{
+    VariadicInvoker* invoker = NULL;
+    VALUE retval = Qnil;
+    VALUE convention = Qnil;
+    VALUE fixed = Qnil;
+    int i;
+
+    Check_Type(options, T_HASH);
+    convention = rb_hash_aref(options, ID2SYM(rb_intern("convention")));
+
+    Data_Get_Struct(self, VariadicInvoker, invoker);
+    invoker->rbEnums = rb_hash_aref(options, ID2SYM(rb_intern("enums")));
+    invoker->rbAddress = rbFunction;
+    invoker->function = rbffi_AbstractMemory_Cast(rbFunction, rbffi_PointerClass)->address;
+
+#if defined(_WIN32) || defined(__WIN32__)
+    invoker->abi = (RTEST(convention) && strcmp(StringValueCStr(convention), "stdcall") == 0)
+            ? FFI_STDCALL : FFI_DEFAULT_ABI;
+#else
+    invoker->abi = FFI_DEFAULT_ABI;
+#endif
+
+    invoker->rbReturnType = rbffi_Type_Lookup(rbReturnType);
+    if (!RTEST(invoker->rbReturnType)) {
+        VALUE typeName = rb_funcall2(rbReturnType, rb_intern("inspect"), 0, NULL);
+        rb_raise(rb_eTypeError, "Invalid return type (%s)", RSTRING_PTR(typeName));
+    }
+
+    Data_Get_Struct(rbReturnType, Type, invoker->returnType);
+
+    invoker->paramCount = -1;
+
+    fixed = rb_ary_new2(RARRAY_LEN(rbParameterTypes) - 1);
+    for (i = 0; i < RARRAY_LEN(rbParameterTypes); ++i) {
+        VALUE entry = rb_ary_entry(rbParameterTypes, i);
+        VALUE rbType = rbffi_Type_Lookup(entry);
+        Type* type;
+
+        if (!RTEST(rbType)) {
+            VALUE typeName = rb_funcall2(entry, rb_intern("inspect"), 0, NULL);
+            rb_raise(rb_eTypeError, "Invalid parameter type (%s)", RSTRING_PTR(typeName));
+        }
+        Data_Get_Struct(rbType, Type, type);
+        if (type->nativeType != NATIVE_VARARGS) {
+            rb_ary_push(fixed, entry);
+        }
+    }
+    /*
+     * @fixed and @type_map are used by the parameter mangling ruby code
+     */
+    rb_iv_set(self, "@fixed", fixed);
+    rb_iv_set(self, "@type_map", rb_hash_aref(options, ID2SYM(rb_intern("type_map"))));
+
+    return retval;
+}
+
+
+static inline VALUE
+ffi_invoke(ffi_cif* cif, void* function, Type* returnType, void** ffiValues,
+    VALUE rbReturnType, VALUE rbEnums)
+{
+    FFIStorage retval;
+
+#ifdef USE_RAW
+    ffi_raw_call(cif, function, &retval, (ffi_raw *) ffiValues[0]);
+#else
+    ffi_call(cif, function, &retval, ffiValues);
+#endif
+    rbffi_save_errno();
+
+    return rbffi_NativeValue_ToRuby(returnType, rbReturnType, &retval, rbEnums);
+}
+
+static VALUE
+variadic_call(VALUE self, VALUE parameterTypes, VALUE parameterValues)
+{
+    VariadicInvoker* invoker;
+    FFIStorage* params;
+    ffi_cif cif;
+    void** ffiValues;
+    ffi_type** ffiParamTypes;
+    ffi_type* ffiReturnType;
+    NativeType* paramTypes;
+    VALUE* argv;
+    int paramCount = 0, i;
+    ffi_status ffiStatus;
+
+    Check_Type(parameterTypes, T_ARRAY);
+    Check_Type(parameterValues, T_ARRAY);
+
+    Data_Get_Struct(self, VariadicInvoker, invoker);
+    paramCount = RARRAY_LEN(parameterTypes);
+    paramTypes = ALLOCA_N(NativeType, paramCount);
+    ffiParamTypes = ALLOCA_N(ffi_type *, paramCount);
+    params = ALLOCA_N(FFIStorage, paramCount);
+    ffiValues = ALLOCA_N(void*, paramCount);
+    argv = ALLOCA_N(VALUE, paramCount);
+
+    for (i = 0; i < paramCount; ++i) {
+        VALUE entry = rb_ary_entry(parameterTypes, i);
+        int paramType = rbffi_Type_GetIntValue(entry);
+        Type* type;
+        Data_Get_Struct(entry, Type, type);
+
+        switch (paramType) {
+            case NATIVE_INT8:
+            case NATIVE_INT16:
+            case NATIVE_INT32:
+            case NATIVE_ENUM:
+                paramType = NATIVE_INT32;
+                ffiParamTypes[i] = &ffi_type_sint;
+                break;
+            case NATIVE_UINT8:
+            case NATIVE_UINT16:
+            case NATIVE_UINT32:
+                paramType = NATIVE_UINT32;
+                ffiParamTypes[i] = &ffi_type_uint;
+                break;
+            case NATIVE_FLOAT32:
+                paramType = NATIVE_FLOAT64;
+                ffiParamTypes[i] = &ffi_type_double;
+                break;
+            default:
+                ffiParamTypes[i] = type->ffiType;
+                break;
+        }
+        paramTypes[i] = paramType;
+        if (ffiParamTypes[i] == NULL) {
+            rb_raise(rb_eArgError, "Invalid parameter type #%x", paramType);
+        }
+        argv[i] = rb_ary_entry(parameterValues, i);
+    }
+
+    ffiReturnType = invoker->returnType->ffiType;
+    if (ffiReturnType == NULL) {
+        rb_raise(rb_eArgError, "Invalid return type");
+    }
+    ffiStatus = ffi_prep_cif(&cif, invoker->abi, paramCount, ffiReturnType, ffiParamTypes);
+    switch (ffiStatus) {
+        case FFI_BAD_ABI:
+            rb_raise(rb_eArgError, "Invalid ABI specified");
+        case FFI_BAD_TYPEDEF:
+            rb_raise(rb_eArgError, "Invalid argument type specified");
+        case FFI_OK:
+            break;
+        default:
+            rb_raise(rb_eArgError, "Unknown FFI error");
+    }
+
+    rbffi_SetupCallParams(paramCount, argv, -1, paramTypes, params,
+        ffiValues, NULL, 0, invoker->rbEnums);
+
+    return ffi_invoke(&cif, invoker->function, invoker->returnType,
+        ffiValues, invoker->rbReturnType, invoker->rbEnums);
+}
+
+
+void
+rbffi_Variadic_Init(VALUE moduleFFI)
+{
+    classVariadicInvoker = rb_define_class_under(moduleFFI, "VariadicInvoker", rb_cObject);
+    rb_global_variable(&classVariadicInvoker);
+
+    rb_define_alloc_func(classVariadicInvoker, variadic_allocate);
+
+    rb_define_method(classVariadicInvoker, "initialize", variadic_initialize, 4);
+    rb_define_method(classVariadicInvoker, "invoke", variadic_call, 2);
+    rb_define_alias(classVariadicInvoker, "call", "invoke");
+}
+

data/ext/ffi_c/compat.h

@@ -0,0 +1,72 @@
+/*
+ * 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.
+ */
+
+#ifndef RBFFI_COMPAT_H
+#define RBFFI_COMPAT_H
+
+#include <ruby.h>
+
+#ifndef RARRAY_LEN
+#  define RARRAY_LEN(ary) RARRAY(ary)->len
+#endif
+
+#ifndef RARRAY_PTR
+#  define RARRAY_PTR(ary) RARRAY(ary)->ptr
+#endif
+
+#ifndef RSTRING_LEN
+#  define RSTRING_LEN(s) RSTRING(s)->len
+#endif
+
+#ifndef RSTRING_PTR
+#  define RSTRING_PTR(s) RSTRING(s)->ptr
+#endif
+
+#ifndef NUM2ULL
+#  define NUM2ULL(x) rb_num2ull((VALUE)x)
+#endif
+
+#ifndef roundup
+#  define roundup(x, y)   ((((x)+((y)-1))/(y))*(y))
+#endif
+
+#ifdef __GNUC__
+#  define likely(x) __builtin_expect((x), 1)
+#  define unlikely(x) __builtin_expect((x), 0)
+#else
+#  define likely(x) (x)
+#  define unlikely(x) (x)
+#endif
+
+#ifndef MAX
+#  define MAX(a, b) ((a) < (b) ? (b) : (a))
+#endif
+#ifndef MIN
+#  define MIN(a, b) ((a) < (b) ? (a) : (b))
+#endif
+
+#endif /* RBFFI_COMPAT_H */

data/ext/ffi_c/endian.h

@@ -0,0 +1,40 @@
+#ifndef JFFI_ENDIAN_H
+#define JFFI_ENDIAN_H
+
+#include <sys/param.h>
+#include <sys/types.h>
+
+#ifdef __linux__
+#  include_next <endian.h>
+#endif
+
+#ifdef __sun
+# include <sys/byteorder.h>
+# define LITTLE_ENDIAN 1234
+# define BIG_ENDIAN 4321
+# if defined(_BIG_ENDIAN)
+#  define BYTE_ORDER BIG_ENDIAN
+# elif defined(_LITTLE_ENDIAN)
+#  define BYTE_ORDER LITTLE_ENDIAN
+# else
+#  error "Cannot determine endian-ness"
+# endif
+#endif
+
+#if defined(_AIX) && !defined(BYTE_ORDER)
+# define LITTLE_ENDIAN 1234
+# define BIG_ENDIAN 4321
+# if defined(__BIG_ENDIAN__)
+#  define BYTE_ORDER BIG_ENDIAN
+# elif defined(__LITTLE_ENDIAN__)
+#  define BYTE_ORDER LITTLE_ENDIAN
+# else
+#  error "Cannot determine endian-ness"
+# endif
+#endif
+
+#if !defined(BYTE_ORDER) || !defined(LITTLE_ENDIAN) || !defined(BIG_ENDIAN)
+#  error "Cannot determine the endian-ness of this platform"
+#endif
+
+#endif /* JFFI_ENDIAN_H */