* Removed all Id tags.
[cacao.git] / src / threads / native / threads.h
index 4dade8c93473343a5a138727dc0c9eaf95896820..417b273d1849ff2236f6a5fe6b4dc10d7cfc5d9c 100644 (file)
@@ -1,9 +1,9 @@
 /* src/threads/native/threads.h - native threads header
 
-   Copyright (C) 1996-2005 R. Grafl, A. Krall, C. Kruegel, C. Oates,
-   R. Obermaisser, M. Platter, M. Probst, S. Ring, E. Steiner,
-   C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich, J. Wenninger,
-   Institut f. Computersprachen - TU Wien
+   Copyright (C) 1996-2005, 2006, 2007 R. Grafl, A. Krall, C. Kruegel,
+   C. Oates, R. Obermaisser, M. Platter, M. Probst, S. Ring,
+   E. Steiner, C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich,
+   J. Wenninger, Institut f. Computersprachen - TU Wien
 
    This file is part of CACAO.
 
 
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
-   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
-   02111-1307, USA.
+   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+   02110-1301, USA.
 
-   Contact: cacao@complang.tuwien.ac.at
+*/
 
-   Authors: Stefan Ring
 
-   Changes: Christian Thalinger
+#ifndef _THREADS_H
+#define _THREADS_H
 
-   $Id: threads.h 3830 2005-12-01 23:07:33Z twisti $
+/* forward typedefs ***********************************************************/
 
-*/
+typedef struct threadobject threadobject;
 
 
-#ifndef _THREADS_H
-#define _THREADS_H
+#include "config.h"
 
 #include <pthread.h>
-#include <semaphore.h>
 #include <ucontext.h>
 
-#include "config.h"
-#include "vm/types.h"
-
-#include "config.h"
 #include "vm/types.h"
 
 #include "mm/memory.h"
 #include "native/jni.h"
-#include "native/include/java_lang_Object.h" /* required by java/lang/VMThread*/
+#include "native/localref.h"
 #include "native/include/java_lang_Thread.h"
-#include "native/include/java_lang_VMThread.h"
+
+#include "threads/native/lock.h"
+
 #include "vm/global.h"
 
+#include "vm/jit/stacktrace.h"
+
+#if defined(ENABLE_INTRP)
+#include "vm/jit/intrp/intrp.h"
+#endif
+
 #if defined(__DARWIN__)
-#include <mach/mach.h>
+# include <mach/mach.h>
 
-/* We need to emulate recursive mutexes. */
-#define MUTEXSIM
+typedef struct {
+       pthread_mutex_t mutex;
+       pthread_cond_t cond;
+       int value;
+} sem_t;
+
+#else
+# include <semaphore.h>
 #endif
 
 
+/* current threadobject *******************************************************/
+
 #if defined(HAVE___THREAD)
 
 #define THREADSPECIFIC    __thread
-#define THREADOBJECT      ((java_lang_VMThread*) threadobj)
-#define THREADINFO        (&threadobj->info)
+#define THREADOBJECT      threads_current_threadobject
 
-extern __thread threadobject *threadobj;
+extern __thread threadobject *threads_current_threadobject;
 
 #else /* defined(HAVE___THREAD) */
 
 #define THREADSPECIFIC
-#define THREADOBJECT ((java_lang_VMThread*) pthread_getspecific(tkey_threadinfo))
-#define THREADINFO (&((threadobject*) pthread_getspecific(tkey_threadinfo))->info)
+#define THREADOBJECT \
+       ((threadobject *) pthread_getspecific(threads_current_threadobject_key))
 
-extern pthread_key_t tkey_threadinfo;
+extern pthread_key_t threads_current_threadobject_key;
 
 #endif /* defined(HAVE___THREAD) */
 
 
-/* typedefs *******************************************************************/
+/* threadobject ****************************************************************
 
-typedef struct ExecEnvironment ExecEnvironment;
-typedef struct nativethread nativethread;
-typedef struct threadobject threadobject;
-typedef struct monitorLockRecord monitorLockRecord;
-typedef struct lockRecordPoolHeader lockRecordPoolHeader;
-typedef struct lockRecordPool lockRecordPool;
-typedef java_lang_Thread thread;
+   Struct holding thread local variables.
+
+*******************************************************************************/
 
+#define THREAD_FLAG_JAVA        0x01    /* a normal Java thread               */
+#define THREAD_FLAG_INTERNAL    0x02    /* CACAO internal thread              */
+#define THREAD_FLAG_DAEMON      0x04    /* daemon thread                      */
 
-/* ExecEnvironment *************************************************************
 
-   Monitor lock implementation
+struct threadobject {
+       java_lang_Thread     *object;       /* link to java.lang.Thread object    */
 
-*******************************************************************************/
+       ptrint                thinlock;     /* pre-computed thin lock value       */
 
-struct ExecEnvironment {
-       monitorLockRecord *firstLR;
-       lockRecordPool    *lrpool;
-       int                numlr;
-};
+       s4                    index;        /* thread index, starting with 1      */
+       u4                    flags;        /* flag field                         */
+       u4                    state;        /* state field                        */
 
+       pthread_t             tid;          /* pthread id                         */
 
-struct nativethread {
-       threadobject      *next;
-       threadobject      *prev;
-       java_objectheader *_exceptionptr;
-       void              *_stackframeinfo;
-       localref_table    *_localref_table; /* JNI local references               */
-#if defined(ENABLE_INTRP)
-       void              *_global_sp;
-#endif
-       pthread_t          tid;
 #if defined(__DARWIN__)
-       mach_port_t        mach_thread;
+       mach_port_t           mach_thread;       /* Darwin thread id              */
 #endif
-       pthread_mutex_t    joinMutex;
-       pthread_cond_t     joinCond;
-};
-
-
-/* threadobject ****************************************************************
 
-   Every java.lang.VMThread object is actually an instance of this structure.
+       /* these are used for the wait/notify implementation                      */
+       pthread_mutex_t       waitmutex;
+       pthread_cond_t        waitcond;
 
-*******************************************************************************/
+       bool                  interrupted;
+       bool                  signaled;
+       bool                  sleeping;
 
-struct threadobject {
-       java_lang_VMThread  o;
-       nativethread        info;           /* some general pthreads stuff        */
-       ExecEnvironment     ee;             /* contains our lock record pool      */
+       u1                   *pc;           /* current PC (used for profiling)    */
 
-       /* these are used for the wait/notify implementation                      */
-       pthread_mutex_t     waitLock;
-       pthread_cond_t      waitCond;
-       bool                interrupted;
-       bool                signaled;
-       bool                isSleeping;
+       java_object_t        *_exceptionptr;     /* current exception             */
+       stackframeinfo       *_stackframeinfo;   /* current native stackframeinfo */
+       localref_table       *_localref_table;   /* JNI local references          */
 
-       dumpinfo            dumpinfo;       /* dump memory info structure         */
-};
+#if defined(ENABLE_INTRP)
+       Cell                 *_global_sp;        /* stack pointer for interpreter */
+#endif
 
-/* monitorLockRecord ***********************************************************
+       dumpinfo_t            dumpinfo;     /* dump memory info structure         */
 
-   This is the really interesting stuff.
-   See handbook for a detailed description.
+#if defined(ENABLE_DEBUG_FILTER)
+       u2                    filterverbosecallctr[2]; /* counters for verbose call filter */
+#endif
 
-*******************************************************************************/
+#if !defined(NDEBUG)
+       s4                    tracejavacallindent;
+       u4                    tracejavacallcount;
+#endif
 
-struct monitorLockRecord {
-       threadobject      *ownerThread;
-       java_objectheader *o;
-       s4                 lockCount;
-       monitorLockRecord *nextFree;
-       s4                 queuers;
-       monitorLockRecord *waiter;
-       monitorLockRecord *incharge;
-       bool               waiting;
-       sem_t              queueSem;
-       pthread_mutex_t    resolveLock;
-       pthread_cond_t     resolveWait;
+       listnode_t            linkage;      /* threads-list                       */
 };
 
 
-struct lockRecordPoolHeader {
-       lockRecordPool *next;
-       int             size;
-}; 
+/* exception pointer **********************************************************/
 
-struct lockRecordPool {
-       lockRecordPoolHeader header;
-       monitorLockRecord    lr[1];
-};
+#define exceptionptr      (&(THREADOBJECT->_exceptionptr))
 
 
-monitorLockRecord *monitorEnter(threadobject *, java_objectheader *);
-bool monitorExit(threadobject *, java_objectheader *);
+/* stackframeinfo *************************************************************/
 
-bool threadHoldsLock(threadobject *t, java_objectheader *o);
-void signal_cond_for_object(java_objectheader *obj);
-void broadcast_cond_for_object(java_objectheader *obj);
-void wait_cond_for_object(java_objectheader *obj, s8 time, s4 nanos);
+#define STACKFRAMEINFO    (THREADOBJECT->_stackframeinfo)
 
-void *thread_getself(void);
+/* counter for verbose call filter ********************************************/
 
-void threads_preinit(void);
-bool threads_init(u1 *stackbottom);
+#if defined(ENABLE_DEBUG_FILTER)
+#      define FILTERVERBOSECALLCTR (THREADOBJECT->filterverbosecallctr)
+#endif
 
-void initObjectLock(java_objectheader *);
-monitorLockRecord *get_dummyLR(void);
-void initLocks();
-void initThread(java_lang_VMThread *);
+/* state for trace java call **************************************************/
 
-/* start a thread */
-void threads_start_thread(thread *t, functionptr function);
+#if !defined(NDEBUG)
+#      define TRACEJAVACALLINDENT (THREADOBJECT->tracejavacallindent)
+#      define TRACEJAVACALLCOUNT (THREADOBJECT->tracejavacallcount)
+#endif
 
-void joinAllThreads();
+/* functions ******************************************************************/
 
-void sleepThread(s8 millis, s4 nanos);
-void yieldThread();
+void threads_sem_init(sem_t *sem, bool shared, int value);
+void threads_sem_wait(sem_t *sem);
+void threads_sem_post(sem_t *sem);
 
-void setPriorityThread(thread *t, s4 priority);
+threadobject *threads_get_current_threadobject(void);
 
-void interruptThread(java_lang_VMThread *);
-bool interruptedThread();
-bool isInterruptedThread(java_lang_VMThread *);
+bool threads_init(void);
 
-/* This must not be changed, it is used in asm_criticalsections */
-typedef struct {
-       u1 *mcodebegin;
-       u1 *mcodeend;
-       u1 *mcoderestart;
-} threadcritnode;
+void threads_start_thread(threadobject *thread, functionptr function);
 
-void thread_registercritical(threadcritnode *);
-u1 *thread_checkcritical(u1*);
+void threads_set_thread_priority(pthread_t tid, int priority);
 
-extern volatile int stopworldwhere;
-extern threadobject *mainthreadobj;
+bool threads_attach_current_thread(JavaVMAttachArgs *vm_aargs, bool isdaemon);
+bool threads_detach_thread(threadobject *thread);
 
-extern pthread_mutex_t pool_lock;
-extern lockRecordPool *global_pool;
+void threads_join_all_threads(void);
 
+void threads_sleep(s8 millis, s4 nanos);
 
-void cast_stopworld();
-void cast_startworld();
+bool threads_wait_with_timeout_relative(threadobject *t, s8 millis, s4 nanos);
 
-/* dumps all threads */
-void threads_dump(void);
+void threads_thread_interrupt(threadobject *thread);
+bool threads_check_if_interrupted_and_reset(void);
+bool threads_thread_has_been_interrupted(threadobject *thread);
 
-/* this is a machine dependent functions (src/vm/jit/$(ARCH_DIR)/md.c) */
-void thread_restartcriticalsection(ucontext_t *);
+void threads_cast_stopworld(void);
+void threads_cast_startworld(void);
 
 #endif /* _THREADS_H */
 
@@ -248,4 +214,5 @@ void thread_restartcriticalsection(ucontext_t *);
  * c-basic-offset: 4
  * tab-width: 4
  * End:
+ * vim:noexpandtab:sw=4:ts=4:
  */