1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
|
/*
* Copyright (c) 2009-2011 Wayne Meissner
*
* Copyright (c) 2008-2013, Ruby FFI project contributors
* 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 <COPYRIGHT HOLDER> 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 _MSC_VER
#include <sys/param.h>
#endif
#include <sys/types.h>
#ifndef _WIN32
# include <sys/mman.h>
# include <unistd.h>
#endif
#include <stdio.h>
#ifndef _MSC_VER
# include <stdint.h>
# include <stdbool.h>
#else
# include "win32/stdbool.h"
# if !defined(INT8_MIN)
# include "win32/stdint.h"
# endif
#endif
#include <ruby.h>
#include <ffi.h>
#if defined(HAVE_NATIVETHREAD) && !defined(_WIN32)
#include <pthread.h>
#endif
#include <fcntl.h>
#include "rbffi.h"
#include "compat.h"
#include "AbstractMemory.h"
#include "Pointer.h"
#include "Struct.h"
#include "Platform.h"
#include "Type.h"
#include "LastError.h"
#include "Call.h"
#include "ClosurePool.h"
#include "MappedType.h"
#include "Thread.h"
#include "LongDouble.h"
#include "MethodHandle.h"
#include "Function.h"
typedef struct Function_ {
Pointer base;
FunctionType* info;
MethodHandle* methodHandle;
bool autorelease;
Closure* closure;
VALUE rbProc;
VALUE rbFunctionInfo;
} Function;
static void function_mark(Function *);
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);
static VALUE invoke_callback(void* data);
static VALUE save_callback_exception(void* data, VALUE exc);
#define DEFER_ASYNC_CALLBACK 1
#if defined(DEFER_ASYNC_CALLBACK)
static VALUE async_cb_event(void *);
static VALUE async_cb_call(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;
#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;
bool done;
rbffi_frame_t *frame;
#if defined(DEFER_ASYNC_CALLBACK)
struct gvl_callback* next;
# ifndef _WIN32
pthread_cond_t async_cond;
pthread_mutex_t async_mutex;
# else
HANDLE async_event;
# 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;
# if !(defined(HAVE_RB_THREAD_BLOCKING_REGION) || defined(HAVE_RB_THREAD_CALL_WITHOUT_GVL))
static int async_cb_pipe[2];
# endif
# else
static HANDLE async_cb_cond;
static CRITICAL_SECTION async_cb_lock;
# if !(defined(HAVE_RB_THREAD_BLOCKING_REGION) || defined(HAVE_RB_THREAD_CALL_WITHOUT_GVL))
static int async_cb_pipe[2];
# endif
# endif
#endif
static VALUE
function_allocate(VALUE klass)
{
Function *fn;
VALUE obj;
obj = Data_Make_Struct(klass, Function, function_mark, function_free, fn);
fn->base.memory.flags = MEM_RD;
fn->base.rbParent = Qnil;
fn->rbProc = Qnil;
fn->rbFunctionInfo = Qnil;
fn->autorelease = true;
return obj;
}
static void
function_mark(Function *fn)
{
rb_gc_mark(fn->base.rbParent);
rb_gc_mark(fn->rbProc);
rb_gc_mark(fn->rbFunctionInfo);
}
static void
function_free(Function *fn)
{
if (fn->methodHandle != NULL) {
rbffi_MethodHandle_Free(fn->methodHandle);
}
if (fn->closure != NULL && fn->autorelease) {
rbffi_Closure_Free(fn->closure);
}
xfree(fn);
}
/*
* @param [Type, Symbol] return_type return type for the function
* @param [Array<Type, Symbol>] param_types array of parameters types
* @param [Hash] options see {FFI::FunctionType} for available options
* @return [self]
* A new Function instance.
*
* Define a function from a Proc or a block.
*
* @overload initialize(return_type, param_types, options = {}) { |i| ... }
* @yieldparam i parameters for the function
* @overload initialize(return_type, param_types, proc, options = {})
* @param [Proc] proc
*/
static VALUE
function_initialize(int argc, VALUE* argv, VALUE self)
{
VALUE rbReturnType = Qnil, rbParamTypes = Qnil, rbProc = Qnil, rbOptions = Qnil;
VALUE rbFunctionInfo = Qnil;
VALUE infoArgv[3];
int nargs;
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 }
*/
if (rb_block_given_p()) {
if (nargs > 3) {
rb_raise(rb_eArgError, "cannot create function with both proc/address and block");
}
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 })
*/
}
infoArgv[0] = rbReturnType;
infoArgv[1] = rbParamTypes;
infoArgv[2] = rbOptions;
rbFunctionInfo = rb_class_new_instance(rbOptions != Qnil ? 3 : 2, infoArgv, rbffi_FunctionTypeClass);
function_init(self, rbFunctionInfo, rbProc);
return self;
}
/*
* call-seq: initialize_copy(other)
* @return [nil]
* DO NOT CALL THIS METHOD
*/
static VALUE
function_initialize_copy(VALUE self, VALUE other)
{
rb_raise(rb_eRuntimeError, "cannot duplicate function instances");
return Qnil;
}
VALUE
rbffi_Function_NewInstance(VALUE rbFunctionInfo, VALUE rbProc)
{
return function_init(function_allocate(rbffi_FunctionClass), rbFunctionInfo, rbProc);
}
VALUE
rbffi_Function_ForProc(VALUE rbFunctionInfo, VALUE proc)
{
VALUE callback, cbref, cbTable;
Function* fp;
cbref = RTEST(rb_ivar_defined(proc, id_cb_ref)) ? rb_ivar_get(proc, id_cb_ref) : Qnil;
/* If the first callback reference has the same function function signature, use it */
if (cbref != Qnil && CLASS_OF(cbref) == rbffi_FunctionClass) {
Data_Get_Struct(cbref, Function, fp);
if (fp->rbFunctionInfo == rbFunctionInfo) {
return cbref;
}
}
cbTable = RTEST(rb_ivar_defined(proc, id_cbtable)) ? rb_ivar_get(proc, id_cbtable) : Qnil;
if (cbTable != Qnil && (callback = rb_hash_aref(cbTable, rbFunctionInfo)) != Qnil) {
return callback;
}
/* No existing function for the proc with that signature, create a new one and cache it */
callback = rbffi_Function_NewInstance(rbFunctionInfo, proc);
if (cbref == Qnil) {
/* If there is no other cb already cached for this proc, we can use the ivar slot */
rb_ivar_set(proc, id_cb_ref, callback);
} else {
/* The proc instance has been used as more than one type of callback, store extras in a hash */
cbTable = rb_hash_new();
rb_ivar_set(proc, id_cbtable, cbTable);
rb_hash_aset(cbTable, rbFunctionInfo, callback);
}
return callback;
}
static VALUE
function_init(VALUE self, VALUE rbFunctionInfo, VALUE rbProc)
{
Function* fn = NULL;
Data_Get_Struct(self, Function, fn);
fn->rbFunctionInfo = rbFunctionInfo;
Data_Get_Struct(fn->rbFunctionInfo, FunctionType, fn->info);
if (rb_obj_is_kind_of(rbProc, rbffi_PointerClass)) {
Pointer* orig;
Data_Get_Struct(rbProc, Pointer, orig);
fn->base.memory = orig->memory;
fn->base.rbParent = rbProc;
} else if (rb_obj_is_kind_of(rbProc, rb_cProc) || rb_respond_to(rbProc, id_call)) {
if (fn->info->closurePool == NULL) {
fn->info->closurePool = rbffi_ClosurePool_New(sizeof(ffi_closure), callback_prep, fn->info);
if (fn->info->closurePool == NULL) {
rb_raise(rb_eNoMemError, "failed to create closure pool");
}
}
#if defined(DEFER_ASYNC_CALLBACK)
if (async_cb_thread == Qnil) {
#if !(defined(HAVE_RB_THREAD_BLOCKING_REGION) || defined(HAVE_RB_THREAD_CALL_WITHOUT_GVL)) && defined(_WIN32)
_pipe(async_cb_pipe, 1024, O_BINARY);
#elif !(defined(HAVE_RB_THREAD_BLOCKING_REGION) || defined(HAVE_RB_THREAD_CALL_WITHOUT_GVL))
pipe(async_cb_pipe);
fcntl(async_cb_pipe[0], F_SETFL, fcntl(async_cb_pipe[0], F_GETFL) | O_NONBLOCK);
fcntl(async_cb_pipe[1], F_SETFL, fcntl(async_cb_pipe[1], F_GETFL) | O_NONBLOCK);
#endif
async_cb_thread = rb_thread_create(async_cb_event, NULL);
}
#endif
fn->closure = rbffi_Closure_Alloc(fn->info->closurePool);
fn->closure->info = fn;
fn->base.memory.address = fn->closure->code;
fn->base.memory.size = sizeof(*fn->closure);
fn->autorelease = true;
} else {
rb_raise(rb_eTypeError, "wrong argument type %s, expected pointer or proc",
rb_obj_classname(rbProc));
}
fn->rbProc = rbProc;
return self;
}
/*
* call-seq: call(*args)
* @param [Array] args function arguments
* @return [FFI::Type]
* Call the function
*/
static VALUE
function_call(int argc, VALUE* argv, VALUE self)
{
Function* fn;
Data_Get_Struct(self, Function, fn);
return (*fn->info->invoke)(argc, argv, fn->base.memory.address, fn->info);
}
/*
* call-seq: attach(m, name)
* @param [Module] m
* @param [String] name
* @return [self]
* Attach a Function to the Module +m+ as +name+.
*/
static VALUE
function_attach(VALUE self, VALUE module, VALUE name)
{
Function* fn;
char var[1024];
Data_Get_Struct(self, Function, fn);
if (fn->info->parameterCount == -1) {
rb_raise(rb_eRuntimeError, "cannot attach variadic functions");
return Qnil;
}
if (!rb_obj_is_kind_of(module, rb_cModule)) {
rb_raise(rb_eRuntimeError, "trying to attach function to non-module");
return Qnil;
}
if (fn->methodHandle == NULL) {
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
*/
snprintf(var, sizeof(var), "@@%s", StringValueCStr(name));
rb_cv_set(module, var, self);
rb_define_singleton_method(module, StringValueCStr(name),
rbffi_MethodHandle_CodeAddress(fn->methodHandle), -1);
rb_define_method(module, StringValueCStr(name),
rbffi_MethodHandle_CodeAddress(fn->methodHandle), -1);
return self;
}
/*
* call-seq: autorelease = autorelease
* @param [Boolean] autorelease
* @return [self]
* Set +autorelease+ attribute (See {Pointer}).
*/
static VALUE
function_set_autorelease(VALUE self, VALUE autorelease)
{
Function* fn;
Data_Get_Struct(self, Function, fn);
fn->autorelease = RTEST(autorelease);
return self;
}
static VALUE
function_autorelease_p(VALUE self)
{
Function* fn;
Data_Get_Struct(self, Function, fn);
return fn->autorelease ? Qtrue : Qfalse;
}
/*
* call-seq: free
* @return [self]
* Free memory allocated by Function.
*/
static VALUE
function_release(VALUE self)
{
Function* fn;
Data_Get_Struct(self, Function, fn);
if (fn->closure == NULL) {
rb_raise(rb_eRuntimeError, "cannot free function which was not allocated");
}
rbffi_Closure_Free(fn->closure);
fn->closure = NULL;
return self;
}
static void
callback_invoke(ffi_cif* cif, void* retval, void** parameters, void* user_data)
{
struct gvl_callback cb = { 0 };
cb.closure = (Closure *) user_data;
cb.retval = retval;
cb.parameters = parameters;
cb.done = false;
cb.frame = rbffi_frame_current();
if (cb.frame != NULL) cb.frame->exc = Qnil;
if (cb.frame != NULL && cb.frame->has_gvl) {
callback_with_gvl(&cb);
#if defined(HAVE_RB_THREAD_CALL_WITH_GVL)
} else if (cb.frame != NULL) {
rb_thread_call_with_gvl(callback_with_gvl, &cb);
#endif
#if defined(DEFER_ASYNC_CALLBACK) && !defined(_WIN32)
} else {
bool empty = false;
pthread_mutex_init(&cb.async_mutex, NULL);
pthread_cond_init(&cb.async_cond, NULL);
/* Now signal the async callback thread */
pthread_mutex_lock(&async_cb_mutex);
empty = async_cb_list == NULL;
cb.next = async_cb_list;
async_cb_list = &cb;
#if !(defined(HAVE_RB_THREAD_BLOCKING_REGION) || defined(HAVE_RB_THREAD_CALL_WITHOUT_GVL))
pthread_mutex_unlock(&async_cb_mutex);
/* Only signal if the list was empty */
if (empty) {
char c;
write(async_cb_pipe[1], &c, 1);
}
#else
pthread_cond_signal(&async_cb_cond);
pthread_mutex_unlock(&async_cb_mutex);
#endif
/* 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);
}
pthread_mutex_unlock(&cb.async_mutex);
pthread_cond_destroy(&cb.async_cond);
pthread_mutex_destroy(&cb.async_mutex);
#elif defined(DEFER_ASYNC_CALLBACK) && defined(_WIN32)
} else {
bool empty = false;
cb.async_event = CreateEvent(NULL, FALSE, FALSE, NULL);
/* Now signal the async callback thread */
EnterCriticalSection(&async_cb_lock);
empty = async_cb_list == NULL;
cb.next = async_cb_list;
async_cb_list = &cb;
LeaveCriticalSection(&async_cb_lock);
#if !(defined(HAVE_RB_THREAD_BLOCKING_REGION) || defined(HAVE_RB_THREAD_CALL_WITHOUT_GVL))
/* Only signal if the list was empty */
if (empty) {
char c;
write(async_cb_pipe[1], &c, 1);
}
#else
SetEvent(async_cb_cond);
#endif
/* Wait for the thread executing the ruby callback to signal it is done */
WaitForSingleObject(cb.async_event, INFINITE);
CloseHandle(cb.async_event);
#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 *);
#if defined(HAVE_RB_THREAD_BLOCKING_REGION) || defined(HAVE_RB_THREAD_CALL_WITHOUT_GVL)
static VALUE
async_cb_event(void* unused)
{
struct async_wait w = { 0 };
w.stop = false;
while (!w.stop) {
#if defined(HAVE_RB_THREAD_CALL_WITHOUT_GVL)
rb_thread_call_without_gvl(async_cb_wait, &w, async_cb_stop, &w);
#else
rb_thread_blocking_region(async_cb_wait, &w, async_cb_stop, &w);
#endif
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;
}
#elif defined(_WIN32)
static VALUE
async_cb_event(void* unused)
{
while (true) {
struct gvl_callback* cb;
char buf[64];
fd_set rfds;
FD_ZERO(&rfds);
FD_SET(async_cb_pipe[0], &rfds);
rb_thread_select(async_cb_pipe[0] + 1, &rfds, NULL, NULL, NULL);
read(async_cb_pipe[0], buf, sizeof(buf));
EnterCriticalSection(&async_cb_lock);
cb = async_cb_list;
async_cb_list = NULL;
LeaveCriticalSection(&async_cb_lock);
while (cb != NULL) {
struct gvl_callback* next = cb->next;
/* Start up a new ruby thread to run the ruby callback */
rb_thread_create(async_cb_call, cb);
cb = next;
}
}
return Qnil;
}
#else
static VALUE
async_cb_event(void* unused)
{
while (true) {
struct gvl_callback* cb;
char buf[64];
if (read(async_cb_pipe[0], buf, sizeof(buf)) < 0) {
rb_thread_wait_fd(async_cb_pipe[0]);
while (read(async_cb_pipe[0], buf, sizeof (buf)) < 0) {
if (rb_io_wait_readable(async_cb_pipe[0]) != Qtrue) {
return Qfalse;
}
}
}
pthread_mutex_lock(&async_cb_mutex);
cb = async_cb_list;
async_cb_list = NULL;
pthread_mutex_unlock(&async_cb_mutex);
while (cb != NULL) {
struct gvl_callback* next = cb->next;
/* Start up a new ruby thread to run the ruby callback */
rb_thread_create(async_cb_call, cb);
cb = next;
}
}
return Qnil;
}
#endif
#ifdef _WIN32
static VALUE
async_cb_wait(void *data)
{
struct async_wait* w = (struct async_wait *) data;
w->cb = NULL;
EnterCriticalSection(&async_cb_lock);
while (!w->stop && async_cb_list == NULL) {
LeaveCriticalSection(&async_cb_lock);
WaitForSingleObject(async_cb_cond, INFINITE);
EnterCriticalSection(&async_cb_lock);
}
if (async_cb_list != NULL) {
w->cb = async_cb_list;
async_cb_list = async_cb_list->next;
}
LeaveCriticalSection(&async_cb_lock);
return Qnil;
}
static void
async_cb_stop(void *data)
{
struct async_wait* w = (struct async_wait *) data;
EnterCriticalSection(&async_cb_lock);
w->stop = true;
LeaveCriticalSection(&async_cb_lock);
SetEvent(async_cb_cond);
}
#else
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);
}
#endif
static VALUE
async_cb_call(void *data)
{
struct gvl_callback* cb = (struct gvl_callback *) data;
callback_with_gvl(data);
/* Signal the original native thread that the ruby code has completed */
#ifdef _WIN32
SetEvent(cb->async_event);
#else
pthread_mutex_lock(&cb->async_mutex);
cb->done = true;
pthread_cond_signal(&cb->async_cond);
pthread_mutex_unlock(&cb->async_mutex);
#endif
return Qnil;
}
#endif
static void *
callback_with_gvl(void* data)
{
rb_rescue2(invoke_callback, (VALUE) data, save_callback_exception, (VALUE) data, rb_eException, (VALUE) 0);
return NULL;
}
static VALUE
invoke_callback(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;
Type* paramType = cbInfo->parameterTypes[i];
VALUE rbParamType = rb_ary_entry(cbInfo->rbParameterTypes, i);
if (unlikely(paramType->nativeType == NATIVE_MAPPED)) {
rbParamType = ((MappedType *) paramType)->rbType;
paramType = ((MappedType *) paramType)->type;
}
switch (paramType->nativeType) {
case NATIVE_INT8:
param = INT2NUM(*(int8_t *) parameters[i]);
break;
case NATIVE_UINT8:
param = UINT2NUM(*(uint8_t *) parameters[i]);
break;
case NATIVE_INT16:
param = INT2NUM(*(int16_t *) parameters[i]);
break;
case NATIVE_UINT16:
param = UINT2NUM(*(uint16_t *) parameters[i]);
break;
case NATIVE_INT32:
param = INT2NUM(*(int32_t *) parameters[i]);
break;
case NATIVE_UINT32:
param = UINT2NUM(*(uint32_t *) parameters[i]);
break;
case NATIVE_INT64:
param = LL2NUM(*(int64_t *) parameters[i]);
break;
case NATIVE_UINT64:
param = ULL2NUM(*(uint64_t *) parameters[i]);
break;
case NATIVE_LONG:
param = LONG2NUM(*(long *) parameters[i]);
break;
case NATIVE_ULONG:
param = ULONG2NUM(*(unsigned long *) parameters[i]);
break;
case NATIVE_FLOAT32:
param = rb_float_new(*(float *) parameters[i]);
break;
case NATIVE_FLOAT64:
param = rb_float_new(*(double *) parameters[i]);
break;
case NATIVE_LONGDOUBLE:
param = rbffi_longdouble_new(*(long double *) parameters[i]);
break;
case NATIVE_STRING:
param = (*(void **) parameters[i] != NULL) ? rb_tainted_str_new2(*(char **) parameters[i]) : Qnil;
break;
case NATIVE_POINTER:
param = rbffi_Pointer_NewInstance(*(void **) parameters[i]);
break;
case NATIVE_BOOL:
param = (*(uint8_t *) parameters[i]) ? Qtrue : Qfalse;
break;
case NATIVE_FUNCTION:
case NATIVE_CALLBACK:
case NATIVE_STRUCT:
param = rbffi_NativeValue_ToRuby(paramType, rbParamType, parameters[i]);
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);
RB_GC_GUARD_PTR(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, returnType->ffiType->size);
} else switch (returnType->nativeType) {
case NATIVE_INT8:
case NATIVE_INT16:
case NATIVE_INT32:
*((ffi_sarg *) retval) = NUM2INT(rbReturnValue);
break;
case NATIVE_UINT8:
case NATIVE_UINT16:
case NATIVE_UINT32:
*((ffi_arg *) retval) = NUM2UINT(rbReturnValue);
break;
case NATIVE_INT64:
*((int64_t *) retval) = NUM2LL(rbReturnValue);
break;
case NATIVE_UINT64:
*((uint64_t *) retval) = NUM2ULL(rbReturnValue);
break;
case NATIVE_LONG:
*((ffi_sarg *) retval) = NUM2LONG(rbReturnValue);
break;
case NATIVE_ULONG:
*((ffi_arg *) retval) = NUM2ULONG(rbReturnValue);
break;
case NATIVE_FLOAT32:
*((float *) retval) = (float) NUM2DBL(rbReturnValue);
break;
case NATIVE_FLOAT64:
*((double *) retval) = NUM2DBL(rbReturnValue);
break;
case NATIVE_POINTER:
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 */
*((void **) retval) = NULL;
}
break;
case NATIVE_BOOL:
*((ffi_arg *) retval) = rbReturnValue == Qtrue;
break;
case NATIVE_FUNCTION:
case NATIVE_CALLBACK:
if (TYPE(rbReturnValue) == T_DATA && rb_obj_is_kind_of(rbReturnValue, rbffi_PointerClass)) {
*((void **) retval) = ((AbstractMemory *) DATA_PTR(rbReturnValue))->address;
} else if (rb_obj_is_kind_of(rbReturnValue, rb_cProc) || rb_respond_to(rbReturnValue, id_call)) {
VALUE function;
function = rbffi_Function_ForProc(rbReturnType, rbReturnValue);
*((void **) retval) = ((AbstractMemory *) DATA_PTR(function))->address;
} else {
*((void **) retval) = NULL;
}
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 Qnil;
}
static VALUE
save_callback_exception(void* data, VALUE exc)
{
struct gvl_callback* cb = (struct gvl_callback *) data;
memset(cb->retval, 0, ((Function *) cb->closure->info)->info->returnType->ffiType->size);
if (cb->frame != NULL) cb->frame->exc = exc;
return Qnil;
}
static bool
callback_prep(void* ctx, void* code, Closure* closure, char* errmsg, size_t errmsgsize)
{
FunctionType* fnInfo = (FunctionType *) ctx;
ffi_status ffiStatus;
ffiStatus = ffi_prep_closure(code, &fnInfo->ffi_cif, callback_invoke, closure);
if (ffiStatus != FFI_OK) {
snprintf(errmsg, errmsgsize, "ffi_prep_closure failed. status=%#x", ffiStatus);
return false;
}
return true;
}
void
rbffi_Function_Init(VALUE moduleFFI)
{
rbffi_FunctionInfo_Init(moduleFFI);
/*
* Document-class: FFI::Function < FFI::Pointer
*/
rbffi_FunctionClass = rb_define_class_under(moduleFFI, "Function", rbffi_PointerClass);
rb_global_variable(&rbffi_FunctionClass);
rb_define_alloc_func(rbffi_FunctionClass, function_allocate);
rb_define_method(rbffi_FunctionClass, "initialize", function_initialize, -1);
rb_define_method(rbffi_FunctionClass, "initialize_copy", function_initialize_copy, 1);
rb_define_method(rbffi_FunctionClass, "call", function_call, -1);
rb_define_method(rbffi_FunctionClass, "attach", function_attach, 2);
rb_define_method(rbffi_FunctionClass, "free", function_release, 0);
rb_define_method(rbffi_FunctionClass, "autorelease=", function_set_autorelease, 1);
/*
* call-seq: autorelease
* @return [Boolean]
* Get +autorelease+ attribute.
* Synonymous for {#autorelease?}.
*/
rb_define_method(rbffi_FunctionClass, "autorelease", function_autorelease_p, 0);
/*
* call-seq: autorelease?
* @return [Boolean] +autorelease+ attribute
* Get +autorelease+ attribute.
*/
rb_define_method(rbffi_FunctionClass, "autorelease?", function_autorelease_p, 0);
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");
#if defined(_WIN32)
InitializeCriticalSection(&async_cb_lock);
async_cb_cond = CreateEvent(NULL, FALSE, FALSE, NULL);
#endif
}
|