1 /* Copyright (C) 1995,1996,1997,1998,2000,2001, 2002, 2003 Free Software Foundation, Inc.
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2, or (at your option)
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this software; see the file COPYING. If not, write to
15 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
16 * Boston, MA 02111-1307 USA
18 * As a special exception, the Free Software Foundation gives permission
19 * for additional uses of the text contained in its release of GUILE.
21 * The exception is that, if you link the GUILE library with other files
22 * to produce an executable, this does not by itself cause the
23 * resulting executable to be covered by the GNU General Public License.
24 * Your use of that executable is in no way restricted on account of
25 * linking the GUILE library code into it.
27 * This exception does not however invalidate any other reasons why
28 * the executable file might be covered by the GNU General Public License.
30 * This exception applies only to the code released by the
31 * Free Software Foundation under the name GUILE. If you copy
32 * code from other Free Software Foundation releases into a copy of
33 * GUILE, as the General Public License permits, the exception does
34 * not apply to the code that you add in this way. To avoid misleading
35 * anyone as to the status of such modified files, you must delete
36 * this exception notice from them.
38 * If you write modifications of your own for GUILE, it is your choice
39 * whether to permit this exception to apply to your modifications.
40 * If you do not wish that, delete this exception notice. */
45 /* This file implements nice Scheme level threads on top of the gastly
54 #include "libguile/_scm.h"
55 #include "libguile/validate.h"
56 #include "libguile/root.h"
57 #include "libguile/eval.h"
58 #include "libguile/async.h"
59 #include "libguile/ports.h"
60 #include "libguile/threads.h"
61 #include "libguile/dynwind.h"
62 #include "libguile/iselect.h"
69 return scm_cons (SCM_EOL
, SCM_EOL
);
73 enqueue (SCM q
, SCM t
)
75 SCM c
= scm_cons (t
, SCM_EOL
);
76 if (SCM_NULLP (SCM_CDR (q
)))
79 SCM_SETCDR (SCM_CAR (q
), c
);
85 remqueue (SCM q
, SCM c
)
88 for (p
= SCM_CDR (q
); !SCM_NULLP (p
); p
= SCM_CDR (p
))
92 if (SCM_EQ_P (c
, SCM_CAR (q
)))
93 SCM_SETCAR (q
, SCM_CDR (c
));
94 SCM_SETCDR (prev
, SCM_CDR (c
));
110 SCM_SETCDR (q
, SCM_CDR (c
));
111 if (SCM_NULLP (SCM_CDR (q
)))
112 SCM_SETCAR (q
, SCM_EOL
);
119 #define THREAD_INITIALIZED_P(t) (t->base != NULL)
125 scm_t_cond sleep_cond
;
126 struct scm_thread
*next_waiting
;
128 /* This mutex represents this threads right to access the heap.
129 That right can temporarily be taken away by the GC. */
130 scm_t_mutex heap_mutex
;
131 int clear_freelists_p
; /* set if GC was done while thread was asleep */
133 scm_root_state
*root
;
139 /* For keeping track of the stack and registers. */
147 make_thread (SCM creation_protects
)
151 z
= scm_make_smob (scm_tc16_thread
);
152 t
= SCM_THREAD_DATA (z
);
154 t
->result
= creation_protects
;
156 scm_i_plugin_cond_init (&t
->sleep_cond
, 0);
157 scm_i_plugin_mutex_init (&t
->heap_mutex
, &scm_i_plugin_mutex
);
158 t
->clear_freelists_p
= 0;
164 init_thread_creatant (SCM thread
,
167 scm_thread
*t
= SCM_THREAD_DATA (thread
);
168 t
->thread
= scm_thread_self ();
174 thread_mark (SCM obj
)
176 scm_thread
*t
= SCM_THREAD_DATA (obj
);
177 scm_gc_mark (t
->result
);
178 return t
->root
->handle
; /* mark root-state of this thread */
182 thread_print (SCM exp
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
184 scm_thread
*t
= SCM_THREAD_DATA (exp
);
185 scm_puts ("#<thread ", port
);
186 scm_intprint ((unsigned long)t
->thread
, 10, port
);
187 scm_puts (" (", port
);
188 scm_intprint ((unsigned long)t
, 16, port
);
189 scm_puts (")>", port
);
194 thread_free (SCM obj
)
196 scm_thread
*t
= SCM_THREAD_DATA (obj
);
199 scm_gc_free (t
, sizeof (*t
), "thread");
205 #define cur_thread (SCM_CURRENT_THREAD->handle)
206 scm_t_key scm_i_thread_key
;
207 scm_t_key scm_i_root_state_key
;
210 scm_i_set_thread_data (void *data
)
212 scm_thread
*t
= SCM_CURRENT_THREAD
;
213 scm_setspecific (scm_i_root_state_key
, data
);
214 t
->root
= (scm_root_state
*)data
;
218 resume (scm_thread
*t
)
221 if (t
->clear_freelists_p
)
223 *SCM_FREELIST_LOC (scm_i_freelist
) = SCM_EOL
;
224 *SCM_FREELIST_LOC (scm_i_freelist2
) = SCM_EOL
;
225 t
->clear_freelists_p
= 0;
230 scm_i_enter_guile (scm_thread
*t
)
232 scm_i_plugin_mutex_lock (&t
->heap_mutex
);
239 scm_thread
*c
= SCM_CURRENT_THREAD
;
241 /* record top of stack for the GC */
242 c
->top
= (SCM_STACKITEM
*)&c
;
243 /* save registers. */
244 SCM_FLUSH_REGISTER_WINDOWS
;
253 scm_thread
*t
= suspend ();
254 scm_i_plugin_mutex_unlock (&t
->heap_mutex
);
258 /* Put the current thread to sleep until it is explicitely unblocked.
264 scm_thread
*t
= suspend ();
265 err
= scm_i_plugin_cond_wait (&t
->sleep_cond
, &t
->heap_mutex
);
270 /* Put the current thread to sleep until it is explicitely unblocked
271 or until a signal arrives or until time AT (absolute time) is
272 reached. Return 0 when it has been unblocked; errno otherwise.
275 timed_block (const struct timespec
*at
)
278 scm_thread
*t
= suspend ();
279 err
= scm_i_plugin_cond_timedwait (&t
->sleep_cond
, &t
->heap_mutex
, at
);
284 /* Unblock a sleeping thread.
287 unblock (scm_thread
*t
)
289 scm_i_plugin_cond_signal (&t
->sleep_cond
);
292 /*** Thread creation */
294 static scm_t_mutex thread_admin_mutex
;
295 static SCM all_threads
;
296 static int thread_count
;
298 typedef struct launch_data
{
301 scm_t_catch_body body
;
303 scm_t_catch_handler handler
;
308 body_bootstrip (launch_data
* data
)
310 /* First save the new root continuation */
311 data
->rootcont
= scm_root
->rootcont
;
312 return (data
->body
) (data
->body_data
);
316 handler_bootstrip (launch_data
* data
, SCM tag
, SCM throw_args
)
318 scm_root
->rootcont
= data
->rootcont
;
319 return (data
->handler
) (data
->handler_data
, tag
, throw_args
);
323 really_launch (SCM_STACKITEM
*base
, launch_data
*data
)
327 thread
= data
->thread
;
328 t
= SCM_THREAD_DATA (thread
);
329 SCM_FREELIST_CREATE (scm_i_freelist
);
330 SCM_FREELIST_CREATE (scm_i_freelist2
);
331 scm_setspecific (scm_i_thread_key
, t
);
332 scm_setspecific (scm_i_root_state_key
, t
->root
);
333 scm_i_plugin_mutex_lock (&t
->heap_mutex
); /* ensure that we "own" the heap */
334 init_thread_creatant (thread
, base
); /* must own the heap */
336 data
->rootcont
= SCM_BOOL_F
;
338 scm_internal_cwdr ((scm_t_catch_body
) body_bootstrip
,
340 (scm_t_catch_handler
) handler_bootstrip
,
342 scm_i_leave_guile (); /* release the heap */
345 scm_i_plugin_mutex_lock (&thread_admin_mutex
);
346 all_threads
= scm_delq_x (thread
, all_threads
);
349 /* detach before unlocking in order to not become joined when detached */
350 scm_thread_detach (t
->thread
);
351 scm_i_plugin_mutex_unlock (&thread_admin_mutex
);
355 launch_thread (void *p
)
357 really_launch ((SCM_STACKITEM
*)&p
, (launch_data
*)p
);
362 create_thread (scm_t_catch_body body
, void *body_data
,
363 scm_t_catch_handler handler
, void *handler_data
,
368 /* Make new thread. The first thing the new thread will do is to
369 lock guile_mutex. Thus, we can safely complete its
370 initialization after creating it. While the new thread starts,
371 all its data is protected via all_threads.
381 /* Allocate thread locals. */
382 root
= scm_make_root (scm_root
->handle
);
383 data
= scm_malloc (sizeof (launch_data
));
386 thread
= make_thread (protects
);
387 data
->thread
= thread
;
389 data
->body_data
= body_data
;
390 data
->handler
= handler
;
391 data
->handler_data
= handler_data
;
392 t
= SCM_THREAD_DATA (thread
);
393 /* must initialize root state pointer before the thread is linked
395 t
->root
= SCM_ROOT_STATE (root
);
396 /* disconnect from parent, to prevent remembering dead threads */
397 t
->root
->parent
= SCM_BOOL_F
;
398 /* start with an empty dynwind chain */
399 t
->root
->dynwinds
= SCM_EOL
;
401 /* In order to avoid the need of synchronization between parent
402 and child thread, we need to insert the child into all_threads
405 SCM new_threads
= scm_cons (thread
, SCM_BOOL_F
); /* could cause GC */
406 scm_thread
*parent
= scm_i_leave_guile (); /* to prevent deadlock */
407 scm_i_plugin_mutex_lock (&thread_admin_mutex
);
408 SCM_SETCDR (new_threads
, all_threads
);
409 all_threads
= new_threads
;
411 scm_i_plugin_mutex_unlock (&thread_admin_mutex
);
413 scm_remember_upto_here_1 (root
);
415 scm_i_enter_guile (parent
);
418 err
= scm_i_plugin_thread_create (&th
, 0, launch_thread
, (void *) data
);
421 scm_i_plugin_mutex_lock (&thread_admin_mutex
);
422 all_threads
= scm_delq_x (thread
, all_threads
);
423 ((scm_thread
*) SCM_THREAD_DATA(thread
))->exited
= 1;
425 scm_i_plugin_mutex_unlock (&thread_admin_mutex
);
431 scm_syserror ("create-thread");
438 SCM_DEFINE (scm_call_with_new_thread
, "call-with-new-thread", 2, 0, 0,
439 (SCM thunk
, SCM handler
),
440 "Evaluate @var{(thunk)} in a new thread, and new dynamic context, "
441 "returning a new thread object representing the thread. "
442 "If an error occurs during evaluation, call error-thunk, passing it an "
443 "error code describing the condition. "
444 "If this happens, the error-thunk is called outside the scope of the new "
445 "root -- it is called in the same dynamic context in which "
446 "with-new-thread was evaluated, but not in the callers thread. "
447 "All the evaluation rules for dynamic roots apply to threads.")
448 #define FUNC_NAME s_scm_call_with_new_thread
450 SCM_ASSERT (SCM_NFALSEP (scm_thunk_p (thunk
)), thunk
, SCM_ARG1
, FUNC_NAME
);
451 SCM_ASSERT (SCM_NFALSEP (scm_procedure_p (handler
)), handler
, SCM_ARG2
,
454 return create_thread ((scm_t_catch_body
) scm_call_0
, thunk
,
455 (scm_t_catch_handler
) scm_apply_1
, handler
,
456 scm_cons (thunk
, handler
));
460 SCM_DEFINE (scm_yield
, "yield", 0, 0, 0,
462 "Move the calling thread to the end of the scheduling queue.")
463 #define FUNC_NAME s_scm_yield
465 return SCM_BOOL (scm_thread_yield
);
469 SCM_DEFINE (scm_join_thread
, "join-thread", 1, 0, 0,
471 "Suspend execution of the calling thread until the target @var{thread} "
472 "terminates, unless the target @var{thread} has already terminated. ")
473 #define FUNC_NAME s_scm_join_thread
478 SCM_VALIDATE_THREAD (1, thread
);
479 if (SCM_EQ_P (cur_thread
, thread
))
480 SCM_MISC_ERROR ("can not join the current thread", SCM_EOL
);
482 t
= SCM_THREAD_DATA (thread
);
486 c
= scm_i_leave_guile ();
487 while (!THREAD_INITIALIZED_P (t
))
488 scm_i_plugin_thread_yield ();
489 scm_thread_join (t
->thread
, 0);
490 scm_i_enter_guile (c
);
493 t
->result
= SCM_BOOL_F
;
500 /* We implement our own mutex type since we want them to be 'fair', we
501 want to do fancy things while waiting for them (like running
502 asyncs) and we want to support waiting on many things at once.
503 Also, we might add things that are nice for debugging.
506 typedef struct fair_mutex
{
507 /* the thread currently owning the mutex, or SCM_BOOL_F. */
511 /* how much the owner owns us. */
513 /* the threads waiting for this mutex. */
518 fair_mutex_mark (SCM mx
)
520 fair_mutex
*m
= SCM_MUTEX_DATA (mx
);
521 scm_gc_mark (m
->owner
);
525 SCM_DEFINE (scm_make_fair_mutex
, "make-fair-mutex", 0, 0, 0,
527 "Create a new fair mutex object. ")
528 #define FUNC_NAME s_scm_make_fair_mutex
530 SCM mx
= scm_make_smob (scm_tc16_fair_mutex
);
531 fair_mutex
*m
= SCM_MUTEX_DATA (mx
);
532 scm_i_plugin_mutex_init (&m
->lock
, &scm_i_plugin_mutex
);
534 m
->owner
= SCM_BOOL_F
;
536 m
->waiting
= make_queue ();
542 fair_mutex_lock (fair_mutex
*m
)
544 scm_i_plugin_mutex_lock (&m
->lock
);
546 /* Need to wait if another thread is just temporarily unlocking.
547 This is happens very seldom and only when the other thread is
548 between scm_mutex_unlock and scm_i_plugin_mutex_lock below. */
554 if (m
->owner
== SCM_BOOL_F
)
555 m
->owner
= cur_thread
;
556 else if (m
->owner
== cur_thread
)
562 SCM c
= enqueue (m
->waiting
, cur_thread
);
564 /* Note: It's important that m->lock is never locked for
565 any longer amount of time since that could prevent GC */
566 scm_i_plugin_mutex_unlock (&m
->lock
);
568 if (m
->owner
== cur_thread
)
570 scm_i_plugin_mutex_lock (&m
->lock
);
571 remqueue (m
->waiting
, c
);
572 scm_i_plugin_mutex_unlock (&m
->lock
);
576 scm_i_plugin_mutex_lock (&m
->lock
);
579 scm_i_plugin_mutex_unlock (&m
->lock
);
584 fair_mutex_trylock (fair_mutex
*m
)
586 scm_i_plugin_mutex_lock (&m
->lock
);
587 if (m
->owner
== SCM_BOOL_F
)
588 m
->owner
= cur_thread
;
589 else if (m
->owner
== cur_thread
)
593 scm_i_plugin_mutex_unlock (&m
->lock
);
596 scm_i_plugin_mutex_unlock (&m
->lock
);
601 fair_mutex_unlock (fair_mutex
*m
)
603 scm_i_plugin_mutex_lock (&m
->lock
);
604 if (m
->owner
!= cur_thread
)
606 scm_i_plugin_mutex_unlock (&m
->lock
);
609 else if (m
->level
> 0)
613 SCM next
= dequeue (m
->waiting
);
614 if (!SCM_FALSEP (next
))
617 unblock (SCM_THREAD_DATA (next
));
620 m
->owner
= SCM_BOOL_F
;
622 scm_i_plugin_mutex_unlock (&m
->lock
);
626 /*** Fair condition variables */
628 /* Like mutexes, we implement our own condition variables using the
632 typedef struct fair_cond
{
634 /* the threads waiting for this condition. */
639 fair_cond_mark (SCM cv
)
641 fair_cond
*c
= SCM_CONDVAR_DATA (cv
);
645 SCM_DEFINE (scm_make_fair_condition_variable
, "make-fair-condition-variable", 0, 0, 0,
647 "Make a new fair condition variable.")
648 #define FUNC_NAME s_scm_make_fair_condition_variable
650 SCM cv
= scm_make_smob (scm_tc16_fair_condvar
);
651 fair_cond
*c
= SCM_CONDVAR_DATA (cv
);
652 scm_i_plugin_mutex_init (&c
->lock
, 0);
653 c
->waiting
= make_queue ();
659 fair_cond_timedwait (fair_cond
*c
,
661 const struct timespec
*waittime
)
664 scm_i_plugin_mutex_lock (&c
->lock
);
668 enqueue (c
->waiting
, cur_thread
);
669 scm_i_plugin_mutex_unlock (&c
->lock
);
670 fair_mutex_unlock (m
); /*fixme* - not thread safe */
671 if (waittime
== NULL
)
674 err
= timed_block (waittime
);
678 /* XXX - check whether we have been signalled. */
685 fair_cond_signal (fair_cond
*c
)
688 scm_i_plugin_mutex_lock (&c
->lock
);
689 if (!SCM_FALSEP (th
= dequeue (c
->waiting
)))
690 unblock (SCM_THREAD_DATA (th
));
691 scm_i_plugin_mutex_unlock (&c
->lock
);
696 fair_cond_broadcast (fair_cond
*c
)
699 scm_i_plugin_mutex_lock (&c
->lock
);
700 while (!SCM_FALSEP (th
= dequeue (c
->waiting
)))
701 unblock (SCM_THREAD_DATA (th
));
702 scm_i_plugin_mutex_unlock (&c
->lock
);
708 SCM_DEFINE (scm_make_mutex
, "make-mutex", 0, 0, 0,
710 "Create a new mutex object. ")
711 #define FUNC_NAME s_scm_make_mutex
713 SCM mx
= scm_make_smob (scm_tc16_mutex
);
714 scm_i_plugin_mutex_init (SCM_MUTEX_DATA (mx
), &scm_i_plugin_mutex
);
719 /*fixme* change documentation */
720 SCM_DEFINE (scm_lock_mutex
, "lock-mutex", 1, 0, 0,
722 "Lock @var{mutex}. If the mutex is already locked, the calling thread "
723 "blocks until the mutex becomes available. The function returns when "
724 "the calling thread owns the lock on @var{mutex}. Locking a mutex that "
725 "a thread already owns will succeed right away and will not block the "
726 "thread. That is, Guile's mutexes are @emph{recursive}. ")
727 #define FUNC_NAME s_scm_lock_mutex
730 SCM_VALIDATE_MUTEX (1, mx
);
732 if (SCM_TYP16 (mx
) == scm_tc16_fair_mutex
)
733 err
= fair_mutex_lock (SCM_MUTEX_DATA (mx
));
736 scm_t_mutex
*m
= SCM_MUTEX_DATA (mx
);
737 err
= scm_mutex_lock (m
);
749 SCM_DEFINE (scm_try_mutex
, "try-mutex", 1, 0, 0,
751 "Try to lock @var{mutex}. If the mutex is already locked by someone "
752 "else, return @code{#f}. Else lock the mutex and return @code{#t}. ")
753 #define FUNC_NAME s_scm_try_mutex
756 SCM_VALIDATE_MUTEX (1, mx
);
758 if (SCM_TYP16 (mx
) == scm_tc16_fair_mutex
)
759 err
= fair_mutex_trylock (SCM_MUTEX_DATA (mx
));
762 scm_t_mutex
*m
= SCM_MUTEX_DATA (mx
);
763 err
= scm_mutex_trylock (m
);
779 SCM_DEFINE (scm_unlock_mutex
, "unlock-mutex", 1, 0, 0,
781 "Unlocks @var{mutex} if the calling thread owns the lock on "
782 "@var{mutex}. Calling unlock-mutex on a mutex not owned by the current "
783 "thread results in undefined behaviour. Once a mutex has been unlocked, "
784 "one thread blocked on @var{mutex} is awakened and grabs the mutex "
785 "lock. Every call to @code{lock-mutex} by this thread must be matched "
786 "with a call to @code{unlock-mutex}. Only the last call to "
787 "@code{unlock-mutex} will actually unlock the mutex. ")
788 #define FUNC_NAME s_scm_unlock_mutex
791 SCM_VALIDATE_MUTEX (1, mx
);
793 if (SCM_TYP16 (mx
) == scm_tc16_fair_mutex
)
795 err
= fair_mutex_unlock (SCM_MUTEX_DATA (mx
));
798 fair_mutex
*m
= SCM_MUTEX_DATA (mx
);
799 if (m
->owner
!= cur_thread
)
801 if (m
->owner
== SCM_BOOL_F
)
802 SCM_MISC_ERROR ("mutex not locked", SCM_EOL
);
804 SCM_MISC_ERROR ("mutex not locked by this thread", SCM_EOL
);
810 scm_t_mutex
*m
= SCM_MUTEX_DATA (mx
);
811 err
= scm_mutex_unlock (m
);
823 /*** Condition variables */
825 SCM_DEFINE (scm_make_condition_variable
, "make-condition-variable", 0, 0, 0,
827 "Make a new condition variable.")
828 #define FUNC_NAME s_scm_make_condition_variable
830 SCM cv
= scm_make_smob (scm_tc16_condvar
);
831 scm_i_plugin_cond_init (SCM_CONDVAR_DATA (cv
), 0);
836 SCM_DEFINE (scm_timed_wait_condition_variable
, "wait-condition-variable", 2, 1, 0,
837 (SCM cv
, SCM mx
, SCM t
),
838 "Wait until @var{cond-var} has been signalled. While waiting, "
839 "@var{mutex} is atomically unlocked (as with @code{unlock-mutex}) and "
840 "is locked again when this function returns. When @var{time} is given, "
841 "it specifies a point in time where the waiting should be aborted. It "
842 "can be either a integer as returned by @code{current-time} or a pair "
843 "as returned by @code{gettimeofday}. When the waiting is aborted the "
844 "mutex is locked and @code{#f} is returned. When the condition "
845 "variable is in fact signalled, the mutex is also locked and @code{#t} "
847 #define FUNC_NAME s_scm_timed_wait_condition_variable
849 struct timespec waittime
;
852 SCM_VALIDATE_CONDVAR (1, cv
);
853 SCM_VALIDATE_MUTEX (2, mx
);
854 if (!((SCM_TYP16 (cv
) == scm_tc16_condvar
855 && SCM_TYP16 (mx
) == scm_tc16_mutex
)
856 || (SCM_TYP16 (cv
) == scm_tc16_fair_condvar
857 && SCM_TYP16 (mx
) == scm_tc16_fair_mutex
)))
858 SCM_MISC_ERROR ("Condition variable and mutex are of different kinds.",
865 SCM_VALIDATE_UINT_COPY (3, SCM_CAR (t
), waittime
.tv_sec
);
866 SCM_VALIDATE_UINT_COPY (3, SCM_CDR (t
), waittime
.tv_nsec
);
867 waittime
.tv_nsec
*= 1000;
871 SCM_VALIDATE_UINT_COPY (3, t
, waittime
.tv_sec
);
872 waittime
.tv_nsec
= 0;
876 if (SCM_TYP16 (cv
) == scm_tc16_fair_condvar
)
877 err
= fair_cond_timedwait (SCM_CONDVAR_DATA (cv
),
879 SCM_UNBNDP (t
) ? NULL
: &waittime
);
882 scm_t_cond
*c
= SCM_CONDVAR_DATA (cv
);
883 scm_t_mutex
*m
= SCM_MUTEX_DATA (mx
);
885 err
= scm_cond_wait (c
, m
);
887 err
= scm_cond_timedwait (c
, m
, &waittime
);
892 if (err
== ETIMEDOUT
)
901 SCM_DEFINE (scm_signal_condition_variable
, "signal-condition-variable", 1, 0, 0,
903 "Wake up one thread that is waiting for @var{cv}")
904 #define FUNC_NAME s_scm_signal_condition_variable
906 SCM_VALIDATE_CONDVAR (1, cv
);
907 if (SCM_TYP16 (cv
) == scm_tc16_fair_condvar
)
908 fair_cond_signal (SCM_CONDVAR_DATA (cv
));
911 scm_t_cond
*c
= SCM_CONDVAR_DATA (cv
);
918 SCM_DEFINE (scm_broadcast_condition_variable
, "broadcast-condition-variable", 1, 0, 0,
920 "Wake up all threads that are waiting for @var{cv}. ")
921 #define FUNC_NAME s_scm_broadcast_condition_variable
923 SCM_VALIDATE_CONDVAR (1, cv
);
924 if (SCM_TYP16 (cv
) == scm_tc16_fair_condvar
)
925 fair_cond_broadcast (SCM_CONDVAR_DATA (cv
));
928 scm_t_cond
*c
= SCM_CONDVAR_DATA (cv
);
929 scm_cond_broadcast (c
);
935 /*** Marking stacks */
937 /* XXX - what to do with this? Do we need to handle this for blocked
941 # define SCM_MARK_BACKING_STORE() do { \
943 SCM_STACKITEM * top, * bot; \
945 scm_mark_locations ((SCM_STACKITEM *) &ctx.uc_mcontext, \
946 ((size_t) (sizeof (SCM_STACKITEM) - 1 + sizeof ctx.uc_mcontext) \
947 / sizeof (SCM_STACKITEM))); \
948 bot = (SCM_STACKITEM *) __libc_ia64_register_backing_store_base; \
949 top = (SCM_STACKITEM *) ctx.uc_mcontext.sc_ar_bsp; \
950 scm_mark_locations (bot, top - bot); } while (0)
952 # define SCM_MARK_BACKING_STORE()
956 scm_threads_mark_stacks (void)
959 for (c
= all_threads
; !SCM_NULLP (c
); c
= SCM_CDR (c
))
961 scm_thread
*t
= SCM_THREAD_DATA (SCM_CAR (c
));
962 if (!THREAD_INITIALIZED_P (t
))
964 /* Not fully initialized yet. */
971 if (t
->thread
!= scm_thread_self ())
975 /* stack_len is long rather than sizet in order to guarantee
976 that &stack_len is long aligned */
977 #ifdef STACK_GROWS_UP
978 stack_len
= ((SCM_STACKITEM
*) (&t
) -
979 (SCM_STACKITEM
*) thread
->base
);
981 /* Protect from the C stack. This must be the first marking
982 * done because it provides information about what objects
983 * are "in-use" by the C code. "in-use" objects are those
984 * for which the information about length and base address must
985 * remain usable. This requirement is stricter than a liveness
986 * requirement -- in particular, it constrains the implementation
989 SCM_FLUSH_REGISTER_WINDOWS
;
990 /* This assumes that all registers are saved into the jmp_buf */
991 setjmp (scm_save_regs_gc_mark
);
992 scm_mark_locations ((SCM_STACKITEM
*) scm_save_regs_gc_mark
,
993 ((size_t) sizeof scm_save_regs_gc_mark
994 / sizeof (SCM_STACKITEM
)));
996 scm_mark_locations (((size_t) t
->base
,
999 stack_len
= ((SCM_STACKITEM
*) t
->base
-
1000 (SCM_STACKITEM
*) (&t
));
1002 /* Protect from the C stack. This must be the first marking
1003 * done because it provides information about what objects
1004 * are "in-use" by the C code. "in-use" objects are those
1005 * for which the information about length and base address must
1006 * remain usable. This requirement is stricter than a liveness
1007 * requirement -- in particular, it constrains the implementation
1010 SCM_FLUSH_REGISTER_WINDOWS
;
1011 /* This assumes that all registers are saved into the jmp_buf */
1012 setjmp (scm_save_regs_gc_mark
);
1013 scm_mark_locations ((SCM_STACKITEM
*) scm_save_regs_gc_mark
,
1014 ((size_t) sizeof scm_save_regs_gc_mark
1015 / sizeof (SCM_STACKITEM
)));
1017 scm_mark_locations ((SCM_STACKITEM
*) &t
,
1023 /* Suspended thread */
1024 #ifdef STACK_GROWS_UP
1025 long stack_len
= t
->top
- t
->base
;
1026 scm_mark_locations (t
->base
, stack_len
);
1028 long stack_len
= t
->base
- t
->top
;
1029 scm_mark_locations (t
->top
, stack_len
);
1031 scm_mark_locations ((SCM_STACKITEM
*) t
->regs
,
1032 ((size_t) sizeof(t
->regs
)
1033 / sizeof (SCM_STACKITEM
)));
1041 scm_internal_select (int nfds
,
1042 SELECT_TYPE
*readfds
,
1043 SELECT_TYPE
*writefds
,
1044 SELECT_TYPE
*exceptfds
,
1045 struct timeval
*timeout
)
1048 scm_thread
*c
= scm_i_leave_guile ();
1049 res
= scm_i_plugin_select (nfds
, readfds
, writefds
, exceptfds
, timeout
);
1051 scm_i_enter_guile (c
);
1057 /* Low-level C API */
1060 scm_spawn_thread (scm_t_catch_body body
, void *body_data
,
1061 scm_t_catch_handler handler
, void *handler_data
)
1063 return create_thread (body
, body_data
, handler
, handler_data
, SCM_BOOL_F
);
1067 scm_mutex_lock (scm_t_mutex
*m
)
1069 scm_thread
*t
= scm_i_leave_guile ();
1070 int res
= scm_i_plugin_mutex_lock (m
);
1071 scm_i_enter_guile (t
);
1076 scm_make_rec_mutex ()
1078 scm_t_rec_mutex
*m
= scm_malloc (sizeof (scm_t_rec_mutex
));
1079 scm_i_plugin_rec_mutex_init (m
, &scm_i_plugin_rec_mutex
);
1084 scm_rec_mutex_free (scm_t_rec_mutex
*m
)
1086 scm_i_plugin_rec_mutex_destroy (m
);
1091 scm_rec_mutex_lock (scm_t_rec_mutex
*m
)
1093 scm_thread
*t
= scm_i_leave_guile ();
1094 int res
= scm_i_plugin_rec_mutex_lock (m
);
1095 scm_i_enter_guile (t
);
1100 scm_cond_wait (scm_t_cond
*c
, scm_t_mutex
*m
)
1102 scm_thread
*t
= scm_i_leave_guile ();
1103 scm_i_plugin_cond_wait (c
, m
);
1104 scm_i_enter_guile (t
);
1109 scm_cond_timedwait (scm_t_cond
*c
, scm_t_mutex
*m
, const struct timespec
*wt
)
1111 scm_thread
*t
= scm_i_leave_guile ();
1112 int res
= scm_i_plugin_cond_timedwait (c
, m
, wt
);
1113 scm_i_enter_guile (t
);
1120 scm_i_enter_guile (SCM_CURRENT_THREAD
);
1126 scm_i_leave_guile ();
1130 scm_thread_usleep (unsigned long usecs
)
1133 tv
.tv_usec
= usecs
% 1000000;
1134 tv
.tv_sec
= usecs
/ 1000000;
1135 scm_internal_select (0, NULL
, NULL
, NULL
, &tv
);
1136 return tv
.tv_usec
+ tv
.tv_sec
*1000000;
1140 scm_thread_sleep (unsigned long secs
)
1145 scm_internal_select (0, NULL
, NULL
, NULL
, &tv
);
1151 SCM_DEFINE (scm_current_thread
, "current-thread", 0, 0, 0,
1153 "Return the thread that called this function.")
1154 #define FUNC_NAME s_scm_current_thread
1160 SCM_DEFINE (scm_all_threads
, "all-threads", 0, 0, 0,
1162 "Return a list of all threads.")
1163 #define FUNC_NAME s_scm_all_threads
1165 return scm_list_copy (all_threads
);
1170 scm_i_thread_root (SCM thread
)
1172 return ((scm_thread
*) SCM_THREAD_DATA (thread
))->root
;
1175 SCM_DEFINE (scm_thread_exited_p
, "thread-exited?", 1, 0, 0,
1177 "Return @code{#t} iff @var{thread} has exited.\n")
1178 #define FUNC_NAME s_scm_thread_exited_p
1180 return SCM_BOOL (scm_c_thread_exited_p (thread
));
1185 scm_c_thread_exited_p (SCM thread
)
1186 #define FUNC_NAME s_scm_thread_exited_p
1189 SCM_VALIDATE_THREAD (1, thread
);
1190 t
= SCM_THREAD_DATA (thread
);
1195 static scm_t_cond wake_up_cond
;
1196 int scm_i_thread_go_to_sleep
;
1197 static int gc_section_count
= 0;
1198 static int threads_initialized_p
= 0;
1201 scm_i_thread_put_to_sleep ()
1203 if (threads_initialized_p
&& !gc_section_count
++)
1206 scm_i_plugin_mutex_lock (&thread_admin_mutex
);
1207 threads
= all_threads
;
1208 /* Signal all threads to go to sleep */
1209 scm_i_thread_go_to_sleep
= 1;
1210 for (; !SCM_NULLP (threads
); threads
= SCM_CDR (threads
))
1211 if (SCM_CAR (threads
) != cur_thread
)
1213 scm_thread
*t
= SCM_THREAD_DATA (SCM_CAR (threads
));
1214 scm_i_plugin_mutex_lock (&t
->heap_mutex
);
1216 scm_i_thread_go_to_sleep
= 0;
1221 scm_i_thread_invalidate_freelists ()
1223 /* Don't need to lock thread_admin_mutex here since we are single threaded */
1224 SCM threads
= all_threads
;
1225 for (; !SCM_NULLP (threads
); threads
= SCM_CDR (threads
))
1226 if (SCM_CAR (threads
) != cur_thread
)
1228 scm_thread
*t
= SCM_THREAD_DATA (SCM_CAR (threads
));
1229 t
->clear_freelists_p
= 1;
1234 scm_i_thread_wake_up ()
1236 if (threads_initialized_p
&& !--gc_section_count
)
1239 threads
= all_threads
;
1240 scm_i_plugin_cond_broadcast (&wake_up_cond
);
1241 for (; !SCM_NULLP (threads
); threads
= SCM_CDR (threads
))
1242 if (SCM_CAR (threads
) != cur_thread
)
1244 scm_thread
*t
= SCM_THREAD_DATA (SCM_CAR (threads
));
1245 scm_i_plugin_mutex_unlock (&t
->heap_mutex
);
1247 scm_i_plugin_mutex_unlock (&thread_admin_mutex
);
1252 scm_i_thread_sleep_for_gc ()
1256 scm_i_plugin_cond_wait (&wake_up_cond
, &t
->heap_mutex
);
1260 scm_t_mutex scm_i_critical_section_mutex
;
1261 scm_t_rec_mutex scm_i_defer_mutex
;
1263 #ifdef USE_PTHREAD_THREADS
1264 #include "libguile/pthread-threads.c"
1266 #include "libguile/threads-plugin.c"
1268 /*** Initialization */
1271 scm_threads_prehistory ()
1274 #ifdef USE_PTHREAD_THREADS
1275 /* Must be called before any initialization of a mutex. */
1276 scm_init_pthread_threads ();
1278 scm_i_plugin_mutex_init (&thread_admin_mutex
, &scm_i_plugin_mutex
);
1279 scm_i_plugin_cond_init (&wake_up_cond
, 0);
1280 scm_i_plugin_mutex_init (&scm_i_critical_section_mutex
, &scm_i_plugin_mutex
);
1282 scm_i_plugin_key_create (&scm_i_thread_key
, 0);
1283 scm_i_plugin_key_create (&scm_i_root_state_key
, 0);
1284 scm_i_plugin_rec_mutex_init (&scm_i_defer_mutex
, &scm_i_plugin_rec_mutex
);
1285 /* Allocate a fake thread object to be used during bootup. */
1286 t
= malloc (sizeof (scm_thread
));
1288 t
->clear_freelists_p
= 0;
1289 scm_i_plugin_mutex_init (&t
->heap_mutex
, &scm_i_plugin_mutex
);
1290 scm_setspecific (scm_i_thread_key
, t
);
1291 scm_i_enter_guile (t
);
1294 scm_t_bits scm_tc16_thread
;
1295 scm_t_bits scm_tc16_future
;
1296 scm_t_bits scm_tc16_mutex
;
1297 scm_t_bits scm_tc16_fair_mutex
;
1298 scm_t_bits scm_tc16_condvar
;
1299 scm_t_bits scm_tc16_fair_condvar
;
1302 scm_init_threads (SCM_STACKITEM
*base
)
1305 scm_tc16_thread
= scm_make_smob_type ("thread", sizeof (scm_thread
));
1306 scm_tc16_mutex
= scm_make_smob_type ("mutex", sizeof (scm_t_mutex
));
1307 scm_tc16_fair_mutex
= scm_make_smob_type ("fair-mutex",
1308 sizeof (fair_mutex
));
1309 scm_tc16_condvar
= scm_make_smob_type ("condition-variable",
1310 sizeof (scm_t_cond
));
1311 scm_tc16_fair_condvar
= scm_make_smob_type ("fair-condition-variable",
1312 sizeof (fair_cond
));
1314 thread
= make_thread (SCM_BOOL_F
);
1315 /* Replace initial fake thread with a real thread object */
1316 free (SCM_CURRENT_THREAD
);
1317 scm_setspecific (scm_i_thread_key
, SCM_THREAD_DATA (thread
));
1318 scm_i_enter_guile (SCM_CURRENT_THREAD
);
1320 /* root is set later from init.c */
1321 init_thread_creatant (thread
, base
);
1323 scm_gc_register_root (&all_threads
);
1324 all_threads
= scm_cons (thread
, SCM_EOL
);
1326 scm_set_smob_mark (scm_tc16_thread
, thread_mark
);
1327 scm_set_smob_print (scm_tc16_thread
, thread_print
);
1328 scm_set_smob_free (scm_tc16_thread
, thread_free
);
1330 scm_set_smob_mark (scm_tc16_fair_mutex
, fair_mutex_mark
);
1332 scm_set_smob_mark (scm_tc16_fair_condvar
, fair_cond_mark
);
1334 threads_initialized_p
= 1;
1338 scm_init_thread_procs ()
1340 #include "libguile/threads.x"