src/threads/threads-common.h

   1 /* src/threads/threads-common.h - 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 */
  26
  27
  28 #ifndef _THREADS_COMMON_H
  29 #define _THREADS_COMMON_H
  30
  31 #include "config.h"
  32 #include "vm/types.h"
  33
  34 #include "vm/global.h"
  35
  36 #include "native/llni.h"
  37
  38 #if defined(ENABLE_THREADS)
  39 # include "threads/native/threads.h"
  40 #else
  41 # include "threads/none/threads.h"
  42 #endif
  43
  44 #include "vmcore/utf8.h"
  45
  46
  47 /* only define the following stuff with thread enabled ************************/
  48
  49 #if defined(ENABLE_THREADS)
  50
  51 /* thread states **************************************************************/
  52
  53 #define THREAD_STATE_NEW              0
  54 #define THREAD_STATE_RUNNABLE         1
  55 #define THREAD_STATE_BLOCKED          2
  56 #define THREAD_STATE_WAITING          3
  57 #define THREAD_STATE_TIMED_WAITING    4
  58 #define THREAD_STATE_TERMINATED       5
  59
  60
  61 /* thread priorities **********************************************************/
  62
  63 #define MIN_PRIORITY     1
  64 #define NORM_PRIORITY    5
  65 #define MAX_PRIORITY     10
  66
  67
  68 /* debug **********************************************************************/
  69
  70 #if !defined(NDEBUG)
  71 # define DEBUGTHREADS(message, thread) \
  72         do { \
  73                 if (opt_DebugThreads) { \
  74                         printf("[Thread %-16s: ", message); \
  75                         threads_thread_print_info(thread); \
  76                         printf("]\n"); \
  77                 } \
  78         } while (0)
  79 #else
  80 # define DEBUGTHREADS(message, thread)
  81 #endif
  82
  83
  84 #if defined(__LINUX__)
  85 /* XXX Remove for exact-GC. */
  86 extern bool threads_pthreads_implementation_nptl;
  87 #endif
  88
  89
  90 /* inline functions ***********************************************************/
  91
  92 /* threads_thread_get_object ***************************************************
  93
  94    Return the java.lang.Thread object for the given thread.
  95
  96 *******************************************************************************/
  97
  98 static inline java_handle_t *threads_thread_get_object(threadobject *t)
  99 {
 100         return LLNI_WRAP(t->object);
 101 }
 102
 103
 104 /* threads_thread_set_object ***************************************************
 105
 106    Set the java.lang.Thread object for the given thread.
 107
 108 *******************************************************************************/
 109
 110 static inline void threads_thread_set_object(threadobject *t, java_handle_t *object)
 111 {
 112         t->object = LLNI_DIRECT(object);
 113 }
 114
 115
 116 /* function prototypes ********************************************************/
 117
 118 void          threads_preinit(void);
 119
 120 threadobject *threads_list_first(void);
 121 threadobject *threads_list_next(threadobject *t);
 122 s4            threads_list_get_non_daemons(void);
 123
 124 threadobject *threads_thread_new(void);
 125 void          threads_thread_free(threadobject *t);
 126
 127 bool          threads_thread_start_internal(utf *name, functionptr f);
 128 void          threads_thread_start(java_handle_t *object);
 129
 130 void          threads_thread_print_info(threadobject *t);
 131
 132 ptrint        threads_get_current_tid(void);
 133
 134 void          threads_thread_state_runnable(threadobject *t);
 135 void          threads_thread_state_waiting(threadobject *t);
 136 void          threads_thread_state_timed_waiting(threadobject *t);
 137 void          threads_thread_state_terminated(threadobject *t);
 138 utf          *threads_thread_get_state(threadobject *t);
 139
 140 bool          threads_thread_is_alive(threadobject *t);
 141
 142 void          threads_dump(void);
 143 void          threads_thread_print_stacktrace(threadobject *thread);
 144 void          threads_print_stacktrace(void);
 145
 146
 147 /* implementation specific functions */
 148
 149 void          threads_impl_preinit(void);
 150
 151 void          threads_list_lock(void);
 152 void          threads_list_unlock(void);
 153
 154 #if defined(ENABLE_GC_CACAO)
 155 void          threads_mutex_gc_lock(void);
 156 void          threads_mutex_gc_unlock(void);
 157 #endif
 158
 159 void          threads_mutex_join_lock(void);
 160 void          threads_mutex_join_unlock(void);
 161
 162 void          threads_set_current_threadobject(threadobject *thread);
 163 void          threads_impl_thread_new(threadobject *t);
 164 void          threads_impl_thread_free(threadobject *t);
 165 void          threads_impl_thread_start(threadobject *thread, functionptr f);
 166
 167 void          threads_yield(void);
 168
 169 #endif /* ENABLE_THREADS */
 170
 171 #endif /* _THREADS_COMMON_H */
 172
 173
 174 /*
 175  * These are local overrides for various environment variables in Emacs.
 176  * Please do not remove this and leave it at the end of the file, where
 177  * Emacs will automagically detect them.
 178  * ---------------------------------------------------------------------
 179  * Local variables:
 180  * mode: c
 181  * indent-tabs-mode: t
 182  * c-basic-offset: 4
 183  * tab-width: 4
 184  * End:
 185  * vim:noexpandtab:sw=4:ts=4:
 186  */