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.
5 * This library is free software; you can redistribute it and/or
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.
10 * This library is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
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
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
27 #include "libguile/bdw-gc.h"
28 #include "libguile/_scm.h"
37 #include <string.h> /* for memset used by FD_ZERO on Solaris 10 */
45 # include <pthread_np.h>
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"
58 #include "libguile/dynwind.h"
59 #include "libguile/iselect.h"
60 #include "libguile/fluids.h"
61 #include "libguile/continuations.h"
62 #include "libguile/gc.h"
63 #include "libguile/init.h"
64 #include "libguile/scmsigs.h"
65 #include "libguile/strings.h"
67 #include <full-read.h>
72 /* First some libgc shims. */
74 /* Make sure GC_fn_type is defined; it is missing from the public
75 headers of GC 7.1 and earlier. */
76 #ifndef HAVE_GC_FN_TYPE
77 typedef void * (* GC_fn_type
) (void *);
85 #ifndef GC_UNIMPLEMENTED
86 #define GC_UNIMPLEMENTED 3
89 /* Likewise struct GC_stack_base is missing before 7.1. */
90 #ifndef HAVE_GC_STACK_BASE
91 struct GC_stack_base
{
92 void * mem_base
; /* Base of memory stack. */
94 void * reg_base
; /* Base of separate register stack. */
99 GC_register_my_thread (struct GC_stack_base
*stack_base
)
101 return GC_UNIMPLEMENTED
;
105 GC_unregister_my_thread ()
109 #if !SCM_USE_PTHREAD_THREADS
110 /* No threads; we can just use GC_stackbottom. */
112 get_thread_stack_base ()
114 return GC_stackbottom
;
117 #elif defined HAVE_PTHREAD_ATTR_GETSTACK && defined HAVE_PTHREAD_GETATTR_NP \
118 && defined PTHREAD_ATTR_GETSTACK_WORKS
119 /* This method for GNU/Linux and perhaps some other systems.
120 It's not for MacOS X or Solaris 10, since pthread_getattr_np is not
121 available on them. */
123 get_thread_stack_base ()
129 pthread_getattr_np (pthread_self (), &attr
);
130 pthread_attr_getstack (&attr
, &start
, &size
);
131 end
= (char *)start
+ size
;
133 #if SCM_STACK_GROWS_UP
140 #elif defined HAVE_PTHREAD_GET_STACKADDR_NP
141 /* This method for MacOS X.
142 It'd be nice if there was some documentation on pthread_get_stackaddr_np,
143 but as of 2006 there's nothing obvious at apple.com. */
145 get_thread_stack_base ()
147 return pthread_get_stackaddr_np (pthread_self ());
150 #elif HAVE_PTHREAD_ATTR_GET_NP
151 /* This one is for FreeBSD 9. */
153 get_thread_stack_base ()
159 pthread_attr_init (&attr
);
160 pthread_attr_get_np (pthread_self (), &attr
);
161 pthread_attr_getstack (&attr
, &start
, &size
);
162 pthread_attr_destroy (&attr
);
164 end
= (char *)start
+ size
;
166 #if SCM_STACK_GROWS_UP
174 #error Threads enabled with old BDW-GC, but missing get_thread_stack_base impl. Please upgrade to libgc >= 7.1.
178 GC_get_stack_base (struct GC_stack_base
*stack_base
)
180 stack_base
->mem_base
= get_thread_stack_base ();
182 /* Calculate and store off the base of this thread's register
183 backing store (RBS). Unfortunately our implementation(s) of
184 scm_ia64_register_backing_store_base are only reliable for the
185 main thread. For other threads, therefore, find out the current
186 top of the RBS, and use that as a maximum. */
187 stack_base
->reg_base
= scm_ia64_register_backing_store_base ();
192 bsp
= scm_ia64_ar_bsp (&ctx
);
193 if (stack_base
->reg_base
> bsp
)
194 stack_base
->reg_base
= bsp
;
201 GC_call_with_stack_base(void * (*fn
) (struct GC_stack_base
*, void*), void *arg
)
203 struct GC_stack_base stack_base
;
205 stack_base
.mem_base
= (void*)&stack_base
;
207 /* FIXME: Untested. */
211 stack_base
.reg_base
= scm_ia64_ar_bsp (&ctx
);
215 return fn (&stack_base
, arg
);
217 #endif /* HAVE_GC_STACK_BASE */
220 /* Now define with_gc_active and with_gc_inactive. */
222 #if (defined(HAVE_GC_DO_BLOCKING) && defined (HAVE_DECL_GC_DO_BLOCKING) && defined (HAVE_GC_CALL_WITH_GC_ACTIVE))
224 /* We have a sufficiently new libgc (7.2 or newer). */
227 with_gc_inactive (GC_fn_type func
, void *data
)
229 return GC_do_blocking (func
, data
);
233 with_gc_active (GC_fn_type func
, void *data
)
235 return GC_call_with_gc_active (func
, data
);
240 /* libgc not new enough, so never actually deactivate GC.
242 Note that though GC 7.1 does have a GC_do_blocking, it doesn't have
243 GC_call_with_gc_active. */
246 with_gc_inactive (GC_fn_type func
, void *data
)
252 with_gc_active (GC_fn_type func
, void *data
)
257 #endif /* HAVE_GC_DO_BLOCKING */
262 to_timespec (SCM t
, scm_t_timespec
*waittime
)
266 waittime
->tv_sec
= scm_to_ulong (SCM_CAR (t
));
267 waittime
->tv_nsec
= scm_to_ulong (SCM_CDR (t
)) * 1000;
271 double time
= scm_to_double (t
);
272 double sec
= scm_c_truncate (time
);
274 waittime
->tv_sec
= (long) sec
;
275 waittime
->tv_nsec
= (long) ((time
- sec
) * 1000000000);
282 /* Note: We annotate with "GC-robust" assignments whose purpose is to avoid
283 the risk of false references leading to unbounded retained space as
284 described in "Bounding Space Usage of Conservative Garbage Collectors",
287 /* Make an empty queue data structure.
292 return scm_cons (SCM_EOL
, SCM_EOL
);
295 /* Put T at the back of Q and return a handle that can be used with
296 remqueue to remove T from Q again.
299 enqueue (SCM q
, SCM t
)
301 SCM c
= scm_cons (t
, SCM_EOL
);
302 SCM_CRITICAL_SECTION_START
;
303 if (scm_is_null (SCM_CDR (q
)))
306 SCM_SETCDR (SCM_CAR (q
), c
);
308 SCM_CRITICAL_SECTION_END
;
312 /* Remove the element that the handle C refers to from the queue Q. C
313 must have been returned from a call to enqueue. The return value
314 is zero when the element referred to by C has already been removed.
315 Otherwise, 1 is returned.
318 remqueue (SCM q
, SCM c
)
321 SCM_CRITICAL_SECTION_START
;
322 for (p
= SCM_CDR (q
); !scm_is_null (p
); p
= SCM_CDR (p
))
324 if (scm_is_eq (p
, c
))
326 if (scm_is_eq (c
, SCM_CAR (q
)))
327 SCM_SETCAR (q
, SCM_CDR (c
));
328 SCM_SETCDR (prev
, SCM_CDR (c
));
331 SCM_SETCDR (c
, SCM_EOL
);
333 SCM_CRITICAL_SECTION_END
;
338 SCM_CRITICAL_SECTION_END
;
342 /* Remove the front-most element from the queue Q and return it.
343 Return SCM_BOOL_F when Q is empty.
349 SCM_CRITICAL_SECTION_START
;
353 SCM_CRITICAL_SECTION_END
;
358 SCM_SETCDR (q
, SCM_CDR (c
));
359 if (scm_is_null (SCM_CDR (q
)))
360 SCM_SETCAR (q
, SCM_EOL
);
361 SCM_CRITICAL_SECTION_END
;
364 SCM_SETCDR (c
, SCM_EOL
);
370 /*** Thread smob routines */
374 thread_print (SCM exp
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
376 /* On a Gnu system pthread_t is an unsigned long, but on mingw it's a
377 struct. A cast like "(unsigned long) t->pthread" is a syntax error in
378 the struct case, hence we go via a union, and extract according to the
379 size of pthread_t. */
387 scm_i_thread
*t
= SCM_I_THREAD_DATA (exp
);
388 scm_i_pthread_t p
= t
->pthread
;
391 if (sizeof (p
) == sizeof (unsigned short))
393 else if (sizeof (p
) == sizeof (unsigned int))
395 else if (sizeof (p
) == sizeof (unsigned long))
400 scm_puts_unlocked ("#<thread ", port
);
401 scm_uintprint (id
, 10, port
);
402 scm_puts_unlocked (" (", port
);
403 scm_uintprint ((scm_t_bits
)t
, 16, port
);
404 scm_puts_unlocked (")>", port
);
409 /*** Blocking on queues. */
411 /* See also scm_i_queue_async_cell for how such a block is
415 /* Put the current thread on QUEUE and go to sleep, waiting for it to
416 be woken up by a call to 'unblock_from_queue', or to be
417 interrupted. Upon return of this function, the current thread is
418 no longer on QUEUE, even when the sleep has been interrupted.
420 The caller of block_self must hold MUTEX. It will be atomically
421 unlocked while sleeping, just as with scm_i_pthread_cond_wait.
423 SLEEP_OBJECT is an arbitrary SCM value that is kept alive as long
426 When WAITTIME is not NULL, the sleep will be aborted at that time.
428 The return value of block_self is an errno value. It will be zero
429 when the sleep has been successfully completed by a call to
430 unblock_from_queue, EINTR when it has been interrupted by the
431 delivery of a system async, and ETIMEDOUT when the timeout has
434 The system asyncs themselves are not executed by block_self.
437 block_self (SCM queue
, SCM sleep_object
, scm_i_pthread_mutex_t
*mutex
,
438 const scm_t_timespec
*waittime
)
440 scm_i_thread
*t
= SCM_I_CURRENT_THREAD
;
444 if (scm_i_setup_sleep (t
, sleep_object
, mutex
, -1))
449 q_handle
= enqueue (queue
, t
->handle
);
450 if (waittime
== NULL
)
451 err
= scm_i_scm_pthread_cond_wait (&t
->sleep_cond
, mutex
);
453 err
= scm_i_scm_pthread_cond_timedwait (&t
->sleep_cond
, mutex
, waittime
);
455 /* When we are still on QUEUE, we have been interrupted. We
456 report this only when no other error (such as a timeout) has
459 if (remqueue (queue
, q_handle
) && err
== 0)
462 scm_i_reset_sleep (t
);
468 /* Wake up the first thread on QUEUE, if any. The awoken thread is
469 returned, or #f if the queue was empty.
472 unblock_from_queue (SCM queue
)
474 SCM thread
= dequeue (queue
);
475 if (scm_is_true (thread
))
476 scm_i_pthread_cond_signal (&SCM_I_THREAD_DATA(thread
)->sleep_cond
);
481 /* Getting into and out of guile mode.
484 /* Key used to attach a cleanup handler to a given thread. Also, if
485 thread-local storage is unavailable, this key is used to retrieve the
486 current thread with `pthread_getspecific ()'. */
487 scm_i_pthread_key_t scm_i_thread_key
;
490 #ifdef SCM_HAVE_THREAD_STORAGE_CLASS
492 /* When thread-local storage (TLS) is available, a pointer to the
493 current-thread object is kept in TLS. Note that storing the thread-object
494 itself in TLS (rather than a pointer to some malloc'd memory) is not
495 possible since thread objects may live longer than the actual thread they
497 SCM_THREAD_LOCAL scm_i_thread
*scm_i_current_thread
= NULL
;
499 #endif /* SCM_HAVE_THREAD_STORAGE_CLASS */
502 static scm_i_pthread_mutex_t thread_admin_mutex
= SCM_I_PTHREAD_MUTEX_INITIALIZER
;
503 SCM_PTHREAD_ATFORK_LOCK_STATIC_MUTEX (thread_admin_mutex
);
504 static scm_i_thread
*all_threads
= NULL
;
505 static int thread_count
;
507 static SCM scm_i_default_dynamic_state
;
509 /* Run when a fluid is collected. */
511 scm_i_reset_fluid (size_t n
)
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
))
519 SCM v
= SCM_I_DYNAMIC_STATE_FLUIDS (t
->dynamic_state
);
521 if (n
< SCM_SIMPLE_VECTOR_LENGTH (v
))
522 SCM_SIMPLE_VECTOR_SET (v
, n
, SCM_UNDEFINED
);
524 scm_i_pthread_mutex_unlock (&thread_admin_mutex
);
527 /* Perform first stage of thread initialisation, in non-guile mode.
530 guilify_self_1 (struct GC_stack_base
*base
)
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. */
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
;
545 t
.join_queue
= SCM_EOL
;
546 t
.dynamic_state
= SCM_BOOL_F
;
547 t
.dynwinds
= SCM_EOL
;
548 t
.active_asyncs
= SCM_EOL
;
550 t
.pending_asyncs
= 1;
551 t
.critical_section_level
= 0;
552 t
.base
= base
->mem_base
;
554 t
.register_backing_store_base
= base
->reg_base
;
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
;
563 if (pipe2 (t
.sleep_pipe
, O_CLOEXEC
) != 0)
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'. */
569 scm_i_pthread_mutex_init (&t
.admin_mutex
, NULL
);
570 t
.current_mark_stack_ptr
= NULL
;
571 t
.current_mark_stack_limit
= NULL
;
576 /* The switcheroo. */
578 scm_i_thread
*t_ptr
= &t
;
581 t_ptr
= GC_malloc (sizeof (scm_i_thread
));
582 memcpy (t_ptr
, &t
, sizeof t
);
584 scm_i_pthread_setspecific (scm_i_thread_key
, t_ptr
);
586 #ifdef SCM_HAVE_THREAD_STORAGE_CLASS
587 /* Cache the current thread in TLS for faster lookup. */
588 scm_i_current_thread
= t_ptr
;
591 scm_i_pthread_mutex_lock (&thread_admin_mutex
);
592 t_ptr
->next_thread
= all_threads
;
595 scm_i_pthread_mutex_unlock (&thread_admin_mutex
);
601 /* Perform second stage of thread initialisation, in guile mode.
604 guilify_self_2 (SCM parent
)
606 scm_i_thread
*t
= SCM_I_CURRENT_THREAD
;
610 SCM_NEWSMOB (t
->handle
, scm_tc16_thread
, t
);
612 t
->continuation_root
= scm_cons (t
->handle
, SCM_EOL
);
613 t
->continuation_base
= t
->base
;
616 if (scm_is_true (parent
))
617 t
->dynamic_state
= scm_make_dynamic_state (parent
);
619 t
->dynamic_state
= scm_i_make_initial_dynamic_state ();
621 t
->join_queue
= make_queue ();
628 /* We implement our own mutex type since we want them to be 'fair', we
629 want to do fancy things while waiting for them (like running
630 asyncs) and we might want to add things that are nice for
635 scm_i_pthread_mutex_t lock
;
637 int level
; /* how much the owner owns us. <= 1 for non-recursive mutexes */
639 int recursive
; /* allow recursive locking? */
640 int unchecked_unlock
; /* is it an error to unlock an unlocked mutex? */
641 int allow_external_unlock
; /* is it an error to unlock a mutex that is not
642 owned by the current thread? */
644 SCM waiting
; /* the threads waiting for this mutex. */
647 #define SCM_MUTEXP(x) SCM_SMOB_PREDICATE (scm_tc16_mutex, x)
648 #define SCM_MUTEX_DATA(x) ((fat_mutex *) SCM_SMOB_DATA (x))
651 call_cleanup (void *data
)
654 return scm_call_0 (*proc_p
);
657 /* Perform thread tear-down, in guile mode.
660 do_thread_exit (void *v
)
662 scm_i_thread
*t
= (scm_i_thread
*) v
;
664 if (!scm_is_false (t
->cleanup_handler
))
666 SCM ptr
= t
->cleanup_handler
;
668 t
->cleanup_handler
= SCM_BOOL_F
;
669 t
->result
= scm_internal_catch (SCM_BOOL_T
,
671 scm_handle_by_message_noexit
, NULL
);
674 scm_i_scm_pthread_mutex_lock (&t
->admin_mutex
);
677 close (t
->sleep_pipe
[0]);
678 close (t
->sleep_pipe
[1]);
679 while (scm_is_true (unblock_from_queue (t
->join_queue
)))
682 while (!scm_is_null (t
->mutexes
))
684 SCM mutex
= scm_c_weak_vector_ref (scm_car (t
->mutexes
), 0);
686 if (scm_is_true (mutex
))
688 fat_mutex
*m
= SCM_MUTEX_DATA (mutex
);
690 scm_i_pthread_mutex_lock (&m
->lock
);
692 /* Since MUTEX is in `t->mutexes', T must be its owner. */
693 assert (scm_is_eq (m
->owner
, t
->handle
));
695 unblock_from_queue (m
->waiting
);
697 scm_i_pthread_mutex_unlock (&m
->lock
);
700 t
->mutexes
= scm_cdr (t
->mutexes
);
703 scm_i_pthread_mutex_unlock (&t
->admin_mutex
);
709 do_thread_exit_trampoline (struct GC_stack_base
*sb
, void *v
)
711 /* Won't hurt if we are already registered. */
712 #if SCM_USE_PTHREAD_THREADS
713 GC_register_my_thread (sb
);
716 return scm_with_guile (do_thread_exit
, v
);
720 on_thread_exit (void *v
)
722 /* This handler is executed in non-guile mode. */
723 scm_i_thread
*t
= (scm_i_thread
*) v
, **tp
;
725 /* If we were canceled, we were unable to clear `t->guile_mode', so do
729 /* If this thread was cancelled while doing a cond wait, it will
730 still have a mutex locked, so we unlock it here. */
733 scm_i_pthread_mutex_unlock (t
->held_mutex
);
734 t
->held_mutex
= NULL
;
737 /* Reinstate the current thread for purposes of scm_with_guile
738 guile-mode cleanup handlers. Only really needed in the non-TLS
739 case but it doesn't hurt to be consistent. */
740 scm_i_pthread_setspecific (scm_i_thread_key
, t
);
742 /* Scheme-level thread finalizers and other cleanup needs to happen in
744 GC_call_with_stack_base (do_thread_exit_trampoline
, t
);
746 /* Removing ourself from the list of all threads needs to happen in
747 non-guile mode since all SCM values on our stack become
748 unprotected once we are no longer in the list. */
749 scm_i_pthread_mutex_lock (&thread_admin_mutex
);
750 for (tp
= &all_threads
; *tp
; tp
= &(*tp
)->next_thread
)
753 *tp
= t
->next_thread
;
756 t
->next_thread
= NULL
;
762 /* If there's only one other thread, it could be the signal delivery
763 thread, so we need to notify it to shut down by closing its read pipe.
764 If it's not the signal delivery thread, then closing the read pipe isn't
766 if (thread_count
<= 1)
767 scm_i_close_signal_pipe ();
769 scm_i_pthread_mutex_unlock (&thread_admin_mutex
);
771 scm_i_pthread_setspecific (scm_i_thread_key
, NULL
);
773 #if SCM_USE_PTHREAD_THREADS
774 GC_unregister_my_thread ();
778 static scm_i_pthread_once_t init_thread_key_once
= SCM_I_PTHREAD_ONCE_INIT
;
781 init_thread_key (void)
783 scm_i_pthread_key_create (&scm_i_thread_key
, on_thread_exit
);
786 /* Perform any initializations necessary to make the current thread
787 known to Guile (via SCM_I_CURRENT_THREAD), initializing Guile itself,
790 BASE is the stack base to use with GC.
792 PARENT is the dynamic state to use as the parent, ot SCM_BOOL_F in
793 which case the default dynamic state is used.
795 Returns zero when the thread was known to guile already; otherwise
798 Note that it could be the case that the thread was known
799 to Guile, but not in guile mode (because we are within a
800 scm_without_guile call). Check SCM_I_CURRENT_THREAD->guile_mode to
801 be sure. New threads are put into guile mode implicitly. */
804 scm_i_init_thread_for_guile (struct GC_stack_base
*base
, SCM parent
)
806 scm_i_pthread_once (&init_thread_key_once
, init_thread_key
);
808 if (SCM_I_CURRENT_THREAD
)
810 /* Thread is already known to Guile.
816 /* This thread has not been guilified yet.
819 scm_i_pthread_mutex_lock (&scm_i_init_mutex
);
820 if (scm_initialized_p
== 0)
822 /* First thread ever to enter Guile. Run the full
825 scm_i_init_guile (base
);
827 #if defined (HAVE_GC_ALLOW_REGISTER_THREADS) && SCM_USE_PTHREAD_THREADS
828 /* Allow other threads to come in later. */
829 GC_allow_register_threads ();
832 scm_i_pthread_mutex_unlock (&scm_i_init_mutex
);
836 /* Guile is already initialized, but this thread enters it for
837 the first time. Only initialize this thread.
839 scm_i_pthread_mutex_unlock (&scm_i_init_mutex
);
841 /* Register this thread with libgc. */
842 #if SCM_USE_PTHREAD_THREADS
843 GC_register_my_thread (base
);
846 guilify_self_1 (base
);
847 guilify_self_2 (parent
);
856 struct GC_stack_base stack_base
;
858 if (GC_get_stack_base (&stack_base
) == GC_SUCCESS
)
859 scm_i_init_thread_for_guile (&stack_base
,
860 scm_i_default_dynamic_state
);
863 fprintf (stderr
, "Failed to get stack base for current thread.\n");
868 struct with_guile_args
876 with_guile_trampoline (void *data
)
878 struct with_guile_args
*args
= data
;
880 return scm_c_with_continuation_barrier (args
->func
, args
->data
);
884 with_guile_and_parent (struct GC_stack_base
*base
, void *data
)
889 struct with_guile_args
*args
= data
;
891 new_thread
= scm_i_init_thread_for_guile (base
, args
->parent
);
892 t
= SCM_I_CURRENT_THREAD
;
895 /* We are in Guile mode. */
896 assert (t
->guile_mode
);
898 res
= scm_c_with_continuation_barrier (args
->func
, args
->data
);
900 /* Leave Guile mode. */
903 else if (t
->guile_mode
)
905 /* Already in Guile mode. */
906 res
= scm_c_with_continuation_barrier (args
->func
, args
->data
);
910 /* We are not in Guile mode, either because we are not within a
911 scm_with_guile, or because we are within a scm_without_guile.
913 This call to scm_with_guile() could happen from anywhere on the
914 stack, and in particular lower on the stack than when it was
915 when this thread was first guilified. Thus, `base' must be
917 #if SCM_STACK_GROWS_UP
918 if (SCM_STACK_PTR (base
->mem_base
) < t
->base
)
919 t
->base
= SCM_STACK_PTR (base
->mem_base
);
921 if (SCM_STACK_PTR (base
->mem_base
) > t
->base
)
922 t
->base
= SCM_STACK_PTR (base
->mem_base
);
926 res
= with_gc_active (with_guile_trampoline
, args
);
933 scm_i_with_guile_and_parent (void *(*func
)(void *), void *data
, SCM parent
)
935 struct with_guile_args args
;
939 args
.parent
= parent
;
941 return GC_call_with_stack_base (with_guile_and_parent
, &args
);
945 scm_with_guile (void *(*func
)(void *), void *data
)
947 return scm_i_with_guile_and_parent (func
, data
,
948 scm_i_default_dynamic_state
);
952 scm_without_guile (void *(*func
)(void *), void *data
)
955 scm_i_thread
*t
= SCM_I_CURRENT_THREAD
;
959 SCM_I_CURRENT_THREAD
->guile_mode
= 0;
960 result
= with_gc_inactive (func
, data
);
961 SCM_I_CURRENT_THREAD
->guile_mode
= 1;
964 /* Otherwise we're not in guile mode, so nothing to do. */
965 result
= func (data
);
971 /*** Thread creation */
978 scm_i_pthread_mutex_t mutex
;
979 scm_i_pthread_cond_t cond
;
983 really_launch (void *d
)
985 launch_data
*data
= (launch_data
*)d
;
986 SCM thunk
= data
->thunk
, handler
= data
->handler
;
989 t
= SCM_I_CURRENT_THREAD
;
991 scm_i_scm_pthread_mutex_lock (&data
->mutex
);
992 data
->thread
= scm_current_thread ();
993 scm_i_pthread_cond_signal (&data
->cond
);
994 scm_i_pthread_mutex_unlock (&data
->mutex
);
996 if (SCM_UNBNDP (handler
))
997 t
->result
= scm_call_0 (thunk
);
999 t
->result
= scm_catch (SCM_BOOL_T
, thunk
, handler
);
1005 launch_thread (void *d
)
1007 launch_data
*data
= (launch_data
*)d
;
1008 scm_i_pthread_detach (scm_i_pthread_self ());
1009 scm_i_with_guile_and_parent (really_launch
, d
, data
->parent
);
1013 SCM_DEFINE (scm_call_with_new_thread
, "call-with-new-thread", 1, 1, 0,
1014 (SCM thunk
, SCM handler
),
1015 "Call @code{thunk} in a new thread and with a new dynamic state,\n"
1016 "returning a new thread object representing the thread. The procedure\n"
1017 "@var{thunk} is called via @code{with-continuation-barrier}.\n"
1019 "When @var{handler} is specified, then @var{thunk} is called from\n"
1020 "within a @code{catch} with tag @code{#t} that has @var{handler} as its\n"
1021 "handler. This catch is established inside the continuation barrier.\n"
1023 "Once @var{thunk} or @var{handler} returns, the return value is made\n"
1024 "the @emph{exit value} of the thread and the thread is terminated.")
1025 #define FUNC_NAME s_scm_call_with_new_thread
1031 SCM_ASSERT (scm_is_true (scm_thunk_p (thunk
)), thunk
, SCM_ARG1
, FUNC_NAME
);
1032 SCM_ASSERT (SCM_UNBNDP (handler
) || scm_is_true (scm_procedure_p (handler
)),
1033 handler
, SCM_ARG2
, FUNC_NAME
);
1035 GC_collect_a_little ();
1036 data
.parent
= scm_current_dynamic_state ();
1038 data
.handler
= handler
;
1039 data
.thread
= SCM_BOOL_F
;
1040 scm_i_pthread_mutex_init (&data
.mutex
, NULL
);
1041 scm_i_pthread_cond_init (&data
.cond
, NULL
);
1043 scm_i_scm_pthread_mutex_lock (&data
.mutex
);
1044 err
= scm_i_pthread_create (&id
, NULL
, launch_thread
, &data
);
1047 scm_i_pthread_mutex_unlock (&data
.mutex
);
1049 scm_syserror (NULL
);
1051 scm_i_scm_pthread_cond_wait (&data
.cond
, &data
.mutex
);
1052 scm_i_pthread_mutex_unlock (&data
.mutex
);
1060 scm_t_catch_body body
;
1062 scm_t_catch_handler handler
;
1065 scm_i_pthread_mutex_t mutex
;
1066 scm_i_pthread_cond_t cond
;
1070 really_spawn (void *d
)
1072 spawn_data
*data
= (spawn_data
*)d
;
1073 scm_t_catch_body body
= data
->body
;
1074 void *body_data
= data
->body_data
;
1075 scm_t_catch_handler handler
= data
->handler
;
1076 void *handler_data
= data
->handler_data
;
1077 scm_i_thread
*t
= SCM_I_CURRENT_THREAD
;
1079 scm_i_scm_pthread_mutex_lock (&data
->mutex
);
1080 data
->thread
= scm_current_thread ();
1081 scm_i_pthread_cond_signal (&data
->cond
);
1082 scm_i_pthread_mutex_unlock (&data
->mutex
);
1084 if (handler
== NULL
)
1085 t
->result
= body (body_data
);
1087 t
->result
= scm_internal_catch (SCM_BOOL_T
,
1089 handler
, handler_data
);
1095 spawn_thread (void *d
)
1097 spawn_data
*data
= (spawn_data
*)d
;
1098 scm_i_pthread_detach (scm_i_pthread_self ());
1099 scm_i_with_guile_and_parent (really_spawn
, d
, data
->parent
);
1104 scm_spawn_thread (scm_t_catch_body body
, void *body_data
,
1105 scm_t_catch_handler handler
, void *handler_data
)
1111 data
.parent
= scm_current_dynamic_state ();
1113 data
.body_data
= body_data
;
1114 data
.handler
= handler
;
1115 data
.handler_data
= handler_data
;
1116 data
.thread
= SCM_BOOL_F
;
1117 scm_i_pthread_mutex_init (&data
.mutex
, NULL
);
1118 scm_i_pthread_cond_init (&data
.cond
, NULL
);
1120 scm_i_scm_pthread_mutex_lock (&data
.mutex
);
1121 err
= scm_i_pthread_create (&id
, NULL
, spawn_thread
, &data
);
1124 scm_i_pthread_mutex_unlock (&data
.mutex
);
1126 scm_syserror (NULL
);
1128 scm_i_scm_pthread_cond_wait (&data
.cond
, &data
.mutex
);
1129 scm_i_pthread_mutex_unlock (&data
.mutex
);
1131 assert (SCM_I_IS_THREAD (data
.thread
));
1136 SCM_DEFINE (scm_yield
, "yield", 0, 0, 0,
1138 "Move the calling thread to the end of the scheduling queue.")
1139 #define FUNC_NAME s_scm_yield
1141 return scm_from_bool (scm_i_sched_yield ());
1145 SCM_DEFINE (scm_cancel_thread
, "cancel-thread", 1, 0, 0,
1147 "Asynchronously force the target @var{thread} to terminate. @var{thread} "
1148 "cannot be the current thread, and if @var{thread} has already terminated or "
1149 "been signaled to terminate, this function is a no-op.")
1150 #define FUNC_NAME s_scm_cancel_thread
1152 scm_i_thread
*t
= NULL
;
1154 SCM_VALIDATE_THREAD (1, thread
);
1155 t
= SCM_I_THREAD_DATA (thread
);
1156 scm_i_scm_pthread_mutex_lock (&t
->admin_mutex
);
1160 scm_i_pthread_mutex_unlock (&t
->admin_mutex
);
1161 scm_i_pthread_cancel (t
->pthread
);
1164 scm_i_pthread_mutex_unlock (&t
->admin_mutex
);
1166 return SCM_UNSPECIFIED
;
1170 SCM_DEFINE (scm_set_thread_cleanup_x
, "set-thread-cleanup!", 2, 0, 0,
1171 (SCM thread
, SCM proc
),
1172 "Set the thunk @var{proc} as the cleanup handler for the thread @var{thread}. "
1173 "This handler will be called when the thread exits.")
1174 #define FUNC_NAME s_scm_set_thread_cleanup_x
1178 SCM_VALIDATE_THREAD (1, thread
);
1179 if (!scm_is_false (proc
))
1180 SCM_VALIDATE_THUNK (2, proc
);
1182 t
= SCM_I_THREAD_DATA (thread
);
1183 scm_i_pthread_mutex_lock (&t
->admin_mutex
);
1185 if (!(t
->exited
|| t
->canceled
))
1186 t
->cleanup_handler
= proc
;
1188 scm_i_pthread_mutex_unlock (&t
->admin_mutex
);
1190 return SCM_UNSPECIFIED
;
1194 SCM_DEFINE (scm_thread_cleanup
, "thread-cleanup", 1, 0, 0,
1196 "Return the cleanup handler installed for the thread @var{thread}.")
1197 #define FUNC_NAME s_scm_thread_cleanup
1202 SCM_VALIDATE_THREAD (1, thread
);
1204 t
= SCM_I_THREAD_DATA (thread
);
1205 scm_i_pthread_mutex_lock (&t
->admin_mutex
);
1206 ret
= (t
->exited
|| t
->canceled
) ? SCM_BOOL_F
: t
->cleanup_handler
;
1207 scm_i_pthread_mutex_unlock (&t
->admin_mutex
);
1213 SCM
scm_join_thread (SCM thread
)
1215 return scm_join_thread_timed (thread
, SCM_UNDEFINED
, SCM_UNDEFINED
);
1218 SCM_DEFINE (scm_join_thread_timed
, "join-thread", 1, 2, 0,
1219 (SCM thread
, SCM timeout
, SCM timeoutval
),
1220 "Suspend execution of the calling thread until the target @var{thread} "
1221 "terminates, unless the target @var{thread} has already terminated. ")
1222 #define FUNC_NAME s_scm_join_thread_timed
1225 scm_t_timespec ctimeout
, *timeout_ptr
= NULL
;
1226 SCM res
= SCM_BOOL_F
;
1228 if (! (SCM_UNBNDP (timeoutval
)))
1231 SCM_VALIDATE_THREAD (1, thread
);
1232 if (scm_is_eq (scm_current_thread (), thread
))
1233 SCM_MISC_ERROR ("cannot join the current thread", SCM_EOL
);
1235 t
= SCM_I_THREAD_DATA (thread
);
1236 scm_i_scm_pthread_mutex_lock (&t
->admin_mutex
);
1238 if (! SCM_UNBNDP (timeout
))
1240 to_timespec (timeout
, &ctimeout
);
1241 timeout_ptr
= &ctimeout
;
1250 int err
= block_self (t
->join_queue
, thread
, &t
->admin_mutex
,
1260 else if (err
== ETIMEDOUT
)
1263 scm_i_pthread_mutex_unlock (&t
->admin_mutex
);
1265 scm_i_scm_pthread_mutex_lock (&t
->admin_mutex
);
1267 /* Check for exit again, since we just released and
1268 reacquired the admin mutex, before the next block_self
1269 call (which would block forever if t has already
1279 scm_i_pthread_mutex_unlock (&t
->admin_mutex
);
1285 SCM_DEFINE (scm_thread_p
, "thread?", 1, 0, 0,
1287 "Return @code{#t} if @var{obj} is a thread.")
1288 #define FUNC_NAME s_scm_thread_p
1290 return SCM_I_IS_THREAD(obj
) ? SCM_BOOL_T
: SCM_BOOL_F
;
1296 fat_mutex_free (SCM mx
)
1298 fat_mutex
*m
= SCM_MUTEX_DATA (mx
);
1299 scm_i_pthread_mutex_destroy (&m
->lock
);
1304 fat_mutex_print (SCM mx
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
1306 fat_mutex
*m
= SCM_MUTEX_DATA (mx
);
1307 scm_puts_unlocked ("#<mutex ", port
);
1308 scm_uintprint ((scm_t_bits
)m
, 16, port
);
1309 scm_puts_unlocked (">", port
);
1314 make_fat_mutex (int recursive
, int unchecked_unlock
, int external_unlock
)
1319 m
= scm_gc_malloc (sizeof (fat_mutex
), "mutex");
1320 scm_i_pthread_mutex_init (&m
->lock
, NULL
);
1321 m
->owner
= SCM_BOOL_F
;
1324 m
->recursive
= recursive
;
1325 m
->unchecked_unlock
= unchecked_unlock
;
1326 m
->allow_external_unlock
= external_unlock
;
1328 m
->waiting
= SCM_EOL
;
1329 SCM_NEWSMOB (mx
, scm_tc16_mutex
, (scm_t_bits
) m
);
1330 m
->waiting
= make_queue ();
1334 SCM
scm_make_mutex (void)
1336 return scm_make_mutex_with_flags (SCM_EOL
);
1339 SCM_SYMBOL (unchecked_unlock_sym
, "unchecked-unlock");
1340 SCM_SYMBOL (allow_external_unlock_sym
, "allow-external-unlock");
1341 SCM_SYMBOL (recursive_sym
, "recursive");
1343 SCM_DEFINE (scm_make_mutex_with_flags
, "make-mutex", 0, 0, 1,
1345 "Create a new mutex. ")
1346 #define FUNC_NAME s_scm_make_mutex_with_flags
1348 int unchecked_unlock
= 0, external_unlock
= 0, recursive
= 0;
1351 while (! scm_is_null (ptr
))
1353 SCM flag
= SCM_CAR (ptr
);
1354 if (scm_is_eq (flag
, unchecked_unlock_sym
))
1355 unchecked_unlock
= 1;
1356 else if (scm_is_eq (flag
, allow_external_unlock_sym
))
1357 external_unlock
= 1;
1358 else if (scm_is_eq (flag
, recursive_sym
))
1361 SCM_MISC_ERROR ("unsupported mutex option: ~a", scm_list_1 (flag
));
1362 ptr
= SCM_CDR (ptr
);
1364 return make_fat_mutex (recursive
, unchecked_unlock
, external_unlock
);
1368 SCM_DEFINE (scm_make_recursive_mutex
, "make-recursive-mutex", 0, 0, 0,
1370 "Create a new recursive mutex. ")
1371 #define FUNC_NAME s_scm_make_recursive_mutex
1373 return make_fat_mutex (1, 0, 0);
1377 SCM_SYMBOL (scm_abandoned_mutex_error_key
, "abandoned-mutex-error");
1380 fat_mutex_lock (SCM mutex
, scm_t_timespec
*timeout
, SCM owner
, int *ret
)
1382 fat_mutex
*m
= SCM_MUTEX_DATA (mutex
);
1384 SCM new_owner
= SCM_UNBNDP (owner
) ? scm_current_thread() : owner
;
1385 SCM err
= SCM_BOOL_F
;
1387 struct timeval current_time
;
1389 scm_i_scm_pthread_mutex_lock (&m
->lock
);
1395 m
->owner
= new_owner
;
1398 if (SCM_I_IS_THREAD (new_owner
))
1400 scm_i_thread
*t
= SCM_I_THREAD_DATA (new_owner
);
1402 /* FIXME: The order in which `t->admin_mutex' and
1403 `m->lock' are taken differs from that in
1404 `on_thread_exit', potentially leading to deadlocks. */
1405 scm_i_pthread_mutex_lock (&t
->admin_mutex
);
1407 /* Only keep a weak reference to MUTEX so that it's not
1408 retained when not referenced elsewhere (bug #27450).
1409 The weak pair itself is eventually removed when MUTEX
1410 is unlocked. Note that `t->mutexes' lists mutexes
1411 currently held by T, so it should be small. */
1412 t
->mutexes
= scm_cons (scm_make_weak_vector (SCM_INUM1
, mutex
),
1415 scm_i_pthread_mutex_unlock (&t
->admin_mutex
);
1420 else if (SCM_I_IS_THREAD (m
->owner
) && scm_c_thread_exited_p (m
->owner
))
1422 m
->owner
= new_owner
;
1423 err
= scm_cons (scm_abandoned_mutex_error_key
,
1424 scm_from_locale_string ("lock obtained on abandoned "
1429 else if (scm_is_eq (m
->owner
, new_owner
))
1438 err
= scm_cons (scm_misc_error_key
,
1439 scm_from_locale_string ("mutex already locked "
1447 if (timeout
!= NULL
)
1449 gettimeofday (¤t_time
, NULL
);
1450 if (current_time
.tv_sec
> timeout
->tv_sec
||
1451 (current_time
.tv_sec
== timeout
->tv_sec
&&
1452 current_time
.tv_usec
* 1000 > timeout
->tv_nsec
))
1458 block_self (m
->waiting
, mutex
, &m
->lock
, timeout
);
1459 scm_i_pthread_mutex_unlock (&m
->lock
);
1461 scm_i_scm_pthread_mutex_lock (&m
->lock
);
1464 scm_i_pthread_mutex_unlock (&m
->lock
);
1468 SCM
scm_lock_mutex (SCM mx
)
1470 return scm_lock_mutex_timed (mx
, SCM_UNDEFINED
, SCM_UNDEFINED
);
1473 SCM_DEFINE (scm_lock_mutex_timed
, "lock-mutex", 1, 2, 0,
1474 (SCM m
, SCM timeout
, SCM owner
),
1475 "Lock mutex @var{m}. If the mutex is already locked, the calling\n"
1476 "thread blocks until the mutex becomes available. The function\n"
1477 "returns when the calling thread owns the lock on @var{m}.\n"
1478 "Locking a mutex that a thread already owns will succeed right\n"
1479 "away and will not block the thread. That is, Guile's mutexes\n"
1480 "are @emph{recursive}.")
1481 #define FUNC_NAME s_scm_lock_mutex_timed
1485 scm_t_timespec cwaittime
, *waittime
= NULL
;
1487 SCM_VALIDATE_MUTEX (1, m
);
1489 if (! SCM_UNBNDP (timeout
) && ! scm_is_false (timeout
))
1491 to_timespec (timeout
, &cwaittime
);
1492 waittime
= &cwaittime
;
1495 if (!SCM_UNBNDP (owner
) && !scm_is_false (owner
))
1496 SCM_VALIDATE_THREAD (3, owner
);
1498 exception
= fat_mutex_lock (m
, waittime
, owner
, &ret
);
1499 if (!scm_is_false (exception
))
1500 scm_ithrow (SCM_CAR (exception
), scm_list_1 (SCM_CDR (exception
)), 1);
1501 return ret
? SCM_BOOL_T
: SCM_BOOL_F
;
1506 lock_mutex_return_void (SCM mx
)
1508 (void) scm_lock_mutex (mx
);
1512 unlock_mutex_return_void (SCM mx
)
1514 (void) scm_unlock_mutex (mx
);
1518 scm_dynwind_lock_mutex (SCM mutex
)
1520 scm_dynwind_unwind_handler_with_scm (unlock_mutex_return_void
, mutex
,
1521 SCM_F_WIND_EXPLICITLY
);
1522 scm_dynwind_rewind_handler_with_scm (lock_mutex_return_void
, mutex
,
1523 SCM_F_WIND_EXPLICITLY
);
1526 SCM_DEFINE (scm_try_mutex
, "try-mutex", 1, 0, 0,
1528 "Try to lock @var{mutex}. If the mutex is already locked by someone "
1529 "else, return @code{#f}. Else lock the mutex and return @code{#t}. ")
1530 #define FUNC_NAME s_scm_try_mutex
1534 scm_t_timespec cwaittime
, *waittime
= NULL
;
1536 SCM_VALIDATE_MUTEX (1, mutex
);
1538 to_timespec (scm_from_int(0), &cwaittime
);
1539 waittime
= &cwaittime
;
1541 exception
= fat_mutex_lock (mutex
, waittime
, SCM_UNDEFINED
, &ret
);
1542 if (!scm_is_false (exception
))
1543 scm_ithrow (SCM_CAR (exception
), scm_list_1 (SCM_CDR (exception
)), 1);
1544 return ret
? SCM_BOOL_T
: SCM_BOOL_F
;
1548 /*** Fat condition variables */
1551 scm_i_pthread_mutex_t lock
;
1552 SCM waiting
; /* the threads waiting for this condition. */
1555 #define SCM_CONDVARP(x) SCM_SMOB_PREDICATE (scm_tc16_condvar, x)
1556 #define SCM_CONDVAR_DATA(x) ((fat_cond *) SCM_SMOB_DATA (x))
1559 remove_mutex_from_thread (SCM mutex
, scm_i_thread
*t
)
1563 for (prev
= SCM_BOOL_F
, walk
= t
->mutexes
; scm_is_pair (walk
);
1564 walk
= SCM_CDR (walk
))
1566 if (scm_is_eq (mutex
, scm_c_weak_vector_ref (SCM_CAR (walk
), 0)))
1568 if (scm_is_pair (prev
))
1569 SCM_SETCDR (prev
, SCM_CDR (walk
));
1571 t
->mutexes
= SCM_CDR (walk
);
1578 fat_mutex_unlock (SCM mutex
, SCM cond
,
1579 const scm_t_timespec
*waittime
, int relock
)
1582 fat_mutex
*m
= SCM_MUTEX_DATA (mutex
);
1584 scm_i_thread
*t
= SCM_I_CURRENT_THREAD
;
1585 int err
= 0, ret
= 0;
1587 scm_i_scm_pthread_mutex_lock (&m
->lock
);
1591 if (!scm_is_eq (owner
, t
->handle
))
1595 if (!m
->unchecked_unlock
)
1597 scm_i_pthread_mutex_unlock (&m
->lock
);
1598 scm_misc_error (NULL
, "mutex not locked", SCM_EOL
);
1602 else if (!m
->allow_external_unlock
)
1604 scm_i_pthread_mutex_unlock (&m
->lock
);
1605 scm_misc_error (NULL
, "mutex not locked by current thread", SCM_EOL
);
1609 if (! (SCM_UNBNDP (cond
)))
1611 c
= SCM_CONDVAR_DATA (cond
);
1620 /* Change the owner of MUTEX. */
1621 remove_mutex_from_thread (mutex
, t
);
1622 m
->owner
= unblock_from_queue (m
->waiting
);
1627 err
= block_self (c
->waiting
, cond
, &m
->lock
, waittime
);
1628 scm_i_pthread_mutex_unlock (&m
->lock
);
1635 else if (err
== ETIMEDOUT
)
1640 else if (err
!= EINTR
)
1643 scm_syserror (NULL
);
1649 scm_lock_mutex_timed (mutex
, SCM_UNDEFINED
, owner
);
1657 scm_remember_upto_here_2 (cond
, mutex
);
1659 scm_i_scm_pthread_mutex_lock (&m
->lock
);
1668 /* Change the owner of MUTEX. */
1669 remove_mutex_from_thread (mutex
, t
);
1670 m
->owner
= unblock_from_queue (m
->waiting
);
1673 scm_i_pthread_mutex_unlock (&m
->lock
);
1680 SCM
scm_unlock_mutex (SCM mx
)
1682 return scm_unlock_mutex_timed (mx
, SCM_UNDEFINED
, SCM_UNDEFINED
);
1685 SCM_DEFINE (scm_unlock_mutex_timed
, "unlock-mutex", 1, 2, 0,
1686 (SCM mx
, SCM cond
, SCM timeout
),
1687 "Unlocks @var{mutex} if the calling thread owns the lock on "
1688 "@var{mutex}. Calling unlock-mutex on a mutex not owned by the current "
1689 "thread results in undefined behaviour. Once a mutex has been unlocked, "
1690 "one thread blocked on @var{mutex} is awakened and grabs the mutex "
1691 "lock. Every call to @code{lock-mutex} by this thread must be matched "
1692 "with a call to @code{unlock-mutex}. Only the last call to "
1693 "@code{unlock-mutex} will actually unlock the mutex. ")
1694 #define FUNC_NAME s_scm_unlock_mutex_timed
1696 scm_t_timespec cwaittime
, *waittime
= NULL
;
1698 SCM_VALIDATE_MUTEX (1, mx
);
1699 if (! (SCM_UNBNDP (cond
)))
1701 SCM_VALIDATE_CONDVAR (2, cond
);
1703 if (! (SCM_UNBNDP (timeout
)))
1705 to_timespec (timeout
, &cwaittime
);
1706 waittime
= &cwaittime
;
1710 return fat_mutex_unlock (mx
, cond
, waittime
, 0) ? SCM_BOOL_T
: SCM_BOOL_F
;
1714 SCM_DEFINE (scm_mutex_p
, "mutex?", 1, 0, 0,
1716 "Return @code{#t} if @var{obj} is a mutex.")
1717 #define FUNC_NAME s_scm_mutex_p
1719 return SCM_MUTEXP (obj
) ? SCM_BOOL_T
: SCM_BOOL_F
;
1723 SCM_DEFINE (scm_mutex_owner
, "mutex-owner", 1, 0, 0,
1725 "Return the thread owning @var{mx}, or @code{#f}.")
1726 #define FUNC_NAME s_scm_mutex_owner
1729 fat_mutex
*m
= NULL
;
1731 SCM_VALIDATE_MUTEX (1, mx
);
1732 m
= SCM_MUTEX_DATA (mx
);
1733 scm_i_pthread_mutex_lock (&m
->lock
);
1735 scm_i_pthread_mutex_unlock (&m
->lock
);
1741 SCM_DEFINE (scm_mutex_level
, "mutex-level", 1, 0, 0,
1743 "Return the lock level of mutex @var{mx}.")
1744 #define FUNC_NAME s_scm_mutex_level
1746 SCM_VALIDATE_MUTEX (1, mx
);
1747 return scm_from_int (SCM_MUTEX_DATA(mx
)->level
);
1751 SCM_DEFINE (scm_mutex_locked_p
, "mutex-locked?", 1, 0, 0,
1753 "Returns @code{#t} if the mutex @var{mx} is locked.")
1754 #define FUNC_NAME s_scm_mutex_locked_p
1756 SCM_VALIDATE_MUTEX (1, mx
);
1757 return SCM_MUTEX_DATA (mx
)->level
> 0 ? SCM_BOOL_T
: SCM_BOOL_F
;
1762 fat_cond_print (SCM cv
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
1764 fat_cond
*c
= SCM_CONDVAR_DATA (cv
);
1765 scm_puts_unlocked ("#<condition-variable ", port
);
1766 scm_uintprint ((scm_t_bits
)c
, 16, port
);
1767 scm_puts_unlocked (">", port
);
1771 SCM_DEFINE (scm_make_condition_variable
, "make-condition-variable", 0, 0, 0,
1773 "Make a new condition variable.")
1774 #define FUNC_NAME s_scm_make_condition_variable
1779 c
= scm_gc_malloc (sizeof (fat_cond
), "condition variable");
1780 c
->waiting
= SCM_EOL
;
1781 SCM_NEWSMOB (cv
, scm_tc16_condvar
, (scm_t_bits
) c
);
1782 c
->waiting
= make_queue ();
1787 SCM_DEFINE (scm_timed_wait_condition_variable
, "wait-condition-variable", 2, 1, 0,
1788 (SCM cv
, SCM mx
, SCM t
),
1789 "Wait until condition variable @var{cv} has been signalled. While waiting, "
1790 "mutex @var{mx} is atomically unlocked (as with @code{unlock-mutex}) and "
1791 "is locked again when this function returns. When @var{t} is given, "
1792 "it specifies a point in time where the waiting should be aborted. It "
1793 "can be either a integer as returned by @code{current-time} or a pair "
1794 "as returned by @code{gettimeofday}. When the waiting is aborted the "
1795 "mutex is locked and @code{#f} is returned. When the condition "
1796 "variable is in fact signalled, the mutex is also locked and @code{#t} "
1798 #define FUNC_NAME s_scm_timed_wait_condition_variable
1800 scm_t_timespec waittime
, *waitptr
= NULL
;
1802 SCM_VALIDATE_CONDVAR (1, cv
);
1803 SCM_VALIDATE_MUTEX (2, mx
);
1805 if (!SCM_UNBNDP (t
))
1807 to_timespec (t
, &waittime
);
1808 waitptr
= &waittime
;
1811 return fat_mutex_unlock (mx
, cv
, waitptr
, 1) ? SCM_BOOL_T
: SCM_BOOL_F
;
1816 fat_cond_signal (fat_cond
*c
)
1818 unblock_from_queue (c
->waiting
);
1821 SCM_DEFINE (scm_signal_condition_variable
, "signal-condition-variable", 1, 0, 0,
1823 "Wake up one thread that is waiting for @var{cv}")
1824 #define FUNC_NAME s_scm_signal_condition_variable
1826 SCM_VALIDATE_CONDVAR (1, cv
);
1827 fat_cond_signal (SCM_CONDVAR_DATA (cv
));
1833 fat_cond_broadcast (fat_cond
*c
)
1835 while (scm_is_true (unblock_from_queue (c
->waiting
)))
1839 SCM_DEFINE (scm_broadcast_condition_variable
, "broadcast-condition-variable", 1, 0, 0,
1841 "Wake up all threads that are waiting for @var{cv}. ")
1842 #define FUNC_NAME s_scm_broadcast_condition_variable
1844 SCM_VALIDATE_CONDVAR (1, cv
);
1845 fat_cond_broadcast (SCM_CONDVAR_DATA (cv
));
1850 SCM_DEFINE (scm_condition_variable_p
, "condition-variable?", 1, 0, 0,
1852 "Return @code{#t} if @var{obj} is a condition variable.")
1853 #define FUNC_NAME s_scm_condition_variable_p
1855 return SCM_CONDVARP(obj
) ? SCM_BOOL_T
: SCM_BOOL_F
;
1866 SELECT_TYPE
*read_fds
;
1867 SELECT_TYPE
*write_fds
;
1868 SELECT_TYPE
*except_fds
;
1869 struct timeval
*timeout
;
1876 do_std_select (void *args
)
1878 struct select_args
*select_args
;
1880 select_args
= (struct select_args
*) args
;
1882 select_args
->result
=
1883 select (select_args
->nfds
,
1884 select_args
->read_fds
, select_args
->write_fds
,
1885 select_args
->except_fds
, select_args
->timeout
);
1886 select_args
->errno_value
= errno
;
1892 scm_std_select (int nfds
,
1893 SELECT_TYPE
*readfds
,
1894 SELECT_TYPE
*writefds
,
1895 SELECT_TYPE
*exceptfds
,
1896 struct timeval
*timeout
)
1899 int res
, eno
, wakeup_fd
;
1900 scm_i_thread
*t
= SCM_I_CURRENT_THREAD
;
1901 struct select_args args
;
1903 if (readfds
== NULL
)
1905 FD_ZERO (&my_readfds
);
1906 readfds
= &my_readfds
;
1909 while (scm_i_setup_sleep (t
, SCM_BOOL_F
, NULL
, t
->sleep_pipe
[1]))
1912 wakeup_fd
= t
->sleep_pipe
[0];
1913 FD_SET (wakeup_fd
, readfds
);
1914 if (wakeup_fd
>= nfds
)
1918 args
.read_fds
= readfds
;
1919 args
.write_fds
= writefds
;
1920 args
.except_fds
= exceptfds
;
1921 args
.timeout
= timeout
;
1923 /* Explicitly cooperate with the GC. */
1924 scm_without_guile (do_std_select
, &args
);
1927 eno
= args
.errno_value
;
1930 scm_i_reset_sleep (t
);
1932 if (res
> 0 && FD_ISSET (wakeup_fd
, readfds
))
1935 full_read (wakeup_fd
, &dummy
, 1);
1937 FD_CLR (wakeup_fd
, readfds
);
1949 /* Convenience API for blocking while in guile mode. */
1951 #if SCM_USE_PTHREAD_THREADS
1953 /* It seems reasonable to not run procedures related to mutex and condition
1954 variables within `GC_do_blocking ()' since, (i) the GC can operate even
1955 without it, and (ii) the only potential gain would be GC latency. See
1956 http://thread.gmane.org/gmane.comp.programming.garbage-collection.boehmgc/2245/focus=2251
1957 for a discussion of the pros and cons. */
1960 scm_pthread_mutex_lock (scm_i_pthread_mutex_t
*mutex
)
1962 int res
= scm_i_pthread_mutex_lock (mutex
);
1967 do_unlock (void *data
)
1969 scm_i_pthread_mutex_unlock ((scm_i_pthread_mutex_t
*)data
);
1973 scm_dynwind_pthread_mutex_lock (scm_i_pthread_mutex_t
*mutex
)
1975 scm_i_scm_pthread_mutex_lock (mutex
);
1976 scm_dynwind_unwind_handler (do_unlock
, mutex
, SCM_F_WIND_EXPLICITLY
);
1980 scm_pthread_cond_wait (scm_i_pthread_cond_t
*cond
, scm_i_pthread_mutex_t
*mutex
)
1983 scm_i_thread
*t
= SCM_I_CURRENT_THREAD
;
1985 t
->held_mutex
= mutex
;
1986 res
= scm_i_pthread_cond_wait (cond
, mutex
);
1987 t
->held_mutex
= NULL
;
1993 scm_pthread_cond_timedwait (scm_i_pthread_cond_t
*cond
,
1994 scm_i_pthread_mutex_t
*mutex
,
1995 const scm_t_timespec
*wt
)
1998 scm_i_thread
*t
= SCM_I_CURRENT_THREAD
;
2000 t
->held_mutex
= mutex
;
2001 res
= scm_i_pthread_cond_timedwait (cond
, mutex
, wt
);
2002 t
->held_mutex
= NULL
;
2010 scm_std_usleep (unsigned long usecs
)
2013 tv
.tv_usec
= usecs
% 1000000;
2014 tv
.tv_sec
= usecs
/ 1000000;
2015 scm_std_select (0, NULL
, NULL
, NULL
, &tv
);
2016 return tv
.tv_sec
* 1000000 + tv
.tv_usec
;
2020 scm_std_sleep (unsigned int secs
)
2025 scm_std_select (0, NULL
, NULL
, NULL
, &tv
);
2031 SCM_DEFINE (scm_current_thread
, "current-thread", 0, 0, 0,
2033 "Return the thread that called this function.")
2034 #define FUNC_NAME s_scm_current_thread
2036 return SCM_I_CURRENT_THREAD
->handle
;
2041 scm_c_make_list (size_t n
, SCM fill
)
2045 res
= scm_cons (fill
, res
);
2049 SCM_DEFINE (scm_all_threads
, "all-threads", 0, 0, 0,
2051 "Return a list of all threads.")
2052 #define FUNC_NAME s_scm_all_threads
2054 /* We can not allocate while holding the thread_admin_mutex because
2055 of the way GC is done.
2057 int n
= thread_count
;
2059 SCM list
= scm_c_make_list (n
, SCM_UNSPECIFIED
), *l
;
2061 scm_i_pthread_mutex_lock (&thread_admin_mutex
);
2063 for (t
= all_threads
; t
&& n
> 0; t
= t
->next_thread
)
2065 if (t
!= scm_i_signal_delivery_thread
)
2067 SCM_SETCAR (*l
, t
->handle
);
2068 l
= SCM_CDRLOC (*l
);
2073 scm_i_pthread_mutex_unlock (&thread_admin_mutex
);
2078 SCM_DEFINE (scm_thread_exited_p
, "thread-exited?", 1, 0, 0,
2080 "Return @code{#t} iff @var{thread} has exited.\n")
2081 #define FUNC_NAME s_scm_thread_exited_p
2083 return scm_from_bool (scm_c_thread_exited_p (thread
));
2088 scm_c_thread_exited_p (SCM thread
)
2089 #define FUNC_NAME s_scm_thread_exited_p
2092 SCM_VALIDATE_THREAD (1, thread
);
2093 t
= SCM_I_THREAD_DATA (thread
);
2098 SCM_DEFINE (scm_total_processor_count
, "total-processor-count", 0, 0, 0,
2100 "Return the total number of processors of the machine, which\n"
2101 "is guaranteed to be at least 1. A ``processor'' here is a\n"
2102 "thread execution unit, which can be either:\n\n"
2104 "@item an execution core in a (possibly multi-core) chip, in a\n"
2105 " (possibly multi- chip) module, in a single computer, or\n"
2106 "@item a thread execution unit inside a core in the case of\n"
2107 " @dfn{hyper-threaded} CPUs.\n"
2109 "Which of the two definitions is used, is unspecified.\n")
2110 #define FUNC_NAME s_scm_total_processor_count
2112 return scm_from_ulong (num_processors (NPROC_ALL
));
2116 SCM_DEFINE (scm_current_processor_count
, "current-processor-count", 0, 0, 0,
2118 "Like @code{total-processor-count}, but return the number of\n"
2119 "processors available to the current process. See\n"
2120 "@code{setaffinity} and @code{getaffinity} for more\n"
2122 #define FUNC_NAME s_scm_current_processor_count
2124 return scm_from_ulong (num_processors (NPROC_CURRENT
));
2131 static scm_i_pthread_cond_t wake_up_cond
;
2132 static int threads_initialized_p
= 0;
2135 /* This mutex is used by SCM_CRITICAL_SECTION_START/END.
2137 scm_i_pthread_mutex_t scm_i_critical_section_mutex
;
2138 SCM_PTHREAD_ATFORK_LOCK_STATIC_MUTEX (scm_i_critical_section_mutex
);
2140 static SCM dynwind_critical_section_mutex
;
2143 scm_dynwind_critical_section (SCM mutex
)
2145 if (scm_is_false (mutex
))
2146 mutex
= dynwind_critical_section_mutex
;
2147 scm_dynwind_lock_mutex (mutex
);
2148 scm_dynwind_block_asyncs ();
2151 /*** Initialization */
2153 scm_i_pthread_mutex_t scm_i_misc_mutex
;
2154 SCM_PTHREAD_ATFORK_LOCK_STATIC_MUTEX (scm_i_misc_mutex
);
2156 #if SCM_USE_PTHREAD_THREADS
2157 pthread_mutexattr_t scm_i_pthread_mutexattr_recursive
[1];
2161 scm_threads_prehistory (void *base
)
2163 #if SCM_USE_PTHREAD_THREADS
2164 pthread_mutexattr_init (scm_i_pthread_mutexattr_recursive
);
2165 pthread_mutexattr_settype (scm_i_pthread_mutexattr_recursive
,
2166 PTHREAD_MUTEX_RECURSIVE
);
2169 scm_i_pthread_mutex_init (&scm_i_critical_section_mutex
,
2170 scm_i_pthread_mutexattr_recursive
);
2171 scm_i_pthread_mutex_init (&scm_i_misc_mutex
, NULL
);
2172 scm_i_pthread_cond_init (&wake_up_cond
, NULL
);
2174 guilify_self_1 ((struct GC_stack_base
*) base
);
2177 scm_t_bits scm_tc16_thread
;
2178 scm_t_bits scm_tc16_mutex
;
2179 scm_t_bits scm_tc16_condvar
;
2184 scm_tc16_thread
= scm_make_smob_type ("thread", sizeof (scm_i_thread
));
2185 scm_set_smob_print (scm_tc16_thread
, thread_print
);
2187 scm_tc16_mutex
= scm_make_smob_type ("mutex", sizeof (fat_mutex
));
2188 scm_set_smob_print (scm_tc16_mutex
, fat_mutex_print
);
2189 scm_set_smob_free (scm_tc16_mutex
, fat_mutex_free
);
2191 scm_tc16_condvar
= scm_make_smob_type ("condition-variable",
2193 scm_set_smob_print (scm_tc16_condvar
, fat_cond_print
);
2195 scm_i_default_dynamic_state
= SCM_BOOL_F
;
2196 guilify_self_2 (SCM_BOOL_F
);
2197 threads_initialized_p
= 1;
2199 dynwind_critical_section_mutex
= scm_make_recursive_mutex ();
2203 scm_init_threads_default_dynamic_state ()
2205 SCM state
= scm_make_dynamic_state (scm_current_dynamic_state ());
2206 scm_i_default_dynamic_state
= state
;
2210 scm_init_thread_procs ()
2212 #include "libguile/threads.x"
2216 /* IA64-specific things. */
2220 # include <sys/param.h>
2221 # include <sys/pstat.h>
2223 scm_ia64_register_backing_store_base (void)
2225 struct pst_vm_status vm_status
;
2227 while (pstat_getprocvm (&vm_status
, sizeof (vm_status
), 0, i
++) == 1)
2228 if (vm_status
.pst_type
== PS_RSESTACK
)
2229 return (void *) vm_status
.pst_vaddr
;
2233 scm_ia64_ar_bsp (const void *ctx
)
2236 __uc_get_ar_bsp (ctx
, &bsp
);
2237 return (void *) bsp
;
2241 # include <ucontext.h>
2243 scm_ia64_register_backing_store_base (void)
2245 extern void *__libc_ia64_register_backing_store_base
;
2246 return __libc_ia64_register_backing_store_base
;
2249 scm_ia64_ar_bsp (const void *opaque
)
2251 const ucontext_t
*ctx
= opaque
;
2252 return (void *) ctx
->uc_mcontext
.sc_ar_bsp
;
2256 # include <ucontext.h>
2258 scm_ia64_register_backing_store_base (void)
2260 return (void *)0x8000000000000000;
2263 scm_ia64_ar_bsp (const void *opaque
)
2265 const ucontext_t
*ctx
= opaque
;
2266 return (void *)(ctx
->uc_mcontext
.mc_special
.bspstore
2267 + ctx
->uc_mcontext
.mc_special
.ndirty
);
2269 # endif /* __FreeBSD__ */
2270 #endif /* __ia64__ */