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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
|
/*
* Optimized Ruby Mutex implementation, loosely based on thread.rb by
* Yukihiro Matsumoto <matz@ruby-lang.org>
*
* Copyright 2006-2007 MenTaLguY <mental@rydia.net>
*
* RDoc taken from original.
*
* This file is made available under the same terms as Ruby.
*/
#include <ruby.h>
#include <intern.h>
#include <rubysig.h>
static VALUE rb_cMutex;
static VALUE rb_cConditionVariable;
static VALUE rb_cQueue;
static VALUE rb_cSizedQueue;
static VALUE set_critical(VALUE value);
static VALUE
thread_exclusive(VALUE (*func)(ANYARGS), VALUE arg)
{
VALUE critical = rb_thread_critical;
rb_thread_critical = 1;
return rb_ensure(func, arg, set_critical, (VALUE)critical);
}
/*
* call-seq:
* Thread.exclusive { block } => obj
*
* Wraps a block in Thread.critical, restoring the original value
* upon exit from the critical section, and returns the value of the
* block.
*/
static VALUE
rb_thread_exclusive(void)
{
return thread_exclusive(rb_yield, Qundef);
}
typedef struct _Entry {
VALUE value;
struct _Entry *next;
} Entry;
typedef struct _List {
Entry *entries;
Entry *last_entry;
Entry *entry_pool;
unsigned long size;
} List;
static void
init_list(List *list)
{
list->entries = NULL;
list->last_entry = NULL;
list->entry_pool = NULL;
list->size = 0;
}
static void
mark_list(List *list)
{
Entry *entry;
for (entry = list->entries; entry; entry = entry->next) {
rb_gc_mark(entry->value);
}
}
static void
free_entries(Entry *first)
{
Entry *next;
while (first) {
next = first->next;
xfree(first);
first = next;
}
}
static void
finalize_list(List *list)
{
free_entries(list->entries);
free_entries(list->entry_pool);
}
static void
push_list(List *list, VALUE value)
{
Entry *entry;
if (list->entry_pool) {
entry = list->entry_pool;
list->entry_pool = entry->next;
} else {
entry = ALLOC(Entry);
}
entry->value = value;
entry->next = NULL;
if (list->last_entry) {
list->last_entry->next = entry;
} else {
list->entries = entry;
}
list->last_entry = entry;
++list->size;
}
static void
push_multiple_list(List *list, VALUE *values, unsigned count)
{
unsigned i;
for (i = 0; i < count; i++) {
push_list(list, values[i]);
}
}
static void
recycle_entries(List *list, Entry *first_entry, Entry *last_entry)
{
#ifdef USE_MEM_POOLS
last_entry->next = list->entry_pool;
list->entry_pool = first_entry;
#else
last_entry->next = NULL;
free_entries(first_entry);
#endif
}
static VALUE
shift_list(List *list)
{
Entry *entry;
VALUE value;
entry = list->entries;
if (!entry) return Qnil;
list->entries = entry->next;
if (entry == list->last_entry) {
list->last_entry = NULL;
}
--list->size;
value = entry->value;
recycle_entries(list, entry, entry);
return value;
}
static void
remove_one(List *list, VALUE value)
{
Entry **ref;
Entry *prev;
Entry *entry;
for (ref = &list->entries, prev = NULL, entry = list->entries;
entry != NULL;
ref = &entry->next, prev = entry, entry = entry->next) {
if (entry->value == value) {
*ref = entry->next;
list->size--;
if (!entry->next) {
list->last_entry = prev;
}
recycle_entries(list, entry, entry);
break;
}
}
}
static void
clear_list(List *list)
{
if (list->last_entry) {
recycle_entries(list, list->entries, list->last_entry);
list->entries = NULL;
list->last_entry = NULL;
list->size = 0;
}
}
static VALUE
array_from_list(List const *list)
{
VALUE ary;
Entry *entry;
ary = rb_ary_new();
for (entry = list->entries; entry; entry = entry->next) {
rb_ary_push(ary, entry->value);
}
return ary;
}
static VALUE
wake_thread(VALUE thread)
{
return rb_thread_wakeup_alive(thread);
}
static VALUE
run_thread(VALUE thread)
{
thread = wake_thread(thread);
if (RTEST(thread) && !rb_thread_critical)
rb_thread_schedule();
return thread;
}
static VALUE
wake_one(List *list)
{
VALUE waking;
waking = Qnil;
while (list->entries && !RTEST(waking)) {
waking = wake_thread(shift_list(list));
}
return waking;
}
static VALUE
wake_all(List *list)
{
while (list->entries) {
wake_one(list);
}
return Qnil;
}
extern int rb_thread_join _((VALUE thread, double limit));
#define DELAY_INFTY 1E30
static VALUE
wait_list_inner(VALUE arg)
{
push_list((List *)arg, rb_thread_current());
rb_thread_stop();
return Qnil;
}
static VALUE
wait_list_cleanup(VALUE arg)
{
/* cleanup in case of spurious wakeups */
remove_one((List *)arg, rb_thread_current());
return Qnil;
}
static VALUE
wait_list(List *list)
{
return rb_ensure(wait_list_inner, (VALUE)list, wait_list_cleanup, (VALUE)list);
}
static void
kill_waiting_threads(List *waiting)
{
Entry *entry;
for (entry = waiting->entries; entry; entry = entry->next) {
rb_thread_kill(entry->value);
}
}
/*
* Document-class: Mutex
*
* Mutex implements a simple semaphore that can be used to coordinate access to
* shared data from multiple concurrent threads.
*
* Example:
*
* require 'thread'
* semaphore = Mutex.new
*
* a = Thread.new {
* semaphore.synchronize {
* # access shared resource
* }
* }
*
* b = Thread.new {
* semaphore.synchronize {
* # access shared resource
* }
* }
*
*/
typedef struct _Mutex {
VALUE owner;
List waiting;
} Mutex;
#define MUTEX_LOCKED_P(mutex) (RTEST((mutex)->owner) && rb_thread_alive_p((mutex)->owner))
static void
mark_mutex(Mutex *mutex)
{
rb_gc_mark(mutex->owner);
mark_list(&mutex->waiting);
}
static void
finalize_mutex(Mutex *mutex)
{
finalize_list(&mutex->waiting);
}
static void
free_mutex(Mutex *mutex)
{
kill_waiting_threads(&mutex->waiting);
finalize_mutex(mutex);
xfree(mutex);
}
static void
init_mutex(Mutex *mutex)
{
mutex->owner = Qnil;
init_list(&mutex->waiting);
}
/*
* Document-method: new
* call-seq: Mutex.new
*
* Creates a new Mutex
*
*/
static VALUE
rb_mutex_alloc(VALUE klass)
{
Mutex *mutex;
mutex = ALLOC(Mutex);
init_mutex(mutex);
return Data_Wrap_Struct(klass, mark_mutex, free_mutex, mutex);
}
/*
* Document-method: locked?
* call-seq: locked?
*
* Returns +true+ if this lock is currently held by some thread.
*
*/
static VALUE
rb_mutex_locked_p(VALUE self)
{
Mutex *mutex;
Data_Get_Struct(self, Mutex, mutex);
return MUTEX_LOCKED_P(mutex) ? Qtrue : Qfalse;
}
/*
* Document-method: try_lock
* call-seq: try_lock
*
* Attempts to obtain the lock and returns immediately. Returns +true+ if the
* lock was granted.
*
*/
static VALUE
rb_mutex_try_lock(VALUE self)
{
Mutex *mutex;
Data_Get_Struct(self, Mutex, mutex);
if (MUTEX_LOCKED_P(mutex))
return Qfalse;
mutex->owner = rb_thread_current();
return Qtrue;
}
static VALUE
wait_mutex(VALUE arg)
{
Mutex *mutex = (Mutex *)arg;
VALUE current = rb_thread_current();
push_list(&mutex->waiting, current);
do {
rb_thread_critical = 0;
rb_thread_join(mutex->owner, DELAY_INFTY);
rb_thread_critical = 1;
if (!MUTEX_LOCKED_P(mutex)) {
mutex->owner = current;
break;
}
} while (mutex->owner != current);
return Qnil;
}
/*
* Document-method: lock
* call-seq: lock
*
* Attempts to grab the lock and waits if it isn't available.
*
*/
static VALUE
lock_mutex(Mutex *mutex)
{
VALUE current;
current = rb_thread_current();
rb_thread_critical = 1;
if (!MUTEX_LOCKED_P(mutex)) {
mutex->owner = current;
}
else {
rb_ensure(wait_mutex, (VALUE)mutex, wait_list_cleanup, (VALUE)&mutex->waiting);
}
rb_thread_critical = 0;
return Qnil;
}
static VALUE
lock_mutex_call(VALUE mutex)
{
return lock_mutex((Mutex *)mutex);
}
static VALUE
rb_mutex_lock(VALUE self)
{
Mutex *mutex;
Data_Get_Struct(self, Mutex, mutex);
lock_mutex(mutex);
return self;
}
/*
* Document-method: unlock
*
* Releases the lock. Returns +nil+ if ref wasn't locked.
*
*/
static VALUE
unlock_mutex_inner(Mutex *mutex)
{
VALUE waking;
if (mutex->owner != rb_thread_current()) {
rb_raise(rb_eThreadError, "not owner");
}
waking = wake_one(&mutex->waiting);
mutex->owner = waking;
return waking;
}
static VALUE
set_critical(VALUE value)
{
rb_thread_critical = (int)value;
return Qundef;
}
static VALUE
unlock_mutex(Mutex *mutex)
{
VALUE waking = thread_exclusive(unlock_mutex_inner, (VALUE)mutex);
if (!RTEST(waking)) {
return Qfalse;
}
run_thread(waking);
return Qtrue;
}
static VALUE
unlock_mutex_call(VALUE mutex)
{
return unlock_mutex((Mutex *)mutex);
}
static VALUE
rb_mutex_unlock(VALUE self)
{
Mutex *mutex;
Data_Get_Struct(self, Mutex, mutex);
if (RTEST(unlock_mutex(mutex))) {
return self;
} else {
return Qnil;
}
}
/*
* Document-method: exclusive_unlock
* call-seq: exclusive_unlock { ... }
*
* If the mutex is locked, unlocks the mutex, wakes one waiting thread, and
* yields in a critical section.
*
*/
static VALUE
rb_mutex_exclusive_unlock_inner(Mutex *mutex)
{
VALUE waking;
waking = unlock_mutex_inner(mutex);
rb_yield(Qundef);
return waking;
}
static VALUE
rb_mutex_exclusive_unlock(VALUE self)
{
Mutex *mutex;
VALUE waking;
Data_Get_Struct(self, Mutex, mutex);
waking = thread_exclusive(rb_mutex_exclusive_unlock_inner, (VALUE)mutex);
if (!RTEST(waking)) {
return Qnil;
}
run_thread(waking);
return self;
}
/*
* Document-method: synchronize
* call-seq: synchronize { ... }
*
* Obtains a lock, runs the block, and releases the lock when the block
* completes. See the example under Mutex.
*
*/
static VALUE
rb_mutex_synchronize(VALUE self)
{
rb_mutex_lock(self);
return rb_ensure(rb_yield, Qundef, rb_mutex_unlock, self);
}
/*
* Document-class: ConditionVariable
*
* ConditionVariable objects augment class Mutex. Using condition variables,
* it is possible to suspend while in the middle of a critical section until a
* resource becomes available.
*
* Example:
*
* require 'thread'
*
* mutex = Mutex.new
* resource = ConditionVariable.new
*
* a = Thread.new {
* mutex.synchronize {
* # Thread 'a' now needs the resource
* resource.wait(mutex)
* # 'a' can now have the resource
* }
* }
*
* b = Thread.new {
* mutex.synchronize {
* # Thread 'b' has finished using the resource
* resource.signal
* }
* }
*
*/
typedef struct _ConditionVariable {
List waiting;
} ConditionVariable;
static void
mark_condvar(ConditionVariable *condvar)
{
mark_list(&condvar->waiting);
}
static void
finalize_condvar(ConditionVariable *condvar)
{
finalize_list(&condvar->waiting);
}
static void
free_condvar(ConditionVariable *condvar)
{
kill_waiting_threads(&condvar->waiting);
finalize_condvar(condvar);
xfree(condvar);
}
static void
init_condvar(ConditionVariable *condvar)
{
init_list(&condvar->waiting);
}
/*
* Document-method: new
* call-seq: ConditionVariable.new
*
* Creates a new ConditionVariable
*
*/
static VALUE
rb_condvar_alloc(VALUE klass)
{
ConditionVariable *condvar;
condvar = ALLOC(ConditionVariable);
init_condvar(condvar);
return Data_Wrap_Struct(klass, mark_condvar, free_condvar, condvar);
}
/*
* Document-method: wait
* call-seq: wait
*
* Releases the lock held in +mutex+ and waits; reacquires the lock on wakeup.
*
*/
static void condvar_wakeup(Mutex *mutex);
static void
wait_condvar(ConditionVariable *condvar, Mutex *mutex)
{
condvar_wakeup(mutex);
rb_ensure(wait_list, (VALUE)&condvar->waiting, lock_mutex_call, (VALUE)mutex);
}
static void
condvar_wakeup(Mutex *mutex)
{
VALUE waking;
rb_thread_critical = 1;
if (rb_thread_current() != mutex->owner) {
rb_thread_critical = 0;
rb_raise(rb_eThreadError, "not owner of the synchronization mutex");
}
waking = unlock_mutex_inner(mutex);
if (RTEST(waking)) {
wake_thread(waking);
}
}
static VALUE
legacy_exclusive_unlock(VALUE mutex)
{
return rb_funcall(mutex, rb_intern("exclusive_unlock"), 0);
}
typedef struct {
ConditionVariable *condvar;
VALUE mutex;
} legacy_wait_args;
static VALUE
legacy_wait(VALUE unused, legacy_wait_args *args)
{
wait_list(&args->condvar->waiting);
rb_funcall(args->mutex, rb_intern("lock"), 0);
return Qnil;
}
static VALUE
rb_condvar_wait(VALUE self, VALUE mutex_v)
{
ConditionVariable *condvar;
Data_Get_Struct(self, ConditionVariable, condvar);
if (CLASS_OF(mutex_v) != rb_cMutex) {
/* interoperate with legacy mutex */
legacy_wait_args args;
args.condvar = condvar;
args.mutex = mutex_v;
rb_iterate(legacy_exclusive_unlock, mutex_v, legacy_wait, (VALUE)&args);
} else {
Mutex *mutex;
Data_Get_Struct(mutex_v, Mutex, mutex);
wait_condvar(condvar, mutex);
}
return self;
}
/*
* Document-method: broadcast
* call-seq: broadcast
*
* Wakes up all threads waiting for this condition.
*
*/
static VALUE
rb_condvar_broadcast(VALUE self)
{
ConditionVariable *condvar;
Data_Get_Struct(self, ConditionVariable, condvar);
thread_exclusive(wake_all, (VALUE)&condvar->waiting);
rb_thread_schedule();
return self;
}
/*
* Document-method: signal
* call-seq: signal
*
* Wakes up the first thread in line waiting for this condition.
*
*/
static void
signal_condvar(ConditionVariable *condvar)
{
VALUE waking = thread_exclusive(wake_one, (VALUE)&condvar->waiting);
if (RTEST(waking)) {
run_thread(waking);
}
}
static VALUE
signal_condvar_call(VALUE condvar)
{
signal_condvar((ConditionVariable *)condvar);
return Qundef;
}
static VALUE
rb_condvar_signal(VALUE self)
{
ConditionVariable *condvar;
Data_Get_Struct(self, ConditionVariable, condvar);
signal_condvar(condvar);
return self;
}
/*
* Document-class: Queue
*
* This class provides a way to synchronize communication between threads.
*
* Example:
*
* require 'thread'
*
* queue = Queue.new
*
* producer = Thread.new do
* 5.times do |i|
* sleep rand(i) # simulate expense
* queue << i
* puts "#{i} produced"
* end
* end
*
* consumer = Thread.new do
* 5.times do |i|
* value = queue.pop
* sleep rand(i/2) # simulate expense
* puts "consumed #{value}"
* end
* end
*
* consumer.join
*
*/
typedef struct _Queue {
Mutex mutex;
ConditionVariable value_available;
ConditionVariable space_available;
List values;
unsigned long capacity;
} Queue;
static void
mark_queue(Queue *queue)
{
mark_mutex(&queue->mutex);
mark_condvar(&queue->value_available);
mark_condvar(&queue->space_available);
mark_list(&queue->values);
}
static void
finalize_queue(Queue *queue)
{
finalize_mutex(&queue->mutex);
finalize_condvar(&queue->value_available);
finalize_condvar(&queue->space_available);
finalize_list(&queue->values);
}
static void
free_queue(Queue *queue)
{
kill_waiting_threads(&queue->mutex.waiting);
kill_waiting_threads(&queue->space_available.waiting);
kill_waiting_threads(&queue->value_available.waiting);
finalize_queue(queue);
xfree(queue);
}
static void
init_queue(Queue *queue)
{
init_mutex(&queue->mutex);
init_condvar(&queue->value_available);
init_condvar(&queue->space_available);
init_list(&queue->values);
queue->capacity = 0;
}
/*
* Document-method: new
* call-seq: new
*
* Creates a new queue.
*
*/
static VALUE
rb_queue_alloc(VALUE klass)
{
Queue *queue;
queue = ALLOC(Queue);
init_queue(queue);
return Data_Wrap_Struct(klass, mark_queue, free_queue, queue);
}
static VALUE
rb_queue_marshal_load(VALUE self, VALUE data)
{
Queue *queue;
VALUE array;
Data_Get_Struct(self, Queue, queue);
array = rb_marshal_load(data);
if (TYPE(array) != T_ARRAY) {
rb_raise(rb_eTypeError, "expected Array of queue data");
}
if (RARRAY(array)->len < 1) {
rb_raise(rb_eArgError, "missing capacity value");
}
queue->capacity = NUM2ULONG(rb_ary_shift(array));
push_multiple_list(&queue->values, RARRAY(array)->ptr, (unsigned)RARRAY(array)->len);
return self;
}
static VALUE
rb_queue_marshal_dump(VALUE self)
{
Queue *queue;
VALUE array;
Data_Get_Struct(self, Queue, queue);
array = array_from_list(&queue->values);
rb_ary_unshift(array, ULONG2NUM(queue->capacity));
return rb_marshal_dump(array, Qnil);
}
/*
* Document-method: clear
* call-seq: clear
*
* Removes all objects from the queue.
*
*/
static VALUE
rb_queue_clear(VALUE self)
{
Queue *queue;
Data_Get_Struct(self, Queue, queue);
lock_mutex(&queue->mutex);
clear_list(&queue->values);
signal_condvar(&queue->space_available);
unlock_mutex(&queue->mutex);
return self;
}
/*
* Document-method: empty?
* call-seq: empty?
*
* Returns +true+ if the queue is empty.
*
*/
static VALUE
rb_queue_empty_p(VALUE self)
{
Queue *queue;
VALUE result;
Data_Get_Struct(self, Queue, queue);
lock_mutex(&queue->mutex);
result = queue->values.size == 0 ? Qtrue : Qfalse;
unlock_mutex(&queue->mutex);
return result;
}
/*
* Document-method: length
* call-seq: length
*
* Returns the length of the queue.
*
*/
static VALUE
rb_queue_length(VALUE self)
{
Queue *queue;
VALUE result;
Data_Get_Struct(self, Queue, queue);
lock_mutex(&queue->mutex);
result = ULONG2NUM(queue->values.size);
unlock_mutex(&queue->mutex);
return result;
}
/*
* Document-method: num_waiting
* call-seq: num_waiting
*
* Returns the number of threads waiting on the queue.
*
*/
static VALUE
rb_queue_num_waiting(VALUE self)
{
Queue *queue;
VALUE result;
Data_Get_Struct(self, Queue, queue);
lock_mutex(&queue->mutex);
result = ULONG2NUM(queue->value_available.waiting.size +
queue->space_available.waiting.size);
unlock_mutex(&queue->mutex);
return result;
}
static void
wait_queue(ConditionVariable *condvar, Mutex *mutex)
{
condvar_wakeup(mutex);
wait_list(&condvar->waiting);
lock_mutex(mutex);
}
static VALUE queue_pop_inner(VALUE arg);
/*
* Document-method: pop
* call_seq: pop(non_block=false)
*
* Retrieves data from the queue. If the queue is empty, the calling thread is
* suspended until data is pushed onto the queue. If +non_block+ is true, the
* thread isn't suspended, and an exception is raised.
*
*/
static VALUE
rb_queue_pop(int argc, VALUE *argv, VALUE self)
{
Queue *queue;
int should_block;
Data_Get_Struct(self, Queue, queue);
if (argc == 0) {
should_block = 1;
} else if (argc == 1) {
should_block = !RTEST(argv[0]);
} else {
rb_raise(rb_eArgError, "wrong number of arguments (%d for 1)", argc);
}
lock_mutex(&queue->mutex);
if (!queue->values.entries && !should_block) {
unlock_mutex(&queue->mutex);
rb_raise(rb_eThreadError, "queue empty");
}
while (!queue->values.entries) {
wait_queue(&queue->value_available, &queue->mutex);
}
return rb_ensure(queue_pop_inner, (VALUE)queue,
unlock_mutex_call, (VALUE)&queue->mutex);
}
static VALUE
queue_pop_inner(VALUE arg)
{
Queue *queue = (Queue *)arg;
VALUE result = shift_list(&queue->values);
if (queue->capacity && queue->values.size < queue->capacity) {
signal_condvar(&queue->space_available);
}
return result;
}
/*
* Document-method: push
* call-seq: push(obj)
*
* Pushes +obj+ to the queue.
*
*/
static VALUE
rb_queue_push(VALUE self, VALUE value)
{
Queue *queue;
Data_Get_Struct(self, Queue, queue);
lock_mutex(&queue->mutex);
while (queue->capacity && queue->values.size >= queue->capacity) {
wait_queue(&queue->space_available, &queue->mutex);
}
push_list(&queue->values, value);
rb_ensure(signal_condvar_call, (VALUE)&queue->value_available,
unlock_mutex_call, (VALUE)&queue->mutex);
return self;
}
/*
* Document-class: SizedQueue
*
* This class represents queues of specified size capacity. The push operation
* may be blocked if the capacity is full.
*
* See Queue for an example of how a SizedQueue works.
*
*/
/*
* Document-method: new
* call-seq: new
*
* Creates a fixed-length queue with a maximum size of +max+.
*
*/
/*
* Document-method: max
* call-seq: max
*
* Returns the maximum size of the queue.
*
*/
static VALUE
rb_sized_queue_max(VALUE self)
{
Queue *queue;
VALUE result;
Data_Get_Struct(self, Queue, queue);
lock_mutex(&queue->mutex);
result = ULONG2NUM(queue->capacity);
unlock_mutex(&queue->mutex);
return result;
}
/*
* Document-method: max=
* call-seq: max=(size)
*
* Sets the maximum size of the queue.
*
*/
static VALUE
rb_sized_queue_max_set(VALUE self, VALUE value)
{
Queue *queue;
unsigned long new_capacity;
unsigned long difference;
Data_Get_Struct(self, Queue, queue);
new_capacity = NUM2ULONG(value);
if (new_capacity < 1) {
rb_raise(rb_eArgError, "value must be positive");
}
lock_mutex(&queue->mutex);
if (queue->capacity && new_capacity > queue->capacity) {
difference = new_capacity - queue->capacity;
} else {
difference = 0;
}
queue->capacity = new_capacity;
for (; difference > 0; --difference) {
signal_condvar(&queue->space_available);
}
unlock_mutex(&queue->mutex);
return self;
}
/*
* Document-method: push
* call-seq: push(obj)
*
* Pushes +obj+ to the queue. If there is no space left in the queue, waits
* until space becomes available.
*
*/
/*
* Document-method: pop
* call-seq: pop(non_block=false)
*
* Retrieves data from the queue and runs a waiting thread, if any.
*
*/
/* for marshalling mutexes and condvars */
static VALUE
dummy_load(VALUE self, VALUE string)
{
return Qnil;
}
static VALUE
dummy_dump(VALUE self)
{
return rb_str_new2("");
}
void
Init_thread(void)
{
rb_define_singleton_method(rb_cThread, "exclusive", rb_thread_exclusive, 0);
rb_cMutex = rb_define_class("Mutex", rb_cObject);
rb_define_alloc_func(rb_cMutex, rb_mutex_alloc);
rb_define_method(rb_cMutex, "marshal_load", dummy_load, 1);
rb_define_method(rb_cMutex, "marshal_dump", dummy_dump, 0);
rb_define_method(rb_cMutex, "locked?", rb_mutex_locked_p, 0);
rb_define_method(rb_cMutex, "try_lock", rb_mutex_try_lock, 0);
rb_define_method(rb_cMutex, "lock", rb_mutex_lock, 0);
rb_define_method(rb_cMutex, "unlock", rb_mutex_unlock, 0);
rb_define_method(rb_cMutex, "exclusive_unlock", rb_mutex_exclusive_unlock, 0);
rb_define_method(rb_cMutex, "synchronize", rb_mutex_synchronize, 0);
rb_cConditionVariable = rb_define_class("ConditionVariable", rb_cObject);
rb_define_alloc_func(rb_cConditionVariable, rb_condvar_alloc);
rb_define_method(rb_cConditionVariable, "marshal_load", dummy_load, 1);
rb_define_method(rb_cConditionVariable, "marshal_dump", dummy_dump, 0);
rb_define_method(rb_cConditionVariable, "wait", rb_condvar_wait, 1);
rb_define_method(rb_cConditionVariable, "broadcast", rb_condvar_broadcast, 0);
rb_define_method(rb_cConditionVariable, "signal", rb_condvar_signal, 0);
rb_cQueue = rb_define_class("Queue", rb_cObject);
rb_define_alloc_func(rb_cQueue, rb_queue_alloc);
rb_define_method(rb_cQueue, "marshal_load", rb_queue_marshal_load, 1);
rb_define_method(rb_cQueue, "marshal_dump", rb_queue_marshal_dump, 0);
rb_define_method(rb_cQueue, "clear", rb_queue_clear, 0);
rb_define_method(rb_cQueue, "empty?", rb_queue_empty_p, 0);
rb_define_method(rb_cQueue, "length", rb_queue_length, 0);
rb_define_method(rb_cQueue, "num_waiting", rb_queue_num_waiting, 0);
rb_define_method(rb_cQueue, "pop", rb_queue_pop, -1);
rb_define_method(rb_cQueue, "push", rb_queue_push, 1);
rb_alias(rb_cQueue, rb_intern("enq"), rb_intern("push"));
rb_alias(rb_cQueue, rb_intern("<<"), rb_intern("push"));
rb_alias(rb_cQueue, rb_intern("deq"), rb_intern("pop"));
rb_alias(rb_cQueue, rb_intern("shift"), rb_intern("pop"));
rb_alias(rb_cQueue, rb_intern("size"), rb_intern("length"));
rb_cSizedQueue = rb_define_class("SizedQueue", rb_cQueue);
rb_define_method(rb_cSizedQueue, "initialize", rb_sized_queue_max_set, 1);
rb_define_method(rb_cSizedQueue, "num_waiting", rb_queue_num_waiting, 0);
rb_define_method(rb_cSizedQueue, "pop", rb_queue_pop, -1);
rb_define_method(rb_cSizedQueue, "push", rb_queue_push, 1);
rb_define_method(rb_cSizedQueue, "max", rb_sized_queue_max, 0);
rb_define_method(rb_cSizedQueue, "max=", rb_sized_queue_max_set, 1);
rb_alias(rb_cSizedQueue, rb_intern("enq"), rb_intern("push"));
rb_alias(rb_cSizedQueue, rb_intern("<<"), rb_intern("push"));
rb_alias(rb_cSizedQueue, rb_intern("deq"), rb_intern("pop"));
rb_alias(rb_cSizedQueue, rb_intern("shift"), rb_intern("pop"));
}
|