1 /* src/threads/threads-common.c - machine independent thread functions
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
8 This file is part of CACAO.
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.
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.
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
36 #include "mm/memory.h"
38 #include "native/jni.h"
39 #include "native/llni.h"
41 #include "native/include/java_lang_Object.h"
42 #include "native/include/java_lang_String.h"
43 #include "native/include/java_lang_Thread.h"
45 #if defined(WITH_CLASSPATH_GNU)
46 # include "native/include/java_lang_VMThread.h"
49 #include "threads/critical.h"
50 #include "threads/lock-common.h"
51 #include "threads/threads-common.h"
53 #include "toolbox/list.h"
55 #include "vm/builtin.h"
56 #include "vm/stringlocal.h"
59 #include "vm/jit/stacktrace.h"
61 #include "vmcore/class.h"
63 #if defined(ENABLE_STATISTICS)
64 # include "vmcore/options.h"
65 # include "vmcore/statistics.h"
68 #include "vmcore/utf8.h"
71 /* global variables ***********************************************************/
73 /* global threads list */
74 static list_t *list_threads;
76 /* global threads free-list */
77 static list_t *list_threads_free;
79 #if defined(__LINUX__)
80 /* XXX Remove for exact-GC. */
81 bool threads_pthreads_implementation_nptl;
85 /* threads_preinit *************************************************************
87 Do some early initialization of stuff required.
89 ATTENTION: Do NOT use any Java heap allocation here, as gc_init()
90 is called AFTER this function!
92 *******************************************************************************/
94 void threads_preinit(void)
96 threadobject *mainthread;
97 #if defined(__LINUX__) && defined(_CS_GNU_LIBPTHREAD_VERSION)
102 #if defined(__LINUX__)
103 /* XXX Remove for exact-GC. */
105 /* On Linux we need to check the pthread implementation. */
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
111 # if defined(_CS_GNU_LIBPTHREAD_VERSION)
112 len = confstr(_CS_GNU_LIBPTHREAD_VERSION, NULL, (size_t) 0);
114 /* Some systems return as length 0 (maybe cross-compilation
115 related). In this case we also fall back to linuxthreads. */
118 pathbuf = MNEW(char, len);
120 (void) confstr(_CS_GNU_LIBPTHREAD_VERSION, pathbuf, len);
122 if (strstr(pathbuf, "NPTL") != NULL)
123 threads_pthreads_implementation_nptl = true;
125 threads_pthreads_implementation_nptl = false;
128 threads_pthreads_implementation_nptl = false;
130 threads_pthreads_implementation_nptl = false;
134 /* initialize the threads lists */
136 list_threads = list_create(OFFSET(threadobject, linkage));
137 list_threads_free = list_create(OFFSET(threadobject, linkage));
139 /* Initialize the threads implementation (sets the thinlock on the
142 threads_impl_preinit();
144 /* create internal thread data-structure for the main thread */
146 mainthread = threads_thread_new();
148 /* thread is a Java thread and running */
150 mainthread->flags = THREAD_FLAG_JAVA;
151 mainthread->state = THREAD_STATE_RUNNABLE;
153 /* store the internal thread data-structure in the TSD */
155 threads_set_current_threadobject(mainthread);
157 /* initialize locking subsystems */
161 /* initialize the critical section */
167 /* threads_list_first **********************************************************
169 Return the first entry in the threads list.
171 NOTE: This function does not lock the lists.
173 *******************************************************************************/
175 threadobject *threads_list_first(void)
179 t = list_first_unsynced(list_threads);
185 /* threads_list_next ***********************************************************
187 Return the next entry in the threads list.
189 NOTE: This function does not lock the lists.
191 *******************************************************************************/
193 threadobject *threads_list_next(threadobject *t)
197 next = list_next_unsynced(list_threads, t);
203 /* threads_list_get_non_daemons ************************************************
205 Return the number of non-daemon threads.
207 NOTE: This function does a linear-search over the threads list,
208 because it's only used for joining the threads.
210 *******************************************************************************/
212 s4 threads_list_get_non_daemons(void)
217 /* lock the threads lists */
223 for (t = threads_list_first(); t != NULL; t = threads_list_next(t)) {
224 if (!(t->flags & THREAD_FLAG_DAEMON))
228 /* unlock the threads lists */
230 threads_list_unlock();
236 /* threads_thread_new **********************************************************
238 Allocates and initializes an internal thread data-structure and
239 adds it to the threads list.
241 *******************************************************************************/
243 threadobject *threads_thread_new(void)
247 /* lock the threads-lists */
251 /* try to get a thread from the free-list */
253 t = list_first_unsynced(list_threads_free);
255 /* is a free thread available? */
258 /* yes, remove it from the free list */
260 list_remove_unsynced(list_threads_free, t);
263 /* no, allocate a new one */
265 #if defined(ENABLE_GC_BOEHM)
266 t = GCNEW_UNCOLLECTABLE(threadobject, 1);
268 t = NEW(threadobject);
271 #if defined(ENABLE_STATISTICS)
273 size_threadobject += sizeof(threadobject);
278 MZERO(t, threadobject, 1);
280 /* set the threads-index */
282 t->index = list_threads->size + 1;
285 /* pre-compute the thinlock-word */
287 assert(t->index != 0);
289 t->thinlock = lock_pre_compute_thinlock(t->index);
290 t->state = THREAD_STATE_NEW;
292 /* initialize the implementation-specific bits */
294 threads_impl_thread_new(t);
296 /* add the thread to the threads-list */
298 list_add_last_unsynced(list_threads, t);
300 /* unlock the threads-lists */
302 threads_list_unlock();
308 /* threads_thread_free *********************************************************
310 Frees an internal thread data-structure by removing it from the
311 threads-list and adding it to the free-list.
313 NOTE: The data-structure is NOT freed, the pointer keeps valid!
315 *******************************************************************************/
317 void threads_thread_free(threadobject *t)
322 /* lock the threads-lists */
326 /* cleanup the implementation-specific bits */
328 threads_impl_thread_free(t);
330 /* remove the thread from the threads-list */
332 list_remove_unsynced(list_threads, t);
334 /* Clear memory, but keep the thread-index and the
337 /* ATTENTION: Do this after list_remove, otherwise the linkage
338 pointers are invalid. */
343 MZERO(t, threadobject, 1);
348 /* add the thread to the free list */
350 list_add_first_unsynced(list_threads_free, t);
352 /* unlock the threads-lists */
354 threads_list_unlock();
358 /* threads_thread_start_internal ***********************************************
360 Start an internal thread in the JVM. No Java thread objects exists
364 name.......UTF-8 name of the thread
365 f..........function pointer to C function to start
367 *******************************************************************************/
369 bool threads_thread_start_internal(utf *name, functionptr f)
372 java_lang_Thread *object;
373 #if defined(WITH_CLASSPATH_GNU)
374 java_lang_VMThread *vmt;
377 /* Enter the join-mutex, so if the main-thread is currently
378 waiting to join all threads, the number of non-daemon threads
381 threads_mutex_join_lock();
383 /* create internal thread data-structure */
385 t = threads_thread_new();
387 t->flags = THREAD_FLAG_INTERNAL | THREAD_FLAG_DAEMON;
389 /* The thread is flagged as (non-)daemon thread, we can leave the
392 threads_mutex_join_unlock();
394 /* create the java thread object */
396 object = (java_lang_Thread *) builtin_new(class_java_lang_Thread);
398 /* XXX memory leak!!! */
402 #if defined(WITH_CLASSPATH_GNU)
403 vmt = (java_lang_VMThread *) builtin_new(class_java_lang_VMThread);
405 /* XXX memory leak!!! */
409 LLNI_field_set_ref(vmt, thread, object);
410 LLNI_field_set_val(vmt, vmdata, (java_lang_Object *) t);
412 LLNI_field_set_ref(object, vmThread, vmt);
413 #elif defined(WITH_CLASSPATH_CLDC1_1)
414 LLNI_field_set_val(object, vm_thread, (java_lang_Object *) t);
419 /* set java.lang.Thread fields */
421 #if defined(WITH_CLASSPATH_GNU)
422 LLNI_field_set_ref(object, name , (java_lang_String *) javastring_new(name));
423 #elif defined(WITH_CLASSPATH_CLDC1_1)
424 /* FIXME: In cldc the name is a char[] */
425 /* LLNI_field_set_ref(object, name , (java_chararray *) javastring_new(name)); */
426 LLNI_field_set_ref(object, name , NULL);
429 #if defined(ENABLE_JAVASE)
430 LLNI_field_set_val(object, daemon , true);
433 LLNI_field_set_val(object, priority, NORM_PRIORITY);
435 /* start the thread */
437 threads_impl_thread_start(t, f);
439 /* everything's ok */
445 /* threads_thread_start ********************************************************
447 Start a Java thread in the JVM. Only the java thread object exists
451 object.....the java thread object java.lang.Thread
453 *******************************************************************************/
455 void threads_thread_start(java_lang_Thread *object)
457 threadobject *thread;
458 #if defined(WITH_CLASSPATH_GNU)
459 java_lang_VMThread *vmt;
462 /* Enter the join-mutex, so if the main-thread is currently
463 waiting to join all threads, the number of non-daemon threads
466 threads_mutex_join_lock();
468 /* create internal thread data-structure */
470 thread = threads_thread_new();
472 /* this is a normal Java thread */
474 thread->flags = THREAD_FLAG_JAVA;
476 #if defined(ENABLE_JAVASE)
477 /* is this a daemon thread? */
479 if (LLNI_field_direct(object, daemon) == true)
480 thread->flags |= THREAD_FLAG_DAEMON;
483 /* The thread is flagged and (non-)daemon thread, we can leave the
486 threads_mutex_join_unlock();
488 /* link the two objects together */
490 thread->object = object;
492 #if defined(WITH_CLASSPATH_GNU)
493 LLNI_field_get_ref(object, vmThread, vmt);
496 assert(LLNI_field_direct(vmt, vmdata) == NULL);
498 LLNI_field_set_val(vmt, vmdata, (java_lang_Object *) thread);
499 #elif defined(WITH_CLASSPATH_CLDC1_1)
500 LLNI_field_set_val(object, vm_thread, (java_lang_Object *) thread);
503 /* Start the thread. Don't pass a function pointer (NULL) since
504 we want Thread.run()V here. */
506 threads_impl_thread_start(thread, NULL);
510 /* threads_thread_print_info ***************************************************
512 Print information of the passed thread.
514 *******************************************************************************/
516 void threads_thread_print_info(threadobject *t)
518 java_lang_Thread *object;
521 assert(t->state != THREAD_STATE_NEW);
523 /* the thread may be currently in initalization, don't print it */
527 if (object != NULL) {
528 /* get thread name */
530 #if defined(WITH_CLASSPATH_GNU)
531 name = javastring_toutf((java_handle_t *) LLNI_field_direct(object, name), false);
532 #elif defined(WITH_CLASSPATH_SUN) || defined(WITH_CLASSPATH_CLDC1_1)
533 /* FIXME: In cldc the name is a char[] */
534 /* name = object->name; */
537 # error unknown classpath configuration
541 utf_display_printable_ascii(name);
544 if (t->flags & THREAD_FLAG_DAEMON)
547 printf(" prio=%d", LLNI_field_direct(object, priority));
549 #if SIZEOF_VOID_P == 8
550 printf(" t=0x%016lx tid=0x%016lx (%ld)",
551 (ptrint) t, (ptrint) t->tid, (ptrint) t->tid);
553 printf(" t=0x%08x tid=0x%08x (%d)",
554 (ptrint) t, (ptrint) t->tid, (ptrint) t->tid);
557 printf(" index=%d", t->index);
559 /* print thread state */
562 case THREAD_STATE_NEW:
565 case THREAD_STATE_RUNNABLE:
568 case THREAD_STATE_BLOCKED:
571 case THREAD_STATE_WAITING:
574 case THREAD_STATE_TIMED_WAITING:
575 printf(" waiting on condition");
577 case THREAD_STATE_TERMINATED:
578 printf(" terminated");
581 vm_abort("threads_thread_print_info: unknown thread state %d",
588 /* threads_get_current_tid *****************************************************
590 Return the tid of the current thread.
595 *******************************************************************************/
597 ptrint threads_get_current_tid(void)
599 threadobject *thread;
601 thread = THREADOBJECT;
603 /* this may happen during bootstrap */
608 return (ptrint) thread->tid;
612 /* threads_thread_state_runnable ***********************************************
614 Set the current state of the given thread to THREAD_STATE_RUNNABLE.
616 *******************************************************************************/
618 void threads_thread_state_runnable(threadobject *t)
620 /* set the state inside the lock */
624 t->state = THREAD_STATE_RUNNABLE;
626 threads_list_unlock();
630 /* threads_thread_state_waiting ************************************************
632 Set the current state of the given thread to THREAD_STATE_WAITING.
634 *******************************************************************************/
636 void threads_thread_state_waiting(threadobject *t)
638 /* set the state in the lock */
642 t->state = THREAD_STATE_WAITING;
644 threads_list_unlock();
648 /* threads_thread_state_timed_waiting ******************************************
650 Set the current state of the given thread to
651 THREAD_STATE_TIMED_WAITING.
653 *******************************************************************************/
655 void threads_thread_state_timed_waiting(threadobject *t)
657 /* set the state in the lock */
661 t->state = THREAD_STATE_TIMED_WAITING;
663 threads_list_unlock();
667 /* threads_thread_state_terminated *********************************************
669 Set the current state of the given thread to
670 THREAD_STATE_TERMINATED.
672 *******************************************************************************/
674 void threads_thread_state_terminated(threadobject *t)
676 /* set the state in the lock */
680 t->state = THREAD_STATE_TERMINATED;
682 threads_list_unlock();
686 /* threads_thread_get_state ****************************************************
688 Returns the current state of the given thread.
690 *******************************************************************************/
692 utf *threads_thread_get_state(threadobject *t)
697 case THREAD_STATE_NEW:
698 u = utf_new_char("NEW");
700 case THREAD_STATE_RUNNABLE:
701 u = utf_new_char("RUNNABLE");
703 case THREAD_STATE_BLOCKED:
704 u = utf_new_char("BLOCKED");
706 case THREAD_STATE_WAITING:
707 u = utf_new_char("WAITING");
709 case THREAD_STATE_TIMED_WAITING:
710 u = utf_new_char("TIMED_WAITING");
712 case THREAD_STATE_TERMINATED:
713 u = utf_new_char("TERMINATED");
716 vm_abort("threads_get_state: unknown thread state %d", t->state);
718 /* keep compiler happy */
727 /* threads_thread_is_alive *****************************************************
729 Returns if the give thread is alive.
731 *******************************************************************************/
733 bool threads_thread_is_alive(threadobject *thread)
737 switch (thread->state) {
738 case THREAD_STATE_NEW:
739 case THREAD_STATE_TERMINATED:
743 case THREAD_STATE_RUNNABLE:
744 case THREAD_STATE_BLOCKED:
745 case THREAD_STATE_WAITING:
746 case THREAD_STATE_TIMED_WAITING:
751 vm_abort("threads_is_alive: unknown thread state %d", thread->state);
753 /* keep compiler happy */
762 /* threads_dump ****************************************************************
764 Dumps info for all threads running in the JVM. This function is
765 called when SIGQUIT (<ctrl>-\) is sent to CACAO.
767 *******************************************************************************/
769 void threads_dump(void)
773 /* XXX we should stop the world here */
775 /* lock the threads lists */
779 printf("Full thread dump CACAO "VERSION":\n");
781 /* iterate over all started threads */
783 for (t = threads_list_first(); t != NULL; t = threads_list_next(t)) {
784 /* print thread info */
787 threads_thread_print_info(t);
790 /* print trace of thread */
792 threads_thread_print_stacktrace(t);
795 /* unlock the threads lists */
797 threads_list_unlock();
801 /* threads_thread_print_stacktrace *********************************************
803 Print the current stacktrace of the current thread.
805 *******************************************************************************/
807 void threads_thread_print_stacktrace(threadobject *thread)
810 stacktracebuffer *stb;
813 /* mark start of dump memory area */
815 dumpsize = dump_size();
817 /* create a stacktrace for the passed thread */
819 sfi = thread->_stackframeinfo;
821 stb = stacktrace_create(sfi);
823 /* print stacktrace */
826 stacktrace_print_trace_from_buffer(stb);
828 puts("\t<<No stacktrace available>>");
832 dump_release(dumpsize);
836 /* threads_print_stacktrace ****************************************************
838 Print the current stacktrace of the current thread.
840 *******************************************************************************/
842 void threads_print_stacktrace(void)
844 threadobject *thread;
846 thread = THREADOBJECT;
848 threads_thread_print_stacktrace(thread);
853 * These are local overrides for various environment variables in Emacs.
854 * Please do not remove this and leave it at the end of the file, where
855 * Emacs will automagically detect them.
856 * ---------------------------------------------------------------------
859 * indent-tabs-mode: t
863 * vim:noexpandtab:sw=4:ts=4: