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;
284 #if defined(ENABLE_GC_CACAO)
285 /* register reference to java.lang.Thread with the GC */
287 gc_reference_register((java_object_t **) &(t->object), GC_REFTYPE_THREADOBJECT);
291 /* pre-compute the thinlock-word */
293 assert(t->index != 0);
295 t->thinlock = lock_pre_compute_thinlock(t->index);
297 t->state = THREAD_STATE_NEW;
299 #if defined(ENABLE_GC_CACAO)
300 t->flags |= THREAD_FLAG_IN_NATIVE;
303 /* initialize the implementation-specific bits */
305 threads_impl_thread_new(t);
307 /* add the thread to the threads-list */
309 list_add_last_unsynced(list_threads, t);
311 /* unlock the threads-lists */
313 threads_list_unlock();
319 /* threads_thread_free *********************************************************
321 Frees an internal thread data-structure by removing it from the
322 threads-list and adding it to the free-list.
324 NOTE: The data-structure is NOT freed, the pointer keeps valid!
326 *******************************************************************************/
328 void threads_thread_free(threadobject *t)
333 /* lock the threads-lists */
337 /* cleanup the implementation-specific bits */
339 threads_impl_thread_free(t);
341 /* remove the thread from the threads-list */
343 list_remove_unsynced(list_threads, t);
345 /* Clear memory, but keep the thread-index and the
348 /* ATTENTION: Do this after list_remove, otherwise the linkage
349 pointers are invalid. */
354 MZERO(t, threadobject, 1);
359 /* add the thread to the free list */
361 list_add_first_unsynced(list_threads_free, t);
363 /* unlock the threads-lists */
365 threads_list_unlock();
369 /* threads_thread_start_internal ***********************************************
371 Start an internal thread in the JVM. No Java thread objects exists
375 name.......UTF-8 name of the thread
376 f..........function pointer to C function to start
378 *******************************************************************************/
380 bool threads_thread_start_internal(utf *name, functionptr f)
383 java_lang_Thread *object;
384 #if defined(WITH_CLASSPATH_GNU)
385 java_lang_VMThread *vmt;
388 /* Enter the join-mutex, so if the main-thread is currently
389 waiting to join all threads, the number of non-daemon threads
392 threads_mutex_join_lock();
394 /* create internal thread data-structure */
396 t = threads_thread_new();
398 t->flags |= THREAD_FLAG_INTERNAL | THREAD_FLAG_DAEMON;
400 /* The thread is flagged as (non-)daemon thread, we can leave the
403 threads_mutex_join_unlock();
405 /* create the java thread object */
407 object = (java_lang_Thread *) builtin_new(class_java_lang_Thread);
409 /* XXX memory leak!!! */
413 #if defined(WITH_CLASSPATH_GNU)
414 vmt = (java_lang_VMThread *) builtin_new(class_java_lang_VMThread);
416 /* XXX memory leak!!! */
420 LLNI_field_set_ref(vmt, thread, object);
421 LLNI_field_set_val(vmt, vmdata, (java_lang_Object *) t);
423 LLNI_field_set_ref(object, vmThread, vmt);
424 #elif defined(WITH_CLASSPATH_CLDC1_1)
425 LLNI_field_set_val(object, vm_thread, (java_lang_Object *) t);
430 /* set java.lang.Thread fields */
432 #if defined(WITH_CLASSPATH_GNU)
433 LLNI_field_set_ref(object, name , (java_lang_String *) javastring_new(name));
434 #elif defined(WITH_CLASSPATH_CLDC1_1)
435 /* FIXME: In cldc the name is a char[] */
436 /* LLNI_field_set_ref(object, name , (java_chararray *) javastring_new(name)); */
437 LLNI_field_set_ref(object, name , NULL);
440 #if defined(ENABLE_JAVASE)
441 LLNI_field_set_val(object, daemon , true);
444 LLNI_field_set_val(object, priority, NORM_PRIORITY);
446 /* start the thread */
448 threads_impl_thread_start(t, f);
450 /* everything's ok */
456 /* threads_thread_start ********************************************************
458 Start a Java thread in the JVM. Only the java thread object exists
462 object.....the java thread object java.lang.Thread
464 *******************************************************************************/
466 void threads_thread_start(java_lang_Thread *object)
468 threadobject *thread;
469 #if defined(WITH_CLASSPATH_GNU)
470 java_lang_VMThread *vmt;
473 /* Enter the join-mutex, so if the main-thread is currently
474 waiting to join all threads, the number of non-daemon threads
477 threads_mutex_join_lock();
479 /* create internal thread data-structure */
481 thread = threads_thread_new();
483 /* this is a normal Java thread */
485 thread->flags |= THREAD_FLAG_JAVA;
487 #if defined(ENABLE_JAVASE)
488 /* is this a daemon thread? */
490 if (LLNI_field_direct(object, daemon) == true)
491 thread->flags |= THREAD_FLAG_DAEMON;
494 /* The thread is flagged and (non-)daemon thread, we can leave the
497 threads_mutex_join_unlock();
499 /* link the two objects together */
501 thread->object = object;
503 #if defined(WITH_CLASSPATH_GNU)
504 LLNI_field_get_ref(object, vmThread, vmt);
507 assert(LLNI_field_direct(vmt, vmdata) == NULL);
509 LLNI_field_set_val(vmt, vmdata, (java_lang_Object *) thread);
510 #elif defined(WITH_CLASSPATH_CLDC1_1)
511 LLNI_field_set_val(object, vm_thread, (java_lang_Object *) thread);
514 /* Start the thread. Don't pass a function pointer (NULL) since
515 we want Thread.run()V here. */
517 threads_impl_thread_start(thread, NULL);
521 /* threads_thread_print_info ***************************************************
523 Print information of the passed thread.
525 *******************************************************************************/
527 void threads_thread_print_info(threadobject *t)
529 java_lang_Thread *object;
530 #if defined(WITH_CLASSPATH_GNU)
531 java_lang_String *namestring;
535 assert(t->state != THREAD_STATE_NEW);
537 /* the thread may be currently in initalization, don't print it */
541 if (object != NULL) {
542 /* get thread name */
544 #if defined(WITH_CLASSPATH_GNU)
545 LLNI_field_get_ref(object, name, namestring);
546 name = javastring_toutf((java_handle_t *) namestring, false);
547 #elif defined(WITH_CLASSPATH_SUN) || defined(WITH_CLASSPATH_CLDC1_1)
548 /* FIXME: In cldc the name is a char[] */
549 /* name = object->name; */
552 # error unknown classpath configuration
556 utf_display_printable_ascii(name);
559 if (t->flags & THREAD_FLAG_DAEMON)
562 printf(" prio=%d", LLNI_field_direct(object, priority));
564 #if SIZEOF_VOID_P == 8
565 printf(" t=0x%016lx tid=0x%016lx (%ld)",
566 (ptrint) t, (ptrint) t->tid, (ptrint) t->tid);
568 printf(" t=0x%08x tid=0x%08x (%d)",
569 (ptrint) t, (ptrint) t->tid, (ptrint) t->tid);
572 printf(" index=%d", t->index);
574 /* print thread state */
577 case THREAD_STATE_NEW:
580 case THREAD_STATE_RUNNABLE:
583 case THREAD_STATE_BLOCKED:
586 case THREAD_STATE_WAITING:
589 case THREAD_STATE_TIMED_WAITING:
590 printf(" waiting on condition");
592 case THREAD_STATE_TERMINATED:
593 printf(" terminated");
596 vm_abort("threads_thread_print_info: unknown thread state %d",
603 /* threads_get_current_tid *****************************************************
605 Return the tid of the current thread.
610 *******************************************************************************/
612 ptrint threads_get_current_tid(void)
614 threadobject *thread;
616 thread = THREADOBJECT;
618 /* this may happen during bootstrap */
623 return (ptrint) thread->tid;
627 /* threads_thread_state_runnable ***********************************************
629 Set the current state of the given thread to THREAD_STATE_RUNNABLE.
631 NOTE: If the thread has already terminated, don't set the state.
632 This is important for threads_detach_thread.
634 *******************************************************************************/
636 void threads_thread_state_runnable(threadobject *t)
638 /* Set the state inside a lock. */
642 if (t->state != THREAD_STATE_TERMINATED)
643 t->state = THREAD_STATE_RUNNABLE;
645 threads_list_unlock();
649 /* threads_thread_state_waiting ************************************************
651 Set the current state of the given thread to THREAD_STATE_WAITING.
653 NOTE: If the thread has already terminated, don't set the state.
654 This is important for threads_detach_thread.
656 *******************************************************************************/
658 void threads_thread_state_waiting(threadobject *t)
660 /* Set the state inside a lock. */
664 if (t->state != THREAD_STATE_TERMINATED)
665 t->state = THREAD_STATE_WAITING;
667 threads_list_unlock();
671 /* threads_thread_state_timed_waiting ******************************************
673 Set the current state of the given thread to
674 THREAD_STATE_TIMED_WAITING.
676 NOTE: If the thread has already terminated, don't set the state.
677 This is important for threads_detach_thread.
679 *******************************************************************************/
681 void threads_thread_state_timed_waiting(threadobject *t)
683 /* Set the state inside a lock. */
687 if (t->state != THREAD_STATE_TERMINATED)
688 t->state = THREAD_STATE_TIMED_WAITING;
690 threads_list_unlock();
694 /* threads_thread_state_terminated *********************************************
696 Set the current state of the given thread to
697 THREAD_STATE_TERMINATED.
699 *******************************************************************************/
701 void threads_thread_state_terminated(threadobject *t)
703 /* set the state in the lock */
707 t->state = THREAD_STATE_TERMINATED;
709 threads_list_unlock();
713 /* threads_thread_get_state ****************************************************
715 Returns the current state of the given thread.
717 *******************************************************************************/
719 utf *threads_thread_get_state(threadobject *t)
724 case THREAD_STATE_NEW:
725 u = utf_new_char("NEW");
727 case THREAD_STATE_RUNNABLE:
728 u = utf_new_char("RUNNABLE");
730 case THREAD_STATE_BLOCKED:
731 u = utf_new_char("BLOCKED");
733 case THREAD_STATE_WAITING:
734 u = utf_new_char("WAITING");
736 case THREAD_STATE_TIMED_WAITING:
737 u = utf_new_char("TIMED_WAITING");
739 case THREAD_STATE_TERMINATED:
740 u = utf_new_char("TERMINATED");
743 vm_abort("threads_get_state: unknown thread state %d", t->state);
745 /* keep compiler happy */
754 /* threads_thread_is_alive *****************************************************
756 Returns if the give thread is alive.
758 *******************************************************************************/
760 bool threads_thread_is_alive(threadobject *t)
763 case THREAD_STATE_NEW:
764 case THREAD_STATE_TERMINATED:
767 case THREAD_STATE_RUNNABLE:
768 case THREAD_STATE_BLOCKED:
769 case THREAD_STATE_WAITING:
770 case THREAD_STATE_TIMED_WAITING:
774 vm_abort("threads_thread_is_alive: unknown thread state %d", t->state);
777 /* keep compiler happy */
783 /* threads_dump ****************************************************************
785 Dumps info for all threads running in the JVM. This function is
786 called when SIGQUIT (<ctrl>-\) is sent to CACAO.
788 *******************************************************************************/
790 void threads_dump(void)
794 /* XXX we should stop the world here */
796 /* lock the threads lists */
800 printf("Full thread dump CACAO "VERSION":\n");
802 /* iterate over all started threads */
804 for (t = threads_list_first(); t != NULL; t = threads_list_next(t)) {
805 /* print thread info */
808 threads_thread_print_info(t);
811 /* print trace of thread */
813 threads_thread_print_stacktrace(t);
816 /* unlock the threads lists */
818 threads_list_unlock();
822 /* threads_thread_print_stacktrace *********************************************
824 Print the current stacktrace of the current thread.
826 *******************************************************************************/
828 void threads_thread_print_stacktrace(threadobject *thread)
831 stacktracebuffer *stb;
834 /* mark start of dump memory area */
836 dumpsize = dump_size();
838 /* create a stacktrace for the passed thread */
840 sfi = thread->_stackframeinfo;
842 stb = stacktrace_create(sfi);
844 /* print stacktrace */
847 stacktrace_print_trace_from_buffer(stb);
849 puts("\t<<No stacktrace available>>");
853 dump_release(dumpsize);
857 /* threads_print_stacktrace ****************************************************
859 Print the current stacktrace of the current thread.
861 *******************************************************************************/
863 void threads_print_stacktrace(void)
865 threadobject *thread;
867 thread = THREADOBJECT;
869 threads_thread_print_stacktrace(thread);
874 * These are local overrides for various environment variables in Emacs.
875 * Please do not remove this and leave it at the end of the file, where
876 * Emacs will automagically detect them.
877 * ---------------------------------------------------------------------
880 * indent-tabs-mode: t
884 * vim:noexpandtab:sw=4:ts=4: