Commit | Line | Data |
---|---|---|
b3da54d1 LC |
1 | /* Copyright (C) 1995, 1996, 1997, 1998, 2000, 2001, 2002, 2003, 2004, |
2 | * 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 | |
3 | * Free Software Foundation, Inc. | |
74926120 | 4 | * |
73be1d9e | 5 | * This library is free software; you can redistribute it and/or |
53befeb7 NJ |
6 | * modify it under the terms of the GNU Lesser General Public License |
7 | * as published by the Free Software Foundation; either version 3 of | |
8 | * the License, or (at your option) any later version. | |
7bfd3b9e | 9 | * |
53befeb7 NJ |
10 | * This library is distributed in the hope that it will be useful, but |
11 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
73be1d9e MV |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
13 | * Lesser General Public License for more details. | |
7bfd3b9e | 14 | * |
73be1d9e MV |
15 | * You should have received a copy of the GNU Lesser General Public |
16 | * License along with this library; if not, write to the Free Software | |
53befeb7 NJ |
17 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
18 | * 02110-1301 USA | |
73be1d9e | 19 | */ |
1bbd0b84 | 20 | |
1bbd0b84 | 21 | |
7bfd3b9e | 22 | \f |
dbb605f5 LC |
23 | #ifdef HAVE_CONFIG_H |
24 | # include <config.h> | |
25 | #endif | |
7bfd3b9e | 26 | |
1c44468d | 27 | #include "libguile/bdw-gc.h" |
1810dc4e RB |
28 | #include "libguile/_scm.h" |
29 | ||
b3da54d1 | 30 | #include <stdlib.h> |
fcc5d734 | 31 | #if HAVE_UNISTD_H |
d823b11b | 32 | #include <unistd.h> |
fcc5d734 | 33 | #endif |
d823b11b | 34 | #include <stdio.h> |
8ab3d8a0 KR |
35 | |
36 | #ifdef HAVE_STRING_H | |
37 | #include <string.h> /* for memset used by FD_ZERO on Solaris 10 */ | |
38 | #endif | |
39 | ||
fcc5d734 | 40 | #if HAVE_SYS_TIME_H |
d823b11b | 41 | #include <sys/time.h> |
fcc5d734 | 42 | #endif |
5f05c406 | 43 | |
c1d5d6d7 AW |
44 | #if HAVE_PTHREAD_NP_H |
45 | # include <pthread_np.h> | |
46 | #endif | |
47 | ||
f57fdf07 | 48 | #include <assert.h> |
32f94bf2 | 49 | #include <fcntl.h> |
d20912e6 | 50 | #include <nproc.h> |
f57fdf07 | 51 | |
d823b11b MV |
52 | #include "libguile/validate.h" |
53 | #include "libguile/root.h" | |
54 | #include "libguile/eval.h" | |
55 | #include "libguile/async.h" | |
56 | #include "libguile/ports.h" | |
57 | #include "libguile/threads.h" | |
a0599745 | 58 | #include "libguile/dynwind.h" |
d823b11b | 59 | #include "libguile/iselect.h" |
9de87eea MV |
60 | #include "libguile/fluids.h" |
61 | #include "libguile/continuations.h" | |
2b829bbb | 62 | #include "libguile/gc.h" |
9de87eea | 63 | #include "libguile/init.h" |
2e77f720 | 64 | #include "libguile/scmsigs.h" |
6180e336 | 65 | #include "libguile/strings.h" |
a0faf7dd | 66 | #include "libguile/weaks.h" |
7bfd3b9e | 67 | |
634aa8de LC |
68 | #include <full-read.h> |
69 | ||
cde24ce1 AW |
70 | |
71 | \f | |
72 | ||
73 | /* First some libgc shims. */ | |
74 | ||
75 | /* Make sure GC_fn_type is defined; it is missing from the public | |
76 | headers of GC 7.1 and earlier. */ | |
77 | #ifndef HAVE_GC_FN_TYPE | |
78 | typedef void * (* GC_fn_type) (void *); | |
79 | #endif | |
80 | ||
81 | ||
5f0d2951 AW |
82 | #ifndef GC_SUCCESS |
83 | #define GC_SUCCESS 0 | |
84 | #endif | |
85 | ||
86 | #ifndef GC_UNIMPLEMENTED | |
87 | #define GC_UNIMPLEMENTED 3 | |
88 | #endif | |
89 | ||
90 | /* Likewise struct GC_stack_base is missing before 7.1. */ | |
91 | #ifndef HAVE_GC_STACK_BASE | |
12c1d861 AW |
92 | struct GC_stack_base { |
93 | void * mem_base; /* Base of memory stack. */ | |
94 | #ifdef __ia64__ | |
95 | void * reg_base; /* Base of separate register stack. */ | |
96 | #endif | |
97 | }; | |
5f0d2951 AW |
98 | |
99 | static int | |
987b8160 | 100 | GC_register_my_thread (struct GC_stack_base *stack_base) |
5f0d2951 AW |
101 | { |
102 | return GC_UNIMPLEMENTED; | |
103 | } | |
104 | ||
105 | static void | |
106 | GC_unregister_my_thread () | |
107 | { | |
108 | } | |
109 | ||
12c1d861 AW |
110 | #if !SCM_USE_PTHREAD_THREADS |
111 | /* No threads; we can just use GC_stackbottom. */ | |
5f0d2951 | 112 | static void * |
12c1d861 AW |
113 | get_thread_stack_base () |
114 | { | |
115 | return GC_stackbottom; | |
116 | } | |
117 | ||
118 | #elif defined HAVE_PTHREAD_ATTR_GETSTACK && defined HAVE_PTHREAD_GETATTR_NP \ | |
119 | && defined PTHREAD_ATTR_GETSTACK_WORKS | |
120 | /* This method for GNU/Linux and perhaps some other systems. | |
121 | It's not for MacOS X or Solaris 10, since pthread_getattr_np is not | |
122 | available on them. */ | |
123 | static void * | |
124 | get_thread_stack_base () | |
125 | { | |
126 | pthread_attr_t attr; | |
127 | void *start, *end; | |
128 | size_t size; | |
129 | ||
130 | pthread_getattr_np (pthread_self (), &attr); | |
131 | pthread_attr_getstack (&attr, &start, &size); | |
132 | end = (char *)start + size; | |
133 | ||
134 | #if SCM_STACK_GROWS_UP | |
135 | return start; | |
136 | #else | |
137 | return end; | |
138 | #endif | |
139 | } | |
140 | ||
141 | #elif defined HAVE_PTHREAD_GET_STACKADDR_NP | |
142 | /* This method for MacOS X. | |
143 | It'd be nice if there was some documentation on pthread_get_stackaddr_np, | |
144 | but as of 2006 there's nothing obvious at apple.com. */ | |
145 | static void * | |
146 | get_thread_stack_base () | |
147 | { | |
148 | return pthread_get_stackaddr_np (pthread_self ()); | |
149 | } | |
150 | ||
c1d5d6d7 AW |
151 | #elif HAVE_PTHREAD_ATTR_GET_NP |
152 | /* This one is for FreeBSD 9. */ | |
153 | static void * | |
154 | get_thread_stack_base () | |
155 | { | |
156 | pthread_attr_t attr; | |
157 | void *start, *end; | |
158 | size_t size; | |
159 | ||
160 | pthread_attr_init (&attr); | |
161 | pthread_attr_get_np (pthread_self (), &attr); | |
162 | pthread_attr_getstack (&attr, &start, &size); | |
163 | pthread_attr_destroy (&attr); | |
164 | ||
165 | end = (char *)start + size; | |
166 | ||
167 | #if SCM_STACK_GROWS_UP | |
168 | return start; | |
169 | #else | |
170 | return end; | |
171 | #endif | |
172 | } | |
173 | ||
12c1d861 AW |
174 | #else |
175 | #error Threads enabled with old BDW-GC, but missing get_thread_stack_base impl. Please upgrade to libgc >= 7.1. | |
176 | #endif | |
177 | ||
178 | static int | |
987b8160 | 179 | GC_get_stack_base (struct GC_stack_base *stack_base) |
5f0d2951 | 180 | { |
12c1d861 AW |
181 | stack_base->mem_base = get_thread_stack_base (); |
182 | #ifdef __ia64__ | |
183 | /* Calculate and store off the base of this thread's register | |
184 | backing store (RBS). Unfortunately our implementation(s) of | |
185 | scm_ia64_register_backing_store_base are only reliable for the | |
186 | main thread. For other threads, therefore, find out the current | |
187 | top of the RBS, and use that as a maximum. */ | |
188 | stack_base->reg_base = scm_ia64_register_backing_store_base (); | |
189 | { | |
190 | ucontext_t ctx; | |
191 | void *bsp; | |
192 | getcontext (&ctx); | |
193 | bsp = scm_ia64_ar_bsp (&ctx); | |
194 | if (stack_base->reg_base > bsp) | |
195 | stack_base->reg_base = bsp; | |
196 | } | |
197 | #endif | |
198 | return GC_SUCCESS; | |
5f0d2951 | 199 | } |
12c1d861 AW |
200 | |
201 | static void * | |
202 | GC_call_with_stack_base(void * (*fn) (struct GC_stack_base*, void*), void *arg) | |
203 | { | |
204 | struct GC_stack_base stack_base; | |
205 | ||
206 | stack_base.mem_base = (void*)&stack_base; | |
207 | #ifdef __ia64__ | |
208 | /* FIXME: Untested. */ | |
209 | { | |
210 | ucontext_t ctx; | |
211 | getcontext (&ctx); | |
212 | stack_base.reg_base = scm_ia64_ar_bsp (&ctx); | |
213 | } | |
5f0d2951 AW |
214 | #endif |
215 | ||
12c1d861 AW |
216 | return fn (&stack_base, arg); |
217 | } | |
218 | #endif /* HAVE_GC_STACK_BASE */ | |
219 | ||
5f0d2951 | 220 | |
cde24ce1 AW |
221 | /* Now define with_gc_active and with_gc_inactive. */ |
222 | ||
223 | #if (defined(HAVE_GC_DO_BLOCKING) && defined (HAVE_DECL_GC_DO_BLOCKING) && defined (HAVE_GC_CALL_WITH_GC_ACTIVE)) | |
224 | ||
225 | /* We have a sufficiently new libgc (7.2 or newer). */ | |
226 | ||
227 | static void* | |
228 | with_gc_inactive (GC_fn_type func, void *data) | |
229 | { | |
230 | return GC_do_blocking (func, data); | |
231 | } | |
232 | ||
233 | static void* | |
234 | with_gc_active (GC_fn_type func, void *data) | |
235 | { | |
236 | return GC_call_with_gc_active (func, data); | |
237 | } | |
238 | ||
239 | #else | |
240 | ||
241 | /* libgc not new enough, so never actually deactivate GC. | |
242 | ||
243 | Note that though GC 7.1 does have a GC_do_blocking, it doesn't have | |
244 | GC_call_with_gc_active. */ | |
245 | ||
246 | static void* | |
247 | with_gc_inactive (GC_fn_type func, void *data) | |
248 | { | |
249 | return func (data); | |
250 | } | |
251 | ||
252 | static void* | |
253 | with_gc_active (GC_fn_type func, void *data) | |
254 | { | |
255 | return func (data); | |
256 | } | |
257 | ||
258 | #endif /* HAVE_GC_DO_BLOCKING */ | |
259 | ||
260 | ||
634aa8de | 261 | \f |
6180e336 NJ |
262 | static void |
263 | to_timespec (SCM t, scm_t_timespec *waittime) | |
264 | { | |
265 | if (scm_is_pair (t)) | |
266 | { | |
267 | waittime->tv_sec = scm_to_ulong (SCM_CAR (t)); | |
268 | waittime->tv_nsec = scm_to_ulong (SCM_CDR (t)) * 1000; | |
269 | } | |
270 | else | |
271 | { | |
272 | double time = scm_to_double (t); | |
273 | double sec = scm_c_truncate (time); | |
274 | ||
275 | waittime->tv_sec = (long) sec; | |
2a1d0688 | 276 | waittime->tv_nsec = (long) ((time - sec) * 1000000000); |
6180e336 NJ |
277 | } |
278 | } | |
279 | ||
c058db8a | 280 | \f |
d823b11b | 281 | /*** Queues */ |
7bfd3b9e | 282 | |
c058db8a LC |
283 | /* Note: We annotate with "GC-robust" assignments whose purpose is to avoid |
284 | the risk of false references leading to unbounded retained space as | |
285 | described in "Bounding Space Usage of Conservative Garbage Collectors", | |
286 | H.J. Boehm, 2001. */ | |
287 | ||
9de87eea MV |
288 | /* Make an empty queue data structure. |
289 | */ | |
d823b11b MV |
290 | static SCM |
291 | make_queue () | |
292 | { | |
293 | return scm_cons (SCM_EOL, SCM_EOL); | |
294 | } | |
7bfd3b9e | 295 | |
9de87eea MV |
296 | /* Put T at the back of Q and return a handle that can be used with |
297 | remqueue to remove T from Q again. | |
298 | */ | |
d823b11b MV |
299 | static SCM |
300 | enqueue (SCM q, SCM t) | |
301 | { | |
302 | SCM c = scm_cons (t, SCM_EOL); | |
d2a51087 | 303 | SCM_CRITICAL_SECTION_START; |
d2e53ed6 | 304 | if (scm_is_null (SCM_CDR (q))) |
d823b11b MV |
305 | SCM_SETCDR (q, c); |
306 | else | |
307 | SCM_SETCDR (SCM_CAR (q), c); | |
308 | SCM_SETCAR (q, c); | |
d2a51087 | 309 | SCM_CRITICAL_SECTION_END; |
d823b11b MV |
310 | return c; |
311 | } | |
7bfd3b9e | 312 | |
9de87eea MV |
313 | /* Remove the element that the handle C refers to from the queue Q. C |
314 | must have been returned from a call to enqueue. The return value | |
315 | is zero when the element referred to by C has already been removed. | |
316 | Otherwise, 1 is returned. | |
317 | */ | |
318 | static int | |
d823b11b MV |
319 | remqueue (SCM q, SCM c) |
320 | { | |
321 | SCM p, prev = q; | |
d2a51087 | 322 | SCM_CRITICAL_SECTION_START; |
d2e53ed6 | 323 | for (p = SCM_CDR (q); !scm_is_null (p); p = SCM_CDR (p)) |
d823b11b | 324 | { |
bc36d050 | 325 | if (scm_is_eq (p, c)) |
d823b11b | 326 | { |
bc36d050 | 327 | if (scm_is_eq (c, SCM_CAR (q))) |
d823b11b MV |
328 | SCM_SETCAR (q, SCM_CDR (c)); |
329 | SCM_SETCDR (prev, SCM_CDR (c)); | |
c058db8a LC |
330 | |
331 | /* GC-robust */ | |
332 | SCM_SETCDR (c, SCM_EOL); | |
333 | ||
d2a51087 | 334 | SCM_CRITICAL_SECTION_END; |
9de87eea | 335 | return 1; |
d823b11b MV |
336 | } |
337 | prev = p; | |
338 | } | |
d2a51087 | 339 | SCM_CRITICAL_SECTION_END; |
9de87eea | 340 | return 0; |
d823b11b MV |
341 | } |
342 | ||
9de87eea MV |
343 | /* Remove the front-most element from the queue Q and return it. |
344 | Return SCM_BOOL_F when Q is empty. | |
345 | */ | |
d823b11b MV |
346 | static SCM |
347 | dequeue (SCM q) | |
348 | { | |
d2a51087 NJ |
349 | SCM c; |
350 | SCM_CRITICAL_SECTION_START; | |
351 | c = SCM_CDR (q); | |
d2e53ed6 | 352 | if (scm_is_null (c)) |
d2a51087 NJ |
353 | { |
354 | SCM_CRITICAL_SECTION_END; | |
355 | return SCM_BOOL_F; | |
356 | } | |
d823b11b MV |
357 | else |
358 | { | |
359 | SCM_SETCDR (q, SCM_CDR (c)); | |
d2e53ed6 | 360 | if (scm_is_null (SCM_CDR (q))) |
d823b11b | 361 | SCM_SETCAR (q, SCM_EOL); |
d2a51087 | 362 | SCM_CRITICAL_SECTION_END; |
c058db8a LC |
363 | |
364 | /* GC-robust */ | |
365 | SCM_SETCDR (c, SCM_EOL); | |
366 | ||
d823b11b MV |
367 | return SCM_CAR (c); |
368 | } | |
369 | } | |
7bfd3b9e | 370 | |
9de87eea | 371 | /*** Thread smob routines */ |
76da80e7 | 372 | |
d823b11b MV |
373 | |
374 | static int | |
375 | thread_print (SCM exp, SCM port, scm_print_state *pstate SCM_UNUSED) | |
376 | { | |
23d72566 KR |
377 | /* On a Gnu system pthread_t is an unsigned long, but on mingw it's a |
378 | struct. A cast like "(unsigned long) t->pthread" is a syntax error in | |
379 | the struct case, hence we go via a union, and extract according to the | |
380 | size of pthread_t. */ | |
381 | union { | |
382 | scm_i_pthread_t p; | |
383 | unsigned short us; | |
384 | unsigned int ui; | |
385 | unsigned long ul; | |
386 | scm_t_uintmax um; | |
387 | } u; | |
9de87eea | 388 | scm_i_thread *t = SCM_I_THREAD_DATA (exp); |
23d72566 KR |
389 | scm_i_pthread_t p = t->pthread; |
390 | scm_t_uintmax id; | |
391 | u.p = p; | |
392 | if (sizeof (p) == sizeof (unsigned short)) | |
393 | id = u.us; | |
394 | else if (sizeof (p) == sizeof (unsigned int)) | |
395 | id = u.ui; | |
396 | else if (sizeof (p) == sizeof (unsigned long)) | |
397 | id = u.ul; | |
398 | else | |
399 | id = u.um; | |
400 | ||
d823b11b | 401 | scm_puts ("#<thread ", port); |
23d72566 | 402 | scm_uintprint (id, 10, port); |
1b92fb6b | 403 | scm_puts (" (", port); |
0345e278 | 404 | scm_uintprint ((scm_t_bits)t, 16, port); |
1b92fb6b | 405 | scm_puts (")>", port); |
d823b11b MV |
406 | return 1; |
407 | } | |
408 | ||
706846f6 | 409 | \f |
9de87eea | 410 | /*** Blocking on queues. */ |
f7eca35d | 411 | |
9de87eea MV |
412 | /* See also scm_i_queue_async_cell for how such a block is |
413 | interrputed. | |
414 | */ | |
d823b11b | 415 | |
9de87eea MV |
416 | /* Put the current thread on QUEUE and go to sleep, waiting for it to |
417 | be woken up by a call to 'unblock_from_queue', or to be | |
418 | interrupted. Upon return of this function, the current thread is | |
419 | no longer on QUEUE, even when the sleep has been interrupted. | |
420 | ||
d2a51087 | 421 | The caller of block_self must hold MUTEX. It will be atomically |
9de87eea MV |
422 | unlocked while sleeping, just as with scm_i_pthread_cond_wait. |
423 | ||
424 | SLEEP_OBJECT is an arbitrary SCM value that is kept alive as long | |
425 | as MUTEX is needed. | |
426 | ||
427 | When WAITTIME is not NULL, the sleep will be aborted at that time. | |
428 | ||
429 | The return value of block_self is an errno value. It will be zero | |
430 | when the sleep has been successfully completed by a call to | |
431 | unblock_from_queue, EINTR when it has been interrupted by the | |
432 | delivery of a system async, and ETIMEDOUT when the timeout has | |
433 | expired. | |
434 | ||
435 | The system asyncs themselves are not executed by block_self. | |
436 | */ | |
437 | static int | |
438 | block_self (SCM queue, SCM sleep_object, scm_i_pthread_mutex_t *mutex, | |
439 | const scm_t_timespec *waittime) | |
76da80e7 | 440 | { |
9de87eea MV |
441 | scm_i_thread *t = SCM_I_CURRENT_THREAD; |
442 | SCM q_handle; | |
443 | int err; | |
444 | ||
445 | if (scm_i_setup_sleep (t, sleep_object, mutex, -1)) | |
446 | err = EINTR; | |
447 | else | |
448 | { | |
449 | t->block_asyncs++; | |
450 | q_handle = enqueue (queue, t->handle); | |
451 | if (waittime == NULL) | |
452 | err = scm_i_scm_pthread_cond_wait (&t->sleep_cond, mutex); | |
453 | else | |
454 | err = scm_i_scm_pthread_cond_timedwait (&t->sleep_cond, mutex, waittime); | |
455 | ||
456 | /* When we are still on QUEUE, we have been interrupted. We | |
457 | report this only when no other error (such as a timeout) has | |
458 | happened above. | |
459 | */ | |
460 | if (remqueue (queue, q_handle) && err == 0) | |
461 | err = EINTR; | |
462 | t->block_asyncs--; | |
463 | scm_i_reset_sleep (t); | |
464 | } | |
465 | ||
466 | return err; | |
76da80e7 | 467 | } |
9de87eea | 468 | |
d2a51087 NJ |
469 | /* Wake up the first thread on QUEUE, if any. The awoken thread is |
470 | returned, or #f if the queue was empty. | |
9de87eea MV |
471 | */ |
472 | static SCM | |
473 | unblock_from_queue (SCM queue) | |
474 | { | |
475 | SCM thread = dequeue (queue); | |
476 | if (scm_is_true (thread)) | |
477 | scm_i_pthread_cond_signal (&SCM_I_THREAD_DATA(thread)->sleep_cond); | |
478 | return thread; | |
479 | } | |
480 | ||
45f15cac | 481 | \f |
9de87eea MV |
482 | /* Getting into and out of guile mode. |
483 | */ | |
484 | ||
f60a7648 AW |
485 | /* Key used to attach a cleanup handler to a given thread. Also, if |
486 | thread-local storage is unavailable, this key is used to retrieve the | |
487 | current thread with `pthread_getspecific ()'. */ | |
488 | scm_i_pthread_key_t scm_i_thread_key; | |
489 | ||
490 | ||
705edb95 LC |
491 | #ifdef SCM_HAVE_THREAD_STORAGE_CLASS |
492 | ||
493 | /* When thread-local storage (TLS) is available, a pointer to the | |
494 | current-thread object is kept in TLS. Note that storing the thread-object | |
495 | itself in TLS (rather than a pointer to some malloc'd memory) is not | |
496 | possible since thread objects may live longer than the actual thread they | |
497 | represent. */ | |
498 | SCM_THREAD_LOCAL scm_i_thread *scm_i_current_thread = NULL; | |
499 | ||
f60a7648 | 500 | #endif /* SCM_HAVE_THREAD_STORAGE_CLASS */ |
705edb95 | 501 | |
d823b11b | 502 | |
9de87eea MV |
503 | static scm_i_pthread_mutex_t thread_admin_mutex = SCM_I_PTHREAD_MUTEX_INITIALIZER; |
504 | static scm_i_thread *all_threads = NULL; | |
505 | static int thread_count; | |
506 | ||
507 | static SCM scm_i_default_dynamic_state; | |
508 | ||
0b77014f AW |
509 | /* Run when a fluid is collected. */ |
510 | void | |
aafb4ed7 | 511 | scm_i_reset_fluid (size_t n) |
0b77014f AW |
512 | { |
513 | scm_i_thread *t; | |
514 | ||
515 | scm_i_pthread_mutex_lock (&thread_admin_mutex); | |
516 | for (t = all_threads; t; t = t->next_thread) | |
517 | if (SCM_I_DYNAMIC_STATE_P (t->dynamic_state)) | |
518 | { | |
519 | SCM v = SCM_I_DYNAMIC_STATE_FLUIDS (t->dynamic_state); | |
520 | ||
521 | if (n < SCM_SIMPLE_VECTOR_LENGTH (v)) | |
aafb4ed7 | 522 | SCM_SIMPLE_VECTOR_SET (v, n, SCM_UNDEFINED); |
0b77014f AW |
523 | } |
524 | scm_i_pthread_mutex_unlock (&thread_admin_mutex); | |
525 | } | |
526 | ||
9de87eea | 527 | /* Perform first stage of thread initialisation, in non-guile mode. |
d823b11b | 528 | */ |
9de87eea | 529 | static void |
12c1d861 | 530 | guilify_self_1 (struct GC_stack_base *base) |
d823b11b | 531 | { |
7f22442b AW |
532 | scm_i_thread t; |
533 | ||
534 | /* We must arrange for SCM_I_CURRENT_THREAD to point to a valid value | |
535 | before allocating anything in this thread, because allocation could | |
536 | cause GC to run, and GC could cause finalizers, which could invoke | |
537 | Scheme functions, which need the current thread to be set. */ | |
538 | ||
539 | t.pthread = scm_i_pthread_self (); | |
540 | t.handle = SCM_BOOL_F; | |
541 | t.result = SCM_BOOL_F; | |
542 | t.cleanup_handler = SCM_BOOL_F; | |
543 | t.mutexes = SCM_EOL; | |
544 | t.held_mutex = NULL; | |
545 | t.join_queue = SCM_EOL; | |
546 | t.dynamic_state = SCM_BOOL_F; | |
547 | t.dynwinds = SCM_EOL; | |
548 | t.active_asyncs = SCM_EOL; | |
549 | t.block_asyncs = 1; | |
550 | t.pending_asyncs = 1; | |
551 | t.critical_section_level = 0; | |
552 | t.base = base->mem_base; | |
346e4402 | 553 | #ifdef __ia64__ |
bbd21051 | 554 | t.register_backing_store_base = base->reg_base; |
346e4402 | 555 | #endif |
7f22442b AW |
556 | t.continuation_root = SCM_EOL; |
557 | t.continuation_base = t.base; | |
558 | scm_i_pthread_cond_init (&t.sleep_cond, NULL); | |
559 | t.sleep_mutex = NULL; | |
560 | t.sleep_object = SCM_BOOL_F; | |
561 | t.sleep_fd = -1; | |
562 | ||
32f94bf2 | 563 | if (pipe2 (t.sleep_pipe, O_CLOEXEC) != 0) |
634aa8de LC |
564 | /* FIXME: Error conditions during the initialization phase are handled |
565 | gracelessly since public functions such as `scm_init_guile ()' | |
566 | currently have type `void'. */ | |
567 | abort (); | |
568 | ||
7f22442b AW |
569 | scm_i_pthread_mutex_init (&t.admin_mutex, NULL); |
570 | t.current_mark_stack_ptr = NULL; | |
571 | t.current_mark_stack_limit = NULL; | |
572 | t.canceled = 0; | |
573 | t.exited = 0; | |
574 | t.guile_mode = 0; | |
9de87eea | 575 | |
7f22442b AW |
576 | /* The switcheroo. */ |
577 | { | |
578 | scm_i_thread *t_ptr = &t; | |
579 | ||
580 | GC_disable (); | |
581 | t_ptr = GC_malloc (sizeof (scm_i_thread)); | |
582 | memcpy (t_ptr, &t, sizeof t); | |
583 | ||
584 | scm_i_pthread_setspecific (scm_i_thread_key, t_ptr); | |
f60a7648 AW |
585 | |
586 | #ifdef SCM_HAVE_THREAD_STORAGE_CLASS | |
7f22442b AW |
587 | /* Cache the current thread in TLS for faster lookup. */ |
588 | scm_i_current_thread = t_ptr; | |
f60a7648 | 589 | #endif |
9de87eea | 590 | |
7f22442b AW |
591 | scm_i_pthread_mutex_lock (&thread_admin_mutex); |
592 | t_ptr->next_thread = all_threads; | |
593 | all_threads = t_ptr; | |
594 | thread_count++; | |
595 | scm_i_pthread_mutex_unlock (&thread_admin_mutex); | |
596 | ||
597 | GC_enable (); | |
598 | } | |
d823b11b MV |
599 | } |
600 | ||
9de87eea | 601 | /* Perform second stage of thread initialisation, in guile mode. |
d823b11b | 602 | */ |
9de87eea MV |
603 | static void |
604 | guilify_self_2 (SCM parent) | |
d823b11b | 605 | { |
9de87eea MV |
606 | scm_i_thread *t = SCM_I_CURRENT_THREAD; |
607 | ||
72e6b608 LC |
608 | t->guile_mode = 1; |
609 | ||
9de87eea | 610 | SCM_NEWSMOB (t->handle, scm_tc16_thread, t); |
c812243b | 611 | |
9de87eea MV |
612 | t->continuation_root = scm_cons (t->handle, SCM_EOL); |
613 | t->continuation_base = t->base; | |
2bbe1533 | 614 | t->vm = SCM_BOOL_F; |
9de87eea MV |
615 | |
616 | if (scm_is_true (parent)) | |
617 | t->dynamic_state = scm_make_dynamic_state (parent); | |
618 | else | |
619 | t->dynamic_state = scm_i_make_initial_dynamic_state (); | |
620 | ||
621 | t->join_queue = make_queue (); | |
622 | t->block_asyncs = 0; | |
f740445a AW |
623 | |
624 | /* See note in finalizers.c:queue_finalizer_async(). */ | |
625 | GC_invoke_finalizers (); | |
d823b11b MV |
626 | } |
627 | ||
6180e336 NJ |
628 | \f |
629 | /*** Fat mutexes */ | |
630 | ||
631 | /* We implement our own mutex type since we want them to be 'fair', we | |
632 | want to do fancy things while waiting for them (like running | |
633 | asyncs) and we might want to add things that are nice for | |
634 | debugging. | |
635 | */ | |
636 | ||
637 | typedef struct { | |
638 | scm_i_pthread_mutex_t lock; | |
639 | SCM owner; | |
adc085f1 | 640 | int level; /* how much the owner owns us. <= 1 for non-recursive mutexes */ |
6180e336 | 641 | |
adc085f1 | 642 | int recursive; /* allow recursive locking? */ |
6180e336 NJ |
643 | int unchecked_unlock; /* is it an error to unlock an unlocked mutex? */ |
644 | int allow_external_unlock; /* is it an error to unlock a mutex that is not | |
645 | owned by the current thread? */ | |
646 | ||
647 | SCM waiting; /* the threads waiting for this mutex. */ | |
648 | } fat_mutex; | |
649 | ||
650 | #define SCM_MUTEXP(x) SCM_SMOB_PREDICATE (scm_tc16_mutex, x) | |
651 | #define SCM_MUTEX_DATA(x) ((fat_mutex *) SCM_SMOB_DATA (x)) | |
652 | ||
2002f1f8 AW |
653 | static SCM |
654 | call_cleanup (void *data) | |
655 | { | |
656 | SCM *proc_p = data; | |
657 | return scm_call_0 (*proc_p); | |
658 | } | |
659 | ||
9de87eea | 660 | /* Perform thread tear-down, in guile mode. |
d823b11b | 661 | */ |
9de87eea MV |
662 | static void * |
663 | do_thread_exit (void *v) | |
664 | { | |
2e77f720 LC |
665 | scm_i_thread *t = (scm_i_thread *) v; |
666 | ||
91230883 LC |
667 | /* Ensure the signal handling thread has been launched, because we might be |
668 | shutting it down. This needs to be done in Guile mode. */ | |
669 | scm_i_ensure_signal_delivery_thread (); | |
670 | ||
2e77f720 LC |
671 | if (!scm_is_false (t->cleanup_handler)) |
672 | { | |
673 | SCM ptr = t->cleanup_handler; | |
674 | ||
675 | t->cleanup_handler = SCM_BOOL_F; | |
676 | t->result = scm_internal_catch (SCM_BOOL_T, | |
2002f1f8 | 677 | call_cleanup, &ptr, |
2e77f720 LC |
678 | scm_handle_by_message_noexit, NULL); |
679 | } | |
9de87eea | 680 | |
86a597f8 | 681 | scm_i_scm_pthread_mutex_lock (&t->admin_mutex); |
9de87eea MV |
682 | |
683 | t->exited = 1; | |
0c97d7dd MV |
684 | close (t->sleep_pipe[0]); |
685 | close (t->sleep_pipe[1]); | |
9de87eea MV |
686 | while (scm_is_true (unblock_from_queue (t->join_queue))) |
687 | ; | |
9de87eea | 688 | |
74926120 | 689 | while (!scm_is_null (t->mutexes)) |
6180e336 | 690 | { |
a0faf7dd | 691 | SCM mutex = SCM_WEAK_PAIR_CAR (t->mutexes); |
74926120 | 692 | |
a0faf7dd LC |
693 | if (!SCM_UNBNDP (mutex)) |
694 | { | |
695 | fat_mutex *m = SCM_MUTEX_DATA (mutex); | |
696 | ||
697 | scm_i_pthread_mutex_lock (&m->lock); | |
f57fdf07 | 698 | |
02a362a6 LC |
699 | /* Check whether T owns MUTEX. This is usually the case, unless |
700 | T abandoned MUTEX; in that case, T is no longer its owner (see | |
701 | `fat_mutex_lock') but MUTEX is still in `t->mutexes'. */ | |
702 | if (scm_is_eq (m->owner, t->handle)) | |
703 | unblock_from_queue (m->waiting); | |
f57fdf07 | 704 | |
a0faf7dd LC |
705 | scm_i_pthread_mutex_unlock (&m->lock); |
706 | } | |
6180e336 | 707 | |
a0faf7dd | 708 | t->mutexes = SCM_WEAK_PAIR_CDR (t->mutexes); |
6180e336 NJ |
709 | } |
710 | ||
86a597f8 | 711 | scm_i_pthread_mutex_unlock (&t->admin_mutex); |
2e77f720 | 712 | |
9de87eea MV |
713 | return NULL; |
714 | } | |
715 | ||
f60a7648 AW |
716 | static void * |
717 | do_thread_exit_trampoline (struct GC_stack_base *sb, void *v) | |
718 | { | |
7f22442b | 719 | /* Won't hurt if we are already registered. */ |
8e76ce94 | 720 | #if SCM_USE_PTHREAD_THREADS |
7f22442b | 721 | GC_register_my_thread (sb); |
8e76ce94 | 722 | #endif |
f60a7648 | 723 | |
7f22442b | 724 | return scm_with_guile (do_thread_exit, v); |
f60a7648 AW |
725 | } |
726 | ||
d823b11b | 727 | static void |
9de87eea | 728 | on_thread_exit (void *v) |
d823b11b | 729 | { |
29776e85 | 730 | /* This handler is executed in non-guile mode. */ |
2e77f720 | 731 | scm_i_thread *t = (scm_i_thread *) v, **tp; |
0c97d7dd | 732 | |
b8441577 LC |
733 | /* If we were canceled, we were unable to clear `t->guile_mode', so do |
734 | it here. */ | |
735 | t->guile_mode = 0; | |
736 | ||
d2a51087 NJ |
737 | /* If this thread was cancelled while doing a cond wait, it will |
738 | still have a mutex locked, so we unlock it here. */ | |
739 | if (t->held_mutex) | |
740 | { | |
741 | scm_i_pthread_mutex_unlock (t->held_mutex); | |
742 | t->held_mutex = NULL; | |
743 | } | |
744 | ||
f60a7648 AW |
745 | /* Reinstate the current thread for purposes of scm_with_guile |
746 | guile-mode cleanup handlers. Only really needed in the non-TLS | |
747 | case but it doesn't hurt to be consistent. */ | |
748 | scm_i_pthread_setspecific (scm_i_thread_key, t); | |
0c97d7dd | 749 | |
7f22442b AW |
750 | /* Scheme-level thread finalizers and other cleanup needs to happen in |
751 | guile mode. */ | |
752 | GC_call_with_stack_base (do_thread_exit_trampoline, t); | |
0c97d7dd MV |
753 | |
754 | /* Removing ourself from the list of all threads needs to happen in | |
755 | non-guile mode since all SCM values on our stack become | |
29776e85 | 756 | unprotected once we are no longer in the list. */ |
0c97d7dd MV |
757 | scm_i_pthread_mutex_lock (&thread_admin_mutex); |
758 | for (tp = &all_threads; *tp; tp = &(*tp)->next_thread) | |
759 | if (*tp == t) | |
760 | { | |
761 | *tp = t->next_thread; | |
c058db8a LC |
762 | |
763 | /* GC-robust */ | |
764 | t->next_thread = NULL; | |
765 | ||
0c97d7dd MV |
766 | break; |
767 | } | |
768 | thread_count--; | |
2e77f720 LC |
769 | |
770 | /* If there's only one other thread, it could be the signal delivery | |
771 | thread, so we need to notify it to shut down by closing its read pipe. | |
772 | If it's not the signal delivery thread, then closing the read pipe isn't | |
773 | going to hurt. */ | |
774 | if (thread_count <= 1) | |
775 | scm_i_close_signal_pipe (); | |
776 | ||
0c97d7dd MV |
777 | scm_i_pthread_mutex_unlock (&thread_admin_mutex); |
778 | ||
f60a7648 | 779 | scm_i_pthread_setspecific (scm_i_thread_key, NULL); |
7f22442b | 780 | |
8e76ce94 | 781 | #if SCM_USE_PTHREAD_THREADS |
7f22442b | 782 | GC_unregister_my_thread (); |
653ccd78 | 783 | #endif |
d823b11b MV |
784 | } |
785 | ||
9de87eea | 786 | static scm_i_pthread_once_t init_thread_key_once = SCM_I_PTHREAD_ONCE_INIT; |
d823b11b | 787 | |
9de87eea MV |
788 | static void |
789 | init_thread_key (void) | |
790 | { | |
f60a7648 | 791 | scm_i_pthread_key_create (&scm_i_thread_key, on_thread_exit); |
9de87eea | 792 | } |
d823b11b | 793 | |
cde24ce1 AW |
794 | /* Perform any initializations necessary to make the current thread |
795 | known to Guile (via SCM_I_CURRENT_THREAD), initializing Guile itself, | |
796 | if necessary. | |
a54a94b3 | 797 | |
9de87eea MV |
798 | BASE is the stack base to use with GC. |
799 | ||
800 | PARENT is the dynamic state to use as the parent, ot SCM_BOOL_F in | |
801 | which case the default dynamic state is used. | |
802 | ||
cde24ce1 | 803 | Returns zero when the thread was known to guile already; otherwise |
9de87eea | 804 | return 1. |
cde24ce1 AW |
805 | |
806 | Note that it could be the case that the thread was known | |
807 | to Guile, but not in guile mode (because we are within a | |
808 | scm_without_guile call). Check SCM_I_CURRENT_THREAD->guile_mode to | |
809 | be sure. New threads are put into guile mode implicitly. */ | |
9de87eea MV |
810 | |
811 | static int | |
12c1d861 | 812 | scm_i_init_thread_for_guile (struct GC_stack_base *base, SCM parent) |
d823b11b | 813 | { |
9de87eea MV |
814 | scm_i_pthread_once (&init_thread_key_once, init_thread_key); |
815 | ||
cde24ce1 AW |
816 | if (SCM_I_CURRENT_THREAD) |
817 | { | |
818 | /* Thread is already known to Guile. | |
819 | */ | |
820 | return 0; | |
821 | } | |
822 | else | |
9de87eea MV |
823 | { |
824 | /* This thread has not been guilified yet. | |
825 | */ | |
826 | ||
827 | scm_i_pthread_mutex_lock (&scm_i_init_mutex); | |
828 | if (scm_initialized_p == 0) | |
829 | { | |
830 | /* First thread ever to enter Guile. Run the full | |
831 | initialization. | |
832 | */ | |
833 | scm_i_init_guile (base); | |
12c1d861 | 834 | |
8e76ce94 | 835 | #if defined (HAVE_GC_ALLOW_REGISTER_THREADS) && SCM_USE_PTHREAD_THREADS |
12c1d861 AW |
836 | /* Allow other threads to come in later. */ |
837 | GC_allow_register_threads (); | |
4000d064 | 838 | #endif |
12c1d861 | 839 | |
9de87eea MV |
840 | scm_i_pthread_mutex_unlock (&scm_i_init_mutex); |
841 | } | |
842 | else | |
843 | { | |
844 | /* Guile is already initialized, but this thread enters it for | |
845 | the first time. Only initialize this thread. | |
846 | */ | |
847 | scm_i_pthread_mutex_unlock (&scm_i_init_mutex); | |
12c1d861 AW |
848 | |
849 | /* Register this thread with libgc. */ | |
8e76ce94 | 850 | #if SCM_USE_PTHREAD_THREADS |
12c1d861 | 851 | GC_register_my_thread (base); |
8e76ce94 | 852 | #endif |
12c1d861 | 853 | |
9de87eea MV |
854 | guilify_self_1 (base); |
855 | guilify_self_2 (parent); | |
856 | } | |
857 | return 1; | |
858 | } | |
d823b11b MV |
859 | } |
860 | ||
12c1d861 AW |
861 | void |
862 | scm_init_guile () | |
d823b11b | 863 | { |
12c1d861 AW |
864 | struct GC_stack_base stack_base; |
865 | ||
866 | if (GC_get_stack_base (&stack_base) == GC_SUCCESS) | |
867 | scm_i_init_thread_for_guile (&stack_base, | |
868 | scm_i_default_dynamic_state); | |
9de87eea MV |
869 | else |
870 | { | |
12c1d861 | 871 | fprintf (stderr, "Failed to get stack base for current thread.\n"); |
b3da54d1 | 872 | exit (EXIT_FAILURE); |
9de87eea | 873 | } |
a54a94b3 MV |
874 | } |
875 | ||
12c1d861 | 876 | struct with_guile_args |
cde24ce1 AW |
877 | { |
878 | GC_fn_type func; | |
879 | void *data; | |
12c1d861 | 880 | SCM parent; |
cde24ce1 AW |
881 | }; |
882 | ||
883 | static void * | |
884 | with_guile_trampoline (void *data) | |
885 | { | |
12c1d861 | 886 | struct with_guile_args *args = data; |
cde24ce1 AW |
887 | |
888 | return scm_c_with_continuation_barrier (args->func, args->data); | |
889 | } | |
890 | ||
12c1d861 AW |
891 | static void * |
892 | with_guile_and_parent (struct GC_stack_base *base, void *data) | |
9de87eea MV |
893 | { |
894 | void *res; | |
cde24ce1 AW |
895 | int new_thread; |
896 | scm_i_thread *t; | |
12c1d861 | 897 | struct with_guile_args *args = data; |
2e77f720 | 898 | |
12c1d861 | 899 | new_thread = scm_i_init_thread_for_guile (base, args->parent); |
cde24ce1 AW |
900 | t = SCM_I_CURRENT_THREAD; |
901 | if (new_thread) | |
2e77f720 | 902 | { |
cde24ce1 AW |
903 | /* We are in Guile mode. */ |
904 | assert (t->guile_mode); | |
905 | ||
12c1d861 | 906 | res = scm_c_with_continuation_barrier (args->func, args->data); |
cde24ce1 AW |
907 | |
908 | /* Leave Guile mode. */ | |
909 | t->guile_mode = 0; | |
910 | } | |
911 | else if (t->guile_mode) | |
912 | { | |
913 | /* Already in Guile mode. */ | |
12c1d861 | 914 | res = scm_c_with_continuation_barrier (args->func, args->data); |
2e77f720 | 915 | } |
74926120 | 916 | else |
cde24ce1 | 917 | { |
cde24ce1 AW |
918 | /* We are not in Guile mode, either because we are not within a |
919 | scm_with_guile, or because we are within a scm_without_guile. | |
72e6b608 | 920 | |
cde24ce1 AW |
921 | This call to scm_with_guile() could happen from anywhere on the |
922 | stack, and in particular lower on the stack than when it was | |
923 | when this thread was first guilified. Thus, `base' must be | |
924 | updated. */ | |
925 | #if SCM_STACK_GROWS_UP | |
12c1d861 AW |
926 | if (SCM_STACK_PTR (base->mem_base) < t->base) |
927 | t->base = SCM_STACK_PTR (base->mem_base); | |
cde24ce1 | 928 | #else |
12c1d861 AW |
929 | if (SCM_STACK_PTR (base->mem_base) > t->base) |
930 | t->base = SCM_STACK_PTR (base->mem_base); | |
cde24ce1 | 931 | #endif |
72e6b608 | 932 | |
cde24ce1 | 933 | t->guile_mode = 1; |
12c1d861 | 934 | res = with_gc_active (with_guile_trampoline, args); |
cde24ce1 AW |
935 | t->guile_mode = 0; |
936 | } | |
937 | return res; | |
72e6b608 | 938 | } |
3d1af79f | 939 | |
12c1d861 AW |
940 | static void * |
941 | scm_i_with_guile_and_parent (void *(*func)(void *), void *data, SCM parent) | |
942 | { | |
943 | struct with_guile_args args; | |
944 | ||
945 | args.func = func; | |
946 | args.data = data; | |
947 | args.parent = parent; | |
948 | ||
949 | return GC_call_with_stack_base (with_guile_and_parent, &args); | |
950 | } | |
951 | ||
952 | void * | |
953 | scm_with_guile (void *(*func)(void *), void *data) | |
954 | { | |
955 | return scm_i_with_guile_and_parent (func, data, | |
956 | scm_i_default_dynamic_state); | |
957 | } | |
958 | ||
9de87eea MV |
959 | void * |
960 | scm_without_guile (void *(*func)(void *), void *data) | |
d823b11b | 961 | { |
72e6b608 | 962 | void *result; |
cde24ce1 | 963 | scm_i_thread *t = SCM_I_CURRENT_THREAD; |
72e6b608 | 964 | |
cde24ce1 | 965 | if (t->guile_mode) |
72e6b608 | 966 | { |
cde24ce1 AW |
967 | SCM_I_CURRENT_THREAD->guile_mode = 0; |
968 | result = with_gc_inactive (func, data); | |
969 | SCM_I_CURRENT_THREAD->guile_mode = 1; | |
72e6b608 LC |
970 | } |
971 | else | |
cde24ce1 | 972 | /* Otherwise we're not in guile mode, so nothing to do. */ |
72e6b608 LC |
973 | result = func (data); |
974 | ||
975 | return result; | |
9de87eea MV |
976 | } |
977 | ||
72e6b608 | 978 | \f |
9de87eea MV |
979 | /*** Thread creation */ |
980 | ||
981 | typedef struct { | |
982 | SCM parent; | |
983 | SCM thunk; | |
984 | SCM handler; | |
76da80e7 | 985 | SCM thread; |
9de87eea MV |
986 | scm_i_pthread_mutex_t mutex; |
987 | scm_i_pthread_cond_t cond; | |
988 | } launch_data; | |
d823b11b | 989 | |
9de87eea MV |
990 | static void * |
991 | really_launch (void *d) | |
992 | { | |
993 | launch_data *data = (launch_data *)d; | |
994 | SCM thunk = data->thunk, handler = data->handler; | |
995 | scm_i_thread *t; | |
d823b11b | 996 | |
9de87eea | 997 | t = SCM_I_CURRENT_THREAD; |
a54a94b3 | 998 | |
9de87eea MV |
999 | scm_i_scm_pthread_mutex_lock (&data->mutex); |
1000 | data->thread = scm_current_thread (); | |
1001 | scm_i_pthread_cond_signal (&data->cond); | |
1002 | scm_i_pthread_mutex_unlock (&data->mutex); | |
1003 | ||
1004 | if (SCM_UNBNDP (handler)) | |
1005 | t->result = scm_call_0 (thunk); | |
1006 | else | |
1007 | t->result = scm_catch (SCM_BOOL_T, thunk, handler); | |
1008 | ||
1009 | return 0; | |
d823b11b MV |
1010 | } |
1011 | ||
9de87eea MV |
1012 | static void * |
1013 | launch_thread (void *d) | |
1014 | { | |
1015 | launch_data *data = (launch_data *)d; | |
1016 | scm_i_pthread_detach (scm_i_pthread_self ()); | |
1017 | scm_i_with_guile_and_parent (really_launch, d, data->parent); | |
1018 | return NULL; | |
1019 | } | |
1020 | ||
1021 | SCM_DEFINE (scm_call_with_new_thread, "call-with-new-thread", 1, 1, 0, | |
d823b11b | 1022 | (SCM thunk, SCM handler), |
9de87eea MV |
1023 | "Call @code{thunk} in a new thread and with a new dynamic state,\n" |
1024 | "returning a new thread object representing the thread. The procedure\n" | |
1025 | "@var{thunk} is called via @code{with-continuation-barrier}.\n" | |
1026 | "\n" | |
1027 | "When @var{handler} is specified, then @var{thunk} is called from\n" | |
1028 | "within a @code{catch} with tag @code{#t} that has @var{handler} as its\n" | |
1029 | "handler. This catch is established inside the continuation barrier.\n" | |
1030 | "\n" | |
1031 | "Once @var{thunk} or @var{handler} returns, the return value is made\n" | |
1032 | "the @emph{exit value} of the thread and the thread is terminated.") | |
d823b11b MV |
1033 | #define FUNC_NAME s_scm_call_with_new_thread |
1034 | { | |
9de87eea MV |
1035 | launch_data data; |
1036 | scm_i_pthread_t id; | |
1037 | int err; | |
d823b11b | 1038 | |
9de87eea MV |
1039 | SCM_ASSERT (scm_is_true (scm_thunk_p (thunk)), thunk, SCM_ARG1, FUNC_NAME); |
1040 | SCM_ASSERT (SCM_UNBNDP (handler) || scm_is_true (scm_procedure_p (handler)), | |
1041 | handler, SCM_ARG2, FUNC_NAME); | |
1042 | ||
9f7537dc | 1043 | GC_collect_a_little (); |
9de87eea MV |
1044 | data.parent = scm_current_dynamic_state (); |
1045 | data.thunk = thunk; | |
1046 | data.handler = handler; | |
1047 | data.thread = SCM_BOOL_F; | |
1048 | scm_i_pthread_mutex_init (&data.mutex, NULL); | |
1049 | scm_i_pthread_cond_init (&data.cond, NULL); | |
1050 | ||
1051 | scm_i_scm_pthread_mutex_lock (&data.mutex); | |
1052 | err = scm_i_pthread_create (&id, NULL, launch_thread, &data); | |
1053 | if (err) | |
1054 | { | |
1055 | scm_i_pthread_mutex_unlock (&data.mutex); | |
1056 | errno = err; | |
1057 | scm_syserror (NULL); | |
1058 | } | |
1059 | scm_i_scm_pthread_cond_wait (&data.cond, &data.mutex); | |
1060 | scm_i_pthread_mutex_unlock (&data.mutex); | |
74926120 | 1061 | |
9de87eea | 1062 | return data.thread; |
d823b11b MV |
1063 | } |
1064 | #undef FUNC_NAME | |
1065 | ||
9de87eea MV |
1066 | typedef struct { |
1067 | SCM parent; | |
1068 | scm_t_catch_body body; | |
1069 | void *body_data; | |
1070 | scm_t_catch_handler handler; | |
1071 | void *handler_data; | |
1072 | SCM thread; | |
1073 | scm_i_pthread_mutex_t mutex; | |
1074 | scm_i_pthread_cond_t cond; | |
1075 | } spawn_data; | |
1076 | ||
1077 | static void * | |
1078 | really_spawn (void *d) | |
1079 | { | |
1080 | spawn_data *data = (spawn_data *)d; | |
1081 | scm_t_catch_body body = data->body; | |
1082 | void *body_data = data->body_data; | |
1083 | scm_t_catch_handler handler = data->handler; | |
1084 | void *handler_data = data->handler_data; | |
1085 | scm_i_thread *t = SCM_I_CURRENT_THREAD; | |
1086 | ||
1087 | scm_i_scm_pthread_mutex_lock (&data->mutex); | |
1088 | data->thread = scm_current_thread (); | |
1089 | scm_i_pthread_cond_signal (&data->cond); | |
1090 | scm_i_pthread_mutex_unlock (&data->mutex); | |
1091 | ||
1092 | if (handler == NULL) | |
1093 | t->result = body (body_data); | |
1094 | else | |
1095 | t->result = scm_internal_catch (SCM_BOOL_T, | |
1096 | body, body_data, | |
1097 | handler, handler_data); | |
1098 | ||
1099 | return 0; | |
1100 | } | |
1101 | ||
1102 | static void * | |
1103 | spawn_thread (void *d) | |
1104 | { | |
1105 | spawn_data *data = (spawn_data *)d; | |
1106 | scm_i_pthread_detach (scm_i_pthread_self ()); | |
1107 | scm_i_with_guile_and_parent (really_spawn, d, data->parent); | |
1108 | return NULL; | |
1109 | } | |
1110 | ||
1111 | SCM | |
1112 | scm_spawn_thread (scm_t_catch_body body, void *body_data, | |
1113 | scm_t_catch_handler handler, void *handler_data) | |
1114 | { | |
1115 | spawn_data data; | |
1116 | scm_i_pthread_t id; | |
1117 | int err; | |
1118 | ||
1119 | data.parent = scm_current_dynamic_state (); | |
1120 | data.body = body; | |
1121 | data.body_data = body_data; | |
1122 | data.handler = handler; | |
1123 | data.handler_data = handler_data; | |
1124 | data.thread = SCM_BOOL_F; | |
1125 | scm_i_pthread_mutex_init (&data.mutex, NULL); | |
1126 | scm_i_pthread_cond_init (&data.cond, NULL); | |
1127 | ||
1128 | scm_i_scm_pthread_mutex_lock (&data.mutex); | |
1129 | err = scm_i_pthread_create (&id, NULL, spawn_thread, &data); | |
1130 | if (err) | |
1131 | { | |
1132 | scm_i_pthread_mutex_unlock (&data.mutex); | |
1133 | errno = err; | |
1134 | scm_syserror (NULL); | |
1135 | } | |
1136 | scm_i_scm_pthread_cond_wait (&data.cond, &data.mutex); | |
1137 | scm_i_pthread_mutex_unlock (&data.mutex); | |
74926120 | 1138 | |
0f4f2d9a LC |
1139 | assert (SCM_I_IS_THREAD (data.thread)); |
1140 | ||
9de87eea MV |
1141 | return data.thread; |
1142 | } | |
1143 | ||
29717c89 MD |
1144 | SCM_DEFINE (scm_yield, "yield", 0, 0, 0, |
1145 | (), | |
1146 | "Move the calling thread to the end of the scheduling queue.") | |
1147 | #define FUNC_NAME s_scm_yield | |
1148 | { | |
9de87eea | 1149 | return scm_from_bool (scm_i_sched_yield ()); |
29717c89 MD |
1150 | } |
1151 | #undef FUNC_NAME | |
1152 | ||
2e77f720 LC |
1153 | SCM_DEFINE (scm_cancel_thread, "cancel-thread", 1, 0, 0, |
1154 | (SCM thread), | |
1155 | "Asynchronously force the target @var{thread} to terminate. @var{thread} " | |
1156 | "cannot be the current thread, and if @var{thread} has already terminated or " | |
1157 | "been signaled to terminate, this function is a no-op.") | |
1158 | #define FUNC_NAME s_scm_cancel_thread | |
1159 | { | |
1160 | scm_i_thread *t = NULL; | |
1161 | ||
1162 | SCM_VALIDATE_THREAD (1, thread); | |
1163 | t = SCM_I_THREAD_DATA (thread); | |
86a597f8 | 1164 | scm_i_scm_pthread_mutex_lock (&t->admin_mutex); |
2e77f720 LC |
1165 | if (!t->canceled) |
1166 | { | |
1167 | t->canceled = 1; | |
86a597f8 | 1168 | scm_i_pthread_mutex_unlock (&t->admin_mutex); |
2e77f720 LC |
1169 | scm_i_pthread_cancel (t->pthread); |
1170 | } | |
1171 | else | |
86a597f8 | 1172 | scm_i_pthread_mutex_unlock (&t->admin_mutex); |
2e77f720 LC |
1173 | |
1174 | return SCM_UNSPECIFIED; | |
1175 | } | |
1176 | #undef FUNC_NAME | |
1177 | ||
1178 | SCM_DEFINE (scm_set_thread_cleanup_x, "set-thread-cleanup!", 2, 0, 0, | |
1179 | (SCM thread, SCM proc), | |
1180 | "Set the thunk @var{proc} as the cleanup handler for the thread @var{thread}. " | |
1181 | "This handler will be called when the thread exits.") | |
1182 | #define FUNC_NAME s_scm_set_thread_cleanup_x | |
1183 | { | |
1184 | scm_i_thread *t; | |
1185 | ||
1186 | SCM_VALIDATE_THREAD (1, thread); | |
1187 | if (!scm_is_false (proc)) | |
1188 | SCM_VALIDATE_THUNK (2, proc); | |
1189 | ||
2e77f720 | 1190 | t = SCM_I_THREAD_DATA (thread); |
86a597f8 NJ |
1191 | scm_i_pthread_mutex_lock (&t->admin_mutex); |
1192 | ||
2e77f720 LC |
1193 | if (!(t->exited || t->canceled)) |
1194 | t->cleanup_handler = proc; | |
1195 | ||
86a597f8 | 1196 | scm_i_pthread_mutex_unlock (&t->admin_mutex); |
2e77f720 LC |
1197 | |
1198 | return SCM_UNSPECIFIED; | |
1199 | } | |
1200 | #undef FUNC_NAME | |
1201 | ||
1202 | SCM_DEFINE (scm_thread_cleanup, "thread-cleanup", 1, 0, 0, | |
1203 | (SCM thread), | |
1204 | "Return the cleanup handler installed for the thread @var{thread}.") | |
1205 | #define FUNC_NAME s_scm_thread_cleanup | |
1206 | { | |
1207 | scm_i_thread *t; | |
1208 | SCM ret; | |
1209 | ||
1210 | SCM_VALIDATE_THREAD (1, thread); | |
1211 | ||
2e77f720 | 1212 | t = SCM_I_THREAD_DATA (thread); |
86a597f8 | 1213 | scm_i_pthread_mutex_lock (&t->admin_mutex); |
2e77f720 | 1214 | ret = (t->exited || t->canceled) ? SCM_BOOL_F : t->cleanup_handler; |
86a597f8 | 1215 | scm_i_pthread_mutex_unlock (&t->admin_mutex); |
2e77f720 LC |
1216 | |
1217 | return ret; | |
1218 | } | |
1219 | #undef FUNC_NAME | |
1220 | ||
6180e336 NJ |
1221 | SCM scm_join_thread (SCM thread) |
1222 | { | |
1223 | return scm_join_thread_timed (thread, SCM_UNDEFINED, SCM_UNDEFINED); | |
1224 | } | |
1225 | ||
1226 | SCM_DEFINE (scm_join_thread_timed, "join-thread", 1, 2, 0, | |
1227 | (SCM thread, SCM timeout, SCM timeoutval), | |
d823b11b MV |
1228 | "Suspend execution of the calling thread until the target @var{thread} " |
1229 | "terminates, unless the target @var{thread} has already terminated. ") | |
6180e336 | 1230 | #define FUNC_NAME s_scm_join_thread_timed |
5f05c406 | 1231 | { |
9de87eea | 1232 | scm_i_thread *t; |
6180e336 NJ |
1233 | scm_t_timespec ctimeout, *timeout_ptr = NULL; |
1234 | SCM res = SCM_BOOL_F; | |
1235 | ||
1236 | if (! (SCM_UNBNDP (timeoutval))) | |
1237 | res = timeoutval; | |
d823b11b MV |
1238 | |
1239 | SCM_VALIDATE_THREAD (1, thread); | |
9de87eea | 1240 | if (scm_is_eq (scm_current_thread (), thread)) |
2e77f720 | 1241 | SCM_MISC_ERROR ("cannot join the current thread", SCM_EOL); |
d823b11b | 1242 | |
9de87eea | 1243 | t = SCM_I_THREAD_DATA (thread); |
86a597f8 NJ |
1244 | scm_i_scm_pthread_mutex_lock (&t->admin_mutex); |
1245 | ||
6180e336 NJ |
1246 | if (! SCM_UNBNDP (timeout)) |
1247 | { | |
1248 | to_timespec (timeout, &ctimeout); | |
1249 | timeout_ptr = &ctimeout; | |
1250 | } | |
1251 | ||
1252 | if (t->exited) | |
1253 | res = t->result; | |
1254 | else | |
d823b11b | 1255 | { |
9de87eea MV |
1256 | while (1) |
1257 | { | |
74926120 | 1258 | int err = block_self (t->join_queue, thread, &t->admin_mutex, |
6180e336 NJ |
1259 | timeout_ptr); |
1260 | if (err == 0) | |
1261 | { | |
1262 | if (t->exited) | |
1263 | { | |
1264 | res = t->result; | |
1265 | break; | |
1266 | } | |
1267 | } | |
1268 | else if (err == ETIMEDOUT) | |
9de87eea | 1269 | break; |
6180e336 | 1270 | |
86a597f8 | 1271 | scm_i_pthread_mutex_unlock (&t->admin_mutex); |
9de87eea | 1272 | SCM_TICK; |
86a597f8 | 1273 | scm_i_scm_pthread_mutex_lock (&t->admin_mutex); |
21346c4f NJ |
1274 | |
1275 | /* Check for exit again, since we just released and | |
1276 | reacquired the admin mutex, before the next block_self | |
1277 | call (which would block forever if t has already | |
1278 | exited). */ | |
1279 | if (t->exited) | |
1280 | { | |
1281 | res = t->result; | |
1282 | break; | |
1283 | } | |
9de87eea | 1284 | } |
d823b11b | 1285 | } |
9de87eea | 1286 | |
86a597f8 | 1287 | scm_i_pthread_mutex_unlock (&t->admin_mutex); |
2e77f720 | 1288 | |
d823b11b | 1289 | return res; |
5f05c406 MV |
1290 | } |
1291 | #undef FUNC_NAME | |
1292 | ||
6180e336 NJ |
1293 | SCM_DEFINE (scm_thread_p, "thread?", 1, 0, 0, |
1294 | (SCM obj), | |
1295 | "Return @code{#t} if @var{obj} is a thread.") | |
1296 | #define FUNC_NAME s_scm_thread_p | |
1297 | { | |
1298 | return SCM_I_IS_THREAD(obj) ? SCM_BOOL_T : SCM_BOOL_F; | |
1299 | } | |
1300 | #undef FUNC_NAME | |
5f05c406 | 1301 | |
4079f87e | 1302 | |
9de87eea MV |
1303 | static size_t |
1304 | fat_mutex_free (SCM mx) | |
76da80e7 | 1305 | { |
9de87eea MV |
1306 | fat_mutex *m = SCM_MUTEX_DATA (mx); |
1307 | scm_i_pthread_mutex_destroy (&m->lock); | |
76da80e7 MV |
1308 | return 0; |
1309 | } | |
1310 | ||
1311 | static int | |
9de87eea | 1312 | fat_mutex_print (SCM mx, SCM port, scm_print_state *pstate SCM_UNUSED) |
76da80e7 | 1313 | { |
9de87eea MV |
1314 | fat_mutex *m = SCM_MUTEX_DATA (mx); |
1315 | scm_puts ("#<mutex ", port); | |
1316 | scm_uintprint ((scm_t_bits)m, 16, port); | |
1317 | scm_puts (">", port); | |
1318 | return 1; | |
76da80e7 MV |
1319 | } |
1320 | ||
76da80e7 | 1321 | static SCM |
6180e336 | 1322 | make_fat_mutex (int recursive, int unchecked_unlock, int external_unlock) |
76da80e7 | 1323 | { |
9de87eea MV |
1324 | fat_mutex *m; |
1325 | SCM mx; | |
1326 | ||
1327 | m = scm_gc_malloc (sizeof (fat_mutex), "mutex"); | |
1328 | scm_i_pthread_mutex_init (&m->lock, NULL); | |
1329 | m->owner = SCM_BOOL_F; | |
adc085f1 | 1330 | m->level = 0; |
6180e336 | 1331 | |
adc085f1 | 1332 | m->recursive = recursive; |
6180e336 NJ |
1333 | m->unchecked_unlock = unchecked_unlock; |
1334 | m->allow_external_unlock = external_unlock; | |
1335 | ||
9de87eea MV |
1336 | m->waiting = SCM_EOL; |
1337 | SCM_NEWSMOB (mx, scm_tc16_mutex, (scm_t_bits) m); | |
1338 | m->waiting = make_queue (); | |
1339 | return mx; | |
76da80e7 MV |
1340 | } |
1341 | ||
6180e336 NJ |
1342 | SCM scm_make_mutex (void) |
1343 | { | |
1344 | return scm_make_mutex_with_flags (SCM_EOL); | |
1345 | } | |
1346 | ||
2a1d0688 NJ |
1347 | SCM_SYMBOL (unchecked_unlock_sym, "unchecked-unlock"); |
1348 | SCM_SYMBOL (allow_external_unlock_sym, "allow-external-unlock"); | |
1349 | SCM_SYMBOL (recursive_sym, "recursive"); | |
6180e336 NJ |
1350 | |
1351 | SCM_DEFINE (scm_make_mutex_with_flags, "make-mutex", 0, 0, 1, | |
1352 | (SCM flags), | |
9de87eea | 1353 | "Create a new mutex. ") |
6180e336 | 1354 | #define FUNC_NAME s_scm_make_mutex_with_flags |
76da80e7 | 1355 | { |
6180e336 NJ |
1356 | int unchecked_unlock = 0, external_unlock = 0, recursive = 0; |
1357 | ||
1358 | SCM ptr = flags; | |
1359 | while (! scm_is_null (ptr)) | |
1360 | { | |
1361 | SCM flag = SCM_CAR (ptr); | |
1362 | if (scm_is_eq (flag, unchecked_unlock_sym)) | |
1363 | unchecked_unlock = 1; | |
1364 | else if (scm_is_eq (flag, allow_external_unlock_sym)) | |
1365 | external_unlock = 1; | |
1366 | else if (scm_is_eq (flag, recursive_sym)) | |
1367 | recursive = 1; | |
74926120 | 1368 | else |
2a1d0688 | 1369 | SCM_MISC_ERROR ("unsupported mutex option: ~a", scm_list_1 (flag)); |
6180e336 NJ |
1370 | ptr = SCM_CDR (ptr); |
1371 | } | |
1372 | return make_fat_mutex (recursive, unchecked_unlock, external_unlock); | |
76da80e7 MV |
1373 | } |
1374 | #undef FUNC_NAME | |
1375 | ||
9de87eea | 1376 | SCM_DEFINE (scm_make_recursive_mutex, "make-recursive-mutex", 0, 0, 0, |
9bc4701c | 1377 | (void), |
9de87eea MV |
1378 | "Create a new recursive mutex. ") |
1379 | #define FUNC_NAME s_scm_make_recursive_mutex | |
9bc4701c | 1380 | { |
6180e336 | 1381 | return make_fat_mutex (1, 0, 0); |
9bc4701c MD |
1382 | } |
1383 | #undef FUNC_NAME | |
1384 | ||
6180e336 NJ |
1385 | SCM_SYMBOL (scm_abandoned_mutex_error_key, "abandoned-mutex-error"); |
1386 | ||
1387 | static SCM | |
adc085f1 | 1388 | fat_mutex_lock (SCM mutex, scm_t_timespec *timeout, SCM owner, int *ret) |
9de87eea MV |
1389 | { |
1390 | fat_mutex *m = SCM_MUTEX_DATA (mutex); | |
6180e336 | 1391 | |
adc085f1 | 1392 | SCM new_owner = SCM_UNBNDP (owner) ? scm_current_thread() : owner; |
6180e336 NJ |
1393 | SCM err = SCM_BOOL_F; |
1394 | ||
1395 | struct timeval current_time; | |
9de87eea MV |
1396 | |
1397 | scm_i_scm_pthread_mutex_lock (&m->lock); | |
adc085f1 JG |
1398 | |
1399 | while (1) | |
9de87eea | 1400 | { |
adc085f1 | 1401 | if (m->level == 0) |
6180e336 | 1402 | { |
adc085f1 | 1403 | m->owner = new_owner; |
6180e336 | 1404 | m->level++; |
74926120 | 1405 | |
adc085f1 | 1406 | if (SCM_I_IS_THREAD (new_owner)) |
6180e336 | 1407 | { |
adc085f1 | 1408 | scm_i_thread *t = SCM_I_THREAD_DATA (new_owner); |
ccb80964 | 1409 | |
4f39f31e LC |
1410 | /* FIXME: The order in which `t->admin_mutex' and |
1411 | `m->lock' are taken differs from that in | |
1412 | `on_thread_exit', potentially leading to deadlocks. */ | |
6180e336 | 1413 | scm_i_pthread_mutex_lock (&t->admin_mutex); |
a0faf7dd LC |
1414 | |
1415 | /* Only keep a weak reference to MUTEX so that it's not | |
f57fdf07 LC |
1416 | retained when not referenced elsewhere (bug #27450). |
1417 | The weak pair itself is eventually removed when MUTEX | |
1418 | is unlocked. Note that `t->mutexes' lists mutexes | |
1419 | currently held by T, so it should be small. */ | |
a0faf7dd LC |
1420 | t->mutexes = scm_weak_car_pair (mutex, t->mutexes); |
1421 | ||
6180e336 | 1422 | scm_i_pthread_mutex_unlock (&t->admin_mutex); |
6180e336 | 1423 | } |
adc085f1 JG |
1424 | *ret = 1; |
1425 | break; | |
1426 | } | |
1427 | else if (SCM_I_IS_THREAD (m->owner) && scm_c_thread_exited_p (m->owner)) | |
1428 | { | |
1429 | m->owner = new_owner; | |
1430 | err = scm_cons (scm_abandoned_mutex_error_key, | |
1431 | scm_from_locale_string ("lock obtained on abandoned " | |
1432 | "mutex")); | |
1433 | *ret = 1; | |
1434 | break; | |
1435 | } | |
1436 | else if (scm_is_eq (m->owner, new_owner)) | |
1437 | { | |
1438 | if (m->recursive) | |
1439 | { | |
1440 | m->level++; | |
74926120 | 1441 | *ret = 1; |
adc085f1 JG |
1442 | } |
1443 | else | |
6180e336 | 1444 | { |
adc085f1 JG |
1445 | err = scm_cons (scm_misc_error_key, |
1446 | scm_from_locale_string ("mutex already locked " | |
1447 | "by thread")); | |
1448 | *ret = 0; | |
1449 | } | |
74926120 | 1450 | break; |
adc085f1 | 1451 | } |
9de87eea | 1452 | else |
9de87eea | 1453 | { |
74926120 | 1454 | if (timeout != NULL) |
adc085f1 JG |
1455 | { |
1456 | gettimeofday (¤t_time, NULL); | |
1457 | if (current_time.tv_sec > timeout->tv_sec || | |
1458 | (current_time.tv_sec == timeout->tv_sec && | |
1459 | current_time.tv_usec * 1000 > timeout->tv_nsec)) | |
6180e336 | 1460 | { |
adc085f1 JG |
1461 | *ret = 0; |
1462 | break; | |
6180e336 | 1463 | } |
6180e336 | 1464 | } |
37a52039 | 1465 | block_self (m->waiting, mutex, &m->lock, timeout); |
9de87eea MV |
1466 | scm_i_pthread_mutex_unlock (&m->lock); |
1467 | SCM_TICK; | |
1468 | scm_i_scm_pthread_mutex_lock (&m->lock); | |
1469 | } | |
1470 | } | |
1471 | scm_i_pthread_mutex_unlock (&m->lock); | |
6180e336 | 1472 | return err; |
9de87eea MV |
1473 | } |
1474 | ||
6180e336 NJ |
1475 | SCM scm_lock_mutex (SCM mx) |
1476 | { | |
adc085f1 | 1477 | return scm_lock_mutex_timed (mx, SCM_UNDEFINED, SCM_UNDEFINED); |
6180e336 NJ |
1478 | } |
1479 | ||
adc085f1 JG |
1480 | SCM_DEFINE (scm_lock_mutex_timed, "lock-mutex", 1, 2, 0, |
1481 | (SCM m, SCM timeout, SCM owner), | |
b7e64f8b BT |
1482 | "Lock mutex @var{m}. If the mutex is already locked, the calling\n" |
1483 | "thread blocks until the mutex becomes available. The function\n" | |
1484 | "returns when the calling thread owns the lock on @var{m}.\n" | |
1485 | "Locking a mutex that a thread already owns will succeed right\n" | |
1486 | "away and will not block the thread. That is, Guile's mutexes\n" | |
1487 | "are @emph{recursive}.") | |
6180e336 | 1488 | #define FUNC_NAME s_scm_lock_mutex_timed |
9bc4701c | 1489 | { |
6180e336 NJ |
1490 | SCM exception; |
1491 | int ret = 0; | |
1492 | scm_t_timespec cwaittime, *waittime = NULL; | |
76da80e7 | 1493 | |
6180e336 NJ |
1494 | SCM_VALIDATE_MUTEX (1, m); |
1495 | ||
1496 | if (! SCM_UNBNDP (timeout) && ! scm_is_false (timeout)) | |
1497 | { | |
1498 | to_timespec (timeout, &cwaittime); | |
1499 | waittime = &cwaittime; | |
1500 | } | |
1501 | ||
97ec95b7 LC |
1502 | if (!SCM_UNBNDP (owner) && !scm_is_false (owner)) |
1503 | SCM_VALIDATE_THREAD (3, owner); | |
1504 | ||
adc085f1 | 1505 | exception = fat_mutex_lock (m, waittime, owner, &ret); |
6180e336 NJ |
1506 | if (!scm_is_false (exception)) |
1507 | scm_ithrow (SCM_CAR (exception), scm_list_1 (SCM_CDR (exception)), 1); | |
1508 | return ret ? SCM_BOOL_T : SCM_BOOL_F; | |
9bc4701c | 1509 | } |
76da80e7 | 1510 | #undef FUNC_NAME |
9bc4701c | 1511 | |
2a3db25e MW |
1512 | static void |
1513 | lock_mutex_return_void (SCM mx) | |
1514 | { | |
1515 | (void) scm_lock_mutex (mx); | |
1516 | } | |
1517 | ||
1518 | static void | |
1519 | unlock_mutex_return_void (SCM mx) | |
1520 | { | |
1521 | (void) scm_unlock_mutex (mx); | |
1522 | } | |
1523 | ||
a4d106c7 | 1524 | void |
661ae7ab | 1525 | scm_dynwind_lock_mutex (SCM mutex) |
a4d106c7 | 1526 | { |
2a3db25e | 1527 | scm_dynwind_unwind_handler_with_scm (unlock_mutex_return_void, mutex, |
661ae7ab | 1528 | SCM_F_WIND_EXPLICITLY); |
2a3db25e | 1529 | scm_dynwind_rewind_handler_with_scm (lock_mutex_return_void, mutex, |
661ae7ab | 1530 | SCM_F_WIND_EXPLICITLY); |
a4d106c7 MV |
1531 | } |
1532 | ||
9bc4701c | 1533 | SCM_DEFINE (scm_try_mutex, "try-mutex", 1, 0, 0, |
ba1b7223 | 1534 | (SCM mutex), |
9bc4701c MD |
1535 | "Try to lock @var{mutex}. If the mutex is already locked by someone " |
1536 | "else, return @code{#f}. Else lock the mutex and return @code{#t}. ") | |
1537 | #define FUNC_NAME s_scm_try_mutex | |
1538 | { | |
6180e336 NJ |
1539 | SCM exception; |
1540 | int ret = 0; | |
1541 | scm_t_timespec cwaittime, *waittime = NULL; | |
9de87eea | 1542 | |
ba1b7223 | 1543 | SCM_VALIDATE_MUTEX (1, mutex); |
6180e336 NJ |
1544 | |
1545 | to_timespec (scm_from_int(0), &cwaittime); | |
1546 | waittime = &cwaittime; | |
74926120 | 1547 | |
adc085f1 | 1548 | exception = fat_mutex_lock (mutex, waittime, SCM_UNDEFINED, &ret); |
6180e336 NJ |
1549 | if (!scm_is_false (exception)) |
1550 | scm_ithrow (SCM_CAR (exception), scm_list_1 (SCM_CDR (exception)), 1); | |
1551 | return ret ? SCM_BOOL_T : SCM_BOOL_F; | |
9de87eea MV |
1552 | } |
1553 | #undef FUNC_NAME | |
76da80e7 | 1554 | |
6180e336 NJ |
1555 | /*** Fat condition variables */ |
1556 | ||
1557 | typedef struct { | |
1558 | scm_i_pthread_mutex_t lock; | |
1559 | SCM waiting; /* the threads waiting for this condition. */ | |
1560 | } fat_cond; | |
1561 | ||
1562 | #define SCM_CONDVARP(x) SCM_SMOB_PREDICATE (scm_tc16_condvar, x) | |
1563 | #define SCM_CONDVAR_DATA(x) ((fat_cond *) SCM_SMOB_DATA (x)) | |
1564 | ||
1565 | static int | |
1566 | fat_mutex_unlock (SCM mutex, SCM cond, | |
1567 | const scm_t_timespec *waittime, int relock) | |
9de87eea | 1568 | { |
7f991c7d | 1569 | SCM owner; |
6180e336 NJ |
1570 | fat_mutex *m = SCM_MUTEX_DATA (mutex); |
1571 | fat_cond *c = NULL; | |
1572 | scm_i_thread *t = SCM_I_CURRENT_THREAD; | |
1573 | int err = 0, ret = 0; | |
9de87eea MV |
1574 | |
1575 | scm_i_scm_pthread_mutex_lock (&m->lock); | |
adc085f1 | 1576 | |
7f991c7d | 1577 | owner = m->owner; |
adc085f1 | 1578 | |
d31ae2c3 | 1579 | if (!scm_is_eq (owner, t->handle)) |
9bc4701c | 1580 | { |
adc085f1 | 1581 | if (m->level == 0) |
6180e336 NJ |
1582 | { |
1583 | if (!m->unchecked_unlock) | |
2a1d0688 NJ |
1584 | { |
1585 | scm_i_pthread_mutex_unlock (&m->lock); | |
1586 | scm_misc_error (NULL, "mutex not locked", SCM_EOL); | |
1587 | } | |
d31ae2c3 | 1588 | owner = t->handle; |
6180e336 NJ |
1589 | } |
1590 | else if (!m->allow_external_unlock) | |
2a1d0688 NJ |
1591 | { |
1592 | scm_i_pthread_mutex_unlock (&m->lock); | |
1593 | scm_misc_error (NULL, "mutex not locked by current thread", SCM_EOL); | |
1594 | } | |
6180e336 NJ |
1595 | } |
1596 | ||
1597 | if (! (SCM_UNBNDP (cond))) | |
1598 | { | |
6180e336 NJ |
1599 | c = SCM_CONDVAR_DATA (cond); |
1600 | while (1) | |
1601 | { | |
1602 | int brk = 0; | |
1603 | ||
6180e336 NJ |
1604 | if (m->level > 0) |
1605 | m->level--; | |
adc085f1 | 1606 | if (m->level == 0) |
f57fdf07 LC |
1607 | { |
1608 | /* Change the owner of MUTEX. */ | |
1609 | t->mutexes = scm_delq_x (mutex, t->mutexes); | |
1610 | m->owner = unblock_from_queue (m->waiting); | |
1611 | } | |
adc085f1 | 1612 | |
6180e336 | 1613 | t->block_asyncs++; |
74926120 | 1614 | |
d2a51087 NJ |
1615 | err = block_self (c->waiting, cond, &m->lock, waittime); |
1616 | scm_i_pthread_mutex_unlock (&m->lock); | |
6180e336 NJ |
1617 | |
1618 | if (err == 0) | |
1619 | { | |
1620 | ret = 1; | |
1621 | brk = 1; | |
1622 | } | |
1623 | else if (err == ETIMEDOUT) | |
1624 | { | |
1625 | ret = 0; | |
1626 | brk = 1; | |
1627 | } | |
1628 | else if (err != EINTR) | |
74926120 | 1629 | { |
6180e336 | 1630 | errno = err; |
6180e336 | 1631 | scm_syserror (NULL); |
74926120 | 1632 | } |
6180e336 NJ |
1633 | |
1634 | if (brk) | |
1635 | { | |
1636 | if (relock) | |
adc085f1 | 1637 | scm_lock_mutex_timed (mutex, SCM_UNDEFINED, owner); |
4201062d | 1638 | t->block_asyncs--; |
6180e336 NJ |
1639 | break; |
1640 | } | |
74926120 | 1641 | |
6180e336 NJ |
1642 | t->block_asyncs--; |
1643 | scm_async_click (); | |
74926120 | 1644 | |
6180e336 NJ |
1645 | scm_remember_upto_here_2 (cond, mutex); |
1646 | ||
1647 | scm_i_scm_pthread_mutex_lock (&m->lock); | |
1648 | } | |
9bc4701c | 1649 | } |
9de87eea | 1650 | else |
6180e336 NJ |
1651 | { |
1652 | if (m->level > 0) | |
1653 | m->level--; | |
74926120 | 1654 | if (m->level == 0) |
f57fdf07 LC |
1655 | { |
1656 | /* Change the owner of MUTEX. */ | |
1657 | t->mutexes = scm_delq_x (mutex, t->mutexes); | |
1658 | m->owner = unblock_from_queue (m->waiting); | |
1659 | } | |
74926120 | 1660 | |
6180e336 NJ |
1661 | scm_i_pthread_mutex_unlock (&m->lock); |
1662 | ret = 1; | |
1663 | } | |
9de87eea | 1664 | |
6180e336 | 1665 | return ret; |
9bc4701c | 1666 | } |
9bc4701c | 1667 | |
6180e336 NJ |
1668 | SCM scm_unlock_mutex (SCM mx) |
1669 | { | |
1670 | return scm_unlock_mutex_timed (mx, SCM_UNDEFINED, SCM_UNDEFINED); | |
9bc4701c | 1671 | } |
9bc4701c | 1672 | |
6180e336 NJ |
1673 | SCM_DEFINE (scm_unlock_mutex_timed, "unlock-mutex", 1, 2, 0, |
1674 | (SCM mx, SCM cond, SCM timeout), | |
9bc4701c MD |
1675 | "Unlocks @var{mutex} if the calling thread owns the lock on " |
1676 | "@var{mutex}. Calling unlock-mutex on a mutex not owned by the current " | |
1677 | "thread results in undefined behaviour. Once a mutex has been unlocked, " | |
1678 | "one thread blocked on @var{mutex} is awakened and grabs the mutex " | |
1679 | "lock. Every call to @code{lock-mutex} by this thread must be matched " | |
1680 | "with a call to @code{unlock-mutex}. Only the last call to " | |
1681 | "@code{unlock-mutex} will actually unlock the mutex. ") | |
6180e336 | 1682 | #define FUNC_NAME s_scm_unlock_mutex_timed |
9bc4701c | 1683 | { |
6180e336 NJ |
1684 | scm_t_timespec cwaittime, *waittime = NULL; |
1685 | ||
9bc4701c | 1686 | SCM_VALIDATE_MUTEX (1, mx); |
6180e336 NJ |
1687 | if (! (SCM_UNBNDP (cond))) |
1688 | { | |
1689 | SCM_VALIDATE_CONDVAR (2, cond); | |
1690 | ||
1691 | if (! (SCM_UNBNDP (timeout))) | |
1692 | { | |
1693 | to_timespec (timeout, &cwaittime); | |
1694 | waittime = &cwaittime; | |
1695 | } | |
1696 | } | |
1697 | ||
1698 | return fat_mutex_unlock (mx, cond, waittime, 0) ? SCM_BOOL_T : SCM_BOOL_F; | |
9bc4701c MD |
1699 | } |
1700 | #undef FUNC_NAME | |
1701 | ||
6180e336 NJ |
1702 | SCM_DEFINE (scm_mutex_p, "mutex?", 1, 0, 0, |
1703 | (SCM obj), | |
1704 | "Return @code{#t} if @var{obj} is a mutex.") | |
1705 | #define FUNC_NAME s_scm_mutex_p | |
1706 | { | |
1707 | return SCM_MUTEXP (obj) ? SCM_BOOL_T : SCM_BOOL_F; | |
1708 | } | |
74926120 | 1709 | #undef FUNC_NAME |
9de87eea MV |
1710 | |
1711 | SCM_DEFINE (scm_mutex_owner, "mutex-owner", 1, 0, 0, | |
1712 | (SCM mx), | |
1713 | "Return the thread owning @var{mx}, or @code{#f}.") | |
1714 | #define FUNC_NAME s_scm_mutex_owner | |
1715 | { | |
adc085f1 JG |
1716 | SCM owner; |
1717 | fat_mutex *m = NULL; | |
1718 | ||
9de87eea | 1719 | SCM_VALIDATE_MUTEX (1, mx); |
adc085f1 JG |
1720 | m = SCM_MUTEX_DATA (mx); |
1721 | scm_i_pthread_mutex_lock (&m->lock); | |
1722 | owner = m->owner; | |
1723 | scm_i_pthread_mutex_unlock (&m->lock); | |
1724 | ||
1725 | return owner; | |
9de87eea MV |
1726 | } |
1727 | #undef FUNC_NAME | |
1728 | ||
1729 | SCM_DEFINE (scm_mutex_level, "mutex-level", 1, 0, 0, | |
1730 | (SCM mx), | |
adc085f1 | 1731 | "Return the lock level of mutex @var{mx}.") |
9de87eea MV |
1732 | #define FUNC_NAME s_scm_mutex_level |
1733 | { | |
1734 | SCM_VALIDATE_MUTEX (1, mx); | |
1735 | return scm_from_int (SCM_MUTEX_DATA(mx)->level); | |
1736 | } | |
1737 | #undef FUNC_NAME | |
1738 | ||
adc085f1 JG |
1739 | SCM_DEFINE (scm_mutex_locked_p, "mutex-locked?", 1, 0, 0, |
1740 | (SCM mx), | |
1741 | "Returns @code{#t} if the mutex @var{mx} is locked.") | |
1742 | #define FUNC_NAME s_scm_mutex_locked_p | |
1743 | { | |
1744 | SCM_VALIDATE_MUTEX (1, mx); | |
1745 | return SCM_MUTEX_DATA (mx)->level > 0 ? SCM_BOOL_T : SCM_BOOL_F; | |
1746 | } | |
1747 | #undef FUNC_NAME | |
9de87eea | 1748 | |
9de87eea MV |
1749 | static int |
1750 | fat_cond_print (SCM cv, SCM port, scm_print_state *pstate SCM_UNUSED) | |
1751 | { | |
1752 | fat_cond *c = SCM_CONDVAR_DATA (cv); | |
1753 | scm_puts ("#<condition-variable ", port); | |
1754 | scm_uintprint ((scm_t_bits)c, 16, port); | |
1755 | scm_puts (">", port); | |
1756 | return 1; | |
1757 | } | |
9bc4701c | 1758 | |
d823b11b MV |
1759 | SCM_DEFINE (scm_make_condition_variable, "make-condition-variable", 0, 0, 0, |
1760 | (void), | |
1761 | "Make a new condition variable.") | |
1762 | #define FUNC_NAME s_scm_make_condition_variable | |
5f05c406 | 1763 | { |
9de87eea MV |
1764 | fat_cond *c; |
1765 | SCM cv; | |
1766 | ||
1767 | c = scm_gc_malloc (sizeof (fat_cond), "condition variable"); | |
9de87eea MV |
1768 | c->waiting = SCM_EOL; |
1769 | SCM_NEWSMOB (cv, scm_tc16_condvar, (scm_t_bits) c); | |
1770 | c->waiting = make_queue (); | |
d823b11b | 1771 | return cv; |
5f05c406 | 1772 | } |
d823b11b | 1773 | #undef FUNC_NAME |
5f05c406 | 1774 | |
d823b11b MV |
1775 | SCM_DEFINE (scm_timed_wait_condition_variable, "wait-condition-variable", 2, 1, 0, |
1776 | (SCM cv, SCM mx, SCM t), | |
b7e64f8b BT |
1777 | "Wait until condition variable @var{cv} has been signalled. While waiting, " |
1778 | "mutex @var{mx} is atomically unlocked (as with @code{unlock-mutex}) and " | |
1779 | "is locked again when this function returns. When @var{t} is given, " | |
d823b11b MV |
1780 | "it specifies a point in time where the waiting should be aborted. It " |
1781 | "can be either a integer as returned by @code{current-time} or a pair " | |
1782 | "as returned by @code{gettimeofday}. When the waiting is aborted the " | |
1783 | "mutex is locked and @code{#f} is returned. When the condition " | |
1784 | "variable is in fact signalled, the mutex is also locked and @code{#t} " | |
1785 | "is returned. ") | |
1786 | #define FUNC_NAME s_scm_timed_wait_condition_variable | |
5f05c406 | 1787 | { |
9de87eea | 1788 | scm_t_timespec waittime, *waitptr = NULL; |
d823b11b MV |
1789 | |
1790 | SCM_VALIDATE_CONDVAR (1, cv); | |
1791 | SCM_VALIDATE_MUTEX (2, mx); | |
74926120 | 1792 | |
d823b11b MV |
1793 | if (!SCM_UNBNDP (t)) |
1794 | { | |
6180e336 | 1795 | to_timespec (t, &waittime); |
9de87eea | 1796 | waitptr = &waittime; |
d823b11b MV |
1797 | } |
1798 | ||
2a1d0688 | 1799 | return fat_mutex_unlock (mx, cv, waitptr, 1) ? SCM_BOOL_T : SCM_BOOL_F; |
5f05c406 | 1800 | } |
d823b11b | 1801 | #undef FUNC_NAME |
5f05c406 | 1802 | |
9de87eea MV |
1803 | static void |
1804 | fat_cond_signal (fat_cond *c) | |
1805 | { | |
9de87eea | 1806 | unblock_from_queue (c->waiting); |
9de87eea MV |
1807 | } |
1808 | ||
d823b11b MV |
1809 | SCM_DEFINE (scm_signal_condition_variable, "signal-condition-variable", 1, 0, 0, |
1810 | (SCM cv), | |
1811 | "Wake up one thread that is waiting for @var{cv}") | |
1812 | #define FUNC_NAME s_scm_signal_condition_variable | |
5f05c406 | 1813 | { |
d823b11b | 1814 | SCM_VALIDATE_CONDVAR (1, cv); |
9de87eea | 1815 | fat_cond_signal (SCM_CONDVAR_DATA (cv)); |
d823b11b | 1816 | return SCM_BOOL_T; |
5f05c406 | 1817 | } |
d823b11b | 1818 | #undef FUNC_NAME |
5f05c406 | 1819 | |
9de87eea MV |
1820 | static void |
1821 | fat_cond_broadcast (fat_cond *c) | |
1822 | { | |
9de87eea MV |
1823 | while (scm_is_true (unblock_from_queue (c->waiting))) |
1824 | ; | |
9de87eea MV |
1825 | } |
1826 | ||
d823b11b MV |
1827 | SCM_DEFINE (scm_broadcast_condition_variable, "broadcast-condition-variable", 1, 0, 0, |
1828 | (SCM cv), | |
1829 | "Wake up all threads that are waiting for @var{cv}. ") | |
1830 | #define FUNC_NAME s_scm_broadcast_condition_variable | |
5f05c406 | 1831 | { |
d823b11b | 1832 | SCM_VALIDATE_CONDVAR (1, cv); |
9de87eea | 1833 | fat_cond_broadcast (SCM_CONDVAR_DATA (cv)); |
d823b11b | 1834 | return SCM_BOOL_T; |
5f05c406 | 1835 | } |
d823b11b | 1836 | #undef FUNC_NAME |
5f05c406 | 1837 | |
6180e336 NJ |
1838 | SCM_DEFINE (scm_condition_variable_p, "condition-variable?", 1, 0, 0, |
1839 | (SCM obj), | |
1840 | "Return @code{#t} if @var{obj} is a condition variable.") | |
1841 | #define FUNC_NAME s_scm_condition_variable_p | |
1842 | { | |
1843 | return SCM_CONDVARP(obj) ? SCM_BOOL_T : SCM_BOOL_F; | |
1844 | } | |
1845 | #undef FUNC_NAME | |
1846 | ||
6087fad9 | 1847 | |
8c2b3143 | 1848 | \f |
d823b11b MV |
1849 | /*** Select */ |
1850 | ||
8c2b3143 LC |
1851 | struct select_args |
1852 | { | |
1853 | int nfds; | |
1854 | SELECT_TYPE *read_fds; | |
1855 | SELECT_TYPE *write_fds; | |
1856 | SELECT_TYPE *except_fds; | |
1857 | struct timeval *timeout; | |
1858 | ||
1859 | int result; | |
1860 | int errno_value; | |
1861 | }; | |
1862 | ||
1863 | static void * | |
1864 | do_std_select (void *args) | |
1865 | { | |
1866 | struct select_args *select_args; | |
1867 | ||
1868 | select_args = (struct select_args *) args; | |
1869 | ||
1870 | select_args->result = | |
1871 | select (select_args->nfds, | |
1872 | select_args->read_fds, select_args->write_fds, | |
1873 | select_args->except_fds, select_args->timeout); | |
1874 | select_args->errno_value = errno; | |
1875 | ||
1876 | return NULL; | |
1877 | } | |
1878 | ||
911782b7 | 1879 | int |
9de87eea MV |
1880 | scm_std_select (int nfds, |
1881 | SELECT_TYPE *readfds, | |
1882 | SELECT_TYPE *writefds, | |
1883 | SELECT_TYPE *exceptfds, | |
1884 | struct timeval *timeout) | |
1885 | { | |
1886 | fd_set my_readfds; | |
1887 | int res, eno, wakeup_fd; | |
1888 | scm_i_thread *t = SCM_I_CURRENT_THREAD; | |
8c2b3143 | 1889 | struct select_args args; |
9de87eea MV |
1890 | |
1891 | if (readfds == NULL) | |
1892 | { | |
1893 | FD_ZERO (&my_readfds); | |
1894 | readfds = &my_readfds; | |
1895 | } | |
1896 | ||
1897 | while (scm_i_setup_sleep (t, SCM_BOOL_F, NULL, t->sleep_pipe[1])) | |
1898 | SCM_TICK; | |
1899 | ||
1900 | wakeup_fd = t->sleep_pipe[0]; | |
9de87eea MV |
1901 | FD_SET (wakeup_fd, readfds); |
1902 | if (wakeup_fd >= nfds) | |
1903 | nfds = wakeup_fd+1; | |
9de87eea | 1904 | |
8c2b3143 LC |
1905 | args.nfds = nfds; |
1906 | args.read_fds = readfds; | |
1907 | args.write_fds = writefds; | |
1908 | args.except_fds = exceptfds; | |
1909 | args.timeout = timeout; | |
1910 | ||
1911 | /* Explicitly cooperate with the GC. */ | |
1912 | scm_without_guile (do_std_select, &args); | |
1913 | ||
1914 | res = args.result; | |
1915 | eno = args.errno_value; | |
1916 | ||
1917 | t->sleep_fd = -1; | |
9de87eea MV |
1918 | scm_i_reset_sleep (t); |
1919 | ||
1920 | if (res > 0 && FD_ISSET (wakeup_fd, readfds)) | |
1921 | { | |
1922 | char dummy; | |
634aa8de LC |
1923 | full_read (wakeup_fd, &dummy, 1); |
1924 | ||
9de87eea MV |
1925 | FD_CLR (wakeup_fd, readfds); |
1926 | res -= 1; | |
1927 | if (res == 0) | |
1928 | { | |
1929 | eno = EINTR; | |
1930 | res = -1; | |
1931 | } | |
1932 | } | |
d823b11b MV |
1933 | errno = eno; |
1934 | return res; | |
5f05c406 MV |
1935 | } |
1936 | ||
9de87eea | 1937 | /* Convenience API for blocking while in guile mode. */ |
76da80e7 | 1938 | |
9de87eea | 1939 | #if SCM_USE_PTHREAD_THREADS |
92e64b87 | 1940 | |
2956b071 LC |
1941 | /* It seems reasonable to not run procedures related to mutex and condition |
1942 | variables within `GC_do_blocking ()' since, (i) the GC can operate even | |
1943 | without it, and (ii) the only potential gain would be GC latency. See | |
1944 | http://thread.gmane.org/gmane.comp.programming.garbage-collection.boehmgc/2245/focus=2251 | |
1945 | for a discussion of the pros and cons. */ | |
1946 | ||
9bc4701c | 1947 | int |
9de87eea | 1948 | scm_pthread_mutex_lock (scm_i_pthread_mutex_t *mutex) |
9bc4701c | 1949 | { |
9de87eea | 1950 | int res = scm_i_pthread_mutex_lock (mutex); |
9bc4701c MD |
1951 | return res; |
1952 | } | |
1953 | ||
9de87eea | 1954 | static void |
2b829bbb | 1955 | do_unlock (void *data) |
28d52ebb | 1956 | { |
9de87eea | 1957 | scm_i_pthread_mutex_unlock ((scm_i_pthread_mutex_t *)data); |
28d52ebb MD |
1958 | } |
1959 | ||
1960 | void | |
661ae7ab | 1961 | scm_dynwind_pthread_mutex_lock (scm_i_pthread_mutex_t *mutex) |
28d52ebb | 1962 | { |
9de87eea | 1963 | scm_i_scm_pthread_mutex_lock (mutex); |
2b829bbb | 1964 | scm_dynwind_unwind_handler (do_unlock, mutex, SCM_F_WIND_EXPLICITLY); |
28d52ebb MD |
1965 | } |
1966 | ||
9bc4701c | 1967 | int |
9de87eea | 1968 | scm_pthread_cond_wait (scm_i_pthread_cond_t *cond, scm_i_pthread_mutex_t *mutex) |
9bc4701c | 1969 | { |
4cf72f0b LC |
1970 | int res; |
1971 | scm_i_thread *t = SCM_I_CURRENT_THREAD; | |
1972 | ||
1973 | t->held_mutex = mutex; | |
1974 | res = scm_i_pthread_cond_wait (cond, mutex); | |
1975 | t->held_mutex = NULL; | |
1976 | ||
9bc4701c MD |
1977 | return res; |
1978 | } | |
9bc4701c | 1979 | |
76da80e7 | 1980 | int |
9de87eea MV |
1981 | scm_pthread_cond_timedwait (scm_i_pthread_cond_t *cond, |
1982 | scm_i_pthread_mutex_t *mutex, | |
1983 | const scm_t_timespec *wt) | |
76da80e7 | 1984 | { |
4cf72f0b LC |
1985 | int res; |
1986 | scm_i_thread *t = SCM_I_CURRENT_THREAD; | |
1987 | ||
1988 | t->held_mutex = mutex; | |
1989 | res = scm_i_pthread_cond_timedwait (cond, mutex, wt); | |
1990 | t->held_mutex = NULL; | |
1991 | ||
9de87eea | 1992 | return res; |
76da80e7 MV |
1993 | } |
1994 | ||
9de87eea | 1995 | #endif |
76da80e7 | 1996 | |
d823b11b | 1997 | unsigned long |
9de87eea | 1998 | scm_std_usleep (unsigned long usecs) |
5f05c406 | 1999 | { |
d823b11b MV |
2000 | struct timeval tv; |
2001 | tv.tv_usec = usecs % 1000000; | |
2002 | tv.tv_sec = usecs / 1000000; | |
9de87eea MV |
2003 | scm_std_select (0, NULL, NULL, NULL, &tv); |
2004 | return tv.tv_sec * 1000000 + tv.tv_usec; | |
5f05c406 MV |
2005 | } |
2006 | ||
9de87eea MV |
2007 | unsigned int |
2008 | scm_std_sleep (unsigned int secs) | |
6c214b62 | 2009 | { |
d823b11b MV |
2010 | struct timeval tv; |
2011 | tv.tv_usec = 0; | |
2012 | tv.tv_sec = secs; | |
9de87eea | 2013 | scm_std_select (0, NULL, NULL, NULL, &tv); |
d823b11b | 2014 | return tv.tv_sec; |
6c214b62 MD |
2015 | } |
2016 | ||
d823b11b MV |
2017 | /*** Misc */ |
2018 | ||
2019 | SCM_DEFINE (scm_current_thread, "current-thread", 0, 0, 0, | |
2020 | (void), | |
2021 | "Return the thread that called this function.") | |
2022 | #define FUNC_NAME s_scm_current_thread | |
2023 | { | |
9de87eea | 2024 | return SCM_I_CURRENT_THREAD->handle; |
d823b11b MV |
2025 | } |
2026 | #undef FUNC_NAME | |
2027 | ||
9de87eea MV |
2028 | static SCM |
2029 | scm_c_make_list (size_t n, SCM fill) | |
2030 | { | |
2031 | SCM res = SCM_EOL; | |
2032 | while (n-- > 0) | |
2033 | res = scm_cons (fill, res); | |
2034 | return res; | |
2035 | } | |
2036 | ||
d823b11b MV |
2037 | SCM_DEFINE (scm_all_threads, "all-threads", 0, 0, 0, |
2038 | (void), | |
2039 | "Return a list of all threads.") | |
9bc4701c | 2040 | #define FUNC_NAME s_scm_all_threads |
d823b11b | 2041 | { |
9de87eea MV |
2042 | /* We can not allocate while holding the thread_admin_mutex because |
2043 | of the way GC is done. | |
2044 | */ | |
2045 | int n = thread_count; | |
2046 | scm_i_thread *t; | |
2047 | SCM list = scm_c_make_list (n, SCM_UNSPECIFIED), *l; | |
d823b11b | 2048 | |
9de87eea MV |
2049 | scm_i_pthread_mutex_lock (&thread_admin_mutex); |
2050 | l = &list; | |
2051 | for (t = all_threads; t && n > 0; t = t->next_thread) | |
2052 | { | |
2e77f720 LC |
2053 | if (t != scm_i_signal_delivery_thread) |
2054 | { | |
2055 | SCM_SETCAR (*l, t->handle); | |
2056 | l = SCM_CDRLOC (*l); | |
2057 | } | |
9de87eea MV |
2058 | n--; |
2059 | } | |
2060 | *l = SCM_EOL; | |
2061 | scm_i_pthread_mutex_unlock (&thread_admin_mutex); | |
2062 | return list; | |
d823b11b | 2063 | } |
9de87eea | 2064 | #undef FUNC_NAME |
d823b11b MV |
2065 | |
2066 | SCM_DEFINE (scm_thread_exited_p, "thread-exited?", 1, 0, 0, | |
2067 | (SCM thread), | |
2068 | "Return @code{#t} iff @var{thread} has exited.\n") | |
2069 | #define FUNC_NAME s_scm_thread_exited_p | |
2070 | { | |
7888309b | 2071 | return scm_from_bool (scm_c_thread_exited_p (thread)); |
d823b11b MV |
2072 | } |
2073 | #undef FUNC_NAME | |
2074 | ||
911782b7 | 2075 | int |
d823b11b MV |
2076 | scm_c_thread_exited_p (SCM thread) |
2077 | #define FUNC_NAME s_scm_thread_exited_p | |
5f05c406 | 2078 | { |
9de87eea | 2079 | scm_i_thread *t; |
d823b11b | 2080 | SCM_VALIDATE_THREAD (1, thread); |
9de87eea | 2081 | t = SCM_I_THREAD_DATA (thread); |
d823b11b | 2082 | return t->exited; |
5f05c406 | 2083 | } |
d823b11b | 2084 | #undef FUNC_NAME |
5f05c406 | 2085 | |
d20912e6 LC |
2086 | SCM_DEFINE (scm_total_processor_count, "total-processor-count", 0, 0, 0, |
2087 | (void), | |
2088 | "Return the total number of processors of the machine, which\n" | |
2089 | "is guaranteed to be at least 1. A ``processor'' here is a\n" | |
2090 | "thread execution unit, which can be either:\n\n" | |
2091 | "@itemize\n" | |
2092 | "@item an execution core in a (possibly multi-core) chip, in a\n" | |
2093 | " (possibly multi- chip) module, in a single computer, or\n" | |
2094 | "@item a thread execution unit inside a core in the case of\n" | |
2095 | " @dfn{hyper-threaded} CPUs.\n" | |
2096 | "@end itemize\n\n" | |
2097 | "Which of the two definitions is used, is unspecified.\n") | |
2098 | #define FUNC_NAME s_scm_total_processor_count | |
2099 | { | |
2100 | return scm_from_ulong (num_processors (NPROC_ALL)); | |
2101 | } | |
2102 | #undef FUNC_NAME | |
2103 | ||
2104 | SCM_DEFINE (scm_current_processor_count, "current-processor-count", 0, 0, 0, | |
2105 | (void), | |
2106 | "Like @code{total-processor-count}, but return the number of\n" | |
2107 | "processors available to the current process. See\n" | |
2108 | "@code{setaffinity} and @code{getaffinity} for more\n" | |
2109 | "information.\n") | |
2110 | #define FUNC_NAME s_scm_current_processor_count | |
2111 | { | |
2112 | return scm_from_ulong (num_processors (NPROC_CURRENT)); | |
2113 | } | |
2114 | #undef FUNC_NAME | |
2115 | ||
2116 | ||
2117 | \f | |
2118 | ||
9de87eea | 2119 | static scm_i_pthread_cond_t wake_up_cond; |
9bc4701c MD |
2120 | static int threads_initialized_p = 0; |
2121 | ||
9bc4701c | 2122 | |
a4d106c7 MV |
2123 | /* This mutex is used by SCM_CRITICAL_SECTION_START/END. |
2124 | */ | |
d1138028 | 2125 | scm_i_pthread_mutex_t scm_i_critical_section_mutex; |
a4d106c7 | 2126 | |
661ae7ab | 2127 | static SCM dynwind_critical_section_mutex; |
a54a94b3 | 2128 | |
9bc4701c | 2129 | void |
661ae7ab | 2130 | scm_dynwind_critical_section (SCM mutex) |
76da80e7 | 2131 | { |
a4d106c7 | 2132 | if (scm_is_false (mutex)) |
661ae7ab MV |
2133 | mutex = dynwind_critical_section_mutex; |
2134 | scm_dynwind_lock_mutex (mutex); | |
2135 | scm_dynwind_block_asyncs (); | |
9de87eea MV |
2136 | } |
2137 | ||
2138 | /*** Initialization */ | |
2139 | ||
9de87eea MV |
2140 | scm_i_pthread_mutex_t scm_i_misc_mutex; |
2141 | ||
d1138028 MV |
2142 | #if SCM_USE_PTHREAD_THREADS |
2143 | pthread_mutexattr_t scm_i_pthread_mutexattr_recursive[1]; | |
2144 | #endif | |
2145 | ||
9de87eea | 2146 | void |
12c1d861 | 2147 | scm_threads_prehistory (void *base) |
9de87eea | 2148 | { |
d1138028 MV |
2149 | #if SCM_USE_PTHREAD_THREADS |
2150 | pthread_mutexattr_init (scm_i_pthread_mutexattr_recursive); | |
2151 | pthread_mutexattr_settype (scm_i_pthread_mutexattr_recursive, | |
2152 | PTHREAD_MUTEX_RECURSIVE); | |
2153 | #endif | |
2154 | ||
2155 | scm_i_pthread_mutex_init (&scm_i_critical_section_mutex, | |
2156 | scm_i_pthread_mutexattr_recursive); | |
9de87eea MV |
2157 | scm_i_pthread_mutex_init (&scm_i_misc_mutex, NULL); |
2158 | scm_i_pthread_cond_init (&wake_up_cond, NULL); | |
74926120 | 2159 | |
12c1d861 | 2160 | guilify_self_1 ((struct GC_stack_base *) base); |
9bc4701c MD |
2161 | } |
2162 | ||
d823b11b MV |
2163 | scm_t_bits scm_tc16_thread; |
2164 | scm_t_bits scm_tc16_mutex; | |
2165 | scm_t_bits scm_tc16_condvar; | |
7bfd3b9e | 2166 | |
7bfd3b9e | 2167 | void |
9de87eea | 2168 | scm_init_threads () |
7bfd3b9e | 2169 | { |
9de87eea | 2170 | scm_tc16_thread = scm_make_smob_type ("thread", sizeof (scm_i_thread)); |
d823b11b | 2171 | scm_set_smob_print (scm_tc16_thread, thread_print); |
d823b11b | 2172 | |
9de87eea | 2173 | scm_tc16_mutex = scm_make_smob_type ("mutex", sizeof (fat_mutex)); |
9de87eea MV |
2174 | scm_set_smob_print (scm_tc16_mutex, fat_mutex_print); |
2175 | scm_set_smob_free (scm_tc16_mutex, fat_mutex_free); | |
9bc4701c | 2176 | |
9de87eea MV |
2177 | scm_tc16_condvar = scm_make_smob_type ("condition-variable", |
2178 | sizeof (fat_cond)); | |
9de87eea | 2179 | scm_set_smob_print (scm_tc16_condvar, fat_cond_print); |
d823b11b | 2180 | |
9de87eea MV |
2181 | scm_i_default_dynamic_state = SCM_BOOL_F; |
2182 | guilify_self_2 (SCM_BOOL_F); | |
9bc4701c | 2183 | threads_initialized_p = 1; |
a4d106c7 | 2184 | |
f39448c5 | 2185 | dynwind_critical_section_mutex = scm_make_recursive_mutex (); |
7bfd3b9e | 2186 | } |
89e00824 | 2187 | |
5f05c406 | 2188 | void |
9de87eea | 2189 | scm_init_threads_default_dynamic_state () |
5f05c406 | 2190 | { |
9de87eea | 2191 | SCM state = scm_make_dynamic_state (scm_current_dynamic_state ()); |
f39448c5 | 2192 | scm_i_default_dynamic_state = state; |
5f05c406 MV |
2193 | } |
2194 | ||
d823b11b | 2195 | void |
9de87eea | 2196 | scm_init_thread_procs () |
d823b11b | 2197 | { |
9de87eea | 2198 | #include "libguile/threads.x" |
d823b11b MV |
2199 | } |
2200 | ||
3c13664e LC |
2201 | \f |
2202 | /* IA64-specific things. */ | |
2203 | ||
2204 | #ifdef __ia64__ | |
2205 | # ifdef __hpux | |
2206 | # include <sys/param.h> | |
2207 | # include <sys/pstat.h> | |
2208 | void * | |
2209 | scm_ia64_register_backing_store_base (void) | |
2210 | { | |
2211 | struct pst_vm_status vm_status; | |
2212 | int i = 0; | |
2213 | while (pstat_getprocvm (&vm_status, sizeof (vm_status), 0, i++) == 1) | |
2214 | if (vm_status.pst_type == PS_RSESTACK) | |
2215 | return (void *) vm_status.pst_vaddr; | |
2216 | abort (); | |
2217 | } | |
2218 | void * | |
2219 | scm_ia64_ar_bsp (const void *ctx) | |
2220 | { | |
2221 | uint64_t bsp; | |
2222 | __uc_get_ar_bsp (ctx, &bsp); | |
2223 | return (void *) bsp; | |
2224 | } | |
2225 | # endif /* hpux */ | |
2226 | # ifdef linux | |
2227 | # include <ucontext.h> | |
2228 | void * | |
2229 | scm_ia64_register_backing_store_base (void) | |
2230 | { | |
2231 | extern void *__libc_ia64_register_backing_store_base; | |
2232 | return __libc_ia64_register_backing_store_base; | |
2233 | } | |
2234 | void * | |
2235 | scm_ia64_ar_bsp (const void *opaque) | |
2236 | { | |
2237 | const ucontext_t *ctx = opaque; | |
2238 | return (void *) ctx->uc_mcontext.sc_ar_bsp; | |
2239 | } | |
2240 | # endif /* linux */ | |
ba20d262 AW |
2241 | # ifdef __FreeBSD__ |
2242 | # include <ucontext.h> | |
2243 | void * | |
2244 | scm_ia64_register_backing_store_base (void) | |
2245 | { | |
2246 | return (void *)0x8000000000000000; | |
2247 | } | |
2248 | void * | |
2249 | scm_ia64_ar_bsp (const void *opaque) | |
2250 | { | |
2251 | const ucontext_t *ctx = opaque; | |
2252 | return (void *)(ctx->uc_mcontext.mc_special.bspstore | |
2253 | + ctx->uc_mcontext.mc_special.ndirty); | |
2254 | } | |
2255 | # endif /* __FreeBSD__ */ | |
3c13664e LC |
2256 | #endif /* __ia64__ */ |
2257 | ||
2258 | ||
89e00824 ML |
2259 | /* |
2260 | Local Variables: | |
2261 | c-file-style: "gnu" | |
2262 | End: | |
2263 | */ |