src/threads/threads-common.c

   1 /* src/threads/threads-common.c - machine independent thread functions
   2
   3    Copyright (C) 2007 R. Grafl, A. Krall, C. Kruegel,
   4    C. Oates, R. Obermaisser, M. Platter, M. Probst, S. Ring,
   5    E. Steiner, C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich,
   6    J. Wenninger, Institut f. Computersprachen - TU Wien
   7
   8    This file is part of CACAO.
   9
  10    This program is free software; you can redistribute it and/or
  11    modify it under the terms of the GNU General Public License as
  12    published by the Free Software Foundation; either version 2, or (at
  13    your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful, but
  16    WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18    General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program; if not, write to the Free Software
  22    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  23    02110-1301, USA.
  24
  25    $Id: threads-common.c 8266 2007-08-07 08:26:38Z twisti $
  26
  27 */
  28
  29
  30 #include "config.h"
  31
  32 #include <assert.h>
  33 #include <unistd.h>
  34
  35 #include "vm/types.h"
  36
  37 #include "mm/memory.h"
  38
  39 #include "native/jni.h"
  40
  41 #include "native/include/java_lang_Object.h"
  42 #include "native/include/java_lang_String.h"
  43 #include "native/include/java_lang_Thread.h"
  44
  45 #if defined(WITH_CLASSPATH_GNU)
  46 # include "native/include/java_lang_VMThread.h"
  47 #endif
  48
  49 #include "threads/critical.h"
  50 #include "threads/lock-common.h"
  51 #include "threads/threads-common.h"
  52
  53 #include "toolbox/list.h"
  54
  55 #include "vm/builtin.h"
  56 #include "vm/stringlocal.h"
  57 #include "vm/vm.h"
  58
  59 #include "vm/jit/stacktrace.h"
  60
  61 #include "vmcore/class.h"
  62
  63 #if defined(ENABLE_STATISTICS)
  64 # include "vmcore/options.h"
  65 # include "vmcore/statistics.h"
  66 #endif
  67
  68 #include "vmcore/utf8.h"
  69
  70
  71 /* global variables ***********************************************************/
  72
  73 /* global threads list */
  74 static list_t *list_threads;
  75
  76 /* global threads free-list */
  77 static list_t *list_threads_free;
  78
  79 #if defined(__LINUX__)
  80 /* XXX Remove for exact-GC. */
  81 bool threads_pthreads_implementation_nptl;
  82 #endif
  83
  84
  85 /* threads_preinit *************************************************************
  86
  87    Do some early initialization of stuff required.
  88
  89    ATTENTION: Do NOT use any Java heap allocation here, as gc_init()
  90    is called AFTER this function!
  91
  92 *******************************************************************************/
  93
  94 void threads_preinit(void)
  95 {
  96         threadobject *mainthread;
  97 #if defined(__LINUX__) && defined(_CS_GNU_LIBPTHREAD_VERSION)
  98         char         *pathbuf;
  99         size_t        len;
 100 #endif
 101
 102 #if defined(__LINUX__)
 103         /* XXX Remove for exact-GC. */
 104
 105         /* On Linux we need to check the pthread implementation. */
 106
 107         /* _CS_GNU_LIBPTHREAD_VERSION (GNU C library only; since glibc 2.3.2) */
 108         /* If the glibc is a pre-2.3.2 version, we fall back to
 109            linuxthreads. */
 110
 111 # if defined(_CS_GNU_LIBPTHREAD_VERSION)
 112         len = confstr(_CS_GNU_LIBPTHREAD_VERSION, NULL, (size_t) 0);
 113
 114         /* Some systems return as length 0 (maybe cross-compilation
 115            related).  In this case we also fall back to linuxthreads. */
 116
 117         if (len > 0) {
 118                 pathbuf = MNEW(char, len);
 119
 120                 (void) confstr(_CS_GNU_LIBPTHREAD_VERSION, pathbuf, len);
 121
 122                 if (strstr(pathbuf, "NPTL") != NULL)
 123                         threads_pthreads_implementation_nptl = true;
 124                 else
 125                         threads_pthreads_implementation_nptl = false;
 126         }
 127         else
 128                 threads_pthreads_implementation_nptl = false;
 129 # else
 130         threads_pthreads_implementation_nptl = false;
 131 # endif
 132 #endif
 133
 134         /* initialize the threads lists */
 135
 136         list_threads      = list_create(OFFSET(threadobject, linkage));
 137         list_threads_free = list_create(OFFSET(threadobject, linkage));
 138
 139         /* Initialize the threads implementation (sets the thinlock on the
 140            main thread). */
 141
 142         threads_impl_preinit();
 143
 144         /* create internal thread data-structure for the main thread */
 145
 146         mainthread = threads_thread_new();
 147
 148         /* thread is a Java thread and running */
 149
 150         mainthread->flags = THREAD_FLAG_JAVA;
 151         mainthread->state = THREAD_STATE_RUNNABLE;
 152
 153         /* store the internal thread data-structure in the TSD */
 154
 155         threads_set_current_threadobject(mainthread);
 156
 157         /* initialize locking subsystems */
 158
 159         lock_init();
 160
 161         /* initialize the critical section */
 162
 163         critical_init();
 164 }
 165
 166
 167 /* threads_list_first **********************************************************
 168
 169    Return the first entry in the threads list.
 170
 171    NOTE: This function does not lock the lists.
 172
 173 *******************************************************************************/
 174
 175 threadobject *threads_list_first(void)
 176 {
 177         threadobject *t;
 178
 179         t = list_first_unsynced(list_threads);
 180
 181         return t;
 182 }
 183
 184
 185 /* threads_list_next ***********************************************************
 186
 187    Return the next entry in the threads list.
 188
 189    NOTE: This function does not lock the lists.
 190
 191 *******************************************************************************/
 192
 193 threadobject *threads_list_next(threadobject *t)
 194 {
 195         threadobject *next;
 196
 197         next = list_next_unsynced(list_threads, t);
 198
 199         return next;
 200 }
 201
 202
 203 /* threads_list_get_non_daemons ************************************************
 204
 205    Return the number of non-daemon threads.
 206
 207    NOTE: This function does a linear-search over the threads list,
 208          because it's only used for joining the threads.
 209
 210 *******************************************************************************/
 211
 212 s4 threads_list_get_non_daemons(void)
 213 {
 214         threadobject *t;
 215         s4            nondaemons;
 216
 217         /* lock the threads lists */
 218
 219         threads_list_lock();
 220
 221         nondaemons = 0;
 222
 223         for (t = threads_list_first(); t != NULL; t = threads_list_next(t)) {
 224                 if (!(t->flags & THREAD_FLAG_DAEMON))
 225                         nondaemons++;
 226         }
 227
 228         /* unlock the threads lists */
 229
 230         threads_list_unlock();
 231
 232         return nondaemons;
 233 }
 234
 235
 236 /* threads_thread_new **********************************************************
 237
 238    Allocates and initializes an internal thread data-structure and
 239    adds it to the threads list.
 240
 241 *******************************************************************************/
 242
 243 threadobject *threads_thread_new(void)
 244 {
 245         threadobject *t;
 246
 247         /* lock the threads-lists */
 248
 249         threads_list_lock();
 250
 251         /* try to get a thread from the free-list */
 252
 253         t = list_first_unsynced(list_threads_free);
 254
 255         /* is a free thread available? */
 256
 257         if (t != NULL) {
 258                 /* yes, remove it from the free list */
 259
 260                 list_remove_unsynced(list_threads_free, t);
 261         }
 262         else {
 263                 /* no, allocate a new one */
 264
 265 #if defined(ENABLE_GC_BOEHM)
 266                 t = GCNEW_UNCOLLECTABLE(threadobject, 1);
 267 #else
 268                 t = NEW(threadobject);
 269 #endif
 270
 271 #if defined(ENABLE_STATISTICS)
 272                 if (opt_stat)
 273                         size_threadobject += sizeof(threadobject);
 274 #endif
 275
 276                 /* clear memory */
 277
 278                 MZERO(t, threadobject, 1);
 279
 280                 /* set the threads-index */
 281
 282                 t->index = list_threads->size + 1;
 283         }
 284
 285         /* pre-compute the thinlock-word */
 286
 287         assert(t->index != 0);
 288
 289         t->thinlock = lock_pre_compute_thinlock(t->index);
 290         t->state    = THREAD_STATE_NEW;
 291
 292         /* initialize the implementation-specific bits */
 293
 294         threads_impl_thread_new(t);
 295
 296         /* add the thread to the threads-list */
 297
 298         list_add_last_unsynced(list_threads, t);
 299
 300         /* unlock the threads-lists */
 301
 302         threads_list_unlock();
 303
 304         return t;
 305 }
 306
 307
 308 /* threads_thread_free *********************************************************
 309
 310    Frees an internal thread data-structure by removing it from the
 311    threads-list and adding it to the free-list.
 312
 313    NOTE: The data-structure is NOT freed, the pointer keeps valid!
 314
 315 *******************************************************************************/
 316
 317 void threads_thread_free(threadobject *t)
 318 {
 319         s4 index;
 320
 321         /* lock the threads-lists */
 322
 323         threads_list_lock();
 324
 325         /* cleanup the implementation-specific bits */
 326
 327         threads_impl_thread_free(t);
 328
 329         /* remove the thread from the threads-list */
 330
 331         list_remove_unsynced(list_threads, t);
 332
 333         /* Clear memory, but keep the thread-index. */
 334         /* ATTENTION: Do this after list_remove, otherwise the linkage
 335            pointers are invalid. */
 336
 337         index = t->index;
 338
 339         MZERO(t, threadobject, 1);
 340
 341         t->index = index;
 342
 343         /* add the thread to the free list */
 344
 345         list_add_first_unsynced(list_threads_free, t);
 346
 347         /* unlock the threads-lists */
 348
 349         threads_list_unlock();
 350 }
 351
 352
 353 /* threads_thread_start_internal ***********************************************
 354
 355    Start an internal thread in the JVM.  No Java thread objects exists
 356    so far.
 357
 358    IN:
 359       name.......UTF-8 name of the thread
 360       f..........function pointer to C function to start
 361
 362 *******************************************************************************/
 363
 364 bool threads_thread_start_internal(utf *name, functionptr f)
 365 {
 366         threadobject       *t;
 367         java_lang_Thread   *object;
 368 #if defined(WITH_CLASSPATH_GNU)
 369         java_lang_VMThread *vmt;
 370 #endif
 371
 372         /* Enter the join-mutex, so if the main-thread is currently
 373            waiting to join all threads, the number of non-daemon threads
 374            is correct. */
 375
 376         threads_mutex_join_lock();
 377
 378         /* create internal thread data-structure */
 379
 380         t = threads_thread_new();
 381
 382         t->flags = THREAD_FLAG_INTERNAL | THREAD_FLAG_DAEMON;
 383
 384         /* The thread is flagged as (non-)daemon thread, we can leave the
 385            mutex. */
 386
 387         threads_mutex_join_unlock();
 388
 389         /* create the java thread object */
 390
 391         object = (java_lang_Thread *) builtin_new(class_java_lang_Thread);
 392
 393         /* XXX memory leak!!! */
 394         if (object == NULL)
 395                 return false;
 396
 397 #if defined(WITH_CLASSPATH_GNU)
 398         vmt = (java_lang_VMThread *) builtin_new(class_java_lang_VMThread);
 399
 400         /* XXX memory leak!!! */
 401         if (vmt == NULL)
 402                 return false;
 403
 404         vmt->thread = object;
 405         vmt->vmdata = (java_lang_Object *) t;
 406
 407         object->vmThread = vmt;
 408 #elif defined(WITH_CLASSPATH_CLDC1_1)
 409         object->vm_thread = (java_lang_Object *) t;
 410 #endif
 411
 412         t->object = object;
 413
 414         /* set java.lang.Thread fields */
 415
 416 #if defined(WITH_CLASSPATH_GNU)
 417         object->name     = (java_lang_String *) javastring_new(name);
 418 #elif defined(WITH_CLASSPATH_CLDC1_1)
 419         /* FIXME: In cldc the name is a char[] */
 420 /*      object->name     = (java_chararray *) javastring_new(name); */
 421         object->name     = NULL;
 422 #endif
 423
 424 #if defined(ENABLE_JAVASE)
 425         object->daemon   = true;
 426 #endif
 427
 428         object->priority = NORM_PRIORITY;
 429
 430         /* start the thread */
 431
 432         threads_impl_thread_start(t, f);
 433
 434         /* everything's ok */
 435
 436         return true;
 437 }
 438
 439
 440 /* threads_thread_start ********************************************************
 441
 442    Start a Java thread in the JVM.  Only the java thread object exists
 443    so far.
 444
 445    IN:
 446       object.....the java thread object java.lang.Thread
 447
 448 *******************************************************************************/
 449
 450 void threads_thread_start(java_lang_Thread *object)
 451 {
 452         threadobject *thread;
 453
 454         /* Enter the join-mutex, so if the main-thread is currently
 455            waiting to join all threads, the number of non-daemon threads
 456            is correct. */
 457
 458         threads_mutex_join_lock();
 459
 460         /* create internal thread data-structure */
 461
 462         thread = threads_thread_new();
 463
 464         /* this is a normal Java thread */
 465
 466         thread->flags = THREAD_FLAG_JAVA;
 467
 468 #if defined(ENABLE_JAVASE)
 469         /* is this a daemon thread? */
 470
 471         if (object->daemon == true)
 472                 thread->flags |= THREAD_FLAG_DAEMON;
 473 #endif
 474
 475         /* The thread is flagged and (non-)daemon thread, we can leave the
 476            mutex. */
 477
 478         threads_mutex_join_unlock();
 479
 480         /* link the two objects together */
 481
 482         thread->object = object;
 483
 484 #if defined(WITH_CLASSPATH_GNU)
 485         assert(object->vmThread);
 486         assert(object->vmThread->vmdata == NULL);
 487
 488         object->vmThread->vmdata = (java_lang_Object *) thread;
 489 #elif defined(WITH_CLASSPATH_CLDC1_1)
 490         object->vm_thread = (java_lang_Object *) thread;
 491 #endif
 492
 493         /* Start the thread.  Don't pass a function pointer (NULL) since
 494            we want Thread.run()V here. */
 495
 496         threads_impl_thread_start(thread, NULL);
 497 }
 498
 499
 500 /* threads_thread_print_info ***************************************************
 501
 502    Print information of the passed thread.
 503
 504 *******************************************************************************/
 505
 506 void threads_thread_print_info(threadobject *t)
 507 {
 508         java_lang_Thread *object;
 509         utf              *name;
 510
 511         assert(t->state != THREAD_STATE_NEW);
 512
 513         /* the thread may be currently in initalization, don't print it */
 514
 515         object = t->object;
 516
 517         if (object != NULL) {
 518                 /* get thread name */
 519
 520 #if defined(WITH_CLASSPATH_GNU)
 521                 name = javastring_toutf((java_objectheader *) object->name, false);
 522 #elif defined(WITH_CLASSPATH_SUN) || defined(WITH_CLASSPATH_CLDC1_1)
 523                 /* FIXME: In cldc the name is a char[] */
 524 /*              name = object->name; */
 525                 name = utf_null;
 526 #else
 527 # error unknown classpath configuration
 528 #endif
 529
 530                 printf("\"");
 531                 utf_display_printable_ascii(name);
 532                 printf("\"");
 533
 534                 if (t->flags & THREAD_FLAG_DAEMON)
 535                         printf(" daemon");
 536
 537                 printf(" prio=%d", object->priority);
 538
 539 #if SIZEOF_VOID_P == 8
 540                 printf(" t=0x%016lx tid=0x%016lx (%ld)",
 541                            (ptrint) t, (ptrint) t->tid, (ptrint) t->tid);
 542 #else
 543                 printf(" t=0x%08x tid=0x%08x (%d)",
 544                            (ptrint) t, (ptrint) t->tid, (ptrint) t->tid);
 545 #endif
 546
 547                 printf(" index=%d", t->index);
 548
 549                 /* print thread state */
 550
 551                 switch (t->state) {
 552                 case THREAD_STATE_NEW:
 553                         printf(" new");
 554                         break;
 555                 case THREAD_STATE_RUNNABLE:
 556                         printf(" runnable");
 557                         break;
 558                 case THREAD_STATE_BLOCKED:
 559                         printf(" blocked");
 560                         break;
 561                 case THREAD_STATE_WAITING:
 562                         printf(" waiting");
 563                         break;
 564                 case THREAD_STATE_TIMED_WAITING:
 565                         printf(" waiting on condition");
 566                         break;
 567                 case THREAD_STATE_TERMINATED:
 568                         printf(" terminated");
 569                         break;
 570                 default:
 571                         vm_abort("threads_thread_print_info: unknown thread state %d",
 572                                          t->state);
 573                 }
 574         }
 575 }
 576
 577
 578 /* threads_get_current_tid *****************************************************
 579
 580    Return the tid of the current thread.
 581
 582    RETURN VALUE:
 583        the current tid
 584
 585 *******************************************************************************/
 586
 587 ptrint threads_get_current_tid(void)
 588 {
 589         threadobject *thread;
 590
 591         thread = THREADOBJECT;
 592
 593         /* this may happen during bootstrap */
 594
 595         if (thread == NULL)
 596                 return 0;
 597
 598         return (ptrint) thread->tid;
 599 }
 600
 601
 602 /* threads_thread_state_runnable ***********************************************
 603
 604    Set the current state of the given thread to THREAD_STATE_RUNNABLE.
 605
 606 *******************************************************************************/
 607
 608 void threads_thread_state_runnable(threadobject *t)
 609 {
 610         /* set the state inside the lock */
 611
 612         threads_list_lock();
 613
 614         t->state = THREAD_STATE_RUNNABLE;
 615
 616         threads_list_unlock();
 617 }
 618
 619
 620 /* threads_thread_state_waiting ************************************************
 621
 622    Set the current state of the given thread to THREAD_STATE_WAITING.
 623
 624 *******************************************************************************/
 625
 626 void threads_thread_state_waiting(threadobject *t)
 627 {
 628         /* set the state in the lock */
 629
 630         threads_list_lock();
 631
 632         t->state = THREAD_STATE_WAITING;
 633
 634         threads_list_unlock();
 635 }
 636
 637
 638 /* threads_thread_state_timed_waiting ******************************************
 639
 640    Set the current state of the given thread to
 641    THREAD_STATE_TIMED_WAITING.
 642
 643 *******************************************************************************/
 644
 645 void threads_thread_state_timed_waiting(threadobject *t)
 646 {
 647         /* set the state in the lock */
 648
 649         threads_list_lock();
 650
 651         t->state = THREAD_STATE_TIMED_WAITING;
 652
 653         threads_list_unlock();
 654 }
 655
 656
 657 /* threads_thread_state_terminated *********************************************
 658
 659    Set the current state of the given thread to
 660    THREAD_STATE_TERMINATED.
 661
 662 *******************************************************************************/
 663
 664 void threads_thread_state_terminated(threadobject *t)
 665 {
 666         /* set the state in the lock */
 667
 668         threads_list_lock();
 669
 670         t->state = THREAD_STATE_TERMINATED;
 671
 672         threads_list_unlock();
 673 }
 674
 675
 676 /* threads_thread_get_state ****************************************************
 677
 678    Returns the current state of the given thread.
 679
 680 *******************************************************************************/
 681
 682 utf *threads_thread_get_state(threadobject *t)
 683 {
 684         utf *u;
 685
 686         switch (t->state) {
 687         case THREAD_STATE_NEW:
 688                 u = utf_new_char("NEW");
 689                 break;
 690         case THREAD_STATE_RUNNABLE:
 691                 u = utf_new_char("RUNNABLE");
 692                 break;
 693         case THREAD_STATE_BLOCKED:
 694                 u = utf_new_char("BLOCKED");
 695                 break;
 696         case THREAD_STATE_WAITING:
 697                 u = utf_new_char("WAITING");
 698                 break;
 699         case THREAD_STATE_TIMED_WAITING:
 700                 u = utf_new_char("TIMED_WAITING");
 701                 break;
 702         case THREAD_STATE_TERMINATED:
 703                 u = utf_new_char("TERMINATED");
 704                 break;
 705         default:
 706                 vm_abort("threads_get_state: unknown thread state %d", t->state);
 707
 708                 /* keep compiler happy */
 709
 710                 u = NULL;
 711         }
 712
 713         return u;
 714 }
 715
 716
 717 /* threads_thread_is_alive *****************************************************
 718
 719    Returns if the give thread is alive.
 720
 721 *******************************************************************************/
 722
 723 bool threads_thread_is_alive(threadobject *thread)
 724 {
 725         bool result;
 726
 727         switch (thread->state) {
 728         case THREAD_STATE_NEW:
 729         case THREAD_STATE_TERMINATED:
 730                 result = false;
 731                 break;
 732
 733         case THREAD_STATE_RUNNABLE:
 734         case THREAD_STATE_BLOCKED:
 735         case THREAD_STATE_WAITING:
 736         case THREAD_STATE_TIMED_WAITING:
 737                 result = true;
 738                 break;
 739
 740         default:
 741                 vm_abort("threads_is_alive: unknown thread state %d", thread->state);
 742
 743                 /* keep compiler happy */
 744
 745                 result = false;
 746         }
 747
 748         return result;
 749 }
 750
 751
 752 /* threads_dump ****************************************************************
 753
 754    Dumps info for all threads running in the JVM.  This function is
 755    called when SIGQUIT (<ctrl>-\) is sent to CACAO.
 756
 757 *******************************************************************************/
 758
 759 void threads_dump(void)
 760 {
 761         threadobject *t;
 762
 763         /* XXX we should stop the world here */
 764
 765         /* lock the threads lists */
 766
 767         threads_list_lock();
 768
 769         printf("Full thread dump CACAO "VERSION":\n");
 770
 771         /* iterate over all started threads */
 772
 773         for (t = threads_list_first(); t != NULL; t = threads_list_next(t)) {
 774                 /* print thread info */
 775
 776                 printf("\n");
 777                 threads_thread_print_info(t);
 778                 printf("\n");
 779
 780                 /* print trace of thread */
 781
 782                 threads_thread_print_stacktrace(t);
 783         }
 784
 785         /* unlock the threads lists */
 786
 787         threads_list_unlock();
 788 }
 789
 790
 791 /* threads_thread_print_stacktrace *********************************************
 792
 793    Print the current stacktrace of the current thread.
 794
 795 *******************************************************************************/
 796
 797 void threads_thread_print_stacktrace(threadobject *thread)
 798 {
 799         stackframeinfo   *sfi;
 800         stacktracebuffer *stb;
 801         s4                dumpsize;
 802
 803         /* mark start of dump memory area */
 804
 805         dumpsize = dump_size();
 806
 807         /* create a stacktrace for the passed thread */
 808
 809         sfi = thread->_stackframeinfo;
 810
 811         stb = stacktrace_create(sfi);
 812
 813         /* print stacktrace */
 814
 815         if (stb != NULL)
 816                 stacktrace_print_trace_from_buffer(stb);
 817         else {
 818                 puts("\t<<No stacktrace available>>");
 819                 fflush(stdout);
 820         }
 821
 822         dump_release(dumpsize);
 823 }
 824
 825
 826 /* threads_print_stacktrace ****************************************************
 827
 828    Print the current stacktrace of the current thread.
 829
 830 *******************************************************************************/
 831
 832 void threads_print_stacktrace(void)
 833 {
 834         threadobject *thread;
 835
 836         thread = THREADOBJECT;
 837
 838         threads_thread_print_stacktrace(thread);
 839 }
 840
 841
 842 /*
 843  * These are local overrides for various environment variables in Emacs.
 844  * Please do not remove this and leave it at the end of the file, where
 845  * Emacs will automagically detect them.
 846  * ---------------------------------------------------------------------
 847  * Local variables:
 848  * mode: c
 849  * indent-tabs-mode: t
 850  * c-basic-offset: 4
 851  * tab-width: 4
 852  * End:
 853  * vim:noexpandtab:sw=4:ts=4:
 854  */