| 1 | /* classes: h_files */ |
| 2 | |
| 3 | #ifndef SCM_THREADS_H |
| 4 | #define SCM_THREADS_H |
| 5 | |
| 6 | /* Copyright (C) 1996,1997,1998,2000,2001, 2002, 2003, 2004, 2006, 2007, 2008 Free Software Foundation, Inc. |
| 7 | * |
| 8 | * This library is free software; you can redistribute it and/or |
| 9 | * modify it under the terms of the GNU Lesser General Public |
| 10 | * License as published by the Free Software Foundation; either |
| 11 | * version 2.1 of the License, or (at your option) any later version. |
| 12 | * |
| 13 | * This library is distributed in the hope that it will be useful, |
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 16 | * Lesser General Public License for more details. |
| 17 | * |
| 18 | * You should have received a copy of the GNU Lesser General Public |
| 19 | * License along with this library; if not, write to the Free Software |
| 20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
| 21 | */ |
| 22 | |
| 23 | \f |
| 24 | |
| 25 | #include "libguile/__scm.h" |
| 26 | #include "libguile/procs.h" |
| 27 | #include "libguile/throw.h" |
| 28 | #include "libguile/root.h" |
| 29 | #include "libguile/iselect.h" |
| 30 | #include "libguile/dynwind.h" |
| 31 | #include "libguile/continuations.h" |
| 32 | |
| 33 | #if SCM_USE_PTHREAD_THREADS |
| 34 | #include "libguile/pthread-threads.h" |
| 35 | #endif |
| 36 | |
| 37 | #if SCM_USE_NULL_THREADS |
| 38 | #include "libguile/null-threads.h" |
| 39 | #endif |
| 40 | |
| 41 | \f |
| 42 | |
| 43 | /* smob tags for the thread datatypes */ |
| 44 | SCM_API scm_t_bits scm_tc16_thread; |
| 45 | SCM_API scm_t_bits scm_tc16_mutex; |
| 46 | SCM_API scm_t_bits scm_tc16_condvar; |
| 47 | |
| 48 | typedef struct scm_i_thread { |
| 49 | struct scm_i_thread *next_thread; |
| 50 | |
| 51 | SCM handle; |
| 52 | scm_i_pthread_t pthread; |
| 53 | |
| 54 | SCM cleanup_handler; |
| 55 | SCM join_queue; |
| 56 | |
| 57 | scm_i_pthread_mutex_t admin_mutex; |
| 58 | SCM mutexes; |
| 59 | scm_i_pthread_mutex_t *held_mutex; |
| 60 | |
| 61 | SCM result; |
| 62 | int canceled; |
| 63 | int exited; |
| 64 | |
| 65 | /* Boolean indicating whether the thread is in guile mode. */ |
| 66 | int guile_mode; |
| 67 | |
| 68 | SCM sleep_object; |
| 69 | scm_i_pthread_mutex_t *sleep_mutex; |
| 70 | scm_i_pthread_cond_t sleep_cond; |
| 71 | int sleep_fd, sleep_pipe[2]; |
| 72 | |
| 73 | /* Information about the Boehm-GC mark stack during the mark phase. This |
| 74 | is used by `scm_gc_mark ()'. */ |
| 75 | void *current_mark_stack_ptr; |
| 76 | void *current_mark_stack_limit; |
| 77 | |
| 78 | /* Other thread local things. |
| 79 | */ |
| 80 | SCM dynamic_state; |
| 81 | scm_t_debug_frame *last_debug_frame; |
| 82 | SCM dynwinds; |
| 83 | |
| 84 | /* For system asyncs. |
| 85 | */ |
| 86 | SCM active_asyncs; /* The thunks to be run at the next |
| 87 | safe point */ |
| 88 | unsigned int block_asyncs; /* Non-zero means that asyncs should |
| 89 | not be run. */ |
| 90 | unsigned int pending_asyncs; /* Non-zero means that asyncs might be pending. |
| 91 | */ |
| 92 | |
| 93 | /* The current continuation root and the stack base for it. |
| 94 | |
| 95 | The continuation root is an arbitrary but unique object that |
| 96 | identifies a dynamic extent. Continuations created during that |
| 97 | extent can also only be invoked during it. |
| 98 | |
| 99 | We use pairs where the car is the thread handle and the cdr links |
| 100 | to the previous pair. This might be used for better error |
| 101 | messages but is not essential for identifying continuation roots. |
| 102 | |
| 103 | The continuation base is the far end of the stack upto which it |
| 104 | needs to be copied. |
| 105 | */ |
| 106 | SCM continuation_root; |
| 107 | SCM_STACKITEM *continuation_base; |
| 108 | |
| 109 | /* For keeping track of the stack and registers. */ |
| 110 | SCM_STACKITEM *base; |
| 111 | SCM_STACKITEM *top; |
| 112 | jmp_buf regs; |
| 113 | #ifdef __ia64__ |
| 114 | void *register_backing_store_base; |
| 115 | scm_t_contregs *pending_rbs_continuation; |
| 116 | #endif |
| 117 | |
| 118 | } scm_i_thread; |
| 119 | |
| 120 | #define SCM_I_IS_THREAD(x) SCM_SMOB_PREDICATE (scm_tc16_thread, x) |
| 121 | #define SCM_I_THREAD_DATA(x) ((scm_i_thread *) SCM_SMOB_DATA (x)) |
| 122 | |
| 123 | #define SCM_VALIDATE_THREAD(pos, a) \ |
| 124 | scm_assert_smob_type (scm_tc16_thread, (a)) |
| 125 | #define SCM_VALIDATE_MUTEX(pos, a) \ |
| 126 | scm_assert_smob_type (scm_tc16_mutex, (a)) |
| 127 | #define SCM_VALIDATE_CONDVAR(pos, a) \ |
| 128 | scm_assert_smob_type (scm_tc16_condvar, (a)) |
| 129 | |
| 130 | SCM_API SCM scm_spawn_thread (scm_t_catch_body body, void *body_data, |
| 131 | scm_t_catch_handler handler, void *handler_data); |
| 132 | |
| 133 | SCM_API void *scm_without_guile (void *(*func)(void *), void *data); |
| 134 | SCM_API void *scm_with_guile (void *(*func)(void *), void *data); |
| 135 | |
| 136 | SCM_INTERNAL void *scm_i_with_guile_and_parent (void *(*func)(void *), |
| 137 | void *data, SCM parent); |
| 138 | |
| 139 | |
| 140 | void scm_threads_prehistory (SCM_STACKITEM *); |
| 141 | void scm_threads_init_first_thread (void); |
| 142 | |
| 143 | SCM_INTERNAL void scm_init_threads (void); |
| 144 | SCM_INTERNAL void scm_init_thread_procs (void); |
| 145 | SCM_INTERNAL void scm_init_threads_default_dynamic_state (void); |
| 146 | |
| 147 | |
| 148 | #define SCM_THREAD_SWITCHING_CODE \ |
| 149 | do { } while (0) |
| 150 | |
| 151 | SCM_API SCM scm_call_with_new_thread (SCM thunk, SCM handler); |
| 152 | SCM_API SCM scm_yield (void); |
| 153 | SCM_API SCM scm_cancel_thread (SCM t); |
| 154 | SCM_API SCM scm_set_thread_cleanup_x (SCM thread, SCM proc); |
| 155 | SCM_API SCM scm_thread_cleanup (SCM thread); |
| 156 | SCM_API SCM scm_join_thread (SCM t); |
| 157 | SCM_API SCM scm_join_thread_timed (SCM t, SCM timeout, SCM timeoutval); |
| 158 | SCM_API SCM scm_thread_p (SCM t); |
| 159 | |
| 160 | SCM_API SCM scm_make_mutex (void); |
| 161 | SCM_API SCM scm_make_recursive_mutex (void); |
| 162 | SCM_API SCM scm_make_mutex_with_flags (SCM flags); |
| 163 | SCM_API SCM scm_lock_mutex (SCM m); |
| 164 | SCM_API SCM scm_lock_mutex_timed (SCM m, SCM timeout, SCM owner); |
| 165 | SCM_API void scm_dynwind_lock_mutex (SCM mutex); |
| 166 | SCM_API SCM scm_try_mutex (SCM m); |
| 167 | SCM_API SCM scm_unlock_mutex (SCM m); |
| 168 | SCM_API SCM scm_unlock_mutex_timed (SCM m, SCM cond, SCM timeout); |
| 169 | SCM_API SCM scm_mutex_p (SCM o); |
| 170 | SCM_API SCM scm_mutex_locked_p (SCM m); |
| 171 | SCM_API SCM scm_mutex_owner (SCM m); |
| 172 | SCM_API SCM scm_mutex_level (SCM m); |
| 173 | |
| 174 | SCM_API SCM scm_make_condition_variable (void); |
| 175 | SCM_API SCM scm_wait_condition_variable (SCM cond, SCM mutex); |
| 176 | SCM_API SCM scm_timed_wait_condition_variable (SCM cond, SCM mutex, |
| 177 | SCM abstime); |
| 178 | SCM_API SCM scm_signal_condition_variable (SCM cond); |
| 179 | SCM_API SCM scm_broadcast_condition_variable (SCM cond); |
| 180 | SCM_API SCM scm_condition_variable_p (SCM o); |
| 181 | |
| 182 | SCM_API SCM scm_current_thread (void); |
| 183 | SCM_API SCM scm_all_threads (void); |
| 184 | |
| 185 | SCM_API int scm_c_thread_exited_p (SCM thread); |
| 186 | SCM_API SCM scm_thread_exited_p (SCM thread); |
| 187 | |
| 188 | SCM_API void scm_dynwind_critical_section (SCM mutex); |
| 189 | |
| 190 | #define SCM_I_CURRENT_THREAD \ |
| 191 | ((scm_i_thread *) scm_i_pthread_getspecific (scm_i_thread_key)) |
| 192 | SCM_API scm_i_pthread_key_t scm_i_thread_key; |
| 193 | |
| 194 | #define scm_i_dynwinds() (SCM_I_CURRENT_THREAD->dynwinds) |
| 195 | #define scm_i_set_dynwinds(w) (SCM_I_CURRENT_THREAD->dynwinds = (w)) |
| 196 | #define scm_i_last_debug_frame() (SCM_I_CURRENT_THREAD->last_debug_frame) |
| 197 | #define scm_i_set_last_debug_frame(f) \ |
| 198 | (SCM_I_CURRENT_THREAD->last_debug_frame = (f)) |
| 199 | |
| 200 | SCM_INTERNAL scm_i_pthread_mutex_t scm_i_misc_mutex; |
| 201 | |
| 202 | /* Convenience functions for working with the pthread API in guile |
| 203 | mode. |
| 204 | */ |
| 205 | |
| 206 | #if SCM_USE_PTHREAD_THREADS |
| 207 | SCM_API int scm_pthread_mutex_lock (pthread_mutex_t *mutex); |
| 208 | SCM_API void scm_dynwind_pthread_mutex_lock (pthread_mutex_t *mutex); |
| 209 | SCM_API int scm_pthread_cond_wait (pthread_cond_t *cond, |
| 210 | pthread_mutex_t *mutex); |
| 211 | SCM_API int scm_pthread_cond_timedwait (pthread_cond_t *cond, |
| 212 | pthread_mutex_t *mutex, |
| 213 | const struct timespec *abstime); |
| 214 | #endif |
| 215 | |
| 216 | /* More convenience functions. |
| 217 | */ |
| 218 | |
| 219 | SCM_API unsigned int scm_std_sleep (unsigned int); |
| 220 | SCM_API unsigned long scm_std_usleep (unsigned long); |
| 221 | |
| 222 | #endif /* SCM_THREADS_H */ |
| 223 | |
| 224 | /* |
| 225 | Local Variables: |
| 226 | c-file-style: "gnu" |
| 227 | End: |
| 228 | */ |