src/threads/threads-common.h

   1 /* src/threads/threads-common.h - machine independent thread functions
   2
   3    Copyright (C) 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-common.h 7904 2007-05-14 13:29:32Z twisti $
  26
  27 */
  28
  29
  30 #ifndef _THREADS_COMMON_H
  31 #define _THREADS_COMMON_H
  32
  33 #include "config.h"
  34 #include "vm/types.h"
  35
  36 #include "vm/global.h"
  37
  38 #include "native/jni.h"
  39
  40 #if defined(ENABLE_THREADS)
  41 # include "threads/native/threads.h"
  42 #else
  43 # include "threads/none/threads.h"
  44 #endif
  45
  46 #include "vmcore/utf8.h"
  47
  48
  49 /* only define the following stuff with thread enabled ************************/
  50
  51 #if defined(ENABLE_THREADS)
  52
  53 /* typedefs *******************************************************************/
  54
  55 typedef struct threads_table_entry_t threads_table_entry_t;
  56 typedef struct threads_table_t       threads_table_t;
  57
  58
  59 /* thread states **************************************************************/
  60
  61 #define THREAD_STATE_NEW              0
  62 #define THREAD_STATE_RUNNABLE         1
  63 #define THREAD_STATE_BLOCKED          2
  64 #define THREAD_STATE_WAITING          3
  65 #define THREAD_STATE_TIMED_WAITING    4
  66 #define THREAD_STATE_TERMINATED       5
  67
  68
  69 /* thread priorities **********************************************************/
  70
  71 #define MIN_PRIORITY     1
  72 #define NORM_PRIORITY    5
  73 #define MAX_PRIORITY     10
  74
  75
  76 /* threads_table_entry_t *******************************************************
  77
  78    An entry in the global threads table.
  79
  80 *******************************************************************************/
  81
  82 struct threads_table_entry_t {
  83         threadobject *thread;              /* an existing thread                  */
  84         s4            next;                /* next free or used index             */
  85 };
  86
  87
  88 /* threads_table_t *************************************************************
  89
  90    Struct for the global threads table.
  91
  92 *******************************************************************************/
  93
  94 struct threads_table_t {
  95         threads_table_entry_t *table;      /* the table, threads[0] is the head   */
  96                                            /* of the free list. Real entries      */
  97                                                                            /* start at threads[1].                */
  98         s4                     size;       /* current size of the table           */
  99         s4                     used;       /* number of thread entries            */
 100         s4                     daemons;    /* number of daemon thread entries     */
 101 };
 102
 103
 104 /* function prototypes ********************************************************/
 105
 106 void          threads_preinit(void);
 107
 108 s4            threads_table_add(threadobject *thread);
 109 void          threads_table_remove(threadobject *thread);
 110 s4            threads_table_get_threads(void);
 111 s4            threads_table_get_non_daemons(void);
 112 threadobject *threads_table_first(void);
 113 threadobject *threads_table_next(threadobject *thread);
 114
 115 #if !defined(NDEBUG)
 116 void          threads_table_dump(void);
 117 #endif
 118
 119 threadobject *threads_thread_new(void);
 120 void          threads_thread_free(threadobject *t);
 121 bool          threads_thread_start_internal(utf *name, functionptr f);
 122 void          threads_thread_start(java_lang_Thread *object);
 123
 124 void          threads_thread_print_info(threadobject *t);
 125
 126 ptrint        threads_get_current_tid(void);
 127 utf          *threads_thread_get_state(threadobject *thread);
 128 bool          threads_thread_is_alive(threadobject *thread);
 129
 130 void          threads_dump(void);
 131 void          threads_thread_print_stacktrace(threadobject *thread);
 132 void          threads_print_stacktrace(void);
 133
 134
 135 /* implementation specific functions */
 136
 137 void          threads_impl_preinit(void);
 138
 139 void          threads_impl_table_init(void);
 140 void          threads_table_lock(void);
 141 void          threads_table_unlock(void);
 142
 143 void          threads_set_current_threadobject(threadobject *thread);
 144 void          threads_impl_thread_new(threadobject *t);
 145 void          threads_impl_thread_free(threadobject *t);
 146 void          threads_impl_thread_start(threadobject *thread, functionptr f);
 147
 148 #endif /* ENABLE_THREADS */
 149
 150 #endif /* _THREADS_COMMON_H */
 151
 152
 153 /*
 154  * These are local overrides for various environment variables in Emacs.
 155  * Please do not remove this and leave it at the end of the file, where
 156  * Emacs will automagically detect them.
 157  * ---------------------------------------------------------------------
 158  * Local variables:
 159  * mode: c
 160  * indent-tabs-mode: t
 161  * c-basic-offset: 4
 162  * tab-width: 4
 163  * End:
 164  * vim:noexpandtab:sw=4:ts=4:
 165  */