libguile/threads.c

   1 /*      Copyright (C) 1995, 1996, 1997, 1998, 2000 Free Software Foundation, Inc.
   2  *
   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)
   6  * any later version.
   7  *
   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.
  12  *
  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
  17  *
  18  * As a special exception, the Free Software Foundation gives permission
  19  * for additional uses of the text contained in its release of GUILE.
  20  *
  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.
  26  *
  27  * This exception does not however invalidate any other reasons why
  28  * the executable file might be covered by the GNU General Public License.
  29  *
  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.
  37  *
  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.  */
  41
  42
  43 \f
  44
  45 /* This file does some pretty hairy #inclusion.  It probably seemed
  46    like a good idea at the time, but it doesn't now.  Here's the
  47    structure, edited for relevance (!), last I checked:
  48
  49       threads.c:
  50         threads.h
  51           coop-defs.h
  52             iselect.h
  53         coop-threads.c
  54           coop-threads.h
  55             coop-defs.h*
  56             ../qt/qt.h
  57           coop.c
  58             <qt.h>
  59
  60     * second #inclusion
  61 */
  62
  63 #include "libguile/_scm.h"
  64 #include "libguile/dynwind.h"
  65 #include "libguile/smob.h"
  66
  67 #include "libguile/threads.h"
  68
  69 \f
  70
  71 scm_t_bits scm_tc16_thread;
  72 scm_t_bits scm_tc16_mutex;
  73 scm_t_bits scm_tc16_condvar;
  74
  75 \f
  76 /* Scheme-visible thread functions. */
  77
  78 #ifdef USE_COOP_THREADS
  79 SCM_REGISTER_PROC(s_single_thread_p, "single-active-thread?", 0, 0, 0, scm_single_thread_p);
  80 #endif
  81
  82 /* GJB:FIXME:DOC: SCM_REGISTER_PROC needs to permit a docstring,
  83    or these need to move into the file where the proc is defined. */
  84
  85 SCM_REGISTER_PROC(s_yield, "yield", 0, 0, 0, scm_yield);
  86 /* If one or more threads are waiting to execute, calling yield forces an
  87 immediate context switch to one of them. Otherwise, yield has no effect.
  88 */
  89
  90 SCM_REGISTER_PROC(s_call_with_new_thread, "call-with-new-thread", 0, 0, 1, scm_call_with_new_thread);
  91 /* Evaluate @var{(thunk)} in a new thread, and new dynamic context,
  92 returning a new thread object representing the thread.
  93
  94 If an error occurs during evaluation, call error-thunk, passing it an
  95 error code describing the condition.  [Error codes are currently
  96 meaningless integers.  In the future, real values will be specified.]
  97 If this happens, the error-thunk is called outside the scope of the new
  98 root -- it is called in the same dynamic context in which
  99 with-new-thread was evaluated, but not in the callers thread.
 100
 101 All the evaluation rules for dynamic roots apply to threads.
 102 */
 103
 104 SCM_REGISTER_PROC(s_join_thread, "join-thread", 1, 0, 0, scm_join_thread);
 105 /* Suspend execution of the calling thread until the target @var{thread}
 106 terminates, unless the target @var{thread} has already terminated.
 107 */
 108
 109 SCM_REGISTER_PROC(s_make_mutex, "make-mutex", 0, 0, 0, scm_make_mutex);
 110 /* Create a new mutex object. */
 111
 112 SCM_REGISTER_PROC(s_lock_mutex, "lock-mutex", 1, 0, 0, scm_lock_mutex);
 113 /* Lock @var{mutex}. If the mutex is already locked, the calling thread
 114 blocks until the mutex becomes available. The function returns when
 115 the calling thread owns the lock on @var{mutex}. */
 116
 117 SCM_REGISTER_PROC(s_unlock_mutex, "unlock-mutex", 1, 0, 0, scm_unlock_mutex);
 118 /* Unlocks @var{mutex} if the calling thread owns the lock on @var{mutex}.
 119 Calling unlock-mutex on a mutex not owned by the current thread results
 120 in undefined behaviour. Once a mutex has been unlocked, one thread
 121 blocked on @var{mutex} is awakened and grabs the mutex lock. */
 122
 123 SCM_REGISTER_PROC(s_make_condition_variable, "make-condition-variable", 0, 0, 0, scm_make_condition_variable);
 124
 125 SCM_REGISTER_PROC(s_wait_condition_variable, "wait-condition-variable", 2, 0, 0, scm_wait_condition_variable);
 126
 127 SCM_REGISTER_PROC(s_signal_condition_variable, "signal-condition-variable", 1, 0, 0, scm_signal_condition_variable);
 128
 129 \f
 130
 131 #ifdef USE_COOP_THREADS
 132 #include "libguile/coop-threads.c"
 133 #endif
 134
 135 \f
 136
 137 void
 138 scm_init_threads (SCM_STACKITEM *i)
 139 {
 140   scm_tc16_thread = scm_make_smob_type ("thread", 0);
 141   scm_tc16_mutex = scm_make_smob_type ("mutex", sizeof (coop_m));
 142   scm_tc16_condvar = scm_make_smob_type ("condition-variable", sizeof (coop_c));
 143
 144 #ifndef SCM_MAGIC_SNARFER
 145 #include "libguile/threads.x"
 146 #endif
 147   /* Initialize implementation specific details of the threads support */
 148   scm_threads_init (i);
 149 }
 150
 151 /*
 152   Local Variables:
 153   c-file-style: "gnu"
 154   End:
 155 */