1 /* Copyright (C) 1995,1996,1997,1998,2000,2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public License
5 * as published by the Free Software Foundation; either version 3 of
6 * the License, or (at your option) any later version.
8 * This library is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
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., 51 Franklin Street, Fifth Floor, Boston, MA
25 #include "libguile/bdw-gc.h"
26 #include "libguile/_scm.h"
34 #include <string.h> /* for memset used by FD_ZERO on Solaris 10 */
43 #include "libguile/validate.h"
44 #include "libguile/root.h"
45 #include "libguile/eval.h"
46 #include "libguile/async.h"
47 #include "libguile/ports.h"
48 #include "libguile/threads.h"
49 #include "libguile/dynwind.h"
50 #include "libguile/iselect.h"
51 #include "libguile/fluids.h"
52 #include "libguile/continuations.h"
53 #include "libguile/gc.h"
54 #include "libguile/init.h"
55 #include "libguile/scmsigs.h"
56 #include "libguile/strings.h"
57 #include "libguile/weaks.h"
61 # define ETIMEDOUT WSAETIMEDOUT
65 # define pipe(fd) _pipe (fd, 256, O_BINARY)
66 #endif /* __MINGW32__ */
68 #include <full-read.h>
73 /* First some libgc shims. */
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 *);
86 #ifndef GC_UNIMPLEMENTED
87 #define GC_UNIMPLEMENTED 3
90 /* Likewise struct GC_stack_base is missing before 7.1. */
91 #ifndef HAVE_GC_STACK_BASE
92 struct GC_stack_base
{
93 void * mem_base
; /* Base of memory stack. */
95 void * reg_base
; /* Base of separate register stack. */
100 GC_register_my_thread (struct GC_stack_base
*)
102 return GC_UNIMPLEMENTED
;
106 GC_unregister_my_thread ()
110 #if !SCM_USE_PTHREAD_THREADS
111 /* No threads; we can just use GC_stackbottom. */
113 get_thread_stack_base ()
115 return GC_stackbottom
;
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. */
124 get_thread_stack_base ()
130 pthread_getattr_np (pthread_self (), &attr
);
131 pthread_attr_getstack (&attr
, &start
, &size
);
132 end
= (char *)start
+ size
;
134 #if SCM_STACK_GROWS_UP
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. */
146 get_thread_stack_base ()
148 return pthread_get_stackaddr_np (pthread_self ());
152 #error Threads enabled with old BDW-GC, but missing get_thread_stack_base impl. Please upgrade to libgc >= 7.1.
156 GC_get_stack_base (struct GC_stack_base
*)
158 stack_base
->mem_base
= get_thread_stack_base ();
160 /* Calculate and store off the base of this thread's register
161 backing store (RBS). Unfortunately our implementation(s) of
162 scm_ia64_register_backing_store_base are only reliable for the
163 main thread. For other threads, therefore, find out the current
164 top of the RBS, and use that as a maximum. */
165 stack_base
->reg_base
= scm_ia64_register_backing_store_base ();
170 bsp
= scm_ia64_ar_bsp (&ctx
);
171 if (stack_base
->reg_base
> bsp
)
172 stack_base
->reg_base
= bsp
;
179 GC_call_with_stack_base(void * (*fn
) (struct GC_stack_base
*, void*), void *arg
)
181 struct GC_stack_base stack_base
;
183 stack_base
.mem_base
= (void*)&stack_base
;
185 /* FIXME: Untested. */
189 stack_base
.reg_base
= scm_ia64_ar_bsp (&ctx
);
193 return fn (&stack_base
, arg
);
195 #endif /* HAVE_GC_STACK_BASE */
198 /* Now define with_gc_active and with_gc_inactive. */
200 #if (defined(HAVE_GC_DO_BLOCKING) && defined (HAVE_DECL_GC_DO_BLOCKING) && defined (HAVE_GC_CALL_WITH_GC_ACTIVE))
202 /* We have a sufficiently new libgc (7.2 or newer). */
205 with_gc_inactive (GC_fn_type func
, void *data
)
207 return GC_do_blocking (func
, data
);
211 with_gc_active (GC_fn_type func
, void *data
)
213 return GC_call_with_gc_active (func
, data
);
218 /* libgc not new enough, so never actually deactivate GC.
220 Note that though GC 7.1 does have a GC_do_blocking, it doesn't have
221 GC_call_with_gc_active. */
224 with_gc_inactive (GC_fn_type func
, void *data
)
230 with_gc_active (GC_fn_type func
, void *data
)
235 #endif /* HAVE_GC_DO_BLOCKING */
240 to_timespec (SCM t
, scm_t_timespec
*waittime
)
244 waittime
->tv_sec
= scm_to_ulong (SCM_CAR (t
));
245 waittime
->tv_nsec
= scm_to_ulong (SCM_CDR (t
)) * 1000;
249 double time
= scm_to_double (t
);
250 double sec
= scm_c_truncate (time
);
252 waittime
->tv_sec
= (long) sec
;
253 waittime
->tv_nsec
= (long) ((time
- sec
) * 1000000000);
260 /* Note: We annotate with "GC-robust" assignments whose purpose is to avoid
261 the risk of false references leading to unbounded retained space as
262 described in "Bounding Space Usage of Conservative Garbage Collectors",
265 /* Make an empty queue data structure.
270 return scm_cons (SCM_EOL
, SCM_EOL
);
273 /* Put T at the back of Q and return a handle that can be used with
274 remqueue to remove T from Q again.
277 enqueue (SCM q
, SCM t
)
279 SCM c
= scm_cons (t
, SCM_EOL
);
280 SCM_CRITICAL_SECTION_START
;
281 if (scm_is_null (SCM_CDR (q
)))
284 SCM_SETCDR (SCM_CAR (q
), c
);
286 SCM_CRITICAL_SECTION_END
;
290 /* Remove the element that the handle C refers to from the queue Q. C
291 must have been returned from a call to enqueue. The return value
292 is zero when the element referred to by C has already been removed.
293 Otherwise, 1 is returned.
296 remqueue (SCM q
, SCM c
)
299 SCM_CRITICAL_SECTION_START
;
300 for (p
= SCM_CDR (q
); !scm_is_null (p
); p
= SCM_CDR (p
))
302 if (scm_is_eq (p
, c
))
304 if (scm_is_eq (c
, SCM_CAR (q
)))
305 SCM_SETCAR (q
, SCM_CDR (c
));
306 SCM_SETCDR (prev
, SCM_CDR (c
));
309 SCM_SETCDR (c
, SCM_EOL
);
311 SCM_CRITICAL_SECTION_END
;
316 SCM_CRITICAL_SECTION_END
;
320 /* Remove the front-most element from the queue Q and return it.
321 Return SCM_BOOL_F when Q is empty.
327 SCM_CRITICAL_SECTION_START
;
331 SCM_CRITICAL_SECTION_END
;
336 SCM_SETCDR (q
, SCM_CDR (c
));
337 if (scm_is_null (SCM_CDR (q
)))
338 SCM_SETCAR (q
, SCM_EOL
);
339 SCM_CRITICAL_SECTION_END
;
342 SCM_SETCDR (c
, SCM_EOL
);
348 /*** Thread smob routines */
352 thread_print (SCM exp
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
354 /* On a Gnu system pthread_t is an unsigned long, but on mingw it's a
355 struct. A cast like "(unsigned long) t->pthread" is a syntax error in
356 the struct case, hence we go via a union, and extract according to the
357 size of pthread_t. */
365 scm_i_thread
*t
= SCM_I_THREAD_DATA (exp
);
366 scm_i_pthread_t p
= t
->pthread
;
369 if (sizeof (p
) == sizeof (unsigned short))
371 else if (sizeof (p
) == sizeof (unsigned int))
373 else if (sizeof (p
) == sizeof (unsigned long))
378 scm_puts ("#<thread ", port
);
379 scm_uintprint (id
, 10, port
);
380 scm_puts (" (", port
);
381 scm_uintprint ((scm_t_bits
)t
, 16, port
);
382 scm_puts (")>", port
);
387 /*** Blocking on queues. */
389 /* See also scm_i_queue_async_cell for how such a block is
393 /* Put the current thread on QUEUE and go to sleep, waiting for it to
394 be woken up by a call to 'unblock_from_queue', or to be
395 interrupted. Upon return of this function, the current thread is
396 no longer on QUEUE, even when the sleep has been interrupted.
398 The caller of block_self must hold MUTEX. It will be atomically
399 unlocked while sleeping, just as with scm_i_pthread_cond_wait.
401 SLEEP_OBJECT is an arbitrary SCM value that is kept alive as long
404 When WAITTIME is not NULL, the sleep will be aborted at that time.
406 The return value of block_self is an errno value. It will be zero
407 when the sleep has been successfully completed by a call to
408 unblock_from_queue, EINTR when it has been interrupted by the
409 delivery of a system async, and ETIMEDOUT when the timeout has
412 The system asyncs themselves are not executed by block_self.
415 block_self (SCM queue
, SCM sleep_object
, scm_i_pthread_mutex_t
*mutex
,
416 const scm_t_timespec
*waittime
)
418 scm_i_thread
*t
= SCM_I_CURRENT_THREAD
;
422 if (scm_i_setup_sleep (t
, sleep_object
, mutex
, -1))
427 q_handle
= enqueue (queue
, t
->handle
);
428 if (waittime
== NULL
)
429 err
= scm_i_scm_pthread_cond_wait (&t
->sleep_cond
, mutex
);
431 err
= scm_i_scm_pthread_cond_timedwait (&t
->sleep_cond
, mutex
, waittime
);
433 /* When we are still on QUEUE, we have been interrupted. We
434 report this only when no other error (such as a timeout) has
437 if (remqueue (queue
, q_handle
) && err
== 0)
440 scm_i_reset_sleep (t
);
446 /* Wake up the first thread on QUEUE, if any. The awoken thread is
447 returned, or #f if the queue was empty.
450 unblock_from_queue (SCM queue
)
452 SCM thread
= dequeue (queue
);
453 if (scm_is_true (thread
))
454 scm_i_pthread_cond_signal (&SCM_I_THREAD_DATA(thread
)->sleep_cond
);
459 /* Getting into and out of guile mode.
462 /* Key used to attach a cleanup handler to a given thread. Also, if
463 thread-local storage is unavailable, this key is used to retrieve the
464 current thread with `pthread_getspecific ()'. */
465 scm_i_pthread_key_t scm_i_thread_key
;
468 #ifdef SCM_HAVE_THREAD_STORAGE_CLASS
470 /* When thread-local storage (TLS) is available, a pointer to the
471 current-thread object is kept in TLS. Note that storing the thread-object
472 itself in TLS (rather than a pointer to some malloc'd memory) is not
473 possible since thread objects may live longer than the actual thread they
475 SCM_THREAD_LOCAL scm_i_thread
*scm_i_current_thread
= NULL
;
477 #endif /* SCM_HAVE_THREAD_STORAGE_CLASS */
480 static scm_i_pthread_mutex_t thread_admin_mutex
= SCM_I_PTHREAD_MUTEX_INITIALIZER
;
481 static scm_i_thread
*all_threads
= NULL
;
482 static int thread_count
;
484 static SCM scm_i_default_dynamic_state
;
486 /* Perform first stage of thread initialisation, in non-guile mode.
489 guilify_self_1 (struct GC_stack_base
*base
)
493 /* We must arrange for SCM_I_CURRENT_THREAD to point to a valid value
494 before allocating anything in this thread, because allocation could
495 cause GC to run, and GC could cause finalizers, which could invoke
496 Scheme functions, which need the current thread to be set. */
498 t
.pthread
= scm_i_pthread_self ();
499 t
.handle
= SCM_BOOL_F
;
500 t
.result
= SCM_BOOL_F
;
501 t
.cleanup_handler
= SCM_BOOL_F
;
504 t
.join_queue
= SCM_EOL
;
505 t
.dynamic_state
= SCM_BOOL_F
;
506 t
.dynwinds
= SCM_EOL
;
507 t
.active_asyncs
= SCM_EOL
;
509 t
.pending_asyncs
= 1;
510 t
.critical_section_level
= 0;
511 t
.base
= base
->mem_base
;
513 t
.register_backing_store_base
= base
->reg
-base
;
515 t
.continuation_root
= SCM_EOL
;
516 t
.continuation_base
= t
.base
;
517 scm_i_pthread_cond_init (&t
.sleep_cond
, NULL
);
518 t
.sleep_mutex
= NULL
;
519 t
.sleep_object
= SCM_BOOL_F
;
522 if (pipe (t
.sleep_pipe
) != 0)
523 /* FIXME: Error conditions during the initialization phase are handled
524 gracelessly since public functions such as `scm_init_guile ()'
525 currently have type `void'. */
528 scm_i_pthread_mutex_init (&t
.admin_mutex
, NULL
);
529 t
.current_mark_stack_ptr
= NULL
;
530 t
.current_mark_stack_limit
= NULL
;
535 /* The switcheroo. */
537 scm_i_thread
*t_ptr
= &t
;
540 t_ptr
= GC_malloc (sizeof (scm_i_thread
));
541 memcpy (t_ptr
, &t
, sizeof t
);
543 scm_i_pthread_setspecific (scm_i_thread_key
, t_ptr
);
545 #ifdef SCM_HAVE_THREAD_STORAGE_CLASS
546 /* Cache the current thread in TLS for faster lookup. */
547 scm_i_current_thread
= t_ptr
;
550 scm_i_pthread_mutex_lock (&thread_admin_mutex
);
551 t_ptr
->next_thread
= all_threads
;
554 scm_i_pthread_mutex_unlock (&thread_admin_mutex
);
560 /* Perform second stage of thread initialisation, in guile mode.
563 guilify_self_2 (SCM parent
)
565 scm_i_thread
*t
= SCM_I_CURRENT_THREAD
;
569 SCM_NEWSMOB (t
->handle
, scm_tc16_thread
, t
);
571 t
->continuation_root
= scm_cons (t
->handle
, SCM_EOL
);
572 t
->continuation_base
= t
->base
;
575 if (scm_is_true (parent
))
576 t
->dynamic_state
= scm_make_dynamic_state (parent
);
578 t
->dynamic_state
= scm_i_make_initial_dynamic_state ();
580 t
->join_queue
= make_queue ();
587 /* We implement our own mutex type since we want them to be 'fair', we
588 want to do fancy things while waiting for them (like running
589 asyncs) and we might want to add things that are nice for
594 scm_i_pthread_mutex_t lock
;
596 int level
; /* how much the owner owns us. <= 1 for non-recursive mutexes */
598 int recursive
; /* allow recursive locking? */
599 int unchecked_unlock
; /* is it an error to unlock an unlocked mutex? */
600 int allow_external_unlock
; /* is it an error to unlock a mutex that is not
601 owned by the current thread? */
603 SCM waiting
; /* the threads waiting for this mutex. */
606 #define SCM_MUTEXP(x) SCM_SMOB_PREDICATE (scm_tc16_mutex, x)
607 #define SCM_MUTEX_DATA(x) ((fat_mutex *) SCM_SMOB_DATA (x))
609 /* Perform thread tear-down, in guile mode.
612 do_thread_exit (void *v
)
614 scm_i_thread
*t
= (scm_i_thread
*) v
;
616 if (!scm_is_false (t
->cleanup_handler
))
618 SCM ptr
= t
->cleanup_handler
;
620 t
->cleanup_handler
= SCM_BOOL_F
;
621 t
->result
= scm_internal_catch (SCM_BOOL_T
,
622 (scm_t_catch_body
) scm_call_0
, ptr
,
623 scm_handle_by_message_noexit
, NULL
);
626 scm_i_scm_pthread_mutex_lock (&t
->admin_mutex
);
629 close (t
->sleep_pipe
[0]);
630 close (t
->sleep_pipe
[1]);
631 while (scm_is_true (unblock_from_queue (t
->join_queue
)))
634 while (!scm_is_null (t
->mutexes
))
636 SCM mutex
= SCM_WEAK_PAIR_CAR (t
->mutexes
);
638 if (!SCM_UNBNDP (mutex
))
640 fat_mutex
*m
= SCM_MUTEX_DATA (mutex
);
642 scm_i_pthread_mutex_lock (&m
->lock
);
644 /* Since MUTEX is in `t->mutexes', T must be its owner. */
645 assert (scm_is_eq (m
->owner
, t
->handle
));
647 unblock_from_queue (m
->waiting
);
649 scm_i_pthread_mutex_unlock (&m
->lock
);
652 t
->mutexes
= SCM_WEAK_PAIR_CDR (t
->mutexes
);
655 scm_i_pthread_mutex_unlock (&t
->admin_mutex
);
661 do_thread_exit_trampoline (struct GC_stack_base
*sb
, void *v
)
663 /* Won't hurt if we are already registered. */
664 GC_register_my_thread (sb
);
666 return scm_with_guile (do_thread_exit
, v
);
670 on_thread_exit (void *v
)
672 /* This handler is executed in non-guile mode. */
673 scm_i_thread
*t
= (scm_i_thread
*) v
, **tp
;
675 /* If this thread was cancelled while doing a cond wait, it will
676 still have a mutex locked, so we unlock it here. */
679 scm_i_pthread_mutex_unlock (t
->held_mutex
);
680 t
->held_mutex
= NULL
;
683 /* Reinstate the current thread for purposes of scm_with_guile
684 guile-mode cleanup handlers. Only really needed in the non-TLS
685 case but it doesn't hurt to be consistent. */
686 scm_i_pthread_setspecific (scm_i_thread_key
, t
);
688 /* Ensure the signal handling thread has been launched, because we might be
690 scm_i_ensure_signal_delivery_thread ();
692 /* Scheme-level thread finalizers and other cleanup needs to happen in
694 GC_call_with_stack_base (do_thread_exit_trampoline
, t
);
696 /* Removing ourself from the list of all threads needs to happen in
697 non-guile mode since all SCM values on our stack become
698 unprotected once we are no longer in the list. */
699 scm_i_pthread_mutex_lock (&thread_admin_mutex
);
700 for (tp
= &all_threads
; *tp
; tp
= &(*tp
)->next_thread
)
703 *tp
= t
->next_thread
;
706 t
->next_thread
= NULL
;
712 /* If there's only one other thread, it could be the signal delivery
713 thread, so we need to notify it to shut down by closing its read pipe.
714 If it's not the signal delivery thread, then closing the read pipe isn't
716 if (thread_count
<= 1)
717 scm_i_close_signal_pipe ();
719 scm_i_pthread_mutex_unlock (&thread_admin_mutex
);
721 scm_i_pthread_setspecific (scm_i_thread_key
, NULL
);
723 GC_unregister_my_thread ();
726 static scm_i_pthread_once_t init_thread_key_once
= SCM_I_PTHREAD_ONCE_INIT
;
729 init_thread_key (void)
731 scm_i_pthread_key_create (&scm_i_thread_key
, on_thread_exit
);
734 /* Perform any initializations necessary to make the current thread
735 known to Guile (via SCM_I_CURRENT_THREAD), initializing Guile itself,
738 BASE is the stack base to use with GC.
740 PARENT is the dynamic state to use as the parent, ot SCM_BOOL_F in
741 which case the default dynamic state is used.
743 Returns zero when the thread was known to guile already; otherwise
746 Note that it could be the case that the thread was known
747 to Guile, but not in guile mode (because we are within a
748 scm_without_guile call). Check SCM_I_CURRENT_THREAD->guile_mode to
749 be sure. New threads are put into guile mode implicitly. */
752 scm_i_init_thread_for_guile (struct GC_stack_base
*base
, SCM parent
)
754 scm_i_pthread_once (&init_thread_key_once
, init_thread_key
);
756 if (SCM_I_CURRENT_THREAD
)
758 /* Thread is already known to Guile.
764 /* This thread has not been guilified yet.
767 scm_i_pthread_mutex_lock (&scm_i_init_mutex
);
768 if (scm_initialized_p
== 0)
770 /* First thread ever to enter Guile. Run the full
773 scm_i_init_guile (base
);
775 /* Allow other threads to come in later. */
776 GC_allow_register_threads ();
778 scm_i_pthread_mutex_unlock (&scm_i_init_mutex
);
782 /* Guile is already initialized, but this thread enters it for
783 the first time. Only initialize this thread.
785 scm_i_pthread_mutex_unlock (&scm_i_init_mutex
);
787 /* Register this thread with libgc. */
788 GC_register_my_thread (base
);
790 guilify_self_1 (base
);
791 guilify_self_2 (parent
);
800 struct GC_stack_base stack_base
;
802 if (GC_get_stack_base (&stack_base
) == GC_SUCCESS
)
803 scm_i_init_thread_for_guile (&stack_base
,
804 scm_i_default_dynamic_state
);
807 fprintf (stderr
, "Failed to get stack base for current thread.\n");
812 SCM_UNUSED
static void
813 scm_leave_guile_cleanup (void *x
)
815 on_thread_exit (SCM_I_CURRENT_THREAD
);
818 struct with_guile_args
826 with_guile_trampoline (void *data
)
828 struct with_guile_args
*args
= data
;
830 return scm_c_with_continuation_barrier (args
->func
, args
->data
);
834 with_guile_and_parent (struct GC_stack_base
*base
, void *data
)
839 struct with_guile_args
*args
= data
;
841 new_thread
= scm_i_init_thread_for_guile (base
, args
->parent
);
842 t
= SCM_I_CURRENT_THREAD
;
845 /* We are in Guile mode. */
846 assert (t
->guile_mode
);
848 res
= scm_c_with_continuation_barrier (args
->func
, args
->data
);
850 /* Leave Guile mode. */
853 else if (t
->guile_mode
)
855 /* Already in Guile mode. */
856 res
= scm_c_with_continuation_barrier (args
->func
, args
->data
);
860 /* We are not in Guile mode, either because we are not within a
861 scm_with_guile, or because we are within a scm_without_guile.
863 This call to scm_with_guile() could happen from anywhere on the
864 stack, and in particular lower on the stack than when it was
865 when this thread was first guilified. Thus, `base' must be
867 #if SCM_STACK_GROWS_UP
868 if (SCM_STACK_PTR (base
->mem_base
) < t
->base
)
869 t
->base
= SCM_STACK_PTR (base
->mem_base
);
871 if (SCM_STACK_PTR (base
->mem_base
) > t
->base
)
872 t
->base
= SCM_STACK_PTR (base
->mem_base
);
876 res
= with_gc_active (with_guile_trampoline
, args
);
883 scm_i_with_guile_and_parent (void *(*func
)(void *), void *data
, SCM parent
)
885 struct with_guile_args args
;
889 args
.parent
= parent
;
891 return GC_call_with_stack_base (with_guile_and_parent
, &args
);
895 scm_with_guile (void *(*func
)(void *), void *data
)
897 return scm_i_with_guile_and_parent (func
, data
,
898 scm_i_default_dynamic_state
);
902 scm_without_guile (void *(*func
)(void *), void *data
)
905 scm_i_thread
*t
= SCM_I_CURRENT_THREAD
;
909 SCM_I_CURRENT_THREAD
->guile_mode
= 0;
910 result
= with_gc_inactive (func
, data
);
911 SCM_I_CURRENT_THREAD
->guile_mode
= 1;
914 /* Otherwise we're not in guile mode, so nothing to do. */
915 result
= func (data
);
921 /*** Thread creation */
928 scm_i_pthread_mutex_t mutex
;
929 scm_i_pthread_cond_t cond
;
933 really_launch (void *d
)
935 launch_data
*data
= (launch_data
*)d
;
936 SCM thunk
= data
->thunk
, handler
= data
->handler
;
939 t
= SCM_I_CURRENT_THREAD
;
941 scm_i_scm_pthread_mutex_lock (&data
->mutex
);
942 data
->thread
= scm_current_thread ();
943 scm_i_pthread_cond_signal (&data
->cond
);
944 scm_i_pthread_mutex_unlock (&data
->mutex
);
946 if (SCM_UNBNDP (handler
))
947 t
->result
= scm_call_0 (thunk
);
949 t
->result
= scm_catch (SCM_BOOL_T
, thunk
, handler
);
955 launch_thread (void *d
)
957 launch_data
*data
= (launch_data
*)d
;
958 scm_i_pthread_detach (scm_i_pthread_self ());
959 scm_i_with_guile_and_parent (really_launch
, d
, data
->parent
);
963 SCM_DEFINE (scm_call_with_new_thread
, "call-with-new-thread", 1, 1, 0,
964 (SCM thunk
, SCM handler
),
965 "Call @code{thunk} in a new thread and with a new dynamic state,\n"
966 "returning a new thread object representing the thread. The procedure\n"
967 "@var{thunk} is called via @code{with-continuation-barrier}.\n"
969 "When @var{handler} is specified, then @var{thunk} is called from\n"
970 "within a @code{catch} with tag @code{#t} that has @var{handler} as its\n"
971 "handler. This catch is established inside the continuation barrier.\n"
973 "Once @var{thunk} or @var{handler} returns, the return value is made\n"
974 "the @emph{exit value} of the thread and the thread is terminated.")
975 #define FUNC_NAME s_scm_call_with_new_thread
981 SCM_ASSERT (scm_is_true (scm_thunk_p (thunk
)), thunk
, SCM_ARG1
, FUNC_NAME
);
982 SCM_ASSERT (SCM_UNBNDP (handler
) || scm_is_true (scm_procedure_p (handler
)),
983 handler
, SCM_ARG2
, FUNC_NAME
);
985 data
.parent
= scm_current_dynamic_state ();
987 data
.handler
= handler
;
988 data
.thread
= SCM_BOOL_F
;
989 scm_i_pthread_mutex_init (&data
.mutex
, NULL
);
990 scm_i_pthread_cond_init (&data
.cond
, NULL
);
992 scm_i_scm_pthread_mutex_lock (&data
.mutex
);
993 err
= scm_i_pthread_create (&id
, NULL
, launch_thread
, &data
);
996 scm_i_pthread_mutex_unlock (&data
.mutex
);
1000 scm_i_scm_pthread_cond_wait (&data
.cond
, &data
.mutex
);
1001 scm_i_pthread_mutex_unlock (&data
.mutex
);
1009 scm_t_catch_body body
;
1011 scm_t_catch_handler handler
;
1014 scm_i_pthread_mutex_t mutex
;
1015 scm_i_pthread_cond_t cond
;
1019 really_spawn (void *d
)
1021 spawn_data
*data
= (spawn_data
*)d
;
1022 scm_t_catch_body body
= data
->body
;
1023 void *body_data
= data
->body_data
;
1024 scm_t_catch_handler handler
= data
->handler
;
1025 void *handler_data
= data
->handler_data
;
1026 scm_i_thread
*t
= SCM_I_CURRENT_THREAD
;
1028 scm_i_scm_pthread_mutex_lock (&data
->mutex
);
1029 data
->thread
= scm_current_thread ();
1030 scm_i_pthread_cond_signal (&data
->cond
);
1031 scm_i_pthread_mutex_unlock (&data
->mutex
);
1033 if (handler
== NULL
)
1034 t
->result
= body (body_data
);
1036 t
->result
= scm_internal_catch (SCM_BOOL_T
,
1038 handler
, handler_data
);
1044 spawn_thread (void *d
)
1046 spawn_data
*data
= (spawn_data
*)d
;
1047 scm_i_pthread_detach (scm_i_pthread_self ());
1048 scm_i_with_guile_and_parent (really_spawn
, d
, data
->parent
);
1053 scm_spawn_thread (scm_t_catch_body body
, void *body_data
,
1054 scm_t_catch_handler handler
, void *handler_data
)
1060 data
.parent
= scm_current_dynamic_state ();
1062 data
.body_data
= body_data
;
1063 data
.handler
= handler
;
1064 data
.handler_data
= handler_data
;
1065 data
.thread
= SCM_BOOL_F
;
1066 scm_i_pthread_mutex_init (&data
.mutex
, NULL
);
1067 scm_i_pthread_cond_init (&data
.cond
, NULL
);
1069 scm_i_scm_pthread_mutex_lock (&data
.mutex
);
1070 err
= scm_i_pthread_create (&id
, NULL
, spawn_thread
, &data
);
1073 scm_i_pthread_mutex_unlock (&data
.mutex
);
1075 scm_syserror (NULL
);
1077 scm_i_scm_pthread_cond_wait (&data
.cond
, &data
.mutex
);
1078 scm_i_pthread_mutex_unlock (&data
.mutex
);
1083 SCM_DEFINE (scm_yield
, "yield", 0, 0, 0,
1085 "Move the calling thread to the end of the scheduling queue.")
1086 #define FUNC_NAME s_scm_yield
1088 return scm_from_bool (scm_i_sched_yield ());
1092 SCM_DEFINE (scm_cancel_thread
, "cancel-thread", 1, 0, 0,
1094 "Asynchronously force the target @var{thread} to terminate. @var{thread} "
1095 "cannot be the current thread, and if @var{thread} has already terminated or "
1096 "been signaled to terminate, this function is a no-op.")
1097 #define FUNC_NAME s_scm_cancel_thread
1099 scm_i_thread
*t
= NULL
;
1101 SCM_VALIDATE_THREAD (1, thread
);
1102 t
= SCM_I_THREAD_DATA (thread
);
1103 scm_i_scm_pthread_mutex_lock (&t
->admin_mutex
);
1107 scm_i_pthread_mutex_unlock (&t
->admin_mutex
);
1108 scm_i_pthread_cancel (t
->pthread
);
1111 scm_i_pthread_mutex_unlock (&t
->admin_mutex
);
1113 return SCM_UNSPECIFIED
;
1117 SCM_DEFINE (scm_set_thread_cleanup_x
, "set-thread-cleanup!", 2, 0, 0,
1118 (SCM thread
, SCM proc
),
1119 "Set the thunk @var{proc} as the cleanup handler for the thread @var{thread}. "
1120 "This handler will be called when the thread exits.")
1121 #define FUNC_NAME s_scm_set_thread_cleanup_x
1125 SCM_VALIDATE_THREAD (1, thread
);
1126 if (!scm_is_false (proc
))
1127 SCM_VALIDATE_THUNK (2, proc
);
1129 t
= SCM_I_THREAD_DATA (thread
);
1130 scm_i_pthread_mutex_lock (&t
->admin_mutex
);
1132 if (!(t
->exited
|| t
->canceled
))
1133 t
->cleanup_handler
= proc
;
1135 scm_i_pthread_mutex_unlock (&t
->admin_mutex
);
1137 return SCM_UNSPECIFIED
;
1141 SCM_DEFINE (scm_thread_cleanup
, "thread-cleanup", 1, 0, 0,
1143 "Return the cleanup handler installed for the thread @var{thread}.")
1144 #define FUNC_NAME s_scm_thread_cleanup
1149 SCM_VALIDATE_THREAD (1, thread
);
1151 t
= SCM_I_THREAD_DATA (thread
);
1152 scm_i_pthread_mutex_lock (&t
->admin_mutex
);
1153 ret
= (t
->exited
|| t
->canceled
) ? SCM_BOOL_F
: t
->cleanup_handler
;
1154 scm_i_pthread_mutex_unlock (&t
->admin_mutex
);
1160 SCM
scm_join_thread (SCM thread
)
1162 return scm_join_thread_timed (thread
, SCM_UNDEFINED
, SCM_UNDEFINED
);
1165 SCM_DEFINE (scm_join_thread_timed
, "join-thread", 1, 2, 0,
1166 (SCM thread
, SCM timeout
, SCM timeoutval
),
1167 "Suspend execution of the calling thread until the target @var{thread} "
1168 "terminates, unless the target @var{thread} has already terminated. ")
1169 #define FUNC_NAME s_scm_join_thread_timed
1172 scm_t_timespec ctimeout
, *timeout_ptr
= NULL
;
1173 SCM res
= SCM_BOOL_F
;
1175 if (! (SCM_UNBNDP (timeoutval
)))
1178 SCM_VALIDATE_THREAD (1, thread
);
1179 if (scm_is_eq (scm_current_thread (), thread
))
1180 SCM_MISC_ERROR ("cannot join the current thread", SCM_EOL
);
1182 t
= SCM_I_THREAD_DATA (thread
);
1183 scm_i_scm_pthread_mutex_lock (&t
->admin_mutex
);
1185 if (! SCM_UNBNDP (timeout
))
1187 to_timespec (timeout
, &ctimeout
);
1188 timeout_ptr
= &ctimeout
;
1197 int err
= block_self (t
->join_queue
, thread
, &t
->admin_mutex
,
1207 else if (err
== ETIMEDOUT
)
1210 scm_i_pthread_mutex_unlock (&t
->admin_mutex
);
1212 scm_i_scm_pthread_mutex_lock (&t
->admin_mutex
);
1214 /* Check for exit again, since we just released and
1215 reacquired the admin mutex, before the next block_self
1216 call (which would block forever if t has already
1226 scm_i_pthread_mutex_unlock (&t
->admin_mutex
);
1232 SCM_DEFINE (scm_thread_p
, "thread?", 1, 0, 0,
1234 "Return @code{#t} if @var{obj} is a thread.")
1235 #define FUNC_NAME s_scm_thread_p
1237 return SCM_I_IS_THREAD(obj
) ? SCM_BOOL_T
: SCM_BOOL_F
;
1243 fat_mutex_free (SCM mx
)
1245 fat_mutex
*m
= SCM_MUTEX_DATA (mx
);
1246 scm_i_pthread_mutex_destroy (&m
->lock
);
1251 fat_mutex_print (SCM mx
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
1253 fat_mutex
*m
= SCM_MUTEX_DATA (mx
);
1254 scm_puts ("#<mutex ", port
);
1255 scm_uintprint ((scm_t_bits
)m
, 16, port
);
1256 scm_puts (">", port
);
1261 make_fat_mutex (int recursive
, int unchecked_unlock
, int external_unlock
)
1266 m
= scm_gc_malloc (sizeof (fat_mutex
), "mutex");
1267 scm_i_pthread_mutex_init (&m
->lock
, NULL
);
1268 m
->owner
= SCM_BOOL_F
;
1271 m
->recursive
= recursive
;
1272 m
->unchecked_unlock
= unchecked_unlock
;
1273 m
->allow_external_unlock
= external_unlock
;
1275 m
->waiting
= SCM_EOL
;
1276 SCM_NEWSMOB (mx
, scm_tc16_mutex
, (scm_t_bits
) m
);
1277 m
->waiting
= make_queue ();
1281 SCM
scm_make_mutex (void)
1283 return scm_make_mutex_with_flags (SCM_EOL
);
1286 SCM_SYMBOL (unchecked_unlock_sym
, "unchecked-unlock");
1287 SCM_SYMBOL (allow_external_unlock_sym
, "allow-external-unlock");
1288 SCM_SYMBOL (recursive_sym
, "recursive");
1290 SCM_DEFINE (scm_make_mutex_with_flags
, "make-mutex", 0, 0, 1,
1292 "Create a new mutex. ")
1293 #define FUNC_NAME s_scm_make_mutex_with_flags
1295 int unchecked_unlock
= 0, external_unlock
= 0, recursive
= 0;
1298 while (! scm_is_null (ptr
))
1300 SCM flag
= SCM_CAR (ptr
);
1301 if (scm_is_eq (flag
, unchecked_unlock_sym
))
1302 unchecked_unlock
= 1;
1303 else if (scm_is_eq (flag
, allow_external_unlock_sym
))
1304 external_unlock
= 1;
1305 else if (scm_is_eq (flag
, recursive_sym
))
1308 SCM_MISC_ERROR ("unsupported mutex option: ~a", scm_list_1 (flag
));
1309 ptr
= SCM_CDR (ptr
);
1311 return make_fat_mutex (recursive
, unchecked_unlock
, external_unlock
);
1315 SCM_DEFINE (scm_make_recursive_mutex
, "make-recursive-mutex", 0, 0, 0,
1317 "Create a new recursive mutex. ")
1318 #define FUNC_NAME s_scm_make_recursive_mutex
1320 return make_fat_mutex (1, 0, 0);
1324 SCM_SYMBOL (scm_abandoned_mutex_error_key
, "abandoned-mutex-error");
1327 fat_mutex_lock (SCM mutex
, scm_t_timespec
*timeout
, SCM owner
, int *ret
)
1329 fat_mutex
*m
= SCM_MUTEX_DATA (mutex
);
1331 SCM new_owner
= SCM_UNBNDP (owner
) ? scm_current_thread() : owner
;
1332 SCM err
= SCM_BOOL_F
;
1334 struct timeval current_time
;
1336 scm_i_scm_pthread_mutex_lock (&m
->lock
);
1342 m
->owner
= new_owner
;
1345 if (SCM_I_IS_THREAD (new_owner
))
1347 scm_i_thread
*t
= SCM_I_THREAD_DATA (new_owner
);
1348 scm_i_pthread_mutex_lock (&t
->admin_mutex
);
1350 /* Only keep a weak reference to MUTEX so that it's not
1351 retained when not referenced elsewhere (bug #27450).
1352 The weak pair itself is eventually removed when MUTEX
1353 is unlocked. Note that `t->mutexes' lists mutexes
1354 currently held by T, so it should be small. */
1355 t
->mutexes
= scm_weak_car_pair (mutex
, t
->mutexes
);
1357 scm_i_pthread_mutex_unlock (&t
->admin_mutex
);
1362 else if (SCM_I_IS_THREAD (m
->owner
) && scm_c_thread_exited_p (m
->owner
))
1364 m
->owner
= new_owner
;
1365 err
= scm_cons (scm_abandoned_mutex_error_key
,
1366 scm_from_locale_string ("lock obtained on abandoned "
1371 else if (scm_is_eq (m
->owner
, new_owner
))
1380 err
= scm_cons (scm_misc_error_key
,
1381 scm_from_locale_string ("mutex already locked "
1389 if (timeout
!= NULL
)
1391 gettimeofday (¤t_time
, NULL
);
1392 if (current_time
.tv_sec
> timeout
->tv_sec
||
1393 (current_time
.tv_sec
== timeout
->tv_sec
&&
1394 current_time
.tv_usec
* 1000 > timeout
->tv_nsec
))
1400 block_self (m
->waiting
, mutex
, &m
->lock
, timeout
);
1401 scm_i_pthread_mutex_unlock (&m
->lock
);
1403 scm_i_scm_pthread_mutex_lock (&m
->lock
);
1406 scm_i_pthread_mutex_unlock (&m
->lock
);
1410 SCM
scm_lock_mutex (SCM mx
)
1412 return scm_lock_mutex_timed (mx
, SCM_UNDEFINED
, SCM_UNDEFINED
);
1415 SCM_DEFINE (scm_lock_mutex_timed
, "lock-mutex", 1, 2, 0,
1416 (SCM m
, SCM timeout
, SCM owner
),
1417 "Lock @var{mutex}. If the mutex is already locked, the calling thread "
1418 "blocks until the mutex becomes available. The function returns when "
1419 "the calling thread owns the lock on @var{mutex}. Locking a mutex that "
1420 "a thread already owns will succeed right away and will not block the "
1421 "thread. That is, Guile's mutexes are @emph{recursive}. ")
1422 #define FUNC_NAME s_scm_lock_mutex_timed
1426 scm_t_timespec cwaittime
, *waittime
= NULL
;
1428 SCM_VALIDATE_MUTEX (1, m
);
1430 if (! SCM_UNBNDP (timeout
) && ! scm_is_false (timeout
))
1432 to_timespec (timeout
, &cwaittime
);
1433 waittime
= &cwaittime
;
1436 exception
= fat_mutex_lock (m
, waittime
, owner
, &ret
);
1437 if (!scm_is_false (exception
))
1438 scm_ithrow (SCM_CAR (exception
), scm_list_1 (SCM_CDR (exception
)), 1);
1439 return ret
? SCM_BOOL_T
: SCM_BOOL_F
;
1444 scm_dynwind_lock_mutex (SCM mutex
)
1446 scm_dynwind_unwind_handler_with_scm ((void(*)(SCM
))scm_unlock_mutex
, mutex
,
1447 SCM_F_WIND_EXPLICITLY
);
1448 scm_dynwind_rewind_handler_with_scm ((void(*)(SCM
))scm_lock_mutex
, mutex
,
1449 SCM_F_WIND_EXPLICITLY
);
1452 SCM_DEFINE (scm_try_mutex
, "try-mutex", 1, 0, 0,
1454 "Try to lock @var{mutex}. If the mutex is already locked by someone "
1455 "else, return @code{#f}. Else lock the mutex and return @code{#t}. ")
1456 #define FUNC_NAME s_scm_try_mutex
1460 scm_t_timespec cwaittime
, *waittime
= NULL
;
1462 SCM_VALIDATE_MUTEX (1, mutex
);
1464 to_timespec (scm_from_int(0), &cwaittime
);
1465 waittime
= &cwaittime
;
1467 exception
= fat_mutex_lock (mutex
, waittime
, SCM_UNDEFINED
, &ret
);
1468 if (!scm_is_false (exception
))
1469 scm_ithrow (SCM_CAR (exception
), scm_list_1 (SCM_CDR (exception
)), 1);
1470 return ret
? SCM_BOOL_T
: SCM_BOOL_F
;
1474 /*** Fat condition variables */
1477 scm_i_pthread_mutex_t lock
;
1478 SCM waiting
; /* the threads waiting for this condition. */
1481 #define SCM_CONDVARP(x) SCM_SMOB_PREDICATE (scm_tc16_condvar, x)
1482 #define SCM_CONDVAR_DATA(x) ((fat_cond *) SCM_SMOB_DATA (x))
1485 fat_mutex_unlock (SCM mutex
, SCM cond
,
1486 const scm_t_timespec
*waittime
, int relock
)
1489 fat_mutex
*m
= SCM_MUTEX_DATA (mutex
);
1491 scm_i_thread
*t
= SCM_I_CURRENT_THREAD
;
1492 int err
= 0, ret
= 0;
1494 scm_i_scm_pthread_mutex_lock (&m
->lock
);
1498 if (!scm_is_eq (owner
, t
->handle
))
1502 if (!m
->unchecked_unlock
)
1504 scm_i_pthread_mutex_unlock (&m
->lock
);
1505 scm_misc_error (NULL
, "mutex not locked", SCM_EOL
);
1509 else if (!m
->allow_external_unlock
)
1511 scm_i_pthread_mutex_unlock (&m
->lock
);
1512 scm_misc_error (NULL
, "mutex not locked by current thread", SCM_EOL
);
1516 if (! (SCM_UNBNDP (cond
)))
1518 c
= SCM_CONDVAR_DATA (cond
);
1527 /* Change the owner of MUTEX. */
1528 t
->mutexes
= scm_delq_x (mutex
, t
->mutexes
);
1529 m
->owner
= unblock_from_queue (m
->waiting
);
1534 err
= block_self (c
->waiting
, cond
, &m
->lock
, waittime
);
1535 scm_i_pthread_mutex_unlock (&m
->lock
);
1542 else if (err
== ETIMEDOUT
)
1547 else if (err
!= EINTR
)
1550 scm_syserror (NULL
);
1556 scm_lock_mutex_timed (mutex
, SCM_UNDEFINED
, owner
);
1564 scm_remember_upto_here_2 (cond
, mutex
);
1566 scm_i_scm_pthread_mutex_lock (&m
->lock
);
1575 /* Change the owner of MUTEX. */
1576 t
->mutexes
= scm_delq_x (mutex
, t
->mutexes
);
1577 m
->owner
= unblock_from_queue (m
->waiting
);
1580 scm_i_pthread_mutex_unlock (&m
->lock
);
1587 SCM
scm_unlock_mutex (SCM mx
)
1589 return scm_unlock_mutex_timed (mx
, SCM_UNDEFINED
, SCM_UNDEFINED
);
1592 SCM_DEFINE (scm_unlock_mutex_timed
, "unlock-mutex", 1, 2, 0,
1593 (SCM mx
, SCM cond
, SCM timeout
),
1594 "Unlocks @var{mutex} if the calling thread owns the lock on "
1595 "@var{mutex}. Calling unlock-mutex on a mutex not owned by the current "
1596 "thread results in undefined behaviour. Once a mutex has been unlocked, "
1597 "one thread blocked on @var{mutex} is awakened and grabs the mutex "
1598 "lock. Every call to @code{lock-mutex} by this thread must be matched "
1599 "with a call to @code{unlock-mutex}. Only the last call to "
1600 "@code{unlock-mutex} will actually unlock the mutex. ")
1601 #define FUNC_NAME s_scm_unlock_mutex_timed
1603 scm_t_timespec cwaittime
, *waittime
= NULL
;
1605 SCM_VALIDATE_MUTEX (1, mx
);
1606 if (! (SCM_UNBNDP (cond
)))
1608 SCM_VALIDATE_CONDVAR (2, cond
);
1610 if (! (SCM_UNBNDP (timeout
)))
1612 to_timespec (timeout
, &cwaittime
);
1613 waittime
= &cwaittime
;
1617 return fat_mutex_unlock (mx
, cond
, waittime
, 0) ? SCM_BOOL_T
: SCM_BOOL_F
;
1621 SCM_DEFINE (scm_mutex_p
, "mutex?", 1, 0, 0,
1623 "Return @code{#t} if @var{obj} is a mutex.")
1624 #define FUNC_NAME s_scm_mutex_p
1626 return SCM_MUTEXP (obj
) ? SCM_BOOL_T
: SCM_BOOL_F
;
1630 SCM_DEFINE (scm_mutex_owner
, "mutex-owner", 1, 0, 0,
1632 "Return the thread owning @var{mx}, or @code{#f}.")
1633 #define FUNC_NAME s_scm_mutex_owner
1636 fat_mutex
*m
= NULL
;
1638 SCM_VALIDATE_MUTEX (1, mx
);
1639 m
= SCM_MUTEX_DATA (mx
);
1640 scm_i_pthread_mutex_lock (&m
->lock
);
1642 scm_i_pthread_mutex_unlock (&m
->lock
);
1648 SCM_DEFINE (scm_mutex_level
, "mutex-level", 1, 0, 0,
1650 "Return the lock level of mutex @var{mx}.")
1651 #define FUNC_NAME s_scm_mutex_level
1653 SCM_VALIDATE_MUTEX (1, mx
);
1654 return scm_from_int (SCM_MUTEX_DATA(mx
)->level
);
1658 SCM_DEFINE (scm_mutex_locked_p
, "mutex-locked?", 1, 0, 0,
1660 "Returns @code{#t} if the mutex @var{mx} is locked.")
1661 #define FUNC_NAME s_scm_mutex_locked_p
1663 SCM_VALIDATE_MUTEX (1, mx
);
1664 return SCM_MUTEX_DATA (mx
)->level
> 0 ? SCM_BOOL_T
: SCM_BOOL_F
;
1669 fat_cond_print (SCM cv
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
1671 fat_cond
*c
= SCM_CONDVAR_DATA (cv
);
1672 scm_puts ("#<condition-variable ", port
);
1673 scm_uintprint ((scm_t_bits
)c
, 16, port
);
1674 scm_puts (">", port
);
1678 SCM_DEFINE (scm_make_condition_variable
, "make-condition-variable", 0, 0, 0,
1680 "Make a new condition variable.")
1681 #define FUNC_NAME s_scm_make_condition_variable
1686 c
= scm_gc_malloc (sizeof (fat_cond
), "condition variable");
1687 c
->waiting
= SCM_EOL
;
1688 SCM_NEWSMOB (cv
, scm_tc16_condvar
, (scm_t_bits
) c
);
1689 c
->waiting
= make_queue ();
1694 SCM_DEFINE (scm_timed_wait_condition_variable
, "wait-condition-variable", 2, 1, 0,
1695 (SCM cv
, SCM mx
, SCM t
),
1696 "Wait until @var{cond-var} has been signalled. While waiting, "
1697 "@var{mutex} is atomically unlocked (as with @code{unlock-mutex}) and "
1698 "is locked again when this function returns. When @var{time} is given, "
1699 "it specifies a point in time where the waiting should be aborted. It "
1700 "can be either a integer as returned by @code{current-time} or a pair "
1701 "as returned by @code{gettimeofday}. When the waiting is aborted the "
1702 "mutex is locked and @code{#f} is returned. When the condition "
1703 "variable is in fact signalled, the mutex is also locked and @code{#t} "
1705 #define FUNC_NAME s_scm_timed_wait_condition_variable
1707 scm_t_timespec waittime
, *waitptr
= NULL
;
1709 SCM_VALIDATE_CONDVAR (1, cv
);
1710 SCM_VALIDATE_MUTEX (2, mx
);
1712 if (!SCM_UNBNDP (t
))
1714 to_timespec (t
, &waittime
);
1715 waitptr
= &waittime
;
1718 return fat_mutex_unlock (mx
, cv
, waitptr
, 1) ? SCM_BOOL_T
: SCM_BOOL_F
;
1723 fat_cond_signal (fat_cond
*c
)
1725 unblock_from_queue (c
->waiting
);
1728 SCM_DEFINE (scm_signal_condition_variable
, "signal-condition-variable", 1, 0, 0,
1730 "Wake up one thread that is waiting for @var{cv}")
1731 #define FUNC_NAME s_scm_signal_condition_variable
1733 SCM_VALIDATE_CONDVAR (1, cv
);
1734 fat_cond_signal (SCM_CONDVAR_DATA (cv
));
1740 fat_cond_broadcast (fat_cond
*c
)
1742 while (scm_is_true (unblock_from_queue (c
->waiting
)))
1746 SCM_DEFINE (scm_broadcast_condition_variable
, "broadcast-condition-variable", 1, 0, 0,
1748 "Wake up all threads that are waiting for @var{cv}. ")
1749 #define FUNC_NAME s_scm_broadcast_condition_variable
1751 SCM_VALIDATE_CONDVAR (1, cv
);
1752 fat_cond_broadcast (SCM_CONDVAR_DATA (cv
));
1757 SCM_DEFINE (scm_condition_variable_p
, "condition-variable?", 1, 0, 0,
1759 "Return @code{#t} if @var{obj} is a condition variable.")
1760 #define FUNC_NAME s_scm_condition_variable_p
1762 return SCM_CONDVARP(obj
) ? SCM_BOOL_T
: SCM_BOOL_F
;
1773 SELECT_TYPE
*read_fds
;
1774 SELECT_TYPE
*write_fds
;
1775 SELECT_TYPE
*except_fds
;
1776 struct timeval
*timeout
;
1783 do_std_select (void *args
)
1785 struct select_args
*select_args
;
1787 select_args
= (struct select_args
*) args
;
1789 select_args
->result
=
1790 select (select_args
->nfds
,
1791 select_args
->read_fds
, select_args
->write_fds
,
1792 select_args
->except_fds
, select_args
->timeout
);
1793 select_args
->errno_value
= errno
;
1799 scm_std_select (int nfds
,
1800 SELECT_TYPE
*readfds
,
1801 SELECT_TYPE
*writefds
,
1802 SELECT_TYPE
*exceptfds
,
1803 struct timeval
*timeout
)
1806 int res
, eno
, wakeup_fd
;
1807 scm_i_thread
*t
= SCM_I_CURRENT_THREAD
;
1808 struct select_args args
;
1810 if (readfds
== NULL
)
1812 FD_ZERO (&my_readfds
);
1813 readfds
= &my_readfds
;
1816 while (scm_i_setup_sleep (t
, SCM_BOOL_F
, NULL
, t
->sleep_pipe
[1]))
1819 wakeup_fd
= t
->sleep_pipe
[0];
1820 FD_SET (wakeup_fd
, readfds
);
1821 if (wakeup_fd
>= nfds
)
1825 args
.read_fds
= readfds
;
1826 args
.write_fds
= writefds
;
1827 args
.except_fds
= exceptfds
;
1828 args
.timeout
= timeout
;
1830 /* Explicitly cooperate with the GC. */
1831 scm_without_guile (do_std_select
, &args
);
1834 eno
= args
.errno_value
;
1837 scm_i_reset_sleep (t
);
1839 if (res
> 0 && FD_ISSET (wakeup_fd
, readfds
))
1842 full_read (wakeup_fd
, &dummy
, 1);
1844 FD_CLR (wakeup_fd
, readfds
);
1856 /* Convenience API for blocking while in guile mode. */
1858 #if SCM_USE_PTHREAD_THREADS
1860 /* It seems reasonable to not run procedures related to mutex and condition
1861 variables within `GC_do_blocking ()' since, (i) the GC can operate even
1862 without it, and (ii) the only potential gain would be GC latency. See
1863 http://thread.gmane.org/gmane.comp.programming.garbage-collection.boehmgc/2245/focus=2251
1864 for a discussion of the pros and cons. */
1867 scm_pthread_mutex_lock (scm_i_pthread_mutex_t
*mutex
)
1869 int res
= scm_i_pthread_mutex_lock (mutex
);
1874 do_unlock (void *data
)
1876 scm_i_pthread_mutex_unlock ((scm_i_pthread_mutex_t
*)data
);
1880 scm_dynwind_pthread_mutex_lock (scm_i_pthread_mutex_t
*mutex
)
1882 scm_i_scm_pthread_mutex_lock (mutex
);
1883 scm_dynwind_unwind_handler (do_unlock
, mutex
, SCM_F_WIND_EXPLICITLY
);
1887 scm_pthread_cond_wait (scm_i_pthread_cond_t
*cond
, scm_i_pthread_mutex_t
*mutex
)
1890 scm_i_thread
*t
= SCM_I_CURRENT_THREAD
;
1892 t
->held_mutex
= mutex
;
1893 res
= scm_i_pthread_cond_wait (cond
, mutex
);
1894 t
->held_mutex
= NULL
;
1900 scm_pthread_cond_timedwait (scm_i_pthread_cond_t
*cond
,
1901 scm_i_pthread_mutex_t
*mutex
,
1902 const scm_t_timespec
*wt
)
1905 scm_i_thread
*t
= SCM_I_CURRENT_THREAD
;
1907 t
->held_mutex
= mutex
;
1908 res
= scm_i_pthread_cond_timedwait (cond
, mutex
, wt
);
1909 t
->held_mutex
= NULL
;
1917 scm_std_usleep (unsigned long usecs
)
1920 tv
.tv_usec
= usecs
% 1000000;
1921 tv
.tv_sec
= usecs
/ 1000000;
1922 scm_std_select (0, NULL
, NULL
, NULL
, &tv
);
1923 return tv
.tv_sec
* 1000000 + tv
.tv_usec
;
1927 scm_std_sleep (unsigned int secs
)
1932 scm_std_select (0, NULL
, NULL
, NULL
, &tv
);
1938 SCM_DEFINE (scm_current_thread
, "current-thread", 0, 0, 0,
1940 "Return the thread that called this function.")
1941 #define FUNC_NAME s_scm_current_thread
1943 return SCM_I_CURRENT_THREAD
->handle
;
1948 scm_c_make_list (size_t n
, SCM fill
)
1952 res
= scm_cons (fill
, res
);
1956 SCM_DEFINE (scm_all_threads
, "all-threads", 0, 0, 0,
1958 "Return a list of all threads.")
1959 #define FUNC_NAME s_scm_all_threads
1961 /* We can not allocate while holding the thread_admin_mutex because
1962 of the way GC is done.
1964 int n
= thread_count
;
1966 SCM list
= scm_c_make_list (n
, SCM_UNSPECIFIED
), *l
;
1968 scm_i_pthread_mutex_lock (&thread_admin_mutex
);
1970 for (t
= all_threads
; t
&& n
> 0; t
= t
->next_thread
)
1972 if (t
!= scm_i_signal_delivery_thread
)
1974 SCM_SETCAR (*l
, t
->handle
);
1975 l
= SCM_CDRLOC (*l
);
1980 scm_i_pthread_mutex_unlock (&thread_admin_mutex
);
1985 SCM_DEFINE (scm_thread_exited_p
, "thread-exited?", 1, 0, 0,
1987 "Return @code{#t} iff @var{thread} has exited.\n")
1988 #define FUNC_NAME s_scm_thread_exited_p
1990 return scm_from_bool (scm_c_thread_exited_p (thread
));
1995 scm_c_thread_exited_p (SCM thread
)
1996 #define FUNC_NAME s_scm_thread_exited_p
1999 SCM_VALIDATE_THREAD (1, thread
);
2000 t
= SCM_I_THREAD_DATA (thread
);
2005 static scm_i_pthread_cond_t wake_up_cond
;
2006 static int threads_initialized_p
= 0;
2009 /* This mutex is used by SCM_CRITICAL_SECTION_START/END.
2011 scm_i_pthread_mutex_t scm_i_critical_section_mutex
;
2013 static SCM dynwind_critical_section_mutex
;
2016 scm_dynwind_critical_section (SCM mutex
)
2018 if (scm_is_false (mutex
))
2019 mutex
= dynwind_critical_section_mutex
;
2020 scm_dynwind_lock_mutex (mutex
);
2021 scm_dynwind_block_asyncs ();
2024 /*** Initialization */
2026 scm_i_pthread_mutex_t scm_i_misc_mutex
;
2028 #if SCM_USE_PTHREAD_THREADS
2029 pthread_mutexattr_t scm_i_pthread_mutexattr_recursive
[1];
2033 scm_threads_prehistory (void *base
)
2035 #if SCM_USE_PTHREAD_THREADS
2036 pthread_mutexattr_init (scm_i_pthread_mutexattr_recursive
);
2037 pthread_mutexattr_settype (scm_i_pthread_mutexattr_recursive
,
2038 PTHREAD_MUTEX_RECURSIVE
);
2041 scm_i_pthread_mutex_init (&scm_i_critical_section_mutex
,
2042 scm_i_pthread_mutexattr_recursive
);
2043 scm_i_pthread_mutex_init (&scm_i_misc_mutex
, NULL
);
2044 scm_i_pthread_cond_init (&wake_up_cond
, NULL
);
2046 guilify_self_1 ((struct GC_stack_base
*) base
);
2049 scm_t_bits scm_tc16_thread
;
2050 scm_t_bits scm_tc16_mutex
;
2051 scm_t_bits scm_tc16_condvar
;
2056 scm_tc16_thread
= scm_make_smob_type ("thread", sizeof (scm_i_thread
));
2057 scm_set_smob_print (scm_tc16_thread
, thread_print
);
2059 scm_tc16_mutex
= scm_make_smob_type ("mutex", sizeof (fat_mutex
));
2060 scm_set_smob_print (scm_tc16_mutex
, fat_mutex_print
);
2061 scm_set_smob_free (scm_tc16_mutex
, fat_mutex_free
);
2063 scm_tc16_condvar
= scm_make_smob_type ("condition-variable",
2065 scm_set_smob_print (scm_tc16_condvar
, fat_cond_print
);
2067 scm_i_default_dynamic_state
= SCM_BOOL_F
;
2068 guilify_self_2 (SCM_BOOL_F
);
2069 threads_initialized_p
= 1;
2071 dynwind_critical_section_mutex
= scm_make_recursive_mutex ();
2075 scm_init_threads_default_dynamic_state ()
2077 SCM state
= scm_make_dynamic_state (scm_current_dynamic_state ());
2078 scm_i_default_dynamic_state
= state
;
2082 scm_init_thread_procs ()
2084 #include "libguile/threads.x"
2088 /* IA64-specific things. */
2092 # include <sys/param.h>
2093 # include <sys/pstat.h>
2095 scm_ia64_register_backing_store_base (void)
2097 struct pst_vm_status vm_status
;
2099 while (pstat_getprocvm (&vm_status
, sizeof (vm_status
), 0, i
++) == 1)
2100 if (vm_status
.pst_type
== PS_RSESTACK
)
2101 return (void *) vm_status
.pst_vaddr
;
2105 scm_ia64_ar_bsp (const void *ctx
)
2108 __uc_get_ar_bsp (ctx
, &bsp
);
2109 return (void *) bsp
;
2113 # include <ucontext.h>
2115 scm_ia64_register_backing_store_base (void)
2117 extern void *__libc_ia64_register_backing_store_base
;
2118 return __libc_ia64_register_backing_store_base
;
2121 scm_ia64_ar_bsp (const void *opaque
)
2123 const ucontext_t
*ctx
= opaque
;
2124 return (void *) ctx
->uc_mcontext
.sc_ar_bsp
;
2127 #endif /* __ia64__ */