X-Git-Url: http://git.hcoop.net/bpt/guile.git/blobdiff_plain/23a621512f6a034a8624f589a3862dbddcec6b9d..aa169af8142b77f1af62b3e30071bfd62ab5dbac:/libguile/threads.c diff --git a/libguile/threads.c b/libguile/threads.c index c6347546c..5685a8907 100644 --- a/libguile/threads.c +++ b/libguile/threads.c @@ -1,4 +1,4 @@ -/* Copyright (C) 1995, 1996, 1997, 1998 Free Software Foundation, Inc. +/* Copyright (C) 1995, 1996, 1997, 1998, 2000 Free Software Foundation, Inc. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -38,6 +38,10 @@ * If you write modifications of your own for GUILE, it is your choice * whether to permit this exception to apply to your modifications. * If you do not wish that, delete this exception notice. */ + +/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999, + gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */ + /* This file does some pretty hairy #inclusion. It probably seemed @@ -48,7 +52,6 @@ threads.h coop-defs.h iselect.h - mit-pthreads.c coop-threads.c coop-threads.h coop-defs.h* @@ -60,12 +63,11 @@ */ #include -#include "_scm.h" -#include "dynwind.h" -#include "smob.h" -#include "genio.h" +#include "libguile/_scm.h" +#include "libguile/dynwind.h" +#include "libguile/smob.h" -#include "threads.h" +#include "libguile/threads.h" @@ -79,44 +81,78 @@ long scm_tc16_condvar; /* Scheme-visible thread functions. */ #ifdef USE_COOP_THREADS -SCM_PROC(s_single_thread_p, "single-active-thread?", 0, 0, 0, scm_single_thread_p); +SCM_REGISTER_PROC(s_single_thread_p, "single-active-thread?", 0, 0, 0, scm_single_thread_p); #endif -SCM_PROC(s_yield, "yield", 0, 0, 0, scm_yield); -SCM_PROC(s_call_with_new_thread, "call-with-new-thread", 0, 0, 1, scm_call_with_new_thread); -SCM_PROC(s_join_thread, "join-thread", 1, 0, 0, scm_join_thread); -SCM_PROC(s_make_mutex, "make-mutex", 0, 0, 0, scm_make_mutex); -SCM_PROC(s_lock_mutex, "lock-mutex", 1, 0, 0, scm_lock_mutex); -SCM_PROC(s_unlock_mutex, "unlock-mutex", 1, 0, 0, scm_unlock_mutex); -SCM_PROC(s_make_condition_variable, "make-condition-variable", 0, 0, 0, scm_make_condition_variable); -SCM_PROC(s_wait_condition_variable, "wait-condition-variable", 2, 0, 0, scm_wait_condition_variable); -SCM_PROC(s_signal_condition_variable, "signal-condition-variable", 1, 0, 0, scm_signal_condition_variable); - +/* GJB:FIXME:DOC: SCM_REGISTER_PROC needs to permit a docstring, + or these need to move into the file where the proc is defined. */ -#ifdef USE_MIT_PTHREADS -#include "mit-pthreads.c" -#endif +SCM_REGISTER_PROC(s_yield, "yield", 0, 0, 0, scm_yield); +/* If one or more threads are waiting to execute, calling yield forces an +immediate context switch to one of them. Otherwise, yield has no effect. +*/ + +SCM_REGISTER_PROC(s_call_with_new_thread, "call-with-new-thread", 0, 0, 1, scm_call_with_new_thread); +/* Evaluate @var{(thunk)} in a new thread, and new dynamic context, +returning a new thread object representing the thread. + +If an error occurs during evaluation, call error-thunk, passing it an +error code describing the condition. [Error codes are currently +meaningless integers. In the future, real values will be specified.] +If this happens, the error-thunk is called outside the scope of the new +root -- it is called in the same dynamic context in which +with-new-thread was evaluated, but not in the callers thread. + +All the evaluation rules for dynamic roots apply to threads. +*/ + +SCM_REGISTER_PROC(s_join_thread, "join-thread", 1, 0, 0, scm_join_thread); +/* Suspend execution of the calling thread until the target @var{thread} +terminates, unless the target @var{thread} has already terminated. +*/ + +SCM_REGISTER_PROC(s_make_mutex, "make-mutex", 0, 0, 0, scm_make_mutex); +/* Create a new mutex object. */ + +SCM_REGISTER_PROC(s_lock_mutex, "lock-mutex", 1, 0, 0, scm_lock_mutex); +/* Lock @var{mutex}. If the mutex is already locked, the calling thread +blocks until the mutex becomes available. The function returns when +the calling thread owns the lock on @var{mutex}. */ + +SCM_REGISTER_PROC(s_unlock_mutex, "unlock-mutex", 1, 0, 0, scm_unlock_mutex); +/* Unlocks @var{mutex} if the calling thread owns the lock on @var{mutex}. +Calling unlock-mutex on a mutex not owned by the current thread results +in undefined behaviour. Once a mutex has been unlocked, one thread +blocked on @var{mutex} is awakened and grabs the mutex lock. */ + +SCM_REGISTER_PROC(s_make_condition_variable, "make-condition-variable", 0, 0, 0, scm_make_condition_variable); + +SCM_REGISTER_PROC(s_wait_condition_variable, "wait-condition-variable", 2, 0, 0, scm_wait_condition_variable); + +SCM_REGISTER_PROC(s_signal_condition_variable, "signal-condition-variable", 1, 0, 0, scm_signal_condition_variable); + + #ifdef USE_COOP_THREADS -#include "coop-threads.c" +#include "libguile/coop-threads.c" #endif -#ifdef __STDC__ void scm_init_threads (SCM_STACKITEM *i) -#else -void -scm_init_threads (i) - SCM_STACKITEM *i; -#endif { - scm_tc16_thread = scm_make_smob_type ("thread", sizeof (coop_t)); + scm_tc16_thread = scm_make_smob_type ("thread", 0); scm_tc16_mutex = scm_make_smob_type ("mutex", sizeof (coop_m)); scm_tc16_condvar = scm_make_smob_type ("condition-variable", sizeof (coop_c)); -#include "threads.x" +#include "libguile/threads.x" /* Initialize implementation specific details of the threads support */ scm_threads_init (i); } + +/* + Local Variables: + c-file-style: "gnu" + End: +*/