Commit | Line | Data |
---|---|---|
2d3179db | 1 | /* Copyright (C) 1995,1996,1997,1998,2000,2001, 2002 Free Software Foundation, Inc. |
843e4e9d | 2 | * |
73be1d9e MV |
3 | * This library is free software; you can redistribute it and/or |
4 | * modify it under the terms of the GNU Lesser General Public | |
5 | * License as published by the Free Software Foundation; either | |
6 | * version 2.1 of the License, or (at your option) any later version. | |
843e4e9d | 7 | * |
73be1d9e | 8 | * This library is distributed in the hope that it will be useful, |
0f2d19dd | 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
73be1d9e MV |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
11 | * Lesser General Public License for more details. | |
843e4e9d | 12 | * |
73be1d9e MV |
13 | * You should have received a copy of the GNU Lesser General Public |
14 | * License along with this library; if not, write to the Free Software | |
15 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
16 | */ | |
1bbd0b84 | 17 | |
1bbd0b84 | 18 | |
0f2d19dd | 19 | \f |
ef92a2a2 RB |
20 | #if HAVE_CONFIG_H |
21 | # include <config.h> | |
22 | #endif | |
0f2d19dd | 23 | |
0f2d19dd | 24 | #include <signal.h> |
a0599745 MD |
25 | #include "libguile/_scm.h" |
26 | #include "libguile/eval.h" | |
27 | #include "libguile/throw.h" | |
28 | #include "libguile/root.h" | |
29 | #include "libguile/smob.h" | |
c96d76b8 | 30 | #include "libguile/lang.h" |
e292f7aa | 31 | #include "libguile/dynwind.h" |
2d3179db | 32 | #include "libguile/deprecation.h" |
20e6290e | 33 | |
a0599745 MD |
34 | #include "libguile/validate.h" |
35 | #include "libguile/async.h" | |
0f2d19dd | 36 | |
95b88819 GH |
37 | #ifdef HAVE_STRING_H |
38 | #include <string.h> | |
39 | #endif | |
0f2d19dd JB |
40 | #ifdef HAVE_UNISTD_H |
41 | #include <unistd.h> | |
42 | #endif | |
43 | ||
0f2d19dd JB |
44 | \f |
45 | /* {Asynchronous Events} | |
46 | * | |
2d3179db MV |
47 | * There are two kinds of asyncs: system asyncs and user asyncs. The |
48 | * two kinds have some concepts in commen but work slightly | |
49 | * differently and are not interchangeable. | |
0f2d19dd | 50 | * |
2d3179db MV |
51 | * System asyncs are used to run arbitrary code at the next safe point |
52 | * in a specified thread. You can use them to trigger execution of | |
53 | * Scheme code from signal handlers or to interrupt a thread, for | |
54 | * example. | |
0f2d19dd | 55 | * |
2d3179db MV |
56 | * Each thread has a list of 'activated asyncs', which is a normal |
57 | * Scheme list of procedures with zero arguments. When a thread | |
58 | * executes a SCM_ASYNC_TICK statement (which is included in | |
59 | * SCM_TICK), it will call all procedures on this list. | |
843e4e9d | 60 | * |
2d3179db MV |
61 | * Also, a thread will wake up when a procedure is added to its list |
62 | * of active asyncs and call them. After that, it will go to sleep | |
63 | * again. (Not implemented yet.) | |
0f2d19dd | 64 | * |
0f2d19dd | 65 | * |
2d3179db MV |
66 | * User asyncs are a little data structure that consists of a |
67 | * procedure of zero arguments and a mark. There are functions for | |
68 | * setting the mark of a user async and for calling all procedures of | |
69 | * marked asyncs in a given list. Nothing you couldn't quickly | |
70 | * implement yourself. | |
0f2d19dd JB |
71 | */ |
72 | ||
0f2d19dd | 73 | |
2d3179db | 74 | \f |
0f2d19dd | 75 | |
2d3179db | 76 | /* User asyncs. */ |
e94e3f21 | 77 | |
2d3179db | 78 | static scm_t_bits tc16_async; |
e94e3f21 ML |
79 | |
80 | /* cmm: this has SCM_ prefix because SCM_MAKE_VALIDATE expects it. | |
81 | this is ugly. */ | |
e841c3e0 | 82 | #define SCM_ASYNCP(X) SCM_TYP16_PREDICATE (tc16_async, X) |
6182ceac | 83 | #define VALIDATE_ASYNC(pos, a) SCM_MAKE_VALIDATE_MSG(pos, a, ASYNCP, "user async") |
e94e3f21 ML |
84 | |
85 | #define ASYNC_GOT_IT(X) (SCM_CELL_WORD_0 (X) >> 16) | |
d1ca2c64 | 86 | #define SET_ASYNC_GOT_IT(X, V) (SCM_SET_CELL_WORD_0 ((X), SCM_TYP16 (X) | ((V) << 16))) |
e94e3f21 | 87 | #define ASYNC_THUNK(X) SCM_CELL_OBJECT_1 (X) |
0f2d19dd | 88 | |
0f2d19dd | 89 | static SCM |
2d3179db | 90 | async_gc_mark (SCM obj) |
0f2d19dd | 91 | { |
e94e3f21 | 92 | return ASYNC_THUNK (obj); |
0f2d19dd JB |
93 | } |
94 | ||
843e4e9d | 95 | SCM_DEFINE (scm_async, "async", 1, 0, 0, |
811cf846 MG |
96 | (SCM thunk), |
97 | "Create a new async for the procedure @var{thunk}.") | |
1bbd0b84 | 98 | #define FUNC_NAME s_scm_async |
0f2d19dd | 99 | { |
e94e3f21 | 100 | SCM_RETURN_NEWSMOB (tc16_async, SCM_UNPACK (thunk)); |
0f2d19dd | 101 | } |
1bbd0b84 | 102 | #undef FUNC_NAME |
0f2d19dd | 103 | |
843e4e9d | 104 | SCM_DEFINE (scm_async_mark, "async-mark", 1, 0, 0, |
1bbd0b84 | 105 | (SCM a), |
811cf846 | 106 | "Mark the async @var{a} for future execution.") |
1bbd0b84 | 107 | #define FUNC_NAME s_scm_async_mark |
0f2d19dd | 108 | { |
e94e3f21 | 109 | VALIDATE_ASYNC (1, a); |
e94e3f21 | 110 | SET_ASYNC_GOT_IT (a, 1); |
0f2d19dd JB |
111 | return SCM_UNSPECIFIED; |
112 | } | |
1bbd0b84 | 113 | #undef FUNC_NAME |
0f2d19dd | 114 | |
843e4e9d | 115 | SCM_DEFINE (scm_run_asyncs, "run-asyncs", 1, 0, 0, |
811cf846 MG |
116 | (SCM list_of_a), |
117 | "Execute all thunks from the asyncs of the list @var{list_of_a}.") | |
1bbd0b84 | 118 | #define FUNC_NAME s_scm_run_asyncs |
0f2d19dd | 119 | { |
c96d76b8 | 120 | while (! SCM_NULL_OR_NIL_P (list_of_a)) |
0f2d19dd JB |
121 | { |
122 | SCM a; | |
9f0e55a6 | 123 | SCM_VALIDATE_CONS (1, list_of_a); |
1bbd0b84 | 124 | a = SCM_CAR (list_of_a); |
e94e3f21 | 125 | VALIDATE_ASYNC (SCM_ARG1, a); |
e94e3f21 | 126 | if (ASYNC_GOT_IT (a)) |
0f2d19dd | 127 | { |
e94e3f21 | 128 | SET_ASYNC_GOT_IT (a, 0); |
fdc28395 | 129 | scm_call_0 (ASYNC_THUNK (a)); |
0f2d19dd | 130 | } |
1bbd0b84 | 131 | list_of_a = SCM_CDR (list_of_a); |
0f2d19dd JB |
132 | } |
133 | return SCM_BOOL_T; | |
134 | } | |
1bbd0b84 | 135 | #undef FUNC_NAME |
0f2d19dd JB |
136 | |
137 | \f | |
138 | ||
2d3179db | 139 | /* System asyncs. */ |
0f2d19dd | 140 | |
2d3179db MV |
141 | void |
142 | scm_async_click () | |
0f2d19dd | 143 | { |
402858a4 MV |
144 | /* Reset pending_asyncs even when asyncs are blocked and not really |
145 | executed. | |
146 | */ | |
2d3179db | 147 | |
402858a4 | 148 | scm_root->pending_asyncs = 0; |
e292f7aa | 149 | if (scm_root->block_asyncs == 0) |
2d3179db | 150 | { |
402858a4 | 151 | SCM asyncs; |
e292f7aa | 152 | while (!SCM_NULLP(asyncs = scm_root->active_asyncs)) |
2d3179db | 153 | { |
e292f7aa | 154 | scm_root->active_asyncs = SCM_EOL; |
2d3179db MV |
155 | do |
156 | { | |
2d3179db | 157 | scm_call_0 (SCM_CAR (asyncs)); |
402858a4 | 158 | asyncs = SCM_CDR (asyncs); |
2d3179db MV |
159 | } |
160 | while (!SCM_NULLP(asyncs)); | |
161 | } | |
402858a4 MV |
162 | for (asyncs = scm_root->signal_asyncs; !SCM_NULLP(asyncs); |
163 | asyncs = SCM_CDR (asyncs)) | |
164 | { | |
165 | if (!SCM_FALSEP (SCM_CAR (asyncs))) | |
166 | { | |
167 | SCM proc = SCM_CAR (asyncs); | |
168 | SCM_SETCAR (asyncs, SCM_BOOL_F); | |
169 | scm_call_0 (proc); | |
170 | } | |
171 | } | |
2d3179db | 172 | } |
0f2d19dd JB |
173 | } |
174 | ||
100ae50d DH |
175 | #if (SCM_ENABLE_DEPRECATED == 1) |
176 | ||
2d3179db MV |
177 | SCM_DEFINE (scm_system_async, "system-async", 1, 0, 0, |
178 | (SCM thunk), | |
179 | "This function is deprecated. You can use @var{thunk} directly\n" | |
100ae50d | 180 | "instead of explicitely creating an async object.\n") |
2d3179db MV |
181 | #define FUNC_NAME s_scm_system_async |
182 | { | |
183 | scm_c_issue_deprecation_warning | |
184 | ("'system-async' is deprecated. " | |
185 | "Use the procedure directly with 'system-async-mark'."); | |
186 | return thunk; | |
187 | } | |
188 | #undef FUNC_NAME | |
0f2d19dd | 189 | |
100ae50d DH |
190 | #endif /* SCM_ENABLE_DEPRECATED == 1 */ |
191 | ||
2d3179db MV |
192 | void |
193 | scm_i_queue_async_cell (SCM c, scm_root_state *root) | |
194 | { | |
402858a4 MV |
195 | SCM p = root->active_asyncs; |
196 | SCM_SETCDR (c, SCM_EOL); | |
197 | if (p == SCM_EOL) | |
198 | root->active_asyncs = c; | |
199 | else | |
2d3179db | 200 | { |
402858a4 MV |
201 | SCM pp; |
202 | while ((pp = SCM_CDR(p)) != SCM_EOL) | |
f6b44bd9 | 203 | { |
402858a4 MV |
204 | if (SCM_CAR (p) == SCM_CAR (c)) |
205 | return; | |
206 | p = pp; | |
f6b44bd9 | 207 | } |
402858a4 | 208 | SCM_SETCDR (p, c); |
2d3179db | 209 | } |
402858a4 | 210 | root->pending_asyncs = 1; |
2d3179db | 211 | } |
0f2d19dd | 212 | |
2d3179db MV |
213 | SCM_DEFINE (scm_system_async_mark_for_thread, "system-async-mark", 1, 1, 0, |
214 | (SCM proc, SCM thread), | |
0a50eeaa NJ |
215 | "Mark @var{proc} (a procedure with zero arguments) for future execution\n" |
216 | "in @var{thread}. If @var{proc} has already been marked for\n" | |
217 | "@var{thread} but has not been executed yet, this call has no effect.\n" | |
218 | "If @var{thread} is omitted, the thread that called\n" | |
219 | "@code{system-async-mark} is used.\n\n" | |
220 | "This procedure is not safe to be called from C signal handlers. Use\n" | |
221 | "@code{scm_sigaction} or @code{scm_sigaction_for_thread} to install\n" | |
222 | "signal handlers.") | |
2d3179db MV |
223 | #define FUNC_NAME s_scm_system_async_mark_for_thread |
224 | { | |
028e573c MV |
225 | if (SCM_UNBNDP (thread)) |
226 | thread = scm_current_thread (); | |
227 | else | |
402858a4 MV |
228 | { |
229 | SCM_VALIDATE_THREAD (2, thread); | |
230 | if (scm_c_thread_exited_p (thread)) | |
231 | SCM_MISC_ERROR ("thread has already exited", SCM_EOL); | |
232 | } | |
f6b44bd9 | 233 | scm_i_queue_async_cell (scm_cons (proc, SCM_BOOL_F), |
028e573c | 234 | scm_i_thread_root (thread)); |
2d3179db MV |
235 | return SCM_UNSPECIFIED; |
236 | } | |
237 | #undef FUNC_NAME | |
9f0e55a6 | 238 | |
2d3179db MV |
239 | SCM |
240 | scm_system_async_mark (SCM proc) | |
241 | #define FUNC_NAME s_scm_system_async_mark_for_thread | |
0f2d19dd | 242 | { |
2d3179db | 243 | return scm_system_async_mark_for_thread (proc, SCM_UNDEFINED); |
0f2d19dd | 244 | } |
1bbd0b84 | 245 | #undef FUNC_NAME |
0f2d19dd JB |
246 | |
247 | \f | |
248 | ||
249 | ||
2d3179db MV |
250 | SCM_DEFINE (scm_noop, "noop", 0, 0, 1, |
251 | (SCM args), | |
252 | "Do nothing. When called without arguments, return @code{#f},\n" | |
253 | "otherwise return the first argument.") | |
254 | #define FUNC_NAME s_scm_noop | |
0f2d19dd | 255 | { |
2d3179db MV |
256 | SCM_VALIDATE_REST_ARGUMENT (args); |
257 | return (SCM_NULL_OR_NIL_P (args) ? SCM_BOOL_F : SCM_CAR (args)); | |
0f2d19dd | 258 | } |
1bbd0b84 | 259 | #undef FUNC_NAME |
0f2d19dd | 260 | |
0f2d19dd | 261 | |
0f2d19dd JB |
262 | \f |
263 | ||
100ae50d | 264 | #if (SCM_ENABLE_DEPRECATED == 1) |
e292f7aa | 265 | |
843e4e9d | 266 | SCM_DEFINE (scm_unmask_signals, "unmask-signals", 0, 0, 0, |
811cf846 MG |
267 | (), |
268 | "Unmask signals. The returned value is not specified.") | |
1bbd0b84 | 269 | #define FUNC_NAME s_scm_unmask_signals |
0f2d19dd | 270 | { |
e292f7aa MV |
271 | scm_c_issue_deprecation_warning |
272 | ("'unmask-signals' is deprecated. " | |
273 | "Use 'call-with-blocked-asyncs' instead."); | |
274 | ||
275 | if (scm_root->block_asyncs == 0) | |
276 | SCM_MISC_ERROR ("signals already unmasked", SCM_EOL); | |
277 | scm_root->block_asyncs = 0; | |
402858a4 | 278 | scm_async_click (); |
0f2d19dd JB |
279 | return SCM_UNSPECIFIED; |
280 | } | |
1bbd0b84 | 281 | #undef FUNC_NAME |
0f2d19dd JB |
282 | |
283 | ||
843e4e9d | 284 | SCM_DEFINE (scm_mask_signals, "mask-signals", 0, 0, 0, |
811cf846 MG |
285 | (), |
286 | "Mask signals. The returned value is not specified.") | |
1bbd0b84 | 287 | #define FUNC_NAME s_scm_mask_signals |
0f2d19dd | 288 | { |
e292f7aa MV |
289 | scm_c_issue_deprecation_warning |
290 | ("'mask-signals' is deprecated. Use 'call-with-blocked-asyncs' instead."); | |
291 | ||
292 | if (scm_root->block_asyncs > 0) | |
293 | SCM_MISC_ERROR ("signals already masked", SCM_EOL); | |
294 | scm_root->block_asyncs = 1; | |
0f2d19dd JB |
295 | return SCM_UNSPECIFIED; |
296 | } | |
1bbd0b84 | 297 | #undef FUNC_NAME |
0f2d19dd | 298 | |
100ae50d | 299 | #endif /* SCM_ENABLE_DEPRECATED == 1 */ |
e292f7aa MV |
300 | |
301 | static void | |
302 | increase_block (void *unused) | |
303 | { | |
304 | scm_root->block_asyncs++; | |
305 | } | |
306 | ||
307 | static void | |
308 | decrease_block (void *unused) | |
309 | { | |
310 | scm_root->block_asyncs--; | |
402858a4 MV |
311 | if (scm_root->block_asyncs == 0) |
312 | scm_async_click (); | |
e292f7aa MV |
313 | } |
314 | ||
315 | SCM_DEFINE (scm_call_with_blocked_asyncs, "call-with-blocked-asyncs", 1, 0, 0, | |
316 | (SCM proc), | |
317 | "Call @var{proc} with no arguments and block the execution\n" | |
318 | "of system asyncs by one level for the current thread while\n" | |
319 | "it is running. Return the value returned by @var{proc}.\n") | |
320 | #define FUNC_NAME s_scm_call_with_blocked_asyncs | |
321 | { | |
322 | return scm_internal_dynamic_wind (increase_block, | |
323 | (scm_t_inner) scm_call_0, | |
324 | decrease_block, | |
402858a4 | 325 | (void *)proc, NULL); |
e292f7aa MV |
326 | } |
327 | #undef FUNC_NAME | |
328 | ||
329 | void * | |
330 | scm_c_call_with_blocked_asyncs (void *(*proc) (void *data), void *data) | |
331 | { | |
402858a4 MV |
332 | return (void *)scm_internal_dynamic_wind (increase_block, |
333 | (scm_t_inner) proc, | |
334 | decrease_block, | |
335 | data, NULL); | |
e292f7aa MV |
336 | } |
337 | ||
338 | ||
339 | SCM_DEFINE (scm_call_with_unblocked_asyncs, "call-with-unblocked-asyncs", 1, 0, 0, | |
340 | (SCM proc), | |
341 | "Call @var{proc} with no arguments and unblock the execution\n" | |
342 | "of system asyncs by one level for the current thread while\n" | |
343 | "it is running. Return the value returned by @var{proc}.\n") | |
344 | #define FUNC_NAME s_scm_call_with_unblocked_asyncs | |
345 | { | |
346 | if (scm_root->block_asyncs == 0) | |
347 | SCM_MISC_ERROR ("asyncs already unblocked", SCM_EOL); | |
348 | return scm_internal_dynamic_wind (decrease_block, | |
349 | (scm_t_inner) scm_call_0, | |
350 | increase_block, | |
402858a4 | 351 | (void *)proc, NULL); |
e292f7aa MV |
352 | } |
353 | #undef FUNC_NAME | |
354 | ||
355 | void * | |
356 | scm_c_call_with_unblocked_asyncs (void *(*proc) (void *data), void *data) | |
357 | { | |
358 | if (scm_root->block_asyncs == 0) | |
359 | scm_misc_error ("scm_c_call_with_unblocked_asyncs", | |
360 | "asyncs already unblocked", SCM_EOL); | |
402858a4 MV |
361 | return (void *)scm_internal_dynamic_wind (decrease_block, |
362 | (scm_t_inner) proc, | |
363 | increase_block, | |
364 | data, NULL); | |
e292f7aa MV |
365 | } |
366 | ||
0f2d19dd JB |
367 | \f |
368 | ||
0f2d19dd JB |
369 | void |
370 | scm_init_async () | |
0f2d19dd | 371 | { |
939794ce | 372 | scm_asyncs = SCM_EOL; |
73ea78af | 373 | tc16_async = scm_make_smob_type ("async", 0); |
2d3179db | 374 | scm_set_smob_mark (tc16_async, async_gc_mark); |
73ea78af | 375 | |
a0599745 | 376 | #include "libguile/async.x" |
0f2d19dd | 377 | } |
89e00824 ML |
378 | |
379 | /* | |
380 | Local Variables: | |
381 | c-file-style: "gnu" | |
382 | End: | |
383 | */ |