src/threads/posix/thread-posix.h

   1 /* src/threads/posix/thread-posix.h - POSIX thread functions
   2
   3    Copyright (C) 1996-2005, 2006, 2007, 2008
   4    CACAOVM - Verein zur Foerderung der freien virtuellen Maschine CACAO
   5
   6    This file is part of CACAO.
   7
   8    This program is free software; you can redistribute it and/or
   9    modify it under the terms of the GNU General Public License as
  10    published by the Free Software Foundation; either version 2, or (at
  11    your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22
  23 */
  24
  25
  26 #ifndef _THREAD_POSIX_H
  27 #define _THREAD_POSIX_H
  28
  29 /* forward typedefs ***********************************************************/
  30
  31 typedef struct threadobject threadobject;
  32
  33
  34 #include "config.h"
  35
  36 #include <pthread.h>
  37 #include <ucontext.h>
  38
  39 #include "vm/types.h"
  40
  41 #include "mm/memory.h"
  42
  43 #include "native/localref.h"
  44
  45 #include "threads/mutex.h"
  46
  47 #include "threads/posix/lock.h"
  48
  49 #include "vm/global.h"
  50 #include "vm/vm.h"
  51
  52 #if defined(ENABLE_GC_CACAO)
  53 # include "vm/jit/replace.h"
  54 #endif
  55
  56 #include "vm/jit/stacktrace.h"
  57
  58 #if defined(ENABLE_INTRP)
  59 #include "vm/jit/intrp/intrp.h"
  60 #endif
  61
  62 #if defined(__DARWIN__)
  63 # include <mach/mach.h>
  64
  65 typedef struct {
  66         mutex_t mutex;
  67         pthread_cond_t cond;
  68         int value;
  69 } sem_t;
  70
  71 #else
  72 # include <semaphore.h>
  73 #endif
  74
  75
  76 /* current threadobject *******************************************************/
  77
  78 #if defined(HAVE___THREAD)
  79
  80 #define THREADSPECIFIC    __thread
  81 #define THREADOBJECT      thread_current
  82
  83 extern __thread threadobject *thread_current;
  84
  85 #else /* defined(HAVE___THREAD) */
  86
  87 #define THREADSPECIFIC
  88 #define THREADOBJECT \
  89         ((threadobject *) pthread_getspecific(thread_current_key))
  90
  91 extern pthread_key_t thread_current_key;
  92
  93 #endif /* defined(HAVE___THREAD) */
  94
  95
  96 /* threadobject ****************************************************************
  97
  98    Struct holding thread local variables.
  99
 100 *******************************************************************************/
 101
 102 #define THREAD_FLAG_JAVA        0x01    /* a normal Java thread               */
 103 #define THREAD_FLAG_INTERNAL    0x02    /* CACAO internal thread              */
 104 #define THREAD_FLAG_DAEMON      0x04    /* daemon thread                      */
 105 #define THREAD_FLAG_IN_NATIVE   0x08    /* currently executing native code    */
 106
 107 #define SUSPEND_REASON_JNI       1      /* suspended from JNI                 */
 108 #define SUSPEND_REASON_STOPWORLD 2      /* suspended from stop-thw-world      */
 109
 110
 111 struct threadobject {
 112         java_object_t        *object;       /* link to java.lang.Thread object    */
 113
 114         ptrint                thinlock;     /* pre-computed thin lock value       */
 115
 116         s4                    index;        /* thread index, starting with 1      */
 117         u4                    flags;        /* flag field                         */
 118         u4                    state;        /* state field                        */
 119
 120         pthread_t             tid;          /* pthread id                         */
 121
 122 #if defined(__DARWIN__)
 123         mach_port_t           mach_thread;       /* Darwin thread id              */
 124 #endif
 125
 126         /* for the sable tasuki lock extension */
 127         bool                  flc_bit;
 128         struct threadobject  *flc_list;     /* FLC list head for this thread      */
 129         struct threadobject  *flc_next;     /* next pointer for FLC list          */
 130         java_handle_t        *flc_object;
 131         mutex_t               flc_lock;     /* controlling access to these fields */
 132         pthread_cond_t        flc_cond;
 133
 134         /* these are used for the wait/notify implementation                      */
 135         mutex_t               waitmutex;
 136         pthread_cond_t        waitcond;
 137
 138         mutex_t               suspendmutex; /* lock before suspending this thread */
 139         pthread_cond_t        suspendcond;  /* notify to resume this thread       */
 140
 141         bool                  interrupted;
 142         bool                  signaled;
 143         bool                  sleeping;
 144
 145         bool                  suspended;    /* is this thread suspended?          */
 146         s4                    suspend_reason; /* reason for suspending            */
 147
 148         u1                   *pc;           /* current PC (used for profiling)    */
 149
 150         java_object_t        *_exceptionptr;     /* current exception             */
 151         stackframeinfo_t     *_stackframeinfo;   /* current native stackframeinfo */
 152         localref_table       *_localref_table;   /* JNI local references          */
 153
 154 #if defined(ENABLE_INTRP)
 155         Cell                 *_global_sp;        /* stack pointer for interpreter */
 156 #endif
 157
 158 #if defined(ENABLE_GC_CACAO)
 159         bool                  gc_critical;  /* indicates a critical section       */
 160
 161         sourcestate_t        *ss;
 162         executionstate_t     *es;
 163 #endif
 164
 165         dumpinfo_t            dumpinfo;     /* dump memory info structure         */
 166
 167 #if defined(ENABLE_DEBUG_FILTER)
 168         u2                    filterverbosecallctr[2]; /* counters for verbose call filter */
 169 #endif
 170
 171 #if !defined(NDEBUG)
 172         s4                    tracejavacallindent;
 173         u4                    tracejavacallcount;
 174 #endif
 175
 176         listnode_t            linkage;      /* threads-list                       */
 177         listnode_t            linkage_free; /* free-list                          */
 178 };
 179
 180
 181 /* native-world flags *********************************************************/
 182
 183 #if defined(ENABLE_GC_CACAO)
 184 # define THREAD_NATIVEWORLD_ENTER THREADOBJECT->flags |=  THREAD_FLAG_IN_NATIVE
 185 # define THREAD_NATIVEWORLD_EXIT  THREADOBJECT->flags &= ~THREAD_FLAG_IN_NATIVE
 186 #else
 187 # define THREAD_NATIVEWORLD_ENTER /*nop*/
 188 # define THREAD_NATIVEWORLD_EXIT  /*nop*/
 189 #endif
 190
 191
 192 /* counter for verbose call filter ********************************************/
 193
 194 #if defined(ENABLE_DEBUG_FILTER)
 195 #       define FILTERVERBOSECALLCTR (THREADOBJECT->filterverbosecallctr)
 196 #endif
 197
 198 /* state for trace java call **************************************************/
 199
 200 #if !defined(NDEBUG)
 201 #       define TRACEJAVACALLINDENT (THREADOBJECT->tracejavacallindent)
 202 #       define TRACEJAVACALLCOUNT (THREADOBJECT->tracejavacallcount)
 203 #endif
 204
 205
 206 /* inline functions ***********************************************************/
 207
 208 /* thread_get_current **********************************************************
 209
 210    Return the threadobject of the current thread.
 211
 212    RETURN:
 213        the current threadobject *
 214
 215 *******************************************************************************/
 216
 217 inline static threadobject *thread_get_current(void)
 218 {
 219         threadobject *t;
 220
 221 #if defined(HAVE___THREAD)
 222         t = thread_current;
 223 #else
 224         t = (threadobject *) pthread_getspecific(thread_current_key);
 225 #endif
 226
 227         return t;
 228 }
 229
 230
 231 /* thread_set_current **********************************************************
 232
 233    Set the current thread object.
 234
 235    IN:
 236       t ... the thread object to set
 237
 238 *******************************************************************************/
 239
 240 inline static void thread_set_current(threadobject *t)
 241 {
 242 #if defined(HAVE___THREAD)
 243         thread_current = t;
 244 #else
 245         int result;
 246
 247         result = pthread_setspecific(thread_current_key, t);
 248
 249         if (result != 0)
 250                 vm_abort_errnum(result, "thread_set_current: pthread_setspecific failed");
 251 #endif
 252 }
 253
 254
 255 inline static stackframeinfo_t *threads_get_current_stackframeinfo(void)
 256 {
 257         return THREADOBJECT->_stackframeinfo;
 258 }
 259
 260 inline static void threads_set_current_stackframeinfo(stackframeinfo_t *sfi)
 261 {
 262         THREADOBJECT->_stackframeinfo = sfi;
 263 }
 264
 265
 266 /* functions ******************************************************************/
 267
 268 void threads_sem_init(sem_t *sem, bool shared, int value);
 269 void threads_sem_wait(sem_t *sem);
 270 void threads_sem_post(sem_t *sem);
 271
 272 void threads_start_thread(threadobject *thread, functionptr function);
 273
 274 void threads_set_thread_priority(pthread_t tid, int priority);
 275
 276 bool threads_detach_thread(threadobject *thread);
 277
 278 #if defined(ENABLE_GC_CACAO)
 279 bool threads_suspend_thread(threadobject *thread, s4 reason);
 280 void threads_suspend_ack(u1* pc, u1* sp);
 281 bool threads_resume_thread(threadobject *thread);
 282 #endif
 283
 284 void threads_join_all_threads(void);
 285
 286 void threads_sleep(int64_t millis, int32_t nanos);
 287
 288 void threads_wait_with_timeout_relative(threadobject *t, s8 millis, s4 nanos);
 289
 290 void threads_thread_interrupt(threadobject *thread);
 291
 292 #endif /* _THREAD_POSIX_H */
 293
 294
 295 /*
 296  * These are local overrides for various environment variables in Emacs.
 297  * Please do not remove this and leave it at the end of the file, where
 298  * Emacs will automagically detect them.
 299  * ---------------------------------------------------------------------
 300  * Local variables:
 301  * mode: c
 302  * indent-tabs-mode: t
 303  * c-basic-offset: 4
 304  * tab-width: 4
 305  * End:
 306  * vim:noexpandtab:sw=4:ts=4:
 307  */