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
);
479 scm_thread
*c
= scm_i_leave_guile ();
480 while (!THREAD_INITIALIZED_P (t
))
482 scm_thread_join (t
->thread
, 0);
483 scm_i_enter_guile (c
);
486 t
->result
= SCM_BOOL_F
;
491 SCM
*scm_loc_sys_thread_handler
;
494 scm_i_make_future (SCM thunk
)
496 SCM_RETURN_NEWSMOB2 (scm_tc16_future
,
497 create_thread ((scm_t_catch_body
) scm_call_0
,
499 (scm_t_catch_handler
) scm_apply_1
,
500 *scm_loc_sys_thread_handler
,
502 *scm_loc_sys_thread_handler
)),
503 scm_make_rec_mutex ());
507 future_free (SCM future
)
509 scm_rec_mutex_free (SCM_FUTURE_MUTEX (future
));
514 future_print (SCM exp
, SCM port
, scm_print_state
*pstate
)
516 int writingp
= SCM_WRITINGP (pstate
);
517 scm_puts ("#<future ", port
);
518 SCM_SET_WRITINGP (pstate
, 1);
519 scm_iprin1 (SCM_FUTURE_DATA (exp
), port
, pstate
);
520 SCM_SET_WRITINGP (pstate
, writingp
);
521 scm_putc ('>', port
);
525 SCM_DEFINE (scm_future_ref
, "future-ref", 1, 0, 0,
527 "If the future @var{x} has not been computed yet, compute and\n"
528 "return @var{x}, otherwise just return the previously computed\n"
530 #define FUNC_NAME s_scm_future_ref
532 SCM_VALIDATE_FUTURE (1, future
);
533 scm_rec_mutex_lock (SCM_FUTURE_MUTEX (future
));
534 if (!SCM_FUTURE_COMPUTED_P (future
))
536 SCM value
= scm_join_thread (SCM_FUTURE_DATA (future
));
537 if (!SCM_FUTURE_COMPUTED_P (future
))
539 SCM_SET_FUTURE_DATA (future
, value
);
540 SCM_SET_FUTURE_COMPUTED (future
);
543 scm_rec_mutex_unlock (SCM_FUTURE_MUTEX (future
));
544 return SCM_FUTURE_DATA (future
);
550 /* We implement our own mutex type since we want them to be 'fair', we
551 want to do fancy things while waiting for them (like running
552 asyncs) and we want to support waiting on many things at once.
553 Also, we might add things that are nice for debugging.
556 typedef struct fair_mutex
{
557 /* the thread currently owning the mutex, or SCM_BOOL_F. */
561 /* how much the owner owns us. */
563 /* the threads waiting for this mutex. */
568 fair_mutex_mark (SCM mx
)
570 fair_mutex
*m
= SCM_MUTEX_DATA (mx
);
571 scm_gc_mark (m
->owner
);
575 SCM_DEFINE (scm_make_fair_mutex
, "make-fair-mutex", 0, 0, 0,
577 "Create a new fair mutex object. ")
578 #define FUNC_NAME s_scm_make_fair_mutex
580 SCM mx
= scm_make_smob (scm_tc16_fair_mutex
);
581 fair_mutex
*m
= SCM_MUTEX_DATA (mx
);
582 scm_i_plugin_mutex_init (&m
->lock
, &scm_i_plugin_mutex
);
584 m
->owner
= SCM_BOOL_F
;
586 m
->waiting
= make_queue ();
592 fair_mutex_lock (fair_mutex
*m
)
594 scm_i_plugin_mutex_lock (&m
->lock
);
596 /* Need to wait if another thread is just temporarily unlocking.
597 This is happens very seldom and only when the other thread is
598 between scm_mutex_unlock and scm_i_plugin_mutex_lock below. */
604 if (m
->owner
== SCM_BOOL_F
)
605 m
->owner
= cur_thread
;
606 else if (m
->owner
== cur_thread
)
612 SCM c
= enqueue (m
->waiting
, cur_thread
);
614 /* Note: It's important that m->lock is never locked for
615 any longer amount of time since that could prevent GC */
616 scm_i_plugin_mutex_unlock (&m
->lock
);
618 if (m
->owner
== cur_thread
)
620 scm_i_plugin_mutex_lock (&m
->lock
);
621 remqueue (m
->waiting
, c
);
622 scm_i_plugin_mutex_unlock (&m
->lock
);
626 scm_i_plugin_mutex_lock (&m
->lock
);
629 scm_i_plugin_mutex_unlock (&m
->lock
);
634 fair_mutex_trylock (fair_mutex
*m
)
636 scm_i_plugin_mutex_lock (&m
->lock
);
637 if (m
->owner
== SCM_BOOL_F
)
638 m
->owner
= cur_thread
;
639 else if (m
->owner
== cur_thread
)
643 scm_i_plugin_mutex_unlock (&m
->lock
);
646 scm_i_plugin_mutex_unlock (&m
->lock
);
651 fair_mutex_unlock (fair_mutex
*m
)
653 scm_i_plugin_mutex_lock (&m
->lock
);
654 if (m
->owner
!= cur_thread
)
656 scm_i_plugin_mutex_unlock (&m
->lock
);
659 else if (m
->level
> 0)
663 SCM next
= dequeue (m
->waiting
);
664 if (!SCM_FALSEP (next
))
667 unblock (SCM_THREAD_DATA (next
));
670 m
->owner
= SCM_BOOL_F
;
672 scm_i_plugin_mutex_unlock (&m
->lock
);
676 /*** Fair condition variables */
678 /* Like mutexes, we implement our own condition variables using the
682 typedef struct fair_cond
{
684 /* the threads waiting for this condition. */
689 fair_cond_mark (SCM cv
)
691 fair_cond
*c
= SCM_CONDVAR_DATA (cv
);
695 SCM_DEFINE (scm_make_fair_condition_variable
, "make-fair-condition-variable", 0, 0, 0,
697 "Make a new fair condition variable.")
698 #define FUNC_NAME s_scm_make_fair_condition_variable
700 SCM cv
= scm_make_smob (scm_tc16_fair_condvar
);
701 fair_cond
*c
= SCM_CONDVAR_DATA (cv
);
702 scm_i_plugin_mutex_init (&c
->lock
, 0);
703 c
->waiting
= make_queue ();
709 fair_cond_timedwait (fair_cond
*c
,
711 const struct timespec
*waittime
)
714 scm_i_plugin_mutex_lock (&c
->lock
);
718 enqueue (c
->waiting
, cur_thread
);
719 scm_i_plugin_mutex_unlock (&c
->lock
);
720 fair_mutex_unlock (m
); /*fixme* - not thread safe */
721 if (waittime
== NULL
)
724 err
= timed_block (waittime
);
728 /* XXX - check whether we have been signalled. */
735 fair_cond_signal (fair_cond
*c
)
738 scm_i_plugin_mutex_lock (&c
->lock
);
739 if (!SCM_FALSEP (th
= dequeue (c
->waiting
)))
740 unblock (SCM_THREAD_DATA (th
));
741 scm_i_plugin_mutex_unlock (&c
->lock
);
746 fair_cond_broadcast (fair_cond
*c
)
749 scm_i_plugin_mutex_lock (&c
->lock
);
750 while (!SCM_FALSEP (th
= dequeue (c
->waiting
)))
751 unblock (SCM_THREAD_DATA (th
));
752 scm_i_plugin_mutex_unlock (&c
->lock
);
758 SCM_DEFINE (scm_make_mutex
, "make-mutex", 0, 0, 0,
760 "Create a new mutex object. ")
761 #define FUNC_NAME s_scm_make_mutex
763 SCM mx
= scm_make_smob (scm_tc16_mutex
);
764 scm_i_plugin_mutex_init (SCM_MUTEX_DATA (mx
), &scm_i_plugin_mutex
);
769 /*fixme* change documentation */
770 SCM_DEFINE (scm_lock_mutex
, "lock-mutex", 1, 0, 0,
772 "Lock @var{mutex}. If the mutex is already locked, the calling thread "
773 "blocks until the mutex becomes available. The function returns when "
774 "the calling thread owns the lock on @var{mutex}. Locking a mutex that "
775 "a thread already owns will succeed right away and will not block the "
776 "thread. That is, Guile's mutexes are @emph{recursive}. ")
777 #define FUNC_NAME s_scm_lock_mutex
780 SCM_VALIDATE_MUTEX (1, mx
);
782 if (SCM_TYP16 (mx
) == scm_tc16_fair_mutex
)
783 err
= fair_mutex_lock (SCM_MUTEX_DATA (mx
));
786 scm_t_mutex
*m
= SCM_MUTEX_DATA (mx
);
787 scm_thread
*t
= scm_i_leave_guile ();
788 err
= scm_i_plugin_mutex_lock (m
);
789 scm_i_enter_guile (t
);
801 SCM_DEFINE (scm_try_mutex
, "try-mutex", 1, 0, 0,
803 "Try to lock @var{mutex}. If the mutex is already locked by someone "
804 "else, return @code{#f}. Else lock the mutex and return @code{#t}. ")
805 #define FUNC_NAME s_scm_try_mutex
808 SCM_VALIDATE_MUTEX (1, mx
);
810 if (SCM_TYP16 (mx
) == scm_tc16_fair_mutex
)
811 err
= fair_mutex_trylock (SCM_MUTEX_DATA (mx
));
814 scm_t_mutex
*m
= SCM_MUTEX_DATA (mx
);
815 scm_thread
*t
= scm_i_leave_guile ();
816 err
= scm_i_plugin_mutex_trylock (m
);
817 scm_i_enter_guile (t
);
833 SCM_DEFINE (scm_unlock_mutex
, "unlock-mutex", 1, 0, 0,
835 "Unlocks @var{mutex} if the calling thread owns the lock on "
836 "@var{mutex}. Calling unlock-mutex on a mutex not owned by the current "
837 "thread results in undefined behaviour. Once a mutex has been unlocked, "
838 "one thread blocked on @var{mutex} is awakened and grabs the mutex "
839 "lock. Every call to @code{lock-mutex} by this thread must be matched "
840 "with a call to @code{unlock-mutex}. Only the last call to "
841 "@code{unlock-mutex} will actually unlock the mutex. ")
842 #define FUNC_NAME s_scm_unlock_mutex
845 SCM_VALIDATE_MUTEX (1, mx
);
847 if (SCM_TYP16 (mx
) == scm_tc16_fair_mutex
)
849 err
= fair_mutex_unlock (SCM_MUTEX_DATA (mx
));
852 fair_mutex
*m
= SCM_MUTEX_DATA (mx
);
853 if (m
->owner
!= cur_thread
)
855 if (m
->owner
== SCM_BOOL_F
)
856 SCM_MISC_ERROR ("mutex not locked", SCM_EOL
);
858 SCM_MISC_ERROR ("mutex not locked by this thread", SCM_EOL
);
864 scm_t_mutex
*m
= SCM_MUTEX_DATA (mx
);
865 err
= scm_i_plugin_mutex_unlock (m
);
877 /*** Condition variables */
879 SCM_DEFINE (scm_make_condition_variable
, "make-condition-variable", 0, 0, 0,
881 "Make a new condition variable.")
882 #define FUNC_NAME s_scm_make_condition_variable
884 SCM cv
= scm_make_smob (scm_tc16_condvar
);
885 scm_i_plugin_cond_init (SCM_CONDVAR_DATA (cv
), 0);
890 SCM_DEFINE (scm_timed_wait_condition_variable
, "wait-condition-variable", 2, 1, 0,
891 (SCM cv
, SCM mx
, SCM t
),
892 "Wait until @var{cond-var} has been signalled. While waiting, "
893 "@var{mutex} is atomically unlocked (as with @code{unlock-mutex}) and "
894 "is locked again when this function returns. When @var{time} is given, "
895 "it specifies a point in time where the waiting should be aborted. It "
896 "can be either a integer as returned by @code{current-time} or a pair "
897 "as returned by @code{gettimeofday}. When the waiting is aborted the "
898 "mutex is locked and @code{#f} is returned. When the condition "
899 "variable is in fact signalled, the mutex is also locked and @code{#t} "
901 #define FUNC_NAME s_scm_timed_wait_condition_variable
903 struct timespec waittime
;
906 SCM_VALIDATE_CONDVAR (1, cv
);
907 SCM_VALIDATE_MUTEX (2, mx
);
908 if (!((SCM_TYP16 (cv
) == scm_tc16_condvar
909 && SCM_TYP16 (mx
) == scm_tc16_mutex
)
910 || (SCM_TYP16 (cv
) == scm_tc16_fair_condvar
911 && SCM_TYP16 (mx
) == scm_tc16_fair_mutex
)))
912 SCM_MISC_ERROR ("Condition variable and mutex are of different kinds.",
919 SCM_VALIDATE_UINT_COPY (3, SCM_CAR (t
), waittime
.tv_sec
);
920 SCM_VALIDATE_UINT_COPY (3, SCM_CDR (t
), waittime
.tv_nsec
);
921 waittime
.tv_nsec
*= 1000;
925 SCM_VALIDATE_UINT_COPY (3, t
, waittime
.tv_sec
);
926 waittime
.tv_nsec
= 0;
930 if (SCM_TYP16 (cv
) == scm_tc16_fair_condvar
)
931 err
= fair_cond_timedwait (SCM_CONDVAR_DATA (cv
),
933 SCM_UNBNDP (t
) ? NULL
: &waittime
);
936 scm_t_cond
*c
= SCM_CONDVAR_DATA (cv
);
937 scm_t_mutex
*m
= SCM_MUTEX_DATA (mx
);
938 scm_thread
*t
= scm_i_leave_guile ();
939 err
= scm_i_plugin_cond_wait (c
, m
);
940 scm_i_enter_guile (t
);
952 SCM_DEFINE (scm_signal_condition_variable
, "signal-condition-variable", 1, 0, 0,
954 "Wake up one thread that is waiting for @var{cv}")
955 #define FUNC_NAME s_scm_signal_condition_variable
957 SCM_VALIDATE_CONDVAR (1, cv
);
958 if (SCM_TYP16 (cv
) == scm_tc16_fair_condvar
)
959 fair_cond_signal (SCM_CONDVAR_DATA (cv
));
962 scm_t_cond
*c
= SCM_CONDVAR_DATA (cv
);
963 scm_i_plugin_cond_signal (c
);
969 SCM_DEFINE (scm_broadcast_condition_variable
, "broadcast-condition-variable", 1, 0, 0,
971 "Wake up all threads that are waiting for @var{cv}. ")
972 #define FUNC_NAME s_scm_broadcast_condition_variable
974 SCM_VALIDATE_CONDVAR (1, cv
);
975 if (SCM_TYP16 (cv
) == scm_tc16_fair_condvar
)
976 fair_cond_broadcast (SCM_CONDVAR_DATA (cv
));
979 scm_t_cond
*c
= SCM_CONDVAR_DATA (cv
);
980 scm_i_plugin_cond_broadcast (c
);
986 /*** Marking stacks */
988 /* XXX - what to do with this? Do we need to handle this for blocked
992 # define SCM_MARK_BACKING_STORE() do { \
994 SCM_STACKITEM * top, * bot; \
996 scm_mark_locations ((SCM_STACKITEM *) &ctx.uc_mcontext, \
997 ((size_t) (sizeof (SCM_STACKITEM) - 1 + sizeof ctx.uc_mcontext) \
998 / sizeof (SCM_STACKITEM))); \
999 bot = (SCM_STACKITEM *) __libc_ia64_register_backing_store_base; \
1000 top = (SCM_STACKITEM *) ctx.uc_mcontext.sc_ar_bsp; \
1001 scm_mark_locations (bot, top - bot); } while (0)
1003 # define SCM_MARK_BACKING_STORE()
1007 scm_threads_mark_stacks (void)
1010 for (c
= all_threads
; !SCM_NULLP (c
); c
= SCM_CDR (c
))
1012 scm_thread
*t
= SCM_THREAD_DATA (SCM_CAR (c
));
1013 if (!THREAD_INITIALIZED_P (t
))
1015 /* Not fully initialized yet. */
1022 if (t
->thread
!= scm_thread_self ())
1026 /* stack_len is long rather than sizet in order to guarantee
1027 that &stack_len is long aligned */
1028 #ifdef STACK_GROWS_UP
1029 stack_len
= ((SCM_STACKITEM
*) (&t
) -
1030 (SCM_STACKITEM
*) thread
->base
);
1032 /* Protect from the C stack. This must be the first marking
1033 * done because it provides information about what objects
1034 * are "in-use" by the C code. "in-use" objects are those
1035 * for which the information about length and base address must
1036 * remain usable. This requirement is stricter than a liveness
1037 * requirement -- in particular, it constrains the implementation
1040 SCM_FLUSH_REGISTER_WINDOWS
;
1041 /* This assumes that all registers are saved into the jmp_buf */
1042 setjmp (scm_save_regs_gc_mark
);
1043 scm_mark_locations ((SCM_STACKITEM
*) scm_save_regs_gc_mark
,
1044 ((size_t) sizeof scm_save_regs_gc_mark
1045 / sizeof (SCM_STACKITEM
)));
1047 scm_mark_locations (((size_t) t
->base
,
1048 (sizet
) stack_len
));
1050 stack_len
= ((SCM_STACKITEM
*) t
->base
-
1051 (SCM_STACKITEM
*) (&t
));
1053 /* Protect from the C stack. This must be the first marking
1054 * done because it provides information about what objects
1055 * are "in-use" by the C code. "in-use" objects are those
1056 * for which the information about length and base address must
1057 * remain usable. This requirement is stricter than a liveness
1058 * requirement -- in particular, it constrains the implementation
1061 SCM_FLUSH_REGISTER_WINDOWS
;
1062 /* This assumes that all registers are saved into the jmp_buf */
1063 setjmp (scm_save_regs_gc_mark
);
1064 scm_mark_locations ((SCM_STACKITEM
*) scm_save_regs_gc_mark
,
1065 ((size_t) sizeof scm_save_regs_gc_mark
1066 / sizeof (SCM_STACKITEM
)));
1068 scm_mark_locations ((SCM_STACKITEM
*) &t
,
1074 /* Suspended thread */
1075 #ifdef STACK_GROWS_UP
1076 long stack_len
= t
->top
- t
->base
;
1077 scm_mark_locations (t
->base
, stack_len
);
1079 long stack_len
= t
->base
- t
->top
;
1080 scm_mark_locations (t
->top
, stack_len
);
1082 scm_mark_locations ((SCM_STACKITEM
*) t
->regs
,
1083 ((size_t) sizeof(t
->regs
)
1084 / sizeof (SCM_STACKITEM
)));
1092 scm_internal_select (int nfds
,
1093 SELECT_TYPE
*readfds
,
1094 SELECT_TYPE
*writefds
,
1095 SELECT_TYPE
*exceptfds
,
1096 struct timeval
*timeout
)
1099 scm_thread
*c
= scm_i_leave_guile ();
1100 res
= scm_i_plugin_select (nfds
, readfds
, writefds
, exceptfds
, timeout
);
1102 scm_i_enter_guile (c
);
1108 /* Low-level C API */
1111 scm_spawn_thread (scm_t_catch_body body
, void *body_data
,
1112 scm_t_catch_handler handler
, void *handler_data
)
1114 return create_thread (body
, body_data
, handler
, handler_data
, SCM_BOOL_F
);
1118 scm_mutex_lock (scm_t_mutex
*m
)
1120 scm_thread
*t
= scm_i_leave_guile ();
1121 int res
= scm_i_plugin_mutex_lock (m
);
1122 scm_i_enter_guile (t
);
1127 scm_make_rec_mutex ()
1129 scm_t_rec_mutex
*m
= scm_malloc (sizeof (scm_t_rec_mutex
));
1130 scm_i_plugin_rec_mutex_init (m
, &scm_i_plugin_rec_mutex
);
1135 scm_rec_mutex_free (scm_t_rec_mutex
*m
)
1137 scm_i_plugin_rec_mutex_destroy (m
);
1142 scm_rec_mutex_lock (scm_t_rec_mutex
*m
)
1144 scm_thread
*t
= scm_i_leave_guile ();
1145 int res
= scm_i_plugin_rec_mutex_lock (m
);
1146 scm_i_enter_guile (t
);
1151 scm_cond_wait (scm_t_cond
*c
, scm_t_mutex
*m
)
1153 scm_thread
*t
= scm_i_leave_guile ();
1154 scm_i_plugin_cond_wait (c
, m
);
1155 scm_i_enter_guile (t
);
1160 scm_cond_timedwait (scm_t_cond
*c
, scm_t_mutex
*m
, const struct timespec
*wt
)
1162 scm_thread
*t
= scm_i_leave_guile ();
1163 int res
= scm_i_plugin_cond_timedwait (c
, m
, wt
);
1164 scm_i_enter_guile (t
);
1171 scm_i_enter_guile (SCM_CURRENT_THREAD
);
1177 scm_i_leave_guile ();
1181 scm_thread_usleep (unsigned long usecs
)
1184 tv
.tv_usec
= usecs
% 1000000;
1185 tv
.tv_sec
= usecs
/ 1000000;
1186 scm_internal_select (0, NULL
, NULL
, NULL
, &tv
);
1187 return tv
.tv_usec
+ tv
.tv_sec
*1000000;
1191 scm_thread_sleep (unsigned long secs
)
1196 scm_internal_select (0, NULL
, NULL
, NULL
, &tv
);
1202 SCM_DEFINE (scm_current_thread
, "current-thread", 0, 0, 0,
1204 "Return the thread that called this function.")
1205 #define FUNC_NAME s_scm_current_thread
1211 SCM_DEFINE (scm_all_threads
, "all-threads", 0, 0, 0,
1213 "Return a list of all threads.")
1214 #define FUNC_NAME s_scm_all_threads
1221 scm_i_thread_root (SCM thread
)
1223 return ((scm_thread
*) SCM_THREAD_DATA (thread
))->root
;
1226 SCM_DEFINE (scm_thread_exited_p
, "thread-exited?", 1, 0, 0,
1228 "Return @code{#t} iff @var{thread} has exited.\n")
1229 #define FUNC_NAME s_scm_thread_exited_p
1231 return SCM_BOOL (scm_c_thread_exited_p (thread
));
1236 scm_c_thread_exited_p (SCM thread
)
1237 #define FUNC_NAME s_scm_thread_exited_p
1240 SCM_VALIDATE_THREAD (1, thread
);
1241 t
= SCM_THREAD_DATA (thread
);
1246 static scm_t_cond wake_up_cond
;
1247 int scm_i_thread_go_to_sleep
;
1248 static scm_t_rec_mutex gc_section_mutex
;
1249 static int gc_section_count
= 0;
1250 static int threads_initialized_p
= 0;
1253 scm_i_thread_put_to_sleep ()
1255 scm_rec_mutex_lock (&gc_section_mutex
);
1256 if (threads_initialized_p
&& !gc_section_count
++)
1259 scm_i_plugin_mutex_lock (&thread_admin_mutex
);
1260 threads
= all_threads
;
1261 /* Signal all threads to go to sleep */
1262 scm_i_thread_go_to_sleep
= 1;
1263 for (; !SCM_NULLP (threads
); threads
= SCM_CDR (threads
))
1264 if (SCM_CAR (threads
) != cur_thread
)
1266 scm_thread
*t
= SCM_THREAD_DATA (SCM_CAR (threads
));
1267 scm_i_plugin_mutex_lock (&t
->heap_mutex
);
1269 scm_i_thread_go_to_sleep
= 0;
1270 scm_i_plugin_mutex_unlock (&thread_admin_mutex
);
1275 scm_i_thread_invalidate_freelists ()
1277 /* Don't need to lock thread_admin_mutex here since we are sinle threaded */
1278 SCM threads
= all_threads
;
1279 for (; !SCM_NULLP (threads
); threads
= SCM_CDR (threads
))
1280 if (SCM_CAR (threads
) != cur_thread
)
1282 scm_thread
*t
= SCM_THREAD_DATA (SCM_CAR (threads
));
1283 t
->clear_freelists_p
= 1;
1288 scm_i_thread_wake_up ()
1290 if (threads_initialized_p
&& !--gc_section_count
)
1293 /* Need to lock since woken threads can die and be deleted from list */
1294 scm_i_plugin_mutex_lock (&thread_admin_mutex
);
1295 threads
= all_threads
;
1296 scm_i_plugin_cond_broadcast (&wake_up_cond
);
1297 for (; !SCM_NULLP (threads
); threads
= SCM_CDR (threads
))
1298 if (SCM_CAR (threads
) != cur_thread
)
1300 scm_thread
*t
= SCM_THREAD_DATA (SCM_CAR (threads
));
1301 scm_i_plugin_mutex_unlock (&t
->heap_mutex
);
1303 scm_i_plugin_mutex_unlock (&thread_admin_mutex
);
1305 scm_rec_mutex_unlock (&gc_section_mutex
);
1309 scm_i_thread_sleep_for_gc ()
1313 scm_i_plugin_cond_wait (&wake_up_cond
, &t
->heap_mutex
);
1317 scm_t_mutex scm_i_critical_section_mutex
;
1318 scm_t_rec_mutex scm_i_defer_mutex
;
1320 #ifdef USE_PTHREAD_THREADS
1321 #include "libguile/pthread-threads.c"
1324 /*** Initialization */
1327 scm_threads_prehistory ()
1330 #ifdef USE_PTHREAD_THREADS
1331 /* Must be called before any initialization of a mutex. */
1332 scm_init_pthread_threads ();
1334 scm_i_plugin_mutex_init (&thread_admin_mutex
, &scm_i_plugin_mutex
);
1335 scm_i_plugin_rec_mutex_init (&gc_section_mutex
, &scm_i_plugin_rec_mutex
);
1336 scm_i_plugin_cond_init (&wake_up_cond
, 0);
1337 scm_i_plugin_mutex_init (&scm_i_critical_section_mutex
, &scm_i_plugin_mutex
);
1339 scm_i_plugin_key_create (&scm_i_thread_key
, 0);
1340 scm_i_plugin_key_create (&scm_i_root_state_key
, 0);
1341 scm_i_plugin_rec_mutex_init (&scm_i_defer_mutex
, &scm_i_plugin_rec_mutex
);
1342 /* Allocate a fake thread object to be used during bootup. */
1343 t
= malloc (sizeof (scm_thread
));
1345 t
->clear_freelists_p
= 0;
1346 scm_setspecific (scm_i_thread_key
, t
);
1349 scm_t_bits scm_tc16_thread
;
1350 scm_t_bits scm_tc16_future
;
1351 scm_t_bits scm_tc16_mutex
;
1352 scm_t_bits scm_tc16_fair_mutex
;
1353 scm_t_bits scm_tc16_condvar
;
1354 scm_t_bits scm_tc16_fair_condvar
;
1357 scm_init_threads (SCM_STACKITEM
*base
)
1360 scm_tc16_thread
= scm_make_smob_type ("thread", sizeof (scm_thread
));
1361 scm_tc16_mutex
= scm_make_smob_type ("mutex", sizeof (scm_t_mutex
));
1362 scm_tc16_fair_mutex
= scm_make_smob_type ("fair-mutex",
1363 sizeof (fair_mutex
));
1364 scm_tc16_condvar
= scm_make_smob_type ("condition-variable",
1365 sizeof (scm_t_cond
));
1366 scm_tc16_fair_condvar
= scm_make_smob_type ("fair-condition-variable",
1367 sizeof (fair_cond
));
1369 thread
= make_thread (SCM_BOOL_F
);
1370 /* Replace initial fake thread with a real thread object */
1371 free (SCM_CURRENT_THREAD
);
1372 scm_setspecific (scm_i_thread_key
, SCM_THREAD_DATA (thread
));
1373 scm_i_enter_guile (SCM_CURRENT_THREAD
);
1375 /* root is set later from init.c */
1376 init_thread_creatant (thread
, base
);
1378 scm_gc_register_root (&all_threads
);
1379 all_threads
= scm_cons (thread
, SCM_EOL
);
1381 scm_set_smob_mark (scm_tc16_thread
, thread_mark
);
1382 scm_set_smob_print (scm_tc16_thread
, thread_print
);
1383 scm_set_smob_free (scm_tc16_thread
, thread_free
);
1385 scm_set_smob_mark (scm_tc16_fair_mutex
, fair_mutex_mark
);
1387 scm_set_smob_mark (scm_tc16_fair_condvar
, fair_cond_mark
);
1389 scm_tc16_future
= scm_make_smob_type ("future", 0);
1390 scm_set_smob_mark (scm_tc16_future
, scm_markcdr
);
1391 scm_set_smob_free (scm_tc16_future
, future_free
);
1392 scm_set_smob_print (scm_tc16_future
, future_print
);
1394 threads_initialized_p
= 1;
1398 scm_init_thread_procs ()
1400 scm_loc_sys_thread_handler
1401 = SCM_VARIABLE_LOC (scm_c_define ("%thread-handler", SCM_BOOL_F
));
1402 #include "libguile/threads.x"