1 /* Copyright (C) 1995,1996,1997,1998,2000,2001, 2002 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 scm_i_plugin_mutex_unlock (&thread_admin_mutex
);
351 scm_thread_detach (t
->thread
);
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 /* Unwind wind chain. */
382 old_winds
= scm_dynwinds
;
383 scm_dowinds (SCM_EOL
, scm_ilength (scm_root
->dynwinds
));
385 /* Allocate thread locals. */
386 root
= scm_make_root (scm_root
->handle
);
387 data
= scm_malloc (sizeof (launch_data
));
390 thread
= make_thread (protects
);
391 data
->thread
= thread
;
393 data
->body_data
= body_data
;
394 data
->handler
= handler
;
395 data
->handler_data
= handler_data
;
396 t
= SCM_THREAD_DATA (thread
);
397 /* must initialize root state pointer before the thread is linked
399 t
->root
= SCM_ROOT_STATE (root
);
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
);
428 /* Return to old dynamic context. */
429 scm_dowinds (old_winds
, - scm_ilength (old_winds
));
434 scm_syserror ("create-thread");
441 SCM_DEFINE (scm_call_with_new_thread
, "call-with-new-thread", 2, 0, 0,
442 (SCM thunk
, SCM handler
),
443 "Evaluate @var{(thunk)} in a new thread, and new dynamic context, "
444 "returning a new thread object representing the thread. "
445 "If an error occurs during evaluation, call error-thunk, passing it an "
446 "error code describing the condition. "
447 "If this happens, the error-thunk is called outside the scope of the new "
448 "root -- it is called in the same dynamic context in which "
449 "with-new-thread was evaluated, but not in the callers thread. "
450 "All the evaluation rules for dynamic roots apply to threads.")
451 #define FUNC_NAME s_scm_call_with_new_thread
453 SCM_ASSERT (SCM_NFALSEP (scm_thunk_p (thunk
)), thunk
, SCM_ARG1
, FUNC_NAME
);
454 SCM_ASSERT (SCM_NFALSEP (scm_procedure_p (handler
)), handler
, SCM_ARG2
,
457 return create_thread ((scm_t_catch_body
) scm_call_0
, thunk
,
458 (scm_t_catch_handler
) scm_apply_1
, handler
,
459 scm_cons (thunk
, handler
));
463 SCM_DEFINE (scm_join_thread
, "join-thread", 1, 0, 0,
465 "Suspend execution of the calling thread until the target @var{thread} "
466 "terminates, unless the target @var{thread} has already terminated. ")
467 #define FUNC_NAME s_scm_join_thread
472 SCM_VALIDATE_THREAD (1, thread
);
473 if (SCM_EQ_P (cur_thread
, thread
))
474 SCM_MISC_ERROR ("can not join the current thread", SCM_EOL
);
476 t
= SCM_THREAD_DATA (thread
);
480 c
= scm_i_leave_guile ();
481 while (!THREAD_INITIALIZED_P (t
))
482 scm_i_plugin_thread_yield ();
483 scm_thread_join (t
->thread
, 0);
484 scm_i_enter_guile (c
);
487 t
->result
= SCM_BOOL_F
;
492 SCM
*scm_loc_sys_thread_handler
;
495 scm_i_make_future (SCM thunk
)
497 SCM_RETURN_NEWSMOB2 (scm_tc16_future
,
498 create_thread ((scm_t_catch_body
) scm_call_0
,
500 (scm_t_catch_handler
) scm_apply_1
,
501 *scm_loc_sys_thread_handler
,
503 *scm_loc_sys_thread_handler
)),
504 scm_make_rec_mutex ());
508 future_free (SCM future
)
510 scm_rec_mutex_free (SCM_FUTURE_MUTEX (future
));
515 future_print (SCM exp
, SCM port
, scm_print_state
*pstate
)
517 int writingp
= SCM_WRITINGP (pstate
);
518 scm_puts ("#<future ", port
);
519 SCM_SET_WRITINGP (pstate
, 1);
520 scm_iprin1 (SCM_FUTURE_DATA (exp
), port
, pstate
);
521 SCM_SET_WRITINGP (pstate
, writingp
);
522 scm_putc ('>', port
);
526 SCM_DEFINE (scm_future_ref
, "future-ref", 1, 0, 0,
528 "If the future @var{x} has not been computed yet, compute and\n"
529 "return @var{x}, otherwise just return the previously computed\n"
531 #define FUNC_NAME s_scm_future_ref
533 SCM_VALIDATE_FUTURE (1, future
);
534 scm_rec_mutex_lock (SCM_FUTURE_MUTEX (future
));
535 if (!SCM_FUTURE_COMPUTED_P (future
))
537 SCM value
= scm_join_thread (SCM_FUTURE_DATA (future
));
538 if (!SCM_FUTURE_COMPUTED_P (future
))
540 SCM_SET_FUTURE_DATA (future
, value
);
541 SCM_SET_FUTURE_COMPUTED (future
);
544 scm_rec_mutex_unlock (SCM_FUTURE_MUTEX (future
));
545 return SCM_FUTURE_DATA (future
);
551 /* We implement our own mutex type since we want them to be 'fair', we
552 want to do fancy things while waiting for them (like running
553 asyncs) and we want to support waiting on many things at once.
554 Also, we might add things that are nice for debugging.
557 typedef struct fair_mutex
{
558 /* the thread currently owning the mutex, or SCM_BOOL_F. */
562 /* how much the owner owns us. */
564 /* the threads waiting for this mutex. */
569 fair_mutex_mark (SCM mx
)
571 fair_mutex
*m
= SCM_MUTEX_DATA (mx
);
572 scm_gc_mark (m
->owner
);
576 SCM_DEFINE (scm_make_fair_mutex
, "make-fair-mutex", 0, 0, 0,
578 "Create a new fair mutex object. ")
579 #define FUNC_NAME s_scm_make_fair_mutex
581 SCM mx
= scm_make_smob (scm_tc16_fair_mutex
);
582 fair_mutex
*m
= SCM_MUTEX_DATA (mx
);
583 scm_i_plugin_mutex_init (&m
->lock
, &scm_i_plugin_mutex
);
585 m
->owner
= SCM_BOOL_F
;
587 m
->waiting
= make_queue ();
593 fair_mutex_lock (fair_mutex
*m
)
595 scm_i_plugin_mutex_lock (&m
->lock
);
597 /* Need to wait if another thread is just temporarily unlocking.
598 This is happens very seldom and only when the other thread is
599 between scm_mutex_unlock and scm_i_plugin_mutex_lock below. */
605 if (m
->owner
== SCM_BOOL_F
)
606 m
->owner
= cur_thread
;
607 else if (m
->owner
== cur_thread
)
613 SCM c
= enqueue (m
->waiting
, cur_thread
);
615 /* Note: It's important that m->lock is never locked for
616 any longer amount of time since that could prevent GC */
617 scm_i_plugin_mutex_unlock (&m
->lock
);
619 if (m
->owner
== cur_thread
)
621 scm_i_plugin_mutex_lock (&m
->lock
);
622 remqueue (m
->waiting
, c
);
623 scm_i_plugin_mutex_unlock (&m
->lock
);
627 scm_i_plugin_mutex_lock (&m
->lock
);
630 scm_i_plugin_mutex_unlock (&m
->lock
);
635 fair_mutex_trylock (fair_mutex
*m
)
637 scm_i_plugin_mutex_lock (&m
->lock
);
638 if (m
->owner
== SCM_BOOL_F
)
639 m
->owner
= cur_thread
;
640 else if (m
->owner
== cur_thread
)
644 scm_i_plugin_mutex_unlock (&m
->lock
);
647 scm_i_plugin_mutex_unlock (&m
->lock
);
652 fair_mutex_unlock (fair_mutex
*m
)
654 scm_i_plugin_mutex_lock (&m
->lock
);
655 if (m
->owner
!= cur_thread
)
657 scm_i_plugin_mutex_unlock (&m
->lock
);
660 else if (m
->level
> 0)
664 SCM next
= dequeue (m
->waiting
);
665 if (!SCM_FALSEP (next
))
668 unblock (SCM_THREAD_DATA (next
));
671 m
->owner
= SCM_BOOL_F
;
673 scm_i_plugin_mutex_unlock (&m
->lock
);
677 /*** Fair condition variables */
679 /* Like mutexes, we implement our own condition variables using the
683 typedef struct fair_cond
{
685 /* the threads waiting for this condition. */
690 fair_cond_mark (SCM cv
)
692 fair_cond
*c
= SCM_CONDVAR_DATA (cv
);
696 SCM_DEFINE (scm_make_fair_condition_variable
, "make-fair-condition-variable", 0, 0, 0,
698 "Make a new fair condition variable.")
699 #define FUNC_NAME s_scm_make_fair_condition_variable
701 SCM cv
= scm_make_smob (scm_tc16_fair_condvar
);
702 fair_cond
*c
= SCM_CONDVAR_DATA (cv
);
703 scm_i_plugin_mutex_init (&c
->lock
, 0);
704 c
->waiting
= make_queue ();
710 fair_cond_timedwait (fair_cond
*c
,
712 const struct timespec
*waittime
)
715 scm_i_plugin_mutex_lock (&c
->lock
);
719 enqueue (c
->waiting
, cur_thread
);
720 scm_i_plugin_mutex_unlock (&c
->lock
);
721 fair_mutex_unlock (m
); /*fixme* - not thread safe */
722 if (waittime
== NULL
)
725 err
= timed_block (waittime
);
729 /* XXX - check whether we have been signalled. */
736 fair_cond_signal (fair_cond
*c
)
739 scm_i_plugin_mutex_lock (&c
->lock
);
740 if (!SCM_FALSEP (th
= dequeue (c
->waiting
)))
741 unblock (SCM_THREAD_DATA (th
));
742 scm_i_plugin_mutex_unlock (&c
->lock
);
747 fair_cond_broadcast (fair_cond
*c
)
750 scm_i_plugin_mutex_lock (&c
->lock
);
751 while (!SCM_FALSEP (th
= dequeue (c
->waiting
)))
752 unblock (SCM_THREAD_DATA (th
));
753 scm_i_plugin_mutex_unlock (&c
->lock
);
759 SCM_DEFINE (scm_make_mutex
, "make-mutex", 0, 0, 0,
761 "Create a new mutex object. ")
762 #define FUNC_NAME s_scm_make_mutex
764 SCM mx
= scm_make_smob (scm_tc16_mutex
);
765 scm_i_plugin_mutex_init (SCM_MUTEX_DATA (mx
), &scm_i_plugin_mutex
);
770 /*fixme* change documentation */
771 SCM_DEFINE (scm_lock_mutex
, "lock-mutex", 1, 0, 0,
773 "Lock @var{mutex}. If the mutex is already locked, the calling thread "
774 "blocks until the mutex becomes available. The function returns when "
775 "the calling thread owns the lock on @var{mutex}. Locking a mutex that "
776 "a thread already owns will succeed right away and will not block the "
777 "thread. That is, Guile's mutexes are @emph{recursive}. ")
778 #define FUNC_NAME s_scm_lock_mutex
781 SCM_VALIDATE_MUTEX (1, mx
);
783 if (SCM_TYP16 (mx
) == scm_tc16_fair_mutex
)
784 err
= fair_mutex_lock (SCM_MUTEX_DATA (mx
));
787 scm_t_mutex
*m
= SCM_MUTEX_DATA (mx
);
788 err
= scm_mutex_lock (m
);
800 SCM_DEFINE (scm_try_mutex
, "try-mutex", 1, 0, 0,
802 "Try to lock @var{mutex}. If the mutex is already locked by someone "
803 "else, return @code{#f}. Else lock the mutex and return @code{#t}. ")
804 #define FUNC_NAME s_scm_try_mutex
807 SCM_VALIDATE_MUTEX (1, mx
);
809 if (SCM_TYP16 (mx
) == scm_tc16_fair_mutex
)
810 err
= fair_mutex_trylock (SCM_MUTEX_DATA (mx
));
813 scm_t_mutex
*m
= SCM_MUTEX_DATA (mx
);
814 err
= scm_mutex_trylock (m
);
830 SCM_DEFINE (scm_unlock_mutex
, "unlock-mutex", 1, 0, 0,
832 "Unlocks @var{mutex} if the calling thread owns the lock on "
833 "@var{mutex}. Calling unlock-mutex on a mutex not owned by the current "
834 "thread results in undefined behaviour. Once a mutex has been unlocked, "
835 "one thread blocked on @var{mutex} is awakened and grabs the mutex "
836 "lock. Every call to @code{lock-mutex} by this thread must be matched "
837 "with a call to @code{unlock-mutex}. Only the last call to "
838 "@code{unlock-mutex} will actually unlock the mutex. ")
839 #define FUNC_NAME s_scm_unlock_mutex
842 SCM_VALIDATE_MUTEX (1, mx
);
844 if (SCM_TYP16 (mx
) == scm_tc16_fair_mutex
)
846 err
= fair_mutex_unlock (SCM_MUTEX_DATA (mx
));
849 fair_mutex
*m
= SCM_MUTEX_DATA (mx
);
850 if (m
->owner
!= cur_thread
)
852 if (m
->owner
== SCM_BOOL_F
)
853 SCM_MISC_ERROR ("mutex not locked", SCM_EOL
);
855 SCM_MISC_ERROR ("mutex not locked by this thread", SCM_EOL
);
861 scm_t_mutex
*m
= SCM_MUTEX_DATA (mx
);
862 err
= scm_mutex_unlock (m
);
874 /*** Condition variables */
876 SCM_DEFINE (scm_make_condition_variable
, "make-condition-variable", 0, 0, 0,
878 "Make a new condition variable.")
879 #define FUNC_NAME s_scm_make_condition_variable
881 SCM cv
= scm_make_smob (scm_tc16_condvar
);
882 scm_i_plugin_cond_init (SCM_CONDVAR_DATA (cv
), 0);
887 SCM_DEFINE (scm_timed_wait_condition_variable
, "wait-condition-variable", 2, 1, 0,
888 (SCM cv
, SCM mx
, SCM t
),
889 "Wait until @var{cond-var} has been signalled. While waiting, "
890 "@var{mutex} is atomically unlocked (as with @code{unlock-mutex}) and "
891 "is locked again when this function returns. When @var{time} is given, "
892 "it specifies a point in time where the waiting should be aborted. It "
893 "can be either a integer as returned by @code{current-time} or a pair "
894 "as returned by @code{gettimeofday}. When the waiting is aborted the "
895 "mutex is locked and @code{#f} is returned. When the condition "
896 "variable is in fact signalled, the mutex is also locked and @code{#t} "
898 #define FUNC_NAME s_scm_timed_wait_condition_variable
900 struct timespec waittime
;
903 SCM_VALIDATE_CONDVAR (1, cv
);
904 SCM_VALIDATE_MUTEX (2, mx
);
905 if (!((SCM_TYP16 (cv
) == scm_tc16_condvar
906 && SCM_TYP16 (mx
) == scm_tc16_mutex
)
907 || (SCM_TYP16 (cv
) == scm_tc16_fair_condvar
908 && SCM_TYP16 (mx
) == scm_tc16_fair_mutex
)))
909 SCM_MISC_ERROR ("Condition variable and mutex are of different kinds.",
916 SCM_VALIDATE_UINT_COPY (3, SCM_CAR (t
), waittime
.tv_sec
);
917 SCM_VALIDATE_UINT_COPY (3, SCM_CDR (t
), waittime
.tv_nsec
);
918 waittime
.tv_nsec
*= 1000;
922 SCM_VALIDATE_UINT_COPY (3, t
, waittime
.tv_sec
);
923 waittime
.tv_nsec
= 0;
927 if (SCM_TYP16 (cv
) == scm_tc16_fair_condvar
)
928 err
= fair_cond_timedwait (SCM_CONDVAR_DATA (cv
),
930 SCM_UNBNDP (t
) ? NULL
: &waittime
);
933 scm_t_cond
*c
= SCM_CONDVAR_DATA (cv
);
934 scm_t_mutex
*m
= SCM_MUTEX_DATA (mx
);
935 err
= scm_cond_wait (c
, m
);
947 SCM_DEFINE (scm_signal_condition_variable
, "signal-condition-variable", 1, 0, 0,
949 "Wake up one thread that is waiting for @var{cv}")
950 #define FUNC_NAME s_scm_signal_condition_variable
952 SCM_VALIDATE_CONDVAR (1, cv
);
953 if (SCM_TYP16 (cv
) == scm_tc16_fair_condvar
)
954 fair_cond_signal (SCM_CONDVAR_DATA (cv
));
957 scm_t_cond
*c
= SCM_CONDVAR_DATA (cv
);
964 SCM_DEFINE (scm_broadcast_condition_variable
, "broadcast-condition-variable", 1, 0, 0,
966 "Wake up all threads that are waiting for @var{cv}. ")
967 #define FUNC_NAME s_scm_broadcast_condition_variable
969 SCM_VALIDATE_CONDVAR (1, cv
);
970 if (SCM_TYP16 (cv
) == scm_tc16_fair_condvar
)
971 fair_cond_broadcast (SCM_CONDVAR_DATA (cv
));
974 scm_t_cond
*c
= SCM_CONDVAR_DATA (cv
);
975 scm_cond_broadcast (c
);
981 /*** Marking stacks */
983 /* XXX - what to do with this? Do we need to handle this for blocked
987 # define SCM_MARK_BACKING_STORE() do { \
989 SCM_STACKITEM * top, * bot; \
991 scm_mark_locations ((SCM_STACKITEM *) &ctx.uc_mcontext, \
992 ((size_t) (sizeof (SCM_STACKITEM) - 1 + sizeof ctx.uc_mcontext) \
993 / sizeof (SCM_STACKITEM))); \
994 bot = (SCM_STACKITEM *) __libc_ia64_register_backing_store_base; \
995 top = (SCM_STACKITEM *) ctx.uc_mcontext.sc_ar_bsp; \
996 scm_mark_locations (bot, top - bot); } while (0)
998 # define SCM_MARK_BACKING_STORE()
1002 scm_threads_mark_stacks (void)
1005 for (c
= all_threads
; !SCM_NULLP (c
); c
= SCM_CDR (c
))
1007 scm_thread
*t
= SCM_THREAD_DATA (SCM_CAR (c
));
1008 if (!THREAD_INITIALIZED_P (t
))
1010 /* Not fully initialized yet. */
1017 if (t
->thread
!= scm_thread_self ())
1021 /* stack_len is long rather than sizet in order to guarantee
1022 that &stack_len is long aligned */
1023 #ifdef STACK_GROWS_UP
1024 stack_len
= ((SCM_STACKITEM
*) (&t
) -
1025 (SCM_STACKITEM
*) thread
->base
);
1027 /* Protect from the C stack. This must be the first marking
1028 * done because it provides information about what objects
1029 * are "in-use" by the C code. "in-use" objects are those
1030 * for which the information about length and base address must
1031 * remain usable. This requirement is stricter than a liveness
1032 * requirement -- in particular, it constrains the implementation
1035 SCM_FLUSH_REGISTER_WINDOWS
;
1036 /* This assumes that all registers are saved into the jmp_buf */
1037 setjmp (scm_save_regs_gc_mark
);
1038 scm_mark_locations ((SCM_STACKITEM
*) scm_save_regs_gc_mark
,
1039 ((size_t) sizeof scm_save_regs_gc_mark
1040 / sizeof (SCM_STACKITEM
)));
1042 scm_mark_locations (((size_t) t
->base
,
1043 (sizet
) stack_len
));
1045 stack_len
= ((SCM_STACKITEM
*) t
->base
-
1046 (SCM_STACKITEM
*) (&t
));
1048 /* Protect from the C stack. This must be the first marking
1049 * done because it provides information about what objects
1050 * are "in-use" by the C code. "in-use" objects are those
1051 * for which the information about length and base address must
1052 * remain usable. This requirement is stricter than a liveness
1053 * requirement -- in particular, it constrains the implementation
1056 SCM_FLUSH_REGISTER_WINDOWS
;
1057 /* This assumes that all registers are saved into the jmp_buf */
1058 setjmp (scm_save_regs_gc_mark
);
1059 scm_mark_locations ((SCM_STACKITEM
*) scm_save_regs_gc_mark
,
1060 ((size_t) sizeof scm_save_regs_gc_mark
1061 / sizeof (SCM_STACKITEM
)));
1063 scm_mark_locations ((SCM_STACKITEM
*) &t
,
1069 /* Suspended thread */
1070 #ifdef STACK_GROWS_UP
1071 long stack_len
= t
->top
- t
->base
;
1072 scm_mark_locations (t
->base
, stack_len
);
1074 long stack_len
= t
->base
- t
->top
;
1075 scm_mark_locations (t
->top
, stack_len
);
1077 scm_mark_locations ((SCM_STACKITEM
*) t
->regs
,
1078 ((size_t) sizeof(t
->regs
)
1079 / sizeof (SCM_STACKITEM
)));
1087 scm_internal_select (int nfds
,
1088 SELECT_TYPE
*readfds
,
1089 SELECT_TYPE
*writefds
,
1090 SELECT_TYPE
*exceptfds
,
1091 struct timeval
*timeout
)
1094 scm_thread
*c
= scm_i_leave_guile ();
1095 res
= scm_i_plugin_select (nfds
, readfds
, writefds
, exceptfds
, timeout
);
1097 scm_i_enter_guile (c
);
1103 /* Low-level C API */
1106 scm_spawn_thread (scm_t_catch_body body
, void *body_data
,
1107 scm_t_catch_handler handler
, void *handler_data
)
1109 return create_thread (body
, body_data
, handler
, handler_data
, SCM_BOOL_F
);
1113 scm_mutex_lock (scm_t_mutex
*m
)
1115 scm_thread
*t
= scm_i_leave_guile ();
1116 int res
= scm_i_plugin_mutex_lock (m
);
1117 scm_i_enter_guile (t
);
1122 scm_make_rec_mutex ()
1124 scm_t_rec_mutex
*m
= scm_malloc (sizeof (scm_t_rec_mutex
));
1125 scm_i_plugin_rec_mutex_init (m
, &scm_i_plugin_rec_mutex
);
1130 scm_rec_mutex_free (scm_t_rec_mutex
*m
)
1132 scm_i_plugin_rec_mutex_destroy (m
);
1137 scm_rec_mutex_lock (scm_t_rec_mutex
*m
)
1139 scm_thread
*t
= scm_i_leave_guile ();
1140 int res
= scm_i_plugin_rec_mutex_lock (m
);
1141 scm_i_enter_guile (t
);
1146 scm_cond_wait (scm_t_cond
*c
, scm_t_mutex
*m
)
1148 scm_thread
*t
= scm_i_leave_guile ();
1149 scm_i_plugin_cond_wait (c
, m
);
1150 scm_i_enter_guile (t
);
1155 scm_cond_timedwait (scm_t_cond
*c
, scm_t_mutex
*m
, const struct timespec
*wt
)
1157 scm_thread
*t
= scm_i_leave_guile ();
1158 int res
= scm_i_plugin_cond_timedwait (c
, m
, wt
);
1159 scm_i_enter_guile (t
);
1166 scm_i_enter_guile (SCM_CURRENT_THREAD
);
1172 scm_i_leave_guile ();
1176 scm_thread_usleep (unsigned long usecs
)
1179 tv
.tv_usec
= usecs
% 1000000;
1180 tv
.tv_sec
= usecs
/ 1000000;
1181 scm_internal_select (0, NULL
, NULL
, NULL
, &tv
);
1182 return tv
.tv_usec
+ tv
.tv_sec
*1000000;
1186 scm_thread_sleep (unsigned long secs
)
1191 scm_internal_select (0, NULL
, NULL
, NULL
, &tv
);
1197 SCM_DEFINE (scm_current_thread
, "current-thread", 0, 0, 0,
1199 "Return the thread that called this function.")
1200 #define FUNC_NAME s_scm_current_thread
1206 SCM_DEFINE (scm_all_threads
, "all-threads", 0, 0, 0,
1208 "Return a list of all threads.")
1209 #define FUNC_NAME s_scm_all_threads
1211 return scm_list_copy (all_threads
);
1216 scm_i_thread_root (SCM thread
)
1218 return ((scm_thread
*) SCM_THREAD_DATA (thread
))->root
;
1221 SCM_DEFINE (scm_thread_exited_p
, "thread-exited?", 1, 0, 0,
1223 "Return @code{#t} iff @var{thread} has exited.\n")
1224 #define FUNC_NAME s_scm_thread_exited_p
1226 return SCM_BOOL (scm_c_thread_exited_p (thread
));
1231 scm_c_thread_exited_p (SCM thread
)
1232 #define FUNC_NAME s_scm_thread_exited_p
1235 SCM_VALIDATE_THREAD (1, thread
);
1236 t
= SCM_THREAD_DATA (thread
);
1241 static scm_t_cond wake_up_cond
;
1242 int scm_i_thread_go_to_sleep
;
1243 static scm_t_rec_mutex gc_section_mutex
;
1244 static int gc_section_count
= 0;
1245 static int threads_initialized_p
= 0;
1248 scm_i_thread_put_to_sleep ()
1250 scm_rec_mutex_lock (&gc_section_mutex
);
1251 if (threads_initialized_p
&& !gc_section_count
++)
1254 scm_i_plugin_mutex_lock (&thread_admin_mutex
);
1255 threads
= all_threads
;
1256 /* Signal all threads to go to sleep */
1257 scm_i_thread_go_to_sleep
= 1;
1258 for (; !SCM_NULLP (threads
); threads
= SCM_CDR (threads
))
1259 if (SCM_CAR (threads
) != cur_thread
)
1261 scm_thread
*t
= SCM_THREAD_DATA (SCM_CAR (threads
));
1262 scm_i_plugin_mutex_lock (&t
->heap_mutex
);
1264 scm_i_thread_go_to_sleep
= 0;
1265 scm_i_plugin_mutex_unlock (&thread_admin_mutex
);
1270 scm_i_thread_invalidate_freelists ()
1272 /* Don't need to lock thread_admin_mutex here since we are sinle threaded */
1273 SCM threads
= all_threads
;
1274 for (; !SCM_NULLP (threads
); threads
= SCM_CDR (threads
))
1275 if (SCM_CAR (threads
) != cur_thread
)
1277 scm_thread
*t
= SCM_THREAD_DATA (SCM_CAR (threads
));
1278 t
->clear_freelists_p
= 1;
1283 scm_i_thread_wake_up ()
1285 if (threads_initialized_p
&& !--gc_section_count
)
1288 /* Need to lock since woken threads can die and be deleted from list */
1289 scm_i_plugin_mutex_lock (&thread_admin_mutex
);
1290 threads
= all_threads
;
1291 scm_i_plugin_cond_broadcast (&wake_up_cond
);
1292 for (; !SCM_NULLP (threads
); threads
= SCM_CDR (threads
))
1293 if (SCM_CAR (threads
) != cur_thread
)
1295 scm_thread
*t
= SCM_THREAD_DATA (SCM_CAR (threads
));
1296 scm_i_plugin_mutex_unlock (&t
->heap_mutex
);
1298 scm_i_plugin_mutex_unlock (&thread_admin_mutex
);
1300 scm_rec_mutex_unlock (&gc_section_mutex
);
1304 scm_i_thread_sleep_for_gc ()
1308 scm_i_plugin_cond_wait (&wake_up_cond
, &t
->heap_mutex
);
1312 scm_t_mutex scm_i_critical_section_mutex
;
1313 scm_t_rec_mutex scm_i_defer_mutex
;
1315 #ifdef USE_PTHREAD_THREADS
1316 #include "libguile/pthread-threads.c"
1319 /*** Initialization */
1322 scm_threads_prehistory ()
1325 #ifdef USE_PTHREAD_THREADS
1326 /* Must be called before any initialization of a mutex. */
1327 scm_init_pthread_threads ();
1329 scm_i_plugin_mutex_init (&thread_admin_mutex
, &scm_i_plugin_mutex
);
1330 scm_i_plugin_rec_mutex_init (&gc_section_mutex
, &scm_i_plugin_rec_mutex
);
1331 scm_i_plugin_cond_init (&wake_up_cond
, 0);
1332 scm_i_plugin_mutex_init (&scm_i_critical_section_mutex
, &scm_i_plugin_mutex
);
1334 scm_i_plugin_key_create (&scm_i_thread_key
, 0);
1335 scm_i_plugin_key_create (&scm_i_root_state_key
, 0);
1336 scm_i_plugin_rec_mutex_init (&scm_i_defer_mutex
, &scm_i_plugin_rec_mutex
);
1337 /* Allocate a fake thread object to be used during bootup. */
1338 t
= malloc (sizeof (scm_thread
));
1340 t
->clear_freelists_p
= 0;
1341 scm_i_plugin_mutex_init (&t
->heap_mutex
, &scm_i_plugin_mutex
);
1342 scm_setspecific (scm_i_thread_key
, t
);
1343 scm_i_enter_guile (t
);
1346 scm_t_bits scm_tc16_thread
;
1347 scm_t_bits scm_tc16_future
;
1348 scm_t_bits scm_tc16_mutex
;
1349 scm_t_bits scm_tc16_fair_mutex
;
1350 scm_t_bits scm_tc16_condvar
;
1351 scm_t_bits scm_tc16_fair_condvar
;
1354 scm_init_threads (SCM_STACKITEM
*base
)
1357 scm_tc16_thread
= scm_make_smob_type ("thread", sizeof (scm_thread
));
1358 scm_tc16_mutex
= scm_make_smob_type ("mutex", sizeof (scm_t_mutex
));
1359 scm_tc16_fair_mutex
= scm_make_smob_type ("fair-mutex",
1360 sizeof (fair_mutex
));
1361 scm_tc16_condvar
= scm_make_smob_type ("condition-variable",
1362 sizeof (scm_t_cond
));
1363 scm_tc16_fair_condvar
= scm_make_smob_type ("fair-condition-variable",
1364 sizeof (fair_cond
));
1366 thread
= make_thread (SCM_BOOL_F
);
1367 /* Replace initial fake thread with a real thread object */
1368 free (SCM_CURRENT_THREAD
);
1369 scm_setspecific (scm_i_thread_key
, SCM_THREAD_DATA (thread
));
1370 scm_i_enter_guile (SCM_CURRENT_THREAD
);
1372 /* root is set later from init.c */
1373 init_thread_creatant (thread
, base
);
1375 scm_gc_register_root (&all_threads
);
1376 all_threads
= scm_cons (thread
, SCM_EOL
);
1378 scm_set_smob_mark (scm_tc16_thread
, thread_mark
);
1379 scm_set_smob_print (scm_tc16_thread
, thread_print
);
1380 scm_set_smob_free (scm_tc16_thread
, thread_free
);
1382 scm_set_smob_mark (scm_tc16_fair_mutex
, fair_mutex_mark
);
1384 scm_set_smob_mark (scm_tc16_fair_condvar
, fair_cond_mark
);
1386 scm_tc16_future
= scm_make_smob_type ("future", 0);
1387 scm_set_smob_mark (scm_tc16_future
, scm_markcdr
);
1388 scm_set_smob_free (scm_tc16_future
, future_free
);
1389 scm_set_smob_print (scm_tc16_future
, future_print
);
1391 threads_initialized_p
= 1;
1395 scm_init_thread_procs ()
1397 scm_loc_sys_thread_handler
1398 = SCM_VARIABLE_LOC (scm_c_define ("%thread-handler", SCM_BOOL_F
));
1399 #include "libguile/threads.x"