* src/threads/native/threads.h (STACKFRAMEINFO): Return stackframeinfo
[cacao.git] / src / threads / native / threads.h
index b2b9f340073527f2d3514203e9d3a990b7d38cc6..63891e30e3d09547f23304e340417f1054d4fbd3 100644 (file)
@@ -1,9 +1,9 @@
-/* threads/native/threads.h - native threads header
+/* src/threads/native/threads.h - native threads header
 
-   Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
-   R. Grafl, A. Krall, C. Kruegel, C. Oates, R. Obermaisser,
-   M. Probst, S. Ring, E. Steiner, C. Thalinger, D. Thuernbeck,
-   P. Tomsich, J. Wenninger
+   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
+   $Id: threads.h 7652 2007-04-03 14:23:16Z twisti $
 
-   Authors: Stefan Ring
+*/
 
-   $Id: threads.h 1650 2004-12-02 09:35:13Z twisti $
 
-*/
+#ifndef _THREADS_H
+#define _THREADS_H
+
+/* forward typedefs ***********************************************************/
+
+typedef struct threadobject          threadobject;
+typedef union  threads_table_entry_t threads_table_entry_t;
+typedef struct threads_table_t       threads_table_t;
 
 
-#ifndef _NATIVETHREAD_H
-#define _NATIVETHREAD_H
+#include "config.h"
 
-#include <semaphore.h>
+#include <pthread.h>
+#include <ucontext.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/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>
+
+typedef struct {
+       pthread_mutex_t mutex;
+       pthread_cond_t cond;
+       int value;
+} sem_t;
 
-/* We need to emulate recursive mutexes. */
-#define MUTEXSIM
+#else
+# include <semaphore.h>
 #endif
 
 
-struct _threadobject;
+/* current threadobject *******************************************************/
 
+#if defined(HAVE___THREAD)
 
-typedef struct monitorLockRecord monitorLockRecord;
+#define THREADSPECIFIC    __thread
+#define THREADOBJECT      threads_current_threadobject
 
-struct monitorLockRecord {
-       struct _threadobject *ownerThread;
-       java_objectheader *o;
-       int                lockCount;
-       monitorLockRecord *nextFree;
-       int                queuers;
-       monitorLockRecord *waiter;
-       monitorLockRecord *incharge;
-       bool               waiting;
-       sem_t              queueSem;
-       pthread_mutex_t    resolveLock;
-       pthread_cond_t     resolveWait;
-};
+extern __thread threadobject *threads_current_threadobject;
 
+#else /* defined(HAVE___THREAD) */
 
-struct _lockRecordPool;
+#define THREADSPECIFIC
+#define THREADOBJECT \
+       ((threadobject *) pthread_getspecific(threads_current_threadobject_key))
 
-typedef struct {
-       struct _lockRecordPool *next;
-       int size;
-} lockRecordPoolHeader; 
+extern pthread_key_t threads_current_threadobject_key;
 
-typedef struct _lockRecordPool {
-       lockRecordPoolHeader header;
-       monitorLockRecord lr[1];
-} lockRecordPool;
+#endif /* defined(HAVE___THREAD) */
 
-/* Monitor lock implementation */
-typedef struct {
-       monitorLockRecord *firstLR;
-       lockRecordPool *lrpool;
-       int numlr;
-} ExecEnvironment;
 
-typedef struct {
-       struct _threadobject *next, *prev;
-       java_objectheader *_exceptionptr;
-       methodinfo *_threadrootmethod;
-       void *_stackframeinfo;
-       pthread_t tid;
-#if defined(__DARWIN__)
-       mach_port_t mach_thread;
-#endif
-       pthread_mutex_t joinMutex;
-       pthread_cond_t joinCond;
-} nativethread;
+/* threads_table_entry_t *******************************************************
+
+   An entry in the global threads table.
+
+*******************************************************************************/
+
+union threads_table_entry_t {
+       threadobject       *thread;        /* an existing thread                  */
+       ptrint              nextfree;      /* next free index                     */
+};
+
+
+/* threads_table_t *************************************************************
+
+   Struct for the global threads table.
+
+*******************************************************************************/
 
-typedef java_lang_Thread thread;
+struct threads_table_t {
+       threads_table_entry_t *table;      /* the table, threads[0] is the head   */
+                                          /* of the free list. Real entries      */
+                                                                          /* start at threads[1].                */
+       s4                     size;       /* current size of the table           */
+};
 
 
 /* threadobject ****************************************************************
 
-   TODO
+   Struct holding thread local variables.
 
 *******************************************************************************/
 
-typedef struct _threadobject {
-       java_lang_VMThread  o;
-       nativethread        info;
-       ExecEnvironment     ee;
+#define THREAD_FLAG_JAVA        0x01    /* a normal Java thread               */
+#define THREAD_FLAG_INTERNAL    0x02    /* CACAO internal thread              */
+#define THREAD_FLAG_DAEMON      0x04    /* daemon thread                      */
 
-       pthread_mutex_t     waitLock;
-       pthread_cond_t      waitCond;
-       bool                interrupted;
-       bool                signaled;
-       bool                isSleeping;
 
-       dumpinfo            dumpinfo;       /* dump memory info structure         */
-} threadobject;
+struct threadobject {
+       java_lang_Thread     *object;       /* link to java.lang.Thread object    */
 
+       lock_execution_env_t  ee;           /* data for the lock implementation   */
 
-monitorLockRecord *monitorEnter(threadobject *, java_objectheader *);
-bool monitorExit(threadobject *, java_objectheader *);
+       threadobject         *next;         /* next thread in list, or self       */
+       threadobject         *prev;         /* prev thread in list, or self       */
 
-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);
+       ptrint                thinlock;     /* pre-computed thin lock value       */
 
-void initThreadsEarly();
-void initThreads(u1 *stackbottom);
-void initObjectLock(java_objectheader *);
-void initLocks();
-void initThread(java_lang_VMThread *);
-void startThread(thread *t);
-void joinAllThreads();
+       s4                    index;        /* thread index, starting with 1      */
+       u4                    flags;        /* flag field                         */
 
-void sleepThread(s8 millis, s4 nanos);
-void yieldThread();
+       pthread_t             tid;          /* pthread id                         */
 
-void setPriorityThread(thread *t, s4 priority);
+#if defined(__DARWIN__)
+       mach_port_t           mach_thread;       /* Darwin thread id              */
+#endif
 
-void interruptThread(java_lang_VMThread *);
-bool interruptedThread();
-bool isInterruptedThread(java_lang_VMThread *);
+       pthread_mutex_t       joinmutex;
+       pthread_cond_t        joincond;
 
-#if !defined(HAVE___THREAD)
-extern pthread_key_t tkey_threadinfo;
-#define THREADOBJECT ((java_lang_VMThread*) pthread_getspecific(tkey_threadinfo))
-#define THREADINFO (&((threadobject*) pthread_getspecific(tkey_threadinfo))->info)
-#else
-extern __thread threadobject *threadobj;
-#define THREADOBJECT ((java_lang_VMThread*) threadobj)
-#define THREADINFO (&threadobj->info)
+       /* these are used for the wait/notify implementation                      */
+       pthread_mutex_t       waitmutex;
+       pthread_cond_t        waitcond;
+
+       bool                  interrupted;
+       bool                  signaled;
+       bool                  sleeping;
+
+       u1                   *pc;           /* current PC (used for profiling)    */
+
+       java_objectheader    *_exceptionptr;     /* current exception             */
+       stackframeinfo       *_stackframeinfo;   /* current native stackframeinfo */
+       localref_table       *_localref_table;   /* JNI local references          */
+
+#if defined(ENABLE_INTRP)
+       Cell                 *_global_sp;        /* stack pointer for interpreter */
 #endif
 
-/*#include "builtin.h"*/
+       dumpinfo_t            dumpinfo;     /* dump memory info structure         */
+};
 
-/* This must not be changed, it is used in asm_criticalsections */
-typedef struct {
-       u1 *mcodebegin, *mcodeend, *mcoderestart;
-} threadcritnode;
 
-void thread_registercritical(threadcritnode *);
-u1 *thread_checkcritical(u1*);
+/* exception pointer **********************************************************/
+
+#define exceptionptr      (&(THREADOBJECT->_exceptionptr))
+
+
+/* stackframeinfo *************************************************************/
+
+#define STACKFRAMEINFO    (THREADOBJECT->_stackframeinfo)
+
+
+/* variables ******************************************************************/
+
+extern threadobject *mainthreadobj;
+
+
+/* functions ******************************************************************/
+
+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);
+
+threadobject *threads_get_current_threadobject(void);
+
+void threads_preinit(void);
+bool threads_init(void);
+
+void threads_start_javathread(java_lang_Thread *object);
+void threads_start_thread(threadobject *thread, functionptr function);
+
+void threads_set_thread_priority(pthread_t tid, int priority);
+
+bool threads_attach_current_thread(JavaVMAttachArgs *vm_aargs, bool isdaemon);
+bool threads_detach_thread(threadobject *thread);
+
+void threads_join_all_threads(void);
+
+void threads_sleep(s8 millis, s4 nanos);
+void threads_yield(void);
+
+bool threads_wait_with_timeout_relative(threadobject *t, s8 millis, s4 nanos);
+
+void threads_thread_interrupt(threadobject *thread);
+bool threads_check_if_interrupted_and_reset(void);
+bool threads_thread_has_been_interrupted(threadobject *thread);
 
-extern volatile int stopworldwhere;
+void threads_cast_stopworld(void);
+void threads_cast_startworld(void);
 
-void cast_stopworld();
-void cast_startworld();
+void threads_dump(void);
 
-#endif /* _NATIVETHREAD_H */
+#endif /* _THREADS_H */
 
 
 /*
@@ -190,4 +237,5 @@ void cast_startworld();
  * c-basic-offset: 4
  * tab-width: 4
  * End:
+ * vim:noexpandtab:sw=4:ts=4:
  */