* src/threads/threads-common.c (threads_thread_start_internal): Set
[cacao.git] / 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 7893 2007-05-10 13:27:29Z twisti $
26
27 */
28
29
30 #include "config.h"
31
32 #include <assert.h>
33
34 #include "vm/types.h"
35
36 #include "native/jni.h"
37
38 #include "native/include/java_lang_Object.h"
39 #include "native/include/java_lang_String.h"
40 #include "native/include/java_lang_Thread.h"
41
42 #if defined(WITH_CLASSPATH_GNU)
43 # include "native/include/java_lang_VMThread.h"
44 #endif
45
46 #include "threads/critical.h"
47 #include "threads/lock-common.h"
48 #include "threads/threads-common.h"
49
50 #include "vm/builtin.h"
51 #include "vm/stringlocal.h"
52 #include "vm/vm.h"
53
54 #include "vm/jit/stacktrace.h"
55
56 #include "vmcore/class.h"
57
58 #if defined(ENABLE_STATISTICS)
59 # include "vmcore/options.h"
60 # include "vmcore/statistics.h"
61 #endif
62
63 #include "vmcore/utf8.h"
64
65
66 /* global variables ***********************************************************/
67
68 /* global threads table */
69 static threads_table_t threads_table;
70
71
72 /* prototypes *****************************************************************/
73
74 static void threads_table_init(threadobject *mainthread);
75
76
77 /* threads_preinit *************************************************************
78
79    Do some early initialization of stuff required.
80
81    ATTENTION: Do NOT use any Java heap allocation here, as gc_init()
82    is called AFTER this function!
83
84 *******************************************************************************/
85
86 void threads_preinit(void)
87 {
88         threadobject *mainthread;
89
90         /* Initialize the threads implementation (sets the thinlock on the
91            main thread). */
92
93         threads_impl_preinit();
94
95         /* create internal thread data-structure for the main thread */
96
97         mainthread = threads_create_thread();
98
99         mainthread->object   = NULL;
100         mainthread->index    = 1;
101         mainthread->thinlock = lock_pre_compute_thinlock(mainthread->index);
102
103         /* thread is a Java thread and running */
104
105         mainthread->flags = THREAD_FLAG_JAVA;
106         mainthread->state = THREAD_STATE_RUNNABLE;
107
108         /* store the internal thread data-structure in the TSD */
109
110         threads_set_current_threadobject(mainthread);
111         
112         /* initialize the threads table with the main-thread */
113
114         threads_table_init(mainthread);
115
116         /* initialize locking subsystems */
117
118         lock_init();
119
120         /* initialize the critical section */
121
122         critical_init();
123 }
124
125
126 /* threads_table_init **********************************************************
127
128    Initialize the global threads table.  We initialize the table with
129    the main-thread, which has always the index 1.
130
131    IN:
132       mainthread....the main-thread
133
134 *******************************************************************************/
135
136 #define THREADS_INITIAL_TABLE_SIZE    8
137
138 static void threads_table_init(threadobject *mainthread)
139 {
140         threads_table_entry_t *ttemain;
141         s4                     size;
142         s4                     i;
143
144         /* initialize the threads table lock */
145
146         threads_impl_table_init();
147
148         /* initialize the table */
149
150         size = THREADS_INITIAL_TABLE_SIZE;
151
152         threads_table.table   = MNEW(threads_table_entry_t, size);
153         threads_table.size    = size;
154         threads_table.used    = 0;
155         threads_table.daemons = 0;
156
157         /* Link the entries in a freelist.  Skip 2 entries: 0 is the
158            free-list header and 1 is the main thread. */
159
160         for (i = 2; i < size; i++) {
161                 threads_table.table[i].thread = NULL;
162                 threads_table.table[i].next   = i + 1;
163         }
164
165         threads_table.table[0].next = 2;
166
167         /* terminate the freelist */
168
169         threads_table.table[size - 1].next = 0;          /* index 0 is never free */
170
171         /* insert the main-thread */
172
173         ttemain = &(threads_table.table[1]);
174
175         ttemain->thread = mainthread;
176         ttemain->next   = 0;
177
178         /* now 1 entry is used */
179
180         threads_table.used = 1;
181 }
182
183
184 /* threads_table_add ***********************************************************
185
186    Add a thread to the global threads table. The index is entered in the
187    threadobject. The thinlock value for the thread is pre-computed.
188
189    IN:
190       thread............the thread to add
191
192    RETURN VALUE:
193       The table index for the newly added thread. This value has also been
194           entered in the threadobject.
195
196 *******************************************************************************/
197
198 s4 threads_table_add(threadobject *thread)
199 {
200         threads_table_entry_t *ttefree;
201         threads_table_entry_t *ttemain;
202         threads_table_entry_t *tte;
203         s4 index;
204         s4 oldsize;
205         s4 newsize;
206         s4 i;
207
208         /* lock the threads table */
209
210         threads_table_lock();
211
212         /* get free and main entry */
213
214         ttefree = &(threads_table.table[0]);
215         ttemain = &(threads_table.table[1]);
216
217         /* get the next free index */
218
219         index = ttefree->next;
220
221         /* no entry free anymore? resize the table */
222
223         if (index == 0) {
224                 /* we must grow the table */
225
226                 oldsize = threads_table.size;
227                 newsize = oldsize * 2;
228
229                 threads_table.table = MREALLOC(threads_table.table,
230                                                                            threads_table_entry_t, oldsize, newsize);
231                 threads_table.size = newsize;
232
233                 /* the addresses have changed, get them again */
234
235                 ttefree = &(threads_table.table[0]);
236                 ttemain = &(threads_table.table[1]);
237
238                 /* link the new entries to a free list */
239
240                 for (i = oldsize; i < newsize; i++) {
241                         threads_table.table[i].thread = NULL;
242                         threads_table.table[i].next   = i + 1;
243                 }
244
245                 ttefree->next = oldsize;
246
247                 /* terminate the freelist */
248
249                 threads_table.table[newsize - 1].next = 0;   /* index 0 is never free */
250
251                 /* use the first of the new entries */
252
253                 index = ttefree->next;
254         }
255
256         /* get the entry with the assigned index */
257
258         tte = &(threads_table.table[index]);
259
260         /* store the next free index into the free-list header */
261
262         ttefree->next = tte->next;
263
264         /* store the thread in the table */
265
266         tte->thread = thread;
267
268         /* link the new entry into the used-list */
269
270         tte->next     = ttemain->next;
271         ttemain->next = index;
272
273         /* update the counters */
274
275         threads_table.used++;
276
277         if (thread->flags & THREAD_FLAG_DAEMON)
278                 threads_table.daemons++;
279
280         assert(threads_table.used < threads_table.size);
281
282         /* set the thread variables */
283
284         thread->index    = index;
285         thread->thinlock = lock_pre_compute_thinlock(index);
286
287         /* unlock the threads table */
288
289         threads_table_unlock();
290
291         return index;
292 }
293
294
295 /* threads_table_remove *******************************************************
296
297    Remove a thread from the global threads table.
298
299    IN:
300       thread............the thread to remove
301
302 ******************************************************************************/
303
304 void threads_table_remove(threadobject *thread)
305 {
306         threads_table_entry_t *ttefree;
307         threads_table_entry_t *tte;
308         s4                     index;
309         s4                     i;
310
311         /* lock the threads table */
312
313         threads_table_lock();
314
315         /* get the free entry */
316
317         ttefree = &(threads_table.table[0]);
318
319         /* get the current entry */
320
321         index = thread->index;
322         tte   = &(threads_table.table[index]);
323
324         assert(tte->thread == thread);
325
326         /* Find the entry which has the one to be removed as next entry (I
327            think it's better to do it at the removal in linear time than
328            to have a list or to do it every time we iterate over all
329            threads). */
330
331         for (i = 0; i < threads_table.size; i++) {
332                 if (threads_table.table[i].next == index) {
333                         threads_table.table[i].next = tte->next;
334                         break;
335                 }
336         }
337
338         /* clear the thread pointer in the entry */
339
340         tte->thread = NULL;
341
342         /* this entry is free now, add it to the free-list */
343
344         tte->next     = ttefree->next;
345         ttefree->next = index;
346
347         /* update the counters */
348
349         threads_table.used--;
350
351         if (thread->flags & THREAD_FLAG_DAEMON)
352                 threads_table.daemons--;
353
354         assert(threads_table.used >= 0);
355
356         /* delete the index in the threadobject to discover bugs */
357 #if !defined(NDEBUG)
358         thread->index = 0;
359 #endif
360
361         /* unlock the threads table */
362
363         threads_table_unlock();
364 }
365
366
367 /* threads_table_get ***********************************************************
368
369    Return the thread of the given table-entry index.
370
371    NOTE: It is valid to pass and index of 0, as this entry is the
372          free-list header where the thread pointer is always NULL and
373          this is thre expected behavior.
374
375    NOTE: This function does not lock the table.
376
377 *******************************************************************************/
378
379 static threadobject *threads_table_get(s4 index)
380 {
381         threadobject *thread;
382
383         /* get the requested entry */
384
385         assert((index >= 0) && (index < threads_table.size));
386
387         thread = threads_table.table[index].thread;
388
389         return thread;
390 }
391
392
393 /* threads_table_get_threads ***************************************************
394
395    Return the number of running threads.
396
397    NOTE: This function does not lock the table.
398
399 *******************************************************************************/
400
401 s4 threads_table_get_threads(void)
402 {
403         return threads_table.used;
404 }
405
406
407 /* threads_table_get_non_daemons ***********************************************
408
409    Return the number of non-daemon threads.
410
411 *******************************************************************************/
412
413 s4 threads_table_get_non_daemons(void)
414 {
415         s4 nondaemons;
416
417         /* lock the threads table */
418
419         threads_table_lock();
420
421         nondaemons = threads_table.used - threads_table.daemons;
422
423         /* unlock the threads table */
424
425         threads_table_unlock();
426
427         return nondaemons;
428 }
429
430
431 /* threads_table_first *********************************************************
432
433    Return the first thread of the threads table.
434
435    NOTE: This is always the entry with index 1 and must be the main
436          thread.
437
438    NOTE: This function does not lock the table.
439
440 *******************************************************************************/
441
442 threadobject *threads_table_first(void)
443 {
444         threadobject *thread;
445
446         /* get the requested entry */
447
448         thread = threads_table_get(1);
449
450         return thread;
451 }
452
453
454 /* threads_table_next **********************************************************
455
456    Return the next thread of the threads table relative to the passed
457    one.
458
459    NOTE: This function does not lock the table.
460
461 *******************************************************************************/
462
463 threadobject *threads_table_next(threadobject *thread)
464 {
465         threads_table_entry_t *tte;
466         threadobject          *next;
467         s4                     index;
468
469         index = thread->index;
470
471         /* get the passed entry */
472
473         assert((index > 0) && (index < threads_table.size));
474
475         tte = &(threads_table.table[index]);
476
477         /* get the requested entry */
478
479         next = threads_table_get(tte->next);
480
481         return next;
482 }
483
484
485 /* threads_table_dump *********************************************************
486
487    Dump the threads table for debugging purposes.
488
489 ******************************************************************************/
490
491 #if !defined(NDEBUG)
492 void threads_table_dump(void)
493 {
494         s4 i;
495         s4 size;
496         ptrint index;
497
498         size = threads_table.size;
499
500         log_println("threads table ==========");
501
502         log_println("size:    %d", size);
503         log_println("used:    %d", threads_table.used);
504         log_println("daemons: %d", threads_table.daemons);
505
506         for (i = 0; i < size; i++) {
507                 index = threads_table.table[i].next;
508
509                 if (threads_table.table[i].thread != NULL)
510                         log_println("%4d: thread=0x%08x, next=%d", i,
511                                                 threads_table.table[i].thread->tid, (int) index);
512                 else
513                         log_println("%4d: free, next=%d", i, (int) index);
514         }
515
516         log_println("end of threads table ==========");
517 }
518 #endif
519
520
521 /* threads_create_thread *******************************************************
522
523    Creates and initializes an internal thread data-structure.
524
525 *******************************************************************************/
526
527 threadobject *threads_create_thread(void)
528 {
529         threadobject *thread;
530
531         /* allocate internal thread data-structure */
532
533 #if defined(ENABLE_GC_BOEHM)
534         thread = GCNEW_UNCOLLECTABLE(threadobject, 1);
535 #else
536         thread = NEW(threadobject);
537 #endif
538
539 #if defined(ENABLE_STATISTICS)
540         if (opt_stat)
541                 size_threadobject += sizeof(threadobject);
542 #endif
543
544         /* initialize thread data structure */
545
546         threads_init_threadobject(thread);
547         lock_init_execution_env(thread);
548
549         return thread;
550 }
551
552
553 /* threads_thread_start_internal ***********************************************
554
555    Start an internal thread in the JVM.  No Java thread objects exists
556    so far.
557
558    IN:
559       name.......UTF-8 name of the thread
560       f..........function pointer to C function to start
561
562 *******************************************************************************/
563
564 bool threads_thread_start_internal(utf *name, functionptr f)
565 {
566         threadobject       *thread;
567         java_lang_Thread   *t;
568 #if defined(WITH_CLASSPATH_GNU)
569         java_lang_VMThread *vmt;
570 #endif
571
572         /* create internal thread data-structure */
573
574         thread = threads_create_thread();
575
576         /* create the java thread object */
577
578         t = (java_lang_Thread *) builtin_new(class_java_lang_Thread);
579
580         if (t == NULL)
581                 return false;
582
583 #if defined(WITH_CLASSPATH_GNU)
584         vmt = (java_lang_VMThread *) builtin_new(class_java_lang_VMThread);
585
586         if (vmt == NULL)
587                 return false;
588
589         vmt->thread = t;
590         vmt->vmdata = (java_lang_Object *) thread;
591
592         t->vmThread = vmt;
593 #elif defined(WITH_CLASSPATH_CLDC1_1)
594         t->vm_thread = (java_lang_Object *) thread;
595 #endif
596
597         thread->object = t;
598
599         thread->flags = THREAD_FLAG_INTERNAL | THREAD_FLAG_DAEMON;
600
601         /* set java.lang.Thread fields */
602
603         t->name     = (java_lang_String *) javastring_new(name);
604 #if defined(ENABLE_JAVASE)
605         t->daemon   = true;
606 #endif
607         t->priority = NORM_PRIORITY;
608
609         /* start the thread */
610
611         threads_impl_thread_start(thread, f);
612
613         /* everything's ok */
614
615         return true;
616 }
617
618
619 /* threads_thread_start ********************************************************
620
621    Start a Java thread in the JVM.  Only the java thread object exists
622    so far.
623
624    IN:
625       object.....the java thread object java.lang.Thread
626
627 *******************************************************************************/
628
629 void threads_thread_start(java_lang_Thread *object)
630 {
631         threadobject *thread;
632
633         /* create internal thread data-structure */
634
635         thread = threads_create_thread();
636
637         /* link the two objects together */
638
639         thread->object = object;
640
641         /* this is a normal Java thread */
642
643         thread->flags = THREAD_FLAG_JAVA;
644
645 #if defined(ENABLE_JAVASE)
646         /* is this a daemon thread? */
647
648         if (object->daemon == true)
649                 thread->flags |= THREAD_FLAG_DAEMON;
650 #endif
651
652 #if defined(WITH_CLASSPATH_GNU)
653         assert(object->vmThread);
654         assert(object->vmThread->vmdata == NULL);
655
656         object->vmThread->vmdata = (java_lang_Object *) thread;
657 #elif defined(WITH_CLASSPATH_CLDC1_1)
658         object->vm_thread = (java_lang_Object *) thread;
659 #endif
660
661         /* Start the thread.  Don't pass a function pointer (NULL) since
662            we want Thread.run()V here. */
663
664         threads_impl_thread_start(thread, NULL);
665 }
666
667
668 /* threads_get_current_tid *****************************************************
669
670    Return the tid of the current thread.
671    
672    RETURN VALUE:
673        the current tid
674
675 *******************************************************************************/
676
677 ptrint threads_get_current_tid(void)
678 {
679         threadobject *thread;
680
681         thread = THREADOBJECT;
682
683         /* this may happen during bootstrap */
684
685         if (thread == NULL)
686                 return 0;
687
688         return (ptrint) thread->tid;
689 }
690
691
692 /* threads_thread_get_state ****************************************************
693
694    Returns the current state of the given thread.
695
696 *******************************************************************************/
697
698 utf *threads_thread_get_state(threadobject *thread)
699 {
700         utf *u;
701
702         switch (thread->state) {
703         case THREAD_STATE_NEW:
704                 u = utf_new_char("NEW");
705                 break;
706         case THREAD_STATE_RUNNABLE:
707                 u = utf_new_char("RUNNABLE");
708                 break;
709         case THREAD_STATE_BLOCKED:
710                 u = utf_new_char("BLOCKED");
711                 break;
712         case THREAD_STATE_WAITING:
713                 u = utf_new_char("WAITING");
714                 break;
715         case THREAD_STATE_TIMED_WAITING:
716                 u = utf_new_char("TIMED_WAITING");
717                 break;
718         case THREAD_STATE_TERMINATED:
719                 u = utf_new_char("TERMINATED");
720                 break;
721         default:
722                 vm_abort("threads_get_state: unknown thread state %d", thread->state);
723         }
724
725         return u;
726 }
727
728
729 /* threads_thread_is_alive *****************************************************
730
731    Returns if the give thread is alive.
732
733 *******************************************************************************/
734
735 bool threads_thread_is_alive(threadobject *thread)
736 {
737         bool result;
738
739         switch (thread->state) {
740         case THREAD_STATE_NEW:
741         case THREAD_STATE_TERMINATED:
742                 result = false;
743                 break;
744
745         case THREAD_STATE_RUNNABLE:
746         case THREAD_STATE_BLOCKED:
747         case THREAD_STATE_WAITING:
748         case THREAD_STATE_TIMED_WAITING:
749                 result = true;
750                 break;
751
752         default:
753                 vm_abort("threads_is_alive: unknown thread state %d", thread->state);
754         }
755
756         return result;
757 }
758
759
760 /* threads_dump ****************************************************************
761
762    Dumps info for all threads running in the JVM.  This function is
763    called when SIGQUIT (<ctrl>-\) is sent to CACAO.
764
765 *******************************************************************************/
766
767 void threads_dump(void)
768 {
769         threadobject     *t;
770         java_lang_Thread *object;
771         utf              *name;
772
773         /* XXX we should stop the world here */
774
775         /* lock the threads table */
776
777         threads_table_lock();
778
779         printf("Full thread dump CACAO "VERSION":\n");
780
781         /* iterate over all started threads */
782
783         for (t = threads_table_first(); t != NULL; t = threads_table_next(t)) {
784                 /* get thread object */
785
786                 object = t->object;
787
788                 /* the thread may be currently in initalization, don't print it */
789
790                 if (object != NULL) {
791                         /* get thread name */
792
793 #if defined(ENABLE_JAVASE)
794                         name = javastring_toutf((java_objectheader *) object->name, false);
795 #elif defined(ENABLE_JAVAME_CLDC1_1)
796                         name = object->name;
797 #endif
798
799                         printf("\n\"");
800                         utf_display_printable_ascii(name);
801                         printf("\"");
802
803                         if (t->flags & THREAD_FLAG_DAEMON)
804                                 printf(" daemon");
805
806                         printf(" prio=%d", object->priority);
807
808 #if SIZEOF_VOID_P == 8
809                         printf(" tid=0x%016lx (%ld)", (ptrint) t->tid, (ptrint) t->tid);
810 #else
811                         printf(" tid=0x%08x (%d)", (ptrint) t->tid, (ptrint) t->tid);
812 #endif
813
814                         /* print thread state */
815
816                         switch (t->state) {
817                         case THREAD_STATE_NEW:
818                                 printf(" new");
819                                 break;
820                         case THREAD_STATE_RUNNABLE:
821                                 printf(" runnable");
822                                 break;
823                         case THREAD_STATE_BLOCKED:
824                                 printf(" blocked");
825                                 break;
826                         case THREAD_STATE_WAITING:
827                                 printf(" waiting");
828                                 break;
829                         case THREAD_STATE_TIMED_WAITING:
830                                 printf(" waiting on condition");
831                                 break;
832                         case THREAD_STATE_TERMINATED:
833                                 printf(" terminated");
834                                 break;
835                         default:
836                                 vm_abort("threads_dump: unknown thread state %d", t->state);
837                         }
838
839                         printf("\n");
840
841                         /* print trace of thread */
842
843                         threads_thread_print_stacktrace(t);
844                 }
845         }
846
847         /* unlock the threads table */
848
849         threads_table_unlock();
850 }
851
852
853 /* threads_thread_print_stacktrace *********************************************
854
855    Print the current stacktrace of the current thread.
856
857 *******************************************************************************/
858
859 void threads_thread_print_stacktrace(threadobject *thread)
860 {
861         stackframeinfo   *sfi;
862         stacktracebuffer *stb;
863         s4                dumpsize;
864
865         /* mark start of dump memory area */
866
867         dumpsize = dump_size();
868
869         /* create a stacktrace for the passed thread */
870
871         sfi = thread->_stackframeinfo;
872
873         stb = stacktrace_create(sfi);
874
875         /* print stacktrace */
876
877         if (stb != NULL)
878                 stacktrace_print_trace_from_buffer(stb);
879         else {
880                 puts("\t<<No stacktrace available>>");
881                 fflush(stdout);
882         }
883
884         dump_release(dumpsize);
885 }
886
887
888 /* threads_print_stacktrace ****************************************************
889
890    Print the current stacktrace of the current thread.
891
892 *******************************************************************************/
893
894 void threads_print_stacktrace(void)
895 {
896         threadobject *thread;
897
898         thread = THREADOBJECT;
899
900         threads_thread_print_stacktrace(thread);
901 }
902
903
904 /*
905  * These are local overrides for various environment variables in Emacs.
906  * Please do not remove this and leave it at the end of the file, where
907  * Emacs will automagically detect them.
908  * ---------------------------------------------------------------------
909  * Local variables:
910  * mode: c
911  * indent-tabs-mode: t
912  * c-basic-offset: 4
913  * tab-width: 4
914  * End:
915  * vim:noexpandtab:sw=4:ts=4:
916  */