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
25 $Id: threads-common.c 8114 2007-06-20 18:57:41Z twisti $
37 #include "mm/memory.h"
39 #include "native/jni.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__)
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)
321 /* lock the threads-lists */
325 /* cleanup the implementation-specific bits */
327 threads_impl_thread_free(t);
329 /* remove the thread from the threads-list */
331 list_remove_unsynced(list_threads, t);
333 /* Clear memory, but keep the thread-index. */
334 /* ATTENTION: Do this after list_remove, otherwise the linkage
335 pointers are invalid. */
339 MZERO(t, threadobject, 1);
343 /* add the thread to the free list */
345 list_add_first_unsynced(list_threads_free, t);
347 /* unlock the threads-lists */
349 threads_list_unlock();
353 /* threads_thread_start_internal ***********************************************
355 Start an internal thread in the JVM. No Java thread objects exists
359 name.......UTF-8 name of the thread
360 f..........function pointer to C function to start
362 *******************************************************************************/
364 bool threads_thread_start_internal(utf *name, functionptr f)
367 java_lang_Thread *object;
368 #if defined(WITH_CLASSPATH_GNU)
369 java_lang_VMThread *vmt;
372 /* Enter the join-mutex, so if the main-thread is currently
373 waiting to join all threads, the number of non-daemon threads
376 threads_mutex_join_lock();
378 /* create internal thread data-structure */
380 t = threads_thread_new();
382 t->flags = THREAD_FLAG_INTERNAL | THREAD_FLAG_DAEMON;
384 /* The thread is flagged as (non-)daemon thread, we can leave the
387 threads_mutex_join_unlock();
389 /* create the java thread object */
391 object = (java_lang_Thread *) builtin_new(class_java_lang_Thread);
393 /* XXX memory leak!!! */
397 #if defined(WITH_CLASSPATH_GNU)
398 vmt = (java_lang_VMThread *) builtin_new(class_java_lang_VMThread);
400 /* XXX memory leak!!! */
404 vmt->thread = object;
405 vmt->vmdata = (java_lang_Object *) t;
407 object->vmThread = vmt;
408 #elif defined(WITH_CLASSPATH_CLDC1_1)
409 object->vm_thread = (java_lang_Object *) t;
414 /* set java.lang.Thread fields */
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); */
424 #if defined(ENABLE_JAVASE)
425 object->daemon = true;
428 object->priority = NORM_PRIORITY;
430 /* start the thread */
432 threads_impl_thread_start(t, f);
434 /* everything's ok */
440 /* threads_thread_start ********************************************************
442 Start a Java thread in the JVM. Only the java thread object exists
446 object.....the java thread object java.lang.Thread
448 *******************************************************************************/
450 void threads_thread_start(java_lang_Thread *object)
452 threadobject *thread;
454 /* Enter the join-mutex, so if the main-thread is currently
455 waiting to join all threads, the number of non-daemon threads
458 threads_mutex_join_lock();
460 /* create internal thread data-structure */
462 thread = threads_thread_new();
464 /* this is a normal Java thread */
466 thread->flags = THREAD_FLAG_JAVA;
468 #if defined(ENABLE_JAVASE)
469 /* is this a daemon thread? */
471 if (object->daemon == true)
472 thread->flags |= THREAD_FLAG_DAEMON;
475 /* The thread is flagged and (non-)daemon thread, we can leave the
478 threads_mutex_join_unlock();
480 /* link the two objects together */
482 thread->object = object;
484 #if defined(WITH_CLASSPATH_GNU)
485 assert(object->vmThread);
486 assert(object->vmThread->vmdata == NULL);
488 object->vmThread->vmdata = (java_lang_Object *) thread;
489 #elif defined(WITH_CLASSPATH_CLDC1_1)
490 object->vm_thread = (java_lang_Object *) thread;
493 /* Start the thread. Don't pass a function pointer (NULL) since
494 we want Thread.run()V here. */
496 threads_impl_thread_start(thread, NULL);
500 /* threads_thread_print_info ***************************************************
502 Print information of the passed thread.
504 *******************************************************************************/
506 void threads_thread_print_info(threadobject *t)
508 java_lang_Thread *object;
511 assert(t->state != THREAD_STATE_NEW);
513 /* the thread may be currently in initalization, don't print it */
517 if (object != NULL) {
518 /* get thread name */
520 #if defined(ENABLE_JAVASE)
521 name = javastring_toutf((java_objectheader *) object->name, false);
522 #elif defined(ENABLE_JAVAME_CLDC1_1)
523 /* FIXME: In cldc the name is a char[] */
524 /* name = object->name; */
529 utf_display_printable_ascii(name);
532 if (t->flags & THREAD_FLAG_DAEMON)
535 printf(" prio=%d", object->priority);
537 #if SIZEOF_VOID_P == 8
538 printf(" t=0x%016lx tid=0x%016lx (%ld)",
539 (ptrint) t, (ptrint) t->tid, (ptrint) t->tid);
541 printf(" t=0x%08x tid=0x%08x (%d)",
542 (ptrint) t, (ptrint) t->tid, (ptrint) t->tid);
545 printf(" index=%d", t->index);
547 /* print thread state */
550 case THREAD_STATE_NEW:
553 case THREAD_STATE_RUNNABLE:
556 case THREAD_STATE_BLOCKED:
559 case THREAD_STATE_WAITING:
562 case THREAD_STATE_TIMED_WAITING:
563 printf(" waiting on condition");
565 case THREAD_STATE_TERMINATED:
566 printf(" terminated");
569 vm_abort("threads_thread_print_info: unknown thread state %d",
576 /* threads_get_current_tid *****************************************************
578 Return the tid of the current thread.
583 *******************************************************************************/
585 ptrint threads_get_current_tid(void)
587 threadobject *thread;
589 thread = THREADOBJECT;
591 /* this may happen during bootstrap */
596 return (ptrint) thread->tid;
600 /* threads_thread_state_runnable ***********************************************
602 Set the current state of the given thread to THREAD_STATE_RUNNABLE.
604 *******************************************************************************/
606 void threads_thread_state_runnable(threadobject *t)
608 /* set the state inside the lock */
612 t->state = THREAD_STATE_RUNNABLE;
614 threads_list_unlock();
618 /* threads_thread_state_waiting ************************************************
620 Set the current state of the given thread to THREAD_STATE_WAITING.
622 *******************************************************************************/
624 void threads_thread_state_waiting(threadobject *t)
626 /* set the state in the lock */
630 t->state = THREAD_STATE_WAITING;
632 threads_list_unlock();
636 /* threads_thread_state_timed_waiting ******************************************
638 Set the current state of the given thread to
639 THREAD_STATE_TIMED_WAITING.
641 *******************************************************************************/
643 void threads_thread_state_timed_waiting(threadobject *t)
645 /* set the state in the lock */
649 t->state = THREAD_STATE_TIMED_WAITING;
651 threads_list_unlock();
655 /* threads_thread_state_terminated *********************************************
657 Set the current state of the given thread to
658 THREAD_STATE_TERMINATED.
660 *******************************************************************************/
662 void threads_thread_state_terminated(threadobject *t)
664 /* set the state in the lock */
668 t->state = THREAD_STATE_TERMINATED;
670 threads_list_unlock();
674 /* threads_thread_get_state ****************************************************
676 Returns the current state of the given thread.
678 *******************************************************************************/
680 utf *threads_thread_get_state(threadobject *t)
685 case THREAD_STATE_NEW:
686 u = utf_new_char("NEW");
688 case THREAD_STATE_RUNNABLE:
689 u = utf_new_char("RUNNABLE");
691 case THREAD_STATE_BLOCKED:
692 u = utf_new_char("BLOCKED");
694 case THREAD_STATE_WAITING:
695 u = utf_new_char("WAITING");
697 case THREAD_STATE_TIMED_WAITING:
698 u = utf_new_char("TIMED_WAITING");
700 case THREAD_STATE_TERMINATED:
701 u = utf_new_char("TERMINATED");
704 vm_abort("threads_get_state: unknown thread state %d", t->state);
706 /* keep compiler happy */
715 /* threads_thread_is_alive *****************************************************
717 Returns if the give thread is alive.
719 *******************************************************************************/
721 bool threads_thread_is_alive(threadobject *thread)
725 switch (thread->state) {
726 case THREAD_STATE_NEW:
727 case THREAD_STATE_TERMINATED:
731 case THREAD_STATE_RUNNABLE:
732 case THREAD_STATE_BLOCKED:
733 case THREAD_STATE_WAITING:
734 case THREAD_STATE_TIMED_WAITING:
739 vm_abort("threads_is_alive: unknown thread state %d", thread->state);
741 /* keep compiler happy */
750 /* threads_dump ****************************************************************
752 Dumps info for all threads running in the JVM. This function is
753 called when SIGQUIT (<ctrl>-\) is sent to CACAO.
755 *******************************************************************************/
757 void threads_dump(void)
761 /* XXX we should stop the world here */
763 /* lock the threads lists */
767 printf("Full thread dump CACAO "VERSION":\n");
769 /* iterate over all started threads */
771 for (t = threads_list_first(); t != NULL; t = threads_list_next(t)) {
772 /* print thread info */
775 threads_thread_print_info(t);
778 /* print trace of thread */
780 threads_thread_print_stacktrace(t);
783 /* unlock the threads lists */
785 threads_list_unlock();
789 /* threads_thread_print_stacktrace *********************************************
791 Print the current stacktrace of the current thread.
793 *******************************************************************************/
795 void threads_thread_print_stacktrace(threadobject *thread)
798 stacktracebuffer *stb;
801 /* mark start of dump memory area */
803 dumpsize = dump_size();
805 /* create a stacktrace for the passed thread */
807 sfi = thread->_stackframeinfo;
809 stb = stacktrace_create(sfi);
811 /* print stacktrace */
814 stacktrace_print_trace_from_buffer(stb);
816 puts("\t<<No stacktrace available>>");
820 dump_release(dumpsize);
824 /* threads_print_stacktrace ****************************************************
826 Print the current stacktrace of the current thread.
828 *******************************************************************************/
830 void threads_print_stacktrace(void)
832 threadobject *thread;
834 thread = THREADOBJECT;
836 threads_thread_print_stacktrace(thread);
841 * These are local overrides for various environment variables in Emacs.
842 * Please do not remove this and leave it at the end of the file, where
843 * Emacs will automagically detect them.
844 * ---------------------------------------------------------------------
847 * indent-tabs-mode: t
851 * vim:noexpandtab:sw=4:ts=4: