src/threads/posix/thread-posix.hpp

   1 /* src/threads/posix/thread-posix.hpp - 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_HPP
  27 #define _THREAD_POSIX_HPP
  28
  29 #include "config.h"
  30
  31 #include <pthread.h>
  32 #include <ucontext.h>
  33
  34 #include "vm/types.h"
  35
  36
  37 // Includes required by Thread.
  38
  39 #if defined(ENABLE_TLH)
  40 # include "mm/tlh.h"
  41 #endif
  42
  43 #include "threads/condition.hpp"
  44 #include "threads/mutex.hpp"
  45
  46 #include "vm/global.h"
  47
  48
  49 /* threadobject ****************************************************************
  50
  51    Struct holding thread local variables.
  52
  53 *******************************************************************************/
  54
  55 #define THREAD_FLAG_JAVA        0x01    /* a normal Java thread               */
  56 #define THREAD_FLAG_INTERNAL    0x02    /* CACAO internal thread              */
  57 #define THREAD_FLAG_DAEMON      0x04    /* daemon thread                      */
  58 #define THREAD_FLAG_IN_NATIVE   0x08    /* currently executing native code    */
  59
  60 #define SUSPEND_REASON_JNI       1      /* suspended from JNI                 */
  61 #define SUSPEND_REASON_STOPWORLD 2      /* suspended from stop-thw-world      */
  62
  63
  64 typedef struct threadobject threadobject;
  65
  66 struct threadobject {
  67         java_object_t        *object;       /* link to java.lang.Thread object    */
  68
  69         ptrint                thinlock;     /* pre-computed thin lock value       */
  70
  71         s4                    index;        /* thread index, starting with 1      */
  72         u4                    flags;        /* flag field                         */
  73         u4                    state;        /* state field                        */
  74
  75         pthread_t             tid;          /* pthread id                         */
  76
  77 #if defined(__DARWIN__)
  78         mach_port_t           mach_thread;       /* Darwin thread id              */
  79 #endif
  80
  81         /* for the sable tasuki lock extension */
  82         bool                  flc_bit;
  83         struct threadobject  *flc_list;     /* FLC list head for this thread      */
  84         struct threadobject  *flc_tail;     /* tail pointer for FLC list          */
  85         struct threadobject  *flc_next;     /* next pointer for FLC list          */
  86         java_handle_t        *flc_object;
  87         Mutex*                flc_lock;     /* controlling access to these fields */
  88         Condition*            flc_cond;
  89
  90         /* these are used for the wait/notify implementation                      */
  91         Mutex*                waitmutex;
  92         Condition*            waitcond;
  93
  94         Mutex*                suspendmutex; /* lock before suspending this thread */
  95         Condition*            suspendcond;  /* notify to resume this thread       */
  96
  97         bool                  interrupted;
  98         bool                  signaled;
  99
 100         bool                  suspended;    /* is this thread suspended?          */
 101         s4                    suspend_reason; /* reason for suspending            */
 102
 103         u1                   *pc;           /* current PC (used for profiling)    */
 104
 105         java_object_t        *_exceptionptr;     /* current exception             */
 106         struct stackframeinfo_t     *_stackframeinfo;   /* current native stackframeinfo */
 107         struct localref_table       *_localref_table;   /* JNI local references          */
 108
 109 #if defined(ENABLE_INTRP)
 110         Cell                 *_global_sp;        /* stack pointer for interpreter */
 111 #endif
 112
 113 #if defined(ENABLE_GC_CACAO)
 114         bool                  gc_critical;  /* indicates a critical section       */
 115
 116         sourcestate_t        *ss;
 117         executionstate_t     *es;
 118 #endif
 119
 120         struct DumpMemory*    _dumpmemory;     ///< Dump memory structure.
 121
 122 #if defined(ENABLE_DEBUG_FILTER)
 123         u2                    filterverbosecallctr[2]; /* counters for verbose call filter */
 124 #endif
 125
 126 #if !defined(NDEBUG)
 127         s4                    tracejavacallindent;
 128         u4                    tracejavacallcount;
 129 #endif
 130
 131 #if defined(ENABLE_TLH)
 132         tlh_t                 tlh;
 133 #endif
 134
 135 #if defined(ENABLE_ESCAPE_REASON)
 136         void *escape_reasons;
 137 #endif
 138 };
 139
 140
 141 /* current threadobject *******************************************************/
 142
 143 #if defined(HAVE___THREAD)
 144
 145 #define THREADOBJECT      thread_current
 146
 147 extern __thread threadobject *thread_current;
 148
 149 #else /* defined(HAVE___THREAD) */
 150
 151 #define THREADOBJECT \
 152         ((threadobject *) pthread_getspecific(thread_current_key))
 153
 154 extern pthread_key_t thread_current_key;
 155
 156 #endif /* defined(HAVE___THREAD) */
 157
 158
 159 /* native-world flags *********************************************************/
 160
 161 #if defined(ENABLE_GC_CACAO)
 162 # define THREAD_NATIVEWORLD_ENTER THREADOBJECT->flags |=  THREAD_FLAG_IN_NATIVE
 163 # define THREAD_NATIVEWORLD_EXIT  THREADOBJECT->flags &= ~THREAD_FLAG_IN_NATIVE
 164 #else
 165 # define THREAD_NATIVEWORLD_ENTER /*nop*/
 166 # define THREAD_NATIVEWORLD_EXIT  /*nop*/
 167 #endif
 168
 169
 170 /* counter for verbose call filter ********************************************/
 171
 172 #if defined(ENABLE_DEBUG_FILTER)
 173 #       define FILTERVERBOSECALLCTR (THREADOBJECT->filterverbosecallctr)
 174 #endif
 175
 176 /* state for trace java call **************************************************/
 177
 178 #if !defined(NDEBUG)
 179 #       define TRACEJAVACALLINDENT (THREADOBJECT->tracejavacallindent)
 180 #       define TRACEJAVACALLCOUNT (THREADOBJECT->tracejavacallcount)
 181 #endif
 182
 183
 184 // FIXME
 185 #ifdef __cplusplus
 186 extern "C" {
 187 #endif
 188 inline static threadobject* thread_get_current(void);
 189 #ifdef __cplusplus
 190 }
 191 #endif
 192
 193
 194 // Includes.
 195 #include "mm/memory.h"
 196
 197 #include "native/localref.hpp"
 198
 199 #include "threads/lock.hpp"
 200
 201 #include "vm/global.h"
 202 #include "vm/vm.hpp"
 203
 204 #if defined(ENABLE_GC_CACAO)
 205 # include "vm/jit/executionstate.h"
 206 # include "vm/jit/replace.hpp"
 207 #endif
 208
 209 #if defined(ENABLE_INTRP)
 210 #include "vm/jit/intrp/intrp.h"
 211 #endif
 212
 213 #if defined(__DARWIN__)
 214 # include <mach/mach.h>
 215
 216 typedef struct {
 217         Mutex* mutex;
 218         Condition* cond;
 219         int value;
 220 } sem_t;
 221
 222 #else
 223 # include <semaphore.h>
 224 #endif
 225
 226
 227 // FIXME
 228 #ifdef __cplusplus
 229 extern "C" {
 230 #endif
 231
 232 /* inline functions ***********************************************************/
 233
 234 /**
 235  * Return the Thread object of the current thread.
 236  *
 237  * @return The current Thread object.
 238  */
 239 inline static threadobject* thread_get_current(void)
 240 {
 241         threadobject *t;
 242
 243 #if defined(HAVE___THREAD)
 244         t = thread_current;
 245 #else
 246         t = (threadobject *) pthread_getspecific(thread_current_key);
 247 #endif
 248
 249         return t;
 250 }
 251
 252
 253 /**
 254  * Set the current Thread object.
 255  *
 256  * @param t The thread object to set.
 257  */
 258 inline static void thread_set_current(threadobject* t)
 259 {
 260 #if defined(HAVE___THREAD)
 261         thread_current = t;
 262 #else
 263         int result;
 264
 265         result = pthread_setspecific(thread_current_key, t);
 266
 267         if (result != 0)
 268                 vm_abort_errnum(result, "thread_set_current: pthread_setspecific failed");
 269 #endif
 270 }
 271
 272
 273 inline static struct stackframeinfo_t* threads_get_current_stackframeinfo(void)
 274 {
 275         return THREADOBJECT->_stackframeinfo;
 276 }
 277
 278 inline static void threads_set_current_stackframeinfo(struct stackframeinfo_t* sfi)
 279 {
 280         THREADOBJECT->_stackframeinfo = sfi;
 281 }
 282
 283
 284 /* functions ******************************************************************/
 285
 286 void threads_sem_init(sem_t *sem, bool shared, int value);
 287 void threads_sem_wait(sem_t *sem);
 288 void threads_sem_post(sem_t *sem);
 289
 290 void threads_start_thread(threadobject *thread, functionptr function);
 291
 292 void threads_set_thread_priority(pthread_t tid, int priority);
 293
 294 #if defined(ENABLE_GC_CACAO)
 295 bool threads_suspend_thread(threadobject *thread, s4 reason);
 296 void threads_suspend_ack(u1* pc, u1* sp);
 297 bool threads_resume_thread(threadobject *thread);
 298 #endif
 299
 300 void threads_join_all_threads(void);
 301
 302 void threads_sleep(int64_t millis, int32_t nanos);
 303
 304 void threads_wait_with_timeout_relative(threadobject *t, s8 millis, s4 nanos);
 305
 306 void threads_thread_interrupt(threadobject *thread);
 307
 308 #if defined(ENABLE_TLH)
 309 void threads_tlh_add_frame();
 310 void threads_tlh_remove_frame();
 311 #endif
 312
 313 #ifdef __cplusplus
 314 } // extern "C"
 315 #endif
 316
 317 #endif // _THREAD_POSIX_HPP
 318
 319
 320 /*
 321  * These are local overrides for various environment variables in Emacs.
 322  * Please do not remove this and leave it at the end of the file, where
 323  * Emacs will automagically detect them.
 324  * ---------------------------------------------------------------------
 325  * Local variables:
 326  * mode: c++
 327  * indent-tabs-mode: t
 328  * c-basic-offset: 4
 329  * tab-width: 4
 330  * End:
 331  * vim:noexpandtab:sw=4:ts=4:
 332  */