6 /* Copyright (C) 1996, 1997, 1998, 2000, 2001, 2002, 2003, 2004, 2006,
7 * 2007, 2008, 2009, 2011, 2012, 2013 Free Software Foundation, Inc.
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public License
11 * as published by the Free Software Foundation; either version 3 of
12 * the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
27 #include "libguile/__scm.h"
28 #include "libguile/procs.h"
29 #include "libguile/throw.h"
30 #include "libguile/root.h"
31 #include "libguile/dynstack.h"
32 #include "libguile/iselect.h"
33 #include "libguile/continuations.h"
35 #if SCM_USE_PTHREAD_THREADS
36 #include "libguile/pthread-threads.h"
39 #if SCM_USE_NULL_THREADS
40 #include "libguile/null-threads.h"
45 /* smob tags for the thread datatypes */
46 SCM_API scm_t_bits scm_tc16_thread
;
47 SCM_API scm_t_bits scm_tc16_mutex
;
48 SCM_API scm_t_bits scm_tc16_condvar
;
50 typedef struct scm_i_thread
{
51 struct scm_i_thread
*next_thread
;
54 scm_i_pthread_t pthread
;
59 scm_i_pthread_mutex_t admin_mutex
;
61 scm_i_pthread_mutex_t
*held_mutex
;
67 /* Boolean indicating whether the thread is in guile mode. */
71 scm_i_pthread_mutex_t
*sleep_mutex
;
72 scm_i_pthread_cond_t sleep_cond
;
73 int sleep_fd
, sleep_pipe
[2];
75 /* Other thread local things.
79 /* The dynamic stack. */
80 scm_t_dynstack dynstack
;
84 SCM active_asyncs
; /* The thunks to be run at the next
86 unsigned int block_asyncs
; /* Non-zero means that asyncs should
88 unsigned int pending_asyncs
; /* Non-zero means that asyncs might be pending.
91 /* The current continuation root and the stack base for it.
93 The continuation root is an arbitrary but unique object that
94 identifies a dynamic extent. Continuations created during that
95 extent can also only be invoked during it.
97 We use pairs where the car is the thread handle and the cdr links
98 to the previous pair. This might be used for better error
99 messages but is not essential for identifying continuation roots.
101 The continuation base is the far end of the stack upto which it
104 SCM continuation_root
;
105 SCM_STACKITEM
*continuation_base
;
107 /* For keeping track of the stack and registers. */
112 void *register_backing_store_base
;
113 scm_t_contregs
*pending_rbs_continuation
;
116 /* Whether this thread is in a critical section. */
117 int critical_section_level
;
121 #define SCM_I_IS_THREAD(x) SCM_SMOB_PREDICATE (scm_tc16_thread, x)
122 #define SCM_I_THREAD_DATA(x) ((scm_i_thread *) SCM_SMOB_DATA (x))
124 #define SCM_VALIDATE_THREAD(pos, a) \
125 scm_assert_smob_type (scm_tc16_thread, (a))
126 #define SCM_VALIDATE_MUTEX(pos, a) \
127 scm_assert_smob_type (scm_tc16_mutex, (a))
128 #define SCM_VALIDATE_CONDVAR(pos, a) \
129 scm_assert_smob_type (scm_tc16_condvar, (a))
131 SCM_API SCM
scm_spawn_thread (scm_t_catch_body body
, void *body_data
,
132 scm_t_catch_handler handler
, void *handler_data
);
134 SCM_API
void *scm_without_guile (void *(*func
)(void *), void *data
);
135 SCM_API
void *scm_with_guile (void *(*func
)(void *), void *data
);
137 SCM_INTERNAL
void scm_i_reset_fluid (size_t);
138 SCM_INTERNAL
void scm_threads_prehistory (void *);
139 SCM_INTERNAL
void scm_init_threads (void);
140 SCM_INTERNAL
void scm_init_thread_procs (void);
141 SCM_INTERNAL
void scm_init_threads_default_dynamic_state (void);
143 SCM_INTERNAL
void scm_i_dynwind_pthread_mutex_lock_block_asyncs (scm_i_pthread_mutex_t
*mutex
);
145 SCM_API SCM
scm_call_with_new_thread (SCM thunk
, SCM handler
);
146 SCM_API SCM
scm_yield (void);
147 SCM_API SCM
scm_cancel_thread (SCM t
);
148 SCM_API SCM
scm_set_thread_cleanup_x (SCM thread
, SCM proc
);
149 SCM_API SCM
scm_thread_cleanup (SCM thread
);
150 SCM_API SCM
scm_join_thread (SCM t
);
151 SCM_API SCM
scm_join_thread_timed (SCM t
, SCM timeout
, SCM timeoutval
);
152 SCM_API SCM
scm_thread_p (SCM t
);
154 SCM_API SCM
scm_make_mutex (void);
155 SCM_API SCM
scm_make_recursive_mutex (void);
156 SCM_API SCM
scm_make_mutex_with_flags (SCM flags
);
157 SCM_API SCM
scm_lock_mutex (SCM m
);
158 SCM_API SCM
scm_lock_mutex_timed (SCM m
, SCM timeout
, SCM owner
);
159 SCM_API
void scm_dynwind_lock_mutex (SCM mutex
);
160 SCM_API SCM
scm_try_mutex (SCM m
);
161 SCM_API SCM
scm_unlock_mutex (SCM m
);
162 SCM_API SCM
scm_unlock_mutex_timed (SCM m
, SCM cond
, SCM timeout
);
163 SCM_API SCM
scm_mutex_p (SCM o
);
164 SCM_API SCM
scm_mutex_locked_p (SCM m
);
165 SCM_API SCM
scm_mutex_owner (SCM m
);
166 SCM_API SCM
scm_mutex_level (SCM m
);
168 SCM_API SCM
scm_make_condition_variable (void);
169 SCM_API SCM
scm_wait_condition_variable (SCM cond
, SCM mutex
);
170 SCM_API SCM
scm_timed_wait_condition_variable (SCM cond
, SCM mutex
,
172 SCM_API SCM
scm_signal_condition_variable (SCM cond
);
173 SCM_API SCM
scm_broadcast_condition_variable (SCM cond
);
174 SCM_API SCM
scm_condition_variable_p (SCM o
);
176 SCM_API SCM
scm_current_thread (void);
177 SCM_API SCM
scm_all_threads (void);
179 SCM_API
int scm_c_thread_exited_p (SCM thread
);
180 SCM_API SCM
scm_thread_exited_p (SCM thread
);
182 SCM_API
void scm_dynwind_critical_section (SCM mutex
);
184 #ifdef BUILDING_LIBGUILE
186 /* Though we don't need the key for SCM_I_CURRENT_THREAD if we have TLS,
187 we do use it for cleanup purposes. */
188 SCM_INTERNAL scm_i_pthread_key_t scm_i_thread_key
;
190 # ifdef SCM_HAVE_THREAD_STORAGE_CLASS
192 SCM_INTERNAL SCM_THREAD_LOCAL scm_i_thread
*scm_i_current_thread
;
193 # define SCM_I_CURRENT_THREAD (scm_i_current_thread)
195 # else /* !SCM_HAVE_THREAD_STORAGE_CLASS */
197 # define SCM_I_CURRENT_THREAD \
198 ((scm_i_thread *) scm_i_pthread_getspecific (scm_i_thread_key))
200 # endif /* !SCM_HAVE_THREAD_STORAGE_CLASS */
202 #endif /* BUILDING_LIBGUILE */
204 SCM_INTERNAL scm_i_pthread_mutex_t scm_i_misc_mutex
;
206 /* Convenience functions for working with the pthread API in guile
210 #if SCM_USE_PTHREAD_THREADS
211 SCM_API
int scm_pthread_mutex_lock (pthread_mutex_t
*mutex
);
212 SCM_API
void scm_dynwind_pthread_mutex_lock (pthread_mutex_t
*mutex
);
213 SCM_API
int scm_pthread_cond_wait (pthread_cond_t
*cond
,
214 pthread_mutex_t
*mutex
);
215 SCM_API
int scm_pthread_cond_timedwait (pthread_cond_t
*cond
,
216 pthread_mutex_t
*mutex
,
217 const scm_t_timespec
*abstime
);
220 /* More convenience functions.
223 SCM_API
unsigned int scm_std_sleep (unsigned int);
224 SCM_API
unsigned long scm_std_usleep (unsigned long);
226 SCM_API SCM
scm_total_processor_count (void);
227 SCM_API SCM
scm_current_processor_count (void);
229 #endif /* SCM_THREADS_H */