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