libguile/threads.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_THREADS_H
   4 #define SCM_THREADS_H
   5
   6 /* Copyright (C) 1996,1997,1998,2000,2001 Free Software Foundation, Inc.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2, or (at your option)
  11  * any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this software; see the file COPYING.  If not, write to
  20  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  21  * Boston, MA 02111-1307 USA
  22  *
  23  * As a special exception, the Free Software Foundation gives permission
  24  * for additional uses of the text contained in its release of GUILE.
  25  *
  26  * The exception is that, if you link the GUILE library with other files
  27  * to produce an executable, this does not by itself cause the
  28  * resulting executable to be covered by the GNU General Public License.
  29  * Your use of that executable is in no way restricted on account of
  30  * linking the GUILE library code into it.
  31  *
  32  * This exception does not however invalidate any other reasons why
  33  * the executable file might be covered by the GNU General Public License.
  34  *
  35  * This exception applies only to the code released by the
  36  * Free Software Foundation under the name GUILE.  If you copy
  37  * code from other Free Software Foundation releases into a copy of
  38  * GUILE, as the General Public License permits, the exception does
  39  * not apply to the code that you add in this way.  To avoid misleading
  40  * anyone as to the status of such modified files, you must delete
  41  * this exception notice from them.
  42  *
  43  * If you write modifications of your own for GUILE, it is your choice
  44  * whether to permit this exception to apply to your modifications.
  45  * If you do not wish that, delete this exception notice.  */
  46
  47 \f
  48
  49 #include "libguile/__scm.h"
  50 #include "libguile/procs.h"
  51 #include "libguile/throw.h"
  52
  53 \f
  54
  55 /* smob tags for the thread datatypes */
  56 extern scm_t_bits scm_tc16_thread;
  57 extern scm_t_bits scm_tc16_mutex;
  58 extern scm_t_bits scm_tc16_condvar;
  59
  60 #define SCM_THREADP(x)      SCM_TYP16_PREDICATE (scm_tc16_thread, x)
  61 #define SCM_THREAD_DATA(x)  ((void *) SCM_CELL_WORD_1 (x))
  62
  63 #define SCM_MUTEXP(x)       SCM_TYP16_PREDICATE (scm_tc16_mutex, x)
  64 #define SCM_MUTEX_DATA(x)   ((void *) SCM_CELL_WORD_1 (x))
  65
  66 #define SCM_CONDVARP(x)     SCM_TYP16_PREDICATE (scm_tc16_condvar, x)
  67 #define SCM_CONDVAR_DATA(x) ((void *) SCM_CELL_WORD_1 (x))
  68
  69 /* Initialize implementation specific details of the threads support */
  70 void scm_threads_init (SCM_STACKITEM *);
  71 void scm_threads_mark_stacks (void);
  72 void scm_init_threads (SCM_STACKITEM *);
  73
  74 /* */
  75 SCM scm_threads_make_mutex (void);
  76 SCM scm_threads_lock_mutex (SCM);
  77 SCM scm_threads_unlock_mutex (SCM);
  78 SCM scm_threads_monitor (void);
  79
  80 SCM scm_spawn_thread (scm_t_catch_body body, void *body_data,
  81                       scm_t_catch_handler handler, void *handler_data);
  82
  83 /* These are versions of the ordinary sleep and usleep functions,
  84    that play nicely with the thread system.  */
  85 unsigned long scm_thread_sleep (unsigned long);
  86 unsigned long scm_thread_usleep (unsigned long);
  87
  88
  89 /* The C versions of the Scheme-visible thread functions.  */
  90 #ifdef USE_COOP_THREADS
  91 extern SCM scm_single_thread_p (void);
  92 #endif
  93 extern SCM scm_yield (void);
  94 extern SCM scm_call_with_new_thread (SCM argl);
  95 extern SCM scm_join_thread (SCM t);
  96 extern SCM scm_make_mutex (void);
  97 extern SCM scm_lock_mutex (SCM m);
  98 extern SCM scm_unlock_mutex (SCM m);
  99 extern SCM scm_make_condition_variable (void);
 100 extern SCM scm_wait_condition_variable (SCM cond, SCM mutex);
 101 extern SCM scm_signal_condition_variable (SCM cond);
 102
 103 #ifdef USE_COOP_THREADS
 104 #include "libguile/coop-defs.h"
 105 #endif
 106
 107 #endif  /* SCM_THREADS_H */
 108
 109 /*
 110   Local Variables:
 111   c-file-style: "gnu"
 112   End:
 113 */