src/threads/native/threads.h

   1 /* src/threads/native/threads.h - native threads header
   2
   3    Copyright (C) 1996-2005, 2006, 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.h 7761 2007-04-19 09:18:20Z twisti $
  26
  27 */
  28
  29
  30 #ifndef _THREADS_H
  31 #define _THREADS_H
  32
  33 /* forward typedefs ***********************************************************/
  34
  35 typedef struct threadobject          threadobject;
  36 typedef union  threads_table_entry_t threads_table_entry_t;
  37 typedef struct threads_table_t       threads_table_t;
  38
  39
  40 #include "config.h"
  41
  42 #include <pthread.h>
  43 #include <ucontext.h>
  44
  45 #include "vm/types.h"
  46
  47 #include "mm/memory.h"
  48 #include "native/jni.h"
  49 #include "native/include/java_lang_Thread.h"
  50
  51 #include "threads/native/lock.h"
  52
  53 #include "vm/global.h"
  54
  55 #include "vm/jit/stacktrace.h"
  56
  57 #if defined(ENABLE_INTRP)
  58 #include "vm/jit/intrp/intrp.h"
  59 #endif
  60
  61 #if defined(__DARWIN__)
  62 # include <mach/mach.h>
  63
  64 typedef struct {
  65         pthread_mutex_t mutex;
  66         pthread_cond_t cond;
  67         int value;
  68 } sem_t;
  69
  70 #else
  71 # include <semaphore.h>
  72 #endif
  73
  74
  75 /* current threadobject *******************************************************/
  76
  77 #if defined(HAVE___THREAD)
  78
  79 #define THREADSPECIFIC    __thread
  80 #define THREADOBJECT      threads_current_threadobject
  81
  82 extern __thread threadobject *threads_current_threadobject;
  83
  84 #else /* defined(HAVE___THREAD) */
  85
  86 #define THREADSPECIFIC
  87 #define THREADOBJECT \
  88         ((threadobject *) pthread_getspecific(threads_current_threadobject_key))
  89
  90 extern pthread_key_t threads_current_threadobject_key;
  91
  92 #endif /* defined(HAVE___THREAD) */
  93
  94
  95 /* threads_table_entry_t *******************************************************
  96
  97    An entry in the global threads table.
  98
  99 *******************************************************************************/
 100
 101 union threads_table_entry_t {
 102         threadobject       *thread;        /* an existing thread                  */
 103         ptrint              nextfree;      /* next free index                     */
 104 };
 105
 106
 107 /* threads_table_t *************************************************************
 108
 109    Struct for the global threads table.
 110
 111 *******************************************************************************/
 112
 113 struct threads_table_t {
 114         threads_table_entry_t *table;      /* the table, threads[0] is the head   */
 115                                            /* of the free list. Real entries      */
 116                                                                            /* start at threads[1].                */
 117         s4                     size;       /* current size of the table           */
 118 };
 119
 120
 121 /* threadobject ****************************************************************
 122
 123    Struct holding thread local variables.
 124
 125 *******************************************************************************/
 126
 127 #define THREAD_FLAG_JAVA        0x01    /* a normal Java thread               */
 128 #define THREAD_FLAG_INTERNAL    0x02    /* CACAO internal thread              */
 129 #define THREAD_FLAG_DAEMON      0x04    /* daemon thread                      */
 130
 131
 132 struct threadobject {
 133         java_lang_Thread     *object;       /* link to java.lang.Thread object    */
 134
 135         lock_execution_env_t  ee;           /* data for the lock implementation   */
 136
 137         threadobject         *next;         /* next thread in list, or self       */
 138         threadobject         *prev;         /* prev thread in list, or self       */
 139
 140         ptrint                thinlock;     /* pre-computed thin lock value       */
 141
 142         s4                    index;        /* thread index, starting with 1      */
 143         u4                    flags;        /* flag field                         */
 144         u4                    state;        /* state field                        */
 145
 146         pthread_t             tid;          /* pthread id                         */
 147
 148 #if defined(__DARWIN__)
 149         mach_port_t           mach_thread;       /* Darwin thread id              */
 150 #endif
 151
 152         /* these are used for the wait/notify implementation                      */
 153         pthread_mutex_t       waitmutex;
 154         pthread_cond_t        waitcond;
 155
 156         bool                  interrupted;
 157         bool                  signaled;
 158         bool                  sleeping;
 159
 160         u1                   *pc;           /* current PC (used for profiling)    */
 161
 162         java_objectheader    *_exceptionptr;     /* current exception             */
 163         stackframeinfo       *_stackframeinfo;   /* current native stackframeinfo */
 164         localref_table       *_localref_table;   /* JNI local references          */
 165
 166 #if defined(ENABLE_INTRP)
 167         Cell                 *_global_sp;        /* stack pointer for interpreter */
 168 #endif
 169
 170         dumpinfo_t            dumpinfo;     /* dump memory info structure         */
 171 };
 172
 173
 174 /* exception pointer **********************************************************/
 175
 176 #define exceptionptr      (&(THREADOBJECT->_exceptionptr))
 177
 178
 179 /* stackframeinfo *************************************************************/
 180
 181 #define STACKFRAMEINFO    (THREADOBJECT->_stackframeinfo)
 182
 183
 184 /* variables ******************************************************************/
 185
 186 extern threadobject *mainthreadobj;
 187
 188
 189 /* functions ******************************************************************/
 190
 191 void threads_sem_init(sem_t *sem, bool shared, int value);
 192 void threads_sem_wait(sem_t *sem);
 193 void threads_sem_post(sem_t *sem);
 194
 195 threadobject *threads_get_current_threadobject(void);
 196
 197 void threads_preinit(void);
 198 bool threads_init(void);
 199
 200 void threads_start_thread(threadobject *thread, functionptr function);
 201
 202 void threads_set_thread_priority(pthread_t tid, int priority);
 203
 204 bool threads_attach_current_thread(JavaVMAttachArgs *vm_aargs, bool isdaemon);
 205 bool threads_detach_thread(threadobject *thread);
 206
 207 void threads_join_all_threads(void);
 208
 209 void threads_sleep(s8 millis, s4 nanos);
 210 void threads_yield(void);
 211
 212 bool threads_wait_with_timeout_relative(threadobject *t, s8 millis, s4 nanos);
 213
 214 void threads_thread_interrupt(threadobject *thread);
 215 bool threads_check_if_interrupted_and_reset(void);
 216 bool threads_thread_has_been_interrupted(threadobject *thread);
 217
 218 void threads_cast_stopworld(void);
 219 void threads_cast_startworld(void);
 220
 221 #endif /* _THREADS_H */
 222
 223
 224 /*
 225  * These are local overrides for various environment variables in Emacs.
 226  * Please do not remove this and leave it at the end of the file, where
 227  * Emacs will automagically detect them.
 228  * ---------------------------------------------------------------------
 229  * Local variables:
 230  * mode: c
 231  * indent-tabs-mode: t
 232  * c-basic-offset: 4
 233  * tab-width: 4
 234  * End:
 235  * vim:noexpandtab:sw=4:ts=4:
 236  */